Changeset 1a8fde6c in rtems for cpukit/score/inline


Ignore:
Timestamp:
Mar 6, 1996, 9:34:57 PM (24 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
e642446
Parents:
8e76546
Message:

Removed prototyes for static inline routines and moved the comments into
the inline implementation. The impetus for this was twofold. First,
it is incorrect to have static inline prototypes when using the macro
implementation. Second, this reduced the number of lines in the include
files seen by rtems.h by about 2000 lines.

Next we restricted visibility for the inline routines to inside the
executive itself EXCEPT for a handful of objects. This reduced the
number of include files included by rtems.h by 40 files and reduced
the lines in the include files seen by rtems.h by about 6000 lines.

In total, these reduced the compile time of the entire RTEMS tree by 20%.
This results in about 8 minutes savings on the SparcStation? 10 morgana.

Location:
cpukit/score/inline/rtems/score
Files:
21 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/inline/rtems/score/address.inl

    r8e76546 r1a8fde6c  
    2222 *  _Addresses_Add_offset
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function is used to add an offset to a base address.
     27 *  It returns the resulting address.  This address is typically
     28 *  converted to an access type before being used further.
    2429 */
    2530
     
    3641 *  _Addresses_Subtract_offset
    3742 *
     43 *  DESCRIPTION:
     44 *
     45 *  This function is used to subtract an offset from a base
     46 *  address.  It returns the resulting address.  This address is
     47 *  typically converted to an access type before being used further.
    3848 */
    3949
     
    4959 *
    5060 *  _Addresses_Subtract
     61 *
     62 *  DESCRIPTION:
     63 *
     64 *  This function is used to subtract two addresses.  It returns the
     65 *  resulting offset.
    5166 *
    5267 *  NOTE:  The cast of an address to an unsigned32 makes this code
     
    6681 *  _Addresses_Is_aligned
    6782 *
     83 *  DESCRIPTION:
     84 *
     85 *  This function returns TRUE if the given address is correctly
     86 *  aligned for this processor and FALSE otherwise.  Proper alignment
     87 *  is based on correctness and efficiency.
    6888 */
    6989
     
    7999 *  _Addresses_Is_in_range
    80100 *
     101 *  DESCRIPTION:
     102 *
     103 *  This function returns TRUE if the given address is within the
     104 *  memory range specified and FALSE otherwise.  base is the address
     105 *  of the first byte in the memory range and limit is the address
     106 *  of the last byte in the memory range.  The base address is
     107 *  assumed to be lower than the limit address.
    81108 */
    82109
  • cpukit/score/inline/rtems/score/chain.inl

    r8e76546 r1a8fde6c  
    2525 *
    2626 *  _Chain_Are_nodes_equal
     27 *
     28 *  DESCRIPTION:
     29 *
     30 *  This function returns TRUE if LEFT and RIGHT are equal,
     31 *  and FALSE otherwise.
    2732 */
    2833
     
    3843 *
    3944 *  _Chain_Is_null
     45 *
     46 *  DESCRIPTION:
     47 *
     48 *  This function returns TRUE if the_chain is NULL and FALSE otherwise.
    4049 */
    4150
     
    5059 *
    5160 *  _Chain_Is_null_node
     61 *
     62 *  DESCRIPTION:
     63 *
     64 *  This function returns TRUE if the_node is NULL and FALSE otherwise.
    5265 */
    5366
     
    6275 *
    6376 *  _Chain_Head
     77 *
     78 *  DESCRIPTION:
     79 *
     80 *  This function returns a pointer to the first node on the chain.
    6481 */
    6582
     
    7491 *
    7592 *  _Chain_Tail
     93 *
     94 *  DESCRIPTION:
     95 *
     96 *  This function returns a pointer to the last node on the chain.
    7697 */
    7798
     
    86107 *
    87108 *  _Chain_Is_empty
     109 *
     110 *  DESCRIPTION:
     111 *
     112 *  This function returns TRUE if there a no nodes on the_chain and
     113 *  FALSE otherwise.
    88114 */
    89115
     
    98124 *
    99125 *  _Chain_Is_first
     126 *
     127 *  DESCRIPTION:
     128 *
     129 *  This function returns TRUE if the_node is the first node on a chain and
     130 *  FALSE otherwise.
    100131 */
    101132
     
    110141 *
    111142 *  _Chain_Is_last
     143 *
     144 *  DESCRIPTION:
     145 *
     146 *  This function returns TRUE if the_node is the last node on a chain and
     147 *  FALSE otherwise.
    112148 */
    113149
     
    122158 *
    123159 *  _Chain_Has_only_one_node
     160 *
     161 *  DESCRIPTION:
     162 *
     163 *  This function returns TRUE if there is only one node on the_chain and
     164 *  FALSE otherwise.
    124165 */
    125166
     
    134175 *
    135176 *  _Chain_Is_head
     177 *
     178 *  DESCRIPTION:
     179 *
     180 *  This function returns TRUE if the_node is the head of the_chain and
     181 *  FALSE otherwise.
    136182 */
    137183
     
    147193 *
    148194 *  _Chain_Is_tail
     195 *
     196 *  DESCRIPTION:
     197 *
     198 *  This function returns TRUE if the_node is the tail of the_chain and
     199 *  FALSE otherwise.
    149200 */
    150201
     
    160211 *
    161212 *  Chain_Initialize_empty
     213 *
     214 *  DESCRIPTION:
     215 *
     216 *  This routine initializes the specified chain to contain zero nodes.
    162217 */
    163218
     
    174229 *
    175230 *  _Chain_Extract_unprotected
     231 *
     232 *  DESCRIPTION:
     233 *
     234 *  This routine extracts the_node from the chain on which it resides.
     235 *  It does NOT disable interrupts to insure the atomicity of the
     236 *  extract operation.
    176237 */
    177238
     
    192253 *
    193254 *  _Chain_Get_first_unprotected
     255 *
     256 *  DESCRIPTION:
     257 *
     258 *  This function removes the first node from the_chain and returns
     259 *  a pointer to that node.  It does NOT disable interrupts to insure
     260 *  the atomicity of the get operation.
    194261 */
    195262
     
    212279 *
    213280 *  Chain_Get_unprotected
     281 *
     282 *  DESCRIPTION:
     283 *
     284 *  This function removes the first node from the_chain and returns
     285 *  a pointer to that node.  If the_chain is empty, then NULL is returned.
     286 *  It does NOT disable interrupts to insure the atomicity of the
     287 *  get operation.
    214288 */
    215289
     
    227301 *
    228302 *  _Chain_Insert_unprotected
     303 *
     304 *  DESCRIPTION:
     305 *
     306 *  This routine inserts the_node on a chain immediately following
     307 *  after_node.  It does NOT disable interrupts to insure the atomicity
     308 *  of the extract operation.
    229309 */
    230310
     
    246326 *
    247327 *  _Chain_Append_unprotected
     328 *
     329 *  DESCRIPTION:
     330 *
     331 *  This routine appends the_node onto the end of the_chain.
     332 *  It does NOT disable interrupts to insure the atomicity of the
     333 *  append operation.
    248334 */
    249335
     
    265351 *
    266352 *  _Chain_Prepend_unprotected
     353 *
     354 *  DESCRIPTION:
     355 *
     356 *  This routine prepends the_node onto the front of the_chain.
     357 *  It does NOT disable interrupts to insure the atomicity of the
     358 *  prepend operation.
    267359 */
    268360
     
    279371 *
    280372 *  _Chain_Prepend
     373 *
     374 *  DESCRIPTION:
     375 *
     376 *  This routine prepends the_node onto the front of the_chain.
     377 *  It disables interrupts to insure the atomicity of the
     378 *  prepend operation.
    281379 */
    282380
  • cpukit/score/inline/rtems/score/coremsg.inl

    r8e76546 r1a8fde6c  
    2424 *  _CORE_message_queue_Send
    2525 *
     26 *  DESCRIPTION:
     27 *
     28 *  This routine sends a message to the end of the specified message queue.
    2629 */
    2730 
     
    4851 *  _CORE_message_queue_Urgent
    4952 *
     53 *  DESCRIPTION:
     54 *
     55 *  This routine sends a message to the front of the specified message queue.
    5056 */
    5157 
     
    7278 *  _CORE_message_queue_Copy_buffer
    7379 *
     80 *  DESCRIPTION:
     81 *
     82 *  This routine copies the contents of the source message buffer
     83 *  to the destination message buffer.
    7484 */
    7585
     
    8797 *  _CORE_message_queue_Allocate_message_buffer
    8898 *
     99 *  DESCRIPTION:
     100 *
     101 *  This function allocates a message buffer from the inactive
     102 *  message buffer chain.
    89103 */
    90104
     
    102116 *  _CORE_message_queue_Free_message_buffer
    103117 *
     118 *  DESCRIPTION:
     119 *
     120 *  This routine frees a message buffer to the inactive
     121 *  message buffer chain.
    104122 */
    105123
     
    116134 *  _CORE_message_queue_Get_pending_message
    117135 *
     136 *  DESCRIPTION:
     137 *
     138 *  This function removes the first message from the_message_queue
     139 *  and returns a pointer to it.
    118140 */
    119141
     
    131153 *  _CORE_message_queue_Is_priority
    132154 *
     155 *  DESCRIPTION:
     156 *
     157 *  This function returns TRUE if the priority attribute is
     158 *  enabled in the attribute_set and FALSE otherwise.
    133159 */
    134160 
     
    144170 *  _CORE_message_queue_Append
    145171 *
     172 *  DESCRIPTION:
     173 *
     174 *  This routine places the_message at the rear of the outstanding
     175 *  messages on the_message_queue.
    146176 */
    147177
     
    158188 *  _CORE_message_queue_Prepend
    159189 *
     190 *  DESCRIPTION:
     191 *
     192 *  This routine places the_message at the front of the outstanding
     193 *  messages on the_message_queue.
    160194 */
    161195
     
    175209 *  _CORE_message_queue_Is_null
    176210 *
     211 *  DESCRIPTION:
     212 *
     213 *  This function returns TRUE if the_message_queue is TRUE and FALSE otherwise.
    177214 */
    178215
     
    188225 *  _CORE_message_queue_Is_notify_enabled
    189226 *
     227 *  DESCRIPTION:
     228 *
     229 *  This function returns TRUE if notification is enabled on this message
     230 *  queue and FALSE otherwise.
    190231 */
    191232 
     
    201242 *  _CORE_message_queue_Set_notify
    202243 *
     244 *  DESCRIPTION:
     245 *
     246 *  This routine initializes the notification information for the_message_queue.
    203247 */
    204248 
  • cpukit/score/inline/rtems/score/coremutex.inl

    r8e76546 r1a8fde6c  
    2222 *  _CORE_mutex_Is_locked
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine returns TRUE if the mutex specified is locked and FALSE
     27 *  otherwise.
    2428 */
    2529 
     
    3539 *  _CORE_mutex_Is_fifo
    3640 *
     41 *  DESCRIPTION:
     42 *
     43 *  This routine returns TRUE if the mutex's wait discipline is FIFO and FALSE
     44 *  otherwise.
    3745 */
    3846 
     
    4856 *  _CORE_mutex_Is_priority
    4957 *
     58 *  DESCRIPTION:
     59 *
     60 *  This routine returns TRUE if the mutex's wait discipline is PRIORITY and
     61 *  FALSE otherwise.
    5062 */
    5163 
     
    6173 *  _CORE_mutex_Is_inherit_priority
    6274 *
     75 *  DESCRIPTION:
     76 *
     77 *  This routine returns TRUE if the mutex's wait discipline is
     78 *  INHERIT_PRIORITY and FALSE otherwise.
    6379 */
    6480 
     
    7490 *  _CORE_mutex_Is_priority_ceiling
    7591 *
     92 *  DESCRIPTION:
     93 *
     94 *  This routine returns TRUE if the mutex's wait discipline is
     95 *  PRIORITY_CEILING and FALSE otherwise.
    7696 */
    7797 
  • cpukit/score/inline/rtems/score/coresem.inl

    r8e76546 r1a8fde6c  
    2222 *  _CORE_semaphore_Is_priority
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns TRUE if the priority attribute is
     27 *  enabled in the attribute_set and FALSE otherwise.
    2428 */
    2529
     
    3539 *  _CORE_semaphore_Get_count
    3640 *
     41 *  DESCRIPTION:
     42 *
     43 *  This routine returns the current count associated with the semaphore.
    3744 */
    3845 
  • cpukit/score/inline/rtems/score/heap.inl

    r8e76546 r1a8fde6c  
    2424 *  _Heap_Head
    2525 *
     26 *  DESCRIPTION:
     27 *
     28 *  This function returns the head of the specified heap.
    2629 */
    2730
     
    3740 *  _Heap_Tail
    3841 *
     42 *  DESCRIPTION:
     43 *
     44 *  This function returns the tail of the specified heap.
    3945 */
    4046
     
    5056 *  _Heap_Previous_block
    5157 *
     58 *  DESCRIPTION:
     59 *
     60 *  This function returns the address of the block which physically
     61 *  precedes the_block in memory.
    5262 */
    5363
     
    6676 *  _Heap_Next_block
    6777 *
     78 *  DESCRIPTION:
     79 *
     80 *  This function returns the address of the block which physically
     81 *  follows the_block in memory.
     82 *
    6883 *  NOTE: Next_block assumes that the block is free.
    6984 */
     
    8398 *  _Heap_Block_at
    8499 *
     100 *  DESCRIPTION:
     101 *
     102 *  This function calculates and returns a block's location (address)
     103 *  in the heap based upad a base address and an offset.
    85104 */
    86105
     
    97116 *  _Heap_User_block_at
    98117 *
     118 *  DESCRIPTION:
     119 *
     120 *  XXX
    99121 */
    100122 
     
    113135 *  _Heap_Is_previous_block_free
    114136 *
     137 *  DESCRIPTION:
     138 *
     139 *  This function returns TRUE if the previous block of the_block
     140 *  is free, and FALSE otherwise.
    115141 */
    116142
     
    126152 *  _Heap_Is_block_free
    127153 *
     154 *  DESCRIPTION:
     155 *
     156 *  This function returns TRUE if the block is free, and FALSE otherwise.
    128157 */
    129158
     
    139168 *  _Heap_Is_block_used
    140169 *
     170 *  DESCRIPTION:
     171 *
     172 *  This function returns TRUE if the block is currently allocated,
     173 *  and FALSE otherwise.
    141174 */
    142175
     
    152185 *  _Heap_Block_size
    153186 *
     187 *  DESCRIPTION:
     188 *
     189 *  This function returns the size of the_block in bytes.
    154190 */
    155191
     
    165201 *  _Heap_Start_of_user_area
    166202 *
     203 *  DESCRIPTION:
     204 *
     205 *  This function returns the starting address of the portion of the block
     206 *  which the user may access.
    167207 */
    168208
     
    178218 *  _Heap_Is_block_in
    179219 *
     220 *  DESCRIPTION:
     221 *
     222 *  This function returns TRUE if the_block is within the memory area
     223 *  managed by the_heap, and FALSE otherwise.
    180224 */
    181225
     
    192236 *  _Heap_Is_page_size_valid
    193237 *
     238 *  DESCRIPTION:
     239 *
     240 *  This function validates a specified heap page size.  If the page size
     241 *  is 0 or if lies outside a page size alignment boundary it is invalid
     242 *  and FALSE is returned.  Otherwise, the page size is valid and TRUE is
     243 *  returned.
    194244 */
    195245
     
    206256 *  _Heap_Build_flag
    207257 *
     258 *  DESCRIPTION:
     259 *
     260 *  This function returns the block flag composed of size and in_use_flag.
     261 *  The flag returned is suitable for use as a back or front flag in a
     262 *  heap block.
    208263 */
    209264
  • cpukit/score/inline/rtems/score/isr.inl

    r8e76546 r1a8fde6c  
    2222 *  _ISR_Is_in_progress
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns TRUE if the processor is currently servicing
     27 *  and interrupt and FALSE otherwise.   A return value of TRUE indicates
     28 *  that the caller is an interrupt service routine, NOT a thread.  The
     29 *  directives available to an interrupt service routine are restricted.
    2430 */
    2531
     
    3339 *  _ISR_Is_vector_number_valid
    3440 *
     41 *  DESCRIPTION:
     42 *
     43 *  This function returns TRUE if the vector is a valid vector number
     44 *  for this processor and FALSE otherwise.
    3545 */
    3646
     
    4656 *  _ISR_Is_valid_user_handler
    4757 *
     58 *
     59 *  DESCRIPTION:
     60 *
     61 *  This function returns TRUE if handler is the entry point of a valid
     62 *  use interrupt service routine and FALSE otherwise.
    4863 */
    4964
  • cpukit/score/inline/rtems/score/mppkt.inl

    r8e76546 r1a8fde6c  
    2222 *  _Mp_packet_Is_valid_packet_class
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns TRUE if the the_packet_class is valid,
     27 *  and FALSE otherwise.
     28 *
    2429 *  NOTE: Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
    2530 *        because this enum starts at lower bound of zero.
     
    3742 *  _Mp_packet_Is_null
    3843 *
     44 *  DESCRIPTION:
     45 *
     46 *  This function returns TRUE if the the_packet_class is null,
     47 *  and FALSE otherwise.
    3948 */
    4049
  • cpukit/score/inline/rtems/score/object.inl

    r8e76546 r1a8fde6c  
    2222 *  _Objects_Build_id
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function builds an object's id from the processor node and index
     27 *  values specified.
    2428 */
    2529
     
    3842 *
    3943 *  _Objects_Get_class
     44 *
     45 *  DESCRIPTION:
     46 *
     47 *  This function returns the class portion of the ID.
    4048 */
    4149 
     
    5361 *  _Objects_Get_node
    5462 *
     63 *  DESCRIPTION:
     64 *
     65 *  This function returns the node portion of the ID.
    5566 */
    5667
     
    6677 *  _Objects_Get_index
    6778 *
     79 *  DESCRIPTION:
     80 *
     81 *  This function returns the index portion of the ID.
    6882 */
    6983
     
    7993 *  _Objects_Is_class_valid
    8094 *
     95 *  DESCRIPTION:
     96 *
     97 *  This function returns TRUE if the class is valid.
    8198 */
    8299 
     
    92109 *  _Objects_Is_local_node
    93110 *
     111 *  DESCRIPTION:
     112 *
     113 *  This function returns TRUE if the node is of the local object, and
     114 *  FALSE otherwise.
    94115 */
    95116
     
    105126 *  _Objects_Is_local_id
    106127 *
     128 *  DESCRIPTION:
     129 *
     130 *  This function returns TRUE if the id is of a local object, and
     131 *  FALSE otherwise.
    107132 */
    108133
     
    118143 *  _Objects_Are_ids_equal
    119144 *
     145 *  DESCRIPTION:
     146 *
     147 *  This function returns TRUE if left and right are equal,
     148 *  and FALSE otherwise.
    120149 */
    121150
     
    132161 *  _Objects_Allocate
    133162 *
     163 *  DESCRIPTION:
     164 *
     165 *  This function allocates a object control block from
     166 *  the inactive chain of free object control blocks.
    134167 */
    135168
     
    145178 *  _Objects_Free
    146179 *
     180 *  DESCRIPTION:
     181 *
     182 *  This function frees a object control block to the
     183 *  inactive chain of free object control blocks.
    147184 */
    148185
     
    159196 *  _Objects_Open
    160197 *
     198 *  DESCRIPTION:
     199 *
     200 *  This function places the_object control pointer and object name
     201 *  in the Local Pointer and Local Name Tables, respectively.
    161202 */
    162203
     
    182223 *  _Objects_Close
    183224 *
     225 *  DESCRIPTION:
     226 *
     227 *  This function removes the_object control pointer and object name
     228 *  in the Local Pointer and Local Name Tables.
    184229 */
    185230
  • cpukit/score/inline/rtems/score/objectmp.inl

    r8e76546 r1a8fde6c  
    2222 *  _Objects_MP_Allocate_global_object
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function allocates a Global Object control block.
    2427 */
    2528
     
    3336
    3437/*PAGE
     38 *
    3539 *  _Objects_MP_Free_global_object
    3640 *
     41 *  DESCRIPTION:
     42 *
     43 *  This routine deallocates a Global Object control block.
    3744 */
    3845
     
    4855
    4956/*PAGE
     57 *
    5058 *  _Objects_MP_Is_null_global_object
    5159 *
     60 *  DESCRIPTION:
     61 *
     62 *  This function returns whether the global object is NULL or not.
    5263 */
    5364
  • cpukit/score/inline/rtems/score/priority.inl

    r8e76546 r1a8fde6c  
    2424 *  _Priority_Handler_initialization
    2525 *
     26 *  DESCRIPTION:
     27 *
     28 *  This routine performs the initialization necessary for this handler.
    2629 */
    2730
     
    3942 *  _Priority_Is_valid
    4043 *
     44 *  DESCRIPTION:
     45 *
     46 *  This function returns TRUE if the_priority if valid for a
     47 *  user task, and FALSE otherwise.
    4148 */
    4249
     
    5764 *  _Priority_Major
    5865 *
     66 *  DESCRIPTION:
     67 *
     68 *  This function returns the major portion of the_priority.
    5969 */
    6070
     
    7080 *  _Priority_Minor
    7181 *
     82 *  DESCRIPTION:
     83 *
     84 *  This function returns the minor portion of the_priority.
    7285 */
    7386
     
    8598 *  _Priority_Mask
    8699 *
     100 *  DESCRIPTION:
     101 *
     102 *  This function returns the mask associated with the major or minor
     103 *  number passed to it.
    87104 */
    88105 
     
    99116 *  _Priority_Bits_index
    100117 *
     118 *  DESCRIPTION:
     119 *
     120 *  This function translates the bit numbers returned by the bit scan
     121 *  of a priority bit field into something suitable for use as
     122 *  a major or minor component of a priority.
    101123 */
    102124 
     
    114136 *  _Priority_Add_to_bit_map
    115137 *
     138 *  DESCRIPTION:
     139 *
     140 *  This routine uses the_priority_map to update the priority
     141 *  bit maps to indicate that a thread has been readied.
    116142 */
    117143
     
    128154 *  _Priority_Remove_from_bit_map
    129155 *
     156 *  DESCRIPTION:
     157 *
     158 *  This routine uses the_priority_map to update the priority
     159 *  bit maps to indicate that a thread has been removed from the
     160 *  ready state.
    130161 */
    131162
     
    143174 *  _Priority_Get_highest
    144175 *
     176 *  DESCRIPTION:
     177 *
     178 *  This function returns the priority of the highest priority
     179 *  ready thread.
    145180 */
    146181
     
    161196 *  _Priority_Initialize_information
    162197 *
     198 *  DESCRIPTION:
     199 *
     200 *  This routine initializes the_priority_map so that it
     201 *  contains the information necessary to manage a thread
     202 *  at new_priority.
    163203 */
    164204
     
    191231 *  _Priority_Is_group_empty
    192232 *
     233 *  DESCRIPTION:
     234 *
     235 *  This function returns TRUE if the priority GROUP is empty, and
     236 *  FALSE otherwise.
    193237 */
    194238
  • cpukit/score/inline/rtems/score/stack.inl

    r8e76546 r1a8fde6c  
    2222 *  _Stack_Initialize
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine initializes the_stack record to indicate that
     27 *  size bytes of memory starting at starting_address have been
     28 *  reserved for a stack.
    2429 */
    2530
     
    3843 *  _Stack_Is_enough
    3944 *
     45 *  DESCRIPTION:
     46 *
     47 *  This function returns TRUE if size bytes is enough memory for
     48 *  a valid stack area on this processor, and FALSE otherwise.
    4049 */
    4150
     
    5160 *  _Stack_Adjust_size
    5261 *
     62 *  DESCRIPTION:
     63 *
     64 *  This function increases the stack size to insure that the thread
     65 *  has the desired amount of stack space after the initial stack
     66 *  pointer is determined based on alignment restrictions.
     67 *
     68 *  NOTE:
     69 *
     70 *  The amount of adjustment for alignment is CPU dependent.
    5371 */
    5472
  • cpukit/score/inline/rtems/score/states.inl

    r8e76546 r1a8fde6c  
    2222 *  _States_Set
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function sets the given states_to_set into the current_state
     27 *  passed in.  The result is returned to the user in current_state.
    2428 */
    2529
     
    3640 *  _States_Clear
    3741 *
     42 *  DESCRIPTION:
     43 *
     44 *  This function clears the given states_to_clear into the current_state
     45 *  passed in.  The result is returned to the user in current_state.
    3846 */
    3947
     
    5058 *  _States_Is_ready
    5159 *
     60 *  DESCRIPTION:
     61 *
     62 *  This function returns TRUE if the_states indicates that the
     63 *  state is READY, and FALSE otherwise.
    5264 */
    5365
     
    6375 *  _States_Is_only_dormant
    6476 *
     77 *  DESCRIPTION:
     78 *
     79 *  This function returns TRUE if the DORMANT state is the ONLY state
     80 *  set in the_states, and FALSE otherwise.
    6581 */
    6682
     
    7692 *  _States_Is_dormant
    7793 *
     94 *  DESCRIPTION:
     95 *
     96 *  This function returns TRUE if the DORMANT state is set in
     97 *  the_states, and FALSE otherwise.
    7898 */
    7999
     
    89109 *  _States_Is_suspended
    90110 *
     111 *  DESCRIPTION:
     112 *
     113 *  This function returns TRUE if the SUSPENDED state is set in
     114 *  the_states, and FALSE otherwise.
    91115 */
    92116
     
    102126 *  _States_Is_Transient
    103127 *
     128 *  DESCRIPTION:
     129 *
     130 *  This function returns TRUE if the TRANSIENT state is set in
     131 *  the_states, and FALSE otherwise.
    104132 */
    105133
     
    115143 *  _States_Is_delaying
    116144 *
     145 *  DESCRIPTION:
     146 *
     147 *  This function returns TRUE if the DELAYING state is set in
     148 *  the_states, and FALSE otherwise.
    117149 */
    118150
     
    128160 *  _States_Is_waiting_for_buffer
    129161 *
     162 *  DESCRIPTION:
     163 *
     164 *  This function returns TRUE if the WAITING_FOR_BUFFER state is set in
     165 *  the_states, and FALSE otherwise.
    130166 */
    131167
     
    141177 *  _States_Is_waiting_for_segment
    142178 *
     179 *  DESCRIPTION:
     180 *
     181 *  This function returns TRUE if the WAITING_FOR_SEGMENT state is set in
     182 *  the_states, and FALSE otherwise.
    143183 */
    144184
     
    154194 *  _States_Is_waiting_for_message
    155195 *
     196 *  DESCRIPTION:
     197 *
     198 *  This function returns TRUE if the WAITING_FOR_MESSAGE state is set in
     199 *  the_states, and FALSE otherwise.
    156200 */
    157201
     
    167211 *  _States_Is_waiting_for_event
    168212 *
     213 *  DESCRIPTION:
     214 *
     215 *  This function returns TRUE if the WAITING_FOR_EVENT state is set in
     216 *  the_states, and FALSE otherwise.
    169217 */
    170218
     
    180228 *  _States_Is_waiting_for_mutex
    181229 *
     230 *  DESCRIPTION:
     231 *
     232 *  This function returns TRUE if the WAITING_FOR_MUTEX state
     233 *  is set in the_states, and FALSE otherwise.
    182234 */
    183235 
     
    193245 *  _States_Is_waiting_for_semaphore
    194246 *
     247 *  DESCRIPTION:
     248 *
     249 *  This function returns TRUE if the WAITING_FOR_SEMAPHORE state
     250 *  is set in the_states, and FALSE otherwise.
    195251 */
    196252
     
    206262 *  _States_Is_waiting_for_time
    207263 *
     264 *  DESCRIPTION:
     265 *
     266 *  This function returns TRUE if the WAITING_FOR_TIME state is set in
     267 *  the_states, and FALSE otherwise.
    208268 */
    209269
     
    219279 *  _States_Is_waiting_for_rpc_reply
    220280 *
     281 *  DESCRIPTION:
     282 *
     283 *  This function returns TRUE if the WAITING_FOR_TIME state is set in
     284 *  the_states, and FALSE otherwise.
    221285 */
    222286
     
    232296 *  _States_Is_waiting_for_period
    233297 *
     298 *  DESCRIPTION:
     299 *
     300 *  This function returns TRUE if the WAITING_FOR_PERIOD state is set in
     301 *  the_states, and FALSE otherwise.
    234302 */
    235303
     
    245313 *  _States_Is_locally_blocked
    246314 *
     315 *  DESCRIPTION:
     316 *
     317 *  This function returns TRUE if one of the states which indicates
     318 *  that a task is blocked waiting for a local resource is set in
     319 *  the_states, and FALSE otherwise.
    247320 */
    248321
     
    258331 *  _States_Is_waiting_on_thread_queue
    259332 *
     333 *  DESCRIPTION:
     334 *
     335 *  This function returns TRUE if one of the states which indicates
     336 *  that a task is blocked waiting for a local resource is set in
     337 *  the_states, and FALSE otherwise.
    260338 */
    261339
     
    271349 *  _States_Is_blocked
    272350 *
     351 *  DESCRIPTION:
     352 *
     353 *  This function returns TRUE if one of the states which indicates
     354 *  that a task is blocked is set in the_states, and FALSE otherwise.
    273355 */
    274356
     
    280362}
    281363
    282 /*PAGEPAGE
     364/*PAGE
    283365 *
    284366 *
    285367 *  _States_Are_set
    286368 *
     369 *  DESCRIPTION:
     370 *
     371 *  This function returns TRUE if any of the states in the mask
     372 *  are set in the_states, and FALSE otherwise.
    287373 */
    288374
  • cpukit/score/inline/rtems/score/sysstate.inl

    r8e76546 r1a8fde6c  
    2121 *
    2222 *  _System_state_Handler_initialization
     23 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine initializes the system state handler.
    2327 */
    2428 
     
    3438 *
    3539 *  _System_state_Set
     40 *
     41 *  DESCRIPTION:
     42 *
     43 *  This routine sets the current system state to that specified by
     44 *  the called.
    3645 */
    3746
     
    4655 *
    4756 *  _System_state_Get
     57 *
     58 *  DESCRIPTION:
     59 *
     60 *  This function returns the current system state.
    4861 */
    4962
     
    5669 *
    5770 *  _System_state_Is_before_initialization
     71 *
     72 *  DESCRIPTION:
     73 *
     74 *  This function returns TRUE if the state is equal to the
     75 *  "before initialization" state, and FALSE otherwise.
    5876 */
    5977
     
    6886 *
    6987 *  _System_state_Is_before_multitasking
     88 *
     89 *  DESCRIPTION:
     90 *
     91 *  This function returns TRUE if the state is equal to the
     92 *  "before multitasking" state, and FALSE otherwise.
    7093 */
    7194
     
    80103 *
    81104 *  _System_state_Is_begin_multitasking
     105 *
     106 *  DESCRIPTION:
     107 *
     108 *  This function returns TRUE if the state is equal to the
     109 *  "begin multitasking" state, and FALSE otherwise.
    82110 */
    83111
     
    92120 *
    93121 *  _System_state_Is_up
     122 *
     123 *  DESCRIPTION:
     124 *
     125 *  This function returns TRUE if the state is equal to the
     126 *  "up" state, and FALSE otherwise.
    94127 */
    95128
     
    104137 *
    105138 *  _System_state_Is_failed
     139 *
     140 *  DESCRIPTION:
     141 *
     142 *  This function returns TRUE if the state is equal to the
     143 *  "failed" state, and FALSE otherwise.
    106144 */
    107145
  • cpukit/score/inline/rtems/score/thread.inl

    r8e76546 r1a8fde6c  
    2222 *  _Thread_Stop_multitasking
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine halts multitasking and returns control to
     27 *  the "thread" (i.e. the BSP) which initially invoked the
     28 *  routine which initialized the system.
    2429 */
    2530
     
    3338 *  _Thread_Is_executing
    3439 *
     40 *  DESCRIPTION:
     41 *
     42 *  This function returns TRUE if the_thread is the currently executing
     43 *  thread, and FALSE otherwise.
    3544 */
    3645
     
    4655 *  _Thread_Is_heir
    4756 *
     57 *  DESCRIPTION:
     58 *
     59 *  This function returns TRUE if the_thread is the heir
     60 *  thread, and FALSE otherwise.
    4861 */
    4962
     
    5972 *  _Thread_Is_executing_also_the_heir
    6073 *
     74 *  DESCRIPTION:
     75 *
     76 *  This function returns TRUE if the currently executing thread
     77 *  is also the heir thread, and FALSE otherwise.
    6178 */
    6279
     
    7087 *  _Thread_Resume
    7188 *
     89 *  DESCRIPTION:
     90 *
     91 *  This routine clears the SUSPENDED state for the_thread.  It performs
     92 *  any necessary scheduling operations including the selection of
     93 *  a new heir thread.
    7294 */
    7395
     
    83105 *  _Thread_Unblock
    84106 *
     107 *  DESCRIPTION:
     108 *
     109 *  This routine clears any blocking state for the_thread.  It performs
     110 *  any necessary scheduling operations including the selection of
     111 *  a new heir thread.
    85112 */
    86113
     
    96123 *  _Thread_Restart_self
    97124 *
     125 *  DESCRIPTION:
     126 *
     127 *  This routine resets the current context of the calling thread
     128 *  to that of its initial state.
    98129 */
    99130
     
    110141 *  _Thread_Calculate_heir
    111142 *
     143 *  DESCRIPTION:
     144 *
     145 *  This function returns a pointer to the highest priority
     146 *  ready thread.
    112147 */
    113148
     
    122157 *  _Thread_Is_allocated_fp
    123158 *
     159 *  DESCRIPTION:
     160 *
     161 *  This function returns TRUE if the floating point context of
     162 *  the_thread is currently loaded in the floating point unit, and
     163 *  FALSE otherwise.
    124164 */
    125165
     
    135175 *  _Thread_Deallocate_fp
    136176 *
     177 *  DESCRIPTION:
     178 *
     179 *  This routine is invoked when the currently loaded floating
     180 *  point context is now longer associated with an active thread.
    137181 */
    138182
     
    146190 *  _Thread_Disable_dispatch
    147191 *
     192 *  DESCRIPTION:
     193 *
     194 *  This routine prevents dispatching.
    148195 */
    149196
     
    157204 *  _Thread_Enable_dispatch
    158205 *
     206 *  DESCRIPTION:
     207 *
     208 *  This routine allows dispatching to occur again.  If this is
     209 *  the outer most dispatching critical section, then a dispatching
     210 *  operation will be performed and, if necessary, control of the
     211 *  processor will be transferred to the heir thread.
    159212 */
    160213
     
    175228 *  _Thread_Unnest_dispatch
    176229 *
     230 *  DESCRIPTION:
     231 *
     232 *  This routine allows dispatching to occur again.  However,
     233 *  no dispatching operation is performed even if this is the outer
     234 *  most dispatching critical section.
    177235 */
    178236
     
    186244 *  _Thread_Is_dispatching_enabled
    187245 *
     246 *  DESCRIPTION:
     247 *
     248 *  This function returns TRUE if dispatching is disabled, and FALSE
     249 *  otherwise.
    188250 */
    189251
     
    197259 *  _Thread_Is_context_switch_necessary
    198260 *
     261 *  DESCRIPTION:
     262 *
     263 *  This function returns TRUE if dispatching is disabled, and FALSE
     264 *  otherwise.
    199265 */
    200266
     
    208274 *  _Thread_Dispatch_initialization
    209275 *
     276 *  DESCRIPTION:
     277 *
     278 *  This routine initializes the thread dispatching subsystem.
    210279 */
    211280
     
    219288 *  _Thread_Is_null
    220289 *
     290 *  DESCRIPTION:
     291 *
     292 *  This function returns TRUE if the_thread is NULL and FALSE otherwise.
    221293 */
    222294
     
    231303 *
    232304 *  _Thread_Get
     305 *
     306 *  DESCRIPTION:
     307 *
     308 *  This function maps thread IDs to thread control
     309 *  blocks.  If ID corresponds to a local thread, then it
     310 *  returns the_thread control pointer which maps to ID
     311 *  and location is set to OBJECTS_LOCAL.  If the thread ID is
     312 *  global and resides on a remote node, then location is set
     313 *  to OBJECTS_REMOTE, and the_thread is undefined.
     314 *  Otherwise, location is set to OBJECTS_ERROR and
     315 *  the_thread is undefined.
    233316 *
    234317 *  NOTE:  XXX... This routine may be able to be optimized.
     
    275358 *  _Thread_Is_proxy_blocking
    276359 *
     360 *  DESCRIPTION:
     361 *
     362 *  This function returns TRUE if the status code is equal to the
     363 *  status which indicates that a proxy is blocking, and FALSE otherwise.
    277364 */
    278365
     
    288375 *  _Thread_Internal_allocate
    289376 *
     377 *  DESCRIPTION:
     378 *
     379 *  This routine allocates an internal thread.
    290380 */
    291381 
     
    299389 *  _Thread_Internal_free
    300390 *
     391 *  DESCRIPTION:
     392 *
     393 *  This routine frees an internal thread.
    301394 */
    302395 
  • cpukit/score/inline/rtems/score/threadmp.inl

    r8e76546 r1a8fde6c  
    2222 *  _Thread_MP_Is_receive
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns true if the thread in question is the
     27 *  multiprocessing receive thread.
    2428 */
    2529
     
    3539 *  _Thread_MP_Free_proxy
    3640 *
     41 *  DESCRIPTION:
     42 *
     43 *  This routine frees a proxy control block to the
     44 *  inactive chain of free proxy control blocks.
    3745 */
    3846
  • cpukit/score/inline/rtems/score/tod.inl

    r8e76546 r1a8fde6c  
    2222 *  _TOD_Is_set
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns TRUE if the application has set the current
     27 *  time of day, and FALSE otherwise.
    2428 */
    2529
     
    3337 *  _TOD_Tickle_ticks
    3438 *
     39 *  DESCRIPTION:
     40 *
     41 *  This routine increments the ticks field of the current time of
     42 *  day at each clock tick.
    3543 */
    3644
     
    4553 *  _TOD_Deactivate
    4654 *
     55 *  DESCRIPTION:
     56 *
     57 *  This routine deactivates updating of the current time of day.
    4758 */
    4859
     
    5667 *  _TOD_Activate
    5768 *
     69 *  DESCRIPTION:
     70 *
     71 *  This routine activates updating of the current time of day.
    5872 */
    5973
  • cpukit/score/inline/rtems/score/tqdata.inl

    r8e76546 r1a8fde6c  
    2222 *  _Thread_queue_Header_number
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This function returns the index of the priority chain on which
     27 *  a thread of the_priority should be placed.
    2428 */
    2529
     
    2832)
    2933{
    30   return ( the_priority >> 6 );
     34  return (the_priority / TASK_QUEUE_DATA_PRIORITIES_PER_HEADER);
    3135}
    3236
     
    3539 *  _Thread_queue_Is_reverse_search
    3640 *
     41 *  DESCRIPTION:
     42 *
     43 *  This function returns TRUE if the_priority indicates that the
     44 *  enqueue search should start at the front of this priority
     45 *  group chain, and FALSE if the search should start at the rear.
    3746 */
    3847
     
    4150)
    4251{
    43   return ( the_priority & 0x20 );
     52  return ( the_priority & TASK_QUEUE_DATA_REVERSE_SEARCH_MASK );
    4453}
    4554
     
    4857 *  _Thread_queue_Get_number_waiting
    4958 *
     59 *  DESCRIPTION:
     60 *
     61 *  This function returns the number of threads waiting on this thread queue.
    5062 */
    5163 
     
    6173 *  _Thread_queue_Enter_critical_section
    6274 *
     75 *  DESCRIPTION:
     76 *
     77 *  This routine is invoked to indicate that the specified thread queue is
     78 *  entering a critical section.
    6379 */
    6480 
  • cpukit/score/inline/rtems/score/userext.inl

    r8e76546 r1a8fde6c  
    2222 *  _User_extensions_Handler_initialization
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine performs the initialization necessary for this handler.
    2427 */
    2528
     
    3942 *
    4043 *  _User_extensions_Add_set
     44 *
     45 *  DESCRIPTION:
     46 *
     47 *  This routine is used to add a user extension set to the active list.
    4148 */
    4249
     
    5461 *
    5562 *  _User_extensions_Add_API_set
     63 *  DESCRIPTION:
     64 *
     65 *  This routine is used to add an API extension set to the active list.
    5666 */
    5767 
     
    6676 *
    6777 *  _User_extensions_Remove_set
     78 *
     79 *  DESCRIPTION:
     80 *
     81 *  This routine is used to remove a user extension set from the active list.
    6882 */
    6983
     
    7993 *  _User_extensions_Thread_switch
    8094 *
     95 *  DESCRIPTION:
     96 *
     97 *  This routine is used to invoke the user extension which
     98 *  is invoked when a context switch occurs.
    8199 */
    82100
  • cpukit/score/inline/rtems/score/watchdog.inl

    r8e76546 r1a8fde6c  
    2222 *  _Watchdog_Initialize
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine initializes the specified watchdog.  The watchdog is
     27 *  made inactive, the watchdog id and handler routine are set to the
     28 *  specified values.
    2429 */
    2530
     
    4146 *  _Watchdog_Is_active
    4247 *
     48 *  DESCRIPTION:
     49 *
     50 *  This routine returns TRUE if the watchdog timer is in the ACTIVE
     51 *  state, and FALSE otherwise.
    4352 */
    4453
     
    5665 *  _Watchdog_Activate
    5766 *
     67 *  DESCRIPTION:
     68 *
     69 *  This routine activates THE_WATCHDOG timer which is already
     70 *  on a watchdog chain.
    5871 */
    5972
     
    7184 *  _Watchdog_Deactivate
    7285 *
     86 *  DESCRIPTION:
     87 *
     88 *  This routine deactivates THE_WATCHDOG timer which will remain
     89 *  on a watchdog chain.
    7390 */
    7491
     
    86103 *  _Watchdog_Tickle_ticks
    87104 *
     105 *  DESCRIPTION:
     106 *
     107 *  This routine is invoked at each clock tick to update the ticks
     108 *  watchdog chain.
    88109 */
    89110
     
    99120 *  _Watchdog_Tickle_seconds
    100121 *
     122 *  DESCRIPTION:
     123 *
     124 *  This routine is invoked at each clock tick to update the seconds
     125 *  watchdog chain.
    101126 */
    102127
     
    112137 *  _Watchdog_Insert_ticks
    113138 *
     139 *  DESCRIPTION:
     140 *
     141 *  This routine inserts THE_WATCHDOG into the ticks watchdog chain
     142 *  for a time of UNITS ticks.  The INSERT_MODE indicates whether
     143 *  THE_WATCHDOG is to be activated automatically or later, explicitly
     144 *  by the caller.
    114145 */
    115146
     
    130161 *  _Watchdog_Insert_seconds
    131162 *
     163 *  DESCRIPTION:
     164 *
     165 *  This routine inserts THE_WATCHDOG into the seconds watchdog chain
     166 *  for a time of UNITS seconds.  The INSERT_MODE indicates whether
     167 *  THE_WATCHDOG is to be activated automatically or later, explicitly
     168 *  by the caller.
    132169 */
    133170
     
    148185 *  _Watchdog_Adjust_seconds
    149186 *
     187 *  DESCRIPTION:
     188 *
     189 *  This routine adjusts the seconds watchdog chain in the forward
     190 *  or backward DIRECTION for UNITS seconds.  This is invoked when the
     191 *  current time of day is changed.
    150192 */
    151193
     
    164206 *  _Watchdog_Adjust_ticks
    165207 *
     208 *  DESCRIPTION:
     209 *
     210 *  This routine adjusts the ticks watchdog chain in the forward
     211 *  or backward DIRECTION for UNITS ticks.
    166212 */
    167213
     
    180226 *  _Watchdog_Reset
    181227 *
     228 *  DESCRIPTION:
     229 *
     230 *  This routine resets THE_WATCHDOG timer to its state at INSERT
     231 *  time.  This routine is valid only on interval watchdog timers
     232 *  and is used to make an interval watchdog timer fire "every" so
     233 *  many ticks.
    182234 */
    183235
     
    197249 *  _Watchdog_Next
    198250 *
     251 *  DESCRIPTION:
     252 *
     253 *  This routine returns a pointer to the watchdog timer following
     254 *  THE_WATCHDOG on the watchdog chain.
    199255 */
    200256
     
    212268 *  _Watchdog_Previous
    213269 *
     270 *  DESCRIPTION:
     271 *
     272 *  This routine returns a pointer to the watchdog timer preceding
     273 *  THE_WATCHDOG on the watchdog chain.
    214274 */
    215275
     
    227287 *  _Watchdog_First
    228288 *
     289 *  DESCRIPTION:
     290 *
     291 *  This routine returns a pointer to the first watchdog timer
     292 *  on the watchdog chain HEADER.
    229293 */
    230294
     
    242306 *  _Watchdog_Last
    243307 *
    244  */
     308 *  DESCRIPTION:
     309 *
     310 *  This routine returns a pointer to the last watchdog timer
     311 *  on the watchdog chain HEADER.
     312 */
     313
    245314STATIC INLINE Watchdog_Control *_Watchdog_Last(
    246315  Chain_Control *header
  • cpukit/score/inline/rtems/score/wkspace.inl

    r8e76546 r1a8fde6c  
    2222 *  _Workspace_Handler_initialization
    2323 *
     24 *  DESCRIPTION:
     25 *
     26 *  This routine performs the initialization necessary for this handler.
    2427 */
    2528
     
    6669 *  _Workspace_Allocate
    6770 *
     71 *  DESCRIPTION:
     72 *
     73 *  This routine returns the address of a block of memory of size
     74 *  bytes.  If a block of the appropriate size cannot be allocated
     75 *  from the workspace, then NULL is returned.
    6876 */
    6977
     
    7987 *  _Workspace_Free
    8088 *
     89 *  DESCRIPTION:
     90 *
     91 *  This function frees the specified block of memory.  If the block
     92 *  belongs to the Workspace and can be successfully freed, then
     93 *  TRUE is returned.  Otherwise FALSE is returned.
    8194 */
    8295
Note: See TracChangeset for help on using the changeset viewer.