Changeset 9aafb39 in rtems-docs


Ignore:
Timestamp:
Oct 28, 2016, 12:56:02 PM (3 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
4e71fe2
Parents:
4120668
Message:

c_user: Remove errors and warnings.

Location:
c_user
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • c_user/board_support_packages.rst

    r4120668 r9aafb39  
    208208extension would save and restore the context of the device.
    209209
    210 For more information on user extensions, refer to `User Extensions Manager`_.
     210For more information on user extensions, refer to :ref:`User Extensions Manager`.
    211211
    212212Multiprocessor Communications Interface (MPCI)
  • c_user/clock_manager.rst

    r4120668 r9aafb39  
    6363Configuration Table.
    6464
     65.. _Time and Date Data Structures:
    6566
    6667Time and Date Data Structures
  • c_user/configuring_a_system.rst

    r4120668 r9aafb39  
    55.. COMMENT: All rights reserved.
    66
     7.. _Configuring a System:
     8
    79Configuring a System
    810####################
    911
    10 .. COMMENT: === Introduction ===
     12.. index:: configuring a system
    1113
    1214Introduction
     
    6971.. COMMENT: === Sizing the RTEMS Workspace ===
    7072
     73.. _Sizing the RTEMS Workspace:
     74
    7175Sizing the RTEMS Workspace
    7276==========================
     
    184188  - If the data type is an integer, then it can have numbers, characters (in
    185189    case the value is defined using another macro) and arithmetic operations
    186     (+, -, *, /).
     190    (+, -, \*, /).
    187191
    188192  - If the data type is a function pointer the first character should be an
     
    297301.. COMMENT: === Unlimited Objects ===
    298302
     303.. _Unlimited Objects:
     304
    299305Unlimited Objects
    300306-----------------
     
    395401
    396402.. COMMENT: === Per Object Class Unlimited Object Instances ===
     403
     404.. _Per Object Class Unlimited Object Instances:
    397405
    398406Per Object Class Unlimited Object Instances
     
    425433.. COMMENT: === Unlimited Object Instances ===
    426434
     435.. _Unlimited Object Instances:
     436
    427437Unlimited Object Instances
    428438--------------------------
     
    435445.. COMMENT: === CONFIGURE_UNLIMITED_OBJECTS ===
    436446
     447.. _Enable Unlimited Object Instances:
     448
    437449Enable Unlimited Object Instances
    438450---------------------------------
     
    464476
    465477.. COMMENT: === CONFIGURE_UNLIMITED_ALLOCATION_SIZE ===
     478
     479.. _Specify Unlimited Objects Allocation Size:
    466480
    467481Specify Unlimited Objects Allocation Size
     
    507521
    508522.. COMMENT: === CONFIGURE_MAXIMUM_TASKS ===
     523
     524.. _Specify Maximum Classic API Tasks:
    509525
    510526Specify Maximum Classic API Tasks
     
    552568.. COMMENT: === CONFIGURE_MAXIMUM_TIMERS ===
    553569
     570.. _Specify Maximum Classic API Timers:
     571
    554572Specify Maximum Classic API Timers
    555573----------------------------------
     
    579597.. COMMENT: === CONFIGURE_MAXIMUM_SEMAPHORES ===
    580598
     599.. _Specify Maximum Classic API Semaphores:
     600
    581601Specify Maximum Classic API Semaphores
    582602--------------------------------------
     
    606626.. COMMENT: === CONFIGURE_MAXIMUM_MRSP_SEMAPHORES ===
    607627
     628.. _Specify Maximum Classic API Semaphores usable with MrsP:
     629
    608630Specify Maximum Classic API Semaphores usable with MrsP
    609631-------------------------------------------------------
     
    636658.. COMMENT: === CONFIGURE_MAXIMUM_MESSAGE_QUEUES ===
    637659
     660.. _Specify Maximum Classic API Message Queues:
     661
    638662Specify Maximum Classic API Message Queues
    639663------------------------------------------
     
    663687.. COMMENT: === CONFIGURE_MAXIMUM_BARRIERS ===
    664688
     689.. _Specify Maximum Classic API Barriers:
     690
    665691Specify Maximum Classic API Barriers
    666692------------------------------------
     
    690716.. COMMENT: === CONFIGURE_MAXIMUM_PERIODS ===
    691717
     718.. _Specify Maximum Classic API Periods:
     719
    692720Specify Maximum Classic API Periods
    693721-----------------------------------
     
    717745.. COMMENT: === CONFIGURE_MAXIMUM_PARTITIONS ===
    718746
     747.. _Specify Maximum Classic API Partitions:
     748
    719749Specify Maximum Classic API Partitions
    720750--------------------------------------
     
    744774.. COMMENT: === CONFIGURE_MAXIMUM_REGIONS ===
    745775
     776.. _Specify Maximum Classic API Regions:
     777
    746778Specify Maximum Classic API Regions
    747779-----------------------------------
     
    771803.. COMMENT: === CONFIGURE_MAXIMUM_PORTS ===
    772804
     805.. _Specify Maximum Classic API Ports:
     806
    773807Specify Maximum Classic API Ports
    774808---------------------------------
     
    798832.. COMMENT: === CONFIGURE_MAXIMUM_USER_EXTENSIONS ===
    799833
     834.. _Specify Maximum Classic API User Extensions:
     835
    800836Specify Maximum Classic API User Extensions
    801837-------------------------------------------
     
    833869
    834870.. COMMENT: === CONFIGURE_RTEMS_INIT_TASKS_TABLE ===
     871
     872.. _Instantiate Classic API Initialization Task Table:
    835873
    836874Instantiate Classic API Initialization Task Table
     
    870908.. COMMENT: === CONFIGURE_INIT_TASK_ENTRY_POINT ===
    871909
     910.. _Specifying Classic API Initialization Task Entry Point:
     911
    872912Specifying Classic API Initialization Task Entry Point
    873913------------------------------------------------------
     
    899939.. COMMENT: === CONFIGURE_INIT_TASK_NAME ===
    900940
     941.. _Specifying Classic API Initialization Task Name:
     942
    901943Specifying Classic API Initialization Task Name
    902944-----------------------------------------------
     
    925967
    926968.. COMMENT: === CONFIGURE_INIT_TASK_STACK_SIZE ===
     969
     970.. _Specifying Classic API Initialization Task Stack Size:
    927971
    928972Specifying Classic API Initialization Task Stack Size
     
    9561000.. COMMENT: === CONFIGURE_INIT_TASK_PRIORITY ===
    9571001
     1002.. _Specifying Classic API Initialization Task Priority:
     1003
    9581004Specifying Classic API Initialization Task Priority
    9591005---------------------------------------------------
     
    9841030.. COMMENT: === CONFIGURE_INIT_TASK_ATTRIBUTES ===
    9851031
     1032.. _Specifying Classic API Initialization Task Attributes:
     1033
    9861034Specifying Classic API Initialization Task Attributes
    9871035-----------------------------------------------------
     
    10111059.. COMMENT: === CONFIGURE_INIT_TASK_INITIAL_MODES ===
    10121060
     1061.. _Specifying Classic API Initialization Task Modes:
     1062
    10131063Specifying Classic API Initialization Task Modes
    10141064------------------------------------------------
     
    10391089.. COMMENT: === CONFIGURE_INIT_TASK_ARGUMENTS ===
    10401090
     1091.. _Specifying Classic API Initialization Task Arguments:
     1092
    10411093Specifying Classic API Initialization Task Arguments
    10421094----------------------------------------------------
     
    10661118.. COMMENT: === CONFIGURE_HAS_OWN_INIT_TASK_TABLE ===
    10671119
     1120.. _Not Using Generated Initialization Tasks Table:
     1121
    10681122Not Using Generated Initialization Tasks Table
    10691123----------------------------------------------
     
    11031157
    11041158.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_THREADS ===
     1159
     1160.. _Specify Maximum POSIX API Threads:
    11051161
    11061162Specify Maximum POSIX API Threads
     
    11451201.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MUTEXES ===
    11461202
     1203.. _Specify Maximum POSIX API Mutexes:
     1204
    11471205Specify Maximum POSIX API Mutexes
    11481206---------------------------------
     
    11721230.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES ===
    11731231
     1232.. _Specify Maximum POSIX API Condition Variables:
     1233
    11741234Specify Maximum POSIX API Condition Variables
    11751235---------------------------------------------
     
    11991259.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_KEYS ===
    12001260
     1261.. _Specify Maximum POSIX API Keys:
     1262
    12011263Specify Maximum POSIX API Keys
    12021264------------------------------
     
    12281290.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_TIMERS ===
    12291291
     1292.. _Specify Maximum POSIX API Timers:
     1293
    12301294Specify Maximum POSIX API Timers
    12311295--------------------------------
     
    12551319.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS ===
    12561320
     1321.. _Specify Maximum POSIX API Queued Signals:
     1322
    12571323Specify Maximum POSIX API Queued Signals
    12581324----------------------------------------
     
    12821348.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES ===
    12831349
     1350.. _Specify Maximum POSIX API Message Queues:
     1351
    12841352Specify Maximum POSIX API Message Queues
    12851353----------------------------------------
     
    13111379.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS ===
    13121380
     1381.. _Specify Maximum POSIX API Message Queue Descriptors:
     1382
    13131383Specify Maximum POSIX API Message Queue Descriptors
    13141384---------------------------------------------------
     
    13411411.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SEMAPHORES ===
    13421412
     1413.. _Specify Maximum POSIX API Semaphores:
     1414
    13431415Specify Maximum POSIX API Semaphores
    13441416------------------------------------
     
    13681440.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_BARRIERS ===
    13691441
     1442.. _Specify Maximum POSIX API Barriers:
     1443
    13701444Specify Maximum POSIX API Barriers
    13711445----------------------------------
     
    13951469.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_SPINLOCKS ===
    13961470
     1471.. _Specify Maximum POSIX API Spinlocks:
     1472
    13971473Specify Maximum POSIX API Spinlocks
    13981474-----------------------------------
     
    14221498.. COMMENT: === CONFIGURE_MAXIMUM_POSIX_RWLOCKS ===
    14231499
     1500.. _Specify Maximum POSIX API Read/Write Locks:
     1501
    14241502Specify Maximum POSIX API Read/Write Locks
    14251503------------------------------------------
     
    14571535
    14581536.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_TABLE ===
     1537
     1538.. _Instantiate POSIX API Initialization Thread Table:
    14591539
    14601540Instantiate POSIX API Initialization Thread Table
     
    14951575.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT ===
    14961576
     1577.. _Specifying POSIX API Initialization Thread Entry Point:
     1578
    14971579Specifying POSIX API Initialization Thread Entry Point
    14981580------------------------------------------------------
     
    15241606.. COMMENT: === CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE ===
    15251607
     1608.. _Specifying POSIX API Initialization Thread Stack Size:
     1609
    15261610Specifying POSIX API Initialization Thread Stack Size
    15271611-----------------------------------------------------
     
    15381622
    15391623*DEFAULT VALUE:*
    1540     The default value is 2 * RTEMS_MINIMUM_STACK_SIZE.
     1624    The default value is 2 \* RTEMS_MINIMUM_STACK_SIZE.
    15411625
    15421626**DESCRIPTION:**
     
    15481632
    15491633If the stack size specified is greater than the configured minimum, it must be
    1550 accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See `Reserve Task/Thread
    1551 Stack Memory Above Minimum`_ for more information about
     1634accounted for in ``CONFIGURE_EXTRA_TASK_STACKS``.  See :ref:`Reserve
     1635Task/Thread Stack Memory Above Minimum` for more information about
    15521636``CONFIGURE_EXTRA_TASK_STACKS``.
    15531637
    15541638.. COMMENT: === CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE ===
     1639
     1640.. _Not Using Generated POSIX Initialization Threads Table:
    15551641
    15561642Not Using Generated POSIX Initialization Threads Table
     
    15911677.. COMMENT: === CONFIGURE_UNIFIED_WORK_AREAS ===
    15921678
     1679.. _Separate or Unified Work Areas:
    15931680
    15941681Separate or Unified Work Areas
     
    16351722.. COMMENT: === CONFIGURE_MICROSECONDS_PER_TICK ===
    16361723
     1724.. _Length of Each Clock Tick:
     1725
    16371726Length of Each Clock Tick
    16381727-------------------------
     
    16801769.. COMMENT: === CONFIGURE_TICKS_PER_TIMESLICE ===
    16811770
     1771.. _Specifying Timeslicing Quantum:
     1772
    16821773Specifying Timeslicing Quantum
    16831774------------------------------
     
    17081799
    17091800.. COMMENT: === CONFIGURE_MAXIMUM_PRIORITY ===
     1801
     1802.. _Specifying the Number of Thread Priority Levels:
    17101803
    17111804Specifying the Number of Thread Priority Levels
     
    17551848.. COMMENT: === CONFIGURE_MINIMUM_TASK_STACK_SIZE ===
    17561849
     1850.. _Specifying the Minimum Task Size:
     1851
    17571852Specifying the Minimum Task Size
    17581853--------------------------------
     
    17941889.. COMMENT: === CONFIGURE_INTERRUPT_STACK_SIZE ===
    17951890
     1891.. _Configuring the Size of the Interrupt Stack:
     1892
    17961893Configuring the Size of the Interrupt Stack
    17971894-------------------------------------------
     
    18291926.. COMMENT: === CONFIGURE_EXTRA_TASK_STACKS ===
    18301927
     1928.. _Reserve Task/Thread Stack Memory Above Minimum:
    18311929
    18321930Reserve Task/Thread Stack Memory Above Minimum
     
    18601958
    18611959.. COMMENT: === CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY ===
     1960
     1961.. _Automatically Zeroing the RTEMS Workspace and C Program Heap:
    18621962
    18631963Automatically Zeroing the RTEMS Workspace and C Program Heap
     
    18951995.. COMMENT: === CONFIGURE_STACK_CHECKER_ENABLED ===
    18961996
     1997.. _Enable The Task Stack Usage Checker:
     1998
    18971999Enable The Task Stack Usage Checker
    18982000-----------------------------------
     
    19242026
    19252027.. COMMENT: === CONFIGURE_INITIAL_EXTENSIONS ===
     2028
     2029.. _Specify Application Specific User Extensions:
    19262030
    19272031Specify Application Specific User Extensions
     
    19632067.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR_INIT ===
    19642068
     2069.. _Custom Task Stack Allocator Initialization:
     2070
    19652071Custom Task Stack Allocator Initialization
    19662072------------------------------------------
     
    19972103.. COMMENT: === CONFIGURE_TASK_STACK_ALLOCATOR ===
    19982104
     2105.. _Custom Task Stack Allocator:
     2106
    19992107Custom Task Stack Allocator
    20002108---------------------------
     
    20322140
    20332141.. COMMENT: === CONFIGURE_TASK_STACK_DEALLOCATOR ===
     2142
     2143.. _Custom Task Stack Deallocator:
    20342144
    20352145Custom Task Stack Deallocator
     
    20762186.. COMMENT: === CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE ===
    20772187
     2188.. _Calculate Memory for a Single Classic Message API Message Queue:
     2189
    20782190Calculate Memory for a Single Classic Message API Message Queue
    20792191---------------------------------------------------------------
     
    21132225
    21142226.. COMMENT: === CONFIGURE_MESSAGE_BUFFER_MEMORY ===
     2227
     2228.. _Reserve Memory for All Classic Message API Message Queues:
    21152229
    21162230Reserve Memory for All Classic Message API Message Queues
     
    21682282.. COMMENT: === CONFIGURE_MEMORY_OVERHEAD ===
    21692283
     2284.. _Specify Memory Overhead:
    21702285
    21712286Specify Memory Overhead
     
    21992314.. COMMENT: === CONFIGURE_HAS_OWN_CONFIGURATION_TABLE ===
    22002315
     2316.. _Do Not Generate Configuration Information:
     2317
    22012318Do Not Generate Configuration Information
    22022319-----------------------------------------
     
    22332350
    22342351.. COMMENT: === CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS ===
     2352
     2353.. _Specify Maximum Number of File Descriptors:
    22352354
    22362355Specify Maximum Number of File Descriptors
     
    22652384.. COMMENT: === CONFIGURE_TERMIOS_DISABLED ===
    22662385
     2386.. _Disable POSIX Termios Support:
     2387
    22672388Disable POSIX Termios Support
    22682389-----------------------------
     
    22942415.. COMMENT: === CONFIGURE_NUMBER_OF_TERMIOS_PORTS ===
    22952416
     2417.. _Specify Maximum Termios Ports:
     2418
    22962419Specify Maximum Termios Ports
    22972420-----------------------------
     
    23292452
    23302453.. COMMENT: === CONFIGURE_HAS_OWN_MOUNT_TABLE ===
     2454
     2455.. _Providing Application Specific Mount Table:
    23312456
    23322457Providing Application Specific Mount Table
     
    23642489.. COMMENT: === CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM ===
    23652490
     2491.. _Configure devFS as Root File System:
     2492
    23662493Configure devFS as Root File System
    23672494-----------------------------------
     
    23952522
    23962523.. COMMENT: === CONFIGURE_MAXIMUM_DEVICES ===
     2524
     2525.. _Specifying Maximum Devices for devFS:
    23972526
    23982527Specifying Maximum Devices for devFS
     
    24272556.. COMMENT: === CONFIGURE_APPLICATION_DISABLE_FILESYSTEM ===
    24282557
     2558.. _Disable File System Support:
     2559
    24292560Disable File System Support
    24302561---------------------------
     
    24562587.. COMMENT: === CONFIGURE_USE_MINIIMFS_AS_BASE_FILESYSTEM ===
    24572588
     2589.. _Use a Root IMFS with a Minimalistic Feature Set:
     2590
    24582591Use a Root IMFS with a Minimalistic Feature Set
    24592592-----------------------------------------------
     
    24942627
    24952628.. COMMENT: === CONFIGURE_IMFS_MEMFILE_BYTES_PER_BLOCK ===
     2629
     2630.. _Specify Block Size for IMFS:
    24962631
    24972632Specify Block Size for IMFS
     
    25442679.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHOWN ===
    25452680
     2681.. _Disable Change Owner Support of Root IMFS:
     2682
    25462683Disable Change Owner Support of Root IMFS
    25472684-----------------------------------------
     
    25672704.. COMMENT: === CONFIGURE_IMFS_DISABLE_CHMOD ===
    25682705
     2706.. _Disable Change Mode Support of Root IMFS:
     2707
    25692708Disable Change Mode Support of Root IMFS
    25702709----------------------------------------
     
    25902729.. COMMENT: === CONFIGURE_IMFS_DISABLE_UTIME ===
    25912730
     2731.. _Disable Change Times Support of Root IMFS:
     2732
    25922733Disable Change Times Support of Root IMFS
    25932734-----------------------------------------
     
    26132754.. COMMENT: === CONFIGURE_IMFS_DISABLE_LINK ===
    26142755
     2756.. _Disable Create Hard Link Support of Root IMFS:
     2757
    26152758Disable Create Hard Link Support of Root IMFS
    26162759---------------------------------------------
     
    26362779.. COMMENT: === CONFIGURE_IMFS_DISABLE_SYMLINK ===
    26372780
     2781.. _Disable Create Symbolic Link Support of Root IMFS:
     2782
    26382783Disable Create Symbolic Link Support of Root IMFS
    26392784-------------------------------------------------
     
    26592804.. COMMENT: === CONFIGURE_IMFS_DISABLE_READLINK ===
    26602805
     2806.. _Disable Read Symbolic Link Support of Root IMFS:
     2807
    26612808Disable Read Symbolic Link Support of Root IMFS
    26622809-----------------------------------------------
     
    26822829.. COMMENT: === CONFIGURE_IMFS_DISABLE_RENAME ===
    26832830
     2831.. _Disable Rename Support of Root IMFS:
     2832
    26842833Disable Rename Support of Root IMFS
    26852834-----------------------------------
     
    27052854.. COMMENT: === CONFIGURE_IMFS_DISABLE_READDIR ===
    27062855
     2856.. _Disable Directory Read Support of Root IMFS:
     2857
    27072858Disable Directory Read Support of Root IMFS
    27082859-------------------------------------------
     
    27292880.. COMMENT: === CONFIGURE_IMFS_DISABLE_MOUNT ===
    27302881
     2882.. _Disable Mount Support of Root IMFS:
     2883
    27312884Disable Mount Support of Root IMFS
    27322885----------------------------------
     
    27522905.. COMMENT: === CONFIGURE_IMFS_DISABLE_UNMOUNT ===
    27532906
     2907.. _Disable Unmount Support of Root IMFS:
     2908
    27542909Disable Unmount Support of Root IMFS
    27552910------------------------------------
     
    27752930.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD ===
    27762931
     2932.. _Disable Make Nodes Support of Root IMFS:
     2933
    27772934Disable Make Nodes Support of Root IMFS
    27782935---------------------------------------
     
    27982955.. COMMENT: === CONFIGURE_IMFS_DISABLE_MKNOD_FILE ===
    27992956
     2957.. _Disable Make Files Support of Root IMFS:
     2958
    28002959Disable Make Files Support of Root IMFS
    28012960---------------------------------------
     
    28212980.. COMMENT: === CONFIGURE_IMFS_DISABLE_RMNOD ===
    28222981
     2982.. _Disable Remove Nodes Support of Root IMFS:
     2983
    28232984Disable Remove Nodes Support of Root IMFS
    28242985-----------------------------------------
     
    28523013.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_LIBBLOCK ===
    28533014
     3015.. _Enable Block Device Cache:
     3016
    28543017Enable Block Device Cache
    28553018-------------------------
     
    28803043.. COMMENT: === CONFIGURE_BDBUF_CACHE_MEMORY_SIZE ===
    28813044
     3045.. _Size of the Cache Memory:
     3046
    28823047Size of the Cache Memory
    28833048------------------------
     
    29063071.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MIN_SIZE ===
    29073072
     3073.. _Minimum Size of a Buffer:
     3074
    29083075Minimum Size of a Buffer
    29093076------------------------
     
    29323099.. COMMENT: === CONFIGURE_BDBUF_BUFFER_MAX_SIZE ===
    29333100
     3101.. _Maximum Size of a Buffer:
     3102
    29343103Maximum Size of a Buffer
    29353104------------------------
     
    29583127.. COMMENT: === CONFIGURE_SWAPOUT_SWAP_PERIOD ===
    29593128
     3129.. _Swapout Task Swap Period:
     3130
    29603131Swapout Task Swap Period
    29613132------------------------
     
    29843155.. COMMENT: === CONFIGURE_SWAPOUT_BLOCK_HOLD ===
    29853156
     3157.. _Swapout Task Maximum Block Hold Time:
     3158
    29863159Swapout Task Maximum Block Hold Time
    29873160------------------------------------
     
    30103183.. COMMENT: === CONFIGURE_SWAPOUT_TASK_PRIORITY ===
    30113184
     3185.. _Swapout Task Priority:
     3186
    30123187Swapout Task Priority
    30133188---------------------
     
    30363211.. COMMENT: === CONFIGURE_BDBUF_MAX_READ_AHEAD_BLOCKS ===
    30373212
     3213.. _Maximum Blocks per Read-Ahead Request:
     3214
    30383215Maximum Blocks per Read-Ahead Request
    30393216-------------------------------------
     
    30643241.. COMMENT: === CONFIGURE_BDBUF_MAX_WRITE_BLOCKS ===
    30653242
     3243.. _Maximum Blocks per Write Request:
     3244
    30663245Maximum Blocks per Write Request
    30673246--------------------------------
     
    30903269.. COMMENT: === CONFIGURE_BDBUF_TASK_STACK_SIZE ===
    30913270
     3271.. _Task Stack Size of the Block Device Cache Tasks:
     3272
    30923273Task Stack Size of the Block Device Cache Tasks
    30933274-----------------------------------------------
     
    31163297.. COMMENT: === CONFIGURE_BDBUF_READ_AHEAD_TASK_PRIORITY ===
    31173298
     3299.. _Read-Ahead Task Priority:
     3300
    31183301Read-Ahead Task Priority
    31193302------------------------
     
    31423325.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASKS ===
    31433326
     3327.. _Swapout Worker Task Count:
     3328
    31443329Swapout Worker Task Count
    31453330-------------------------
     
    31683353.. COMMENT: === CONFIGURE_SWAPOUT_WORKER_TASK_PRIORITY ===
    31693354
     3355.. _Swapout Worker Task Priority:
     3356
    31703357Swapout Worker Task Priority
    31713358----------------------------
     
    32033390.. COMMENT: === Disable BSP Settings ===
    32043391
     3392.. _Disable BSP Configuration Settings:
     3393
    32053394Disable BSP Configuration Settings
    32063395----------------------------------
     
    32303419.. COMMENT: === CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK ===
    32313420
     3421.. _Specify BSP Supports sbrk():
     3422
    32323423Specify BSP Supports sbrk()
    32333424---------------------------
     
    32623453.. COMMENT: === BSP_IDLE_TASK_BODY ===
    32633454
     3455.. _Specify BSP Specific Idle Task:
     3456
    32643457Specify BSP Specific Idle Task
    32653458------------------------------
     
    32923485.. COMMENT: === BSP_IDLE_TASK_STACK_SIZE ===
    32933486
     3487.. _Specify BSP Suggested Value for IDLE Task Stack Size:
     3488
    32943489Specify BSP Suggested Value for IDLE Task Stack Size
    32953490----------------------------------------------------
     
    33303525.. COMMENT: === BSP_INITIAL_EXTENSION ===
    33313526
     3527.. _Specify BSP Specific User Extensions:
     3528
    33323529Specify BSP Specific User Extensions
    33333530------------------------------------
     
    33583555.. COMMENT: === BSP_INTERRUPT_STACK_SIZE ===
    33593556
     3557.. _Specifying BSP Specific Interrupt Stack Size:
     3558
    33603559Specifying BSP Specific Interrupt Stack Size
    33613560--------------------------------------------
     
    33853584
    33863585.. COMMENT: === BSP_MAXIMUM_DEVICES ===
     3586
     3587.. _Specifying BSP Specific Maximum Devices:
    33873588
    33883589Specifying BSP Specific Maximum Devices
     
    34173618.. COMMENT: === BSP_ZERO_WORKSPACE_AUTOMATICALLY ===
    34183619
     3620.. _BSP Recommends RTEMS Workspace be Cleared:
     3621
    34193622BSP Recommends RTEMS Workspace be Cleared
    34203623-----------------------------------------
     
    34453648
    34463649.. COMMENT: === CONFIGURE_BSP_PREREQUISITE_DRIVERS ===
     3650
     3651.. _Specify BSP Prerequisite Drivers:
    34473652
    34483653Specify BSP Prerequisite Drivers
     
    34853690.. COMMENT: === CONFIGURE_IDLE_TASK_BODY ===
    34863691
     3692.. _Specify Application Specific Idle Task Body:
     3693
    34873694Specify Application Specific Idle Task Body
    34883695-------------------------------------------
     
    35133720.. COMMENT: === CONFIGURE_IDLE_TASK_STACK_SIZE ===
    35143721
     3722.. _Specify Idle Task Stack Size:
     3723
    35153724Specify Idle Task Stack Size
    35163725----------------------------
     
    35393748
    35403749.. COMMENT: === CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION ===
     3750
     3751.. _Specify Idle Task Performs Application Initialization:
    35413752
    35423753Specify Idle Task Performs Application Initialization
     
    35893800.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY ===
    35903801
     3802.. _Use Deterministic Priority Scheduler:
     3803
    35913804Use Deterministic Priority Scheduler
    35923805------------------------------------
     
    36213834
    36223835.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE ===
     3836
     3837.. _Use Simple Priority Scheduler:
    36233838
    36243839Use Simple Priority Scheduler
     
    36563871
    36573872.. COMMENT: === CONFIGURE_SCHEDULER_EDF ===
     3873
     3874.. _Use Earliest Deadline First Scheduler:
    36583875
    36593876Use Earliest Deadline First Scheduler
     
    36943911.. COMMENT: === CONFIGURE_SCHEDULER_CBS ===
    36953912
     3913.. _Use Constant Bandwidth Server Scheduler:
     3914
    36963915Use Constant Bandwidth Server Scheduler
    36973916---------------------------------------
     
    37293948.. COMMENT: === CONFIGURE_SCHEDULER_PRIORITY_SMP ===
    37303949
     3950.. _Use Deterministic Priority SMP Scheduler:
     3951
    37313952Use Deterministic Priority SMP Scheduler
    37323953----------------------------------------
     
    37633984
    37643985.. COMMENT: === CONFIGURE_SCHEDULER_SIMPLE_SMP ===
     3986
     3987.. _Use Simple SMP Priority Scheduler:
    37653988
    37663989Use Simple SMP Priority Scheduler
     
    38044027
    38054028.. COMMENT: === Configuring a Scheduler Name ===
     4029
     4030.. _Configuring a Scheduler Name:
    38064031
    38074032Configuring a Scheduler Name
     
    38394064.. COMMENT: === Configuring a User Scheduler ===
    38404065
     4066.. _Configuring a User Provided Scheduler:
     4067
    38414068Configuring a User Provided Scheduler
    38424069-------------------------------------
     
    38834110.. COMMENT: === Configuring Clustered Schedulers ===
    38844111
     4112.. _Configuring Clustered Schedulers:
    38854113
    38864114Configuring Clustered Schedulers
     
    40564284.. COMMENT: === CONFIGURE_SMP_APPLICATION ===
    40574285
     4286.. _Enable SMP Support for Applications:
    40584287
    40594288Enable SMP Support for Applications
     
    40844313
    40854314.. COMMENT: === CONFIGURE_SMP_MAXIMUM_PROCESSORS ===
     4315
     4316.. _Specify Maximum Processors in SMP System:
    40864317
    40874318Specify Maximum Processors in SMP System
     
    41244355
    41254356.. COMMENT: === CONFIGURE_MAXIMUM_DRIVERS ===
     4357
     4358.. _Specifying the Maximum Number of Device Drivers:
    41264359
    41274360Specifying the Maximum Number of Device Drivers
     
    41584391.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER ===
    41594392
     4393.. _Enable Console Device Driver:
     4394
    41604395Enable Console Device Driver
    41614396----------------------------
     
    41894424.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER ===
    41904425
     4426.. _Enable Clock Driver:
     4427
    41914428Enable Clock Driver
    41924429-------------------
     
    42214458.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER ===
    42224459
     4460.. _Enable the Benchmark Timer Driver:
     4461
    42234462Enable the Benchmark Timer Driver
    42244463---------------------------------
     
    42504489
    42514490.. COMMENT: === CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER ===
     4491
     4492.. _Specify Clock and Benchmark Timer Drivers Are Not Needed:
    42524493
    42534494Specify Clock and Benchmark Timer Drivers Are Not Needed
     
    42824523.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER ===
    42834524
     4525.. _Enable Real-Time Clock Driver:
     4526
    42844527Enable Real-Time Clock Driver
    42854528-----------------------------
     
    43134556.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER ===
    43144557
     4558.. _Enable the Watchdog Device Driver:
     4559
    43154560Enable the Watchdog Device Driver
    43164561---------------------------------
     
    43444589.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER ===
    43454590
     4591.. _Enable the Graphics Frame Buffer Device Driver:
     4592
    43464593Enable the Graphics Frame Buffer Device Driver
    43474594----------------------------------------------
     
    43754622.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER ===
    43764623
     4624.. _Enable Stub Device Driver:
     4625
    43774626Enable Stub Device Driver
    43784627-------------------------
     
    44024651
    44034652.. COMMENT: === CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS ===
     4653
     4654.. _Specify Application Prerequisite Device Drivers:
    44044655
    44054656Specify Application Prerequisite Device Drivers
     
    44394690.. COMMENT: === CONFIGURE_APPLICATION_EXTRA_DRIVERS ===
    44404691
     4692.. _Specify Extra Application Device Drivers:
     4693
    44414694Specify Extra Application Device Drivers
    44424695----------------------------------------
     
    44684721.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_NULL_DRIVER ===
    44694722
     4723.. _Enable /dev/null Device Driver:
     4724
    44704725Enable /dev/null Device Driver
    44714726------------------------------
     
    44954750.. COMMENT: === CONFIGURE_APPLICATION_NEEDS_ZERO_DRIVER ===
    44964751
     4752.. _Enable /dev/zero Device Driver:
     4753
    44974754Enable /dev/zero Device Driver
    44984755------------------------------
     
    45224779.. COMMENT: === CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE ===
    45234780
     4781.. _Specifying Application Defined Device Driver Table:
     4782
    45244783Specifying Application Defined Device Driver Table
    45254784--------------------------------------------------
     
    45684827.. COMMENT: === CONFIGURE_MP_APPLICATION ===
    45694828
     4829.. _Specify Application Will Use Multiprocessing:
     4830
    45704831Specify Application Will Use Multiprocessing
    45714832--------------------------------------------
     
    45964857
    45974858.. COMMENT: === CONFIGURE_MP_NODE_NUMBER ===
     4859
     4860.. _Configure Node Number in Multiprocessor Configuration:
    45984861
    45994862Configure Node Number in Multiprocessor Configuration
     
    46284891.. COMMENT: === CONFIGURE_MP_MAXIMUM_NODES ===
    46294892
     4893.. _Configure Maximum Node in Multiprocessor Configuration:
     4894
    46304895Configure Maximum Node in Multiprocessor Configuration
    46314896------------------------------------------------------
     
    46554920.. COMMENT: === CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS ===
    46564921
     4922.. _Configure Maximum Global Objects in Multiprocessor Configuration:
     4923
    46574924Configure Maximum Global Objects in Multiprocessor Configuration
    46584925----------------------------------------------------------------
     
    46834950.. COMMENT: === CONFIGURE_MP_MAXIMUM_PROXIES ===
    46844951
     4952.. _Configure Maximum Proxies in Multiprocessor Configuration:
     4953
    46854954Configure Maximum Proxies in Multiprocessor Configuration
    46864955---------------------------------------------------------
     
    47144983.. COMMENT: === CONFIGURE_MP_MPCI_TABLE_POINTER ===
    47154984
     4985.. _Configure MPCI in Multiprocessor Configuration:
     4986
    47164987Configure MPCI in Multiprocessor Configuration
    47174988----------------------------------------------
     
    47435014.. COMMENT: === CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE ===
    47445015
     5016.. _Do Not Generate Multiprocessor Configuration Table:
     5017
    47455018Do Not Generate Multiprocessor Configuration Table
    47465019--------------------------------------------------
     
    47905063.. COMMENT: === CONFIGURE_GNAT_RTEMS ===
    47915064
     5065.. _Specify Application Includes Ada Code:
     5066
    47925067Specify Application Includes Ada Code
    47935068-------------------------------------
     
    48195094.. COMMENT: === CONFIGURE_MAXIMUM_ADA_TASKS ===
    48205095
     5096.. _Specify the Maximum Number of Ada Tasks.:
     5097
    48215098Specify the Maximum Number of Ada Tasks.
    48225099----------------------------------------
     
    48465123
    48475124.. COMMENT: === CONFIGURE_MAXIMUM_FAKE_ADA_TASKS ===
     5125
     5126.. _Specify the Maximum Fake Ada Tasks:
    48485127
    48495128Specify the Maximum Fake Ada Tasks
     
    49345213.. COMMENT: === CONFIGURE_ENABLE_GO ===
    49355214
     5215.. _Specify Application Includes Go Code:
     5216
    49365217Specify Application Includes Go Code
    49375218------------------------------------
     
    49615242.. COMMENT: === CONFIGURE_MAXIMUM_GOROUTINES ===
    49625243
     5244.. _Specify the maximum number of Go routines:
     5245
    49635246Specify the maximum number of Go routines
    49645247-----------------------------------------
     
    49875270
    49885271.. COMMENT: === CONFIGURE_MAXIMUM_GO_CHANNELS ===
     5272
     5273.. _Specify the maximum number of Go Channels:
    49895274
    49905275Specify the maximum number of Go Channels
  • c_user/fatal_error.rst

    r4120668 r9aafb39  
    6666==========
    6767
     68.. _Announcing a Fatal Error:
     69
    6870Announcing a Fatal Error
    6971------------------------
  • c_user/glossary.rst

    r4120668 r9aafb39  
    576576    by at most one scheduler instance.  The processor to scheduler instance
    577577    assignment is determined at application configuration time.  See
    578     `Configuring a System`_.
     578    :ref:`Configuring a System`.
    579579
    580580:dfn:`segments`
  • c_user/key_concepts.rst

    r4120668 r9aafb39  
    279279request to delay until midnight on New Year's Eve before lowering the ball at
    280280Times Square.  The data type ``rtems_time_of_day`` is used to specify calendar
    281 time in RTEMS services.  See `Time and Date Data Structures`_
     281time in RTEMS services.  See :ref:`Time and Date Data Structures`.
    282282
    283283.. index:: rtems_time_of_day
  • c_user/linker_sets.rst

    r4120668 r9aafb39  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
     6
     7.. _Linker Sets:
    68
    79Linker Sets
  • c_user/overview.rst

    r4120668 r9aafb39  
    232232RTEMS requires RAM to manage each instance of an RTEMS object that is created.
    233233Thus the more RTEMS objects an application needs, the more memory that must be
    234 reserved.  See Configuring a System_.
     234reserved.  See :ref:`Configuring a System`.
    235235
    236236RTEMS utilizes memory for both code and data space.  Although RTEMS' data space
  • c_user/semaphore_manager.rst

    r4120668 r9aafb39  
    6969when it reaches its synchronization point, thus unblocking the pending task.
    7070
     71.. _Nested Resource Access:
     72
    7173Nested Resource Access
    7274----------------------
     
    8789Simple binary semaphores do not allow nested access and so can be used for task
    8890synchronization.
     91
     92.. _Priority Inversion:
    8993
    9094Priority Inversion
     
    101105priority task is effectively prevented from executing by lower priority tasks.
    102106
     107.. _Priority Inheritance:
    103108
    104109Priority Inheritance
     
    130135any of the semaphores the task holds.  Only when the task releases ALL of the
    131136binary semaphores it holds will its priority be restored to the normal value.
     137
     138.. _Priority Ceiling:
    132139
    133140Priority Ceiling
     
    167174semaphores it holds will its priority be restored to the normal value.
    168175
     176.. _Multiprocessor Resource Sharing Protocol:
    169177
    170178Multiprocessor Resource Sharing Protocol
     
    184192semaphore to help out and temporarily borrow the right to execute on one of
    185193their assigned processors.
     194
     195.. _Building a Semaphore Attribute Set:
    186196
    187197Building a Semaphore Attribute Set
     
    249259         :alt: Semaphore Attributes
    250260
     261.. _Building a SEMAPHORE_OBTAIN Option Set:
     262
    251263Building a SEMAPHORE_OBTAIN Option Set
    252264--------------------------------------
     
    277289Operations
    278290==========
     291
     292.. _Creating a Semaphore:
    279293
    280294Creating a Semaphore
     
    296310calling task.
    297311
     312.. _Obtaining Semaphore IDs:
     313
    298314Obtaining Semaphore IDs
    299315-----------------------
     
    307323semaphore manager directives to access this semaphore.
    308324
     325.. _Acquiring a Semaphore:
     326
    309327Acquiring a Semaphore
    310328---------------------
     
    341359the holder's priority will be elevated.
    342360
     361.. _Releasing a Semaphore:
     362
    343363Releasing a Semaphore
    344364---------------------
     
    356376binary semaphores, then the task performing the ``rtems_semaphore_release``
    357377will have its priority restored to its normal value.
     378
     379.. _Deleting a Semaphore:
    358380
    359381Deleting a Semaphore
  • c_user/symmetric_multiprocessing_services.rst

    r4120668 r9aafb39  
    2121
    2222It must be explicitly enabled via the ``--enable-smp`` configure command line
    23 option.  To enable SMP in the application configuration see `Enable SMP Support
    24 for Applications`_.  The default scheduler for SMP applications supports up to
    25 32 processors and is a global fixed priority scheduler, see also
     23option.  To enable SMP in the application configuration see :ref:`Enable SMP
     24Support for Applications`.  The default scheduler for SMP applications supports
     25up to 32 processors and is a global fixed priority scheduler, see also
    2626:ref:`Configuring Clustered Schedulers`.  For example applications
    2727see:file:`testsuites/smptests`.
     
    2929.. warning::
    3030
    31    The SMP support in RTEMS is a work in progress. Before you start using this
    32    RTEMS version for SMP ask on the RTEMS mailing list.
     31   The SMP support in the release of RTEMS is a work in progress. Before you
     32   start using this RTEMS version for SMP ask on the RTEMS mailing list.
    3333
    3434This chapter describes the services related to Symmetric Multiprocessing
     
    198198- message queues,
    199199
    200 - semaphores using the `Priority Inheritance`_ protocol (priority boosting),
    201   and
    202 
    203 - semaphores using the `Multiprocessor Resource Sharing Protocol`_ (MrsP).
     200- semaphores using the :ref:`Priority Inheritance` protocol (priority
     201  boosting), and
     202
     203- semaphores using the :ref:`Multiprocessor Resource Sharing Protocol` (MrsP).
    204204
    205205The clustered scheduling approach enables separation of functions with
     
    208208inter-cluster synchronization primitives are used.  This is work in progress.
    209209
    210 For the configuration of clustered schedulers see `Configuring Clustered
    211 Schedulers`_.
    212 
    213 To set the scheduler of a task see `SCHEDULER_IDENT - Get ID of a scheduler`_
    214 and `TASK_SET_SCHEDULER - Set scheduler of a task`_.
     210For the configuration of clustered schedulers see :ref:`Configuring Clustered
     211Schedulers`.
     212
     213To set the scheduler of a task see :ref:`SCHEDULER_IDENT - Get ID of a
     214scheduler` and :ref:`TASK_SET_SCHEDULER - Set scheduler of a task`.
    215215
    216216Task Priority Queues
     
    719719
    720720.. _rtems_scheduler_ident:
     721.. _SCHEDULER_IDENT - Get ID of a scheduler:
    721722
    722723SCHEDULER_IDENT - Get ID of a scheduler
     
    750751
    751752Identifies a scheduler by its name.  The scheduler name is determined by the
    752 scheduler configuration.  See `Configuring a System`_.
     753scheduler configuration.  See :ref:`Configuring a System`.
    753754
    754755**NOTES:**
     
    832833
    833834.. _rtems_task_set_scheduler:
     835.. _TASK_SET_SCHEDULER - Set scheduler of a task:
    834836
    835837TASK_SET_SCHEDULER - Set scheduler of a task
  • c_user/user_extensions.rst

    r4120668 r9aafb39  
    44.. COMMENT: On-Line Applications Research Corporation (OAR).
    55.. COMMENT: All rights reserved.
     6
     7.. _User Extensions Manager:
    68
    79User Extensions Manager
Note: See TracChangeset for help on using the changeset viewer.