Changeset 4b72da4 in rtems


Ignore:
Timestamp:
Jun 17, 2011, 2:55:27 PM (9 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
d8cd045c
Parents:
3203e09
Message:

2011-06-17 Joel Sherrill <joel.sherrill@…>

  • libcsupport/include/rtems/malloc.h, libmisc/stackchk/stackchk.h, posix/include/rtems/posix/time.h, rtems/include/rtems/rtems/object.h, score/include/rtems/score/apiext.h, score/include/rtems/score/interr.h, score/include/rtems/score/mpci.h, score/include/rtems/score/objectmp.h, score/include/rtems/score/thread.h, score/include/rtems/score/threadmp.h, score/include/rtems/score/threadq.h, score/include/rtems/score/timespec.h, score/include/rtems/score/timestamp.h, score/include/rtems/score/timestamp64.h, score/include/rtems/score/tod.h, score/include/rtems/score/watchdog.h, score/include/rtems/score/wkspace.h: Make @brief formatting more consistent.
  • score/include/rtems/score/rbtree.h: Also reformat.
Location:
cpukit
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    r3203e09 r4b72da4  
     12011-06-17      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * libcsupport/include/rtems/malloc.h, libmisc/stackchk/stackchk.h,
     4        posix/include/rtems/posix/time.h, rtems/include/rtems/rtems/object.h,
     5        score/include/rtems/score/apiext.h,
     6        score/include/rtems/score/interr.h, score/include/rtems/score/mpci.h,
     7        score/include/rtems/score/objectmp.h,
     8        score/include/rtems/score/thread.h,
     9        score/include/rtems/score/threadmp.h,
     10        score/include/rtems/score/threadq.h,
     11        score/include/rtems/score/timespec.h,
     12        score/include/rtems/score/timestamp.h,
     13        score/include/rtems/score/timestamp64.h,
     14        score/include/rtems/score/tod.h,
     15        score/include/rtems/score/watchdog.h,
     16        score/include/rtems/score/wkspace.h: Make @brief formatting more
     17        consistent.
     18        * score/include/rtems/score/rbtree.h: Also reformat.
     19
    1202011-06-17      Joel Sherrill <joel.sherrill@oarcorp.com>
    221
  • cpukit/libcsupport/include/rtems/malloc.h

    r3203e09 r4b72da4  
    66 *  RTEMS Malloc Extensions
    77 *
    8  *  COPYRIGHT (c) 1989-2007.
     8 *  COPYRIGHT (c) 1989-2009.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    7373extern rtems_malloc_dirtier_t rtems_malloc_dirty_helper;
    7474
    75 /** @brief Dirty memory function
     75/**
     76 *  @brief Dirty memory function
    7677 *
    7778 *  This method fills the specified area with a non-zero pattern
     
    8485);
    8586
    86 /** @brief Print Malloc Statistic Usage Report
     87/**
     88 *  @brief Print Malloc Statistic Usage Report
    8789 *
    8890 *  This method fills in the called provided malloc statistics area.
     
    9496);
    9597
    96 /** @brief Print Malloc Statistic Usage Report
     98/**
     99 *  @brief Print Malloc Statistic Usage Report
    97100 *
    98101 *  This method prints a malloc statistics report.
     
    102105void malloc_report_statistics(void);
    103106
    104 /** @brief Print Malloc Statistic Usage Report
     107/**
     108 *  @brief Print Malloc Statistic Usage Report
    105109 *
    106110 *  This method prints a malloc statistics report.
     
    117121
    118122/**
     123 *  @brief RTEMS variation on Aligned Memory Allocation
    119124 *
    120125 *  This method is a help memalign implementation which does all
  • cpukit/libmisc/stackchk/stackchk.h

    r3203e09 r4b72da4  
    66
    77/*
    8  *  COPYRIGHT (c) 1989-2007.
     8 *  COPYRIGHT (c) 1989-2009.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    2828#endif
    2929
    30 /** @brief Has Current Task Blown Its Stack
     30/**
     31 *  @brief Has Current Task Blown Its Stack
    3132 *
    3233 *  This method is used to determine if the current stack pointer
     
    3940bool rtems_stack_checker_is_blown( void );
    4041
    41 /** @brief Print Stack Usage Report
     42/**
     43 *  @brief Print Stack Usage Report
    4244 *
    4345 *  This method prints a stack usage report for the curently executing
     
    4850void rtems_stack_checker_report_usage( void );
    4951
    50 /** @brief Print Stack Usage Report
     52/**
     53 *  @brief Print Stack Usage Report
    5154 *
    5255 *  This method prints a stack usage report for the curently executing
     
    6972 *************************************************************/
    7073
    71 /** @brief Stack Checker Task Create Extension
     74/**
     75 *  @brief Stack Checker Task Create Extension
    7276 *
    7377 * This method is the task create extension for the stack checker.
     
    8488);
    8589
    86 /** @brief Stack Checker Task Begin Extension
     90/**
     91 *  @brief Stack Checker Task Begin Extension
    8792 *
    8893 * This method is the task begin extension for the stack checker.
     
    96101);
    97102
    98 /** @brief Stack Checker Task Context Switch Extension
     103/**
     104 *  @brief Stack Checker Task Context Switch Extension
    99105 *
    100106 * This method is the task context switch extension for the stack checker.
     
    111117);
    112118
    113 /** @brief Stack Checker Extension Set Definition
     119/**
     120 *  @brief Stack Checker Extension Set Definition
    114121 *
    115122 *  This macro defines the user extension handler set for the stack
  • cpukit/posix/include/rtems/posix/time.h

    r3203e09 r4b72da4  
    44
    55/*
    6  *  COPYRIGHT (c) 1989-2008.
     6 *  COPYRIGHT (c) 1989-2009.
    77 *  On-Line Applications Research Corporation (OAR).
    88 *
     
    2020#include <rtems/score/watchdog.h>
    2121
    22 /** @brief Absolute Timeout Conversion Results
     22/**
     23 *  @brief Absolute Timeout Conversion Results
    2324 *
    2425 *  This enumeration defines the possible results of converting
  • cpukit/rtems/include/rtems/rtems/object.h

    r3203e09 r4b72da4  
    33 */
    44
    5 /*  COPYRIGHT (c) 1989-2008.
     5/*  COPYRIGHT (c) 1989-2009.
    66 *  On-Line Applications Research Corporation (OAR).
    77 *
     
    8989  _Objects_Build_name( _C1, _C2, _C3, _C4 )
    9090
    91 /** @brief Obtain name of object
     91/**
     92 *  @brief Obtain name of object
    9293 *
    9394 *  This directive returns the name associated with the specified
  • cpukit/score/include/rtems/score/apiext.h

    r3203e09 r4b72da4  
    9292SCORE_EXTERN Chain_Control _API_extensions_List;
    9393
    94 /** @brief Initialize the API Extensions Handler
     94/**
     95 * @brief Initialize the API Extensions Handler
    9596 *
    9697 *  This routine initializes the API extension handler.
     
    9899void _API_extensions_Initialization( void );
    99100
    100 /** @brief Add Extension Set to the Active Set
     101/**
     102 * @brief Add Extension Set to the Active Set
    101103 *
    102104 *  This routine adds an extension to the active set of API extensions.
     
    109111
    110112#if defined(FUNCTIONALITY_NOT_CURRENTLY_USED_BY_ANY_API)
    111   /** @brief Execute all Pre-Driver Extensions
     113  /**
     114   * @brief Execute all Pre-Driver Extensions
    112115   *
    113116   *  This routine executes all of the predriver callouts.
     
    116119#endif
    117120
    118 /** @brief Execute all Post-Driver Extensions
     121/**
     122 * @brief Execute all Post-Driver Extensions
    119123 *
    120124 *  This routine executes all of the postdriver callouts.
     
    122126void _API_extensions_Run_postdriver( void );
    123127
    124 /** @brief Execute all Post Context Switch Extensions
     128/**
     129 * @brief Execute all Post Context Switch Extensions
    125130 *
    126131 *  This routine executes all of the post context switch callouts.
  • cpukit/score/include/rtems/score/interr.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2007.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    9595SCORE_EXTERN Internal_errors_Information _Internal_errors_What_happened;
    9696
    97 /** @brief  Internal error Occurred
     97/**
     98 * @brief  Internal error Occurred
    9899 *
    99100 *  This routine is invoked when the application or the executive itself
  • cpukit/score/include/rtems/score/mpci.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2008.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    180180SCORE_EXTERN MPCI_Control *_MPCI_table;
    181181
    182 /** @brief Pointer to MP Thread Control Block
     182/**
     183 *  @brief Pointer to MP Thread Control Block
    183184 *
    184185 *  The following is used to determine when the multiprocessing receive
  • cpukit/score/include/rtems/score/objectmp.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2006.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    4747}   Objects_MP_Control;
    4848
    49 /** @brief  Objects MP Handler initialization
     49/**
     50 *  @brief  Objects MP Handler initialization
    5051 *
    5152 *  This routine intializes the inactive global object chain
     
    5455void _Objects_MP_Handler_initialization(void);
    5556
    56 /** @brief  Objects MP Handler Early initialization
     57/**
     58 *  @brief  Objects MP Handler Early initialization
    5759 *
    5860 *  This routine intializes the global object node number
     
    6163void _Objects_MP_Handler_early_initialization(void);
    6264
    63 /** @brief Objects MP Open
     65/**
     66 *  @brief Objects MP Open
    6467 *
    6568 *  This routine place the specified global object in the
     
    8285);
    8386
    84 /** @brief  Objects MP Allocate and open
     87/**
     88 *  @brief  Objects MP Allocate and open
    8589 *
    8690 *  This routine allocates a global object control block
     
    106110);
    107111
    108 /** @brief  Objects MP Close
     112/**
     113 *  @brief  Objects MP Close
    109114 *
    110115 *  This routine removes a global object from the specified
     
    116121);
    117122
    118 /** @brief  Objects MP Global name search
     123/**
     124 *  @brief  Objects MP Global name search
    119125 *
    120126 *  This routine looks for the object with the_name in the global
     
    139145);
    140146
    141 /** @brief  Objects MP Is remote
     147/**
     148 *  @brief  Objects MP Is remote
    142149 *
    143150 *  This function searches the Global Object Table managed
  • cpukit/score/include/rtems/score/rbtree.h

    r3203e09 r4b72da4  
    1 
    21/**
    32 *  @file  rtems/score/rbtree.h
     
    3736#include <rtems/score/address.h>
    3837
    39   /**
    40    *  @typedef RBTree_Node
    41    *
    42    *  This type definition promotes the name for the RBTree Node used by
    43    *  all RTEMS code.  It is a separate type definition because a forward
    44    *  reference is required to define it.  See @ref RBTree_Node_struct for
    45    *  detailed information.
    46    */
    47   typedef struct RBTree_Node_struct RBTree_Node;
    48 
    49   /**
    50    * This enum type defines the colors available for the RBTree Nodes
    51    */
    52   typedef enum {
    53     RBT_BLACK,
    54     RBT_RED
    55   } RBTree_Color;
    56 
    57   /**
    58    *  @struct RBTree_Node_struct
    59    *
    60    *  This is used to manage each element (node) which is placed
    61    *  on a RBT.
    62    *
    63    *  @note Typically, a more complicated structure will use the
    64    *        rbtree package.  The more complicated structure will
    65    *        include a rbtree node as the first element in its
    66    *        control structure.  It will then call the rbtree package
    67    *        with a pointer to that node element.  The node pointer
    68    *        and the higher level structure start at the same address
    69    *        so the user can cast the pointers back and forth.
    70    *
    71    */
    72   struct RBTree_Node_struct {
    73     /** This points to the node's parent */
    74     RBTree_Node *parent;
    75     /** child[0] points to the left child, child[1] points to the right child */
    76     RBTree_Node *child[2];
    77     /** This is the integer value stored by this node, used for sorting */
    78     unsigned int value;
    79     /** The color of the node. Either red or black */
    80     RBTree_Color color;
    81   };
    82 
    83   /**
    84    * @brief macro to return the structure containing the @a node.
    85    *
    86    * This macro returns a pointer of type @a container_type that points
    87    * to the structure containing @a node, where @a node_field_name is the
    88    * field name of the RBTree_Node structure in @a container_type.
    89    *
    90    */
    91 
     38/**
     39 *  @typedef RBTree_Node
     40 *
     41 *  This type definition promotes the name for the RBTree Node used by
     42 *  all RTEMS code.  It is a separate type definition because a forward
     43 *  reference is required to define it.  See @ref RBTree_Node_struct for
     44 *  detailed information.
     45 */
     46typedef struct RBTree_Node_struct RBTree_Node;
     47
     48/**
     49 * This enum type defines the colors available for the RBTree Nodes
     50 */
     51typedef enum {
     52  RBT_BLACK,
     53  RBT_RED
     54} RBTree_Color;
     55
     56/**
     57 *  @struct RBTree_Node_struct
     58 *
     59 *  This is used to manage each element (node) which is placed
     60 *  on a RBT.
     61 *
     62 *  @note Typically, a more complicated structure will use the
     63 *        rbtree package.  The more complicated structure will
     64 *        include a rbtree node as the first element in its
     65 *        control structure.  It will then call the rbtree package
     66 *        with a pointer to that node element.  The node pointer
     67 *        and the higher level structure start at the same address
     68 *        so the user can cast the pointers back and forth.
     69 *
     70 */
     71struct RBTree_Node_struct {
     72  /** This points to the node's parent */
     73  RBTree_Node *parent;
     74  /** child[0] points to the left child, child[1] points to the right child */
     75  RBTree_Node *child[2];
     76  /** This is the integer value stored by this node, used for sorting */
     77  unsigned int value;
     78  /** The color of the node. Either red or black */
     79  RBTree_Color color;
     80};
     81
     82/**
     83 * @brief macro to return the structure containing the @a node.
     84 *
     85 * This macro returns a pointer of type @a container_type that points
     86 * to the structure containing @a node, where @a node_field_name is the
     87 * field name of the RBTree_Node structure in @a container_type.
     88 *
     89 */
    9290#define _RBTree_Container_of(node,container_type, node_field_name) \
    93   ((container_type*) \
    94    ((size_t)node - ((size_t)(&((container_type *)0)->node_field_name))))
    95 
    96 
    97   typedef enum {
    98     RBT_LEFT=0,
    99     RBT_RIGHT=1
    100   } RBTree_Direction;
    101 
    102   /**
    103    *  @struct RBTree_Control
    104    *
    105    * This is used to manage a RBT.  A rbtree consists of a tree of zero or more
    106    * nodes.
    107    *
    108    * @note This implementation does not require special checks for
    109    *   manipulating the root element of the RBT.
    110    *   To accomplish this the @a RBTree_Control structure can be overlaid
    111    *   with a @ref RBTree_Node structure to act as a "dummy root",
    112    *   which has a NULL parent and its left child is the root.
    113    */
    114 
    115   /* the RBTree_Control is actually part of the RBTree structure as an
    116    * RBTree_Node. The mapping of fields from RBTree_Control to RBTree_Node are:
    117    *   permanent_null == parent
    118    *   root == left
    119    *   first[0] == right
    120    */
    121   typedef struct {
    122     /** This points to a NULL. Useful for finding the root. */
    123     RBTree_Node *permanent_null;
    124     /** This points to the root node of the RBT. */
    125     RBTree_Node *root;
    126     /** This points to the min and max nodes of this RBT. */
    127     RBTree_Node *first[2];
    128   } RBTree_Control;
    129 
    130   /**
    131    *  @brief RBTree initializer for an empty rbtree with designator @a name.
    132    */
     91((container_type*) \
     92 ((size_t)node - ((size_t)(&((container_type *)0)->node_field_name))))
     93
     94/**
     95 *  This type indicates the direction.
     96 */
     97typedef enum {
     98  RBT_LEFT=0,
     99  RBT_RIGHT=1
     100} RBTree_Direction;
     101
     102/**
     103 *  @struct RBTree_Control
     104 *
     105 * This is used to manage a RBT.  A rbtree consists of a tree of zero or more
     106 * nodes.
     107 *
     108 * @note This implementation does not require special checks for
     109 *   manipulating the root element of the RBT.
     110 *   To accomplish this the @a RBTree_Control structure can be overlaid
     111 *   with a @ref RBTree_Node structure to act as a "dummy root",
     112 *   which has a NULL parent and its left child is the root.
     113 */
     114
     115/* the RBTree_Control is actually part of the RBTree structure as an
     116 * RBTree_Node. The mapping of fields from RBTree_Control to RBTree_Node are:
     117 *   permanent_null == parent
     118 *   root == left
     119 *   first[0] == right
     120 */
     121typedef struct {
     122  /** This points to a NULL. Useful for finding the root. */
     123  RBTree_Node *permanent_null;
     124  /** This points to the root node of the RBT. */
     125  RBTree_Node *root;
     126  /** This points to the min and max nodes of this RBT. */
     127  RBTree_Node *first[2];
     128} RBTree_Control;
     129
     130/**
     131 *  @brief RBTree initializer for an empty rbtree with designator @a name.
     132 */
    133133#define RBTREE_INITIALIZER_EMPTY(name) \
    134   { \
    135     .permanent_null = NULL, \
    136     .root = NULL, \
    137     .first[0] = NULL, \
    138     .first[1] = NULL, \
    139   }
    140 
    141   /**
    142    *  @brief RBTree definition for an empty rbtree with designator @a name.
    143    */
     134{ \
     135  .permanent_null = NULL, \
     136  .root = NULL, \
     137  .first[0] = NULL, \
     138  .first[1] = NULL, \
     139}
     140
     141/**
     142 *  @brief RBTree definition for an empty rbtree with designator @a name.
     143 */
    144144#define RBTREE_DEFINE_EMPTY(name) \
    145   RBTree_Control name = RBTREE_INITIALIZER_EMPTY(name)
    146 
    147   /**
    148    *  @brief RBTree_Node initializer for an empty node with designator @a name.
    149    */
     145RBTree_Control name = RBTREE_INITIALIZER_EMPTY(name)
     146
     147/**
     148 *  @brief RBTree_Node initializer for an empty node with designator @a name.
     149 */
    150150#define RBTREE_NODE_INITIALIZER_EMPTY(name) \
    151   { \
    152     .parent = NULL, \
    153     .child[0] = NULL, \
    154     .child[1] = NULL, \
    155     .value = -1, \
    156     RBT_RED \
    157   }
    158 
    159   /**
    160    *  @brief RBTree definition for an empty rbtree with designator @a name.
    161    */
     151{ \
     152  .parent = NULL, \
     153  .child[0] = NULL, \
     154  .child[1] = NULL, \
     155  .value = -1, \
     156  RBT_RED \
     157}
     158
     159/**
     160 *  @brief RBTree definition for an empty rbtree with designator @a name.
     161 */
    162162#define RBTREE_NODE_DEFINE_EMPTY(name) \
    163   RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name)
    164 
    165 
    166 
    167 
    168   /**
    169    *  @brief Initialize a RBTree Header
    170    *
    171    *  This routine initializes @a the_rbtree structure to manage the
    172    *  contiguous array of @a number_nodes nodes which starts at
    173    *  @a starting_address.  Each node is of @a node_size bytes.
    174    */
    175   void _RBTree_Initialize(
    176       RBTree_Control *the_rbtree,
    177       void          *starting_address,
    178       size_t         number_nodes,
    179       size_t         node_size
    180       );
    181 
    182   /**
    183    *  @brief Obtain the min or max node of a rbtree
    184    *
    185    *  This function removes the min or max node from @a the_rbtree and returns
    186    *  a pointer to that node.  If @a the_rbtree is empty, then NULL is returned.
    187    *  @a dir specifies whether to return the min (0) or max (1).
    188    *
    189    *  @return This method returns a pointer to a node.  If a node was removed,
    190    *          then a pointer to that node is returned.  If @a the_rbtree was
    191    *          empty, then NULL is returned.
    192    *
    193    *  @note It disables interrupts to ensure the atomicity of the get operation.
    194    */
    195   RBTree_Node *_RBTree_Get(
    196       RBTree_Control *the_rbtree,
    197       RBTree_Direction dir
    198       );
    199 
    200   /**
    201    *  @brief Check the min or max node on a rbtree
    202    *
    203    *  This function returns a pointer to the min or max node of @a the_rbtree.
    204    *  If @a the_rbtree is empty, then NULL is returned. @a dir specifies
    205    *  whether to return the min (0) or max (1).
    206    *
    207    *  @return This method returns a pointer to a node.
    208    *          If @a the_rbtree was empty, then NULL is returned.
    209    *
    210    *  @note It disables interrupts to ensure the atomicity of the get operation.
    211    */
    212   RBTree_Node *_RBTree_Peek(
    213       RBTree_Control *the_rbtree,
    214       RBTree_Direction dir
    215       );
    216 
    217   /** @brief Find the node with given value in the tree
    218    *
    219    *  This function returns a pointer to the node with value equal to @a value
    220    *  if it exists in the Red-Black Tree @a the_rbtree, and NULL if not.
    221    */
    222   RBTree_Node *_RBTree_Find(
    223       RBTree_Control *the_rbtree,
    224       unsigned int value
    225       );
    226 
    227   /** @brief Find the control structure of the tree containing the given node
    228    *
    229    *  This function returns a pointer to the control structure of the tree
    230    *  containing @a the_node, if it exists, and NULL if not.
    231    */
    232   RBTree_Control *_RBTree_Find_header(
    233       RBTree_Node *the_node
    234       );
    235 
    236   /** @brief Insert a Node (unprotected)
    237    *
    238    *  This routine inserts @a the_node on the Red-Black Tree @a the_rbtree.
    239    *
    240    *  @retval 0 Successfully inserted.
    241    *  @retval -1 NULL @a the_node.
    242    *  @retval RBTree_Node* if one with equal value to @a the_node->value exists
    243    *          in @a the_rbtree.
    244    *
    245    *  @note It does NOT disable interrupts to ensure the atomicity
    246    *        of the extract operation.
    247    */
    248   RBTree_Node *_RBTree_Insert_unprotected(
    249       RBTree_Control *the_rbtree,
    250       RBTree_Node *the_node
    251   );
    252 
    253   /**
    254    *  @brief Insert a node on a rbtree
    255    *
    256    *  This routine inserts @a the_node on the tree @a the_rbtree.
    257    *
    258    *  @note It disables interrupts to ensure the atomicity
    259    *  of the extract operation.
    260    */
    261   void _RBTree_Insert(
    262       RBTree_Control *the_rbtree,
    263       RBTree_Node *the_node
    264       );
    265 
    266 
    267   /** @brief Extract a Node (unprotected)
    268    *
    269    *  This routine extracts (removes) @a the_node from @a the_rbtree.
    270    *
    271    *  @note It does NOT disable interrupts to ensure the atomicity
    272    *        of the extract operation.
    273    */
    274 
    275   void _RBTree_Extract_unprotected(
    276       RBTree_Control *the_rbtree,
    277       RBTree_Node *the_node
    278   );
    279 
    280 
    281   /**
    282    *  @brief Delete a node from the rbtree
    283    *
    284    *  This routine deletes @a the_node from @a the_rbtree.
    285    *
    286    *  @note It disables interrupts to ensure the atomicity of the
    287    *  append operation.
    288    */
    289   void _RBTree_Extract(
    290       RBTree_Control *the_rbtree,
    291       RBTree_Node    *the_node
    292       );
     163RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name)
     164
     165/**
     166 *  @brief Initialize a RBTree Header
     167 *
     168 *  This routine initializes @a the_rbtree structure to manage the
     169 *  contiguous array of @a number_nodes nodes which starts at
     170 *  @a starting_address.  Each node is of @a node_size bytes.
     171 */
     172void _RBTree_Initialize(
     173  RBTree_Control *the_rbtree,
     174  void          *starting_address,
     175  size_t         number_nodes,
     176  size_t         node_size
     177);
     178
     179/**
     180 *  @brief Obtain the min or max node of a rbtree
     181 *
     182 *  This function removes the min or max node from @a the_rbtree and returns
     183 *  a pointer to that node.  If @a the_rbtree is empty, then NULL is returned.
     184 *  @a dir specifies whether to return the min (0) or max (1).
     185 *
     186 *  @return This method returns a pointer to a node.  If a node was removed,
     187 *          then a pointer to that node is returned.  If @a the_rbtree was
     188 *          empty, then NULL is returned.
     189 *
     190 *  @note It disables interrupts to ensure the atomicity of the get operation.
     191 */
     192RBTree_Node *_RBTree_Get(
     193  RBTree_Control *the_rbtree,
     194  RBTree_Direction dir
     195);
     196
     197/**
     198 *  @brief Check the min or max node on a rbtree
     199 *
     200 *  This function returns a pointer to the min or max node of @a the_rbtree.
     201 *  If @a the_rbtree is empty, then NULL is returned. @a dir specifies
     202 *  whether to return the min (0) or max (1).
     203 *
     204 *  @return This method returns a pointer to a node.
     205 *          If @a the_rbtree was empty, then NULL is returned.
     206 *
     207 *  @note It disables interrupts to ensure the atomicity of the get operation.
     208 */
     209RBTree_Node *_RBTree_Peek(
     210  RBTree_Control *the_rbtree,
     211  RBTree_Direction dir
     212);
     213
     214/**
     215 * @brief Find the node with given value in the tree
     216 *
     217 *  This function returns a pointer to the node with value equal to @a value
     218 *  if it exists in the Red-Black Tree @a the_rbtree, and NULL if not.
     219 */
     220RBTree_Node *_RBTree_Find(
     221  RBTree_Control *the_rbtree,
     222  unsigned int value
     223);
     224
     225/**
     226 * @brief Find the control structure of the tree containing the given node
     227 *
     228 *  This function returns a pointer to the control structure of the tree
     229 *  containing @a the_node, if it exists, and NULL if not.
     230 */
     231RBTree_Control *_RBTree_Find_header(
     232  RBTree_Node *the_node
     233);
     234
     235/**
     236 * @brief Insert a Node (unprotected)
     237 *
     238 *  This routine inserts @a the_node on the Red-Black Tree @a the_rbtree.
     239 *
     240 *  @retval 0 Successfully inserted.
     241 *  @retval -1 NULL @a the_node.
     242 *  @retval RBTree_Node* if one with equal value to @a the_node->value exists
     243 *          in @a the_rbtree.
     244 *
     245 *  @note It does NOT disable interrupts to ensure the atomicity
     246 *        of the extract operation.
     247 */
     248RBTree_Node *_RBTree_Insert_unprotected(
     249  RBTree_Control *the_rbtree,
     250  RBTree_Node *the_node
     251);
     252
     253/**
     254 *  @brief Insert a node on a rbtree
     255 *
     256 *  This routine inserts @a the_node on the tree @a the_rbtree.
     257 *
     258 *  @note It disables interrupts to ensure the atomicity
     259 *  of the extract operation.
     260 */
     261void _RBTree_Insert(
     262  RBTree_Control *the_rbtree,
     263  RBTree_Node *the_node
     264);
     265
     266
     267/**
     268 * @brief Extract a Node (unprotected)
     269 *
     270 *  This routine extracts (removes) @a the_node from @a the_rbtree.
     271 *
     272 *  @note It does NOT disable interrupts to ensure the atomicity
     273 *        of the extract operation.
     274 */
     275void _RBTree_Extract_unprotected(
     276  RBTree_Control *the_rbtree,
     277  RBTree_Node *the_node
     278);
     279
     280/**
     281 *  @brief Delete a node from the rbtree
     282 *
     283 *  This routine deletes @a the_node from @a the_rbtree.
     284 *
     285 *  @note It disables interrupts to ensure the atomicity of the
     286 *  append operation.
     287 */
     288void _RBTree_Extract(
     289  RBTree_Control *the_rbtree,
     290  RBTree_Node    *the_node
     291);
    293292
    294293#ifndef __RTEMS_APPLICATION__
  • cpukit/score/include/rtems/score/thread.h

    r3203e09 r4b72da4  
    183183typedef void (*Thread_CPU_budget_algorithm_callout )( Thread_Control * );
    184184
    185 /** @brief Per Task Variable Manager Structure Forward Reference
     185/**
     186 *  @brief Per Task Variable Manager Structure Forward Reference
    186187 *
    187188 *  Forward reference to the per task variable structure.
     
    189190struct rtems_task_variable_tt;
    190191
    191 /** @brief Per Task Variable Manager Structure
     192/**
     193 *  @brief Per Task Variable Manager Structure
    192194 *
    193195 *  This is the internal structure used to manager per Task Variables.
     
    271273} Thread_Wait_information_Object_argument_type;
    272274
    273 /** @brief Thread Blocking Management Information
     275/**
     276 *  @brief Thread Blocking Management Information
    274277 *
    275278 *  This contains the information required to manage a thread while it is
     
    789792#if defined(RTEMS_SMP)
    790793
    791   /** @brief _Thread_Dispatch_initialization
     794  /**
     795   *  @brief _Thread_Dispatch_initialization
    792796   *
    793797   *  This routine initializes the thread dispatching subsystem.
     
    795799  void _Thread_Dispatch_initialization(void);
    796800
    797   /** @brief _Thread_Dispatch_in_critical_section
     801  /**
     802   *  @brief _Thread_Dispatch_in_critical_section
    798803   *
    799804   * This routine returns true if thread dispatch indicates
     
    802807  bool _Thread_Dispatch_in_critical_section(void);
    803808
    804   /** @brief _Thread_Dispatch_get_disable_level
     809  /**
     810   *  @brief _Thread_Dispatch_get_disable_level
    805811   *
    806812   * This routine returns value of the the thread dispatch level.
     
    808814  uint32_t _Thread_Dispatch_get_disable_level(void);
    809815
    810   /** @brief _Thread_Dispatch_set_disable_level
     816  /**
     817   *  @brief _Thread_Dispatch_set_disable_level
    811818   *
    812819   * This routine sets thread dispatch level to the
     
    815822  uint32_t _Thread_Dispatch_set_disable_level(uint32_t value);
    816823
    817   /** @brief _Thread_Dispatch_increment_disable_level
     824  /**
     825   *  @brief _Thread_Dispatch_increment_disable_level
    818826   *
    819827   * This rountine increments the thread dispatch level
     
    821829  uint32_t _Thread_Dispatch_increment_disable_level(void);
    822830
    823   /** @brief _Thread_Dispatch_decrement_disable_level
     831  /**
     832   *  @brief _Thread_Dispatch_decrement_disable_level
    824833   *
    825834   * This routine decrements the thread dispatch level.
  • cpukit/score/include/rtems/score/threadmp.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2006.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    3434#endif
    3535
    36 /** @brief _Thread_MP_Handler_initialization
     36/**
     37 *  @brief _Thread_MP_Handler_initialization
    3738 *
    3839 *  This routine initializes the multiprocessing portion of the Thread Handler.
     
    4243);
    4344
    44 /** @brief _Thread_MP_Allocate_proxy
     45/**
     46 *  @brief _Thread_MP_Allocate_proxy
    4547 *
    4648 *  This  allocates a proxy control block from
     
    5456);
    5557
    56 /** @brief _Thread_MP_Find_proxy
     58/**
     59 *  @brief _Thread_MP_Find_proxy
    5760 *
    5861 *  This function removes the proxy control block for the specified
     
    6366);
    6467
    65 /** @brief Active Proxy Set
     68/**
     69 *  @brief Active Proxy Set
    6670 *
    6771 * The following chain is used to manage the active set proxies.
     
    6973SCORE_EXTERN Chain_Control _Thread_MP_Active_proxies;
    7074
    71 /** @brief Inactive Proxy Set
     75/**
     76 *  @brief Inactive Proxy Set
    7277 *
    7378 * The following chain is used to manage the inactive set of proxies.
  • cpukit/score/include/rtems/score/threadq.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2008.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    6161             );
    6262
    63 /** @brief  Thread queue Dequeue
     63/**
     64 * @brief  Thread queue Dequeue
    6465 *
    6566 *  This function returns a pointer to a thread waiting on
     
    7273);
    7374
    74 /** @brief  Thread queue Enqueue Wrapper
     75/**
     76 * @brief  Thread queue Enqueue Wrapper
    7577 *
    7678 *  This routine enqueues the currently executing thread on
     
    8486
    8587
    86 /** @brief  Thread queue Enqueue
     88/**
     89 * @brief  Thread queue Enqueue
    8790 *
    8891 *  This routine enqueues the currently executing thread on
     
    109112);
    110113
    111 /** @brief  Thread queue Extract
     114/**
     115 * @brief  Thread queue Extract
    112116 *
    113117 *  This routine removes the_thread from the_thread_queue
     
    119123);
    120124
    121 /** @brief  Thread queue Extract with proxy
     125/**
     126 * @brief  Thread queue Extract with proxy
    122127 *
    123128 *  This routine extracts the_thread from the_thread_queue
     
    129134);
    130135
    131 /** @brief  Thread queue First
     136/**
     137 * @brief  Thread queue First
    132138 *
    133139 *  This function returns a pointer to the "first" thread
     
    139145);
    140146
    141 /** @brief  Thread queue Flush
     147/**
     148 * @brief  Thread queue Flush
    142149 *
    143150 *  This routine unblocks all threads blocked on the_thread_queue
     
    150157);
    151158
    152 /** @brief  Thread queue Initialize
     159/**
     160 * @brief  Thread queue Initialize
    153161 *
    154162 *  This routine initializes the_thread_queue based on the
     
    163171);
    164172
    165 /** @brief  Thread queue Dequeue priority
     173/**
     174 * @brief  Thread queue Dequeue priority
    166175 *
    167176 *  This function returns a pointer to the highest priority
     
    173182);
    174183
    175 /** @brief  Thread queue Enqueue priority
     184/**
     185 * @brief  Thread queue Enqueue priority
    176186 *
    177187 *  This routine enqueues the currently executing thread on
     
    185195);
    186196
    187 /** @brief  Thread queue Extract priority Helper
     197/**
     198 * @brief  Thread queue Extract priority Helper
    188199 *
    189200 *  This routine removes the_thread from the_thread_queue
     
    206217
    207218
    208 /** @brief  Thread queue First priority
     219/**
     220 * @brief  Thread queue First priority
    209221 *
    210222 *  This function returns a pointer to the "first" thread
     
    216228);
    217229
    218 /** @brief  Thread queue Dequeue FIFO
     230/**
     231 * @brief  Thread queue Dequeue FIFO
    219232 *
    220233 *  This function returns a pointer to the thread which has
     
    226239);
    227240
    228 /** @brief  Thread queue Enqueue FIFO
     241/**
     242 * @brief  Thread queue Enqueue FIFO
    229243 *
    230244 *  This routine enqueues the currently executing thread on
     
    238252);
    239253
    240 /** @brief  Thread queue Extract FIFO
     254/**
     255 * @brief  Thread queue Extract FIFO
    241256 *
    242257 *  This routine removes the_thread from the_thread_queue
     
    248263);
    249264
    250 /** @brief  Thread queue First FIFO
     265/**
     266 * @brief  Thread queue First FIFO
    251267 *
    252268 *  This function returns a pointer to the "first" thread
     
    258274);
    259275
    260 /** @brief  Thread queue timeout
     276/**
     277 * @brief  Thread queue timeout
    261278 *
    262279 *  This routine is invoked when a task's request has not
  • cpukit/score/include/rtems/score/timespec.h

    r3203e09 r4b72da4  
    66
    77/*
    8  *  COPYRIGHT (c) 1989-2008.
     8 *  COPYRIGHT (c) 1989-2009.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    3535#endif
    3636
    37 /** @brief Set Timespec to Seconds Nanosecond
     37/**
     38 * @brief Set Timespec to Seconds Nanosecond
    3839 *
    3940 *  This method sets the timespec to the specified seconds and nanoseconds
     
    5051        } while (0)
    5152
    52 /** @brief Zero Timespec
     53/**
     54 * @brief Zero Timespec
    5355 *
    5456 *  This method sets the timespec to zero.
     
    6365        } while (0)
    6466
    65 /** @brief Get Seconds Portion of Timespec
     67/**
     68 * @brief Get Seconds Portion of Timespec
    6669 *
    6770 *  This method returns the seconds portion of the specified timespec
     
    7477        ((_time)->tv_sec)
    7578
    76 /** @brief Get Nanoseconds Portion of Timespec
     79/**
     80 * @brief Get Nanoseconds Portion of Timespec
    7781 *
    7882 *  This method returns the nanoseconds portion of the specified timespec
     
    8589        ((_time)->tv_nsec)
    8690
    87 /** @brief Is Timespec Valid
     91/**
     92 * @brief Is Timespec Valid
    8893 *
    8994 *  This method determines the validity of a timespec.
     
    98103);
    99104
    100 /** @brief Timespec Less Than Operator
     105/**
     106 * @brief Timespec Less Than Operator
    101107 *
    102108 *  This method is the less than operator for timespecs.
     
    113119);
    114120
    115 /** @brief Timespec Greater Than Operator
     121/**
     122 * @brief Timespec Greater Than Operator
    116123 *
    117124 *  This method is the greater than operator for timespecs.
     
    128135);
    129136
    130 /** @brief Timespec equal to Operator
     137/**
     138 * @brief Timespec equal to Operator
    131139 *
    132140 *  This method is the is equal to than operator for timespecs.
     
    143151  )
    144152
    145 /** @brief Add to a Timespec
     153/**
     154 * @brief Add to a Timespec
    146155 *
    147156 *  This routine adds two timespecs.  The second argument is added
     
    158167);
    159168
    160 /** @brief Convert Timespec to Number of Ticks
     169/**
     170 * @brief Convert Timespec to Number of Ticks
    161171 *
    162172 *  This routine convert the @a time timespec to the corresponding number
     
    171181);
    172182
    173 /** @brief Convert Ticks to Timespec
     183/**
     184 * @brief Convert Ticks to Timespec
    174185 *
    175186 *  This routine converts the @a ticks value to the corresponding
     
    184195);
    185196
    186 /** @brief Subtract Two Timespec
     197/**
     198 * @brief Subtract Two Timespec
    187199 *
    188200 *  This routine subtracts two timespecs.  @a result is set to
     
    201213);
    202214
    203 /** @brief Divide Timespec By Integer
     215/**
     216 * @brief Divide Timespec By Integer
    204217 *
    205218 *  This routine divides a timespec by an integer value.  The expected
     
    219232);
    220233
    221 /** @brief Divide Timespec
     234/**
     235 * @brief Divide Timespec
    222236 *
    223237 *  This routine divides a timespec by another timespec.  The
  • cpukit/score/include/rtems/score/timestamp.h

    r3203e09 r4b72da4  
    66
    77/*
    8  *  COPYRIGHT (c) 1989-2008.
     8 *  COPYRIGHT (c) 1989-2009.
    99 *  On-Line Applications Research Corporation (OAR).
    1010 *
     
    131131#endif
    132132
    133 /** @brief Set Timestamp to Seconds Nanosecond
     133/**
     134 *  @brief Set Timestamp to Seconds Nanosecond
    134135 *
    135136 *  This method sets the timestamp to the specified seconds and nanoseconds
     
    148149#endif
    149150
    150 /** @brief Zero Timestamp
     151/**
     152 *  @brief Zero Timestamp
    151153 *
    152154 *  This method sets the timestamp to zero.
     
    163165#endif
    164166
    165 /** @brief Is Timestamp Valid
     167/**
     168 *  @brief Is Timestamp Valid
    166169 *
    167170 *  This method determines the validity of a timestamp.
     
    180183#endif
    181184
    182 /** @brief Timestamp Less Than Operator
     185/**
     186 *  @brief Timestamp Less Than Operator
    183187 *
    184188 *  This method is the less than operator for timestamps.
     
    198202#endif
    199203
    200 /** @brief Timestamp Greater Than Operator
     204/**
     205 *  @brief Timestamp Greater Than Operator
    201206 *
    202207 *  This method is the greater than operator for timestamps.
     
    216221#endif
    217222
    218 /** @brief Timestamp equal to Operator
     223/**
     224 *  @brief Timestamp equal to Operator
    219225 *
    220226 *  This method is the is equal to than operator for timestamps.
     
    234240#endif
    235241
    236 /** @brief Add to a Timestamp
     242/**
     243 *  @brief Add to a Timestamp
    237244 *
    238245 *  This routine adds two timestamps.  The second argument is added
     
    252259#endif
    253260
    254 /** @brief Add to a Timestamp (At Clock Tick)
     261/**
     262 *  @brief Add to a Timestamp (At Clock Tick)
    255263 *
    256264 *  This routine adds two timestamps.  The second argument is added
     
    276284#endif
    277285
    278 /** @brief Convert Timestamp to Number of Ticks
     286/**
     287 *  @brief Convert Timestamp to Number of Ticks
    279288 *
    280289 *  This routine convert the @a time timestamp to the corresponding number
     
    293302#endif
    294303
    295 /** @brief Convert Ticks to Timestamp
     304/**
     305 *  @brief Convert Ticks to Timestamp
    296306 *
    297307 *  This routine converts the @a _ticks value to the corresponding
     
    309319#endif
    310320
    311 /** @brief Subtract Two Timestamp
     321/**
     322 *  @brief Subtract Two Timestamp
    312323 *
    313324 *  This routine subtracts two timestamps.  @a result is set to
     
    329340#endif
    330341
    331 /** @brief Divide Timestamp By Integer
     342/**
     343 *  @brief Divide Timestamp By Integer
    332344 *
    333345 *  This routine divides a timestamp by an integer value.  The expected
     
    349361#endif
    350362
    351 /** @brief Divide Timestamp
     363/**
     364 *  @brief Divide Timestamp
    352365 *
    353366 *  This routine divides a timestamp by another timestamp.  The
     
    369382#endif
    370383
    371 /** @brief Get Seconds Portion of Timestamp
     384/**
     385 *  @brief Get Seconds Portion of Timestamp
    372386 *
    373387 *  This method returns the seconds portion of the specified timestamp
     
    385399#endif
    386400
    387 /** @brief Get Nanoseconds Portion of Timestamp
     401/**
     402 *  @brief Get Nanoseconds Portion of Timestamp
    388403 *
    389404 *  This method returns the nanoseconds portion of the specified timestamp
     
    401416#endif
    402417
    403 /** @brief Convert Timestamp to struct timespec
     418/**
     419 *  @brief Convert Timestamp to struct timespec
    404420 *
    405421 *  This method returns the seconds portion of the specified timestamp
  • cpukit/score/include/rtems/score/timestamp64.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2008.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    5252typedef int64_t Timestamp64_Control;
    5353
    54 /** @brief Set Timestamp to Seconds Nanosecond
     54/**
     55 *  @brief Set Timestamp to Seconds Nanosecond
    5556 *
    5657 *  This method sets the timestamp to the specified seconds and nanoseconds
     
    7576#endif
    7677
    77 /** @brief Zero Timestamp
     78/**
     79 *  @brief Zero Timestamp
    7880 *
    7981 *  This method sets the timestamp to zero.
     
    9193#endif
    9294
    93 /** @brief Is Timestamp Valid
     95/**
     96 *  @brief Is Timestamp Valid
    9497 *
    9598 *  This method determines the validity of a timestamp.
     
    103106        (1)
    104107
    105 /** @brief Timestamp Less Than Operator
     108/**
     109 *  @brief Timestamp Less Than Operator
    106110 *
    107111 *  This method is the less than operator for timestamps.
     
    123127#endif
    124128
    125 /** @brief Timestamp Greater Than Operator
     129/**
     130 *  @brief Timestamp Greater Than Operator
    126131 *
    127132 *  This method is the greater than operator for timestamps.
     
    143148#endif
    144149
    145 /** @brief Timestamp equal to Operator
     150/**
     151 *  @brief Timestamp equal to Operator
    146152 *
    147153 *  This method is the is equal to than operator for timestamps.
     
    163169#endif
    164170
    165 /** @brief Add to a Timestamp
     171/**
     172 *  @brief Add to a Timestamp
    166173 *
    167174 *  This routine adds two timestamps.  The second argument is added
     
    183190#endif
    184191
    185 /** @brief Add to a Timestamp (At Clock Tick)
     192/**
     193 *  @brief Add to a Timestamp (At Clock Tick)
    186194 *
    187195 *  This routine adds two timestamps.  The second argument is added
     
    212220}
    213221
    214 /** @brief Convert Timestamp to Number of Ticks
     222/**
     223 *  @brief Convert Timestamp to Number of Ticks
    215224 *
    216225 *  This routine convert the @a time timestamp to the corresponding number
     
    225234);
    226235
    227 /** @brief Convert Ticks to Timestamp
     236/**
     237 *  @brief Convert Ticks to Timestamp
    228238 *
    229239 *  This routine converts the @a _ticks value to the corresponding
     
    238248);
    239249
    240 /** @brief Subtract Two Timestamp
     250/**
     251 *  @brief Subtract Two Timestamp
    241252 *
    242253 *  This routine subtracts two timestamps.  @a result is set to
     
    263274#endif
    264275
    265 /** @brief Divide Timestamp By Integer
     276/**
     277 *  @brief Divide Timestamp By Integer
    266278 *
    267279 *  This routine divides a timestamp by an integer value.  The expected
     
    288300#endif
    289301
    290 /** @brief Divide Timestamp
     302/**
     303 *  @brief Divide Timestamp
    291304 *
    292305 *  This routine divides a timestamp by another timestamp.  The
     
    307320);
    308321
    309 /** @brief Get Seconds Portion of Timestamp
     322/**
     323 *  @brief Get Seconds Portion of Timestamp
    310324 *
    311325 *  This method returns the seconds portion of the specified timestamp
     
    324338#endif
    325339
    326 /** @brief Get Nanoseconds Portion of Timestamp
     340/**
     341 *  @brief Get Nanoseconds Portion of Timestamp
    327342 *
    328343 *  This method returns the nanoseconds portion of the specified timestamp
     
    341356#endif
    342357
    343 /** @brief Convert Timestamp to struct timespec
     358/**
     359 *  @brief Convert Timestamp to struct timespec
    344360 *
    345361 *  This method returns the seconds portion of the specified timestamp
  • cpukit/score/include/rtems/score/tod.h

    r3203e09 r4b72da4  
    77
    88/*
    9  *  COPYRIGHT (c) 1989-2008.
     9 *  COPYRIGHT (c) 1989-2009.
    1010 *  On-Line Applications Research Corporation (OAR).
    1111 *
     
    103103  (4 * TOD_SECONDS_PER_DAY))
    104104
    105 /** @brief RTEMS Epoch Year
     105/**
     106 *  @brief RTEMS Epoch Year
    106107 *
    107108 *  The following constant define the earliest year to which an
     
    118119/**@{*/
    119120
    120 /** @brief Is the Time Of Day Set
     121/**
     122 *  @brief Is the Time Of Day Set
    121123 *
    122124 *  This is true if the application has set the current
     
    125127SCORE_EXTERN bool _TOD_Is_set;
    126128
    127 /** @brief Current Time of Day (Timespec)
     129/**
     130 *  @brief Current Time of Day (Timespec)
     131 *
    128132 *  The following contains the current time of day.
    129133 */
    130134SCORE_EXTERN Timestamp_Control _TOD_Now;
    131135
    132 /** @brief Current Time of Day (Timespec)
     136/**
     137 *  @brief Current Time of Day (Timespec)
     138 *
    133139 *  The following contains the running uptime.
    134140 */
    135141SCORE_EXTERN Timestamp_Control _TOD_Uptime;
    136142
    137 /** @brief Seconds Since RTEMS Epoch
     143/**
     144 *  @brief Seconds Since RTEMS Epoch
     145 *
    138146 *  The following contains the number of seconds from 00:00:00
    139147 *  January 1, TOD_BASE_YEAR until the current time of day.
     
    142150  _Timestamp_Get_seconds(&_TOD_Now)
    143151
    144 /** @brief _TOD_Handler_initialization
     152/**
     153 *  @brief _TOD_Handler_initialization
    145154 *
    146155 *  This routine performs the initialization necessary for this handler.
     
    148157void _TOD_Handler_initialization(void);
    149158
    150 /** @brief _TOD_Set
     159/**
     160 *  @brief _TOD_Set
    151161 *
    152162 *  This routine sets the current time of day to @a time and
     
    157167);
    158168
    159 /** @brief _TOD_Get
     169/**
     170 *  @brief _TOD_Get
    160171 *
    161172 *  This routine returns the current time of day with potential accuracy
     
    168179);
    169180
    170 /** @brief _TOD_Get_uptime
     181/**
     182 *  @brief _TOD_Get_uptime
    171183 *
    172184 *  This routine returns the system uptime with potential accuracy
     
    179191);
    180192
    181 /** @brief _TOD_Get_uptime_as_timespec
     193/**
     194 *  @brief _TOD_Get_uptime_as_timespec
    182195 *
    183196 *  This routine returns the system uptime with potential accuracy
     
    196209void _TOD_Tickle_ticks( void );
    197210
    198 /** @brief TOD_MILLISECONDS_TO_MICROSECONDS
     211/**
     212 *  @brief TOD_MILLISECONDS_TO_MICROSECONDS
    199213 *
    200214 *  This routine converts an interval expressed in milliseconds to microseconds.
     
    204218#define TOD_MILLISECONDS_TO_MICROSECONDS(_ms) ((uint32_t)(_ms) * 1000L)
    205219
    206 /** @brief TOD_MICROSECONDS_TO_TICKS
     220/**
     221 *  @brief TOD_MICROSECONDS_TO_TICKS
    207222 *
    208223 *  This routine converts an interval expressed in microseconds to ticks.
     
    214229);
    215230
    216 /** @brief TOD_MILLISECONDS_TO_TICKS
     231/**
     232 *  @brief TOD_MILLISECONDS_TO_TICKS
    217233 *
    218234 *  This routine converts an interval expressed in milliseconds to ticks.
     
    224240);
    225241
    226 /** @brief How many ticks in a second?
     242/**
     243 *  @brief How many ticks in a second?
    227244 *
    228245 *  This method returns the number of ticks in a second.
     
    233250uint32_t TOD_TICKS_PER_SECOND_method(void);
    234251
    235 /** @brief Method to return number of ticks in a second
     252/**
     253 *  @brief Method to return number of ticks in a second
    236254 *
    237255 *  This method exists to hide the fact that TOD_TICKS_PER_SECOND can not
  • cpukit/score/include/rtems/score/watchdog.h

    r3203e09 r4b72da4  
    88
    99/*
    10  *  COPYRIGHT (c) 1989-2007.
     10 *  COPYRIGHT (c) 1989-2009.
    1111 *  On-Line Applications Research Corporation (OAR).
    1212 *
     
    3838#endif
    3939
    40 /** @brief Maximum Interval Length
     40/**
     41 *  @brief Maximum Interval Length
    4142 *
    4243 *  The following type defines the control block used to manage
     
    4546#define WATCHDOG_MAXIMUM_INTERVAL ((Watchdog_Interval) 0xffffffff)
    4647
    47 /** @brief Watchdog Interval Type
     48/**
     49 *  @brief Watchdog Interval Type
    4850 *
    4951 *  This type is used to specify the length of intervals.
     
    5153typedef uint32_t   Watchdog_Interval;
    5254
    53 /** @brief Watchdog Nanoseconds Since Last Tick Extension
     55/**
     56 *  @brief Watchdog Nanoseconds Since Last Tick Extension
    5457 *
    5558 *  This type defines a pointer to the BSP plugin to obtain the number
     
    5861typedef uint32_t (*Watchdog_Nanoseconds_since_last_tick_routine)(void);
    5962
    60 /** @brief Watchdog Service Routine Return Type
     63/**
     64 *  @brief Watchdog Service Routine Return Type
    6165 *
    6266 *  This type defines the return type from a Watchdog Service Routine.
     
    6468typedef void Watchdog_Service_routine;
    6569
    66 /** @brief Watchdog Service Routine Pointer Type
     70/**
     71 *  @brief Watchdog Service Routine Pointer Type
    6772 *
    6873 *  This type define a pointer to a watchdog service routine.
     
    7378             );
    7479
    75 /** @brief No timeout constant
     80/**
     81 *  @brief No timeout constant
    7682 *
    7783 *  This is the constant for indefinite wait.  It is actually an
     
    8086#define WATCHDOG_NO_TIMEOUT  0
    8187
    82 /** @brief Watchdog States Type
     88/**
     89 *  @brief Watchdog States Type
    8390 *
    8491 *  This enumerated type is the set of the states in which a
     
    101108} Watchdog_States;
    102109
    103 /** @brief Watchdog Adjustment Directions Type
     110/**
     111 *  @brief Watchdog Adjustment Directions Type
    104112 *
    105113 *  The following enumerated type details the manner in which
     
    115123} Watchdog_Adjust_directions;
    116124
    117 /** @brief Watchdog Control Structure
     125/**
     126 *  @brief Watchdog Control Structure
    118127 *
    119128 *  The following record defines the control block used
     
    145154}   Watchdog_Control;
    146155
    147 /** @brief Watchdog Synchronization Level
     156/**
     157 *  @brief Watchdog Synchronization Level
    148158 *
    149159 *  This used for synchronization purposes
     
    152162SCORE_EXTERN volatile uint32_t    _Watchdog_Sync_level;
    153163
    154 /** @brief Watchdog Synchronization Count
     164/**
     165 *  @brief Watchdog Synchronization Count
    155166 *
    156167 *  This used for synchronization purposes
     
    159170SCORE_EXTERN volatile uint32_t    _Watchdog_Sync_count;
    160171
    161 /** @brief Ticks Since System Boot
     172/**
     173 *  @brief Ticks Since System Boot
    162174 *
    163175 *  This contains the number of ticks since the system was booted.
     
    166178SCORE_EXTERN volatile Watchdog_Interval _Watchdog_Ticks_since_boot;
    167179
    168 /** @brief Watchdog Nanoseconds Since Last Tick Handler
     180/**
     181 *  @brief Watchdog Nanoseconds Since Last Tick Handler
    169182 *
    170183 *  This is a pointer to the optional BSP plugin to obtain the number
     
    174187  _Watchdog_Nanoseconds_since_tick_handler;
    175188
    176 /** @brief Per Ticks Watchdog List
     189/**
     190 *  @brief Per Ticks Watchdog List
    177191 *
    178192 *  This is the watchdog chain which is managed at ticks.
     
    180194SCORE_EXTERN Chain_Control _Watchdog_Ticks_chain;
    181195
    182 /** @brief Per Seconds Watchdog List
     196/**
     197 *  @brief Per Seconds Watchdog List
    183198 *
    184199 *  This is the watchdog chain which is managed at second boundaries.
     
    186201SCORE_EXTERN Chain_Control _Watchdog_Seconds_chain;
    187202
    188 /** @brief Watchdog Handler Initialization
     203/**
     204 *  @brief Watchdog Handler Initialization
    189205 *
    190206 *  This routine initializes the watchdog handler.  The watchdog
     
    194210void _Watchdog_Handler_initialization( void );
    195211
    196 /** @brief Remove Watchdog from List
     212/**
     213 *  @brief Remove Watchdog from List
    197214 *
    198215 *  This routine removes @a the_watchdog from the watchdog chain on which
     
    206223);
    207224
    208 /** @brief Watchdog Adjust
     225/**
     226 *  @brief Watchdog Adjust
    209227 *
    210228 *  This routine adjusts the @a header watchdog chain in the forward
     
    221239);
    222240
    223 /** @brief Watchdog Adjust to Chain
     241/**
     242 *  @brief Watchdog Adjust to Chain
    224243 *
    225244 *  This routine adjusts the @a header watchdog chain in the forward
     
    240259);
    241260
    242 /** @brief Watchdog Insert
     261/**
     262 *  @brief Watchdog Insert
    243263 *
    244264 *  This routine inserts @a the_watchdog into the @a header watchdog chain
     
    253273);
    254274
    255 /** @brief Watchdog Tickle
     275/**
     276 *  @brief Watchdog Tickle
    256277 *
    257278 *  This routine is invoked at appropriate intervals to update
  • cpukit/score/include/rtems/score/wkspace.h

    r3203e09 r4b72da4  
    88
    99/*
    10  *  COPYRIGHT (c) 1989-2008.
     10 *  COPYRIGHT (c) 1989-2009.
    1111 *  On-Line Applications Research Corporation (OAR).
    1212 *
     
    3636#include <rtems/score/interr.h>
    3737
    38 /** @brief Executive Workspace Control
     38/**
     39 * @brief Executive Workspace Control
    3940 *
    4041 *  The is the heap control structure that used to manage the
     
    4344SCORE_EXTERN Heap_Control _Workspace_Area;  /* executive heap header */
    4445
    45 /** @brief Workspace Handler Initialization
     46/**
     47 * @brief Workspace Handler Initialization
    4648 *
    4749 *  This routine performs the initialization necessary for this handler.
     
    4951void _Workspace_Handler_initialization(void);
    5052
    51 /** @brief Allocate Memory from Workspace
     53/**
     54 * @brief Allocate Memory from Workspace
    5255 *
    5356 *  This routine returns the address of a block of memory of size
     
    6366);
    6467
    65 /** @brief Free Memory to the Workspace
     68/**
     69 * @brief Free Memory to the Workspace
    6670 *
    6771 *  This function frees the specified block of memory.  If the block
     
    8084);
    8185
    82 /** @brief Workspace Allocate or Fail with Fatal Error
     86/**
     87 * @brief Workspace Allocate or Fail with Fatal Error
    8388 *
    8489 *  This routine returns the address of a block of memory of @a size
Note: See TracChangeset for help on using the changeset viewer.