[211cafba] | 1 | @c COPYRIGHT (c) 1988-2008. |
---|
[ae68ff0] | 2 | @c On-Line Applications Research Corporation (OAR). |
---|
| 3 | @c All rights reserved. |
---|
| 4 | @c |
---|
[139b2e4a] | 5 | @c $Id$ |
---|
| 6 | @c |
---|
[ae68ff0] | 7 | |
---|
[bae90e1] | 8 | @c The following macros from confdefs.h have not been discussed in this |
---|
| 9 | @c chapter: |
---|
| 10 | @c |
---|
[6e58367] | 11 | @c CONFIGURE_NEWLIB_EXTENSION - probably not needed |
---|
[bae90e1] | 12 | @c |
---|
| 13 | @c In addition, there should be examples of defining your own |
---|
| 14 | @c Device Driver Table, Init task table, etc. |
---|
| 15 | @c |
---|
| 16 | @c Regardless, this is a big step up. :) |
---|
| 17 | @c |
---|
| 18 | |
---|
[ae68ff0] | 19 | @chapter Configuring a System |
---|
[20515fc] | 20 | |
---|
[794d745] | 21 | @section Introduction |
---|
| 22 | |
---|
| 23 | RTEMS must be configured for an application. This configuration |
---|
| 24 | information encompasses a variety of information including |
---|
| 25 | the length of each clock tick, the maximum number of each RTEMS |
---|
| 26 | object that can be created, the application initialization tasks, |
---|
[db9964f1] | 27 | the task scheduling algorithm to be used, |
---|
[794d745] | 28 | and the device drivers in the application. This information |
---|
| 29 | is placed in data structures that are given to RTEMS at |
---|
| 30 | system initialization time. This chapter details the |
---|
| 31 | format of these data structures as well as a simpler |
---|
| 32 | mechanism to automate the generation of these structures. |
---|
| 33 | |
---|
[ae10dbd] | 34 | @ifset is-Ada |
---|
| 35 | System configuration is ALWAYS done from C. When developing |
---|
| 36 | an Ada application, the user is responsible for creating at |
---|
| 37 | least one C file which contains the Ada run-time initialization |
---|
| 38 | and the RTEMS System Configuration. There is no Ada binding |
---|
| 39 | for RTEMS System Configuration information. Thus all examples |
---|
| 40 | and data structures shown in this chapter are in C. |
---|
| 41 | @end ifset |
---|
[794d745] | 42 | |
---|
[bae90e1] | 43 | @section Automatic Generation of System Configuration |
---|
| 44 | |
---|
[169502e] | 45 | @cindex confdefs.h |
---|
[794d745] | 46 | @findex confdefs.h |
---|
[169502e] | 47 | |
---|
[bfa0476] | 48 | RTEMS provides the @code{rtems/confdefs.h} C language header file that |
---|
[bae90e1] | 49 | based on the setting of a variety of macros can automatically |
---|
| 50 | produce nearly all of the configuration tables required |
---|
| 51 | by an RTEMS application. Rather than building the individual |
---|
[e95cfafb] | 52 | tables by hand, the application simply specifies the values |
---|
[bae90e1] | 53 | for the configuration parameters it wishes to set. In the following |
---|
| 54 | example, the configuration information for a simple system with |
---|
| 55 | a message queue and a time slice of 50 milliseconds is configured: |
---|
| 56 | |
---|
| 57 | @example |
---|
| 58 | @group |
---|
[6e58367] | 59 | #define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER |
---|
| 60 | #define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER |
---|
[bae90e1] | 61 | |
---|
| 62 | #define CONFIGURE_MICROSECONDS_PER_TICK 1000 /* 1 millisecond */ |
---|
| 63 | #define CONFIGURE_TICKS_PER_TIMESLICE 50 /* 50 milliseconds */ |
---|
| 64 | |
---|
[81ecc05b] | 65 | #define CONFIGURE_MAXIMUM_TASKS 4 |
---|
[bae90e1] | 66 | #define CONFIGURE_RTEMS_INIT_TASKS_TABLE |
---|
| 67 | @end group |
---|
| 68 | @end example |
---|
| 69 | |
---|
| 70 | This system will begin execution with the single initialization task |
---|
| 71 | named @code{Init}. It will be configured to have both a console |
---|
| 72 | device driver (for standard I/O) and a clock tick device driver. |
---|
| 73 | |
---|
| 74 | For each configuration parameter in the configuration tables, the |
---|
| 75 | macro corresponding to that field is discussed. Most systems |
---|
[bfa0476] | 76 | can be easily configured using the @code{rtems/confdefs.h} mechanism. |
---|
[bae90e1] | 77 | |
---|
[6e58367] | 78 | The @code{CONFIGURE_INIT} constant must be defined in order to |
---|
[bfa0476] | 79 | make @code{rtems/confdefs.h} instantiate the configuration data |
---|
[6e58367] | 80 | structures. This can only be defined in one source file per |
---|
[bfa0476] | 81 | application that includes @code{rtems/confdefs.h} or the symbol |
---|
[6e58367] | 82 | table will be instantiated multiple times and linking errors |
---|
| 83 | produced. |
---|
| 84 | |
---|
[81ecc05b] | 85 | The user should be aware that the defaults are intentionally |
---|
| 86 | set as low as possible. By default, no application resources |
---|
[bfa0476] | 87 | are configured. The @code{rtems/confdefs.h} file ensures that |
---|
[81ecc05b] | 88 | at least one application tasks or thread is configured |
---|
| 89 | and that at least one of the initialization task/thread |
---|
| 90 | tables is configured. |
---|
| 91 | |
---|
[bfa0476] | 92 | The @code{rtems/confdefs.h} file estimates the amount of |
---|
[81ecc05b] | 93 | memory required for the RTEMS Executive Workspace. This |
---|
| 94 | estimate is only as accurate as the information given |
---|
[bfa0476] | 95 | to @code{rtems/confdefs.h} and may be either too high or too |
---|
[81ecc05b] | 96 | low for a variety of reasons. Some of the reasons that |
---|
[bfa0476] | 97 | @code{rtems/confdefs.h} may reserve too much memory for RTEMS |
---|
[81ecc05b] | 98 | are: |
---|
| 99 | |
---|
| 100 | @itemize @bullet |
---|
| 101 | @item All tasks/threads are assumed to be floating point. |
---|
| 102 | @end itemize |
---|
| 103 | |
---|
| 104 | Conversely, there are many more reasons, the resource |
---|
| 105 | estimate could be too low: |
---|
| 106 | |
---|
| 107 | @itemize @bullet |
---|
| 108 | @item Task/thread stacks greater than minimum size must be |
---|
| 109 | accounted for explicitly by developer. |
---|
| 110 | |
---|
| 111 | @item Memory for messages is not included. |
---|
| 112 | |
---|
| 113 | @item Device driver requirements are not included. |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | @item Network stack requirements are not included. |
---|
| 117 | |
---|
| 118 | @item Requirements for add-on libraries are not included. |
---|
| 119 | @end itemize |
---|
| 120 | |
---|
[bfa0476] | 121 | In general, @code{rtems/confdefs.h} is very accurate when given |
---|
[81ecc05b] | 122 | enough information. However, it is quite easy to use |
---|
| 123 | a library and not account for its resources. |
---|
| 124 | |
---|
[1dbf307] | 125 | The following subsection list all of the constants which can be |
---|
| 126 | set by the user. |
---|
| 127 | |
---|
| 128 | @subsection Library Support Definitions |
---|
| 129 | |
---|
[6e58367] | 130 | This section defines the file system and IO library |
---|
| 131 | related configuration parameters supported by |
---|
[bfa0476] | 132 | @code{rtems/confdefs.h}. |
---|
[6e58367] | 133 | |
---|
[1dbf307] | 134 | @itemize @bullet |
---|
[d5671b1] | 135 | @findex CONFIGURE_MALLOC_STATISTICS |
---|
| 136 | @item @code{CONFIGURE_MALLOC_STATISTICS} is defined when the application |
---|
| 137 | wishes to enable the gathering of more detailed statistics on the |
---|
| 138 | C Malloc Family of routines. |
---|
| 139 | |
---|
| 140 | @findex CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK |
---|
| 141 | @item @code{CONFIGURE_MALLOC_BSP_SUPPORTS_SBRK} is defined by a BSP |
---|
| 142 | to indicate that it does not allocate all available memory to the |
---|
| 143 | C Program Heap used by the Malloc Family of routines. If defined, |
---|
| 144 | when @code{malloc()} is unable to allocate memory, it will call |
---|
| 145 | the BSP supplied @code{sbrk()} to obtain more memory. |
---|
| 146 | |
---|
[794d745] | 147 | @findex CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS |
---|
[6e58367] | 148 | @item @code{CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS} is set to the |
---|
| 149 | maximum number of files that can be concurrently open. Libio requires |
---|
| 150 | a Classic RTEMS semaphore for each file descriptor as well as one |
---|
[81ecc05b] | 151 | global one. The default value is 3 file descriptors which is |
---|
| 152 | enough to support standard input, output, and error output. |
---|
| 153 | |
---|
| 154 | @findex CONFIGURE_TERMIOS_DISABLED |
---|
| 155 | @item @code{CONFIGURE_TERMIOS_DISABLED} is defined if the |
---|
| 156 | software implementing POSIX termios functionality is |
---|
| 157 | not going to be used by this application. By default, this |
---|
| 158 | is not defined and resources are reserved for the |
---|
| 159 | termios functionality. |
---|
| 160 | |
---|
| 161 | @findex CONFIGURE_NUMBER_OF_TERMIOS_PORTS |
---|
| 162 | @item @code{CONFIGURE_NUMBER_OF_TERMIOS_PORTS} is set to the |
---|
| 163 | number of ports using the termios functionality. Each |
---|
| 164 | concurrently active termios port requires resources. |
---|
| 165 | By default, this is set to 1 so a console port can be |
---|
| 166 | used. |
---|
[6e58367] | 167 | |
---|
[794d745] | 168 | @findex CONFIGURE_HAS_OWN_MOUNT_TABLE |
---|
[6e58367] | 169 | @item @code{CONFIGURE_HAS_OWN_MOUNT_TABLE} is defined when the |
---|
| 170 | application provides their own filesystem mount table. The |
---|
| 171 | mount table is an array of @code{rtems_filesystem_mount_table_t} |
---|
| 172 | entries pointed to by the global variable |
---|
| 173 | @code{rtems_filesystem_mount_table}. The number of |
---|
| 174 | entries in this table is in an integer variable named |
---|
| 175 | @code{rtems_filesystem_mount_table_t}. |
---|
| 176 | |
---|
[81ecc05b] | 177 | @findex CONFIGURE_USE_IMFS_AS_BASE_FILESYSTEM |
---|
| 178 | @item @code{CONFIGURE_USE_IMFS_AS_BASE_FILESYSTEM} is defined |
---|
| 179 | if the application wishes to use the full functionality |
---|
| 180 | IMFS. By default, the miniIMFS is used. The miniIMFS |
---|
| 181 | is a minimal functionality subset of the In-Memory |
---|
| 182 | FileSystem (IMFS). The miniIMFS is comparable |
---|
[6e58367] | 183 | in functionality to the pseudo-filesystem name space provided |
---|
| 184 | before RTEMS release 4.5.0. The miniIMFS supports |
---|
| 185 | only directories and device nodes and is smaller in executable |
---|
[81ecc05b] | 186 | code size than the full IMFS. |
---|
[6e58367] | 187 | |
---|
[79e4227] | 188 | @findex CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM |
---|
| 189 | @item @code{CONFIGURE_USE_DEVFS_AS_BASE_FILESYSTEM} is defined |
---|
[7df0d541] | 190 | if the application wishes to use the device-only filesytem. The |
---|
[79e4227] | 191 | device-only filesystem supports only device nodes and is smaller |
---|
| 192 | in executable code size than the full IMFS and miniIMFS. |
---|
| 193 | |
---|
| 194 | @findex CONFIGURE_APPLICATION_DISABLE_FILESYSTEM |
---|
| 195 | @item @code{CONFIGURE_APPLICATION_DISABLE_FILESYSTEM} is defined |
---|
| 196 | if the application dose not intend to use any kind of filesystem |
---|
| 197 | supports(including printf family). |
---|
| 198 | |
---|
| 199 | |
---|
[5d2c65e] | 200 | @findex CONFIGURE_STACK_CHECKER_ENABLED |
---|
| 201 | @item @code{CONFIGURED_STACK_CHECKER_ENABLED} is defined when |
---|
| 202 | the application wishes to enable run-time stack bounds checking. |
---|
| 203 | This increases the time required to create tasks as well as adding |
---|
| 204 | overhead to each context switch. By default, this is not defined and |
---|
| 205 | thus stack checking is disabled. NOTE: In 4.9 and older, this was named |
---|
| 206 | @code{STACK_CHECKER_ON} |
---|
[6e58367] | 207 | |
---|
[1dbf307] | 208 | @end itemize |
---|
| 209 | |
---|
| 210 | @subsection Basic System Information |
---|
| 211 | |
---|
[6e58367] | 212 | This section defines the general system configuration parameters supported by |
---|
[bfa0476] | 213 | @code{rtems/confdefs.h}. |
---|
[6e58367] | 214 | |
---|
[1dbf307] | 215 | @itemize @bullet |
---|
[794d745] | 216 | @findex CONFIGURE_HAS_OWN_CONFIGURATION_TABLE |
---|
[6e58367] | 217 | @item @code{CONFIGURE_HAS_OWN_CONFIGURATION_TABLE} should only be defined |
---|
| 218 | if the application is providing their own complete set of configuration |
---|
| 219 | tables. |
---|
| 220 | |
---|
[794d745] | 221 | @findex CONFIGURE_EXECUTIVE_RAM_WORK_AREA |
---|
[6e58367] | 222 | @item @code{CONFIGURE_EXECUTIVE_RAM_WORK_AREA} is the base |
---|
| 223 | address of the RTEMS RAM Workspace. By default, this value |
---|
| 224 | is NULL indicating that the BSP is to determine the location |
---|
| 225 | of the RTEMS RAM Workspace. |
---|
| 226 | |
---|
[2f3e2e0] | 227 | @findex CONFIGURE_UNIFIED_WORK_AREAS |
---|
| 228 | @item @code{CONFIGURE_UNIFIED_WORK_AREAS} configures RTEMS to use a |
---|
| 229 | single memory pool for the RTEMS Workspace and C Program Heap. If not |
---|
| 230 | defined, there will be separate memory pools for the RTEMS Workspace and |
---|
[96a0303b] | 231 | C Program Heap. Having separate pools does have some advantages in the |
---|
[2f3e2e0] | 232 | event a task blows a stack or writes outside its memory area. However, |
---|
| 233 | in low memory systems the overhead of the two pools plus the potential |
---|
| 234 | for unused memory in either pool is very undesirable. |
---|
| 235 | |
---|
| 236 | In high memory environments, this is desirable when you want to use the |
---|
| 237 | RTEMS "unlimited" objects option. You will be able to create objects |
---|
| 238 | until you run out of all available memory rather then just until you |
---|
| 239 | run out of RTEMS Workspace. |
---|
| 240 | |
---|
[6e58367] | 241 | @item @code{CONFIGURE_MICROSECONDS_PER_TICK} is the length |
---|
| 242 | of time between clock ticks. By default, this is set to |
---|
| 243 | 10000 microseconds. |
---|
| 244 | |
---|
[794d745] | 245 | @findex CONFIGURE_TICKS_PER_TIMESLICE |
---|
[3e066540] | 246 | @item @code{CONFIGURE_TICKS_PER_TIMESLICE} is the length |
---|
| 247 | of the timeslice quantum in ticks for each task. By |
---|
| 248 | default, this is 50. |
---|
| 249 | |
---|
[e66dccf] | 250 | @findex CONFIGURE_MAXIMUM_PRIORITY |
---|
| 251 | @item @code{CONFIGURE_MAXIMUM_PRIORITY} is the maximum numeric priority |
---|
| 252 | of any task in the system and one less that the number of priority levels |
---|
| 253 | in the system. The numerically greatest priority is the logically lowest |
---|
| 254 | priority in the system and will thus be used by the IDLE task. Valid values |
---|
| 255 | for this configuration parameter must be one (1) less than than a power |
---|
| 256 | of two (2) between 4 and 256 inclusively. In other words, valid values |
---|
| 257 | are 3, 7, 31, 63, 127, and 255. Reducing the number of priorities in the |
---|
| 258 | system reduces the amount of memory allocated from the RTEMS Workspace. |
---|
| 259 | By default, RTEMS supports 256 priority levels ranging from 0 to 255 so |
---|
| 260 | the default value for this field is 255. |
---|
| 261 | |
---|
| 262 | @findex CONFIGURE_MICROSECONDS_PER_TICK |
---|
[0e3de75] | 263 | @fnindex CONFIGURE_MINIMUM_STACK_SIZE |
---|
| 264 | @item @code{CONFIGURE_MINIMUM_STACK_SIZE} is set to the number of bytes |
---|
| 265 | the application wants the minimum stack size to be for every task or |
---|
| 266 | thread in the system. By default, this is set to the recommended minimum |
---|
| 267 | stack size for this processor. |
---|
| 268 | |
---|
[66c50e2] | 269 | @fnindex CONFIGURE_INTERRUPT_STACK_SIZE |
---|
| 270 | @item @code{CONFIGURE_INTERRUPT_STACK_SIZE} is set to the |
---|
[b912f95] | 271 | size of the interrupt stack. The interrupt stack size is |
---|
| 272 | usually set by the BSP but since this memory may be allocated |
---|
| 273 | from the RTEMS Ram Workspace, it must be accounted for. The |
---|
| 274 | default for this field is the configured minimum stack size. [NOTE: |
---|
| 275 | In some BSPs, changing this constant does NOT change the |
---|
| 276 | size of the interrupt stack, only the amount of memory |
---|
| 277 | reserved for it.] If not specified, the interrupt stack |
---|
| 278 | will be of minimum size. The default value is the configured |
---|
| 279 | minimum stack size. |
---|
[66c50e2] | 280 | |
---|
[3e066540] | 281 | @findex CONFIGURE_TASK_STACK_ALLOCATOR |
---|
| 282 | @item @code{CONFIGURE_TASK_STACK_ALLOCATOR} |
---|
| 283 | may point to a user provided routine to allocate task stacks. |
---|
| 284 | The default value for this field is NULL which indicates that |
---|
| 285 | task stacks will be allocated from the RTEMS Workspace. |
---|
| 286 | |
---|
| 287 | @findex CONFIGURE_TASK_STACK_DEALLOCATOR |
---|
| 288 | @item @code{CONFIGURE_TASK_STACK_DEALLOCATOR} |
---|
| 289 | may point to a user provided routine to free task stacks. |
---|
| 290 | The default value for this field is NULL which indicates that |
---|
| 291 | task stacks will be allocated from the RTEMS Workspace. |
---|
| 292 | |
---|
| 293 | @findex CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY |
---|
| 294 | @item @code{CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY} |
---|
| 295 | indicates whether RTEMS should zero the RTEMS Workspace and |
---|
| 296 | C Program Heap as part of its initialization. If set to |
---|
| 297 | TRUE, the Workspace is zeroed. Otherwise, it is not. |
---|
| 298 | Unless overridden by the BSP, the default value for this |
---|
| 299 | field is FALSE. |
---|
[6e58367] | 300 | |
---|
[7bec8d0a] | 301 | @findex CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE |
---|
| 302 | @item @code{CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE} is a helper macro |
---|
| 303 | which is used to assist in computing the total amount of memory |
---|
| 304 | required for message buffers. Each message queue will have its |
---|
| 305 | own configuration with maximum message size and maximum number of |
---|
| 306 | pending messages. The interface for this macro is as follows: |
---|
| 307 | |
---|
| 308 | @example |
---|
| 309 | CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per) |
---|
| 310 | @end example |
---|
| 311 | |
---|
| 312 | Where @code{max_messages} is the maximum number of pending messages |
---|
| 313 | and @code{size_per} is the size in bytes of the user message. |
---|
| 314 | |
---|
[bfa0476] | 315 | @findex CONFIGURE_MESSAGE_BUFFER_MEMORY |
---|
| 316 | @item @code{CONFIGURE_MESSAGE_BUFFER_MEMORY} is set to the number of |
---|
| 317 | bytes the application requires to be reserved for pending message queue |
---|
| 318 | buffers. This value should include memory for all buffers across |
---|
[7bec8d0a] | 319 | all APIs. The default value is 0. |
---|
| 320 | |
---|
| 321 | The following illustrates how the help macro |
---|
| 322 | @code{CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE} can be used to assist in |
---|
| 323 | calculating the message buffer memory required. In this example, there |
---|
| 324 | are two message queues used in this application. The first message |
---|
| 325 | queue has maximum of 24 pending messages with the message structure |
---|
| 326 | defined by the type @code{one_message_type}. The other message queue |
---|
| 327 | has maximum of 500 pending messages with the message structure defined |
---|
| 328 | by the type @code{other_message_type}. |
---|
| 329 | |
---|
| 330 | @example |
---|
| 331 | |
---|
| 332 | #define CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE \ |
---|
| 333 | (CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \ |
---|
| 334 | 24, sizeof(one_message_type) + \ |
---|
| 335 | CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \ |
---|
| 336 | 500, sizeof(other_message_type) \ |
---|
| 337 | ) |
---|
| 338 | @end example |
---|
[bfa0476] | 339 | |
---|
[794d745] | 340 | @findex CONFIGURE_MEMORY_OVERHEAD |
---|
[6e58367] | 341 | @item @code{CONFIGURE_MEMORY_OVERHEAD} is set to the number of |
---|
[bfa0476] | 342 | kilobytes the application wishes to add to the requirements calculated |
---|
| 343 | by @code{rtems/confdefs.h}. The default value is 0. |
---|
[6e58367] | 344 | |
---|
[794d745] | 345 | @findex CONFIGURE_EXTRA_TASK_STACKS |
---|
[6e58367] | 346 | @item @code{CONFIGURE_EXTRA_TASK_STACKS} is set to the number of |
---|
| 347 | bytes the applications wishes to add to the task stack requirements |
---|
[bfa0476] | 348 | calculated by @code{rtems/confdefs.h}. This parameter is very important. |
---|
[6e58367] | 349 | If the application creates tasks with stacks larger then the |
---|
[bfa0476] | 350 | minimum, then that memory is NOT accounted for by @code{rtems/confdefs.h}. |
---|
[6e58367] | 351 | The default value is 0. |
---|
| 352 | |
---|
[1dbf307] | 353 | @end itemize |
---|
| 354 | |
---|
| 355 | NOTE: The required size of the Executive RAM Work Area is calculated |
---|
[bfa0476] | 356 | automatically when using the @code{rtems/confdefs.h} mechanism. |
---|
[1dbf307] | 357 | |
---|
[3e066540] | 358 | @c |
---|
| 359 | @c |
---|
| 360 | @c |
---|
| 361 | @subsection Idle Task Configuration |
---|
| 362 | |
---|
| 363 | This section defines the IDLE task related configuration parameters |
---|
| 364 | supported by @code{rtems/confdefs.h}. |
---|
| 365 | |
---|
| 366 | @itemize @bullet |
---|
| 367 | |
---|
| 368 | @fnindex CONFIGURE_IDLE_TASK_BODY |
---|
| 369 | @item @code{CONFIGURE_IDLE_TASK_BODY} is set to the method name |
---|
| 370 | corresponding to the application specific IDLE thread body. If |
---|
| 371 | not specified, the BSP or RTEMS default IDLE thread body will |
---|
| 372 | be used. The default value is NULL. |
---|
| 373 | |
---|
| 374 | @fnindex CONFIGURE_IDLE_TASK_STACK_SIZE |
---|
| 375 | @item @code{CONFIGURE_IDLE_TASK_STACK_SIZE} is set to the |
---|
| 376 | desired stack size for the IDLE task. If not specified, |
---|
| 377 | the IDLE task will have a stack of minimum size. The default |
---|
[b912f95] | 378 | value is the configured minimum stack size. |
---|
[3e066540] | 379 | |
---|
[e66dccf] | 380 | @fnindex CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION |
---|
| 381 | @item @code{CONFIGURE_IDLE_TASK_INITIALIZES_APPLICATION} is set to |
---|
| 382 | indicate that the user has configured @b{NO} user initialization tasks |
---|
| 383 | or threads and that the user provided IDLE task will perform application |
---|
| 384 | initialization and then transform itself into an IDLE task. If you |
---|
| 385 | use this option be careful, the user IDLE task @b{CANNOT} block at |
---|
| 386 | all during the initialization sequence. Further, once application |
---|
| 387 | initialization is complete, it must make itself preemptible and |
---|
| 388 | enter an IDLE body loop. By default, this is not the mode of operation |
---|
| 389 | and the user is assumed to provide one or more initialization tasks. |
---|
| 390 | |
---|
[3e066540] | 391 | @end itemize |
---|
| 392 | |
---|
[db9964f1] | 393 | @c |
---|
| 394 | @c |
---|
| 395 | @c |
---|
| 396 | @subsection Scheduler Algorithm Configuration |
---|
| 397 | This section defines the configuration parameters related to selecting |
---|
| 398 | a scheduling algorithm for an application. Regardless of whether |
---|
| 399 | @code{CONFIGURE_SCHEDULER_POLICY} is defined, if none of the other |
---|
| 400 | configuration parameters are set, then @code{rtems/confdefs.h} will define |
---|
| 401 | @code{CONFIGURE_SCHEDULER_PRIORITY} and will (re)define |
---|
| 402 | @code{CONFIGURE_SCHEDULER_POLICY} as @code{_Scheduler_Priority}. That is, |
---|
| 403 | @code{CONFIGURE_SCHEDULER_PRIORITY} is the default scheduling algorithm. |
---|
| 404 | |
---|
| 405 | @itemize @bullet |
---|
| 406 | @findex CONFIGURE_SCHEDULER_POLICY |
---|
| 407 | @item @code{CONFIGURE_SCHEDULER_POLICY} is defined to specify which |
---|
| 408 | scheduling algorithm an application will use. If it is undefined, |
---|
| 409 | then @code{rtems/confdefs.h} will define it based on the definition |
---|
| 410 | of the following configuration parameters. |
---|
| 411 | Valid values for this configuration parameter are: |
---|
| 412 | @code{_Scheduler_USER}, |
---|
| 413 | @code{_Scheduler_Priority}. |
---|
| 414 | |
---|
| 415 | @findex CONFIGURE_SCHEDULER_USER |
---|
| 416 | @item @code{CONFIGURE_SCHEDULER_USER} is defined if the application |
---|
| 417 | provides its own scheduling algorithm. If @code{CONFIGURE_SCHEDULER_USER} is |
---|
| 418 | defined then @code{CONFIGURE_SCHEDULER_ENTRY_USER} must be defined with the |
---|
| 419 | name of the application's initialization function. If both |
---|
| 420 | configuration parameters are defined and @code{CONFIGURE_SCHEDULER_POLICY} |
---|
| 421 | is undefined, then @code{CONFIGURE_SCHEDULER_POLICY} will be be defined as |
---|
| 422 | @code{_Scheduler_USER}. |
---|
| 423 | |
---|
| 424 | @findex CONFIGURE_SCHEDULER_ALL |
---|
| 425 | @item @code{CONFIGURE_SCHEDULER_ALL} is defined if the application |
---|
| 426 | chooses to include all of the RTEMS-provided schedulers. |
---|
| 427 | @code{CONFIGURE_SCHEDULER_ALL} will define all of the following configuration |
---|
| 428 | parameters and will use @code{CONFIGURE_SCHEDULER_POLICY} to select the |
---|
| 429 | algorithm to use. If @code{CONFIGURE_SCHEDULER_POLICY} is not defined, then |
---|
| 430 | @code{rtems/confdefs.h} will define it as @code{_Scheduler_Priority}. |
---|
| 431 | |
---|
| 432 | @findex CONFIGURE_SCHEDULER_PRIORITY |
---|
| 433 | @item @code{CONFIGURE_SCHEDULER_PRIORITY} is defined if the application |
---|
| 434 | will use the Priority Scheduling algorithm. |
---|
| 435 | If none of the previous configuration parameters are defined by the |
---|
| 436 | application, then @code{rtems/confdefs.h} will define |
---|
| 437 | @code{CONFIGURE_SCHEDULER_POLICY} as @code{_Scheduler_PRIORITY}. |
---|
| 438 | |
---|
| 439 | @end itemize |
---|
| 440 | |
---|
[3e066540] | 441 | @c |
---|
| 442 | @c |
---|
| 443 | @c |
---|
[1dbf307] | 444 | @subsection Device Driver Table |
---|
| 445 | |
---|
[6e58367] | 446 | This section defines the configuration parameters related |
---|
| 447 | to the automatic generation of a Device Driver Table. As |
---|
[bfa0476] | 448 | @code{rtems/confdefs.h} only is aware of a small set of |
---|
[6e58367] | 449 | standard device drivers, the generated Device Driver |
---|
| 450 | Table is suitable for simple applications with no |
---|
| 451 | custom device drivers. |
---|
| 452 | |
---|
[1dbf307] | 453 | @itemize @bullet |
---|
[794d745] | 454 | @findex CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE |
---|
[6e58367] | 455 | @item @code{CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE} is defined if |
---|
| 456 | the application wishes to provide their own Device Driver Table. |
---|
| 457 | The table generated is an array of @code{rtems_driver_address_table} |
---|
| 458 | entries named @code{Device_drivers}. By default, this is not |
---|
[bfa0476] | 459 | defined indicating the @code{rtems/confdefs.h} is providing the |
---|
[6e58367] | 460 | device driver table. |
---|
| 461 | |
---|
[6d00095] | 462 | @findex CONFIGURE_MAXIMUM_DRIVERS |
---|
| 463 | @item @code{CONFIGURE_MAXIMUM_DRIVERS} is defined |
---|
| 464 | as the number of device drivers per node. By default, this is |
---|
| 465 | set to 10. |
---|
| 466 | |
---|
[794d745] | 467 | @findex CONFIGURE_MAXIMUM_DEVICES |
---|
[6e58367] | 468 | @item @code{CONFIGURE_MAXIMUM_DEVICES} is defined |
---|
| 469 | to the number of individual devices that may be registered |
---|
[79e4227] | 470 | in the system. By default, this is set to 4. |
---|
[6e58367] | 471 | |
---|
[794d745] | 472 | @findex CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER |
---|
[6e58367] | 473 | @item @code{CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER} |
---|
| 474 | is defined |
---|
| 475 | if the application wishes to include the Console Device Driver. |
---|
| 476 | This device driver is responsible for providing standard input |
---|
| 477 | and output using "/dev/console". By default, this is not |
---|
| 478 | defined. |
---|
| 479 | |
---|
[794d745] | 480 | @findex CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER |
---|
[6e58367] | 481 | @item @code{CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER} |
---|
| 482 | is defined |
---|
[da78fee] | 483 | if the application wishes to include the Clock Device Driver. |
---|
| 484 | This device driver is responsible for providing a regular |
---|
| 485 | interrupt which invokes the @code{rtems_clock_tick} directive. |
---|
| 486 | By default, this is not defined. |
---|
[6e58367] | 487 | |
---|
[794d745] | 488 | @findex CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER |
---|
[6e58367] | 489 | @item @code{CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER} |
---|
| 490 | is defined if the application wishes to include the Timer Driver. |
---|
| 491 | This device driver is used to benchmark execution times |
---|
| 492 | by the RTEMS Timing Test Suites. By default, this is not |
---|
| 493 | defined. |
---|
| 494 | |
---|
[e31f420f] | 495 | @findex CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER |
---|
[343bb43] | 496 | @item @code{CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER} is defined |
---|
[e31f420f] | 497 | when the application does @b{NOT} want the Clock Device Driver |
---|
| 498 | and is @b{NOT} using the Timer Driver. The inclusion or |
---|
| 499 | exclusion of the Clock Driver must be explicit in typical |
---|
| 500 | user applications. This is intended to prevent the common |
---|
| 501 | user error of using the Hello World example as the baseline |
---|
| 502 | for an application and leaving out a clock tick source. |
---|
| 503 | |
---|
| 504 | @findex CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER |
---|
| 505 | @item @code{CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER} |
---|
[adfbb4a] | 506 | is defined if the application wishes to include the Real-Time Clock Driver. |
---|
| 507 | By default, this is not defined. |
---|
| 508 | |
---|
| 509 | @findex CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER |
---|
| 510 | @item @code{CONFIGURE_APPLICATION_NEEDS_WATCHDOG_DRIVER} |
---|
| 511 | is defined if the application wishes to include the Watchdog Driver. |
---|
[e31f420f] | 512 | By default, this is not defined. |
---|
[6e58367] | 513 | |
---|
[f1b90cc] | 514 | @findex CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER |
---|
| 515 | @item @code{CONFIGURE_APPLICATION_NEEDS_FRAME_BUFFER_DRIVER} |
---|
| 516 | is defined |
---|
| 517 | if the application wishes to include the BSP's Frame Buffer Device Driver. |
---|
| 518 | Most BSPs do not provide a Frame Buffer Device Driver. If this is |
---|
| 519 | defined and the BSP does not have this device driver, then the user |
---|
| 520 | will get a link time error for an undefined symbol. |
---|
| 521 | By default, this is not defined. |
---|
| 522 | |
---|
[794d745] | 523 | @findex CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER |
---|
[6e58367] | 524 | @item @code{CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER} |
---|
| 525 | is defined if the application wishes to include the Stub Device Driver. |
---|
| 526 | This device driver simply provides entry points that return |
---|
| 527 | successful and is primarily a test fixture. |
---|
| 528 | By default, this is not defined. |
---|
| 529 | |
---|
[3d92d46] | 530 | @findex CONFIGURE_BSP_PREREQUISITE_DRIVERS |
---|
| 531 | @item @code{CONFIGURE_BSP_PREREQUISITE_DRIVERS} is defined if the |
---|
| 532 | BSP has device drivers it needs to include in the Device Driver |
---|
| 533 | Table. This should be defined to the set of device driver entries that |
---|
| 534 | will be placed in the table at the @b{FRONT} of the Device Driver Table |
---|
| 535 | and initialized before any other drivers @b{INCLUDING} any application |
---|
| 536 | prerequisite drivers. By default,this is not defined. |
---|
| 537 | |
---|
| 538 | @findex CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS |
---|
| 539 | @item @code{CONFIGURE_APPLICATION_PREREQUISITE_DRIVERS} is defined if the |
---|
| 540 | application has device drivers it needs to include in the Device Driver |
---|
| 541 | Table. This should be defined to the set of device driver entries that |
---|
| 542 | will be placed in the table at the @b{FRONT} of the Device Driver Table |
---|
| 543 | and initialized before any other drivers @b{EXCEPT} any BSP prerequisite |
---|
| 544 | drivers. By default,this is not defined. |
---|
| 545 | |
---|
[68fe9f96] | 546 | @findex CONFIGURE_APPLICATION_EXTRA_DRIVERS |
---|
[3d92d46] | 547 | @item @code{CONFIGURE_APPLICATION_EXTRA_DRIVERS} is defined if the |
---|
| 548 | application has device drivers it needs to include in the Device Driver |
---|
| 549 | Table. This should be defined to the set of device driver entries that |
---|
| 550 | will be placed in the table at the @b{END} of the Device Driver Table. |
---|
| 551 | By default,this is not defined. |
---|
[68fe9f96] | 552 | |
---|
[1dbf307] | 553 | @end itemize |
---|
| 554 | |
---|
| 555 | @subsection Multiprocessing Configuration |
---|
| 556 | |
---|
[6e58367] | 557 | This section defines the multiprocessing related |
---|
[bfa0476] | 558 | system configuration parameters supported by @code{rtems/confdefs.h}. |
---|
[6e58367] | 559 | This class of Configuration Constants are only applicable if |
---|
| 560 | @code{CONFIGURE_MP_APPLICATION} is defined. |
---|
| 561 | |
---|
[1dbf307] | 562 | @itemize @bullet |
---|
[5622ddc4] | 563 | @findex CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE |
---|
| 564 | @item @code{CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE} is defined |
---|
[6e58367] | 565 | if the application wishes to provide their own Multiprocessing |
---|
| 566 | Configuration Table. The generated table is named |
---|
| 567 | @code{Multiprocessing_configuration}. By default, this |
---|
| 568 | is not defined. |
---|
| 569 | |
---|
[794d745] | 570 | @findex CONFIGURE_MP_NODE_NUMBER |
---|
[6e58367] | 571 | @item @code{CONFIGURE_MP_NODE_NUMBER} is the node number of |
---|
| 572 | this node in a multiprocessor system. The default node number |
---|
| 573 | is @code{NODE_NUMBER} which is set directly in RTEMS test Makefiles. |
---|
| 574 | |
---|
[794d745] | 575 | @findex CONFIGURE_MP_MAXIMUM_NODES |
---|
[6e58367] | 576 | @item @code{CONFIGURE_MP_MAXIMUM_NODES} is the maximum number |
---|
| 577 | of nodes in a multiprocessor system. The default is 2. |
---|
| 578 | |
---|
[794d745] | 579 | @findex CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS |
---|
[6e58367] | 580 | @item @code{CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS} |
---|
| 581 | is the maximum number |
---|
| 582 | of concurrently active global objects in a multiprocessor |
---|
| 583 | system. The default is 32. |
---|
| 584 | |
---|
[794d745] | 585 | @findex CONFIGURE_MP_MAXIMUM_PROXIES |
---|
[6e58367] | 586 | @item @code{CONFIGURE_MP_MAXIMUM_PROXIES} is the maximum number |
---|
| 587 | of concurrently active thread/task proxies in a multiprocessor |
---|
| 588 | system. The default is 32. |
---|
| 589 | |
---|
[794d745] | 590 | @findex CONFIGURE_MP_MPCI_TABLE_POINTER |
---|
[6e58367] | 591 | @item @code{CONFIGURE_MP_MPCI_TABLE_POINTER} is the pointer |
---|
| 592 | to the MPCI Configuration Table. The default value of |
---|
| 593 | this field is @code{&MPCI_table}. |
---|
[1dbf307] | 594 | @end itemize |
---|
| 595 | |
---|
| 596 | @subsection Classic API Configuration |
---|
| 597 | |
---|
[6e58367] | 598 | This section defines the Classic API related |
---|
[bfa0476] | 599 | system configuration parameters supported by @code{rtems/confdefs.h}. |
---|
[6e58367] | 600 | |
---|
[1dbf307] | 601 | @itemize @bullet |
---|
[794d745] | 602 | @findex CONFIGURE_MAXIMUM_TASKS |
---|
[6e58367] | 603 | @item @code{CONFIGURE_MAXIMUM_TASKS} is the maximum number of |
---|
| 604 | Classic API tasks that can be concurrently active. |
---|
[81ecc05b] | 605 | The default for this field is 0. |
---|
[6e58367] | 606 | |
---|
[a16a7949] | 607 | @findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS |
---|
| 608 | @item @code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} should be defined |
---|
[d695dfc] | 609 | if the user does not want to have support for Classic API Notepads |
---|
| 610 | in their application. By default, this is not defined and Classic API |
---|
| 611 | Notepads are supported. |
---|
| 612 | |
---|
[794d745] | 613 | @findex CONFIGURE_MAXIMUM_TIMERS |
---|
[6e58367] | 614 | @item @code{CONFIGURE_MAXIMUM_TIMERS} is the maximum number of |
---|
| 615 | Classic API timers that can be concurrently active. |
---|
| 616 | The default for this field is 0. |
---|
| 617 | |
---|
[794d745] | 618 | @findex CONFIGURE_MAXIMUM_SEMAPHORES |
---|
[6e58367] | 619 | @item @code{CONFIGURE_MAXIMUM_SEMAPHORES} is the maximum number of |
---|
| 620 | Classic API semaphores that can be concurrently active. |
---|
| 621 | The default for this field is 0. |
---|
| 622 | |
---|
[794d745] | 623 | @findex CONFIGURE_MAXIMUM_MESSAGE_QUEUES |
---|
[6e58367] | 624 | @item @code{CONFIGURE_MAXIMUM_MESSAGE_QUEUES} is the maximum number of |
---|
| 625 | Classic API message queues that can be concurrently active. |
---|
| 626 | The default for this field is 0. |
---|
| 627 | |
---|
[794d745] | 628 | @findex CONFIGURE_MAXIMUM_PARTITIONS |
---|
[6e58367] | 629 | @item @code{CONFIGURE_MAXIMUM_PARTITIONS} is the maximum number of |
---|
| 630 | Classic API partitions that can be concurrently active. |
---|
| 631 | The default for this field is 0. |
---|
| 632 | |
---|
[794d745] | 633 | @findex CONFIGURE_MAXIMUM_REGIONS |
---|
[6e58367] | 634 | @item @code{CONFIGURE_MAXIMUM_REGIONS} is the maximum number of |
---|
| 635 | Classic API regions that can be concurrently active. |
---|
| 636 | The default for this field is 0. |
---|
| 637 | |
---|
[794d745] | 638 | @findex CONFIGURE_MAXIMUM_PORTS |
---|
[6e58367] | 639 | @item @code{CONFIGURE_MAXIMUM_PORTS} is the maximum number of |
---|
| 640 | Classic API ports that can be concurrently active. |
---|
| 641 | The default for this field is 0. |
---|
| 642 | |
---|
[794d745] | 643 | @findex CONFIGURE_MAXIMUM_PERIODS |
---|
[6e58367] | 644 | @item @code{CONFIGURE_MAXIMUM_PERIODS} is the maximum number of |
---|
| 645 | Classic API rate monotonic periods that can be concurrently active. |
---|
| 646 | The default for this field is 0. |
---|
| 647 | |
---|
[794d745] | 648 | @findex CONFIGURE_MAXIMUM_USER_EXTENSIONS |
---|
[6e58367] | 649 | @item @code{CONFIGURE_MAXIMUM_USER_EXTENSIONS} is the maximum number of |
---|
| 650 | Classic API user extensions that can be concurrently active. |
---|
| 651 | The default for this field is 0. |
---|
| 652 | |
---|
[1dbf307] | 653 | @end itemize |
---|
| 654 | |
---|
[6e58367] | 655 | @subsection Classic API Initialization Tasks Table Configuration |
---|
| 656 | |
---|
[bfa0476] | 657 | The @code{rtems/confdefs.h} configuration system can automatically |
---|
[6e58367] | 658 | generate an Initialization Tasks Table named |
---|
| 659 | @code{Initialization_tasks} with a single entry. The following |
---|
| 660 | parameters control the generation of that table. |
---|
[1dbf307] | 661 | |
---|
| 662 | @itemize @bullet |
---|
[794d745] | 663 | @findex CONFIGURE_RTEMS_INIT_TASKS_TABLE |
---|
[6e58367] | 664 | @item @code{CONFIGURE_RTEMS_INIT_TASKS_TABLE} is defined |
---|
| 665 | if the user wishes to use a Classic RTEMS API Initialization |
---|
| 666 | Task Table. The application may choose to use the initialization |
---|
| 667 | tasks or threads table from another API. By default, this |
---|
| 668 | field is not defined as the user MUST select their own |
---|
| 669 | API for initialization tasks. |
---|
| 670 | |
---|
[794d745] | 671 | @findex CONFIGURE_HAS_OWN_INIT_TASK_TABLE |
---|
[6e58367] | 672 | @item @code{CONFIGURE_HAS_OWN_INIT_TASK_TABLE} is defined |
---|
| 673 | if the user wishes to define their own Classic API Initialization |
---|
| 674 | Tasks Table. This table should be named @code{Initialization_tasks}. |
---|
| 675 | By default, this is not defined. |
---|
| 676 | |
---|
[794d745] | 677 | @findex CONFIGURE_INIT_TASK_NAME |
---|
[6e58367] | 678 | @item @code{CONFIGURE_INIT_TASK_NAME} is the name |
---|
| 679 | of the single initialization task defined by the |
---|
| 680 | Classic API Initialization Tasks Table. By default |
---|
| 681 | the value is @code{rtems_build_name( 'U', 'I', '1', ' ' )}. |
---|
| 682 | |
---|
[794d745] | 683 | @findex CONFIGURE_INIT_TASK_STACK_SIZE |
---|
[6e58367] | 684 | @item @code{CONFIGURE_INIT_TASK_STACK_SIZE} |
---|
| 685 | is the stack size |
---|
| 686 | of the single initialization task defined by the |
---|
| 687 | Classic API Initialization Tasks Table. By default |
---|
[b912f95] | 688 | value is the configured minimum stack size. |
---|
[6e58367] | 689 | |
---|
[794d745] | 690 | @findex CONFIGURE_INIT_TASK_PRIORITY |
---|
[6e58367] | 691 | @item @code{CONFIGURE_INIT_TASK_PRIORITY} |
---|
| 692 | is the initial priority |
---|
| 693 | of the single initialization task defined by the |
---|
| 694 | Classic API Initialization Tasks Table. By default |
---|
| 695 | the value is 1 which is the highest priority |
---|
| 696 | in the Classic API. |
---|
| 697 | |
---|
[794d745] | 698 | @findex CONFIGURE_INIT_TASK_ATTRIBUTES |
---|
[6e58367] | 699 | @item @code{CONFIGURE_INIT_TASK_ATTRIBUTES} |
---|
| 700 | is the task attributes |
---|
| 701 | of the single initialization task defined by the |
---|
| 702 | Classic API Initialization Tasks Table. By default |
---|
| 703 | the value is @code{RTEMS_DEFAULT_ATTRIBUTES}. |
---|
| 704 | |
---|
[794d745] | 705 | @findex CONFIGURE_INIT_TASK_ENTRY_POINT |
---|
[6e58367] | 706 | @item @code{CONFIGURE_INIT_TASK_ENTRY_POINT} |
---|
| 707 | is the entry point (a.k.a. function name) |
---|
| 708 | of the single initialization task defined by the |
---|
| 709 | Classic API Initialization Tasks Table. By default |
---|
| 710 | the value is @code{Init}. |
---|
| 711 | |
---|
[794d745] | 712 | @findex CONFIGURE_INIT_TASK_INITIAL_MODES |
---|
[6e58367] | 713 | @item @code{CONFIGURE_INIT_TASK_INITIAL_MODES} |
---|
| 714 | is the initial execution mode |
---|
| 715 | of the single initialization task defined by the |
---|
| 716 | Classic API Initialization Tasks Table. By default |
---|
| 717 | the value is @code{RTEMS_NO_PREEMPT}. |
---|
| 718 | |
---|
[794d745] | 719 | @findex CONFIGURE_INIT_TASK_ARGUMENTS |
---|
[6e58367] | 720 | @item @code{CONFIGURE_INIT_TASK_ARGUMENTS} |
---|
| 721 | is the task argument |
---|
| 722 | of the single initialization task defined by the |
---|
| 723 | Classic API Initialization Tasks Table. By default |
---|
| 724 | the value is 0. |
---|
| 725 | |
---|
[1dbf307] | 726 | @end itemize |
---|
| 727 | |
---|
| 728 | |
---|
| 729 | @subsection POSIX API Configuration |
---|
| 730 | |
---|
[6e58367] | 731 | The parameters in this section are used to configure resources |
---|
| 732 | for the RTEMS POSIX API. They are only relevant if the POSIX API |
---|
| 733 | is enabled at configure time using the @code{--enable-posix} option. |
---|
| 734 | |
---|
[1dbf307] | 735 | @itemize @bullet |
---|
[794d745] | 736 | @findex CONFIGURE_MAXIMUM_POSIX_THREADS |
---|
[6e58367] | 737 | @item @code{CONFIGURE_MAXIMUM_POSIX_THREADS} is the maximum number of |
---|
| 738 | POSIX API threads that can be concurrently active. |
---|
[81ecc05b] | 739 | The default is 0. |
---|
[6e58367] | 740 | |
---|
[794d745] | 741 | @findex CONFIGURE_MAXIMUM_POSIX_MUTEXES |
---|
[6e58367] | 742 | @item @code{CONFIGURE_MAXIMUM_POSIX_MUTEXES} is the maximum number of |
---|
| 743 | POSIX API mutexes that can be concurrently active. |
---|
| 744 | The default is 0. |
---|
| 745 | |
---|
[794d745] | 746 | @findex CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES |
---|
[6e58367] | 747 | @item @code{CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES} is the maximum number of |
---|
| 748 | POSIX API condition variables that can be concurrently active. |
---|
| 749 | The default is 0. |
---|
| 750 | |
---|
[794d745] | 751 | @findex CONFIGURE_MAXIMUM_POSIX_KEYS |
---|
[6e58367] | 752 | @item @code{CONFIGURE_MAXIMUM_POSIX_KEYS} is the maximum number of |
---|
| 753 | POSIX API keys that can be concurrently active. |
---|
| 754 | The default is 0. |
---|
| 755 | |
---|
[794d745] | 756 | @findex CONFIGURE_MAXIMUM_POSIX_TIMERS |
---|
[6e58367] | 757 | @item @code{CONFIGURE_MAXIMUM_POSIX_TIMERS} is the maximum number of |
---|
| 758 | POSIX API timers that can be concurrently active. |
---|
| 759 | The default is 0. |
---|
| 760 | |
---|
[794d745] | 761 | @findex CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS |
---|
[6e58367] | 762 | @item @code{CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS} is the maximum number of |
---|
| 763 | POSIX API queued signals that can be concurrently active. |
---|
| 764 | The default is 0. |
---|
| 765 | |
---|
[794d745] | 766 | @findex CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES |
---|
[6e58367] | 767 | @item @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES} is the maximum number of |
---|
| 768 | POSIX API message queues that can be concurrently active. |
---|
| 769 | The default is 0. |
---|
| 770 | |
---|
[794d745] | 771 | @findex CONFIGURE_MAXIMUM_POSIX_SEMAPHORES |
---|
[6e58367] | 772 | @item @code{CONFIGURE_MAXIMUM_POSIX_SEMAPHORES} is the maximum number of |
---|
| 773 | POSIX API semaphores that can be concurrently active. |
---|
| 774 | The default is 0. |
---|
| 775 | |
---|
[1dbf307] | 776 | @end itemize |
---|
| 777 | |
---|
[6e58367] | 778 | @subsection POSIX Initialization Threads Table Configuration |
---|
| 779 | |
---|
[bfa0476] | 780 | The @code{rtems/confdefs.h} configuration system can automatically |
---|
[6e58367] | 781 | generate a POSIX Initialization Threads Table named |
---|
| 782 | @code{POSIX_Initialization_threads} with a single entry. The following |
---|
| 783 | parameters control the generation of that table. |
---|
[1dbf307] | 784 | |
---|
| 785 | @itemize @bullet |
---|
[794d745] | 786 | @findex CONFIGURE_POSIX_INIT_THREAD_TABLE |
---|
[6e58367] | 787 | @item @code{CONFIGURE_POSIX_INIT_THREAD_TABLE} |
---|
| 788 | is defined |
---|
| 789 | if the user wishes to use a POSIX API Initialization |
---|
| 790 | Threads Table. The application may choose to use the initialization |
---|
| 791 | tasks or threads table from another API. By default, this |
---|
| 792 | field is not defined as the user MUST select their own |
---|
| 793 | API for initialization tasks. |
---|
| 794 | |
---|
[794d745] | 795 | @findex CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE |
---|
[6e58367] | 796 | @item @code{CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE} |
---|
| 797 | is defined if the user wishes to define their own POSIX API Initialization |
---|
| 798 | Threads Table. This table should be named @code{POSIX_Initialization_threads}. |
---|
| 799 | By default, this is not defined. |
---|
| 800 | |
---|
[794d745] | 801 | @findex CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT |
---|
[6e58367] | 802 | @item @code{CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT} |
---|
| 803 | is the entry point (a.k.a. function name) |
---|
| 804 | of the single initialization thread defined by the |
---|
| 805 | POSIX API Initialization Threads Table. By default |
---|
| 806 | the value is @code{POSIX_Init}. |
---|
| 807 | |
---|
[794d745] | 808 | @findex CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE |
---|
[6e58367] | 809 | @item @code{CONFIGURE_POSIX_INIT_THREAD_STACK_SIZE} |
---|
| 810 | is the stack size of the single initialization thread defined by the |
---|
| 811 | POSIX API Initialization Threads Table. By default |
---|
[b912f95] | 812 | value is twice the configured minimum stack size. |
---|
[6e58367] | 813 | |
---|
[1dbf307] | 814 | @end itemize |
---|
| 815 | |
---|
| 816 | @subsection Ada Tasks |
---|
| 817 | |
---|
[6e58367] | 818 | This section defines the system configuration parameters supported |
---|
[bfa0476] | 819 | by @code{rtems/confdefs.h} related to configuring RTEMS to support |
---|
[6e58367] | 820 | a task using Ada tasking with GNAT. |
---|
| 821 | |
---|
[1dbf307] | 822 | @itemize @bullet |
---|
[794d745] | 823 | @findex CONFIGURE_GNAT_RTEMS |
---|
[6e58367] | 824 | @item @code{CONFIGURE_GNAT_RTEMS} is defined to inform |
---|
| 825 | RTEMS that the GNAT Ada run-time is to be used by the |
---|
| 826 | application. This configuration parameter is critical |
---|
[bfa0476] | 827 | as it makes @code{rtems/confdefs.h} configure the resources |
---|
[6e58367] | 828 | (mutexes and keys) used implicitly by the GNAT run-time. |
---|
| 829 | By default, this parameter is not defined. |
---|
| 830 | |
---|
[794d745] | 831 | @findex CONFIGURE_MAXIMUM_ADA_TASKS |
---|
[6e58367] | 832 | @item @code{CONFIGURE_MAXIMUM_ADA_TASKS} is the |
---|
| 833 | number of Ada tasks that can be concurrently active |
---|
| 834 | in the system. By default, when @code{CONFIGURE_GNAT_RTEMS} |
---|
| 835 | is defined, this is set to 20. |
---|
| 836 | |
---|
[794d745] | 837 | @findex CONFIGURE_MAXIMUM_FAKE_ADA_TASKS |
---|
[6e58367] | 838 | @item @code{CONFIGURE_MAXIMUM_FAKE_ADA_TASKS} is |
---|
| 839 | the number of "fake" Ada tasks that can be concurrently |
---|
| 840 | active in the system. A "fake" Ada task is a non-Ada |
---|
| 841 | task that makes calls back into Ada code and thus |
---|
| 842 | implicitly uses the Ada run-time. |
---|
| 843 | |
---|
[1dbf307] | 844 | @end itemize |
---|
| 845 | |
---|
[ae68ff0] | 846 | @section Configuration Table |
---|
| 847 | |
---|
[169502e] | 848 | @cindex Configuration Table |
---|
| 849 | @cindex RTEMS Configuration Table |
---|
| 850 | |
---|
[ae68ff0] | 851 | The RTEMS Configuration Table is used to tailor an |
---|
| 852 | application for its specific needs. For example, the user can |
---|
| 853 | configure the number of device drivers or which APIs may be used. |
---|
| 854 | THe address of the user-defined Configuration Table is passed as an |
---|
[ae10dbd] | 855 | argument to the @code{rtems_initialize_executive} |
---|
[75e22db] | 856 | directive, which MUST be the first RTEMS directive called. |
---|
[ae10dbd] | 857 | The RTEMS Configuration Table is defined in the following C structure: |
---|
[ae68ff0] | 858 | |
---|
[adee5979] | 859 | @findex rtems_configuration_table |
---|
[ae68ff0] | 860 | @example |
---|
| 861 | @group |
---|
| 862 | typedef struct @{ |
---|
[ae10dbd] | 863 | void *work_space_start; |
---|
[6d96c98] | 864 | uintptr_t work_space_size; |
---|
[ae10dbd] | 865 | uint32_t maximum_extensions; |
---|
| 866 | uint32_t microseconds_per_tick; |
---|
| 867 | uint32_t ticks_per_timeslice; |
---|
[db9964f1] | 868 | uint32_t scheduler_policy; |
---|
[3e066540] | 869 | void (*idle_task)( void ); |
---|
| 870 | uint32_t idle_task_stack_size; |
---|
[66c50e2] | 871 | uint32_t interrupt_stack_size; |
---|
[7c9c8c8c] | 872 | void * (*stack_allocate_hook)( size_t ); |
---|
[3e066540] | 873 | void (*stack_free_hook)( void * ); |
---|
[eaf1c0c] | 874 | bool do_zero_of_workspace; |
---|
[ae10dbd] | 875 | uint32_t maximum_drivers; |
---|
| 876 | uint32_t number_of_device_drivers; |
---|
| 877 | rtems_driver_address_table *Device_driver_table; |
---|
| 878 | uint32_t number_of_initial_extensions; |
---|
| 879 | rtems_extensions_table *User_extension_table; |
---|
[3e066540] | 880 | #if defined(RTEMS_MULTIPROCESSING) |
---|
[ae10dbd] | 881 | rtems_multiprocessing_table *User_multiprocessing_table; |
---|
[3e066540] | 882 | #endif |
---|
[ae10dbd] | 883 | rtems_api_configuration_table *RTEMS_api_configuration; |
---|
| 884 | posix_api_configuration_table *POSIX_api_configuration; |
---|
[ae68ff0] | 885 | @} rtems_configuration_table; |
---|
| 886 | @end group |
---|
| 887 | @end example |
---|
| 888 | |
---|
| 889 | @table @b |
---|
| 890 | @item work_space_start |
---|
| 891 | is the address of the RTEMS RAM Workspace. |
---|
| 892 | This area contains items such as the |
---|
| 893 | various object control blocks (TCBs, QCBs, ...) and task stacks. |
---|
| 894 | If the address is not aligned on a four-word boundary, then |
---|
| 895 | RTEMS will invoke the fatal error handler during |
---|
[ae10dbd] | 896 | @code{rtems_initialize_executive}. |
---|
[bfa0476] | 897 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 898 | an RTEMS application, the value for this field corresponds |
---|
[adee5979] | 899 | to the setting of the macro @code{CONFIGURE_EXECUTIVE_RAM_WORK_AREA} |
---|
| 900 | which defaults to @code{NULL}. Normally, this field should be |
---|
| 901 | configured as @code{NULL} as BSPs will assign memory for the |
---|
| 902 | RTEMS RAM Workspace as part of system initialization. |
---|
[ae68ff0] | 903 | |
---|
| 904 | @item work_space_size |
---|
| 905 | is the calculated size of the |
---|
| 906 | RTEMS RAM Workspace. The section Sizing the RTEMS RAM Workspace |
---|
| 907 | details how to arrive at this number. |
---|
[bfa0476] | 908 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 909 | an RTEMS application, the value for this field corresponds |
---|
| 910 | to the setting of the macro @code{CONFIGURE_EXECUTIVE_RAM_SIZE} |
---|
| 911 | and is calculated based on the other system configuration settings. |
---|
[ae68ff0] | 912 | |
---|
| 913 | @item microseconds_per_tick |
---|
| 914 | is number of microseconds per clock tick. |
---|
[bfa0476] | 915 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 916 | an RTEMS application, the value for this field corresponds |
---|
| 917 | to the setting of the macro @code{CONFIGURE_MICROSECONDS_PER_TICK}. |
---|
[adee5979] | 918 | If not defined by the application, then the |
---|
| 919 | @code{CONFIGURE_MICROSECONDS_PER_TICK} macro defaults to 10000 |
---|
| 920 | (10 milliseconds). |
---|
[ae68ff0] | 921 | |
---|
| 922 | @item ticks_per_timeslice |
---|
| 923 | is the number of clock ticks for a timeslice. |
---|
[bfa0476] | 924 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 925 | an RTEMS application, the value for this field corresponds |
---|
| 926 | to the setting of the macro @code{CONFIGURE_TICKS_PER_TIMESLICE}. |
---|
[ae68ff0] | 927 | |
---|
[db9964f1] | 928 | @item scheduler_policy |
---|
| 929 | is the algorithm to use for task scheduling. |
---|
| 930 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
| 931 | an RTEMS application, the value for this field corresponds |
---|
| 932 | to the setting of the macro @code{CONFIGURE_SCHEDULER_POLICY}. |
---|
| 933 | |
---|
[3e066540] | 934 | @item idle_task |
---|
| 935 | is the address of the optional user |
---|
| 936 | provided routine which is used as the system's IDLE task. If |
---|
| 937 | this field is not NULL, then the RTEMS default IDLE task is not |
---|
| 938 | used. This field may be NULL to indicate that the default IDLE |
---|
| 939 | is to be used. When using the @code{rtems/confdefs.h} mechanism |
---|
| 940 | for configuring an RTEMS application, the value for this field |
---|
| 941 | corresponds to the setting of the macro @code{CONFIGURE_IDLE_TASK_BODY}. |
---|
| 942 | |
---|
| 943 | @item idle_task_stack_size |
---|
[b912f95] | 944 | is the size of the RTEMS idle task stack in bytes. If this number is less |
---|
| 945 | than the configured minimum stack size, then the idle task's stack will |
---|
| 946 | be set to the minimum. When using the @code{rtems/confdefs.h} mechanism |
---|
| 947 | for configuring an RTEMS application, the value for this field corresponds |
---|
| 948 | to the setting of the macro @code{CONFIGURE_IDLE_TASK_STACK_SIZE}. |
---|
[3e066540] | 949 | |
---|
[66c50e2] | 950 | @item interrupt_stack_size |
---|
[b912f95] | 951 | is the size of the RTEMS interrupt stack in bytes. If this number is less |
---|
| 952 | than configured minimum stack size, then the interrupt stack will be set |
---|
| 953 | to the minimum. When using the @code{rtems/confdefs.h} mechanism for |
---|
| 954 | configuring an RTEMS application, the value for this field corresponds |
---|
| 955 | to the setting of the macro @code{CONFIGURE_INTERRUPT_STACK_SIZE}. |
---|
[66c50e2] | 956 | |
---|
[3e066540] | 957 | @item stack_allocate_hook |
---|
| 958 | may point to a user provided routine to allocate task stacks. |
---|
| 959 | The default is to allocate task stacks from the RTEMS Workspace. |
---|
| 960 | When using the @code{rtems/confdefs.h} mechanism |
---|
| 961 | for configuring an RTEMS application, the value for this field |
---|
| 962 | corresponds to the setting of the macro |
---|
| 963 | @code{CONFIGURE_TASK_STACK_ALLOCATOR}. |
---|
| 964 | |
---|
| 965 | @item stack_free_hook |
---|
| 966 | may point to a user provided routine to free task stacks. |
---|
| 967 | The default is to allocate task stacks from the RTEMS Workspace. |
---|
| 968 | When using the @code{rtems/confdefs.h} mechanism |
---|
| 969 | for configuring an RTEMS application, the value for this field |
---|
| 970 | corresponds to the setting of the macro |
---|
| 971 | @code{CONFIGURE_TASK_STACK_DEALLOCATOR}. |
---|
| 972 | |
---|
| 973 | @item do_zero_of_workspace |
---|
| 974 | indicates whether RTEMS should zero the RTEMS Workspace and |
---|
| 975 | C Program Heap as part of its initialization. If set to |
---|
| 976 | TRUE, the Workspace is zeroed. Otherwise, it is not. |
---|
| 977 | When using the @code{rtems/confdefs.h} mechanism |
---|
| 978 | for configuring an RTEMS application, the value for this field |
---|
| 979 | corresponds to the setting of the macro |
---|
| 980 | @code{CONFIGURE_ZERO_WORKSPACE_AUTOMATICALLY}. |
---|
| 981 | |
---|
[6d00095] | 982 | @item maximum_drivers |
---|
| 983 | is the maximum number of device drivers that can be registered. |
---|
[bfa0476] | 984 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[6d00095] | 985 | an RTEMS application, the value for this field corresponds |
---|
| 986 | to the setting of the macro @code{CONFIGURE_MAXIMUM_DRIVERS}. |
---|
| 987 | |
---|
[ae68ff0] | 988 | @item number_of_device_drivers |
---|
| 989 | is the number of device drivers for the system. There should be |
---|
| 990 | the same number of entries in the Device Driver Table. If this field |
---|
[bae90e1] | 991 | is zero, then the @code{User_driver_address_table} entry should be NULL. |
---|
[bfa0476] | 992 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 993 | an RTEMS application, the value for this field is calculated |
---|
| 994 | automatically based on the number of entries in the |
---|
| 995 | Device Driver Table. This calculation is based on the assumption |
---|
| 996 | that the Device Driver Table is named @code{Device_drivers} |
---|
| 997 | and defined in C. This table may be generated automatically |
---|
| 998 | for simple applications using only the device drivers that correspond |
---|
| 999 | to the following macros: |
---|
| 1000 | |
---|
| 1001 | @itemize @bullet |
---|
| 1002 | |
---|
[6e58367] | 1003 | @item @code{CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER} |
---|
| 1004 | @item @code{CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER} |
---|
| 1005 | @item @code{CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER} |
---|
| 1006 | @item @code{CONFIGURE_APPLICATION_NEEDS_RTC_DRIVER} |
---|
| 1007 | @item @code{CONFIGURE_APPLICATION_NEEDS_STUB_DRIVER} |
---|
[bae90e1] | 1008 | |
---|
| 1009 | @end itemize |
---|
| 1010 | |
---|
| 1011 | Note that network device drivers are not configured in the |
---|
| 1012 | Device Driver Table. |
---|
[ae68ff0] | 1013 | |
---|
| 1014 | @item Device_driver_table |
---|
| 1015 | is the address of the Device Driver Table. This table contains the entry |
---|
| 1016 | points for each device driver. If the number_of_device_drivers field is zero, |
---|
| 1017 | then this entry should be NULL. The format of this table will be |
---|
| 1018 | discussed below. |
---|
[bfa0476] | 1019 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1020 | an RTEMS application, the Device Driver Table is assumed to be |
---|
| 1021 | named @code{Device_drivers} and defined in C. If the application is providing |
---|
| 1022 | its own Device Driver Table, then the macro |
---|
| 1023 | @code{CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE} must be defined to indicate |
---|
[bfa0476] | 1024 | this and prevent @code{rtems/confdefs.h} from generating the table. |
---|
[ae68ff0] | 1025 | |
---|
[9b64c2d5] | 1026 | @item number_of_initial_extensions |
---|
| 1027 | is the number of initial user extensions. There should be |
---|
| 1028 | the same number of entries as in the User_extension_table. If this field |
---|
| 1029 | is zero, then the User_driver_address_table entry should be NULL. |
---|
[bfa0476] | 1030 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1031 | an RTEMS application, the value for this field corresponds |
---|
| 1032 | to the setting of the macro @code{CONFIGURE_NUMBER_OF_INITIAL_EXTENSIONS} |
---|
[bfa0476] | 1033 | which is set automatically by @code{rtems/confdefs.h} based on the size |
---|
[bae90e1] | 1034 | of the User Extensions Table. |
---|
[9b64c2d5] | 1035 | |
---|
[ae68ff0] | 1036 | @item User_extension_table |
---|
| 1037 | is the address of the User |
---|
| 1038 | Extension Table. This table contains the entry points for the |
---|
| 1039 | static set of optional user extensions. If no user extensions |
---|
| 1040 | are configured, then this entry should be NULL. The format of |
---|
| 1041 | this table will be discussed below. |
---|
[bfa0476] | 1042 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1043 | an RTEMS application, the User Extensions Table is named |
---|
| 1044 | @code{Configuration_Initial_Extensions} and defined in |
---|
| 1045 | confdefs.h. It is initialized based on the following |
---|
| 1046 | macros: |
---|
| 1047 | |
---|
| 1048 | @itemize @bullet |
---|
| 1049 | |
---|
| 1050 | @item @code{CONFIGURE_INITIAL_EXTENSIONS} |
---|
| 1051 | @item @code{STACK_CHECKER_EXTENSION} |
---|
| 1052 | |
---|
| 1053 | @end itemize |
---|
| 1054 | |
---|
| 1055 | The application may configure one or more initial user extension |
---|
| 1056 | sets by setting the @code{CONFIGURE_INITIAL_EXTENSIONS} macro. By |
---|
| 1057 | defining the @code{STACK_CHECKER_EXTENSION} macro, the task stack bounds |
---|
| 1058 | checking user extension set is automatically included in the |
---|
| 1059 | application. |
---|
[ae68ff0] | 1060 | |
---|
| 1061 | @item User_multiprocessing_table |
---|
| 1062 | is the address of the Multiprocessor Configuration Table. This |
---|
| 1063 | table contains information needed by RTEMS only when used in a multiprocessor |
---|
| 1064 | configuration. This field must be NULL when RTEMS is used in a |
---|
| 1065 | single processor configuration. |
---|
[bfa0476] | 1066 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1067 | an RTEMS application, the Multiprocessor Configuration Table |
---|
[adee5979] | 1068 | is automatically generated when the @code{CONFIGURE_MP_APPLICATION} |
---|
| 1069 | is defined. If @code{CONFIGURE_MP_APPLICATION} is not defined, the this |
---|
[bae90e1] | 1070 | entry is set to NULL. The generated table has the name |
---|
| 1071 | @code{Multiprocessing_configuration}. |
---|
[ae68ff0] | 1072 | |
---|
| 1073 | @item RTEMS_api_configuration |
---|
| 1074 | is the address of the RTEMS API Configuration Table. This table |
---|
| 1075 | contains information needed by the RTEMS API. This field should be |
---|
| 1076 | NULL if the RTEMS API is not used. [NOTE: Currently the RTEMS API |
---|
| 1077 | is required to support support components such as BSPs and libraries |
---|
[bae90e1] | 1078 | which use this API.] This table is built automatically and this |
---|
[bfa0476] | 1079 | entry filled in, if using the @code{rtems/confdefs.h} application |
---|
[bae90e1] | 1080 | configuration mechanism. The generated table has the name |
---|
| 1081 | @code{Configuration_RTEMS_API}. |
---|
[ae68ff0] | 1082 | |
---|
| 1083 | @item POSIX_api_configuration |
---|
| 1084 | is the address of the POSIX API Configuration Table. This table |
---|
| 1085 | contains information needed by the POSIX API. This field should be |
---|
[bae90e1] | 1086 | NULL if the POSIX API is not used. This table is built automatically |
---|
[bfa0476] | 1087 | and this entry filled in, if using the @code{rtems/confdefs.h} application |
---|
| 1088 | configuration mechanism. The @code{rtems/confdefs.h} application |
---|
[bae90e1] | 1089 | mechanism will fill this field in with the address of the |
---|
| 1090 | @code{Configuration_POSIX_API} table of POSIX API is configured |
---|
| 1091 | and NULL if the POSIX API is not configured. |
---|
[ae68ff0] | 1092 | |
---|
| 1093 | @end table |
---|
| 1094 | |
---|
| 1095 | @section RTEMS API Configuration Table |
---|
| 1096 | |
---|
[169502e] | 1097 | @cindex RTEMS API Configuration Table |
---|
| 1098 | |
---|
[ae68ff0] | 1099 | The RTEMS API Configuration Table is used to configure the |
---|
| 1100 | managers which constitute the RTEMS API for a particular application. |
---|
| 1101 | For example, the user can configure the maximum number of tasks for |
---|
| 1102 | this application. The RTEMS API Configuration Table is defined in |
---|
[ae10dbd] | 1103 | the following C structure: |
---|
[ae68ff0] | 1104 | |
---|
[adee5979] | 1105 | @findex rtems_api_configuration_table |
---|
[ae68ff0] | 1106 | @example |
---|
| 1107 | @group |
---|
| 1108 | typedef struct @{ |
---|
[ae10dbd] | 1109 | uint32_t maximum_tasks; |
---|
| 1110 | uint32_t maximum_timers; |
---|
| 1111 | uint32_t maximum_semaphores; |
---|
| 1112 | uint32_t maximum_message_queues; |
---|
| 1113 | uint32_t maximum_partitions; |
---|
| 1114 | uint32_t maximum_regions; |
---|
| 1115 | uint32_t maximum_ports; |
---|
| 1116 | uint32_t maximum_periods; |
---|
| 1117 | uint32_t maximum_barriers; |
---|
| 1118 | uint32_t number_of_initialization_tasks; |
---|
[ae68ff0] | 1119 | rtems_initialization_tasks_table *User_initialization_tasks_table; |
---|
| 1120 | @} rtems_api_configuration_table; |
---|
| 1121 | @end group |
---|
| 1122 | @end example |
---|
| 1123 | |
---|
| 1124 | @table @b |
---|
| 1125 | @item maximum_tasks |
---|
| 1126 | is the maximum number of tasks that |
---|
| 1127 | can be concurrently active (created) in the system including |
---|
| 1128 | initialization tasks. |
---|
[bfa0476] | 1129 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1130 | an RTEMS application, the value for this field corresponds |
---|
| 1131 | to the setting of the macro @code{CONFIGURE_MAXIMUM_TASKS}. |
---|
| 1132 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_TASKS} |
---|
[211cafba] | 1133 | macro defaults to 0. |
---|
[ae68ff0] | 1134 | |
---|
| 1135 | @item maximum_timers |
---|
| 1136 | is the maximum number of timers |
---|
| 1137 | that can be concurrently active in the system. |
---|
[bfa0476] | 1138 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1139 | an RTEMS application, the value for this field corresponds |
---|
| 1140 | to the setting of the macro @code{CONFIGURE_MAXIMUM_TIMERS}. |
---|
| 1141 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_TIMERS} |
---|
| 1142 | macro defaults to 0. |
---|
[ae68ff0] | 1143 | |
---|
| 1144 | @item maximum_semaphores |
---|
| 1145 | is the maximum number of |
---|
| 1146 | semaphores that can be concurrently active in the system. |
---|
[bfa0476] | 1147 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1148 | an RTEMS application, the value for this field corresponds |
---|
| 1149 | to the setting of the macro @code{CONFIGURE_MAXIMUM_SEMAPHORES}. |
---|
| 1150 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_SEMAPHORES} |
---|
| 1151 | macro defaults to 0. |
---|
[ae68ff0] | 1152 | |
---|
| 1153 | @item maximum_message_queues |
---|
| 1154 | is the maximum number of |
---|
| 1155 | message queues that can be concurrently active in the system. |
---|
[bfa0476] | 1156 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1157 | an RTEMS application, the value for this field corresponds |
---|
| 1158 | to the setting of the macro @code{CONFIGURE_MAXIMUM_MESSAGE_QUEUES}. |
---|
| 1159 | If not defined by the application, then the |
---|
| 1160 | @code{CONFIGURE_MAXIMUM_MESSAGE_QUEUES} macro defaults to 0. |
---|
[ae68ff0] | 1161 | |
---|
| 1162 | @item maximum_partitions |
---|
| 1163 | is the maximum number of |
---|
| 1164 | partitions that can be concurrently active in the system. |
---|
[bfa0476] | 1165 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1166 | an RTEMS application, the value for this field corresponds |
---|
| 1167 | to the setting of the macro @code{CONFIGURE_MAXIMUM_PARTITIONS}. |
---|
| 1168 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_PARTITIONS} |
---|
| 1169 | macro defaults to 0. |
---|
[ae68ff0] | 1170 | |
---|
| 1171 | @item maximum_regions |
---|
| 1172 | is the maximum number of regions |
---|
| 1173 | that can be concurrently active in the system. |
---|
[bfa0476] | 1174 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1175 | an RTEMS application, the value for this field corresponds |
---|
| 1176 | to the setting of the macro @code{CONFIGURE_MAXIMUM_REGIONS}. |
---|
| 1177 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_REGIONS} |
---|
| 1178 | macro defaults to 0. |
---|
[ae68ff0] | 1179 | |
---|
| 1180 | @item maximum_ports |
---|
| 1181 | is the maximum number of ports into |
---|
| 1182 | dual-port memory areas that can be concurrently active in the |
---|
| 1183 | system. |
---|
[bfa0476] | 1184 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1185 | an RTEMS application, the value for this field corresponds |
---|
| 1186 | to the setting of the macro @code{CONFIGURE_MAXIMUM_PORTS}. |
---|
| 1187 | If not defined by the application, then the @code{CONFIGURE_MAXIMUM_PORTS} |
---|
| 1188 | macro defaults to 0. |
---|
[ae68ff0] | 1189 | |
---|
| 1190 | @item number_of_initialization_tasks |
---|
| 1191 | is the number of initialization tasks configured. At least one |
---|
[bae90e1] | 1192 | RTEMS initialization task or POSIX initializatin must be configured |
---|
| 1193 | in order for the user's application to begin executing. |
---|
[bfa0476] | 1194 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1195 | an RTEMS application, the user must define the |
---|
| 1196 | @code{CONFIGURE_RTEMS_INIT_TASKS_TABLE} to indicate that there |
---|
| 1197 | is one or more RTEMS initialization task. If the application |
---|
| 1198 | only has one RTEMS initialization task, then the automatically |
---|
| 1199 | generated Initialization Task Table will be sufficient. The following |
---|
| 1200 | macros correspond to the single initialization task: |
---|
| 1201 | |
---|
| 1202 | @itemize @bullet |
---|
| 1203 | |
---|
| 1204 | @item @code{CONFIGURE_INIT_TASK_NAME} - is the name of the task. |
---|
| 1205 | If this macro is not defined by the application, then this defaults |
---|
| 1206 | to the task name of @code{"UI1 "} for User Initialization Task 1. |
---|
| 1207 | |
---|
| 1208 | @item @code{CONFIGURE_INIT_TASK_STACK_SIZE} - is the stack size |
---|
| 1209 | of the single initialization task. If this macro is not defined |
---|
[b912f95] | 1210 | by the application, then this defaults to configured minimum |
---|
| 1211 | stack size. |
---|
[bae90e1] | 1212 | |
---|
| 1213 | @item @code{CONFIGURE_INIT_TASK_PRIORITY} - is the initial priority |
---|
| 1214 | of the single initialization task. If this macro is not defined |
---|
| 1215 | by the application, then this defaults to 1. |
---|
| 1216 | |
---|
| 1217 | @item @code{CONFIGURE_INIT_TASK_ATTRIBUTES} - is the attributes |
---|
| 1218 | of the single initialization task. If this macro is not defined |
---|
| 1219 | by the application, then this defaults to @code{RTEMS_DEFAULT_ATTRIBUTES}. |
---|
| 1220 | |
---|
| 1221 | @item @code{CONFIGURE_INIT_TASK_ENTRY_POINT} - is the entry point |
---|
| 1222 | of the single initialization task. If this macro is not defined |
---|
| 1223 | by the application, then this defaults to the C language routine |
---|
| 1224 | @code{Init}. |
---|
| 1225 | |
---|
| 1226 | @item @code{CONFIGURE_INIT_TASK_INITIAL_MODES} - is the initial execution |
---|
| 1227 | modes of the single initialization task. If this macro is not defined |
---|
| 1228 | by the application, then this defaults to @code{RTEMS_NO_PREEMPT}. |
---|
| 1229 | |
---|
| 1230 | @item @code{CONFIGURE_INIT_TASK_ARGUMENTS} - is the argument passed to the |
---|
| 1231 | of the single initialization task. If this macro is not defined |
---|
| 1232 | by the application, then this defaults to 0. |
---|
| 1233 | |
---|
| 1234 | |
---|
| 1235 | @end itemize |
---|
| 1236 | |
---|
| 1237 | |
---|
| 1238 | has the option to have |
---|
| 1239 | value for this field corresponds |
---|
| 1240 | to the setting of the macro @code{}. |
---|
[ae68ff0] | 1241 | |
---|
| 1242 | @item User_initialization_tasks_table |
---|
| 1243 | is the address of the Initialization Task Table. This table contains the |
---|
| 1244 | information needed to create and start each of the |
---|
| 1245 | initialization tasks. The format of this table will be discussed below. |
---|
[bfa0476] | 1246 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1247 | an RTEMS application, the value for this field corresponds |
---|
| 1248 | to the setting of the macro @code{CONFIGURE_EXECUTIVE_RAM_WORK_AREA}. |
---|
[ae68ff0] | 1249 | |
---|
| 1250 | @end table |
---|
| 1251 | |
---|
| 1252 | @section POSIX API Configuration Table |
---|
| 1253 | |
---|
[169502e] | 1254 | @cindex POSIX API Configuration Table |
---|
| 1255 | |
---|
[ae68ff0] | 1256 | The POSIX API Configuration Table is used to configure the |
---|
| 1257 | managers which constitute the POSIX API for a particular application. |
---|
| 1258 | For example, the user can configure the maximum number of threads for |
---|
| 1259 | this application. The POSIX API Configuration Table is defined in |
---|
[ae10dbd] | 1260 | the following C structure: |
---|
[ae68ff0] | 1261 | |
---|
[adee5979] | 1262 | @findex posix_initialization_threads_table |
---|
| 1263 | @findex posix_api_configuration_table |
---|
[ae68ff0] | 1264 | @example |
---|
| 1265 | @group |
---|
| 1266 | typedef struct @{ |
---|
[92c2ae1f] | 1267 | void *(*thread_entry)(void *); |
---|
[ae68ff0] | 1268 | @} posix_initialization_threads_table; |
---|
| 1269 | |
---|
| 1270 | typedef struct @{ |
---|
| 1271 | int maximum_threads; |
---|
| 1272 | int maximum_mutexes; |
---|
| 1273 | int maximum_condition_variables; |
---|
| 1274 | int maximum_keys; |
---|
[2a766a0] | 1275 | int maximum_timers; |
---|
[ae68ff0] | 1276 | int maximum_queued_signals; |
---|
[ae10dbd] | 1277 | int maximum_message_queues; |
---|
[b6f8f03] | 1278 | int maximum_message_queue_descriptors; |
---|
[ae10dbd] | 1279 | int maximum_semaphores; |
---|
| 1280 | int maximum_barriers; |
---|
| 1281 | int maximum_rwlocks; |
---|
| 1282 | int maximum_spinlocks; |
---|
[b6f8f03] | 1283 | int number_of_initialization_threads; |
---|
[ae68ff0] | 1284 | posix_initialization_threads_table *User_initialization_tasks_table; |
---|
| 1285 | @} posix_api_configuration_table; |
---|
| 1286 | @end group |
---|
| 1287 | @end example |
---|
| 1288 | |
---|
| 1289 | @table @b |
---|
| 1290 | @item maximum_threads |
---|
| 1291 | is the maximum number of threads that |
---|
| 1292 | can be concurrently active (created) in the system including |
---|
| 1293 | initialization threads. |
---|
[bfa0476] | 1294 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1295 | an RTEMS application, the value for this field corresponds |
---|
| 1296 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_THREADS}. |
---|
| 1297 | If not defined by the application, then the |
---|
[211cafba] | 1298 | @code{CONFIGURE_MAXIMUM_POSIX_THREADS} macro defaults to 0. |
---|
[ae68ff0] | 1299 | |
---|
| 1300 | @item maximum_mutexes |
---|
| 1301 | is the maximum number of mutexes that can be concurrently |
---|
| 1302 | active in the system. |
---|
[bfa0476] | 1303 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1304 | an RTEMS application, the value for this field corresponds |
---|
| 1305 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_MUTEXES}. |
---|
| 1306 | If not defined by the application, then the |
---|
| 1307 | @code{CONFIGURE_MAXIMUM_POSIX_MUTEXES} macro defaults to 0. |
---|
[ae68ff0] | 1308 | |
---|
| 1309 | @item maximum_condition_variables |
---|
| 1310 | is the maximum number of condition variables that can be |
---|
| 1311 | concurrently active in the system. |
---|
[bfa0476] | 1312 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1313 | an RTEMS application, the value for this field corresponds |
---|
| 1314 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES}. |
---|
| 1315 | If not defined by the application, then the |
---|
| 1316 | @code{CONFIGURE_MAXIMUM_POSIX_CONDITION_VARIABLES} macro defaults to 0. |
---|
[ae68ff0] | 1317 | |
---|
| 1318 | @item maximum_keys |
---|
| 1319 | is the maximum number of keys that can be concurrently active in the system. |
---|
[bfa0476] | 1320 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1321 | an RTEMS application, the value for this field corresponds |
---|
| 1322 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_KEYS}. |
---|
| 1323 | If not defined by the application, then the |
---|
| 1324 | @code{CONFIGURE_MAXIMUM_POSIX_KEYS} macro defaults to 0. |
---|
[ae68ff0] | 1325 | |
---|
[c13cd48] | 1326 | @item maximum_timers |
---|
[2a766a0] | 1327 | is the maximum number of POSIX timers that can be concurrently active |
---|
| 1328 | in the system. |
---|
[bfa0476] | 1329 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1330 | an RTEMS application, the value for this field corresponds |
---|
| 1331 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_TIMERS}. |
---|
| 1332 | If not defined by the application, then the |
---|
| 1333 | @code{CONFIGURE_MAXIMUM_POSIX_TIMERS} macro defaults to 0. |
---|
[2a766a0] | 1334 | |
---|
[ae68ff0] | 1335 | @item maximum_queued_signals |
---|
| 1336 | is the maximum number of queued signals that can be concurrently |
---|
| 1337 | pending in the system. |
---|
[bfa0476] | 1338 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1339 | an RTEMS application, the value for this field corresponds |
---|
| 1340 | to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS}. |
---|
| 1341 | If not defined by the application, then the |
---|
| 1342 | @code{CONFIGURE_MAXIMUM_POSIX_QUEUED_SIGNALS} macro defaults to 0. |
---|
[ae68ff0] | 1343 | |
---|
[b6f8f03] | 1344 | @item maximum_message_queues |
---|
| 1345 | is the maximum number of POSIX message queues that can be concurrently |
---|
| 1346 | active in the system. When using the @code{rtems/confdefs.h} |
---|
| 1347 | mechanism for configuring an RTEMS application, the |
---|
| 1348 | value for this field corresponds to the setting of the macro |
---|
| 1349 | @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES}. If not defined by the |
---|
| 1350 | application, then the @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES} |
---|
| 1351 | macro defaults to 0. |
---|
| 1352 | |
---|
| 1353 | @item maximum_message_queue_descriptors |
---|
| 1354 | is the maximum number of POSIX message queue descriptors |
---|
| 1355 | that can be concurrently active in the system. When using the |
---|
| 1356 | @code{rtems/confdefs.h} mechanism for configuring an RTEMS application, |
---|
| 1357 | the value for this field corresponds to the setting of the macro |
---|
| 1358 | @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS}. |
---|
| 1359 | If not defined by the application, then the |
---|
| 1360 | @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUE_DESCRIPTORS} macro defaults |
---|
| 1361 | to the value of @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES} |
---|
| 1362 | |
---|
| 1363 | @item maximum_semaphores |
---|
| 1364 | is the maximum number of POSIX semaphore that can be concurrently |
---|
| 1365 | active in the system. When using the @code{rtems/confdefs.h} |
---|
| 1366 | mechanism for configuring an RTEMS application, the |
---|
| 1367 | value for this field corresponds to the setting of the macro |
---|
| 1368 | @code{CONFIGURE_MAXIMUM_POSIX_SEMAPHORES}. If not defined by the |
---|
| 1369 | application, then the @code{CONFIGURE_MAXIMUM_POSIX_SEMAPHORES} |
---|
| 1370 | macro defaults to 0. |
---|
| 1371 | |
---|
| 1372 | @item maximum_barriers |
---|
| 1373 | is the maximum number of POSIX barriers that can be concurrently |
---|
| 1374 | active in the system. When using the @code{rtems/confdefs.h} |
---|
| 1375 | mechanism for configuring an RTEMS application, the |
---|
| 1376 | value for this field corresponds to the setting of the macro |
---|
| 1377 | @code{CONFIGURE_MAXIMUM_POSIX_BARRIERS}. If not defined by the |
---|
| 1378 | application, then the @code{CONFIGURE_MAXIMUM_POSIX_BARRIERS} |
---|
| 1379 | macro defaults to 0. |
---|
| 1380 | |
---|
| 1381 | @item maximum_rwlocks |
---|
| 1382 | is the maximum number of POSIX rwlocks that can be concurrently |
---|
| 1383 | active in the system. When using the @code{rtems/confdefs.h} |
---|
| 1384 | mechanism for configuring an RTEMS application, the |
---|
| 1385 | value for this field corresponds to the setting of the macro |
---|
| 1386 | @code{CONFIGURE_MAXIMUM_POSIX_SPINLOCKS}. If not defined by the |
---|
| 1387 | application, then the @code{CONFIGURE_MAXIMUM_POSIX_SPINLOCKS} |
---|
| 1388 | macro defaults to 0. |
---|
| 1389 | |
---|
| 1390 | @item maximum_spinlocks |
---|
| 1391 | is the maximum number of POSIX spinlocks that can be concurrently |
---|
| 1392 | active in the system. When using the @code{rtems/confdefs.h} |
---|
| 1393 | mechanism for configuring an RTEMS application, the |
---|
| 1394 | value for this field corresponds to the setting of the macro |
---|
| 1395 | @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES}. If not defined by the |
---|
| 1396 | application, then the @code{CONFIGURE_MAXIMUM_POSIX_MESSAGE_QUEUES} |
---|
| 1397 | macro defaults to 0. |
---|
| 1398 | |
---|
[ae68ff0] | 1399 | @item number_of_initialization_threads |
---|
| 1400 | is the number of initialization threads configured. At least one |
---|
| 1401 | initialization threads must be configured. |
---|
[bfa0476] | 1402 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1403 | an RTEMS application, the user must define the |
---|
| 1404 | @code{CONFIGURE_POSIX_INIT_THREAD_TABLE} to indicate that there |
---|
| 1405 | is one or more POSIX initialization thread. If the application |
---|
| 1406 | only has one POSIX initialization thread, then the automatically |
---|
| 1407 | generated POSIX Initialization Thread Table will be sufficient. The following |
---|
| 1408 | macros correspond to the single initialization task: |
---|
| 1409 | |
---|
| 1410 | @itemize @bullet |
---|
| 1411 | |
---|
| 1412 | @item @code{CONFIGURE_POSIX_INIT_THREAD_ENTRY_POINT} - is the entry |
---|
| 1413 | point of the thread. If this macro is not defined by the application, |
---|
| 1414 | then this defaults to the C routine @code{POSIX_Init}. |
---|
| 1415 | |
---|
| 1416 | @item @code{CONFIGURE_POSIX_INIT_TASK_STACK_SIZE} - is the stack size |
---|
| 1417 | of the single initialization thread. If this macro is not defined |
---|
[b912f95] | 1418 | by the application, then this defaults to twice the configured |
---|
| 1419 | minimum stack size. |
---|
[bae90e1] | 1420 | |
---|
| 1421 | @end itemize |
---|
[ae68ff0] | 1422 | |
---|
| 1423 | @item User_initialization_threads_table |
---|
| 1424 | is the address of the Initialization Threads Table. This table contains the |
---|
| 1425 | information needed to create and start each of the initialization threads. |
---|
| 1426 | The format of each entry in this table is defined in the |
---|
[ae10dbd] | 1427 | @code{posix_initialization_threads_table} structure. |
---|
[bfa0476] | 1428 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1429 | an RTEMS application, the value for this field corresponds |
---|
| 1430 | to the address of the @code{POSIX_Initialization_threads} structure. |
---|
[ae68ff0] | 1431 | |
---|
| 1432 | @end table |
---|
| 1433 | |
---|
| 1434 | @section CPU Dependent Information Table |
---|
| 1435 | |
---|
[169502e] | 1436 | @cindex CPU Dependent Information Table |
---|
| 1437 | |
---|
[ae68ff0] | 1438 | The CPU Dependent Information Table is used to |
---|
| 1439 | describe processor dependent information required by RTEMS. |
---|
| 1440 | This table is generally used to supply RTEMS with information |
---|
| 1441 | only known by the Board Support Package. The contents of this |
---|
| 1442 | table are discussed in the CPU Dependent Information Table |
---|
[17a3c69] | 1443 | chapter of the Applications Supplement document for a specific |
---|
[ae68ff0] | 1444 | target processor. |
---|
| 1445 | |
---|
[bfa0476] | 1446 | The @code{rtems/confdefs.h} mechanism does not support generating this |
---|
[bae90e1] | 1447 | table. It is normally filled in by the Board Support Package. |
---|
| 1448 | |
---|
[ae68ff0] | 1449 | @section Initialization Task Table |
---|
| 1450 | |
---|
[169502e] | 1451 | @cindex Initialization Tasks Table |
---|
| 1452 | |
---|
[ae68ff0] | 1453 | The Initialization Task Table is used to describe |
---|
| 1454 | each of the user initialization tasks to the Initialization |
---|
| 1455 | Manager. The table contains one entry for each initialization |
---|
| 1456 | task the user wishes to create and start. The fields of this |
---|
| 1457 | data structure directly correspond to arguments to the |
---|
[bae90e1] | 1458 | @code{@value{DIRPREFIX}task_create} and |
---|
| 1459 | @code{@value{DIRPREFIX}task_start} directives. The number of entries is |
---|
| 1460 | found in the @code{number_of_initialization_tasks} entry in the |
---|
| 1461 | Configuration Table. |
---|
| 1462 | |
---|
| 1463 | The format of each entry in the |
---|
[ae10dbd] | 1464 | Initialization Task Table is defined in the following C structure: |
---|
[ae68ff0] | 1465 | |
---|
[adee5979] | 1466 | @findex rtems_initialization_tasks_table |
---|
[ae68ff0] | 1467 | @example |
---|
| 1468 | typedef struct @{ |
---|
| 1469 | rtems_name name; |
---|
[ae10dbd] | 1470 | size_t stack_size; |
---|
[ae68ff0] | 1471 | rtems_task_priority initial_priority; |
---|
| 1472 | rtems_attribute attribute_set; |
---|
| 1473 | rtems_task_entry entry_point; |
---|
| 1474 | rtems_mode mode_set; |
---|
| 1475 | rtems_task_argument argument; |
---|
| 1476 | @} rtems_initialization_tasks_table; |
---|
| 1477 | @end example |
---|
| 1478 | |
---|
| 1479 | @table @b |
---|
| 1480 | @item name |
---|
| 1481 | is the name of this initialization task. |
---|
| 1482 | |
---|
| 1483 | @item stack_size |
---|
| 1484 | is the size of the stack for this initialization task. |
---|
| 1485 | |
---|
| 1486 | @item initial_priority |
---|
| 1487 | is the priority of this initialization task. |
---|
| 1488 | |
---|
| 1489 | @item attribute_set |
---|
| 1490 | is the attribute set used during creation of this initialization task. |
---|
| 1491 | |
---|
| 1492 | @item entry_point |
---|
| 1493 | is the address of the entry point of this initialization task. |
---|
| 1494 | |
---|
| 1495 | @item mode_set |
---|
| 1496 | is the initial execution mode of this initialization task. |
---|
| 1497 | |
---|
| 1498 | @item argument |
---|
| 1499 | is the initial argument for this initialization task. |
---|
| 1500 | |
---|
| 1501 | @end table |
---|
| 1502 | |
---|
| 1503 | A typical declaration for an Initialization Task Table might appear as follows: |
---|
| 1504 | |
---|
| 1505 | @example |
---|
| 1506 | rtems_initialization_tasks_table |
---|
| 1507 | Initialization_tasks[2] = @{ |
---|
| 1508 | @{ INIT_1_NAME, |
---|
| 1509 | 1024, |
---|
| 1510 | 1, |
---|
| 1511 | DEFAULT_ATTRIBUTES, |
---|
| 1512 | Init_1, |
---|
| 1513 | DEFAULT_MODES, |
---|
| 1514 | 1 |
---|
| 1515 | |
---|
| 1516 | @}, |
---|
| 1517 | @{ INIT_2_NAME, |
---|
| 1518 | 1024, |
---|
| 1519 | 250, |
---|
| 1520 | FLOATING_POINT, |
---|
| 1521 | Init_2, |
---|
[92c2ae1f] | 1522 | NO_PREEMPT, |
---|
[ae68ff0] | 1523 | 2 |
---|
| 1524 | |
---|
| 1525 | @} |
---|
| 1526 | @}; |
---|
| 1527 | @end example |
---|
| 1528 | |
---|
| 1529 | @section Driver Address Table |
---|
| 1530 | |
---|
[169502e] | 1531 | @cindex Device Driver Table |
---|
| 1532 | |
---|
[6d00095] | 1533 | The Device Driver Table is used to inform the I/O Manager of the set of |
---|
| 1534 | entry points for each device driver configured in the system. The table |
---|
| 1535 | contains one entry for each device driver required by the application. |
---|
| 1536 | The number of entries is defined in the number_of_device_drivers entry |
---|
| 1537 | in the Configuration Table. This table is copied to the Device Drive |
---|
| 1538 | Table during the IO Manager's initialization giving the entries in this |
---|
| 1539 | table the lower major numbers. The format of each entry in the Device |
---|
[ae10dbd] | 1540 | Driver Table is defined in the following C structure: |
---|
[ae68ff0] | 1541 | |
---|
[adee5979] | 1542 | @findex rtems_driver_address_table |
---|
[ae68ff0] | 1543 | @example |
---|
| 1544 | typedef struct @{ |
---|
[ae10dbd] | 1545 | rtems_device_driver_entry initialization_entry; |
---|
| 1546 | rtems_device_driver_entry open_entry; |
---|
| 1547 | rtems_device_driver_entry close_entry; |
---|
| 1548 | rtems_device_driver_entry read_entry; |
---|
| 1549 | rtems_device_driver_entry write_entry; |
---|
| 1550 | rtems_device_driver_entry control_entry; |
---|
[ae68ff0] | 1551 | @} rtems_driver_address_table; |
---|
| 1552 | @end example |
---|
| 1553 | |
---|
| 1554 | @table @b |
---|
[ae10dbd] | 1555 | @item initialization_entry |
---|
[75e22db] | 1556 | is the address of the entry point called by |
---|
[ae10dbd] | 1557 | @code{rtems_io_initialize} |
---|
[ae68ff0] | 1558 | to initialize a device driver and its associated devices. |
---|
| 1559 | |
---|
[ae10dbd] | 1560 | @item open_entry |
---|
| 1561 | is the address of the entry point called by @code{rtems_io_open}. |
---|
[ae68ff0] | 1562 | |
---|
[ae10dbd] | 1563 | @item close_entry |
---|
| 1564 | is the address of the entry point called by @code{rtems_io_close}. |
---|
[ae68ff0] | 1565 | |
---|
[ae10dbd] | 1566 | @item read_entry |
---|
| 1567 | is the address of the entry point called by @code{rtems_io_read}. |
---|
[ae68ff0] | 1568 | |
---|
[ae10dbd] | 1569 | @item write_entry |
---|
| 1570 | is the address of the entry point called by @code{rtems_io_write}. |
---|
[ae68ff0] | 1571 | |
---|
[ae10dbd] | 1572 | @item control_entry |
---|
| 1573 | is the address of the entry point called by @code{rtems_io_control}. |
---|
[ae68ff0] | 1574 | |
---|
| 1575 | @end table |
---|
| 1576 | |
---|
| 1577 | Driver entry points configured as NULL will always |
---|
[4fa4ea65] | 1578 | return a status code of @code{@value{RPREFIX}SUCCESSFUL}. No user code will be |
---|
[ae68ff0] | 1579 | executed in this situation. |
---|
| 1580 | |
---|
| 1581 | A typical declaration for a Device Driver Table might appear as follows: |
---|
| 1582 | |
---|
| 1583 | @example |
---|
| 1584 | rtems_driver_address_table Driver_table[2] = @{ |
---|
| 1585 | @{ tty_initialize, tty_open, tty_close, /* major = 0 */ |
---|
| 1586 | tty_read, tty_write, tty_control |
---|
| 1587 | @}, |
---|
| 1588 | @{ lp_initialize, lp_open, lp_close, /* major = 1 */ |
---|
| 1589 | NULL, lp_write, lp_control |
---|
| 1590 | @} |
---|
| 1591 | @}; |
---|
| 1592 | @end example |
---|
| 1593 | |
---|
| 1594 | More information regarding the construction and |
---|
| 1595 | operation of device drivers is provided in the I/O Manager |
---|
| 1596 | chapter. |
---|
| 1597 | |
---|
| 1598 | @section User Extensions Table |
---|
| 1599 | |
---|
[169502e] | 1600 | @cindex User Extensions Table |
---|
| 1601 | |
---|
[ae68ff0] | 1602 | The User Extensions Table is used to inform RTEMS of |
---|
| 1603 | the optional user-supplied static extension set. This table |
---|
| 1604 | contains one entry for each possible extension. The entries are |
---|
| 1605 | called at critical times in the life of the system and |
---|
| 1606 | individual tasks. The application may create dynamic extensions |
---|
| 1607 | in addition to this single static set. The format of each entry |
---|
[ae10dbd] | 1608 | in the User Extensions Table is defined in the following C structure: |
---|
[ae68ff0] | 1609 | |
---|
[022fbf3e] | 1610 | @example |
---|
[ae10dbd] | 1611 | typedef void rtems_extension; |
---|
[ce017afb] | 1612 | typedef void (*rtems_task_create_extension)( |
---|
[ae10dbd] | 1613 | Thread_Control * /* executing */, |
---|
| 1614 | Thread_Control * /* created */ |
---|
| 1615 | ); |
---|
[ce017afb] | 1616 | typedef void (*rtems_task_delete_extension)( |
---|
[ae10dbd] | 1617 | Thread_Control * /* executing */, |
---|
| 1618 | Thread_Control * /* deleted */ |
---|
| 1619 | ); |
---|
[ce017afb] | 1620 | typedef void (*rtems_task_start_extension)( |
---|
[ae10dbd] | 1621 | Thread_Control * /* executing */, |
---|
| 1622 | Thread_Control * /* started */ |
---|
| 1623 | ); |
---|
[ce017afb] | 1624 | typedef void (*rtems_task_restart_extension)( |
---|
[ae10dbd] | 1625 | Thread_Control * /* executing */, |
---|
| 1626 | Thread_Control * /* restarted */ |
---|
| 1627 | ); |
---|
[ce017afb] | 1628 | typedef void (*rtems_task_switch_extension)( |
---|
[ae10dbd] | 1629 | Thread_Control * /* executing */, |
---|
| 1630 | Thread_Control * /* heir */ |
---|
| 1631 | ); |
---|
[ce017afb] | 1632 | typedef void (*rtems_task_begin_extension)( |
---|
[ae10dbd] | 1633 | Thread_Control * /* beginning */ |
---|
| 1634 | ); |
---|
[ce017afb] | 1635 | typedef void (*rtems_task_exitted_extension)( |
---|
[ae10dbd] | 1636 | Thread_Control * /* exiting */ |
---|
| 1637 | ); |
---|
[ce017afb] | 1638 | typedef void (*rtems_fatal_extension)( |
---|
[ae10dbd] | 1639 | Internal_errors_Source /* the_source */, |
---|
[eaf1c0c] | 1640 | bool /* is_internal */, |
---|
[ae10dbd] | 1641 | uint32_t /* the_error */ |
---|
| 1642 | ); |
---|
[92c2ae1f] | 1643 | |
---|
[ae68ff0] | 1644 | typedef struct @{ |
---|
[92c2ae1f] | 1645 | rtems_task_create_extension thread_create; |
---|
| 1646 | rtems_task_start_extension thread_start; |
---|
| 1647 | rtems_task_restart_extension thread_restart; |
---|
| 1648 | rtems_task_delete_extension thread_delete; |
---|
| 1649 | rtems_task_switch_extension thread_switch; |
---|
| 1650 | rtems_task_begin_extension thread_begin; |
---|
| 1651 | rtems_task_exitted_extension thread_exitted; |
---|
| 1652 | rtems_fatal_extension fatal; |
---|
[ae10dbd] | 1653 | @} rtems_extensions_table; |
---|
[92c2ae1f] | 1654 | @end example |
---|
[ae68ff0] | 1655 | |
---|
| 1656 | @table @b |
---|
| 1657 | |
---|
| 1658 | @item thread_create |
---|
| 1659 | is the address of the |
---|
| 1660 | user-supplied subroutine for the TASK_CREATE extension. If this |
---|
| 1661 | extension for task creation is defined, it is called from the |
---|
| 1662 | task_create directive. A value of NULL indicates that no |
---|
| 1663 | extension is provided. |
---|
| 1664 | |
---|
| 1665 | @item thread_start |
---|
| 1666 | is the address of the user-supplied |
---|
| 1667 | subroutine for the TASK_START extension. If this extension for |
---|
| 1668 | task initiation is defined, it is called from the task_start |
---|
| 1669 | directive. A value of NULL indicates that no extension is |
---|
| 1670 | provided. |
---|
| 1671 | |
---|
| 1672 | @item thread_restart |
---|
| 1673 | is the address of the user-supplied |
---|
| 1674 | subroutine for the TASK_RESTART extension. If this extension |
---|
| 1675 | for task re-initiation is defined, it is called from the |
---|
| 1676 | task_restart directive. A value of NULL indicates that no |
---|
| 1677 | extension is provided. |
---|
| 1678 | |
---|
| 1679 | @item thread_delete |
---|
| 1680 | is the address of the user-supplied |
---|
| 1681 | subroutine for the TASK_DELETE extension. If this RTEMS |
---|
| 1682 | extension for task deletion is defined, it is called from the |
---|
| 1683 | task_delete directive. A value of NULL indicates that no |
---|
| 1684 | extension is provided. |
---|
| 1685 | |
---|
| 1686 | @item thread_switch |
---|
| 1687 | is the address of the user-supplied |
---|
| 1688 | subroutine for the task context switch extension. This |
---|
| 1689 | subroutine is called from RTEMS dispatcher after the current |
---|
| 1690 | task has been swapped out but before the new task has been |
---|
| 1691 | swapped in. A value of NULL indicates that no extension is |
---|
| 1692 | provided. As this routine is invoked after saving the current |
---|
| 1693 | task's context and before restoring the heir task's context, it |
---|
| 1694 | is not necessary for this routine to save and restore any |
---|
| 1695 | registers. |
---|
| 1696 | |
---|
| 1697 | @item thread_begin |
---|
| 1698 | is the address of the user-supplied |
---|
| 1699 | subroutine which is invoked immediately before a task begins |
---|
| 1700 | execution. It is invoked in the context of the beginning task. |
---|
| 1701 | A value of NULL indicates that no extension is provided. |
---|
| 1702 | |
---|
| 1703 | @item thread_exitted |
---|
| 1704 | is the address of the user-supplied |
---|
| 1705 | subroutine which is invoked when a task exits. This procedure |
---|
| 1706 | is responsible for some action which will allow the system to |
---|
| 1707 | continue execution (i.e. delete or restart the task) or to |
---|
| 1708 | terminate with a fatal error. If this field is set to NULL, the |
---|
[75e22db] | 1709 | default RTEMS TASK_EXITTED handler will be invoked. |
---|
[ae68ff0] | 1710 | |
---|
| 1711 | @item fatal |
---|
| 1712 | is the address of the user-supplied |
---|
| 1713 | subroutine for the FATAL extension. This RTEMS extension of |
---|
[75e22db] | 1714 | fatal error handling is called from the |
---|
| 1715 | @code{@value{DIRPREFIX}fatal_error_occurred} |
---|
[ae68ff0] | 1716 | directive. If the user's fatal error handler returns or if this |
---|
| 1717 | entry is NULL then the default RTEMS fatal error handler will be |
---|
| 1718 | executed. |
---|
| 1719 | |
---|
| 1720 | @end table |
---|
| 1721 | |
---|
| 1722 | A typical declaration for a User Extension Table |
---|
| 1723 | which defines the TASK_CREATE, TASK_DELETE, TASK_SWITCH, and |
---|
| 1724 | FATAL extension might appear as follows: |
---|
| 1725 | |
---|
| 1726 | @example |
---|
| 1727 | rtems_extensions_table User_extensions = @{ |
---|
| 1728 | task_create_extension, |
---|
| 1729 | NULL, |
---|
| 1730 | NULL, |
---|
| 1731 | task_delete_extension, |
---|
| 1732 | task_switch_extension, |
---|
| 1733 | NULL, |
---|
| 1734 | NULL, |
---|
| 1735 | fatal_extension |
---|
| 1736 | @}; |
---|
| 1737 | @end example |
---|
| 1738 | |
---|
| 1739 | More information regarding the user extensions is |
---|
| 1740 | provided in the User Extensions chapter. |
---|
| 1741 | |
---|
| 1742 | @section Multiprocessor Configuration Table |
---|
| 1743 | |
---|
[169502e] | 1744 | @cindex Multiprocessor Configuration Table |
---|
| 1745 | |
---|
[ae68ff0] | 1746 | The Multiprocessor Configuration Table contains |
---|
| 1747 | information needed when using RTEMS in a multiprocessor |
---|
| 1748 | configuration. Many of the details associated with configuring |
---|
| 1749 | a multiprocessor system are dependent on the multiprocessor |
---|
| 1750 | communications layer provided by the user. The address of the |
---|
| 1751 | Multiprocessor Configuration Table should be placed in the |
---|
[bae90e1] | 1752 | @code{User_multiprocessing_table} entry in the primary Configuration |
---|
[ae68ff0] | 1753 | Table. Further details regarding many of the entries in the |
---|
| 1754 | Multiprocessor Configuration Table will be provided in the |
---|
[bae90e1] | 1755 | Multiprocessing chapter. |
---|
| 1756 | |
---|
| 1757 | |
---|
[bfa0476] | 1758 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[adee5979] | 1759 | an RTEMS application, the macro @code{CONFIGURE_MP_APPLICATION} must |
---|
[bae90e1] | 1760 | be defined to automatically generate the Multiprocessor Configuration Table. |
---|
[adee5979] | 1761 | If @code{CONFIGURE_MP_APPLICATION}, is not defined, then a NULL pointer |
---|
[bae90e1] | 1762 | is configured as the address of this table. |
---|
| 1763 | |
---|
| 1764 | The format of the Multiprocessor Configuration Table is defined in |
---|
[ae10dbd] | 1765 | the following C structure: |
---|
[ae68ff0] | 1766 | |
---|
| 1767 | @example |
---|
| 1768 | typedef struct @{ |
---|
[ae10dbd] | 1769 | uint32_t node; |
---|
| 1770 | uint32_t maximum_nodes; |
---|
| 1771 | uint32_t maximum_global_objects; |
---|
| 1772 | uint32_t maximum_proxies; |
---|
[3e066540] | 1773 | uint32_t extra_mpci_receive_server_stack; |
---|
[ae68ff0] | 1774 | rtems_mpci_table *User_mpci_table; |
---|
| 1775 | @} rtems_multiprocessing_table; |
---|
| 1776 | @end example |
---|
| 1777 | |
---|
| 1778 | @table @b |
---|
| 1779 | @item node |
---|
| 1780 | is a unique processor identifier |
---|
| 1781 | and is used in routing messages between nodes in a |
---|
| 1782 | multiprocessor configuration. Each processor must have a unique |
---|
| 1783 | node number. RTEMS assumes that node numbers start at one and |
---|
| 1784 | increase sequentially. This assumption can be used to advantage |
---|
| 1785 | by the user-supplied MPCI layer. Typically, this requirement is |
---|
| 1786 | made when the node numbers are used to calculate the address of |
---|
| 1787 | inter-processor communication links. Zero should be avoided as |
---|
| 1788 | a node number because some MPCI layers use node zero to |
---|
| 1789 | represent broadcasted packets. Thus, it is recommended that |
---|
| 1790 | node numbers start at one and increase sequentially. |
---|
[bfa0476] | 1791 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1792 | an RTEMS application, the value for this field corresponds |
---|
| 1793 | to the setting of the macro @code{CONFIGURE_MP_NODE_NUMBER}. |
---|
| 1794 | If not defined by the application, then the @code{CONFIGURE_MP_NODE_NUMBER} |
---|
| 1795 | macro defaults to the value of the @code{NODE_NUMBER} macro which is |
---|
| 1796 | set on the compiler command line by the RTEMS Multiprocessing Test Suites. |
---|
| 1797 | |
---|
[ae68ff0] | 1798 | |
---|
| 1799 | @item maximum_nodes |
---|
| 1800 | is the number of processor nodes in the system. |
---|
[bfa0476] | 1801 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1802 | an RTEMS application, the value for this field corresponds |
---|
| 1803 | to the setting of the macro @code{CONFIGURE_MP_MAXIMUM_NODES}. |
---|
| 1804 | If not defined by the application, then the @code{CONFIGURE_MP_MAXIMUM_NODES} |
---|
| 1805 | macro defaults to the value 2. |
---|
[ae68ff0] | 1806 | |
---|
| 1807 | @item maximum_global_objects |
---|
| 1808 | is the maximum number of global objects which can exist at any |
---|
| 1809 | given moment in the entire system. If this parameter is not the |
---|
| 1810 | same on all nodes in the system, then a fatal error is generated |
---|
| 1811 | to inform the user that the system is inconsistent. |
---|
[bfa0476] | 1812 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1813 | an RTEMS application, the value for this field corresponds |
---|
| 1814 | to the setting of the macro @code{CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS}. |
---|
| 1815 | If not defined by the application, then the |
---|
| 1816 | @code{CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS} macro defaults to the value 32. |
---|
| 1817 | |
---|
[ae68ff0] | 1818 | |
---|
| 1819 | @item maximum_proxies |
---|
| 1820 | is the maximum number of proxies which can exist at any given moment |
---|
| 1821 | on this particular node. A proxy is a substitute task control block |
---|
| 1822 | which represent a task residing on a remote node when that task blocks |
---|
| 1823 | on a remote object. Proxies are used in situations in which delayed |
---|
| 1824 | interaction is required with a remote node. |
---|
[bfa0476] | 1825 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1826 | an RTEMS application, the value for this field corresponds |
---|
| 1827 | to the setting of the macro @code{CONFIGURE_MP_MAXIMUM_PROXIES}. |
---|
| 1828 | If not defined by the application, then the @code{CONFIGURE_MP_MAXIMUM_PROXIES} |
---|
| 1829 | macro defaults to the value 32. |
---|
| 1830 | |
---|
[3e066540] | 1831 | @item extra_mpci_receive_server_stack |
---|
| 1832 | is the extra stack space allocated for the RTEMS MPCI receive server task |
---|
| 1833 | in bytes. The MPCI receive server may invoke nearly all directives and |
---|
| 1834 | may require extra stack space on some targets. |
---|
[ae68ff0] | 1835 | |
---|
| 1836 | @item User_mpci_table |
---|
| 1837 | is the address of the Multiprocessor Communications Interface |
---|
| 1838 | Table. This table contains the entry points of user-provided functions |
---|
| 1839 | which constitute the multiprocessor communications layer. This table |
---|
| 1840 | must be provided in multiprocessor configurations with all |
---|
| 1841 | entries configured. The format of this table and details |
---|
| 1842 | regarding its entries can be found in the next section. |
---|
[bfa0476] | 1843 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1844 | an RTEMS application, the value for this field corresponds |
---|
| 1845 | to the setting of the macro @code{CONFIGURE_MP_MPCI_TABLE_POINTER}. |
---|
| 1846 | If not defined by the application, then the |
---|
| 1847 | @code{CONFIGURE_MP_MPCI_TABLE_POINTER} macro defaults to the |
---|
| 1848 | address of the table named @code{MPCI_table}. |
---|
| 1849 | |
---|
[ae68ff0] | 1850 | |
---|
| 1851 | @end table |
---|
| 1852 | |
---|
| 1853 | @section Multiprocessor Communications Interface Table |
---|
| 1854 | |
---|
[169502e] | 1855 | @cindex Multiprocessor Communications Interface Table |
---|
| 1856 | |
---|
[bae90e1] | 1857 | This table defines the set of callouts that must be provided by |
---|
| 1858 | an Multiprocessor Communications Interface implementation. |
---|
| 1859 | |
---|
[bfa0476] | 1860 | When using the @code{rtems/confdefs.h} mechanism for configuring |
---|
[bae90e1] | 1861 | an RTEMS application, the name of this table is assumed |
---|
| 1862 | to be @code{MPCI_table} unless the application sets |
---|
| 1863 | the @code{CONFIGURE_MP_MPCI_TABLE_POINTER} when configuring a |
---|
| 1864 | multiprocessing system. |
---|
| 1865 | |
---|
[61389eac] | 1866 | The format of this table is defined in |
---|
[ae10dbd] | 1867 | the following C structure: |
---|
[ae68ff0] | 1868 | |
---|
| 1869 | @example |
---|
| 1870 | typedef struct @{ |
---|
[ae10dbd] | 1871 | uint32_t default_timeout; /* in ticks */ |
---|
| 1872 | uint32_t maximum_packet_size; |
---|
[ae68ff0] | 1873 | rtems_mpci_initialization_entry initialization; |
---|
| 1874 | rtems_mpci_get_packet_entry get_packet; |
---|
| 1875 | rtems_mpci_return_packet_entry return_packet; |
---|
[ae10dbd] | 1876 | rtems_mpci_send_entry send_packet; |
---|
| 1877 | rtems_mpci_receive_entry receive_packet; |
---|
[ae68ff0] | 1878 | @} rtems_mpci_table; |
---|
| 1879 | @end example |
---|
| 1880 | |
---|
| 1881 | @table @b |
---|
| 1882 | @item default_timeout |
---|
| 1883 | is the default maximum length of time a task should block waiting for |
---|
| 1884 | a response to a directive which results in communication with a remote node. |
---|
| 1885 | The maximum length of time is a function the user supplied |
---|
| 1886 | multiprocessor communications layer and the media used. This |
---|
| 1887 | timeout only applies to directives which would not block if the |
---|
| 1888 | operation were performed locally. |
---|
| 1889 | |
---|
| 1890 | @item maximum_packet_size |
---|
| 1891 | is the size in bytes of the longest packet which the MPCI layer is capable |
---|
| 1892 | of sending. This value should represent the total number of bytes available |
---|
| 1893 | for a RTEMS interprocessor messages. |
---|
| 1894 | |
---|
| 1895 | @item initialization |
---|
| 1896 | is the address of the entry point for the initialization procedure of the |
---|
| 1897 | user supplied multiprocessor communications layer. |
---|
| 1898 | |
---|
| 1899 | @item get_packet |
---|
| 1900 | is the address of the entry point for the procedure called by RTEMS to |
---|
| 1901 | obtain a packet from the user supplied multiprocessor communications layer. |
---|
| 1902 | |
---|
| 1903 | @item return_packet |
---|
| 1904 | is the address of the entry point for the procedure called by RTEMS to |
---|
| 1905 | return a packet to the user supplied multiprocessor communications layer. |
---|
| 1906 | |
---|
| 1907 | @item send |
---|
| 1908 | is the address of the entry point for the procedure called by RTEMS to |
---|
| 1909 | send an envelope to another node. This procedure is part of the user |
---|
| 1910 | supplied multiprocessor communications layer. |
---|
| 1911 | |
---|
| 1912 | @item receive |
---|
| 1913 | is the address of the entry point for the |
---|
| 1914 | procedure called by RTEMS to retrieve an envelope containing a |
---|
| 1915 | message from another node. This procedure is part of the user |
---|
| 1916 | supplied multiprocessor communications layer. |
---|
| 1917 | |
---|
| 1918 | @end table |
---|
| 1919 | |
---|
| 1920 | More information regarding the required functionality of these |
---|
| 1921 | entry points is provided in the Multiprocessor chapter. |
---|
| 1922 | |
---|
| 1923 | @section Determining Memory Requirements |
---|
| 1924 | |
---|
| 1925 | Since memory is a critical resource in many real-time |
---|
[bae90e1] | 1926 | embedded systems, the RTEMS Classic API was specifically designed to allow |
---|
| 1927 | unused managers to be forcibly excluded from the run-time environment. |
---|
[ae68ff0] | 1928 | This allows the application designer the flexibility to tailor |
---|
| 1929 | RTEMS to most efficiently meet system requirements while still |
---|
| 1930 | satisfying even the most stringent memory constraints. As |
---|
| 1931 | result, the size of the RTEMS executive is application |
---|
[211cafba] | 1932 | dependent. |
---|
| 1933 | |
---|
| 1934 | It is not necessary for RTEMS Application Developers to calculate |
---|
| 1935 | the amount of memory required for the RTEMS Workspace. This |
---|
| 1936 | is done automatically by @code{<rtems/confdefs.h>}. |
---|
| 1937 | See @ref{Configuring a System Sizing the RTEMS RAM Workspace} for |
---|
| 1938 | more details on how |
---|
| 1939 | this works. In the event, you are interested in the memory required |
---|
| 1940 | for an instance of a particular RTEMS object, please run the test |
---|
| 1941 | @code{spsize} on your target board. |
---|
| 1942 | |
---|
| 1943 | RTEMS is built to be a library and any routines that you do not |
---|
| 1944 | directly or indirectly require in your application will @b{NOT} |
---|
| 1945 | be included in your executable image. However, some managers |
---|
| 1946 | may be explicitly excluded and no attempt to create these instances |
---|
| 1947 | of these objects will succeed even if they are configured. |
---|
| 1948 | The following Classic API managers may be optionally excluded: |
---|
[ae68ff0] | 1949 | |
---|
| 1950 | @itemize @bullet |
---|
| 1951 | @item signal |
---|
| 1952 | @item region |
---|
| 1953 | @item dual ported memory |
---|
| 1954 | @item event |
---|
| 1955 | @item multiprocessing |
---|
| 1956 | @item partition |
---|
| 1957 | @item timer |
---|
| 1958 | @item semaphore |
---|
| 1959 | @item message |
---|
| 1960 | @item rate monotonic |
---|
| 1961 | @end itemize |
---|
| 1962 | |
---|
[bae90e1] | 1963 | RTEMS is designed to be built and installed as a library |
---|
| 1964 | that is linked into the application. As such, much of |
---|
| 1965 | RTEMS is implemented in such a way that there is a single |
---|
| 1966 | entry point per source file. This avoids having the |
---|
| 1967 | linker being forced to pull large object files in their |
---|
| 1968 | entirety into an application when the application references |
---|
[211cafba] | 1969 | a single symbol. In the event you discover an RTEMS method |
---|
| 1970 | that is included in your executable but never entered, please |
---|
| 1971 | let us know. It might be an opportunity to break a dependency |
---|
| 1972 | and shrink many RTEMS applications. |
---|
[bae90e1] | 1973 | |
---|
[ae68ff0] | 1974 | RTEMS based applications must somehow provide memory |
---|
| 1975 | for RTEMS' code and data space. Although RTEMS' data space must |
---|
| 1976 | be in RAM, its code space can be located in either ROM or RAM. |
---|
| 1977 | In addition, the user must allocate RAM for the RTEMS RAM |
---|
| 1978 | Workspace. The size of this area is application dependent and |
---|
| 1979 | can be calculated using the formula provided in the Memory |
---|
[17a3c69] | 1980 | Requirements chapter of the Applications Supplement document |
---|
[ae68ff0] | 1981 | for a specific target processor. |
---|
| 1982 | |
---|
[bae90e1] | 1983 | All private RTEMS data variables and routine names used by |
---|
[ae68ff0] | 1984 | RTEMS begin with the underscore ( _ ) character followed by an |
---|
| 1985 | upper-case letter. If RTEMS is linked with an application, then |
---|
| 1986 | the application code should NOT contain any symbols which begin |
---|
| 1987 | with the underscore character and followed by an upper-case |
---|
| 1988 | letter to avoid any naming conflicts. All RTEMS directive names |
---|
| 1989 | should be treated as reserved words. |
---|
| 1990 | |
---|
| 1991 | @section Sizing the RTEMS RAM Workspace |
---|
| 1992 | |
---|
| 1993 | The RTEMS RAM Workspace is a user-specified block of |
---|
| 1994 | memory reserved for use by RTEMS. The application should NOT |
---|
| 1995 | modify this memory. This area consists primarily of the RTEMS |
---|
| 1996 | data structures whose exact size depends upon the values |
---|
| 1997 | specified in the Configuration Table. In addition, task stacks |
---|
| 1998 | and floating point context areas are dynamically allocated from |
---|
| 1999 | the RTEMS RAM Workspace. |
---|
| 2000 | |
---|
[bfa0476] | 2001 | The @code{rtems/confdefs.h} mechanism calcalutes the size |
---|
[bae90e1] | 2002 | of the RTEMS RAM Workspace automatically. It assumes that |
---|
| 2003 | all tasks are floating point and that all will be allocated |
---|
| 2004 | the miminum stack space. This calculation also automatically |
---|
| 2005 | includes the memory that will be allocated for internal use |
---|
| 2006 | by RTEMS. The following macros may be set |
---|
| 2007 | by the application to make the calculation |
---|
| 2008 | of memory required more accurate: |
---|
| 2009 | |
---|
| 2010 | @itemize @bullet |
---|
| 2011 | |
---|
[e95cfafb] | 2012 | @item @code{CONFIGURE_MEMORY_OVERHEAD} |
---|
| 2013 | @item @code{CONFIGURE_EXTRA_TASK_STACKS} |
---|
[bae90e1] | 2014 | |
---|
| 2015 | @end itemize |
---|
| 2016 | |
---|
[ae68ff0] | 2017 | The starting address of the RTEMS RAM Workspace must |
---|
| 2018 | be aligned on a four-byte boundary. Failure to properly align |
---|
[75e22db] | 2019 | the workspace area will result in the |
---|
| 2020 | @code{@value{DIRPREFIX}fatal_error_occurred} |
---|
| 2021 | directive being invoked with the |
---|
| 2022 | @code{@value{RPREFIX}INVALID_ADDRESS} error code. |
---|
[ae68ff0] | 2023 | |
---|
[211cafba] | 2024 | The file @code{<rtems/confdefs.h>} will calculate the |
---|
| 2025 | value that is specified as the @code{work_space_size} |
---|
| 2026 | parameter of the Configuration Table. There are many |
---|
| 2027 | parameters the application developer can specify to |
---|
| 2028 | help @code{<rtems/confdefs.h>} in its calculations. Correctly |
---|
| 2029 | specifying the application requirements via parameters |
---|
| 2030 | such as @code{CONFIGURE_EXTRA_TASK_STACKS} and |
---|
| 2031 | @code{CONFIGURE_MAXIMUM_TASKS} is critical. |
---|
[338502f] | 2032 | |
---|
| 2033 | The allocation of objects can operate in two modes. The default mode |
---|
| 2034 | has an object number ceiling. No more than the specified number of |
---|
| 2035 | objects can be allocated from the RTEMS RAM Workspace. The number of objects |
---|
| 2036 | specified in the particular API Configuration table fields are |
---|
| 2037 | allocated at initialisation. The second mode allows the number of |
---|
| 2038 | objects to grow to use the available free memory in the RTEMS RAM Workspace. |
---|
| 2039 | |
---|
| 2040 | The auto-extending mode can be enabled individually for each object |
---|
| 2041 | type by using the macro @code{rtems_resource_unlimited}. This takes a value |
---|
| 2042 | as a parameter, and is used to set the object maximum number field in |
---|
| 2043 | an API Configuration table. The value is an allocation unit size. When |
---|
| 2044 | RTEMS is required to grow the object table it is grown by this |
---|
| 2045 | size. The kernel will return the object memory back to the RTEMS RAM Workspace |
---|
| 2046 | when an object is destroyed. The kernel will only return an allocated |
---|
| 2047 | block of objects to the RTEMS RAM Workspace if at least half the allocation |
---|
| 2048 | size of free objects remain allocated. RTEMS always keeps one |
---|
| 2049 | allocation block of objects allocated. Here is an example of using |
---|
| 2050 | @code{rtems_resource_unlimited}: |
---|
| 2051 | |
---|
| 2052 | @example |
---|
| 2053 | #define CONFIGURE_MAXIMUM_TASKS rtems_resource_unlimited(5) |
---|
| 2054 | @end example |
---|
| 2055 | |
---|
| 2056 | The user is cautioned that future versions of RTEMS may not have the |
---|
| 2057 | same memory requirements per object. Although the value calculated is |
---|
| 2058 | suficient for a particular target processor and release of RTEMS, |
---|
| 2059 | memory usage is subject to change across versions and target |
---|
[211cafba] | 2060 | processors. To avoid problems, the user should accurately |
---|
| 2061 | specify each configuration parameter and allow |
---|
| 2062 | @code{<rtems/confdefs.h>} to calculate the memory requirements. |
---|
| 2063 | The memory requirements are likely to change each |
---|
[338502f] | 2064 | time one of the following events occurs: |
---|
[ae68ff0] | 2065 | |
---|
| 2066 | @itemize @bullet |
---|
| 2067 | @item a configuration parameter is modified, |
---|
| 2068 | @item task or interrupt stack requirements change, |
---|
| 2069 | @item task floating point attribute is altered, |
---|
| 2070 | @item RTEMS is upgraded, or |
---|
| 2071 | @item the target processor is changed. |
---|
| 2072 | @end itemize |
---|
| 2073 | |
---|
| 2074 | Failure to provide enough space in the RTEMS RAM |
---|
[75e22db] | 2075 | Workspace will result in the |
---|
| 2076 | @code{@value{DIRPREFIX}fatal_error_occurred} directive |
---|
[ae68ff0] | 2077 | being invoked with the appropriate error code. |
---|