Changeset 5a58b1e in rtems


Ignore:
Timestamp:
Dec 1, 2012, 2:53:45 PM (7 years ago)
Author:
Daniel Georgiev <daniel.georgiev95@…>
Branches:
4.11, master
Children:
52adc808
Parents:
f839bf5a
git-author:
Daniel Georgiev <daniel.georgiev95@…> (12/01/12 14:53:45)
git-committer:
Gedare Bloom <gedare@…> (12/01/12 14:53:45)
Message:

score misc: Score misc: Clean up Doxygen #11 (GCI 2012)

This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.

http://www.google-melange.com/gci/task/view/google/gci2012/8013204

Location:
cpukit/score
Files:
28 edited

Legend:

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

    rf839bf5a r5a58b1e  
    135135
    136136/**
     137 *  @brief Wait For The Barrier
    137138 *  This routine wait for the barrier to be released.  If the barrier
    138139 *  is set to automatic and this is the appropriate thread, then it returns
  • cpukit/score/include/rtems/score/coremutex.h

    rf839bf5a r5a58b1e  
    297297#if defined(__RTEMS_DO_NOT_INLINE_CORE_MUTEX_SEIZE__)
    298298  /**
     299   *  @brief Trylock CORE Mutex Seize Interrupt
    299300   *  When doing test coverage analysis or trying to minimize the code
    300301   *  space for RTEMS, it is often helpful to not inline this method
  • cpukit/score/include/rtems/score/corerwlock.h

    rf839bf5a r5a58b1e  
    139139
    140140/**
     141 *  @brief Obtain RWLock for reading
    141142 *  This routine attempts to obtain the RWLock for read access.
    142143 *
     
    151152 * @note Status is returned via the thread control block.
    152153 */
     154
    153155void _CORE_RWLock_Obtain_for_reading(
    154156  CORE_RWLock_Control                 *the_rwlock,
  • cpukit/score/include/rtems/score/corespinlock.h

    rf839bf5a r5a58b1e  
    124124
    125125/**
     126 *  @brief Wait for Spinlock
    126127 *  This routine wait for the spinlock to be released.  If the spinlock
    127128 *  is set to automatic and this is the appropriate thread, then it returns
  • cpukit/score/include/rtems/score/object.h

    rf839bf5a r5a58b1e  
    584584
    585585/**
     586 *  @brief Object Name To Id
    586587 *  This method converts an object name to an Id.  It performs a look up
    587588 *  using the object information block for this object class.
     
    628629
    629630/**
     631 *  @brief Object Id To Name
    630632 *  This function implements the common portion of the object Id
    631633 *  to name directives.  This function returns the name
     
    648650
    649651/**
     652 *  @brief Get Object
    650653 *  This function maps object ids to object control blocks.
    651654 *  If id corresponds to a local object, then it returns
  • cpukit/score/include/rtems/score/schedulerpriority.h

    rf839bf5a r5a58b1e  
    6565
    6666/**
     67 * @brief Initialize Scheduler Priority
    6768 * This routine initializes the priority scheduler.
    6869 */
  • cpukit/score/include/rtems/score/schedulersimple.h

    rf839bf5a r5a58b1e  
    9494
    9595/**
     96 *  @brief Scheduler Simple Handler / Unblock
    9697 *  This routine adds @a the_thread to the scheduling decision,
    9798 *  that is, adds it to the ready queue and
  • cpukit/score/include/rtems/score/thread.h

    rf839bf5a r5a58b1e  
    579579
    580580/**
     581 *  @brief Initialize Thread
    581582 *  This routine initializes the specified the thread.  It allocates
    582583 *  all memory associated with this thread.  It completes by adding
     
    746747
    747748/**
     749 *  @brief Thread Handler
    748750 *  This routine is the wrapper function for all threads.  It is
    749751 *  the starting point for all threads.  The user provided thread
     
    751753 *  which must be performed immediately before and after the user's
    752754 *  thread executes are found here.
     755 *
     756 *  NOTE:
     757 *
     758 *  On entry, it is assumed all interrupts are blocked and that this
     759 *  routine needs to set the initial isr level.  This may or may not
     760 *  actually be needed by the context switch routine and as a result
     761 *  interrupts may already be at there proper level.  Either way,
     762 *  setting the initial isr level properly here is safe.
     763 *
     764 *  Input parameters:   NONE
     765 *
     766 *  Output parameters:  NONE
    753767 */
    754768void _Thread_Handler( void );
     
    827841
    828842/**
     843 *  @brief Iterates Over All Threads
    829844 *  This routine iterates over all threads regardless of API and
    830845 *  invokes the specified routine.
  • cpukit/score/src/corebarrierwait.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Wait For The Barrier
     5 *  @ingroup ScoreBarrier
     6 */
     7
    18/*
    2  *  SuperCore Barrier Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is part of the implementation of the SuperCore Barrier Handler.
    7  *
    89 *  COPYRIGHT (c) 1989-2006.
    910 *  On-Line Applications Research Corporation (OAR).
     
    2425#include <rtems/score/thread.h>
    2526#include <rtems/score/threadq.h>
    26 
    27 /*
    28  *  _CORE_barrier_Wait
    29  *
    30  *  Input parameters:
    31  *    the_barrier - pointer to barrier control block
    32  *    id          - id of object to wait on
    33  *    wait        - true if wait is allowed, false otherwise
    34  *    timeout     - number of ticks to wait (0 means forever)
    35  *    api_barrier_mp_support - api dependent MP support actions
    36  *
    37  *  Output parameters:  NONE
    38  *
    39  *  INTERRUPT LATENCY:
    40  *    available
    41  *    wait
    42  */
    4327
    4428void _CORE_barrier_Wait(
  • cpukit/score/src/coremutex.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Initialize a Core Mutex
     5 *  @ingroup ScoreMutex
     6 */
     7
    18/*
    2  *  Mutex Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the Mutex Handler.
    7  *  This handler provides synchronization and mutual exclusion capabilities.
    8  *
    99 *  COPYRIGHT (c) 1989-1999.
    1010 *  On-Line Applications Research Corporation (OAR).
     
    2525#include <rtems/score/thread.h>
    2626#include <rtems/score/threadq.h>
    27 
    28 /*
    29  *  _CORE_mutex_Initialize
    30  *
    31  *  This routine initializes a mutex at create time and set the control
    32  *  structure according to the values passed.
    33  *
    34  *  Input parameters:
    35  *    the_mutex             - the mutex control block to initialize
    36  *    the_mutex_attributes  - the mutex attributes specified at create time
    37  *    initial_lock          - mutex initial lock or unlocked status
    38  *
    39  *  Output parameters:  NONE
    40  */
    4127
    4228CORE_mutex_Status _CORE_mutex_Initialize(
  • cpukit/score/src/coremutexflush.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Flush all waiting threads
     5 *  @ingroup ScoreMutex
     6 */
     7
    18/*
    2  *  Mutex Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the Mutex Handler.
    7  *  This handler provides synchronization and mutual exclusion capabilities.
    8  *
    99 *  COPYRIGHT (c) 1989-1999.
    1010 *  On-Line Applications Research Corporation (OAR).
     
    2626#include <rtems/score/threadq.h>
    2727
    28 /*
    29  *  _CORE_mutex_Flush
    30  *
    31  *  This function a flushes the mutex's task wait queue.
    32  *
    33  *  Input parameters:
    34  *    the_mutex              - the mutex to be flushed
    35  *    remote_extract_callout - function to invoke remotely
    36  *    status                 - status to pass to thread
    37  *
    38  *  Output parameters:  NONE
    39  */
    40 
    4128void _CORE_mutex_Flush(
    4229  CORE_mutex_Control         *the_mutex,
  • cpukit/score/src/coremutexseizeintr.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Trylock CORE Mutex Seize Interrupt
     5 *  @ingroup ScoreMutex
     6 */
     7
    18/*
    2  *  Mutex Handler -- Seize interrupt disable version
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/corerwlockobtainread.c

    rf839bf5a r5a58b1e  
     1/**
     2 * @file
     3 *
     4 * @brief Obtain RWLock for reading
     5 * @ingroup ScoreRWLock
     6 */
     7
    18/*
    2  *  SuperCore RWLock Handler -- Obtain RWLock for reading
    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_reading
    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_reading(
  • cpukit/score/src/corespinlockwait.c

    rf839bf5a r5a58b1e  
    11/*
    2  *  SuperCore Spinlock Handler -- Wait for Spinlock
     2 *  @file
    33 *
     4 *  @brief Wait for Spinlock
     5 *  @ingroup ScoreSpinlock
     6 */
     7
     8/*
    49 *  COPYRIGHT (c) 1989-2009.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/iterateoverthreads.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Iterates Over All Threads
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  rtems_iterate_over_all_threads
    3  *
    4  *  This function operates by as follows:
    5  *    for all threads
    6  *         invoke specified function
    7  *
    89 *  COPYRIGHT (c) 1989-2010.
    910 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/objectget.c

    rf839bf5a r5a58b1e  
    11/*
    2  *  Object Handler
     2 *  @file
    33 *
    4  *
     4 *  @brief Get Object
     5 *  @ingroup Score
     6 */
     7
     8/*
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2630#include <rtems/score/sysstate.h>
    2731#include <rtems/score/isr.h>
    28 
    29 /*
    30  * _Objects_Get
    31  *
    32  * This routine sets the object pointer for the given
    33  * object id based on the given object information structure.
    34  *
    35  * Input parameters:
    36  *   information - pointer to entry in table for this class
    37  *   id          - object id to search for
    38  *   location    - address of where to store the location
    39  *
    40  * Output parameters:
    41  *   returns  - address of object if local
    42  *   location - one of the following:
    43  *                  OBJECTS_ERROR  - invalid object ID
    44  *                  OBJECTS_REMOTE - remote object
    45  *                  OBJECTS_LOCAL  - local object
    46  */
    4732
    4833Objects_Control *_Objects_Get(
  • cpukit/score/src/objectidtoname.c

    rf839bf5a r5a58b1e  
    11/*
    2  *  Obtain Object Name Given ID
     2 *  @file
    33 *
    4  *
     4 *  @brief Object id to name
     5 *  @ingroup Score
     6 */
     7
     8/*
    59 *  COPYRIGHT (c) 1989-2003.
    610 *  On-Line Applications Research Corporation (OAR).
     
    1923#include <rtems/score/thread.h>
    2024
    21 /*
    22  *  _Objects_Id_to_name
    23  *
    24  *  DESCRIPTION:
    25  *
    26  *  This routine returns the name associated with the given ID.
    27  *
    28  *  INPUT:
    29  *
    30  *  id   - id of object to lookup name
    31  *  name - pointer to location in which to store name
    32  *
    33  */
    3425Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
    3526  Objects_Id      id,
  • cpukit/score/src/objectnametoid.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Object Name To Id
     5 *  @ingroup Score
     6 */
     7
    18/*
    2  *  Object Handler
    3  *
    49 *  COPYRIGHT (c) 1989-2010.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2530#include <rtems/score/sysstate.h>
    2631#include <rtems/score/isr.h>
    27 
    28 /*
    29  *  _Objects_Name_to_id_u32
    30  *
    31  *  These kernel routines search the object table(s) for the given
    32  *  object name and returns the associated object id.
    33  *
    34  *  Input parameters:
    35  *    information - object information
    36  *    name        - user defined object name
    37  *    node        - node indentifier (0 indicates any node)
    38  *    id          - address of return ID
    39  *
    40  *  Output parameters:
    41  *    id                                   - object id
    42  *    OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL - if successful
    43  *    error code                           - if unsuccessful
    44  */
    4532
    4633Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
  • cpukit/score/src/rbtreeget.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Obtain the min or max node of a rbtree
     5 *  @ingroup ScoreRBTree
     6 */
     7
    18/*
    29 *  Copyright (c) 2010 Gedare Bloom.
     
    1623#include <rtems/score/isr.h>
    1724
    18 /*
    19  *  _RBTree_Get
    20  *
    21  *  This kernel routine returns a pointer to a node taken from the
    22  *  given rbtree.
    23  *
    24  *  Input parameters:
    25  *    the_rbtree - pointer to rbtree header
    26  *    dir - specifies min (0) or max (1)
    27  *
    28  *  Output parameters:
    29  *    return_node - pointer to node in rbtree allocated
    30  *    NULL   - if no nodes available
    31  *
    32  *  INTERRUPT LATENCY:
    33  *    only case
    34  */
    35 
    3625RBTree_Node *_RBTree_Get(
    3726  RBTree_Control *the_rbtree,
  • cpukit/score/src/schedulercbsallocate.c

    rf839bf5a r5a58b1e  
     1/*
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Allocate
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulerpriority.c

    rf839bf5a r5a58b1e  
    11/*
    2  *  Scheduler Handler
     2 *  @file
    33 *
     4 *  @brief Initialize Scheduler Priority
     5 *  @ingroup ScoreScheduler
     6 */
     7
     8/*
    49 *  Copyright (C) 2010 Gedare Bloom.
    510 *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/schedulersimpleunblock.c

    rf839bf5a r5a58b1e  
     1/**
     2 * @file
     3 *
     4 * @brief Scheduler Simple Handler / Unblock
     5 * @ingroup ScoreScheduler
     6 */
     7
    18/*
    2  *  Scheduler Simple Handler / Unblock
    3  *
    49 *  COPYRIGHT (c) 2011.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/threadhandler.c

    rf839bf5a r5a58b1e  
    22 *  @file
    33 *
    4  *  Initialization Wrapper for all Threads.
     4 *  @brief Thread Handler
     5 *  @ingroup ScoreThread
    56 */
    67
     
    5859#endif
    5960
    60 /*
    61  *  _Thread_Handler
    62  *
    63  *  This routine is the "primal" entry point for all threads.
    64  *  _Context_Initialize() dummies up the thread's initial context
    65  *  to cause the first Context_Switch() to jump to _Thread_Handler().
    66  *
    67  *  This routine is the default thread exitted error handler.  It is
    68  *  returned to when a thread exits.  The configured fatal error handler
    69  *  is invoked to process the exit.
    70  *
    71  *  NOTE:
    72  *
    73  *  On entry, it is assumed all interrupts are blocked and that this
    74  *  routine needs to set the initial isr level.  This may or may not
    75  *  actually be needed by the context switch routine and as a result
    76  *  interrupts may already be at there proper level.  Either way,
    77  *  setting the initial isr level properly here is safe.
    78  *
    79  *  Input parameters:   NONE
    80  *
    81  *  Output parameters:  NONE
    82  */
    8361void _Thread_Handler( void )
    8462{
  • cpukit/score/src/threadinitialize.c

    rf839bf5a r5a58b1e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Initialize Thread
     5 *  @ingroup ScoreThread
     6 */
    17/*
    2  *  Thread Handler / Thread Initialize
    3  *
    48 *  COPYRIGHT (c) 1989-2011.
    59 *  On-Line Applications Research Corporation (OAR).
     
    2933#include <rtems/score/watchdog.h>
    3034#include <rtems/score/wkspace.h>
    31 
    32 /*
    33  *  _Thread_Initialize
    34  *
    35  *  This routine initializes the specified the thread.  It allocates
    36  *  all memory associated with this thread.  It completes by adding
    37  *  the thread to the local object table so operations on this
    38  *  thread id are allowed.
    39  */
    4035
    4136bool _Thread_Initialize(
  • cpukit/score/src/timespecsubtract.c

    rf839bf5a r5a58b1e  
    11/**
    22 *  @file  score/src/timespecsubtract.c
     3 *
     4 *  @brief Subtract Two Timespec
     5 *  @ingroup Timespec
    36 */
    47
  • cpukit/score/src/ts64divide.c

    rf839bf5a r5a58b1e  
    11/**
    2  *  @file  score/src/ts64divide.c
     2 *  @file
     3 *
     4 *  @brief Divide Timestamp
     5 *  @ingroup SuperCore
    36 */
    47
  • cpukit/score/src/ts64equalto.c

    rf839bf5a r5a58b1e  
    11/**
    2  * @file score/src/ts64equalto.c
    3 */
     2 *  @file
     3 *
     4 *  @brief Timestamp equal to Operator
     5 *  @ingroup SuperCore
     6 */
    47
    58/*
  • cpukit/score/src/watchdogadjusttochain.c

    rf839bf5a r5a58b1e  
    11/**
    2  *  @file watchdogadjusttochain.c
     2 *  @file
    33 *
    4  *  This is used by the Timer Server task.
     4 *  @brief Watchdog Adjust to Chain
     5 *  @ingroup ScoreWatchdog
    56 */
    67
    7 /*  COPYRIGHT (c) 1989-2009.
     8/*
     9 *  COPYRIGHT (c) 1989-2009.
    810 *  On-Line Applications Research Corporation (OAR).
    911 *
Note: See TracChangeset for help on using the changeset viewer.