Changeset f7f1d77 in rtems


Ignore:
Timestamp:
Nov 28, 2012, 2:11:31 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
d4d7899
Parents:
815994f
git-author:
Alex Ivanov <alexivanov97@…> (11/28/12 14:11:31)
git-committer:
Joel Sherrill <joel.sherrill@…> (11/28/12 14:17:26)
Message:

score misc: Clean up Doxygen (GCI 2012)

This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
https://google-melange.appspot.com/gci/task/view/google/gci2012/7978208

Location:
cpukit/score
Files:
28 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/include/rtems/score/coremsg.h

    r815994f rf7f1d77  
    437437
    438438/**
     439 *  @brief Insert a Message into the Message Queue
     440 *
    439441 *  This kernel routine inserts the specified message into the
    440442 *  message queue.  It is assumed that the message has been filled
     
    445447 *  @param[in] submit_type determines whether the message is prepended,
    446448 *         appended, or enqueued in priority order.
     449 *
     450 *  - INTERRUPT LATENCY:
     451 *    + insert
    447452 */
    448453void _CORE_message_queue_Insert_message(
  • cpukit/score/include/rtems/score/corerwlock.h

    r815994f rf7f1d77  
    158158
    159159/**
     160 *  @brief RWLock Obtain for Writing
     161 *
    160162 *  This routine attempts to obtain the RWLock for write exclusive access.
    161163 *
  • cpukit/score/include/rtems/score/corespinlock.h

    r815994f rf7f1d77  
    141141
    142142/**
     143 * @brief Manually release Spinlock
     144 *
    143145 *  This routine manually releases the spinlock.  All of the threads waiting
    144146 *  for the spinlock will be readied.
  • cpukit/score/include/rtems/score/object.h

    r815994f rf7f1d77  
    4848 *
    4949 * @brief Provides CPU architecture dependent services.
     50 */
     51
     52/**
     53 *  @defgroup ScoreObject Object Handler
     54 *
     55 *  @ingroup Score
    5056 */
    5157
     
    451457
    452458/**
     459 *  @brief Initialize object Information
     460 *
    453461 *  This function initializes an object class information record.
    454462 *  SUPPORTS_GLOBAL is true if the object class supports global
  • cpukit/score/include/rtems/score/rbtree.h

    r815994f rf7f1d77  
    224224 *  of @a the_node if it exists in the Red-Black Tree @a the_rbtree,
    225225 *  and NULL if not.
     226 *
     227 *  @param[in] the_rbtree pointer to rbtree control
     228 *  @param[in] the_node node with the key to search for
     229 *  @return This method returns pointer to control header of rbtree. *
     230 *          If there is no control header available (the node is not part
     231 *          of a tree), then NULL is returned. *
     232 *
     233 *  - INTERRUPT LATENCY:
     234 *    + single case 
    226235 */
    227236RBTree_Node *_RBTree_Find(
  • cpukit/score/include/rtems/score/schedulerpriority.h

    r815994f rf7f1d77  
    7070
    7171/**
     72 *  @brief Scheduler priority Block
     73 *
    7274 *  This routine removes @a the_thread from the scheduling decision,
    7375 *  that is, removes it from the ready queue.  It performs
     
    108110
    109111/**
     112 *  @brief Update Scheduler priority
    110113 *  This routine updates @a the_thread->scheduler based on @a the_scheduler
    111114 *  structures and thread state.
  • cpukit/score/include/rtems/score/thread.h

    r815994f rf7f1d77  
    593593
    594594/**
     595 *  @brief Restart Thread
    595596 *  This support routine restarts the specified task in a way that the
    596597 *  next time this thread executes, it will begin execution at its
  • cpukit/score/include/rtems/score/threadq.h

    r815994f rf7f1d77  
    5252
    5353/**
    54  *
    55  * The following type defines the callout used for timeout processing
    56  * methods.
     54 *  The following type defines the callout used for timeout processing
     55 *  methods.
    5756 */
    5857typedef void ( *Thread_queue_Timeout_callout )(
     
    6261
    6362/**
    64  * @brief  Thread queue Dequeue
     63 *  @brief Thread Queue Dequeue
    6564 *
    6665 *  This function returns a pointer to a thread waiting on
     
    7473
    7574/**
    76  * @brief  Thread queue Enqueue Wrapper
     75 *  @brief Thread Queue Enqueue Wrapper
    7776 *
    7877 *  This routine enqueues the currently executing thread on
     
    8584    _Thread_queue_Timeout )
    8685
    87 
    88 /**
    89  * @brief  Thread queue Enqueue
    90  *
    91  *  This routine enqueues the currently executing thread on
    92  *  the_thread_queue with an optional timeout.
     86/**
     87 *  @brief Thread Queue Enqueue
     88 *
     89 *  This routine blocks a thread, places it on a thread, and optionally
     90 *  starts a timeout timer.
     91 *
     92 *  @param[in] the_thread_queue pointer to threadq
     93 *  @param[in] timeout interval to wait
     94 *
     95 *  - INTERRUPT LATENCY:
     96 *    + single case
    9397 */
    9498void _Thread_queue_Enqueue_with_handler(
     
    99103
    100104/**
    101  *  @brief Thread queue Requeue
     105 *  @brief Thread Queue Requeue
    102106 *
    103107 *  This routine is invoked when a thread changes priority and is
     
    113117
    114118/**
    115  * @brief  Thread queue Extract
     119 *  @brief Thread Queue Extract
    116120 *
    117121 *  This routine removes the_thread from the_thread_queue
     
    124128
    125129/**
    126  * @brief  Thread queue Extract with proxy
     130 *  @brief Thread Queue Extract with proxy
    127131 *
    128132 *  This routine extracts the_thread from the_thread_queue
     
    135139
    136140/**
    137  * @brief  Thread queue First
     141 *  @brief Thread Queue First
    138142 *
    139143 *  This function returns a pointer to the "first" thread
     
    146150
    147151/**
    148  * @brief  Thread queue Flush
     152 *  @brief Thread Queue Flush
    149153 *
    150154 *  This routine unblocks all threads blocked on the_thread_queue
     
    158162
    159163/**
    160  * @brief  Thread queue Initialize
     164 *  @brief Thread Queue Initialize
    161165 *
    162166 *  This routine initializes the_thread_queue based on the
     
    172176
    173177/**
    174  * @brief  Thread queue Dequeue priority
     178 *  @brief Thread Queue Dequeue priority
    175179 *
    176180 *  This function returns a pointer to the highest priority
     
    183187
    184188/**
    185  * @brief  Thread queue Enqueue priority
     189 *  @brief Thread Queue Enqueue priority
    186190 *
    187191 *  This routine enqueues the currently executing thread on
     
    196200
    197201/**
    198  * @brief  Thread queue Extract priority Helper
     202 *  @brief Thread Queue Extract priority Helper
    199203 *
    200204 *  This routine removes the_thread from the_thread_queue
    201205 *  and cancels any timeouts associated with this blocking.
     206 *  @param[in] the_thread_queue pointer to a threadq header
     207 *  @param[in] the_thread pointer to a thread control block
     208 *  @param[in] requeuing true if requeuing and should not alter
     209 *         timeout or state
     210 *  - INTERRUPT LATENCY:
     211 *    + EXTRACT_PRIORITY
    202212 */
    203213void _Thread_queue_Extract_priority_helper(
     
    208218
    209219/**
    210  * @brief Thread queue Extract priority
     220 *  @brief Thread Queue Extract priority
    211221 *
    212222 * This macro wraps the underlying call and hides the requeuing argument.
     
    218228
    219229/**
    220  * @brief  Thread queue First priority
     230 *  @brief Thread Queue First priority
    221231 *
    222232 *  This function returns a pointer to the "first" thread
     
    229239
    230240/**
    231  * @brief  Thread queue Dequeue FIFO
     241 *  @brief Thread Queue Dequeue FIFO
    232242 *
    233243 *  This function returns a pointer to the thread which has
     
    240250
    241251/**
    242  * @brief  Thread queue Enqueue FIFO
     252 *  @brief Thread Queue Enqueue FIFO
    243253 *
    244254 *  This routine enqueues the currently executing thread on
     
    253263
    254264/**
    255  * @brief  Thread queue Extract FIFO
     265 *  @brief Thread Queue Extract FIFO
    256266 *
    257267 *  This routine removes the_thread from the_thread_queue
     
    264274
    265275/**
    266  * @brief  Thread queue First FIFO
     276 *  @brief Thread Queue First FIFO
    267277 *
    268278 *  This function returns a pointer to the "first" thread
     
    275285
    276286/**
    277  * @brief  Thread queue timeout
     287 *  @brief Thread Queue timeout
    278288 *
    279289 *  This routine is invoked when a task's request has not
     
    289299
    290300/**
    291  * @brief Process Thread Queue Timeout
     301 *  @brief Process Thread Queue Timeout
    292302 *
    293303 * This is a shared helper routine which makes it easier to have multiple
  • cpukit/score/src/coremsginsert.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Insert a Message into the Message Queue
     5 * @ingroup ScoreMessageQueue
     6 */
     7
    18/*
    2  *  CORE Message Queue Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the CORE Message Queue Handler.
    7  *  This core object provides task synchronization and communication functions
    8  *  via messages passed to queue objects.
    9  *
    109 *  COPYRIGHT (c) 1989-2005.
    1110 *  On-Line Applications Research Corporation (OAR).
     
    2827#include <rtems/score/thread.h>
    2928#include <rtems/score/wkspace.h>
    30 
    31 /*
    32  *  _CORE_message_queue_Insert_message
    33  *
    34  *  This kernel routine inserts the specified message into the
    35  *  message queue.  It is assumed that the message has been filled
    36  *  in before this routine is called.
    37  *
    38  *  Input parameters:
    39  *    the_message_queue - pointer to message queue
    40  *    the_message       - message to insert
    41  *    priority          - insert indication
    42  *
    43  *  Output parameters:  NONE
    44  *
    45  *  INTERRUPT LATENCY:
    46  *    insert
    47  */
    4829
    4930void _CORE_message_queue_Insert_message(
  • cpukit/score/src/corerwlockobtainwrite.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief RWLock Obtain for Writing
     5 * @ingroup ScoreRWLock
     6 */
     7
    18/*
    2  *  SuperCore RWLock Handler -- Obtain RWLock for writing
    3  *
    49 *  COPYRIGHT (c) 1989-2006.
    510 *  On-Line Applications Research Corporation (OAR).
     
    1924#include <rtems/score/thread.h>
    2025#include <rtems/score/watchdog.h>
    21 
    22 /*
    23  *  _CORE_rwlock_Obtain_for_writing
    24  *
    25  *  This function waits for the rwlock to become available.  Optionally,
    26  *  a limit may be placed on the duration of the spin.
    27  *
    28  *  Input parameters:
    29  *    the_rwlock    - the rwlock control block to initialize
    30  *    timeout_allowed - true if timeout allowed
    31  *    timeout         - the maximum number of ticks to spin
    32  *
    33  *  Output parameters:  NONE
    34  */
    3526
    3627void _CORE_RWLock_Obtain_for_writing(
  • cpukit/score/src/corerwlocktimeout.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief RWLock Specific Thread Queue Timeout
     5 * @ingroup ScoreRWLock
     6 */
     7
    18/*
    2  *  Thread Queue Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    1822#include <rtems/score/corerwlock.h>
    1923#include <rtems/score/corerwlock.h>
    20 
    21 /*
    22  *  _CORE_RWLock_Timeout
    23  *
    24  *  This routine processes a thread which timeouts while waiting on
    25  *  a thread queue. It is called by the watchdog handler.
    26  *
    27  *  Input parameters:
    28  *    id - thread id
    29  *
    30  *  Output parameters: NONE
    31  */
    3224
    3325void _CORE_RWLock_Timeout(
  • cpukit/score/src/corespinlockrelease.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Release a Spinlock
     5 * @ingroup ScoreSpinlock
     6 */
     7
    18/*
    2  *  SuperCore Spinlock Handler -- Release a Spinlock
    3  *
    49 *  COPYRIGHT (c) 1989-2006.
    510 *  On-Line Applications Research Corporation (OAR).
     
    1924#include <rtems/score/thread.h>
    2025#include <rtems/score/watchdog.h>
    21 
    22 /*
    23  *  _CORE_spinlock_Release
    24  *
    25  *  This function releases the spinlock.
    26  *
    27  *  Input parameters:
    28  *    the_spinlock    - the spinlock control block to initialize
    29  *
    30  *  Output parameters:
    31  *    CORE_SPINLOCK_SUCCESSFUL - if successful
    32  *    error code               - if unsuccessful
    33  *
    34  */
    3526
    3627CORE_spinlock_Status _CORE_spinlock_Release(
  • cpukit/score/src/coretodgetuptimetimespec.c

    r815994f rf7f1d77  
    1 /*
    2  *  Time of Day (TOD) Handler - get uptime
     1/**
     2 * @file
     3 *
     4 * @brief Get Uptime as struct timespec
     5 * @ingroup ScoreTODConstants
    36 */
    47
    5 /*  COPYRIGHT (c) 1989-2008.
     8/*
     9 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
    711 *
     
    2024#include <rtems/score/tod.h>
    2125
    22 /*
    23  *  _TOD_Get_uptime_as_timespec
    24  *
    25  *  This routine is used to obtain the system uptime
    26  *
    27  *  Input parameters:
    28  *    time  - pointer to the timestamp structure
    29  *
    30  *  Output parameters: NONE
    31  */
    32 
    3326void _TOD_Get_uptime_as_timespec(
    3427  struct timespec *uptime
  • cpukit/score/src/objectinitializeinformation.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Initialize Object Information
     5 * @ingroup ScoreObject
     6 */
     7
    18/*
    2  *  Object Handler Initialization per Object Class
    3  *
    49 *  COPYRIGHT (c) 1989-2011.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2530#include <rtems/score/sysstate.h>
    2631#include <rtems/score/isr.h>
    27 
    28 /*
    29  *  _Objects_Initialize_information
    30  *
    31  *  This routine initializes all object information related data structures.
    32  *
    33  *  Input parameters:
    34  *    information         - object information table
    35  *    maximum             - maximum objects of this class
    36  *    size                - size of this object's control block
    37  *    is_string           - true if names for this object are strings
    38  *    maximum_name_length - maximum length of each object's name
    39  *    When multiprocessing is configured,
    40  *      supports_global     - true if this is a global object class
    41  *      extract_callout     - pointer to threadq extract callout
    42  *
    43  *  Output parameters:  NONE
    44  */
    4532
    4633void _Objects_Initialize_information(
  • cpukit/score/src/percpu.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Allocate and Initialize Per CPU Structures
     5 * @ingroup PerCPU
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2011.
  • cpukit/score/src/rbtreefind.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Find the control structure of the tree containing the given node
     5 * @ingroup ScoreRBTree
     6 */
     7
    18/*
    29 *  Copyright (c) 2010 Gedare Bloom.
     
    1623#include <rtems/score/isr.h>
    1724
    18 /*
    19  *  _RBTree_Find
    20  *
    21  *  This kernel routine returns a pointer to the rbtree node containing the
    22  *  given key within the given tree, if it exists, or NULL otherwise.
    23  *
    24  *  Input parameters:
    25  *    the_rbtree - pointer to rbtree control
    26  *    search_node - node with the key to search for
    27  *
    28  *  Output parameters:
    29  *    return_node - pointer to control header of rbtree
    30  *    NULL   - if there is no control header available (the node is not part
    31  *    of a tree)
    32  *
    33  *  INTERRUPT LATENCY:
    34  *    only case
    35  */
    36 
    3725RBTree_Node *_RBTree_Find(
    3826  RBTree_Control *the_rbtree,
  • cpukit/score/src/schedulercbsgetparameters.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief _Scheduler_CBS_Get_parameters
     5 * @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/scheduleredfenqueue.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Scheduler EDF Enqueue
     5 * @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulerpriorityblock.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Scheduler Priority Block
     5 * @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Scheduler Handler
  • cpukit/score/src/schedulerpriorityupdate.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Update Scheduler Priority
     5 * @ingroup ScoreScheduler
     6 */
     7
    18/*
    2  *  Scheduler Handler
    3  *
    49 *  Copyright (C) 2010 Gedare Bloom.
    510 *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/threaddisabledispatch.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Disaable Thread Dispatching
     5 * @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  _Thread_Disable_dispatch
    39 *
    410 *
  • cpukit/score/src/threadqenqueue.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Thread Queue Enqueue
     5 * @ingroup ScoreThreadQ
     6 */
     7
    18/*
    29 *  Thread Queue Handler
     
    2330#include <rtems/score/threadq.h>
    2431#include <rtems/score/tqdata.h>
    25 
    26 /*
    27  *  _Thread_queue_Enqueue_with_handler
    28  *
    29  *  This routine blocks a thread, places it on a thread, and optionally
    30  *  starts a timeout timer.
    31  *
    32  *  Input parameters:
    33  *    the_thread_queue - pointer to threadq
    34  *    timeout          - interval to wait
    35  *
    36  *  Output parameters: NONE
    37  *
    38  *  INTERRUPT LATENCY:
    39  *    only case
    40  */
    4132
    4233void _Thread_queue_Enqueue_with_handler(
  • cpukit/score/src/threadqextractpriority.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Thread queue Extract priority Helper
     5 * @ingroup ScoreThreadQ
     6 */
     7
    18/*
    2  *  Thread Queue Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2327#include <rtems/score/threadq.h>
    2428#include <rtems/score/tqdata.h>
    25 
    26 /*
    27  *  _Thread_queue_Extract_priority
    28  *
    29  *  This routine removes a specific thread from the specified threadq,
    30  *  deletes any timeout, and unblocks the thread.
    31  *
    32  *  Input parameters:
    33  *    the_thread_queue - pointer to a threadq header
    34  *    the_thread       - pointer to a thread control block
    35  *    requeuing        - true if requeuing and should not alter timeout or state
    36  *
    37  *  Output parameters: NONE
    38  *
    39  *  INTERRUPT LATENCY:
    40  *    EXTRACT_PRIORITY
    41  */
    4229
    4330void _Thread_queue_Extract_priority_helper(
  • cpukit/score/src/threadrestart.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Restart Thread
     5 * @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2832#include <rtems/score/userextimpl.h>
    2933#include <rtems/score/wkspace.h>
    30 
    31 /*
    32  *  _Thread_Restart
    33  *
    34  *  DESCRIPTION:
    35  *
    36  *  This support routine restarts the specified task in a way that the
    37  *  next time this thread executes, it will begin execution at its
    38  *  original starting point.
    39  */
    4034
    4135bool _Thread_Restart(
  • cpukit/score/src/timespecdivide.c

    r815994f rf7f1d77  
    11/**
    2  *  @file  score/src/timespecdivide.c
     2 * @file
     3 *
     4 * @brief Divide Timespec By Integer
     5 * @ingroup Timespec
    36 */
    47
  • cpukit/score/src/ts64getseconds.c

    r815994f rf7f1d77  
    11/**
    2  * @file score/src/ts64getseconds.c
    3 */
     2 * @file
     3 *
     4 * @brief Get Seconds Portion of Timestamp
     5 * @ingroup SuperCore
     6 */
    47
    58/*
  • cpukit/score/src/ts64subtract.c

    r815994f rf7f1d77  
    11/**
    2  * @file score/src/ts64subtract.c
    3 */
    4 
     2 * @file
     3 *
     4 * @brief Subtract Two Timestamps
     5 * @ingroup Timestamp
     6 */
    57/*
    68 *  COPYRIGHT (c) 1989-2008.
  • cpukit/score/src/watchdogremove.c

    r815994f rf7f1d77  
     1/**
     2 * @file
     3 *
     4 * @brief Remove Watchdog from List
     5 * @ingroup ScoreWatchdog
     6 */
     7
    18/*
    2  *  Watchdog Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    1822#include <rtems/score/isr.h>
    1923#include <rtems/score/watchdog.h>
    20 
    21 /*
    22  *  _Watchdog_Remove
    23  *
    24  *  The routine removes a watchdog from a delta chain and updates
    25  *  the delta counters of the remaining watchdogs.
    26  */
    2724
    2825Watchdog_States _Watchdog_Remove(
Note: See TracChangeset for help on using the changeset viewer.