Changeset 1f0d013 in rtems


Ignore:
Timestamp:
Jan 9, 2013, 1:56:28 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
cc2857a
Parents:
4f5740f
git-author:
Alex Ivanov <alexivanov97@…> (01/09/13 13:56:28)
git-committer:
Jennifer Averett <jennifer.averett@…> (01/09/13 13:56:28)
Message:

score: Doxygen Clean Up Task #17

Location:
cpukit/score
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/cpu/nios2/rtems/asm.h

    r4f5740f r1f0d013  
    11/**
    2  * @file rtems/asm.h
     2 * @file
    33 *
    4  *  This include file attempts to address the problems
    5  *  caused by incompatible flavors of assemblers and
    6  *  toolsets.  It primarily addresses variations in the
    7  *  use of leading underscores on symbols and the requirement
    8  *  that register names be preceded by a %.
     4 * @brief Address the Problems Caused by Incompatible Flavor of
     5 * Assemblers and Toolsets
     6 *
     7 * This include file attempts to address the problems
     8 * caused by incompatible flavors of assemblers and
     9 * toolsets.  It primarily addresses variations in the
     10 * use of leading underscores on symbols and the requirement
     11 * that register names be preceded by a %.
     12 *
     13 * @note The spacing in the use of these macros
     14 *       is critical to them working as advertised.
    915 */
    1016
    1117/*
    12  *  NOTE: The spacing in the use of these macros
    13  *        is critical to them working as advertised.
    14  *
    1518 *  COPYRIGHT:
    1619 *
  • cpukit/score/cpu/nios2/rtems/score/nios2-utility.h

    r4f5740f r1f0d013  
     1/**
     2 * @file
     3 *
     4 * @brief NIOS II Utility
     5 */
    16/*
    27 * Copyright (c) 2011 embedded brains GmbH.  All rights reserved.
     
    497502}
    498503
    499 /*
    500  *  @brief Nios2 MPU Disable Protected
    501  *
     504/**
     505 * @brief Nios2 MPU disable protected.
    502506 */
    503507uint32_t _Nios2_MPU_Disable_protected( void );
  • cpukit/score/cpu/nios2/rtems/score/nios2.h

    r4f5740f r1f0d013  
    1 /*  nios2.h
     1/**
     2 * @file
    23 *
    3  *  This file sets up basic CPU dependency settings based on
    4  *  compiler settings.  For example, it can determine if
    5  *  floating point is available.  This particular implementation
    6  *  is specific to the NIOS2 port.
     4 * @brief NIOS II Set up Basic CPU Dependency Settings Based on
     5 * Compiler Settings
    76 *
    8  *
     7 * This file sets up basic CPU dependency settings based on
     8 * compiler settings.  For example, it can determine if
     9 * floating point is available.  This particular implementation
     10 * is specific to the NIOS2 port.
     11 */
     12
     13/*
    914 *  COPYRIGHT (c) 1989-1999.
    1015 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/inline/rtems/score/chain.inl

    r4f5740f r1f0d013  
    22 * @file
    33 *
    4  * @ingroup ScoreChain
    5  *
    6  * @brief Chain Handler API.
     4 * @brief Chain Handler API
    75 */
    86
     
    2624
    2725/**
    28  *  @addtogroup ScoreChain
    29  *  @{
    30  */
    31 
    32 /** @brief Set off chain
    33  *
    34  *  This function sets the next and previous fields of the @a node to NULL
    35  *  indicating the @a node is not part of a chain.
    36  *
    37  *  @param[in] node the node set to off chain.
     26 * @addtogroup ScoreChain
     27 *
     28 * @{
     29 */
     30
     31/**
     32 * @brief Set off chain.
     33 *
     34 * This function sets the next and previous fields of the @a node to NULL
     35 * indicating the @a node is not part of a chain.
     36 *
     37 * @param[in] node the node set to off chain.
    3838 */
    3939RTEMS_INLINE_ROUTINE void _Chain_Set_off_chain(
     
    4444}
    4545
    46 /** @brief Is the Node off Chain
    47  *
    48  *  This function returns true if the @a node is not on a chain. A @a node is
    49  *  off chain if the next and previous fields are set to NULL.
    50  *
    51  *  @param[in] node is the node off chain.
    52  *
    53  *  @return This function returns true if the @a node is off chain.
     46/**
     47 * @brief Is the node off chain.
     48 *
     49 * This function returns true if the @a node is not on a chain. A @a node is
     50 * off chain if the next and previous fields are set to NULL.
     51 *
     52 * @param[in] node is the node off chain.
     53 *
     54 * @retval true The @a node is off chain.
     55 * @retval false The @a node is not off chain.
    5456 */
    5557RTEMS_INLINE_ROUTINE bool _Chain_Is_node_off_chain(
     
    6062}
    6163
    62 /** @brief Are Two Nodes Equal
    63  *
    64  *  This function returns true if @a left and @a right are equal,
    65  *  and false otherwise.
    66  *
    67  *  @param[in] left is the node on the left hand side of the comparison.
    68  *  @param[in] right is the node on the left hand side of the comparison.
    69  *
    70  *  @return This function returns true if @a left and @a right are equal,
    71  *          and false otherwise.
     64/**
     65 * @brief Are two nodes equal.
     66 *
     67 * This function returns true if @a left and @a right are equal,
     68 * and false otherwise.
     69 *
     70 * @param[in] left is the node on the left hand side of the comparison.
     71 * @param[in] right is the node on the left hand side of the comparison.
     72 *
     73 * @retval true @a left and @a right are equal.
     74 * @retval false @a left and @a right are not equal.
    7275 */
    7376RTEMS_INLINE_ROUTINE bool _Chain_Are_nodes_equal(
     
    7982}
    8083
    81 /** @brief Is this Chain Control Pointer Null
    82  *
    83  *  This function returns true if the_chain is NULL and false otherwise.
    84  *
    85  *  @param[in] the_chain is the chain to be checked for empty status.
    86  *
    87  *  @return This method returns true if the_chain is NULL and false otherwise.
     84/**
     85 * @brief Is this chain control pointer NULL.
     86 *
     87 * This function returns true if the_chain is NULL and false otherwise.
     88 *
     89 * @param[in] the_chain is the chain to be checked for empty status.
     90 *
     91 * @retval true @a the_chain is @c NULL.
     92 * @retval false @a the_chain is not @c NULL.
    8893 */
    8994RTEMS_INLINE_ROUTINE bool _Chain_Is_null(
     
    9499}
    95100
    96 /** @brief Is the Chain Node Pointer NULL
    97  *
    98  *  This function returns true if the_node is NULL and false otherwise.
    99  *
    100  *  @param[in] the_node is the node pointer to check.
    101  *
    102  *  @return This method returns true if the_node is NULL and false otherwise.
     101/**
     102 * @brief Is the chain node pointer NULL.
     103 *
     104 * This function returns true if the_node is NULL and false otherwise.
     105 *
     106 * @param[in] the_node is the node pointer to check.
     107 *
     108 * @retval true @a the_node is @c NULL.
     109 * @retval false @a the_node is not @c NULL.
    103110 */
    104111RTEMS_INLINE_ROUTINE bool _Chain_Is_null_node(
     
    109116}
    110117
    111 /** @brief Return pointer to Chain Head
    112  *
    113  *  This function returns a pointer to the head node on the chain.
    114  *
    115  *  @param[in] the_chain is the chain to be operated upon.
    116  *
    117  *  @return This method returns the permanent head node of the chain.
     118/**
     119 * @brief Return pointer to chain head.
     120 *
     121 * This function returns a pointer to the head node on the chain.
     122 *
     123 * @param[in] the_chain is the chain to be operated upon.
     124 *
     125 * @return This method returns the permanent head node of the chain.
    118126 */
    119127RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Head(
     
    124132}
    125133
    126 /** @brief Return pointer to immutable Chain Head
    127  *
    128  *  This function returns a pointer to the head node on the chain.
    129  *
    130  *  @param[in] the_chain is the chain to be operated upon.
    131  *
    132  *  @return This method returns the permanent head node of the chain.
     134/**
     135 * @brief Return pointer to immutable chain head.
     136 *
     137 * This function returns a pointer to the head node on the chain.
     138 *
     139 * @param[in] the_chain is the chain to be operated upon.
     140 *
     141 * @return This method returns the permanent head node of the chain.
    133142 */
    134143RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_head(
     
    139148}
    140149
    141 /** @brief Return pointer to Chain Tail
    142  *
    143  *  This function returns a pointer to the tail node on the chain.
    144  *
    145  *  @param[in] the_chain is the chain to be operated upon.
    146  *
    147  *  @return This method returns the permanent tail node of the chain.
     150/**
     151 * @brief Return pointer to chain tail.
     152 *
     153 * This function returns a pointer to the tail node on the chain.
     154 *
     155 * @param[in] the_chain is the chain to be operated upon.
     156 *
     157 * @return This method returns the permanent tail node of the chain.
    148158 */
    149159RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Tail(
     
    154164}
    155165
    156 /** @brief Return pointer to immutable Chain Tail
    157  *
    158  *  This function returns a pointer to the tail node on the chain.
    159  *
    160  *  @param[in] the_chain is the chain to be operated upon.
    161  *
    162  *  @return This method returns the permanent tail node of the chain.
     166/**
     167 * @brief Return pointer to immutable chain tail.
     168 *
     169 * This function returns a pointer to the tail node on the chain.
     170 *
     171 * @param[in] the_chain is the chain to be operated upon.
     172 *
     173 * @return This method returns the permanent tail node of the chain.
    163174 */
    164175RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_tail(
     
    169180}
    170181
    171 /** @brief Return pointer to Chain's First node
    172  *
    173  *  This function returns a pointer to the first node on the chain after the
    174  *  head.
    175  *
    176  *  @param[in] the_chain is the chain to be operated upon.
    177  *
    178  *  @return This method returns the first node of the chain.
     182/**
     183 * @brief Return pointer to chain's first node.
     184 *
     185 * This function returns a pointer to the first node on the chain after the
     186 * head.
     187 *
     188 * @param[in] the_chain is the chain to be operated upon.
     189 *
     190 * @return This method returns the first node of the chain.
    179191 */
    180192RTEMS_INLINE_ROUTINE Chain_Node *_Chain_First(
     
    185197}
    186198
    187 /** @brief Return pointer to immutable Chain's First node
    188  *
    189  *  This function returns a pointer to the first node on the chain after the
    190  *  head.
    191  *
    192  *  @param[in] the_chain is the chain to be operated upon.
    193  *
    194  *  @return This method returns the first node of the chain.
     199/**
     200 * @brief Return pointer to immutable chain's first node.
     201 *
     202 * This function returns a pointer to the first node on the chain after the
     203 * head.
     204 *
     205 * @param[in] the_chain is the chain to be operated upon.
     206 *
     207 * @return This method returns the first node of the chain.
    195208 */
    196209RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_first(
     
    201214}
    202215
    203 /** @brief Return pointer to Chain's Last node
    204  *
    205  *  This function returns a pointer to the last node on the chain just before
    206  *  the tail.
    207  *
    208  *  @param[in] the_chain is the chain to be operated upon.
    209  *
    210  *  @return This method returns the last node of the chain.
     216/**
     217 * @brief Return pointer to chain's last node.
     218 *
     219 * This function returns a pointer to the last node on the chain just before
     220 * the tail.
     221 *
     222 * @param[in] the_chain is the chain to be operated upon.
     223 *
     224 * @return This method returns the last node of the chain.
    211225 */
    212226RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Last(
     
    217231}
    218232
    219 /** @brief Return pointer to immutable Chain's Last node
    220  *
    221  *  This function returns a pointer to the last node on the chain just before
    222  *  the tail.
    223  *
    224  *  @param[in] the_chain is the chain to be operated upon.
    225  *
    226  *  @return This method returns the last node of the chain.
     233/**
     234 * @brief Return pointer to immutable chain's last node.
     235 *
     236 * This function returns a pointer to the last node on the chain just before
     237 * the tail.
     238 *
     239 * @param[in] the_chain is the chain to be operated upon.
     240 *
     241 * @return This method returns the last node of the chain.
    227242 */
    228243RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_last(
     
    233248}
    234249
    235 /** @brief Return pointer the next node from this node
    236  *
    237  *  This function returns a pointer to the next node after this node.
    238  *
    239  *  @param[in] the_node is the node to be operated upon.
    240  *
    241  *  @return This method returns the next node on the chain.
     250/**
     251 * @brief Return pointer the next node from this node.
     252 *
     253 * This function returns a pointer to the next node after this node.
     254 *
     255 * @param[in] the_node is the node to be operated upon.
     256 *
     257 * @return This method returns the next node on the chain.
    242258 */
    243259RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Next(
     
    248264}
    249265
    250 /** @brief Return pointer the immutable next node from this node
    251  *
    252  *  This function returns a pointer to the next node after this node.
    253  *
    254  *  @param[in] the_node is the node to be operated upon.
    255  *
    256  *  @return This method returns the next node on the chain.
     266/**
     267 * @brief Return pointer the immutable next node from this node.
     268 *
     269 * This function returns a pointer to the next node after this node.
     270 *
     271 * @param[in] the_node is the node to be operated upon.
     272 *
     273 * @return This method returns the next node on the chain.
    257274 */
    258275RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_next(
     
    263280}
    264281
    265 /** @brief Return pointer the previous node from this node
    266  *
    267  *  This function returns a pointer to the previous node on this chain.
    268  *
    269  *  @param[in] the_node is the node to be operated upon.
    270  *
    271  *  @return This method returns the previous node on the chain.
     282/**
     283 * @brief Return pointer the previous node from this node.
     284 *
     285 * This function returns a pointer to the previous node on this chain.
     286 *
     287 * @param[in] the_node is the node to be operated upon.
     288 *
     289 * @return This method returns the previous node on the chain.
    272290 */
    273291RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Previous(
     
    278296}
    279297
    280 /** @brief Return pointer the immutable previous node from this node
    281  *
    282  *  This function returns a pointer to the previous node on this chain.
    283  *
    284  *  @param[in] the_node is the node to be operated upon.
    285  *
    286  *  @return This method returns the previous node on the chain.
     298/**
     299 * @brief Return pointer the immutable previous node from this node.
     300 *
     301 * This function returns a pointer to the previous node on this chain.
     302 *
     303 * @param[in] the_node is the node to be operated upon.
     304 *
     305 * @return This method returns the previous node on the chain.
    287306 */
    288307RTEMS_INLINE_ROUTINE const Chain_Node *_Chain_Immutable_previous(
     
    293312}
    294313
    295 /** @brief Is the Chain Empty
    296  *
    297  *  This function returns true if there a no nodes on @a the_chain and
    298  *  false otherwise.
    299  *
    300  *  @param[in] the_chain is the chain to be operated upon.
    301  *
    302  *  @return This function returns true if there a no nodes on @a the_chain and
    303  *  false otherwise.
     314/**
     315 * @brief Is the chain empty.
     316 *
     317 * This function returns true if there a no nodes on @a the_chain and
     318 * false otherwise.
     319 *
     320 * @param[in] the_chain is the chain to be operated upon.
     321 *
     322 * @retval true There are no nodes on @a the_chain.
     323 * @retval false There are nodes on @a the_chain.
    304324 */
    305325RTEMS_INLINE_ROUTINE bool _Chain_Is_empty(
     
    311331}
    312332
    313 /** @brief Is this the First Node on the Chain
    314  *
    315  *  This function returns true if the_node is the first node on a chain and
    316  *  false otherwise.
    317  *
    318  *  @param[in] the_node is the node the caller wants to know if it is
    319  *             the first node on a chain.
    320  *
    321  *  @return This function returns true if @a the_node is the first node on
    322  *          a chain and false otherwise.
     333/**
     334 * @brief Is this the first node on the chain.
     335 *
     336 * This function returns true if the_node is the first node on a chain and
     337 * false otherwise.
     338 *
     339 * @param[in] the_node is the node the caller wants to know if it is
     340 *            the first node on a chain.
     341 *
     342 * @retval true @a the_node is the first node on a chain.
     343 * @retval false @a the_node is not the first node on a chain.
    323344 */
    324345RTEMS_INLINE_ROUTINE bool _Chain_Is_first(
     
    329350}
    330351
    331 /** @brief Is this the Last Node on the Chain
    332  *
    333  *  This function returns true if @a the_node is the last node on a chain and
    334  *  false otherwise.
    335  *
    336  *  @param[in] the_node is the node to check as the last node.
    337  *
    338  *  @return This function returns true if @a the_node is the last node on
    339  *          a chain and false otherwise.
     352/**
     353 * @brief Is this the last node on the chain.
     354 *
     355 * This function returns true if @a the_node is the last node on a chain and
     356 * false otherwise.
     357 *
     358 * @param[in] the_node is the node to check as the last node.
     359 *
     360 * @retval true @a the_node is the last node on a chain.
     361 * @retval false @a the_node is not the last node on a chain.
    340362 */
    341363RTEMS_INLINE_ROUTINE bool _Chain_Is_last(
     
    346368}
    347369
    348 /** @brief Does this Chain have only One Node
    349  *
    350  *  This function returns true if there is only one node on @a the_chain and
    351  *  false otherwise.
    352  *
    353  *  @param[in] the_chain is the chain to be operated upon.
    354  *
    355  *  @return This function returns true if there is only one node on
    356  *          @a the_chain and false otherwise.
     370/**
     371 * @brief Does this chain have only one node.
     372 *
     373 * This function returns true if there is only one node on @a the_chain and
     374 * false otherwise.
     375 *
     376 * @param[in] the_chain is the chain to be operated upon.
     377 *
     378 * @return This function returns true if there is only one node on
     379 *         @a the_chain and false otherwise.
     380 *
     381 * @retval true There is only one node on @a the_chain.
     382 * @retval false There is more than one node on @a the_chain.
    357383 */
    358384RTEMS_INLINE_ROUTINE bool _Chain_Has_only_one_node(
     
    364390}
    365391
    366 /** @brief Is this Node the Chain Head
    367  *
    368  *  This function returns true if @a the_node is the head of the_chain and
    369  *  false otherwise.
    370  *
    371  *  @param[in] the_chain is the chain to be operated upon.
    372  *  @param[in] the_node is the node to check for being the Chain Head.
    373  *
    374  *  @return This function returns true if @a the_node is the head of
    375  *          @a the_chain and false otherwise.
     392/**
     393 * @brief Is this node the chain head.
     394 *
     395 * This function returns true if @a the_node is the head of @a the_chain and
     396 * false otherwise.
     397 *
     398 * @param[in] the_chain is the chain to be operated upon.
     399 * @param[in] the_node is the node to check for being the Chain Head.
     400 *
     401 * @retval true @a the_node is the head of @a the_chain.
     402 * @retval false @a the_node is not the head of @a the_chain.
    376403 */
    377404RTEMS_INLINE_ROUTINE bool _Chain_Is_head(
     
    383410}
    384411
    385 /** @brief Is this Node the Chail Tail
    386  *
    387  *  This function returns true if the_node is the tail of the_chain and
    388  *  false otherwise.
    389  *
    390  *  @param[in] the_chain is the chain to be operated upon.
    391  *  @param[in] the_node is the node to check for being the Chain Tail.
     412/**
     413 * @brief Is this node the chail tail.
     414 *
     415 * This function returns true if @a the_node is the tail of @a the_chain and
     416 * false otherwise.
     417 *
     418 * @param[in] the_chain is the chain to be operated upon.
     419 * @param[in] the_node is the node to check for being the Chain Tail.
     420 *
     421 * @retval true @a the_node is the tail of @a the_chain.
     422 * @retval false @a the_node is not the tail of @a the_chain.
    392423 */
    393424RTEMS_INLINE_ROUTINE bool _Chain_Is_tail(
     
    399430}
    400431
    401 /** @brief Initialize this Chain as Empty
    402  *
    403  *  This routine initializes the specified chain to contain zero nodes.
    404  *
    405  *  @param[in] the_chain is the chain to be initialized.
     432/**
     433 * @brief Initialize this chain as empty.
     434 *
     435 * This routine initializes the specified chain to contain zero nodes.
     436 *
     437 * @param[in] the_chain is the chain to be initialized.
    406438 */
    407439RTEMS_INLINE_ROUTINE void _Chain_Initialize_empty(
     
    417449}
    418450
    419 /** @brief Extract this Node (unprotected)
    420  *
    421  *  This routine extracts the_node from the chain on which it resides.
    422  *  It does NOT disable interrupts to ensure the atomicity of the
    423  *  extract operation.
    424  *
    425  *  @param[in] the_node is the node to be extracted.
     451/**
     452 * @brief Extract this node (unprotected).
     453 *
     454 * This routine extracts the_node from the chain on which it resides.
     455 * It does NOT disable interrupts to ensure the atomicity of the
     456 * extract operation.
     457 *
     458 * @param[in] the_node is the node to be extracted.
    426459 */
    427460RTEMS_INLINE_ROUTINE void _Chain_Extract_unprotected(
     
    438471}
    439472
    440 /** @brief Get the First Node (unprotected)
    441  *
    442  *  This function removes the first node from the_chain and returns
    443  *  a pointer to that node.  It does NOT disable interrupts to ensure
    444  *  the atomicity of the get operation.
    445  *
    446  *  @param[in] the_chain is the chain to attempt to get the first node from.
    447  *
    448  *  @return This method returns the first node on the chain even if it is
    449  *          the Chain Tail.
    450  *
    451  *  @note This routine assumes that there is at least one node on the chain
    452  *        and always returns a node even if it is the Chain Tail.
     473/**
     474 * @brief Get the first node (unprotected).
     475 *
     476 * This function removes the first node from the_chain and returns
     477 * a pointer to that node.  It does NOT disable interrupts to ensure
     478 * the atomicity of the get operation.
     479 *
     480 * @param[in] the_chain is the chain to attempt to get the first node from.
     481 *
     482 * @return This method returns the first node on the chain even if it is
     483 *         the Chain Tail.
     484 *
     485 * @note This routine assumes that there is at least one node on the chain
     486 *       and always returns a node even if it is the Chain Tail.
    453487 */
    454488RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_first_unprotected(
     
    466500}
    467501
    468 /** @brief Get the First Node (unprotected)
    469  *
    470  *  This function removes the first node from the_chain and returns
    471  *  a pointer to that node.  If the_chain is empty, then NULL is returned.
    472  *
    473  *  @param[in] the_chain is the chain to attempt to get the first node from.
    474  *
    475  *  @return This method returns the first node on the chain or NULL if the
    476  *          chain is empty.
    477  *
    478  *  @note It does NOT disable interrupts to ensure the atomicity of the
    479  *        get operation.
     502/**
     503 * @brief Get the first node (unprotected).
     504 *
     505 * This function removes the first node from the_chain and returns
     506 * a pointer to that node.  If the_chain is empty, then NULL is returned.
     507 *
     508 * @param[in] the_chain is the chain to attempt to get the first node from.
     509 *
     510 * @return This method returns the first node on the chain or NULL if the
     511 *         chain is empty.
     512 *
     513 * @note It does NOT disable interrupts to ensure the atomicity of the
     514 *       get operation.
    480515 */
    481516RTEMS_INLINE_ROUTINE Chain_Node *_Chain_Get_unprotected(
     
    489524}
    490525
    491 /** @brief Insert a Node (unprotected)
    492  *
    493  *  This routine inserts the_node on a chain immediately following
    494  *  after_node.
    495  *
    496  *  @param[in] after_node is the node which will precede @a the_node on the
    497  *             chain.
    498  *  @param[in] the_node is the node to be inserted.
    499  *
    500  *  @note It does NOT disable interrupts to ensure the atomicity
    501  *        of the extract operation.
     526/**
     527 * @brief Insert a node (unprotected).
     528 *
     529 * This routine inserts the_node on a chain immediately following
     530 * after_node.
     531 *
     532 * @param[in] after_node is the node which will precede @a the_node on the
     533 *            chain.
     534 * @param[in] the_node is the node to be inserted.
     535 *
     536 * @note It does NOT disable interrupts to ensure the atomicity
     537 *       of the extract operation.
    502538 */
    503539RTEMS_INLINE_ROUTINE void _Chain_Insert_unprotected(
     
    515551}
    516552
    517 /** @brief Append a Node (unprotected)
    518  *
    519  *  This routine appends the_node onto the end of the_chain.
    520  *
    521  *  @param[in] the_chain is the chain to be operated upon.
    522  *  @param[in] the_node is the node to be appended.
    523  *
    524  *  @note It does NOT disable interrupts to ensure the atomicity of the
    525  *        append operation.
     553/**
     554 * @brief Append a node (unprotected).
     555 *
     556 * This routine appends the_node onto the end of the_chain.
     557 *
     558 * @param[in] the_chain is the chain to be operated upon.
     559 * @param[in] the_node is the node to be appended.
     560 *
     561 * @note It does NOT disable interrupts to ensure the atomicity of the
     562 *       append operation.
    526563 */
    527564RTEMS_INLINE_ROUTINE void _Chain_Append_unprotected(
     
    540577
    541578/**
    542  *  @brief Append a node on the end of a chain if the node is in the off chain
    543  *  state (unprotected).
    544  *
    545  *  @note It does NOT disable interrupts to ensure the atomicity of the
    546  *        append operation.
    547  *
    548  *  @see _Chain_Append_unprotected() and _Chain_Is_node_off_chain().
     579 * @brief Append a node on the end of a chain if the node is in the off chain
     580 * state (unprotected).
     581 *
     582 * @note It does NOT disable interrupts to ensure the atomicity of the
     583 *       append operation.
     584 *
     585 * @see _Chain_Append_unprotected() and _Chain_Is_node_off_chain().
    549586 */
    550587RTEMS_INLINE_ROUTINE void _Chain_Append_if_is_off_chain_unprotected(
     
    558595}
    559596
    560 /** @brief Prepend a Node (unprotected)
    561  *
    562  *  This routine prepends the_node onto the front of the_chain.
    563  *
    564  *  @param[in] the_chain is the chain to be operated upon.
    565  *  @param[in] the_node is the node to be prepended.
    566  *
    567  *  @note It does NOT disable interrupts to ensure the atomicity of the
    568  *        prepend operation.
     597/**
     598 * @brief Prepend a node (unprotected).
     599 *
     600 * This routine prepends the_node onto the front of the_chain.
     601 *
     602 * @param[in] the_chain is the chain to be operated upon.
     603 * @param[in] the_node is the node to be prepended.
     604 *
     605 * @note It does NOT disable interrupts to ensure the atomicity of the
     606 *       prepend operation.
    569607 */
    570608RTEMS_INLINE_ROUTINE void _Chain_Prepend_unprotected(
     
    576614}
    577615
    578 /** @brief Prepend a Node (protected)
    579  *
    580  *  This routine prepends the_node onto the front of the_chain.
    581  *
    582  *  @param[in] the_chain is the chain to be operated upon.
    583  *  @param[in] the_node is the node to be prepended.
    584  *
    585  *  @note It disables interrupts to ensure the atomicity of the
    586  *        prepend operation.
     616/**
     617 * @brief Prepend a node (protected).
     618 *
     619 * This routine prepends the_node onto the front of the_chain.
     620 *
     621 * @param[in] the_chain is the chain to be operated upon.
     622 * @param[in] the_node is the node to be prepended.
     623 *
     624 * @note It disables interrupts to ensure the atomicity of the
     625 *       prepend operation.
    587626 */
    588627RTEMS_INLINE_ROUTINE void _Chain_Prepend(
     
    689728}
    690729
    691 /**@}*/
     730/** @} */
    692731
    693732#endif
  • cpukit/score/inline/rtems/score/corebarrier.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/corebarrier.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains all of the inlined routines associated
    5  *  with the SuperCore barrier.
     4 * @brief Inlined Routines Associated with the SuperCore Barrier
     5 *
     6 * This include file contains all of the inlined routines associated
     7 * with the SuperCore barrier.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreBarrier
    26  *  @{
     27 * @addtogroup ScoreBarrier
     28 *
     29 * @{
    2730 */
    2831
     
    3134
    3235/**
    33  *  This function returns true if the automatic release attribute is
    34  *  enabled in the @a attribute_set and false otherwise.
     36 * This function returns true if the automatic release attribute is
     37 * enabled in the @a attribute_set and false otherwise.
    3538 *
    36  *  @param[in] the_attribute is the attribute set to test
    37  *  @return true if the priority attribute is enabled
     39 * @param[in] the_attribute is the attribute set to test
     40 *
     41 * @return true if the priority attribute is enabled
    3842 */
    3943RTEMS_INLINE_ROUTINE bool _CORE_barrier_Is_automatic(
     
    4650
    4751/**
    48  *  This routine returns the number of threads currently waiting at the barrier.
     52 * This routine returns the number of threads currently waiting at the barrier.
    4953 *
    50  *  @param[in] the_barrier is the barrier to obtain the number of blocked
    51  *             threads for
    52  *  @return the current count of this barrier
     54 * @param[in] the_barrier is the barrier to obtain the number of blocked
     55 *            threads for
     56 * @return the current count of this barrier
    5357 */
    5458RTEMS_INLINE_ROUTINE uint32_t  _CORE_barrier_Get_number_of_waiting_threads(
     
    5963}
    6064
    61 /**@}*/
     65/** @} */
    6266
    6367#endif
  • cpukit/score/inline/rtems/score/coremsg.inl

    r4f5740f r1f0d013  
    1 /**
    2  *  @file  rtems/score/coremsg.inl
    3  *
    4  *  This include file contains the static inline implementation of all
    5  *  inlined routines in the Core Message Handler.
     1/**
     2 * @file
     3 *
     4 * @brief Inlined Routines in the Core Message Handler
     5 *
     6 * This include file contains the static inline implementation of all
     7 * inlined routines in the Core Message Handler.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreMessageQueue
    26  *  @{
     27 * @addtogroup ScoreMessageQueue
     28 *
     29 * @{
    2730 */
    2831
    2932#include <string.h>   /* needed for memcpy */
    30  
    31 /**
    32  *  This routine sends a message to the end of the specified message queue.
     33
     34/**
     35 * This routine sends a message to the end of the specified message queue.
    3336 */
    3437RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Send(
     
    5356  );
    5457}
    55  
    56 /**
    57  *  This routine sends a message to the front of the specified message queue.
     58
     59/**
     60 * This routine sends a message to the front of the specified message queue.
    5861 */
    5962RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Urgent(
     
    8083
    8184/**
    82  *  This routine copies the contents of the source message buffer
    83  *  to the destination message buffer.
     85 * This routine copies the contents of the source message buffer
     86 * to the destination message buffer.
    8487 */
    8588RTEMS_INLINE_ROUTINE void _CORE_message_queue_Copy_buffer (
     
    9396
    9497/**
    95  *  This function allocates a message buffer from the inactive
    96  *  message buffer chain.
     98 * This function allocates a message buffer from the inactive
     99 * message buffer chain.
    97100 */
    98101RTEMS_INLINE_ROUTINE CORE_message_queue_Buffer_control *
     
    106109
    107110/**
    108  *  This routine frees a message buffer to the inactive
    109  *  message buffer chain.
     111 * This routine frees a message buffer to the inactive
     112 * message buffer chain.
    110113 */
    111114RTEMS_INLINE_ROUTINE void _CORE_message_queue_Free_message_buffer (
     
    118121
    119122/**
    120  *  This function returns the priority of @a the_message.
    121  *
    122  *  NOTE: It encapsulates the optional behavior that message priority is
    123  *        disabled if no API requires it.
     123 * This function returns the priority of @a the_message.
     124 *
     125 * @note It encapsulates the optional behavior that message priority is
     126 *       disabled if no API requires it.
    124127 */
    125128RTEMS_INLINE_ROUTINE int _CORE_message_queue_Get_message_priority (
     
    135138
    136139/**
    137  *  This function sets the priority of @a the_message.
    138  *
    139  *  NOTE: It encapsulates the optional behavior that message priority is
    140  *        disabled if no API requires it.
     140 * This function sets the priority of @a the_message.
     141 *
     142 * @note It encapsulates the optional behavior that message priority is
     143 *       disabled if no API requires it.
    141144 */
    142145RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_message_priority (
    143146  CORE_message_queue_Buffer_control *the_message,
    144   int                                priority 
     147  int                                priority
    145148)
    146149{
     
    151154
    152155/**
    153  *  This function removes the first message from the_message_queue
    154  *  and returns a pointer to it.
     156 * This function removes the first message from the_message_queue
     157 * and returns a pointer to it.
    155158 */
    156159RTEMS_INLINE_ROUTINE
     
    164167
    165168/**
    166  *  This function returns true if the priority attribute is
    167  *  enabled in the attribute_set and false otherwise.
     169 * This function returns true if the priority attribute is
     170 * enabled in the attribute_set and false otherwise.
    168171 */
    169172RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_priority(
     
    176179
    177180/**
    178  *  This routine places the_message at the rear of the outstanding
    179  *  messages on the_message_queue.
     181 * This routine places the_message at the rear of the outstanding
     182 * messages on the_message_queue.
    180183 */
    181184RTEMS_INLINE_ROUTINE void _CORE_message_queue_Append_unprotected (
     
    191194
    192195/**
    193  *  This routine places the_message at the front of the outstanding
    194  *  messages on the_message_queue.
     196 * This routine places the_message at the front of the outstanding
     197 * messages on the_message_queue.
    195198 */
    196199RTEMS_INLINE_ROUTINE void _CORE_message_queue_Prepend_unprotected (
     
    206209
    207210/**
    208  *  This function returns true if the_message_queue is true and false otherwise.
     211 * This function returns true if the_message_queue is true and false otherwise.
    209212 */
    210213RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_null (
     
    217220#if defined(RTEMS_SCORE_COREMSG_ENABLE_NOTIFICATION)
    218221  /**
    219    *  This function returns true if notification is enabled on this message
    220    *  queue and false otherwise.
     222   * This function returns true if notification is enabled on this message
     223   * queue and false otherwise.
    221224   */
    222225  RTEMS_INLINE_ROUTINE bool _CORE_message_queue_Is_notify_enabled (
     
    229232
    230233/**
    231  *  This routine initializes the notification information for
    232  *  @a the_message_queue.
     234 * This routine initializes the notification information for
     235 * @a the_message_queue.
    233236 */
    234237#if defined(RTEMS_SCORE_COREMSG_ENABLE_NOTIFICATION)
     
    248251#endif
    249252
    250 /**@}*/
     253/** @} */
    251254
    252255#endif
  • cpukit/score/inline/rtems/score/corerwlock.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/corerwlock.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains all of the inlined routines associated
    5  *  with the SuperCore RWLock.
     4 * @brief Inlined Routines Associated with the SuperCore RWLock
     5 *
     6 * This include file contains all of the inlined routines associated
     7 * with the SuperCore RWLock.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreRWLock
    26  *  @{
     27 * @addtogroup ScoreRWLock
     28 *
     29 * @{
    2730 */
    2831
     
    3134
    3235/**
     36 * This method is used to initialize core rwlock attributes.
    3337 *
    34  *  This method is used to initialize core rwlock attributes.
    35  *
    36  *  @param[in] the_attributes pointer to the attributes to initialize.
     38 * @param[in] the_attributes pointer to the attributes to initialize.
    3739 */
    3840RTEMS_INLINE_ROUTINE void _CORE_RWLock_Initialize_attributes(
     
    4446
    4547
    46 /**@}*/
     48/** @} */
    4749
    4850#endif
  • cpukit/score/inline/rtems/score/coresem.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/coresem.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains all of the inlined routines associated
    5  *  with the SuperCore semaphore.
     4 * @brief Inlined Routines Associated with the SuperCore Semaphore
     5 *
     6 * This include file contains all of the inlined routines associated
     7 * with the SuperCore semaphore.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreSemaphore
    26  *  @{
     27 * @addtogroup ScoreSemaphore
     28 *
     29 * @{
    2730 */
    2831
     
    3134
    3235/**
    33  *  This function returns true if the priority attribute is
    34  *  enabled in the @a attribute_set and false otherwise.
     36 * This function returns true if the priority attribute is
     37 * enabled in the @a attribute_set and false otherwise.
    3538 *
    36  *  @param[in] the_attribute is the attribute set to test
    37  *  @return true if the priority attribute is enabled
     39 * @param[in] the_attribute is the attribute set to test
     40 *
     41 * @return true if the priority attribute is enabled
    3842 */
    3943RTEMS_INLINE_ROUTINE bool _CORE_semaphore_Is_priority(
     
    4549
    4650/**
    47  *  This routine returns the current count associated with the semaphore.
     51 * This routine returns the current count associated with the semaphore.
    4852 *
    49  *  @param[in] the_semaphore is the semaphore to obtain the count of
    50  *  @return the current count of this semaphore
     53 * @param[in] the_semaphore is the semaphore to obtain the count of
     54 *
     55 * @return the current count of this semaphore
    5156 */
    5257RTEMS_INLINE_ROUTINE uint32_t  _CORE_semaphore_Get_count(
     
    5863
    5964/**
    60  *  This routine attempts to receive a unit from the_semaphore.
    61  *  If a unit is available or if the wait flag is false, then the routine
    62  *  returns.  Otherwise, the calling task is blocked until a unit becomes
    63  *  available.
     65 * This routine attempts to receive a unit from the_semaphore.
     66 * If a unit is available or if the wait flag is false, then the routine
     67 * returns.  Otherwise, the calling task is blocked until a unit becomes
     68 * available.
    6469 *
    65  *  @param[in] the_semaphore is the semaphore to obtain
    66  *  @param[in] id is the Id of the owning API level Semaphore object
    67  *  @param[in] wait is true if the thread is willing to wait
    68  *  @param[in] timeout is the maximum number of ticks to block
    69  *  @param[in] level_p is a temporary variable used to contain the ISR
    70  *         disable level cookie
     70 * @param[in] the_semaphore is the semaphore to obtain
     71 * @param[in] id is the Id of the owning API level Semaphore object
     72 * @param[in] wait is true if the thread is willing to wait
     73 * @param[in] timeout is the maximum number of ticks to block
     74 * @param[in] level_p is a temporary variable used to contain the ISR
     75 *        disable level cookie
    7176 *
    72  *  @note There is currently no MACRO version of this routine.
     77 * @note There is currently no MACRO version of this routine.
    7378 */
    7479RTEMS_INLINE_ROUTINE void _CORE_semaphore_Seize_isr_disable(
     
    7883  Watchdog_Interval        timeout,
    7984  ISR_Level               *level_p
    80 ) 
    81 { 
     85)
     86{
    8287  Thread_Control *executing;
    8388
    8489  /* disabled when you get here */
    85  
     90
    8691  executing = _Thread_Executing;
    8792  executing->Wait.return_code = CORE_SEMAPHORE_STATUS_SUCCESSFUL;
     
    108113}
    109114
    110 /**@}*/
     115/** @} */
    111116
    112117#endif
  • cpukit/score/inline/rtems/score/corespinlock.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/corespinlock.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains all of the inlined routines associated
    5  *  with the SuperCore spinlock.
     4 * @brief Inlined Routines Associated with the SuperCore Spinlock
     5 *
     6 * This include file contains all of the inlined routines associated
     7 * with the SuperCore spinlock.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreSpinlock
    26  *  @{
     27 * @addtogroup ScoreSpinlock
     28 *
     29 * @{
    2730 */
    2831
    2932/**
     33 * This method is used to initialize core spinlock attributes.
    3034 *
    31  *  This method is used to initialize core spinlock attributes.
    32  *
    33  *  @param[in] the_attributes pointer to the attributes to initialize.
     35 * @param[in] the_attributes pointer to the attributes to initialize.
    3436 */
    3537RTEMS_INLINE_ROUTINE void _CORE_spinlock_Initialize_attributes(
     
    4143
    4244/**
     45 * This method is used to determine if the spinlock is available or not.
    4346 *
    44  *  This method is used to determine if the spinlock is available or not.
     47 * @param[in] the_spinlock will be checked
    4548 *
    46  *  @param[in] the_spinlock will be checked
    47  *
    48  *  @return This method will return true if the spinlock is busy
    49  *          and false otherwise.
     49 * @return This method will return true if the spinlock is busy
     50 *         and false otherwise.
    5051 */
    5152RTEMS_INLINE_ROUTINE bool _CORE_spinlock_Is_busy(
     
    5657}
    5758
    58 /**@}*/
     59/** @} */
    5960
    6061#endif
  • cpukit/score/inline/rtems/score/isr.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/isr.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains the static implementation of all
    5  *  inlined routines in the Interrupt Handler.
     4 * @brief Inlined Routines in the Interrupt Handler
     5 *
     6 * This include file contains the static implementation of all
     7 * inlined routines in the Interrupt Handler.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreISR
    26  *  @{
     27 * @addtogroup ScoreISR
     28 *
     29 * @{
    2730 */
    2831
    2932#if (CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE)
    3033/**
    31  *  This function returns true if the vector is a valid vector number
    32  *  for this processor and false otherwise.
     34 * This function returns true if the vector is a valid vector number
     35 * for this processor and false otherwise.
    3336 */
    3437
     
    4144
    4245/**
    43  *  This function returns true if handler is the entry point of a valid
    44  *  use interrupt service routine and false otherwise.
     46 * This function returns true if handler is the entry point of a valid
     47 * use interrupt service routine and false otherwise.
    4548 */
    4649
     
    5356#endif
    5457
    55 /**@}*/
     58/** @} */
    5659
    5760#endif
  • cpukit/score/inline/rtems/score/mppkt.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/mppkt.inl
     1/**
     2 * @file
    33 *
    4  *  This package is the implementation of the Packet Handler
    5  *  routines which are inlined.
     4 * @brief Inlined Routines from the Packet Handler
     5 *
     6 * This package is the implementation of the Packet Handler
     7 * routines which are inlined.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreMPPacket
    26  *  @{
     27 * @addtogroup ScoreMPPacket
     28 *
     29 * @{
    2730 */
    2831
    2932/**
    30  *  This function returns true if the the_packet_class is valid,
    31  *  and false otherwise.
     33 * This function returns true if the the_packet_class is valid,
     34 * and false otherwise.
    3235 *
    33  *  @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
    34  *        because this enum starts at lower bound of zero.
     36 * @note Check for lower bounds (MP_PACKET_CLASSES_FIRST ) is unnecessary
     37 *       because this enum starts at lower bound of zero.
    3538 */
    3639
     
    4346
    4447/**
    45  *  This function returns true if the the_packet_class is null,
    46  *  and false otherwise.
     48 * This function returns true if the the_packet_class is null,
     49 * and false otherwise.
    4750 */
    4851
     
    5457}
    5558
    56 /**@}*/
     59/** @} */
    5760
    5861#endif
  • cpukit/score/inline/rtems/score/object.inl

    r4f5740f r1f0d013  
    11/**
    2  * @file rtems/score/object.inl
     2 * @file
     3 *
     4 * @brief Inlined Routines in the Object Handler
    35 *
    46 * This include file contains the static inline implementation of all
     
    2325
    2426/**
    25  *  This function builds an object's id from the processor node and index
    26  *  values specified.
    27  *
    28  *  @param[in] the_api indicates the API associated with this Id.
    29  *  @param[in] the_class indicates the class of object.
    30  *             It is specific to @a the_api.
    31  *  @param[in] node is the node where this object resides.
    32  *  @param[in] index is the instance number of this object.
    33  *
    34  *  @return This method returns an object Id constructed from the arguments.
     27 * This function builds an object's id from the processor node and index
     28 * values specified.
     29 *
     30 * @param[in] the_api indicates the API associated with this Id.
     31 * @param[in] the_class indicates the class of object.
     32 *            It is specific to @a the_api.
     33 * @param[in] node is the node where this object resides.
     34 * @param[in] index is the instance number of this object.
     35 *
     36 * @return This method returns an object Id constructed from the arguments.
    3537 */
    3638RTEMS_INLINE_ROUTINE Objects_Id _Objects_Build_id(
     
    5052
    5153/**
    52  *  This function returns the API portion of the ID.
    53  *
    54  *  @param[in] id is the object Id to be processed.
    55  *
    56  *  @return This method returns an object Id constructed from the arguments.
     54 * This function returns the API portion of the ID.
     55 *
     56 * @param[in] id is the object Id to be processed.
     57 *
     58 * @return This method returns an object Id constructed from the arguments.
    5759 */
    5860RTEMS_INLINE_ROUTINE Objects_APIs _Objects_Get_API(
     
    6466
    6567/**
    66  *  This function returns the class portion of the ID.
    67  *
    68  *  @param[in] id is the object Id to be processed
     68 * This function returns the class portion of the ID.
     69 *
     70 * @param[in] id is the object Id to be processed
    6971 */
    7072RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_class(
     
    7274)
    7375{
    74   return (uint32_t) 
     76  return (uint32_t)
    7577    ((id >> OBJECTS_CLASS_START_BIT) & OBJECTS_CLASS_VALID_BITS);
    7678}
    77  
    78 /**
    79  *  This function returns the node portion of the ID.
    80  *
    81  *  @param[in] id is the object Id to be processed
    82  *
    83  *  @return This method returns the node portion of an object ID.
     79
     80/**
     81 * This function returns the node portion of the ID.
     82 *
     83 * @param[in] id is the object Id to be processed
     84 *
     85 * @return This method returns the node portion of an object ID.
    8486 */
    8587RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_node(
     
    99101
    100102/**
    101  *  This function returns the index portion of the ID.
    102  *
    103  *  @param[in] id is the Id to be processed
    104  *
    105  *  @return This method returns the class portion of the specified object ID.
     103 * This function returns the index portion of the ID.
     104 *
     105 * @param[in] id is the Id to be processed
     106 *
     107 * @return This method returns the class portion of the specified object ID.
    106108 */
    107109RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Get_index(
     
    115117
    116118/**
    117  *  This function returns true if the api is valid.
    118  *
    119  *  @param[in] the_api is the api portion of an object ID.
    120  *
    121  *  @return This method returns true if the specified api value is valid
    122  *          and false otherwise.
     119 * This function returns true if the api is valid.
     120 *
     121 * @param[in] the_api is the api portion of an object ID.
     122 *
     123 * @return This method returns true if the specified api value is valid
     124 *         and false otherwise.
    123125 */
    124126RTEMS_INLINE_ROUTINE bool _Objects_Is_api_valid(
     
    130132  return true;
    131133}
    132    
    133 /**
    134  *  This function returns true if the node is of the local object, and
    135  *  false otherwise.
    136  *
    137  *  @param[in] node is the node number and corresponds to the node number
    138  *         portion of an object ID.
    139  *
    140  *  @return This method returns true if the specified node is the local node
    141  *          and false otherwise.
     134
     135/**
     136 * This function returns true if the node is of the local object, and
     137 * false otherwise.
     138 *
     139 * @param[in] node is the node number and corresponds to the node number
     140 *        portion of an object ID.
     141 *
     142 * @return This method returns true if the specified node is the local node
     143 *         and false otherwise.
    142144 */
    143145RTEMS_INLINE_ROUTINE bool _Objects_Is_local_node(
     
    149151
    150152/**
    151  *  This function returns true if the id is of a local object, and
    152  *  false otherwise.
    153  *
    154  *  @param[in] id is an object ID
    155  *
    156  *  @return This method returns true if the specified object Id is local
    157  *          and false otherwise.
    158  *
    159  *  @note On a single processor configuration, this always returns true.
     153 * This function returns true if the id is of a local object, and
     154 * false otherwise.
     155 *
     156 * @param[in] id is an object ID
     157 *
     158 * @return This method returns true if the specified object Id is local
     159 *         and false otherwise.
     160 *
     161 * @note On a single processor configuration, this always returns true.
    160162 */
    161163RTEMS_INLINE_ROUTINE bool _Objects_Is_local_id(
     
    175177
    176178/**
    177  *  This function returns true if left and right are equal,
    178  *  and false otherwise.
    179  *
    180  *  @param[in] left is the Id on the left hand side of the comparison
    181  *  @param[in] right is the Id on the right hand side of the comparison
    182  *
    183  *  @return This method returns true if the specified object IDs are equal
    184  *          and false otherwise.
     179 * This function returns true if left and right are equal,
     180 * and false otherwise.
     181 *
     182 * @param[in] left is the Id on the left hand side of the comparison
     183 * @param[in] right is the Id on the right hand side of the comparison
     184 *
     185 * @return This method returns true if the specified object IDs are equal
     186 *         and false otherwise.
    185187 */
    186188RTEMS_INLINE_ROUTINE bool _Objects_Are_ids_equal(
     
    193195
    194196/**
    195  *  This function returns a pointer to the local_table object
    196  *  referenced by the index.
    197  *
    198  *  @param[in] information points to an Object Information Table
    199  *  @param[in] index is the index of the object the caller wants to access
    200  *
    201  *  @return This method returns a pointer to a local object or NULL if the
    202  *          index is invalid and RTEMS_DEBUG is enabled.
     197 * This function returns a pointer to the local_table object
     198 * referenced by the index.
     199 *
     200 * @param[in] information points to an Object Information Table
     201 * @param[in] index is the index of the object the caller wants to access
     202 *
     203 * @return This method returns a pointer to a local object or NULL if the
     204 *         index is invalid and RTEMS_DEBUG is enabled.
    203205 */
    204206RTEMS_INLINE_ROUTINE Objects_Control *_Objects_Get_local_object(
     
    208210{
    209211  /*
    210    *  This routine is ONLY to be called from places in the code
    211    *  where the Id is known to be good.  Therefore, this should NOT
    212    *  occur in normal situations.
    213    */ 
     212   * This routine is ONLY to be called from places in the code
     213   * where the Id is known to be good.  Therefore, this should NOT
     214   * occur in normal situations.
     215   */
    214216  #if defined(RTEMS_DEBUG)
    215217    if ( index > information->maximum )
     
    220222
    221223/**
    222  *  This function sets the pointer to the local_table object
    223  *  referenced by the index.
    224  *
    225  *  @param[in] information points to an Object Information Table
    226  *  @param[in] index is the index of the object the caller wants to access
    227  *  @param[in] the_object is the local object pointer
    228  *
    229  *  @note This routine is ONLY to be called in places where the
    230  *        index portion of the Id is known to be good.  This is
    231  *        OK since it is normally called from object create/init
    232  *        or delete/destroy operations.
     224 * This function sets the pointer to the local_table object
     225 * referenced by the index.
     226 *
     227 * @param[in] information points to an Object Information Table
     228 * @param[in] index is the index of the object the caller wants to access
     229 * @param[in] the_object is the local object pointer
     230 *
     231 * @note This routine is ONLY to be called in places where the
     232 *       index portion of the Id is known to be good.  This is
     233 *       OK since it is normally called from object create/init
     234 *       or delete/destroy operations.
    233235 */
    234236
     
    243245   *  where the Id is known to be good.  Therefore, this should NOT
    244246   *  occur in normal situations.
    245    */ 
     247   */
    246248  #if defined(RTEMS_DEBUG)
    247249    if ( index > information->maximum )
     
    253255
    254256/**
    255  *  This function sets the pointer to the local_table object
    256  *  referenced by the index to a NULL so the object Id is invalid
    257  *  after this call.
    258  *
    259  *  @param[in] information points to an Object Information Table
    260  *  @param[in] the_object is the local object pointer
    261  *
    262  *  @note This routine is ONLY to be called in places where the
    263  *        index portion of the Id is known to be good.  This is
    264  *        OK since it is normally called from object create/init
    265  *        or delete/destroy operations.
     257 * This function sets the pointer to the local_table object
     258 * referenced by the index to a NULL so the object Id is invalid
     259 * after this call.
     260 *
     261 * @param[in] information points to an Object Information Table
     262 * @param[in] the_object is the local object pointer
     263 *
     264 * @note This routine is ONLY to be called in places where the
     265 *       index portion of the Id is known to be good.  This is
     266 *       OK since it is normally called from object create/init
     267 *       or delete/destroy operations.
    266268 */
    267269
     
    279281
    280282/**
    281  *  This function places the_object control pointer and object name
    282  *  in the Local Pointer and Local Name Tables, respectively.
    283  *
    284  *  @param[in] information points to an Object Information Table
    285  *  @param[in] the_object is a pointer to an object
    286  *  @param[in] name is the name of the object to make accessible
     283 * This function places the_object control pointer and object name
     284 * in the Local Pointer and Local Name Tables, respectively.
     285 *
     286 * @param[in] information points to an Object Information Table
     287 * @param[in] the_object is a pointer to an object
     288 * @param[in] name is the name of the object to make accessible
    287289 */
    288290RTEMS_INLINE_ROUTINE void _Objects_Open(
     
    302304
    303305/**
    304  *  This function places the_object control pointer and object name
    305  *  in the Local Pointer and Local Name Tables, respectively.
    306  *
    307  *  @param[in] information points to an Object Information Table
    308  *  @param[in] the_object is a pointer to an object
    309  *  @param[in] name is the name of the object to make accessible
     306 * This function places the_object control pointer and object name
     307 * in the Local Pointer and Local Name Tables, respectively.
     308 *
     309 * @param[in] information points to an Object Information Table
     310 * @param[in] the_object is a pointer to an object
     311 * @param[in] name is the name of the object to make accessible
    310312 */
    311313RTEMS_INLINE_ROUTINE void _Objects_Open_u32(
     
    321323  );
    322324
    323   /* ASSERT: information->is_string == false */ 
     325  /* ASSERT: information->is_string == false */
    324326  the_object->name.name_u32 = name;
    325327}
    326328
    327329/**
    328  *  This function places the_object control pointer and object name
    329  *  in the Local Pointer and Local Name Tables, respectively.
    330  *
    331  *  @param[in] information points to an Object Information Table
    332  *  @param[in] the_object is a pointer to an object
    333  *  @param[in] name is the name of the object to make accessible
     330 * This function places the_object control pointer and object name
     331 * in the Local Pointer and Local Name Tables, respectively.
     332 *
     333 * @param[in] information points to an Object Information Table
     334 * @param[in] the_object is a pointer to an object
     335 * @param[in] name is the name of the object to make accessible
    334336 */
    335337RTEMS_INLINE_ROUTINE void _Objects_Open_string(
     
    346348
    347349  #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)
    348     /* ASSERT: information->is_string */ 
     350    /* ASSERT: information->is_string */
    349351    the_object->name.name_p = name;
    350352  #endif
     
    352354
    353355/**
    354  *  Returns if the object maximum specifies unlimited objects.
    355  *
    356  *  @param[in] maximum The object maximum specification.
    357  *
    358  *  @retval true Unlimited objects are available.
    359  *  @retval false The object count is fixed.
     356 * Returns if the object maximum specifies unlimited objects.
     357 *
     358 * @param[in] maximum The object maximum specification.
     359 *
     360 * @retval true Unlimited objects are available.
     361 * @retval false The object count is fixed.
    360362 */
    361363RTEMS_INLINE_ROUTINE bool _Objects_Is_unlimited( uint32_t maximum )
  • cpukit/score/inline/rtems/score/objectmp.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/objectmp.inl
     1/**
     2 * @file
    33 *
    4  *  This include file contains the bodies of all inlined routines
    5  *  which deal with global objects.
     4 * @brief Inlined Routines Associated with Global Objects
     5 *
     6 * This include file contains the bodies of all inlined routines
     7 * which deal with global objects.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreObjectMP
    26  *  @{
     27 * @addtogroup ScoreObjectMP
     28 *
     29 * @{
    2730 */
    2831
    2932/**
    30  *  This function allocates a Global Object control block.
     33 * This function allocates a Global Object control block.
    3134 */
    3235
     
    4043
    4144/**
    42  *  This routine deallocates a Global Object control block.
     45 * This routine deallocates a Global Object control block.
    4346 */
    4447
     
    5457
    5558/**
    56  *  This function returns whether the global object is NULL or not.
     59 * This function returns whether the global object is NULL or not.
    5760 */
    5861
     
    6467}
    6568
    66 /**@}*/
     69/** @} */
    6770
    6871#endif
  • cpukit/score/inline/rtems/score/scheduler.inl

    r4f5740f r1f0d013  
    1 /**
    2  *  @file  rtems/score/scheduler.inl
    3  *
    4  *  This inline file contains all of the inlined routines associated with
    5  *  the manipulation of the scheduler.
     1/**
     2 * @file
     3 *
     4 * @brief Inlined Routines Associated with the Manipulation of the Scheduler
     5 *
     6 * This inline file contains all of the inlined routines associated with
     7 * the manipulation of the scheduler.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreScheduler
     27 * @addtogroup ScoreScheduler
     28 *
    2629 * @{
    2730 */
    2831
    2932/**
    30  * The preferred method to add a new scheduler is to define the jump table 
    31  * entries and add a case to the _Scheduler_Initialize routine. 
    32  *
    33  * Generic scheduling implementations that rely on the ready queue only can 
     33 * The preferred method to add a new scheduler is to define the jump table
     34 * entries and add a case to the _Scheduler_Initialize routine.
     35 *
     36 * Generic scheduling implementations that rely on the ready queue only can
    3437 * be found in the _Scheduler_queue_XXX functions.
    35  *
    36  */
    37 
    38 /* Passing the Scheduler_Control* to these functions allows for multiple
    39  * scheduler's to exist simultaneously, which could be useful on an SMP 
    40  * system.  Then remote Schedulers may be accessible.  How to protect such 
     38 */
     39
     40/*
     41 * Passing the Scheduler_Control* to these functions allows for multiple
     42 * scheduler's to exist simultaneously, which could be useful on an SMP
     43 * system.  Then remote Schedulers may be accessible.  How to protect such
    4144 * accesses remains an open problem.
    4245 */
    4346
    44 /** @brief _Scheduler_Schedule
    45  *
    46  *  This kernel routine implements the scheduling decision logic for
    47  *  the scheduler. It does NOT dispatch.
     47/**
     48 * @brief Scheduler schedule.
     49 *
     50 * This kernel routine implements the scheduling decision logic for
     51 * the scheduler. It does NOT dispatch.
    4852 */
    4953RTEMS_INLINE_ROUTINE void _Scheduler_Schedule( void )
     
    5256}
    5357
    54 /** @brief _Scheduler_Yield
    55  *
    56  *  This routine is invoked when a thread wishes to voluntarily
    57  *  transfer control of the processor to another thread. This routine
    58  *  always operates on the scheduler that 'owns' the currently executing
    59  *  thread.
     58/**
     59 * @brief Scheduler yield.
     60 *
     61 * This routine is invoked when a thread wishes to voluntarily
     62 * transfer control of the processor to another thread. This routine
     63 * always operates on the scheduler that 'owns' the currently executing
     64 * thread.
    6065 */
    6166RTEMS_INLINE_ROUTINE void _Scheduler_Yield( void )
     
    6469}
    6570
    66 /** @brief _Scheduler_Block
    67  *
    68  *  This routine removes @a the_thread from the scheduling decision for
    69  *  the scheduler. The primary task is to remove the thread from the
    70  *  ready queue.  It performs any necessary schedulering operations
    71  *  including the selection of a new heir thread.
    72  */
    73 RTEMS_INLINE_ROUTINE void _Scheduler_Block(
    74     Thread_Control    *the_thread
     71/**
     72 * @brief Scheduler block.
     73 *
     74 * This routine removes @a the_thread from the scheduling decision for
     75 * the scheduler. The primary task is to remove the thread from the
     76 * ready queue.  It performs any necessary schedulering operations
     77 * including the selection of a new heir thread.
     78 */
     79RTEMS_INLINE_ROUTINE void _Scheduler_Block(
     80    Thread_Control    *the_thread
    7581)
    7682{
     
    7884}
    7985
    80 /** @brief _Scheduler_Unblock
    81  *
    82  *  This routine adds @a the_thread to the scheduling decision for
    83  *  the scheduler.  The primary task is to add the thread to the
    84  *  ready queue per the schedulering policy and update any appropriate
    85  *  scheduling variables, for example the heir thread.
     86/**
     87 * @brief Scheduler unblock.
     88 *
     89 * This routine adds @a the_thread to the scheduling decision for
     90 * the scheduler.  The primary task is to add the thread to the
     91 * ready queue per the schedulering policy and update any appropriate
     92 * scheduling variables, for example the heir thread.
    8693 */
    8794RTEMS_INLINE_ROUTINE void _Scheduler_Unblock(
    88     Thread_Control    *the_thread 
     95    Thread_Control    *the_thread
    8996)
    9097{
     
    9299}
    93100
    94 /** @brief _Scheduler_Allocate
     101/**
     102 * @brief Scheduler allocate.
    95103 *
    96104 * This routine allocates @a the_thread->scheduler
    97105 */
    98 RTEMS_INLINE_ROUTINE void* _Scheduler_Allocate( 
     106RTEMS_INLINE_ROUTINE void* _Scheduler_Allocate(
    99107  Thread_Control    *the_thread
    100108)
     
    103111}
    104112
    105 /** @brief _Scheduler_Free
     113/**
     114 * @brief Scheduler free.
    106115 *
    107116 * This routine frees @a the_thread->scheduler
    108117 */
    109 RTEMS_INLINE_ROUTINE void _Scheduler_Free( 
     118RTEMS_INLINE_ROUTINE void _Scheduler_Free(
    110119  Thread_Control    *the_thread
    111120)
     
    114123}
    115124
    116 /** @brief _Scheduler_Update
     125/**
     126 * @brief Scheduler update.
    117127 *
    118128 * This routine updates @a the_thread->scheduler
    119129 */
    120 RTEMS_INLINE_ROUTINE void _Scheduler_Update( 
     130RTEMS_INLINE_ROUTINE void _Scheduler_Update(
    121131  Thread_Control    *the_thread
    122132)
     
    125135}
    126136
    127 /** @brief _Scheduler_Enqueue
     137/**
     138 * @brief Scheduler enqueue.
    128139 *
    129140 * This routine enqueue @a the_thread->scheduler
    130141 */
    131 RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue( 
     142RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue(
    132143  Thread_Control    *the_thread
    133144)
     
    136147}
    137148
    138 /** @brief _Scheduler_Enqueue_first
     149/**
     150 * @brief Scheduler enqueue first.
    139151 *
    140152 * This routine enqueue_first @a the_thread->scheduler
    141153 */
    142 RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue_first( 
     154RTEMS_INLINE_ROUTINE void _Scheduler_Enqueue_first(
    143155  Thread_Control    *the_thread
    144156)
     
    147159}
    148160
    149 /** @brief _Scheduler_Extract
     161/**
     162 * @brief Scheduler extract.
    150163 *
    151164 * This routine extract @a the_thread->scheduler
    152165 */
    153 RTEMS_INLINE_ROUTINE void _Scheduler_Extract( 
     166RTEMS_INLINE_ROUTINE void _Scheduler_Extract(
    154167  Thread_Control    *the_thread
    155168)
     
    159172
    160173/**
    161  * @brief Scheduler Priority compare
     174 * @brief Scheduler priority compare.
    162175 *
    163176 * This routine compares two priorities.
     
    172185
    173186/**
    174  * @brief Scheduler Release job
     187 * @brief Scheduler release job.
    175188 *
    176189 * This routine is called when a new period of task is issued.
     
    184197}
    185198
    186 /** @brief Scheduler Method Invoked at Each Clock Tick
     199/**
     200 * @brief Scheduler method invoked at each clock tick.
    187201 *
    188202 * This method is invoked at each clock tick to allow the scheduler
    189  * implementation to perform any activities required.  For the 
     203 * implementation to perform any activities required.  For the
    190204 * scheduler which support standard RTEMS features, this includes
    191205 * time-slicing management.
     
    196210}
    197211
    198 /**@}*/
     212/** @} */
    199213
    200214#endif
  • cpukit/score/inline/rtems/score/stack.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/stack.inl
     1/**
     2 * @file
    33 *
    4  *  This file contains the static inline implementation of the inlined
    5  *  routines from the Stack Handler.
     4 * @brief Inlined Routines from the Stack Handler
     5 *
     6 * This file contains the static inline implementation of the inlined
     7 * routines from the Stack Handler.
    68 */
    79
     
    2527
    2628/**
    27  *  @addtogroup ScoreStack
    28  *  @{
     29 * @addtogroup ScoreStack
     30 *
     31 * @{
    2932 */
    3033
    3134/**
    32  *  This routine initializes the_stack record to indicate that
    33  *  size bytes of memory starting at starting_address have been
    34  *  reserved for a stack.
     35 * This routine initializes the_stack record to indicate that
     36 * size bytes of memory starting at starting_address have been
     37 * reserved for a stack.
    3538 */
    3639RTEMS_INLINE_ROUTINE void _Stack_Initialize (
     
    4548
    4649/**
    47  *  This function returns the minimum stack size configured
    48  *  for this application.
     50 * This function returns the minimum stack size configured
     51 * for this application.
    4952 *
    50  *  @return This method returns the minimum stack size;
     53 * @return This method returns the minimum stack size;
    5154 */
    5255RTEMS_INLINE_ROUTINE uint32_t _Stack_Minimum (void)
     
    5659
    5760/**
    58  *  This function returns true if size bytes is enough memory for
    59  *  a valid stack area on this processor, and false otherwise.
     61 * This function returns true if size bytes is enough memory for
     62 * a valid stack area on this processor, and false otherwise.
    6063 *
    61  *  @param[in] size is the stack size to check
     64 * @param[in] size is the stack size to check
    6265 *
    63  *  @return This method returns true if the stack is large enough.
     66 * @return This method returns true if the stack is large enough.
    6467 */
    6568RTEMS_INLINE_ROUTINE bool _Stack_Is_enough (
     
    7174
    7275/**
    73  *  This function returns the appropriate stack size given the requested
    74  *  size.  If the requested size is below the minimum, then the minimum
    75  *  configured stack size is returned.
     76 * This function returns the appropriate stack size given the requested
     77 * size.  If the requested size is below the minimum, then the minimum
     78 * configured stack size is returned.
    7679 *
    77  *  @param[in] size is the stack size to check
     80 * @param[in] size is the stack size to check
    7881 *
    79  *  @return This method returns the appropriate stack size.
     82 * @return This method returns the appropriate stack size.
    8083 */
    8184RTEMS_INLINE_ROUTINE size_t _Stack_Ensure_minimum (
     
    8891}
    8992
    90 /**@}*/
     93/** @} */
    9194
    9295#endif
  • cpukit/score/inline/rtems/score/states.inl

    r4f5740f r1f0d013  
    1 /**
    2  *  @file  rtems/score/states.inl
    3  *
    4  *  This file contains the static inline implementation of the inlined
    5  *  routines associated with thread state information.
     1/**
     2 * @file
     3 *
     4 * @brief Inlined Routines Associated with Thread State Information
     5 *
     6 * This file contains the static inline implementation of the inlined
     7 * routines associated with thread state information.
    68 */
    79
     
    2527
    2628/**
    27  *  @addtogroup ScoreStates
    28  *  @{
    29  */
    30 
    31 /**
    32  *  This function sets the given states_to_set into the current_state
    33  *  passed in.  The result is returned to the user in current_state.
    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.
     29 * @addtogroup ScoreStates
     30 *
     31 * @{
     32 */
     33
     34/**
     35 * This function sets the given states_to_set into the current_state
     36 * passed in.  The result is returned to the user in current_state.
     37 *
     38 * @param[in] states_to_set is the state bits to set
     39 * @param[in] current_state is the state set to add them to
     40 *
     41 * @return This method returns the updated states value.
    3942 */
    4043RTEMS_INLINE_ROUTINE States_Control _States_Set (
     
    4750
    4851/**
    49  *  This function clears the given states_to_clear into the current_state
    50  *  passed in.  The result is returned to the user in current_state.
    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.
     52 * This function clears the given states_to_clear into the current_state
     53 * passed in.  The result is returned to the user in current_state.
     54 *
     55 * @param[in] states_to_set is the state bits to clean
     56 * @param[in] current_state is the state set to remove them from
     57 *
     58 * @return This method returns the updated states value.
    5659 */
    5760RTEMS_INLINE_ROUTINE States_Control _States_Clear (
     
    6467
    6568/**
    66  *  This function returns true if the_states indicates that the
    67  *  state is READY, and false otherwise.
    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.
     69 * This function returns true if the_states indicates that the
     70 * state is READY, and false otherwise.
     71 *
     72 * @param[in] the_states is the task state set to test
     73 *
     74 * @return This method returns true if the desired state condition is set.
    7275 */
    7376RTEMS_INLINE_ROUTINE bool _States_Is_ready (
     
    7982
    8083/**
    81  *  This function returns true if the DORMANT state is the ONLY state
    82  *  set in the_states, and false otherwise.
    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.
     84 * This function returns true if the DORMANT state is the ONLY state
     85 * set in the_states, and false otherwise.
     86 *
     87 * @param[in] the_states is the task state set to test
     88 *
     89 * @return This method returns true if the desired state condition is set.
    8790 */
    8891RTEMS_INLINE_ROUTINE bool _States_Is_only_dormant (
     
    9497
    9598/**
    96  *  This function returns true if the DORMANT state is set in
    97  *  the_states, and false otherwise.
    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.
     99 * This function returns true if the DORMANT state is set in
     100 * the_states, and false otherwise.
     101 *
     102 * @param[in] the_states is the task state set to test
     103 *
     104 * @return This method returns true if the desired state condition is set.
    102105 */
    103106RTEMS_INLINE_ROUTINE bool _States_Is_dormant (
     
    109112
    110113/**
    111  *  This function returns true if the SUSPENDED state is set in
    112  *  the_states, and false otherwise.
    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.
     114 * This function returns true if the SUSPENDED state is set in
     115 * the_states, and false otherwise.
     116 *
     117 * @param[in] the_states is the task state set to test
     118 *
     119 * @return This method returns true if the desired state condition is set.
    117120 */
    118121RTEMS_INLINE_ROUTINE bool _States_Is_suspended (
     
    124127
    125128/**
    126  *  This function returns true if the TRANSIENT state is set in
    127  *  the_states, and false otherwise.
    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.
     129 * This function returns true if the TRANSIENT state is set in
     130 * the_states, and false otherwise.
     131 *
     132 * @param[in] the_states is the task state set to test
     133 *
     134 * @return This method returns true if the desired state condition is set.
    132135 */
    133136RTEMS_INLINE_ROUTINE bool _States_Is_transient (
     
    139142
    140143/**
    141  *  This function returns true if the DELAYING state is set in
    142  *  the_states, and false otherwise.
    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.
     144 * This function returns true if the DELAYING state is set in
     145 * the_states, and false otherwise.
     146 *
     147 * @param[in] the_states is the task state set to test
     148 *
     149 * @return This method returns true if the desired state condition is set.
    147150 */
    148151RTEMS_INLINE_ROUTINE bool _States_Is_delaying (
     
    154157
    155158/**
    156  *  This function returns true if the WAITING_FOR_BUFFER state is set in
    157  *  the_states, and false otherwise.
    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.
     159 * This function returns true if the WAITING_FOR_BUFFER state is set in
     160 * the_states, and false otherwise.
     161 *
     162 * @param[in] the_states is the task state set to test
     163 *
     164 * @return This method returns true if the desired state condition is set.
    162165 */
    163166RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_buffer (
     
    169172
    170173/**
    171  *  This function returns true if the WAITING_FOR_SEGMENT state is set in
    172  *  the_states, and false otherwise.
    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.
     174 * This function returns true if the WAITING_FOR_SEGMENT state is set in
     175 * the_states, and false otherwise.
     176 *
     177 * @param[in] the_states is the task state set to test
     178 *
     179 * @return This method returns true if the desired state condition is set.
    177180 */
    178181RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_segment (
     
    184187
    185188/**
    186  *  This function returns true if the WAITING_FOR_MESSAGE state is set in
    187  *  the_states, and false otherwise.
    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.
     189 * This function returns true if the WAITING_FOR_MESSAGE state is set in
     190 * the_states, and false otherwise.
     191 *
     192 * @param[in] the_states is the task state set to test
     193 *
     194 * @return This method returns true if the desired state condition is set.
    192195 */
    193196RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_message (
     
    199202
    200203/**
    201  *  This function returns true if the WAITING_FOR_EVENT state is set in
    202  *  the_states, and false otherwise.
    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.
     204 * This function returns true if the WAITING_FOR_EVENT state is set in
     205 * the_states, and false otherwise.
     206 *
     207 * @param[in] the_states is the task state set to test
     208 *
     209 * @return This method returns true if the desired state condition is set.
    207210 */
    208211RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_event (
     
    214217
    215218/**
    216  *  This function returns true if the WAITING_FOR_SYSTEM_EVENT state is set in
    217  *  the_states, and false otherwise.
    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.
     219 * This function returns true if the WAITING_FOR_SYSTEM_EVENT state is set in
     220 * the_states, and false otherwise.
     221 *
     222 * @param[in] the_states is the task state set to test
     223 *
     224 * @return This method returns true if the desired state condition is set.
    222225 */
    223226RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_system_event (
     
    229232
    230233/**
    231  *  This function returns true if the WAITING_FOR_MUTEX state
    232  *  is set in the_states, and false otherwise.
    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.
     234 * This function returns true if the WAITING_FOR_MUTEX state
     235 * is set in the_states, and false otherwise.
     236 *
     237 * @param[in] the_states is the task state set to test
     238 *
     239 * @return This method returns true if the desired state condition is set.
    237240 */
    238241RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_mutex (
     
    244247
    245248/**
    246  *  This function returns true if the WAITING_FOR_SEMAPHORE state
    247  *  is set in the_states, and false otherwise.
    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.
     249 * This function returns true if the WAITING_FOR_SEMAPHORE state
     250 * is set in the_states, and false otherwise.
     251 *
     252 * @param[in] the_states is the task state set to test
     253 *
     254 * @return This method returns true if the desired state condition is set.
    252255 */
    253256RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_semaphore (
     
    259262
    260263/**
    261  *  This function returns true if the WAITING_FOR_TIME state is set in
    262  *  the_states, and false otherwise.
    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.
     264 * This function returns true if the WAITING_FOR_TIME state is set in
     265 * the_states, and false otherwise.
     266 *
     267 * @param[in] the_states is the task state set to test
     268 *
     269 * @return This method returns true if the desired state condition is set.
    267270 */
    268271RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_time (
     
    274277
    275278/**
    276  *  This function returns true if the WAITING_FOR_TIME state is set in
    277  *  the_states, and false otherwise.
    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.
     279 * This function returns true if the WAITING_FOR_TIME state is set in
     280 * the_states, and false otherwise.
     281 *
     282 * @param[in] the_states is the task state set to test
     283 *
     284 * @return This method returns true if the desired state condition is set.
    282285 */
    283286RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_rpc_reply (
     
    289292
    290293/**
    291  *  This function returns true if the WAITING_FOR_PERIOD state is set in
    292  *  the_states, and false otherwise.
    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.
     294 * This function returns true if the WAITING_FOR_PERIOD state is set in
     295 * the_states, and false otherwise.
     296 *
     297 * @param[in] the_states is the task state set to test
     298 *
     299 * @return This method returns true if the desired state condition is set.
    297300 */
    298301RTEMS_INLINE_ROUTINE bool _States_Is_waiting_for_period (
     
    304307
    305308/**
    306  *  This function returns true if the task's state is set in
    307  *  way that allows it to be interrupted by a signal.
    308  *
    309  *  @param[in] the_states is the task state set to test
    310  *
    311  *  @return This method returns true if the desired state condition is set.
     309 * This function returns true if the task's state is set in
     310 * way that allows it to be interrupted by a signal.
     311 *
     312 * @param[in] the_states is the task state set to test
     313 *
     314 * @return This method returns true if the desired state condition is set.
    312315 */
    313316RTEMS_INLINE_ROUTINE bool _States_Is_interruptible_by_signal (
     
    319322}
    320323/**
    321  *  This function returns true if one of the states which indicates
    322  *  that a task is blocked waiting for a local resource is set in
    323  *  the_states, and false otherwise.
    324  *
    325  *  @param[in] the_states is the task state set to test
    326  *
    327  *  @return This method returns true if the desired state condition is set.
     324 * This function returns true if one of the states which indicates
     325 * that a task is blocked waiting for a local resource is set in
     326 * the_states, and false otherwise.
     327 *
     328 * @param[in] the_states is the task state set to test
     329 *
     330 * @return This method returns true if the desired state condition is set.
    328331 */
    329332
     
    336339
    337340/**
    338  *  This function returns true if one of the states which indicates
    339  *  that a task is blocked waiting for a local resource is set in
    340  *  the_states, and false otherwise.
    341  *
    342  *  @param[in] the_states is the task state set to test
    343  *
    344  *  @return This method returns true if the state indicates that the
    345  *          assocated thread is waiting on a thread queue.
     341 * This function returns true if one of the states which indicates
     342 * that a task is blocked waiting for a local resource is set in
     343 * the_states, and false otherwise.
     344 *
     345 * @param[in] the_states is the task state set to test
     346 *
     347 * @return This method returns true if the state indicates that the
     348 *         assocated thread is waiting on a thread queue.
    346349 */
    347350RTEMS_INLINE_ROUTINE bool _States_Is_waiting_on_thread_queue (
     
    353356
    354357/**
    355  *  This function returns true if one of the states which indicates
    356  *  that a task is blocked is set in the_states, and false otherwise.
    357  *
    358  *  @param[in] the_states is the task state set to test
    359  *
    360  *  @return This method returns true if the state indicates that the
    361  *          assocated thread is blocked.
     358 * This function returns true if one of the states which indicates
     359 * that a task is blocked is set in the_states, and false otherwise.
     360 *
     361 * @param[in] the_states is the task state set to test
     362 *
     363 * @return This method returns true if the state indicates that the
     364 *         assocated thread is blocked.
    362365 */
    363366RTEMS_INLINE_ROUTINE bool _States_Is_blocked (
     
    369372
    370373/**
    371  *  This function returns true if any of the states in the mask
    372  *  are set in the_states, and false otherwise.
    373  *
    374  *  @param[in] the_states is the task state set to test
    375  *  @param[in] mask is the state bits to test for
    376  *
    377  *  @return This method returns true if the indicates state condition is set.
     374 * This function returns true if any of the states in the mask
     375 * are set in the_states, and false otherwise.
     376 *
     377 * @param[in] the_states is the task state set to test
     378 * @param[in] mask is the state bits to test for
     379 *
     380 * @return This method returns true if the indicates state condition is set.
    378381 */
    379382RTEMS_INLINE_ROUTINE bool _States_Are_set (
     
    385388}
    386389
    387 /**@}*/
     390/** @} */
    388391
    389392#endif
  • cpukit/score/inline/rtems/score/sysstate.inl

    r4f5740f r1f0d013  
    1 /** 
     1/**
    22 * @file
    33 *
    4  * @ingroup ScoreSysState
    5  *
    6  * @brief System State Handler API.
     4 * @brief System State Handler API
    75 */
    86
     
    2422
    2523/**
    26  * @addtogroup ScoreSysState 
     24 * @addtogroup ScoreSysState
    2725 *
    2826 * @{
     
    3533  _System_state_Current = state;
    3634}
    37  
     35
    3836RTEMS_INLINE_ROUTINE void _System_state_Handler_initialization (
    3937#if defined(RTEMS_MULTIPROCESSING)
     
    9795}
    9896
    99 /**@}*/
     97/** @} */
    10098
    10199#endif
  • cpukit/score/inline/rtems/score/thread.inl

    r4f5740f r1f0d013  
    1 /**
    2  *  @file  rtems/score/thread.inl
    3  *
    4  *  This file contains the macro implementation of the inlined
    5  *  routines from the Thread handler.
     1/**
     2 * @file
     3 *
     4 * @brief Inlined Routines from the Thread Handler
     5 *
     6 * This file contains the macro implementation of the inlined
     7 * routines from the Thread handler.
    68 */
    79
     
    2628
    2729/**
    28  *  @addtogroup ScoreThread
    29  *  @{
     30 * @addtogroup ScoreThread
     31 *
     32 * @{
    3033 */
    3134
     
    3841#else
    3942
    40   /** @brief _Thread_Dispatch_in_critical_section
    41    *
     43  /**
     44 * @brief _Thread_Dispatch_in_critical_section
     45   *
    4246   * This routine returns true if thread dispatch indicates
    4347   * that we are in a critical section.
     
    5155  }
    5256
    53   /** @brief _Thread_Dispatch_get_disable_level
    54    *
     57  /**
     58   * @brief Get thread dispatch disable level.
     59   *
    5560   * This routine returns value of the the thread dispatch level.
    5661   */
     
    6065  }
    6166
    62   /** @brief _Thread_Dispatch_set_disable_level
    63    *
    64    * This routine sets thread dispatch level to the
     67  /**
     68   * @brief Set thread dispatch disable level.
     69   *
     70   * This routine sets thread dispatch level to the
    6571   * value passed in.
    6672   */
     
    7177  }
    7278
    73   /** @brief _Thread_Dispatch_increment_disable_level
    74    *
     79  /**
     80   * @brief Increase thread dispatch disable level.
     81   *
    7582   * This rountine increments the thread dispatch level
    7683   */
     
    8592  }
    8693
    87   /** @brief _Thread_Dispatch_decrement_disable_level
    88    *
     94  /**
     95   * @brief Decrease thread dispatch disable level.
     96   *
    8997   * This routine decrements the thread dispatch level.
    9098   */
     
    99107  }
    100108
    101   /** @brief _Thread_Dispatch_initialization
    102    *
    103    *  This routine initializes the thread dispatching subsystem.
     109  /**
     110   * @brief Thread dispatch initialization.
     111   *
     112   * This routine initializes the thread dispatching subsystem.
    104113   */
    105114  RTEMS_INLINE_ROUTINE void _Thread_Dispatch_initialization( void )
     
    111120
    112121/**
    113  *  This routine halts multitasking and returns control to
    114  *  the "thread" (i.e. the BSP) which initially invoked the
    115  *  routine which initialized the system.
     122 * This routine halts multitasking and returns control to
     123 * the "thread" (i.e. the BSP) which initially invoked the
     124 * routine which initialized the system.
    116125 */
    117126
     
    141150
    142151/**
    143  *  This function returns true if the_thread is the currently executing
    144  *  thread, and false otherwise.
     152 * This function returns true if the_thread is the currently executing
     153 * thread, and false otherwise.
    145154 */
    146155
     
    153162
    154163/**
    155  *  This function returns true if the_thread is the heir
    156  *  thread, and false otherwise.
     164 * This function returns true if the_thread is the heir
     165 * thread, and false otherwise.
    157166 */
    158167
     
    165174
    166175/**
    167  *  This function returns true if the currently executing thread
    168  *  is also the heir thread, and false otherwise.
     176 * This function returns true if the currently executing thread
     177 * is also the heir thread, and false otherwise.
    169178 */
    170179
     
    175184
    176185/**
    177  *  This routine clears any blocking state for the_thread.  It performs
    178  *  any necessary scheduling operations including the selection of
    179  *  a new heir thread.
     186 * This routine clears any blocking state for the_thread.  It performs
     187 * any necessary scheduling operations including the selection of
     188 * a new heir thread.
    180189 */
    181190
     
    188197
    189198/**
    190  *  This routine resets the current context of the calling thread
    191  *  to that of its initial state.
     199 * This routine resets the current context of the calling thread
     200 * to that of its initial state.
    192201 */
    193202
     
    203212
    204213/**
    205  *  This function returns true if the floating point context of
    206  *  the_thread is currently loaded in the floating point unit, and
    207  *  false otherwise.
     214 * This function returns true if the floating point context of
     215 * the_thread is currently loaded in the floating point unit, and
     216 * false otherwise.
    208217 */
    209218
     
    218227
    219228/**
    220  *  This routine is invoked when the currently loaded floating
    221  *  point context is now longer associated with an active thread.
     229 * This routine is invoked when the currently loaded floating
     230 * point context is now longer associated with an active thread.
    222231 */
    223232
     
    230239
    231240/**
    232  *  This routine prevents dispatching.
     241 * This routine prevents dispatching.
    233242 */
    234243
     
    244253
    245254/**
    246  *  This routine allows dispatching to occur again.  If this is
    247  *  the outer most dispatching critical section, then a dispatching
    248  *  operation will be performed and, if necessary, control of the
    249  *  processor will be transferred to the heir thread.
     255 * This routine allows dispatching to occur again.  If this is
     256 * the outer most dispatching critical section, then a dispatching
     257 * operation will be performed and, if necessary, control of the
     258 * processor will be transferred to the heir thread.
    250259 */
    251260
     
    263272
    264273/**
    265  *  This routine allows dispatching to occur again.  However,
    266  *  no dispatching operation is performed even if this is the outer
    267  *  most dispatching critical section.
     274 * This routine allows dispatching to occur again.  However,
     275 * no dispatching operation is performed even if this is the outer
     276 * most dispatching critical section.
    268277 */
    269278
     
    275284
    276285/**
    277  *  This function returns true if dispatching is disabled, and false
    278  *  otherwise.
     286 * This function returns true if dispatching is disabled, and false
     287 * otherwise.
    279288 */
    280289
     
    285294
    286295/**
    287  *  This function returns true if dispatching is disabled, and false
    288  *  otherwise.
     296 * This function returns true if dispatching is disabled, and false
     297 * otherwise.
    289298 */
    290299
     
    295304
    296305/**
    297  *  This function returns true if the_thread is NULL and false otherwise.
     306 * This function returns true if the_thread is NULL and false otherwise.
    298307 */
    299308
     
    305314}
    306315
    307 /** @brief _Thread_Is_proxy_blocking
    308  *
    309  *  status which indicates that a proxy is blocking, and false otherwise.
     316/**
     317 * @brief Is proxy blocking.
     318 *
     319 * status which indicates that a proxy is blocking, and false otherwise.
    310320 */
    311321RTEMS_INLINE_ROUTINE bool _Thread_Is_proxy_blocking (
     
    317327
    318328/**
    319  *  This routine allocates an internal thread.
    320  */
    321  
     329 * This routine allocates an internal thread.
     330 */
     331
    322332RTEMS_INLINE_ROUTINE Thread_Control *_Thread_Internal_allocate( void )
    323333{
    324334  return (Thread_Control *) _Objects_Allocate( &_Thread_Internal_information );
    325335}
    326  
    327 /**
    328  *  This routine frees an internal thread.
    329  */
    330  
     336
     337/**
     338 * This routine frees an internal thread.
     339 */
     340
    331341RTEMS_INLINE_ROUTINE void _Thread_Internal_free (
    332342  Thread_Control *the_task
     
    337347
    338348/**
    339  *  This routine returns the C library re-enterant pointer.
    340  */
    341  
     349 * This routine returns the C library re-enterant pointer.
     350 */
     351
    342352RTEMS_INLINE_ROUTINE struct _reent **_Thread_Get_libc_reent( void )
    343353{
     
    346356
    347357/**
    348  *  This routine set the C library re-enterant pointer.
    349  */
    350  
     358 * This routine set the C library re-enterant pointer.
     359 */
     360
    351361RTEMS_INLINE_ROUTINE void _Thread_Set_libc_reent (
    352362  struct _reent **libc_reent
     
    357367
    358368/**
    359  *  This routine evaluates the current scheduling information for the
    360  *  system and determines if a context switch is required.  This
    361  *  is usually called after changing an execution mode such as preemptability
    362  *  for a thread.
    363  *
    364  *  @param[in] are_signals_pending specifies whether or not the API
    365  *             level signals are pending and a dispatch is needed.
     369 * This routine evaluates the current scheduling information for the
     370 * system and determines if a context switch is required.  This
     371 * is usually called after changing an execution mode such as preemptability
     372 * for a thread.
     373 *
     374 * @param[in] are_signals_pending specifies whether or not the API
     375 *            level signals are pending and a dispatch is needed.
    366376 */
    367377RTEMS_INLINE_ROUTINE bool _Thread_Evaluate_is_dispatch_needed(
     
    382392}
    383393
    384 /**@}*/
     394/** @}*/
    385395
    386396#endif
  • cpukit/score/inline/rtems/score/tod.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/tod.inl
     1/**
     2 * @file
    33 *
    4  *  This file contains the static inline implementation of the inlined routines
    5  *  from the Time of Day Handler.
     4 * @brief Inlined Routines from the Time of Day Handle
     5 *
     6 * This file contains the static inline implementation of the inlined routines
     7 * from the Time of Day Handler.
    68 */
    79
     
    2729
    2830/**
    29  *  @addtogroup ScoreTOD
    30  *  @{
     31 * @addtogroup ScoreTOD
     32 *
     33 * @{
    3134 */
    3235
    3336/**
    34  *  This routine deactivates updating of the current time of day.
     37 * This routine deactivates updating of the current time of day.
    3538 */
    3639
     
    4144
    4245/**
    43  *  This routine activates updating of the current time of day.
     46 * This routine activates updating of the current time of day.
    4447 */
    4548
     
    5053
    5154/**
    52  *  This routine returns a timeval based upon the internal timespec format TOD.
     55 * This routine returns a timeval based upon the internal timespec format TOD.
    5356 */
    5457
     
    6568}
    6669
    67 /**@}*/
     70/** @} */
    6871
    6972#endif
  • cpukit/score/inline/rtems/score/tqdata.inl

    r4f5740f r1f0d013  
    1 /** 
    2  *  @file  rtems/score/tqdata.inl
     1/**
     2 * @file
    33 *
    4  *  This file contains the static inline implementation of the inlined
    5  *  routines needed to support the Thread Queue Data.
     4 * @brief Inlined Routines Needed to Support the Thread Queue Data
     5 *
     6 * This file contains the static inline implementation of the inlined
     7 * routines needed to support the Thread Queue Data.
    68 */
    79
     
    2325
    2426/**
    25  *  @addtogroup ScoreThreadQ
    26  *  @{
     27 * @addtogroup ScoreThreadQ
     28 *
     29 * @{
    2730 */
    2831
    2932/**
    30  *  This function returns the index of the priority chain on which
    31  *  a thread of the_priority should be placed.
     33 * This function returns the index of the priority chain on which
     34 * a thread of the_priority should be placed.
    3235 */
    3336
     
    4043
    4144/**
    42  *  This function returns true if the_priority indicates that the
    43  *  enqueue search should start at the front of this priority
    44  *  group chain, and false if the search should start at the rear.
     45 * This function returns true if the_priority indicates that the
     46 * enqueue search should start at the front of this priority
     47 * group chain, and false if the search should start at the rear.
    4548 */
    4649
     
    5356
    5457/**
    55  *  This routine is invoked to indicate that the specified thread queue is
    56  *  entering a critical section.
     58 * This routine is invoked to indicate that the specified thread queue is
     59 * entering a critical section.
    5760 */
    58  
     61
    5962RTEMS_INLINE_ROUTINE void _Thread_queue_Enter_critical_section (
    6063  Thread_queue_Control *the_thread_queue
     
    6467}
    6568
    66 /**
    67  *  @}
    68  */
     69/** @} */
    6970
    7071#endif
Note: See TracChangeset for help on using the changeset viewer.