Changeset e655f7e in rtems


Ignore:
Timestamp:
Nov 29, 2012, 6:39:19 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
1b475860
Parents:
db650357
git-author:
Alex Ivanov <alexivanov97@…> (11/29/12 18:39:19)
git-committer:
Joel Sherrill <joel.sherrill@…> (11/29/12 19:28:46)
Message:

score misc: Score misc: Clean up Doxygen #5

Location:
cpukit
Files:
30 edited

Legend:

Unmodified
Added
Removed
  • cpukit/Doxyfile.in

    rdb650357 re655f7e  
    593593
    594594FILE_PATTERNS          = *.h \
    595                          *.inl
     595                         *.inl \
     596                         *.c
    596597
    597598# The RECURSIVE tag can be used to turn specify whether or not subdirectories
  • cpukit/score/include/rtems/bspsmp.h

    rdb650357 re655f7e  
    144144
    145145/**
     146 *  @brief RTEMS SMP Secondary CPU Initialize
     147 *
    146148 *  This method is the C entry point which secondary CPUs should
    147149 *  arrange to call.  It performs OS initialization for the secondary
     
    163165
    164166/**
     167 *  @brief RTEMS SMP Proccess Interrupt
     168 *
    165169 *  This is the method called by the BSP's interrupt handler
    166170 *  to process the incoming interprocessor request.
  • cpukit/score/include/rtems/score/coremsg.h

    rdb650357 re655f7e  
    289289/**
    290290 *  @brief Close a Message Queue
     291 *
     292 *  DESCRIPTION:
     293 *  This package is the implementation of the CORE Message Queue Handler.
     294 *  This core object provides task synchronization and communication functions
     295 *  via messages passed to queue objects
    291296 *
    292297 *  This function closes a message by returning all allocated space and
     
    307312/**
    308313 *  @brief Flush Pending Messages
     314 *
     315 *  DESCRIPTION:
     316 *  This package is the implementation of the CORE Message Queue Handler.
     317 *  This core object provides task synchronization and communication functions
     318 *  via messages passed to queue objects.
    309319 *
    310320 *  This function flushes @a the_message_queue's pending message queue.  The
     
    350360/**
    351361 *  @brief Broadcast a Message to the Message Queue
     362 *
     363 *  DESCRIPTION:
     364 *  This package is the implementation of the CORE Message Queue Handler.
     365 *  This core object provides task synchronization and communication functions
     366 *  via messages passed to queue objects.
    352367 *
    353368 *  This function sends a message for every thread waiting on the queue and
     
    413428/**
    414429 *  @brief Size a Message from the Message Queue
     430 *
     431 *  DESCRIPTION:
     432 *  This package is the implementation of the CORE Message Queue Handler.
     433 *  This core object provides task synchronization and communication functions
     434 *  via messages passed to queue objects.
    415435 *
    416436 *  This kernel routine dequeues a message, copies the message buffer to
     
    433453 *  @return indication of the successful completion or reason for failure
    434454 *  @note Returns message priority via return are in TCB.
     455 *
     456 *  - INTERRUPT LATENCY:
     457 *    + available
     458 *    + wait
    435459 */
    436460void _CORE_message_queue_Seize(
  • cpukit/score/include/rtems/score/coresem.h

    rdb650357 re655f7e  
    190190
    191191/**
     192 *  @brief Core Semaphore Flush
     193 *
     194 *  DESCRIPTION:
     195 *  This package is the implementation of the CORE Semaphore Handler.
     196 *  This core object utilizes standard Dijkstra counting semaphores to provide
     197 *  synchronization and mutual exclusion capabilities.
     198 *
    192199 *  This routine assists in the deletion of a semaphore by flushing the
    193200 *  associated wait queue.
  • cpukit/score/include/rtems/score/object.h

    rdb650357 re655f7e  
    753753
    754754/**
     755 *  @brief Get Object Information
     756 *
    755757 *  This function return the information structure given
    756758 *  an the API and Class.  This can be done independent of
  • cpukit/score/include/rtems/score/schedulercbs.h

    rdb650357 re655f7e  
    176176
    177177/**
    178  *  @brief _Scheduler_CBS_Attach_thread
     178 *  @brief Attach Scheduler CBS Thread
    179179 *
    180180 *  Attach a task to an already existing server.
     
    285285
    286286/**
    287  *  @brief _Scheduler_CBS_Get_server_id
     287 *  @brief Scheduler CBS Get Server id
    288288 *
    289289 *  Get a thread server id, or SCHEDULER_CBS_ERROR_NOT_FOUND if it is not
  • cpukit/score/include/rtems/score/schedulerpriority.h

    rdb650357 re655f7e  
    137137
    138138/**
     139 *  @brief Scheduler Priority Yield
     140 *
    139141 *  This routine is invoked when a thread wishes to voluntarily
    140142 *  transfer control of the processor to another thread in the queue.
     
    146148 *  timeslice counter is reset.  The heir THREAD will be updated if the
    147149 *  running is also the currently the heir.
     150 *
     151 *  - INTERRUPT LATENCY:
     152 *    + ready chain
     153 *    + select heir
    148154 */
    149155void _Scheduler_priority_Yield( void );
  • cpukit/score/include/rtems/score/thread.h

    rdb650357 re655f7e  
    511511
    512512/**
     513 *  @brief Create Idle Thread
     514 *
    513515 *  This routine creates the idle thread.
    514516 *
     
    518520
    519521/**
     522 *  @brief Start Thread Multitasking
     523 *
    520524 *  This routine initiates multitasking.  It is invoked only as
    521525 *  part of initialization and its invocation is the last act of
    522526 *  the non-multitasking part of the system initialization.
     527 *
     528 *
     529 *  - INTERRUPT LATENCY:
     530 *    + ready chain
     531 *    + select heir
    523532 */
    524533void _Thread_Start_multitasking( void );
     
    561570
    562571/**
     572 *  @brief Deallocate Thread Stack
     573 *
    563574 *  Deallocate the Thread's stack.
    564575 */
     
    656667
    657668/**
     669 *  @brief Clear Thread state
     670 *
    658671 *  This routine clears the indicated STATES for @a the_thread.  It performs
    659672 *  any necessary scheduling operations including the selection of
    660673 *  a new heir thread.
     674 *
     675 *  - INTERRUPT LATENCY:
     676 *    + priority map
     677 *    + select heir
    661678 */
    662679void _Thread_Clear_state(
  • cpukit/score/include/rtems/score/threadmp.h

    rdb650357 re655f7e  
    3333
    3434/**
    35  *  @brief _Thread_MP_Handler_initialization
     35 *  @brief MP Thread Handler Initialization
    3636 *
    3737 *  This routine initializes the multiprocessing portion of the Thread Handler.
     
    4242
    4343/**
    44  *  @brief _Thread_MP_Allocate_proxy
     44 *  @brief MP Thread Proxy Allocate
    4545 *
    4646 *  This  allocates a proxy control block from
     
    5555
    5656/**
    57  *  @brief _Thread_MP_Find_proxy
     57 *  @brief MP Thread Proxy Find
    5858 *
    5959 *  This function removes the proxy control block for the specified
  • cpukit/score/include/rtems/score/timespec.h

    rdb650357 re655f7e  
    104104
    105105/**
    106  * @brief Timespec Less Than Operator
     106 *  @brief Timespec Less Than Operator
    107107 *
    108108 *  This method is the less than operator for timespecs.
  • cpukit/score/src/coremsgbroadcast.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Broadcast a Message to 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-2008.
    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_Broadcast
    33  *
    34  *  This function sends a message for every thread waiting on the queue and
    35  *  returns the number of threads made ready by the message.
    36  *
    37  *  Input parameters:
    38  *    the_message_queue            - message is submitted to this message queue
    39  *    buffer                       - pointer to message buffer
    40  *    size                         - size in bytes of message to send
    41  *    id                           - id of message queue
    42  *    api_message_queue_mp_support - api specific mp support callout
    43  *    count                        - area to store number of threads made ready
    44  *
    45  *  Output parameters:
    46  *    count                         - number of threads made ready
    47  *    CORE_MESSAGE_QUEUE_SUCCESSFUL - if successful
    48  *    error code                    - if unsuccessful
    49  */
    5029
    5130CORE_message_queue_Status _CORE_message_queue_Broadcast(
  • cpukit/score/src/coremsgclose.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Close a 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-1999.
    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_Close
    33  *
    34  *  This function closes a message by returning all allocated space and
    35  *  flushing the message_queue's task wait queue.
    36  *
    37  *  Input parameters:
    38  *    the_message_queue      - the message_queue to be flushed
    39  *    remote_extract_callout - function to invoke remotely
    40  *    status                 - status to pass to thread
    41  *
    42  *  Output parameters:  NONE
    43  */
    4429
    4530void _CORE_message_queue_Close(
  • cpukit/score/src/coremsgflush.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Flush Pending Messages
     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-1999.
    1110 *  On-Line Applications Research Corporation (OAR).
     
    2928#include <rtems/score/wkspace.h>
    3029
    31 /*
    32  *  _CORE_message_queue_Flush
    33  *
    34  *  This function flushes the message_queue's pending message queue.  The
    35  *  number of messages flushed from the queue is returned.
    36  *
    37  *  Input parameters:
    38  *    the_message_queue - the message_queue to be flushed
    39  *
    40  *  Output parameters:
    41  *    returns - the number of messages flushed from the queue
    42  */
    43 
    4430uint32_t   _CORE_message_queue_Flush(
    4531  CORE_message_queue_Control *the_message_queue
  • cpukit/score/src/coremsgseize.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Size a Message from 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-2007.
    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_Seize
    33  *
    34  *  This kernel routine dequeues a message, copies the message buffer to
    35  *  a given destination buffer, and frees the message buffer to the
    36  *  inactive message pool.  The thread will be blocked if wait is true,
    37  *  otherwise an error will be given to the thread if no messages are available.
    38  *
    39  *  Input parameters:
    40  *    the_message_queue - pointer to message queue
    41  *    id                - id of object we are waitig on
    42  *    buffer            - pointer to message buffer to be filled
    43  *    size_p            - pointer to the size of buffer to be filled
    44  *    wait              - true if wait is allowed, false otherwise
    45  *    timeout           - time to wait for a message
    46  *
    47  *  Output parameters:  NONE
    48  *
    49  *  NOTE: Dependent on BUFFER_LENGTH
    50  *
    51  *  INTERRUPT LATENCY:
    52  *    available
    53  *    wait
    54  */
    5529
    5630void _CORE_message_queue_Seize(
  • cpukit/score/src/coresemflush.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Core Semaphore Flush
     5 *  @ingroup ScoreSemaphore
     6 */
     7
    18/*
    2  *  CORE Semaphore Handler
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the CORE Semaphore Handler.
    7  *  This core object utilizes standard Dijkstra counting semaphores to provide
    8  *  synchronization and mutual exclusion capabilities.
    9  *
    109 *  COPYRIGHT (c) 1989-1999.
    1110 *  On-Line Applications Research Corporation (OAR).
     
    2726#include <rtems/score/threadq.h>
    2827
    29 /*
    30  *  _CORE_semaphore_Flush
    31  *
    32  *  This function a flushes the semaphore's task wait queue.
    33  *
    34  *  Input parameters:
    35  *    the_semaphore          - the semaphore to be flushed
    36  *    remote_extract_callout - function to invoke remotely
    37  *    status                 - status to pass to thread
    38  *
    39  *  Output parameters:  NONE
    40  */
    41 
    4228void _CORE_semaphore_Flush(
    4329  CORE_semaphore_Control     *the_semaphore,
  • cpukit/score/src/isrsmp.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Initialize, Disable, Enable, Flash, Enter, Exit ISR Implementation
     5 *  @ingroup ScoreISR
     6 */
     7
    18/*
    2  *  ISR Enable/Disable for SMP Configurations
    3  *
    49 *  COPYRIGHT (c) 1989-2011.
    510 *  On-Line Applications Research Corporation (OAR).
     
    5863}
    5964
    60 /*
    61  *  Return values:
    62  *     0 - simple return
    63  *     1 - dispatching return
    64  */
    6565int _ISR_SMP_Exit(void)
    6666{
  • cpukit/score/src/objectgetinfo.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Get Object Information
     5 *  @ingroup ScoreObject
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2008.
  • cpukit/score/src/schedulercbsattachthread.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Attach Scheduler CBS Thread
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulercbsgetserverid.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler CBS Get Server id
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/scheduleredfschedule.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler EDF Allocate
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  Copyright (C) 2011 Petr Benes.
  • cpukit/score/src/schedulerpriorityyield.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Priority Yield
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    2  *  Scheduler Priority Handler / Yield
    3  *
    49 *  Copyright (C) 2010 Gedare Bloom.
    510 *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
     
    1924#include <rtems/score/schedulerpriority.h>
    2025#include <rtems/score/thread.h>
    21 
    22 /*
    23  *  INTERRUPT LATENCY:
    24  *    ready chain
    25  *    select heir
    26  */
    2726
    2827void _Scheduler_priority_Yield(void)
  • cpukit/score/src/schedulersimplesmptick.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Scheduler Simple SMP Tick Method
     5 *  @ingroup ScoreScheduler
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2009.
  • cpukit/score/src/smp.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief SMP Support
     5 *  @ingroup Score
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 1989-2011.
     
    4350}
    4451
    45 /*
    46  *  Process request to initialize this secondary core.
    47  */
    4852void rtems_smp_secondary_cpu_initialize(void)
    4953{
     
    9195}
    9296
    93 /*
    94  *  Process an interrupt processor interrupt which indicates a request
    95  *  from another core.
    96  */
    9797void rtems_smp_process_interrupt(void)
    9898{
     
    180180}
    181181
    182 /*
    183  *  Send interrupt processor request to all other nodes
    184  */
    185182void _SMP_Broadcast_message(
    186183  uint32_t  message
     
    203200}
    204201
    205 /*
    206  *  Send interrupt processor requests to perform first context switch
    207  */
    208202void _SMP_Request_other_cores_to_perform_first_context_switch(void)
    209203{
     
    216210}
    217211
    218 /*
    219  *  Send message to other cores requesting them to perform
    220  *  a thread dispatch operation.
    221  */
    222212void _SMP_Request_other_cores_to_dispatch(void)
    223213{
     
    240230}
    241231
    242 /*
    243  *  Send message to other cores requesting them to shutdown.
    244  */
    245232void _SMP_Request_other_cores_to_shutdown(void)
    246233{
  • cpukit/score/src/threadclearstate.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Clear Thread state
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler / Thread Clear State
    3  *
    49 *  COPYRIGHT (c) 1989-2011.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2833#include <rtems/score/wkspace.h>
    2934
    30 /*
    31  *  INTERRUPT LATENCY:
    32  *    priority map
    33  *    select heir
    34  */
    3535void _Thread_Clear_state(
    3636  Thread_Control *the_thread,
  • cpukit/score/src/threadcreateidle.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Create Idle Thread
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2011.
    610 *  On-Line Applications Research Corporation (OAR).
  • cpukit/score/src/threadmp.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Distributed MP Support
     5 *  @ingroup ScoreThreadMP
     6 */
     7
    18/*
    2  *  Multiprocessing Support for the Thread Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2006.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2125#include <rtems/score/wkspace.h>
    2226#include <rtems/score/isr.h>
    23 
    24 /*
    25  *  _Thread_MP_Handler_initialization
    26  *
    27  */
    2827
    2928void _Thread_MP_Handler_initialization (
     
    5049
    5150}
    52 
    53 /*
    54  *  _Thread_MP_Allocate_proxy
    55  *
    56  */
    5751
    5852Thread_Control *_Thread_MP_Allocate_proxy (
     
    10094  return NULL;
    10195}
    102 
    103 /*
    104  *  _Thread_MP_Find_proxy
    105  *
    106  */
    10796
    10897/*
  • cpukit/score/src/threadstackfree.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Deallocate Thread Stack
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2933#include <rtems/config.h>
    3034
    31 /*
    32  *  _Thread_Stack_Free
    33  *
    34  *  Deallocate the Thread's stack.
    35  */
    36 
    3735void _Thread_Stack_Free(
    3836  Thread_Control *the_thread
  • cpukit/score/src/threadstartmultitasking.c

    rdb650357 re655f7e  
     1/**
     2 *  @file
     3 *
     4 *  @brief Start Thread Multitasking
     5 *  @ingroup ScoreThread
     6 */
     7
    18/*
    2  *  Thread Handler
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2006.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2731#include <rtems/score/threadq.h>
    2832#include <rtems/score/wkspace.h>
    29 
    30 /*
    31  *  _Thread_Start_multitasking
    32  *
    33  *  This kernel routine readies the requested thread, the thread chain
    34  *  is adjusted.  A new heir thread may be selected.
    35  *
    36  *  Input parameters:
    37  *    system_thread - pointer to system initialization thread control block
    38  *    idle_thread   - pointer to idle thread control block
    39  *
    40  *  Output parameters:  NONE
    41  *
    42  *  NOTE:  This routine uses the "blocking" heir selection mechanism.
    43  *         This ensures the correct heir after a thread restart.
    44  *
    45  *  INTERRUPT LATENCY:
    46  *    ready chain
    47  *    select heir
    48  */
    4933
    5034void _Thread_Start_multitasking( void )
  • cpukit/score/src/timespeclessthan.c

    rdb650357 re655f7e  
    11/**
    2  *  @file  score/src/timespeclessthan.c
     2 *  @file
     3 *
     4 *  @brief Timespec Less Than Operator
     5 *  @ingroup Timespec
    36 */
    47
  • cpukit/score/src/watchdogreportchain.c

    rdb650357 re655f7e  
    11/**
    2  *  @file watchdogreportchain.c
     2 *  @file
    33 *
    4  *  This should only be used for debugging.
     4 *  @brief Report Information on a Watchdog Chain
     5 *  @ingroup ScoreWatchdog
    56 */
    67
Note: See TracChangeset for help on using the changeset viewer.