Changeset 52adc808 in rtems


Ignore:
Timestamp:
Dec 2, 2012, 4:03:09 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
43e0599
Parents:
5a58b1e
git-author:
Alex Ivanov <alexivanov97@…> (12/02/12 16:03:09)
git-committer:
Joel Sherrill <joel.sherrill@…> (12/02/12 16:03:09)
Message:

score misc: Clean up Doxygen #12 (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/8025203

Location:
cpukit/rtems
Files:
30 edited

Legend:

Unmodified
Added
Removed
  • cpukit/rtems/include/rtems/rtems/event.h

    r5a58b1e r52adc808  
    436436#define EVENT_CURRENT  0
    437437
     438/**
     439 *  @brief Event Manager Initialization
     440 *
     441 *  This routine performs the initialization necessary for this manager.
     442 */
    438443void _Event_Manager_initialization( void );
    439444
  • cpukit/rtems/include/rtems/rtems/intr.h

    r5a58b1e r52adc808  
    6464
    6565/**
    66  *  @brief Implementation of the rtems_interrupt_catch directive.
     66 *  @brief RTEMS Interrupt Catch
    6767 *
    6868 *  This directive installs @a new_isr_handler as the RTEMS interrupt service
    6969 *  routine for the interrupt vector with number @a vector.  The previous RTEMS
    7070 *  interrupt service routine is returned in @a old_isr_handler.
     71 * 
     72 *  @param[in] new_isr_handler is the address of interrupt service routine
     73 *  @param[in] vector is the interrupt vector number
     74 *  @param[in] old_isr_handler address at which to store previous ISR address
     75 *
     76 *  @return RTEMS_SUCCESSFUL and *old_isr_handler filled with previous ISR
     77 *              address
    7178 */
    7279rtems_status_code rtems_interrupt_catch(
     
    7885
    7986/**
    80  *  @brief Disables all maskable interrupts and returns the previous level in
    81  *  @a _isr_cookie.
     87 *  @brief Disable RTEMS Interrupt
    8288 *
    8389 *  @note The interrupt level shall be of type @ref rtems_interrupt_level.
     
    8793
    8894/**
    89  *  @brief Enables maskable interrupts to the level indicated by @a
    90  *  _isr_cookie.
     95 *  @brief Enable RTEMS Interrupt
    9196 *
    9297 *  @note The interrupt level shall be of type @ref rtems_interrupt_level.
     
    96101
    97102/**
    98  *  @brief Temporarily enables maskable interrupts to the level in @a
    99  *  _isr_cookie before redisabling them.
     103 *  @brief Flash RTEMS Interrupt
    100104 *
    101105 *  @note The interrupt level shall be of type @ref rtems_interrupt_level.
     
    105109
    106110/**
    107  *  @brief Returns true if the processor is currently servicing an interrupt
    108  *  and false otherwise.
     111 *  @brief RTEMS Interrupt Is in Progress
    109112 *
    110113 *  A return value of true indicates that the caller is an interrupt service
  • cpukit/rtems/include/rtems/rtems/message.h

    r5a58b1e r52adc808  
    169169
    170170/**
    171  *  @brief rtems_message_queue_urgent
     171 *  @brief RTEMS Urgent Message Queue
    172172 *
    173173 *  This routine implements the rtems_message_queue_urgent directive.
     
    176176 *  be placed at the FRONT of the chain of pending messages rather
    177177 *  than at the REAR.
     178 *
     179 *  @param[in] id is the pointer to message queue
     180 *  @param[in] buffer is the pointer to message buffer
     181 *  @param[in] size is the size of message to send urgently
     182 *
     183 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
    178184 */
    179185rtems_status_code rtems_message_queue_urgent(
     
    184190
    185191/**
    186  *  @brief rtems_message_queue_broadcast
     192 *  @brief RTEMS Broadcast Message Queue
    187193 *
    188194 *  This routine implements the rtems_message_queue_broadcast directive.
     
    190196 *  waiting for a message on the message queue indicated by ID.
    191197 *  If no tasks are waiting, then the message buffer will not be queued.
     198 *
     199 *  @param[in] id is the pointer to message queue
     200 *  @param[in] buffer is the pointer to message buffer
     201 *  @param[in] size is the size of message to broadcast
     202 *  @param[in] count pointer to area to store number of threads made ready
     203 *
     204 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
     205 *              *count filled in with number of threads made ready
    192206 */
    193207rtems_status_code rtems_message_queue_broadcast(
  • cpukit/rtems/include/rtems/rtems/part.h

    r5a58b1e r52adc808  
    112112
    113113/**
    114  *  @brief rtems_partition_ident
     114 *  @brief RTEMS Partition Ident
    115115 *
    116116 *  This routine implements the rtems_partition_ident directive.
     
    121121 *  The search can be limited to a particular node or allowed to
    122122 *  encompass all nodes.
     123 *
     124 *  @param[in] name is the user defined partition name
     125 *  @param[in] node is(are) the node(s) to be searched
     126 *  @param[in] id is the pointer to partition id
     127 *
     128 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
     129 *              *id filled in with the partition id
    123130 */
    124131rtems_status_code rtems_partition_ident(
  • cpukit/rtems/include/rtems/rtems/ratemon.h

    r5a58b1e r52adc808  
    392392
    393393/**
    394  *  @brief _Rate_monotonic_Timeout
     394 *  @brief Rate Monotonic Timeout
    395395 *
    396396 *  This routine is invoked when the period represented
     
    400400 *  period to expire, then the period is placed in the EXPIRED
    401401 *  state and not restarted.
     402 *
     403 *  @param[in] id is the period id
    402404 */
    403405void _Rate_monotonic_Timeout(
  • cpukit/rtems/include/rtems/rtems/region.h

    r5a58b1e r52adc808  
    218218
    219219/**
    220  *  @brief rtems_region_resize_segment
     220 *  @brief Resize RTEMS Region Segment
    221221 *
    222222 *  This routine implements the rtems_region_resize_segment directive.  It
     
    229229 *  many subsequent tasks as possible will be unblocked with their requests
    230230 *  satisfied.
    231  *  Returns:
    232  *    RTEMS_SUCCESSFUL  - operation successful
    233  *    RTEMS_UNSATISFIED - the segment can't be resized in place
    234  *    any other code    - failure.
    235  *  On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the
    236  *  'old_size' the old size in bytes of the user memory area of the specified
    237  *  segment.
     231 *
     232 *  @param[in] id is the region id
     233 *  @param[in] segmet is the pointer to segment address
     234 *  @param[in] size is the new required size
     235 *  @return RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the
     236 *      the segment can't be resized in place or any other code atfailure
     237 *
     238 *  @note On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the
     239 *      'old_size' the old size in bytes of the user memory area of the
     240 *      specified segment.
    238241 */
    239242rtems_status_code rtems_region_resize_segment(
  • cpukit/rtems/include/rtems/rtems/sem.h

    r5a58b1e r52adc808  
    186186
    187187/**
    188  *  @brief rtems_semaphore_flush
     188 *  @brief RTEMS Semaphore Flush
     189 *
     190 *  DESCRIPTION:
     191 *  This package is the implementation of the flush directive
     192 *  of the Semaphore Manager.
     193 *
     194 *  This directive allows a thread to flush the threads
    189195 *  pending on the semaphore.
     196 *
     197 *  @param[in] id is the semaphore id
     198 *
     199 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
    190200 */
    191201rtems_status_code rtems_semaphore_flush(
  • cpukit/rtems/include/rtems/rtems/semmp.h

    r5a58b1e r52adc808  
    6464
    6565/**
    66  *  @brief Semaphore_MP_Send_process_packet
     66 *  @brief Semaphore MP Send Process Packet
    6767 *
    6868 *  This routine performs a remote procedure call so that a
     
    7777
    7878/**
    79  *  @brief Semaphore_MP_Send_request_packet
     79 *  @brief Semaphore MP Send Request Packet
    8080 *
    8181 *  This routine performs a remote procedure call so that a
     
    9090
    9191/**
    92  *  @brief Semaphore_MP_Send_response_packet
     92 *  @brief Semaphore MP Send Response Packet
    9393 *
    9494 *  This routine performs a remote procedure call so that a
     
    102102
    103103/**
    104  *  @brief Semaphore_MP_Process_packet
     104 *  @brief Semaphore MP Process Packet
    105105 *
    106106 *  This routine performs the actions specific to this package for
     
    112112
    113113/**
    114  *  @brief Semaphore_MP_Send_object_was_deleted
     114 *  @brief Semaphore MP Send Object was Deleted
    115115 *
    116116 *  This routine is invoked indirectly by the thread queue
     
    123123
    124124/**
    125  *  @brief Semaphore_MP_Send_extract_proxy
     125 *  @brief Semaphore MP Send Extract Proxy
    126126 *
    127127 *  This routine is invoked when a task is deleted and it
     
    134134
    135135/**
    136  *  @brief Semaphore_MP_Get_packet
     136 *  @brief Semaphore MP Get Packet
    137137 *
    138138 *  This function is used to obtain a semaphore mp packet.
     
    141141
    142142/**
    143  * @brief _Semaphore_Core_mutex_mp_support
     143 * @brief Semaphore Core Mutex MP Support
    144144 *
    145145 *  This function processes the global actions necessary for remote
    146146 *  accesses to a global semaphore based on a core mutex.  This function
    147147 *  is called by the core.
     148 *
     149 *  @param[in] the_thread the remote thread the semaphore was surrendered to
     150 *  @param[in] id is the id of the surrendered semaphore
    148151 */
    149152void  _Semaphore_Core_mutex_mp_support (
     
    153156
    154157/**
    155  *  @brief Semaphore_Core_mp_support
     158 *  @brief Semaphore Core MP Support
    156159 *
    157160 *  This function processes the global actions necessary for remote
    158161 *  accesses to a global semaphore based on a core semaphore.  This function
    159162 *  is called by the core.
     163 *
     164 *  @param[in] the_thread the remote thread the semaphore was surrendered to
     165 *  @param[in] id is the id of the surrendered semaphore
    160166 */
    161167void  _Semaphore_Core_semaphore_mp_support (
  • cpukit/rtems/include/rtems/rtems/tasks.h

    r5a58b1e r52adc808  
    241241
    242242/**
    243  *  @brief _RTEMS_tasks_Manager_initialization
     243 *  @brief RTEMS Task Manager Initialization
    244244 *
    245245 *  This routine initializes all Task Manager related data structures.
     
    248248
    249249/**
    250  *  @brief rtems_task_create
     250 *  @brief RTEMS Task Create
    251251 *
    252252 *  This routine implements the rtems_task_create directive.  The task
     
    256256 *  execution with initial_priority and initial_modes.  It returns the
    257257 *  id of the created task in ID.
     258 *
     259 *  @param[in] name is the user defined thread name
     260 *  @param[in] initial_priority is the thread priority
     261 *  @param[in] stack_size is the stack size in bytes
     262 *  @param[in] initial_modes is the initial thread mode
     263 *  @param[in] attribute_set is the thread attributes
     264 *  @param[in] id is the pointer to thread id
     265 *
     266 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
     267 *              and *id thread id filled in
    258268 */
    259269rtems_status_code rtems_task_create(
     
    393403
    394404/**
    395  *  @brief rtems_task_wake_when
     405 *  @brief RTEMS Task Wake When
    396406 *
    397407 *  This routine implements the rtems_task_wake_when directive.  The
    398408 *  calling task is blocked until the current time of day is
    399409 *  equal to that indicated by time_buffer.
     410 *
     411 *  @param[in] time_buffer is the pointer to the time and date structure
     412 *
     413 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
    400414 */
    401415rtems_status_code rtems_task_wake_when(
     
    404418
    405419/**
    406  *  @brief rtems_task_wake_after
     420 *  @brief RTEMS Task Wake After
    407421 *
    408422 *  This routine implements the rtems_task_wake_after directive.  The
    409423 *  calling task is blocked until the indicated number of clock
    410424 *  ticks have occurred.
     425 *
     426 *  @param[in] ticks is the number of ticks to wait
     427 *  @return RTEMS_SUCCESSFUL
    411428 */
    412429rtems_status_code rtems_task_wake_after(
     
    447464
    448465/**
    449  *  @brief rtems_task_variable_delete
     466 *  @brief RTEMS Delete Task Variable
    450467 *
    451468 *  This directive removes a per task variable.
     
    464481
    465482/**
    466  *  @brief _RTEMS_tasks_Initialize_user_tasks
     483 *  @brief RTEMS User Task Initialization
    467484 *
    468485 *  This routine creates and starts all configured user
    469486 *  initialization threads.
    470  *
    471  *  Input parameters: NONE
    472  *
    473  *  Output parameters:  NONE
    474487 */
    475488void _RTEMS_tasks_Initialize_user_tasks( void );
  • cpukit/rtems/include/rtems/rtems/timer.h

    r5a58b1e r52adc808  
    384384
    385385/**
    386  *  @brief rtems_timer_get_information
     386 *  @brief RTEMS Get Timer Information
    387387 *
    388388 *  This routine implements the rtems_timer_get_information directive.
    389389 *  This directive returns information about the timer.
     390 *
     391 *  @param[in] id is the timer id
     392 *  @param[in] the_info is the pointer to timer information block
     393 *
     394 *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
     395 *              *the_info region information block filled in
    390396 */
    391397rtems_status_code rtems_timer_get_information(
  • cpukit/rtems/src/clockgetsecondssinceepoch.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Obtain Seconds Since Epoch
     5 *  @ingroup ClassicClock
     6 */
     7
    18/*
    2  *  Clock Manager - Get Seconds Since Epoch
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/clockgettickspersecond.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Obtain Ticks Per Seconds
     5 *  @ingroup ClassicClock
     6 */
     7
    18/*
    2  *  Clock Manager - Get Ticks Per Second
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/event.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Event Manager Initialization
     5 *  @ingroup ClassicEvent
     6 */
     7
    18/*
    2  *  Event Manager
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2429#include <rtems/rtems/tasks.h>
    2530
    26 /*
    27  *  _Event_Manager_initialization
    28  *
    29  *  DESCRIPTION:
    30  *
    31  *  This routine performs the initialization necessary for this manager.
    32  */
    33 
    3431void _Event_Manager_initialization( void )
    3532{
  • cpukit/rtems/src/intrbody.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Interrupt Support
     5 *  @ingroup ClassicINTR
     6 */
     7
    18/*
    2  *  Bodies for Inlined Interrupt Manager Routines
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2024#include <rtems/rtems/intr.h>
    2125
    22 /*
    23  *  Real body for rtems_interrupt_disable
    24  */
    25 
    2626#undef rtems_interrupt_disable
    2727
     
    3535}
    3636
    37 /*
    38  *  Real body for rtems_interrupt_enable
    39  */
    40 
    4137#undef rtems_interrupt_enable
    4238
     
    4743  _ISR_Enable( previous_level );
    4844}
    49 
    50 /*
    51  *  Real body for rtems_interrupt_flash
    52  */
    5345
    5446#undef rtems_interrupt_flash
     
    6153}
    6254
    63 /*
    64  *  Real body for rtems_interrupt_is_in_progress
    65  */
    66 
    6755#undef rtems_interrupt_is_in_progress
    6856
  • cpukit/rtems/src/intrcatch.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Interrupt Catch
     5 *  @ingroup ClassicINTR
     6 */
     7
    18/*
    2  *  Interrupt Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2125
    2226#if (CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE)
    23 
    24 /*  rtems_interrupt_catch
    25  *
    26  *  This directive allows a thread to specify what action to take when
    27  *  catching signals.
    28  *
    29  *  Input parameters:
    30  *    new_isr_handler - address of interrupt service routine (isr)
    31  *    vector          - interrupt vector number
    32  *    old_isr_handler - address at which to store previous ISR address
    33  *
    34  *  Output parameters:
    35  *    RTEMS_SUCCESSFUL - always succeeds
    36  *    *old_isr_handler  - previous ISR address
    37  */
    3827
    3928rtems_status_code rtems_interrupt_catch(
  • cpukit/rtems/src/msgqbroadcast.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Broadcast Message Queue
     5 *  @ingroup ClassicMessageQueue
     6 */
     7
    18/*
    2  *  Message Queue Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3236#include <rtems/rtems/options.h>
    3337#include <rtems/rtems/support.h>
    34 
    35 /*
    36  *  rtems_message_queue_broadcast
    37  *
    38  *  This directive sends a message for every thread waiting on the queue
    39  *  designated by id.
    40  *
    41  *  Input parameters:
    42  *    id     - pointer to message queue
    43  *    buffer - pointer to message buffer
    44  *    size   - size of message to broadcast
    45  *    count  - pointer to area to store number of threads made ready
    46  *
    47  *  Output parameters:
    48  *    count             - number of threads made ready
    49  *    RTEMS_SUCCESSFUL  - if successful
    50  *    error code        - if unsuccessful
    51  */
    5238
    5339rtems_status_code rtems_message_queue_broadcast(
  • cpukit/rtems/src/msgqurgent.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Urgent Message Queue
     5 *  @ingroup ClassicMessageQueue
     6 */
     7
    18/*
    2  *  Message Queue Manager - rtems_message_queue_urgent
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
     
    3136#include <rtems/rtems/options.h>
    3237#include <rtems/rtems/support.h>
    33 
    34 /*
    35  *  rtems_message_queue_urgent
    36  *
    37  *  This routine implements the directives rtems_message_queue_urgent.  It
    38  *  prepends a message to the specified message queue.
    39  *
    40  *  Input parameters:
    41  *    id     - pointer to message queue
    42  *    buffer - pointer to message buffer
    43  *    size   - size of message to send urgently
    44  *
    45  *  Output parameters:
    46  *    RTEMS_SUCCESSFUL - if successful
    47  *    error code       - if unsuccessful
    48  */
    4938
    5039#if defined(RTEMS_MULTIPROCESSING)
  • cpukit/rtems/src/partident.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Partition Name to Id
     5 *  @ingroup ClassicPart
     6 */
     7
    18/*
    2  *  Partition Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2428#include <rtems/score/sysstate.h>
    2529
    26 /*
    27  *  rtems_partition_ident
    28  *
    29  *  This directive returns the system ID associated with
    30  *  the partition name.
    31  *
    32  *  Input parameters:
    33  *    name - user defined partition name
    34  *    node - node(s) to be searched
    35  *    id   - pointer to partition id
    36  *
    37  *  Output parameters:
    38  *    *id               - partition id
    39  *    RTEMS_SUCCESSFUL - if successful
    40  *    error code        - if unsuccessful
    41  */
    42 
    4330rtems_status_code rtems_partition_ident(
    4431  rtems_name  name,
  • cpukit/rtems/src/ratemondata.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Instantiate RTEMS Period Data
     5 *  @ingroup ClassicRateMon
     6 */
     7
    18/*
    2  *  Rate Monotonic Manager -- Instantiate Data
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/ratemontimeout.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Rate Monotonic Timeout
     5 *  @ingroup ClassicRateMon
     6 */
     7
    18/*
    2  *  Rate Monotonic Manager -- Period End Timeout Handler
    3  *
    49 *  COPYRIGHT (c) 1989-2009.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2126#include <rtems/rtems/ratemon.h>
    2227#include <rtems/score/thread.h>
    23 
    24 /*
    25  *  _Rate_monotonic_Timeout
    26  *
    27  *  This routine processes a period ending.  If the owning thread
    28  *  is waiting for the period, that thread is unblocked and the
    29  *  period reinitiated.  Otherwise, the period is expired.
    30  *  This routine is called by the watchdog handler.
    31  *
    32  *  Input parameters:
    33  *    id - period id
    34  *
    35  *  Output parameters: NONE
    36  */
    3728
    3829void _Rate_monotonic_Timeout(
  • cpukit/rtems/src/regionresizesegment.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Resize RTEMS Region Segment
     5 *  @ingroup ClassicRegion
     6 */
     7
    18/*
    2  *  Region Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2428#include <rtems/score/thread.h>
    2529#include <rtems/score/apimutex.h>
    26 
    27 /*
    28  *  rtems_region_resize_segment
    29  *
    30  *  This directive will try to resize segment to the new size 'size'
    31  *  "in place".
    32  *
    33  *  Input parameters:
    34  *    id      - region id
    35  *    segment - pointer to segment address
    36  *    size    - new required size
    37  *
    38  *  Output parameters:
    39  *    RTEMS_SUCCESSFUL - if successful
    40  *    error code       - if unsuccessful
    41  */
    4230
    4331rtems_status_code rtems_region_resize_segment(
  • cpukit/rtems/src/rtemsobjectgetname.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Obtain Object Name as String
     5 *  @ingroup ClassicClassInfo
     6 */
     7
    18/*
    2  *  RTEMS Object Helper -- Obtain Name of Object as String
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
     
    1823#include <rtems/rtems/object.h>
    1924
    20 /*
    21  *  This method obtain the name of an object and returns its name
    22  *  in the form of a C string.  It attempts to be careful about
    23  *  overflowing the user's string and about returning unprintable characters.
    24  */
    2525char *rtems_object_get_name(
    2626  Objects_Id     id,
  • cpukit/rtems/src/semflush.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Semaphore Flush
     5 *  @ingroup ClassicSem
     6 */
     7
    18/*
    2  *  rtems_semaphore_flush
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the flush directive
    7  *  of the Semaphore Manager.
    8  *
    99 *  COPYRIGHT (c) 1989-2007.
    1010 *  On-Line Applications Research Corporation (OAR).
     
    3838
    3939#include <rtems/score/interr.h>
    40 
    41 /*
    42  *  rtems_semaphore_flush
    43  *
    44  *  This directive allows a thread to flush the threads
    45  *  pending on the semaphore.
    46  *
    47  *  Input parameters:
    48  *    id         - semaphore id
    49  *
    50  *  Output parameters:
    51  *    RTEMS_SUCCESSFUL - if successful
    52  *    error code       - if unsuccessful
    53  */
    5440
    5541#if defined(RTEMS_MULTIPROCESSING)
  • cpukit/rtems/src/semmp.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief Semaphore MP Support
     5 *  @ingroup ClassicSEM
     6 */
     7
    18/*
    2  *  Multiprocessing Support for the Semaphore Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3135);
    3236
    33 /*
    34  *  _Semaphore_MP_Send_process_packet
    35  *
    36  */
    37 
    3837void _Semaphore_MP_Send_process_packet (
    3938  Semaphore_MP_Remote_operations  operation,
     
    7776}
    7877
    79 /*
    80  *  _Semaphore_MP_Send_request_packet
    81  *
    82  */
    83 
    8478rtems_status_code _Semaphore_MP_Send_request_packet (
    8579  Semaphore_MP_Remote_operations operation,
     
    129123}
    130124
    131 /*
    132  *  _Semaphore_MP_Send_response_packet
    133  *
    134  */
    135 
    136125void _Semaphore_MP_Send_response_packet (
    137126  Semaphore_MP_Remote_operations  operation,
     
    172161}
    173162
    174 /*
    175  *
    176  *  _Semaphore_MP_Process_packet
    177  *
    178  */
    179 
    180163void _Semaphore_MP_Process_packet (
    181164  rtems_packet_prefix  *the_packet_prefix
     
    258241}
    259242
    260 /*
    261  *  _Semaphore_MP_Send_object_was_deleted
    262  *
    263  */
    264 
    265243void _Semaphore_MP_Send_object_was_deleted (
    266244  Thread_Control *the_proxy
     
    276254
    277255}
    278 
    279 /*
    280  *  _Semaphore_MP_Send_extract_proxy
    281  *
    282  */
    283256
    284257void _Semaphore_MP_Send_extract_proxy (
     
    297270}
    298271
    299 /*
    300  *  _Semaphore_MP_Get_packet
    301  *
    302  */
    303 
    304272Semaphore_MP_Packet *_Semaphore_MP_Get_packet ( void )
    305273{
    306274  return ( (Semaphore_MP_Packet *) _MPCI_Get_packet() );
    307275}
    308 
    309 /*
    310  *  _Semaphore_Core_mutex_mp_support
    311  *
    312  *  Input parameters:
    313  *    the_thread - the remote thread the semaphore was surrendered to
    314  *    id         - id of the surrendered semaphore
    315  *
    316  *  Output parameters: NONE
    317  */
    318276
    319277#if defined(RTEMS_MULTIPROCESSING)
     
    333291#endif
    334292
    335 
    336 /*
    337  *  _Semaphore_Core_semaphore_mp_support
    338  *
    339  *  Input parameters:
    340  *    the_thread - the remote thread the semaphore was surrendered to
    341  *    id         - id of the surrendered semaphore
    342  *
    343  *  Output parameters: NONE
    344  */
    345 
    346293#if defined(RTEMS_MULTIPROCESSING)
    347294void  _Semaphore_Core_semaphore_mp_support (
  • cpukit/rtems/src/taskcreate.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Task Create
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  RTEMS Task Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3135#include <rtems/score/apimutex.h>
    3236
    33 /*
    34  *  rtems_task_create
    35  *
    36  *  This directive creates a thread by allocating and initializing a
    37  *  thread control block and a stack.  The newly created thread is
    38  *  placed in the dormant state.
    39  *
    40  *  Input parameters:
    41  *    name             - user defined thread name
    42  *    initial_priority - thread priority
    43  *    stack_size       - stack size in bytes
    44  *    initial_modes    - initial thread mode
    45  *    attribute_set    - thread attributes
    46  *    id               - pointer to thread id
    47  *
    48  *  Output parameters:
    49  *    id               - thread id
    50  *    RTEMS_SUCCESSFUL - if successful
    51  *    error code       - if unsuccessful
    52  */
    53 
    5437rtems_status_code rtems_task_create(
    5538  rtems_name           name,
  • cpukit/rtems/src/tasks.c

    r5a58b1e r52adc808  
    1 /*
    2  *  RTEMS Task Manager -- Initialize Manager
    3  *
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Task API Extensions
     5 *  @ingroup ClassicTasks
     6 */
     7
     8/*
    49 *  COPYRIGHT (c) 1989-2009.
    510 *  On-Line Applications Research Corporation (OAR).
     
    231236};
    232237
    233 /*
    234  *  _RTEMS_tasks_Manager_initialization
    235  *
    236  *  This routine initializes all Task Manager related data structures.
    237  *
    238  *  Input parameters: NONE
    239  *
    240  *  Output parameters:  NONE
    241  */
    242 
    243238void _RTEMS_tasks_Manager_initialization(void)
    244239{
     
    280275}
    281276
    282 /*
    283  *  _RTEMS_tasks_Initialize_user_tasks
    284  *
    285  *  This routine creates and starts all configured user
    286  *  initialization threads.
    287  *
    288  *  Input parameters: NONE
    289  *
    290  *  Output parameters:  NONE
    291  */
    292 
    293277void _RTEMS_tasks_Initialize_user_tasks( void )
    294278{
  • cpukit/rtems/src/taskvariabledelete.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Delete Task Variable
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  rtems_task_variable_delete - Delete a per-task variable
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    1822#include <rtems/rtems/tasks.h>
    1923#include <rtems/score/wkspace.h>
    20 
    21 /*
    22  *  rtems_task_variable_delete
    23  *
    24  *  This directive removes a task variable.
    25  */
    2624
    2725rtems_status_code rtems_task_variable_delete(
  • cpukit/rtems/src/taskwakeafter.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Task Wake After
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  RTEMS Task Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3135#include <rtems/score/sysstate.h>
    3236
    33 /*
    34  *  rtems_task_wake_after
    35  *
    36  *  This directive suspends the requesting thread for the given amount
    37  *  of ticks.
    38  *
    39  *  Input parameters:
    40  *    ticks - number of ticks to wait
    41  *
    42  *  Output parameters:
    43  *    RTEMS_SUCCESSFUL - always successful
    44  */
    45 
    4637rtems_status_code rtems_task_wake_after(
    4738  rtems_interval ticks
  • cpukit/rtems/src/taskwakewhen.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Task Wake When
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  RTEMS Task Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3034#include <rtems/score/apiext.h>
    3135#include <rtems/score/sysstate.h>
    32 
    33 /*
    34  *  rtems_task_wake_when
    35  *
    36  *  This directive blocks the requesting thread until the given date and
    37  *  time is reached.
    38  *
    39  *  Input parameters:
    40  *    time_buffer - pointer to the time and date structure
    41  *
    42  *  Output parameters:
    43  *    RTEMS_SUCCESSFUL - if successful
    44  *    error code       - if unsuccessful
    45  */
    4636
    4737rtems_status_code rtems_task_wake_when(
  • cpukit/rtems/src/timergetinfo.c

    r5a58b1e r52adc808  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Get Timer Information
     5 *  @ingroup ClassicTimer
     6 */
     7
    18/*
    2  *  Timer Manager - rtems_timer_get_information directive
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2327#include <rtems/score/tod.h>
    2428#include <rtems/score/watchdog.h>
    25 
    26 /*
    27  *  rtems_timer_get_information
    28  *
    29  *  This directive allows a thread to obtain information about a timer.
    30  *
    31  *  Input parameters:
    32  *    id       - timer id
    33  *    the_info - pointer to timer information block
    34  *
    35  *  Output parameters:
    36  *    *the_info        - region information block filled in
    37  *    RTEMS_SUCCESSFUL - if successful
    38  *    error code       - if unsuccessful
    39  *
    40  */
    4129
    4230rtems_status_code rtems_timer_get_information(
Note: See TracChangeset for help on using the changeset viewer.