Changeset cdea617 in rtems


Ignore:
Timestamp:
Jul 22, 2009, 9:26:30 PM (10 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, master
Children:
0997128
Parents:
b01619d7
Message:

2009-07-22 Joel Sherrill <joel.sherrill@…>

  • score/inline/rtems/score/states.inl: Add _States_Is_interruptible_by_signal. Add more DOxygen comments and clean up.
Location:
cpukit
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    rb01619d7 rcdea617  
     12009-07-22      Joel Sherrill <joel.sherrill@OARcorp.com>
     2
     3        * score/inline/rtems/score/states.inl: Add
     4        _States_Is_interruptible_by_signal. Add more DOxygen comments and
     5        clean up.
     6
    172009-07-22      Joel Sherrill <joel.sherrill@oarcorp.com>
    28
  • cpukit/score/inline/rtems/score/states.inl

    rb01619d7 rcdea617  
    22 *  @file  rtems/score/states.inl
    33 *
    4  *  This file contains the macro implementation of the inlined
     4 *  This file contains the static inline implementation of the inlined
    55 *  routines associated with thread state information.
    66 */
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2004.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    3232 *  This function sets the given states_to_set into the current_state
    3333 *  passed in.  The result is returned to the user in current_state.
    34  */
    35 
     34 *
     35 *  @param[in] states_to_set is the state bits to set
     36 *  @param[in] current_state is the state set to add them to
     37 *
     38 *  @return This method returns the updated states value.
     39 */
    3640RTEMS_INLINE_ROUTINE States_Control _States_Set (
    3741  States_Control states_to_set,
     
    4549 *  This function clears the given states_to_clear into the current_state
    4650 *  passed in.  The result is returned to the user in current_state.
    47  */
    48 
     51 *
     52 *  @param[in] states_to_set is the state bits to clean
     53 *  @param[in] current_state is the state set to remove them from
     54 *
     55 *  @return This method returns the updated states value.
     56 */
    4957RTEMS_INLINE_ROUTINE States_Control _States_Clear (
    5058  States_Control states_to_clear,
     
    5866 *  This function returns true if the_states indicates that the
    5967 *  state is READY, and false otherwise.
    60  */
    61 
     68 *
     69 *  @param[in] the_states is the task state set to test
     70 *
     71 *  @return This method returns true if the desired state condition is set.
     72 */
    6273RTEMS_INLINE_ROUTINE bool _States_Is_ready (
    6374  States_Control the_states
     
    7081 *  This function returns true if the DORMANT state is the ONLY state
    7182 *  set in the_states, and false otherwise.
    72  */
    73 
     83 *
     84 *  @param[in] the_states is the task state set to test
     85 *
     86 *  @return This method returns true if the desired state condition is set.
     87 */
    7488RTEMS_INLINE_ROUTINE bool _States_Is_only_dormant (
    7589  States_Control the_states
     
    8296 *  This function returns true if the DORMANT state is set in
    8397 *  the_states, and false otherwise.
    84  */
    85 
     98 *
     99 *  @param[in] the_states is the task state set to test
     100 *
     101 *  @return This method returns true if the desired state condition is set.
     102 */
    86103RTEMS_INLINE_ROUTINE bool _States_Is_dormant (
    87104  States_Control the_states
     
    94111 *  This function returns true if the SUSPENDED state is set in
    95112 *  the_states, and false otherwise.
    96  */
    97 
     113 *
     114 *  @param[in] the_states is the task state set to test
     115 *
     116 *  @return This method returns true if the desired state condition is set.
     117 */
    98118RTEMS_INLINE_ROUTINE bool _States_Is_suspended (
    99119  States_Control the_states
     
    106126 *  This function returns true if the TRANSIENT state is set in
    107127 *  the_states, and false otherwise.
    108  */
    109 
     128 *
     129 *  @param[in] the_states is the task state set to test
     130 *
     131 *  @return This method returns true if the desired state condition is set.
     132 */
    110133RTEMS_INLINE_ROUTINE bool _States_Is_transient (
    111134  States_Control the_states
     
    118141 *  This function returns true if the DELAYING state is set in
    119142 *  the_states, and false otherwise.
    120  */
    121 
     143 *
     144 *  @param[in] the_states is the task state set to test
     145 *
     146 *  @return This method returns true if the desired state condition is set.
     147 */
    122148RTEMS_INLINE_ROUTINE bool _States_Is_delaying (
    123149  States_Control the_states
     
    130156 *  This function returns true if the WAITING_FOR_BUFFER state is set in
    131157 *  the_states, and false otherwise.
    132  */
    133 
     158 *
     159 *  @param[in] the_states is the task state set to test
     160 *
     161 *  @return This method returns true if the desired state condition is set.
     162 */
    134163RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_buffer (
    135164  States_Control the_states
     
    142171 *  This function returns true if the WAITING_FOR_SEGMENT state is set in
    143172 *  the_states, and false otherwise.
    144  */
    145 
     173 *
     174 *  @param[in] the_states is the task state set to test
     175 *
     176 *  @return This method returns true if the desired state condition is set.
     177 */
    146178RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_segment (
    147179  States_Control the_states
     
    154186 *  This function returns true if the WAITING_FOR_MESSAGE state is set in
    155187 *  the_states, and false otherwise.
    156  */
    157 
     188 *
     189 *  @param[in] the_states is the task state set to test
     190 *
     191 *  @return This method returns true if the desired state condition is set.
     192 */
    158193RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_message (
    159194  States_Control the_states
     
    166201 *  This function returns true if the WAITING_FOR_EVENT state is set in
    167202 *  the_states, and false otherwise.
    168  */
    169 
     203 *
     204 *  @param[in] the_states is the task state set to test
     205 *
     206 *  @return This method returns true if the desired state condition is set.
     207 */
    170208RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_event (
    171209  States_Control the_states
     
    178216 *  This function returns true if the WAITING_FOR_MUTEX state
    179217 *  is set in the_states, and false otherwise.
    180  */
    181  
     218 *
     219 *  @param[in] the_states is the task state set to test
     220 *
     221 *  @return This method returns true if the desired state condition is set.
     222 */
    182223RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_mutex (
    183224  States_Control the_states
     
    190231 *  This function returns true if the WAITING_FOR_SEMAPHORE state
    191232 *  is set in the_states, and false otherwise.
    192  */
    193 
     233 *
     234 *  @param[in] the_states is the task state set to test
     235 *
     236 *  @return This method returns true if the desired state condition is set.
     237 */
    194238RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_semaphore (
    195239  States_Control the_states
     
    202246 *  This function returns true if the WAITING_FOR_TIME state is set in
    203247 *  the_states, and false otherwise.
    204  */
    205 
     248 *
     249 *  @param[in] the_states is the task state set to test
     250 *
     251 *  @return This method returns true if the desired state condition is set.
     252 */
    206253RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_time (
    207254  States_Control the_states
     
    214261 *  This function returns true if the WAITING_FOR_TIME state is set in
    215262 *  the_states, and false otherwise.
    216  */
    217 
     263 *
     264 *  @param[in] the_states is the task state set to test
     265 *
     266 *  @return This method returns true if the desired state condition is set.
     267 */
    218268RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_rpc_reply (
    219269  States_Control the_states
     
    226276 *  This function returns true if the WAITING_FOR_PERIOD state is set in
    227277 *  the_states, and false otherwise.
    228  */
    229 
     278 *
     279 *  @param[in] the_states is the task state set to test
     280 *
     281 *  @return This method returns true if the desired state condition is set.
     282 */
    230283RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_period (
    231284  States_Control the_states
     
    235288}
    236289
     290/**
     291 *  This function returns true if the task's state is set in
     292 *  way that allows it to be interrupted by a signal.
     293 *
     294 *  @param[in] the_states is the task state set to test
     295 *
     296 *  @return This method returns true if the desired state condition is set.
     297 */
     298RTEMS_INLINE_ROUTINE bool _States_Is_interruptible_by_signal (
     299  States_Control the_states
     300)
     301{
     302   return (the_states & STATES_INTERRUPTIBLE_BY_SIGNAL);
     303
     304}
    237305/**
    238306 *  This function returns true if one of the states which indicates
    239307 *  that a task is blocked waiting for a local resource is set in
    240308 *  the_states, and false otherwise.
     309 *
     310 *  @param[in] the_states is the task state set to test
     311 *
     312 *  @return This method returns true if the desired state condition is set.
    241313 */
    242314
     
    252324 *  that a task is blocked waiting for a local resource is set in
    253325 *  the_states, and false otherwise.
    254  */
    255 
     326 *
     327 *  @param[in] the_states is the task state set to test
     328 *
     329 *  @return This method returns true if the state indicates that the
     330 *          assocated thread is waiting on a thread queue.
     331 */
    256332RTEMS_INLINE_ROUTINE bool _States_Is_waiting_on_thread_queue (
    257333  States_Control the_states
     
    264340 *  This function returns true if one of the states which indicates
    265341 *  that a task is blocked is set in the_states, and false otherwise.
    266  */
    267 
     342 *
     343 *  @param[in] the_states is the task state set to test
     344 *
     345 *  @return This method returns true if the state indicates that the
     346 *          assocated thread is blocked.
     347 */
    268348RTEMS_INLINE_ROUTINE bool _States_Is_blocked (
    269349  States_Control the_states
     
    276356 *  This function returns true if any of the states in the mask
    277357 *  are set in the_states, and false otherwise.
    278  */
    279 
     358 *
     359 *  @param[in] the_states is the task state set to test
     360 *  @param[in] mask is the state bits to test for
     361 *
     362 *  @return This method returns true if the indicates state condition is set.
     363 */
    280364RTEMS_INLINE_ROUTINE bool _States_Are_set (
    281365  States_Control the_states,
Note: See TracChangeset for help on using the changeset viewer.