Changeset 60ceb61 in rtems


Ignore:
Timestamp:
Dec 5, 2012, 11:15:32 PM (7 years ago)
Author:
Alex Ivanov <alexivanov97@…>
Branches:
4.11, master
Children:
a6500136
Parents:
9465fca
git-author:
Alex Ivanov <alexivanov97@…> (12/05/12 23:15:32)
git-committer:
Gedare Bloom <gedare@…> (12/05/12 23:15:32)
Message:

rtems misc: Clean up Doxygen GCI Task #6

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

Location:
cpukit/rtems
Files:
27 edited

Legend:

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

    r9465fca r60ceb61  
    126126
    127127/**
    128  *  @brief rtems_barrier_delete
     128 *  @brief RTEMS Delete Barrier
    129129 *
    130130 *  This routine implements the rtems_barrier_delete directive.  The
    131  *  barrier indicated by @a id is deleted.
     131 *  barrier indicated by @a id is deleted.  The barrier is freed back to the
     132 *  inactive barrier chain.
     133 *
    132134 *
    133135 *  @param[in] id indicates the barrier to delete
  • cpukit/rtems/include/rtems/rtems/dpmem.h

    r9465fca r60ceb61  
    8585
    8686/**
    87  *  @brief rtems_port_create
     87 *  @brief RTEMS Create Port
    8888 *
    8989 *  This routine implements the rtems_port_create directive.  The port
     
    9292 *  as the internal and external starting addresses, respectively.
    9393 *  It returns the id of the created port in ID.
     94 *
     95 *  @param[in] name is the user defined port name
     96 *  @param[in] internal_start is the internal start address of port
     97 *  @param[in] external_start is the external start address of port
     98 *  @param[in] length is the physical length in bytes
     99 *  @param[in] id is the address of port id to set
     100 *
     101 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     102 *          error.  Otherwise, a status code is returned indicating the
     103 *          source of the error.  If successful, the id will
     104 *          be filled in with the port id.
    94105 */
    95106rtems_status_code rtems_port_create(
     
    119130
    120131/**
    121  *  @brief rtems_port_delete
     132 *  @brief RTEMS Delete Port
    122133 *
    123134 *  This routine implements the rtems_port_delete directive.  It deletes
    124135 *  the port associated with ID.
     136 *
     137 *  @param[in] id is the dual-ported memory area id
     138 *
     139 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     140 *          error.  Otherwise, a status code is returned indicating the
     141 *          source of the error.
    125142 */
    126143rtems_status_code rtems_port_delete(
  • cpukit/rtems/include/rtems/rtems/modes.h

    r9465fca r60ceb61  
    103103
    104104/**
    105  *  @brief Body for RTEMS_INTERRUPT_LEVEL macro.
     105 *  @brief Body for RTEMS_INTERRUPT_LEVEL Macro
    106106 *
    107107 *  @param[in] level is the desired interrupt level
  • cpukit/rtems/include/rtems/rtems/part.h

    r9465fca r60ceb61  
    8585
    8686/**
    87  *  @brief Partition_Manager_initialization
     87 *  @brief Partition Manager Initialization
    8888 *
    8989 *  This routine performs the initialization necessary for this manager.
  • cpukit/rtems/include/rtems/rtems/region.h

    r9465fca r60ceb61  
    110110
    111111/**
    112  *  @brief rtems_region_extend
     112 *  @brief RTEMS Extend Region
    113113 *
    114114 *  This routine implements the rtems_region_extend directive.  The
     
    116116 *  the region will be attempted to be grown by length bytes using
    117117 *  the memory starting at starting_address.
     118 *
     119 *  @param[in] id is the id of region to grow
     120 *  @param[in] starting_address starting address of memory area for extension
     121 *  @param[in] length is the physical length in bytes to grow the region
     122 *
     123 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     124 *          error.  Otherwise, a status code is returned indicating the
     125 *          source of the error.
    118126 */
    119127rtems_status_code rtems_region_extend(
     
    124132
    125133/**
    126  *  @brief rtems_region_ident
     134 *  @brief RTEMS Region Name to Id
    127135 *
    128136 *  This routine implements the rtems_region_ident directive.
     
    130138 *  If more than one region is named name, then the region
    131139 *  to which the ID belongs is arbitrary.
     140 *
     141 *  @param[in] name is the user defined region name
     142 *  @param[in] id is the pointer to region id
     143 *
     144 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     145 *          error.  Otherwise, a status code is returned indicating the
     146 *          source of the error.  If successful, the id will
     147 *          be filled in with the region id.
    132148 */
    133149rtems_status_code rtems_region_ident(
     
    167183
    168184/**
    169  *  @brief rtems_region_delete
     185 *  @brief RTEMS Delete Region
    170186 *
    171187 *  This routine implements the rtems_region_delete directive.  The
    172  *  region indicated by ID is deleted.
     188 *  region indicated by ID is deleted, provided that none of its segments are
     189 *  still allocated.
     190 *
     191 *  @param[in] id is the region id
     192 *
     193 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     194 *          error.  Otherwise, a status code is returned indicating the
     195 *          source of the error.
    173196 */
    174197rtems_status_code rtems_region_delete(
     
    207230
    208231/**
    209  *  @brief rtems_region_get_segment_size
     232 *  @brief RTEMS Get Region Segment Size
    210233 *
    211234 *  This routine implements the rtems_region_get_segment_size directive.  It
    212235 *  returns the size in bytes of the specified user memory area.
     236 * 
     237 *  @param[in] id is the region id
     238 *  @param[in] segment is the segment address
     239 *  @param[in] size is the pointer to segment size in bytes
     240 *
     241 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     242 *          error.  Otherwise, a status code is returned indicating the
     243 *          source of the error.  If successful, the size will
     244 *          be filled in with the segment size in bytes.
    213245 */
    214246rtems_status_code rtems_region_get_segment_size(
  • cpukit/rtems/include/rtems/rtems/sem.h

    r9465fca r60ceb61  
    230230
    231231/**
    232  *  @brief _Semaphore_Translate_core_mutex_return_code
     232 *  @brief Semaphore Translate Core Mutex Return Code
    233233 *
    234234 *  This function returns a RTEMS status code based on the mutex
    235235 *  status code specified.
     236 * 
     237 *  @param[in] the_mutex_status is the mutex status code to translate
     238 *
     239 *  @return translated RTEMS status code
    236240 */
    237241rtems_status_code _Semaphore_Translate_core_mutex_return_code (
     
    240244
    241245/**
    242  *  @brief _Semaphore_Translate_core_semaphore_return_code
     246 *  @brief Semaphore Translate Core Semaphore Return Code
    243247 *
    244248 *  This function returns a RTEMS status code based on the semaphore
    245249 *  status code specified.
     250 *
     251 *  @param[in] status is the semaphore status code to translate
     252 *
     253 *  @return translated RTEMS status code
    246254 */
    247255rtems_status_code _Semaphore_Translate_core_semaphore_return_code (
  • cpukit/rtems/include/rtems/rtems/tasks.h

    r9465fca r60ceb61  
    279279
    280280/**
    281  *  @brief rtems_task_ident
     281 *  @brief RTEMS Task Name to Id
    282282 *
    283283 *  This routine implements the rtems_task_ident directive.
     
    288288 *  The search can be limited to a particular node or allowed to
    289289 *  encompass all nodes.
     290 *
     291 *  @param[in] name is the user defined thread name
     292 *  @param[in] node is(are) the node(s) to be searched
     293 *  @param[in] id is the pointer to thread id
     294 *
     295 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     296 *          error.  Otherwise, a status code is returned indicating the
     297 *          source of the error.  If successful, the id will
     298 *          be filled in with the thread id.
    290299 */
    291300rtems_status_code rtems_task_ident(
     
    296305
    297306/**
    298  *  @brief rtems_task_delete
     307 *  @brief RTEMS Delete Task
    299308 *
    300309 *  This routine implements the rtems_task_delete directive.  The
    301  *  task indicated by ID is deleted.
     310 *  task indicated by ID is deleted. The executive halts execution
     311 *  of the thread and frees the thread control block.
     312 * 
     313 *  @param[in] id is the thread id
     314 *
     315 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     316 *          error and id is not the requesting thread.  Status code is
     317 *          returned indicating the source of the error.  Nothing
     318 *          is returned if id is the requesting thread (always succeeds).
    302319 */
    303320rtems_status_code rtems_task_delete(
     
    377394
    378395/**
    379  *  @brief rtems_task_suspend
     396 *  @brief RTEMS Suspend Task
    380397 *
    381398 *  This routine implements the rtems_task_suspend directive.  The
    382  *  SUSPENDED state is set for task associated with ID.
     399 *  SUSPENDED state is set for task associated with ID. Note that the
     400 *  suspended state can be in addition to other waiting states.
     401 *
     402 *  @param[in] id is the thread id
     403 *
     404 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     405 *          error.  Otherwise, a status code is returned indicating the
     406 *          source of the error.
    383407 */
    384408rtems_status_code rtems_task_suspend(
     
    523547
    524548/**
    525  *  @brief _RTEMS_Tasks_Invoke_task_variable_dtor
     549 *  @brief RTEMS Tasks Invoke Task Variable Destructor
    526550 *
    527551 *  This routine invokes the optional user provided destructor on the
    528552 *  task variable and frees the memory for the task variable.
    529  *
    530  *  Input parameters: NONE
    531  *
    532  *  Output parameters:  NONE
    533553 */
    534554void _RTEMS_Tasks_Invoke_task_variable_dtor(
  • cpukit/rtems/include/rtems/rtems/timer.h

    r9465fca r60ceb61  
    223223
    224224/**
    225  *  @brief _Timer_Manager_initialization
     225 *  @brief Timer Manager Initialization
    226226 *
    227227 *  This routine performs the initialization necessary for this manager.
     
    302302
    303303/**
    304  *  @brief rtems_timer_server_fire_after
     304 *  @brief RTEMS Timer Server Fire After
    305305 *
    306306 *  This routine implements the rtems_timer_server_fire_after directive.  It
     
    309309 *  Timer Server in the context of a task NOT IN THE CONTEXT of the
    310310 *  clock tick interrupt.
     311 *
     312 *  @param[in] id is the timer id
     313 *  @param[in] ticks is the interval until routine is fired
     314 *  @param[in] routine is the routine to schedule
     315 *  @param[in] user_data is the passed as argument to routine when it is fired
     316 *
     317 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     318 *          error.  Otherwise, a status code is returned indicating the
     319 *          source of the error.
    311320 */
    312321rtems_status_code rtems_timer_server_fire_after(
     
    318327
    319328/**
    320  *  @brief rtems_timer_fire_when
     329 *  @brief RTEMS Timer Fire When
    321330 *
    322331 *  This routine implements the rtems_timer_fire_when directive.  It
     
    325334 *  of the rtems_clock_tick directive which is normally invoked as
    326335 *  part of servicing a periodic interupt.
     336 *
     337 *  @param[in] id is the timer id
     338 *  @param[in] wall_time is the time of day to fire timer
     339 *  @param[in] routine is the routine to schedule
     340 *  @param[in] user_data is the passed as argument to routine when it is fired
     341 *
     342 *  @return This method returns RTEMS_SUCCESSFUL if there was not an
     343 *          error.  Otherwise, a status code is returned indicating the
     344 *          source of the error.
    327345 */
    328346rtems_status_code rtems_timer_fire_when(
  • cpukit/rtems/src/barrierdelete.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Delete Barrier
     5 *  @ingroup ClassicBarrier
     6 */
     7
    18/*
    2  *  Barrier Manager -- Delete a Barrier
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2126#include <rtems/score/thread.h>
    2227#include <rtems/score/threadq.h>
    23 
    24 /*
    25  *  rtems_barrier_delete
    26  *
    27  *  This directive allows a thread to delete a barrier specified by
    28  *  the barrier id.  The barrier is freed back to the inactive
    29  *  barrier chain.
    30  *
    31  *  Input parameters:
    32  *    id - barrier id
    33  *
    34  *  Output parameters:
    35  *    RTEMS_SUCCESSFUL - if successful
    36  *    error code       - if unsuccessful
    37  */
    3828
    3929rtems_status_code rtems_barrier_delete(
  • cpukit/rtems/src/dpmemcreate.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Create Port
     5 *  @ingroup ClassicDPMEM
     6 */
     7
    18/*
    2  *  Dual Port Memory Manager
    3  *
    49 *  COPYRIGHT (c) 1989-1999.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2227#include <rtems/score/thread.h>
    2328#include <rtems/rtems/dpmem.h>
    24 
    25 /*
    26  *  rtems_port_create
    27  *
    28  *  This directive creates a port into a dual-ported memory area.
    29  *
    30  *  Input parameters:
    31  *    name           - user defined port name
    32  *    internal_start - internal start address of port
    33  *    external_start - external start address of port
    34  *    length         - physical length in bytes
    35  *    id             - address of port id to set
    36  *
    37  *  Output parameters:
    38  *    id       - port id
    39  *    RTEMS_SUCCESSFUL - if successful
    40  *    error code - if unsuccessful
    41  */
    4229
    4330rtems_status_code rtems_port_create(
  • cpukit/rtems/src/dpmemdelete.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Delete Port
     5 *  @ingroup ClassicDPMEM
     6 */
     7
    18/*
    2  *  Dual Port Memory Manager
    3  *
    49 *  COPYRIGHT (c) 1989-2007.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2227#include <rtems/score/thread.h>
    2328#include <rtems/rtems/dpmem.h>
    24 
    25 /*
    26  *  rtems_port_delete
    27  *
    28  *  This directive allows a thread to delete a dual-ported memory area
    29  *  specified by the dual-ported memory identifier.
    30  *
    31  *  Input parameters:
    32  *    id - dual-ported memory area id
    33  *
    34  *  Output parameters:
    35  *    RTEMS_SUCCESSFUL - if successful
    36  *    error code        - if unsuccessful
    37  */
    3829
    3930rtems_status_code rtems_port_delete(
  • cpukit/rtems/src/modes.c

    r9465fca r60ceb61  
    22 *  @file
    33 *
    4  *  @body Body for Mode Routines Implemented as Macros
    5  *
    6  *  This file contains bodies for Mode Macros which are
    7  *  needed by language bindings other than C and C++.
     4 *  @brief Body for RTEMS_INTERRUPT_LEVEL Macro
     5 *  @ingroup ClassicModes
    86 */
     7
    98
    109/*
  • cpukit/rtems/src/part.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief Partition Manager Initialization
     5 *  @ingroup ClassicPart
     6 */
     7
    18/*
    2  *  Partition Manager
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2328#include <rtems/score/thread.h>
    2429#include <rtems/score/sysstate.h>
    25 
    26 /*
    27  *  _Partition_Manager_initialization
    28  *
    29  *  This routine initializes all partition manager related
    30  *  data structures.
    31  *
    32  *  Input parameters:   NONE
    33  *
    34  *  Output parameters:  NONE
    35  */
    3630
    3731void _Partition_Manager_initialization(void)
  • cpukit/rtems/src/regiondelete.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Delete Region
     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_delete
    29  *
    30  *  This directive allows a thread to delete a region specified by
    31  *  the region identifier, provided that none of its segments are
    32  *  still allocated.
    33  *
    34  *  Input parameters:
    35  *    id - region id
    36  *
    37  *  Output parameters:
    38  *    RTEMS_SUCCESSFUL - if successful
    39  *    error code       - if unsuccessful
    40  */
    4130
    4231rtems_status_code rtems_region_delete(
  • cpukit/rtems/src/regionextend.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Extend Region
     5 *  @ingroup ClassicRegion
     6 */
     7
    18/*
    2  *  Region Manager - Extend (add memory to) a Region
    3  *
    49 *  COPYRIGHT (c) 1989-2009.
    510 *  On-Line Applications Research Corporation (OAR).
     
    2328#include <rtems/score/thread.h>
    2429#include <rtems/score/apimutex.h>
    25 
    26 /*
    27  *  rtems_region_extend
    28  *
    29  *  This directive attempts to grow a region of physical contiguous memory area
    30  *  from which variable sized segments can be allocated.
    31  *
    32  *  Input parameters:
    33  *    id         - id of region to grow
    34  *    start      - starting address of memory area for extension
    35  *    length     - physical length in bytes to grow the region
    36  *
    37  *  Output parameters:
    38  *    RTEMS_SUCCESSFUL - if successful
    39  *    error code       - if unsuccessful
    40  */
    4130
    4231rtems_status_code rtems_region_extend(
  • cpukit/rtems/src/regiongetsegmentsize.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Get Region Segment Size
     5 *  @ingroup ClassicRegion
     6 */
     7
    18/*
    2  *  Region Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2327#include <rtems/score/states.h>
    2428#include <rtems/score/apimutex.h>
    25 
    26 /*
    27  *  rtems_region_get_segment_size
    28  *
    29  *  This directive will return the size of the segment indicated
    30  *
    31  *  Input parameters:
    32  *    id         - region id
    33  *    segment    - segment address
    34  *    size       - pointer to segment size in bytes
    35  *
    36  *  Output parameters:
    37  *    size       - segment size in bytes filled in
    38  *    RTEMS_SUCCESSFUL - if successful
    39  *    error code - if unsuccessful
    40  */
    4129
    4230rtems_status_code rtems_region_get_segment_size(
  • cpukit/rtems/src/regionident.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Region Name to Id
     5 *  @ingroup ClassicRegion
     6 */
     7
    18/*
    2  *  Region Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-1999.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2529#include <rtems/score/apimutex.h>
    2630
    27 /*
    28  *  rtems_region_ident
    29  *
    30  *  This directive returns the system ID associated with
    31  *  the region name.
    32  *
    33  *  Input parameters:
    34  *    name - user defined region name
    35  *    id   - pointer to region id
    36  *
    37  *  Output parameters:
    38  *    *id      - region id
    39  *    RTEMS_SUCCESSFUL - if successful
    40  *    error code - if unsuccessful
    41  */
    42 
    4331rtems_status_code rtems_region_ident(
    4432  rtems_name  name,
  • cpukit/rtems/src/rtclock.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief No Initialization Routine
     5 *  @ingroup ClassicClock
     6 */
     7
    18/*
    2  *  Clock Manager
    3  *
    49 *  COPYRIGHT (c) 1989-1999.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/rtemsobjectidgetnode.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief Get Node Portion of Object Id
     5 *  @ingroup ClassicClassInfo
     6 */
     7
    18/*
    2  *  RTEMS Object Helper -- Extract Node From Id
    3  *
    49 *  COPYRIGHT (c) 1989-2008.
    510 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/rtemstimer.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief Timer Manager Initialization
     5 *  @ingroup ClassicTimer
     6 */
     7
    18/*
    2  *  Timer Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2428#include <rtems/score/tod.h>
    2529#include <rtems/score/watchdog.h>
    26 
    27 /*
    28  *  _Timer_Manager_initialization
    29  *
    30  *  This routine initializes all timer manager related data structures.
    31  *
    32  *  Input parameters: NONE
    33  *
    34  *  Output parameters:  NONE
    35  */
    3630
    3731void _Timer_Manager_initialization(void)
  • cpukit/rtems/src/semtranslatereturncode.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief Semaphore Translate Core Mutex and Semaphore Return Code
     5 *  @ingroup ClassicSem
     6 */
     7
    18/*
    2  *  Semaphore Manager
    3  *
    4  *  DESCRIPTION:
    5  *
    6  *  This package is the implementation of the Semaphore Manager.
    7  *  This manager utilizes standard Dijkstra counting semaphores to provide
    8  *  synchronization and mutual exclusion capabilities.
    9  *
    10  *  Directives provided are:
    11  *
    12  *     + create a semaphore
    13  *     + get an ID of a semaphore
    14  *     + delete a semaphore
    15  *     + acquire a semaphore
    16  *     + release a semaphore
    17  *
    189 *  COPYRIGHT (c) 1989-2009.
    1910 *  On-Line Applications Research Corporation (OAR).
     
    4738
    4839#include <rtems/score/interr.h>
    49 
    50 /*
    51  *  _Semaphore_Translate_core_mutex_return_code
    52  *
    53  *  Input parameters:
    54  *    status - mutex status code to translate
    55  *
    56  *  Output parameters:
    57  *    rtems status code - translated RTEMS status code
    58  *
    59  */
    6040
    6141const rtems_status_code _Semaphore_Translate_core_mutex_return_code_[] = {
     
    9676}
    9777
    98 /*
    99  *  _Semaphore_Translate_core_semaphore_return_code
    100  *
    101  *  Input parameters:
    102  *    status - semaphore status code to translate
    103  *
    104  *  Output parameters:
    105  *    rtems status code - translated RTEMS status code
    106  *
    107  */
    108 
    10978const rtems_status_code _Semaphore_Translate_core_semaphore_return_code_[] = {
    11079  RTEMS_SUCCESSFUL,         /* CORE_SEMAPHORE_STATUS_SUCCESSFUL */
  • cpukit/rtems/src/taskdelete.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Delete Task
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  RTEMS Task Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2008.
    610 *  On-Line Applications Research Corporation (OAR).
     
    3034#include <rtems/score/sysstate.h>
    3135#include <rtems/score/apimutex.h>
    32 
    33 /*
    34  *  rtems_task_delete
    35  *
    36  *  This directive allows a thread to delete itself or the thread
    37  *  identified in the id field.  The executive halts execution
    38  *  of the thread and frees the thread control block.
    39  *
    40  *  Input parameters:
    41  *    id - thread id
    42  *
    43  *  Output parameters:
    44  *    nothing           - if id is the requesting thread (always succeeds)
    45  *    RTEMS_SUCCESSFUL - if successful and id is
    46  *                           not the requesting thread
    47  *    error code        - if unsuccessful
    48  */
    4936
    5037rtems_status_code rtems_task_delete(
  • cpukit/rtems/src/taskident.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Task Name to Id
     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/sysstate.h>
    3135
    32 /*
    33  *  rtems_task_ident
    34  *
    35  *  This directive returns the system ID associated with
    36  *  the thread name.
    37  *
    38  *  Input parameters:
    39  *    name - user defined thread name
    40  *    node - node(s) to be searched
    41  *    id   - pointer to thread id
    42  *
    43  *  Output parameters:
    44  *    *id               - thread id
    45  *    RTEMS_SUCCESSFUL - if successful
    46  *    error code        - if unsuccessful
    47  */
    48 
    4936rtems_status_code rtems_task_ident(
    5037  rtems_name    name,
  • cpukit/rtems/src/tasksuspend.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Suspend Task
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  RTEMS Task Manager
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
     
    2933#include <rtems/score/apiext.h>
    3034#include <rtems/score/sysstate.h>
    31 
    32 /*
    33  *  rtems_task_suspend
    34  *
    35  *  This directive will place the specified thread in the "suspended"
    36  *  state.  Note that the suspended state can be in addition to
    37  *  other waiting states.
    38  *
    39  *  Input parameters:
    40  *    id - thread id
    41  *
    42  *  Output parameters:
    43  *    RTEMS_SUCCESSFUL - if successful
    44  *    error code        - if unsuccessful
    45  */
    4635
    4736rtems_status_code rtems_task_suspend(
  • cpukit/rtems/src/taskvariable_invoke_dtor.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Tasks Invoke Task Variable Destructor
     5 *  @ingroup ClassicTasks
     6 */
     7
    18/*
    2  *  Invoke the destructor on a per-task variable
    3  *
    4  *
    59 *  COPYRIGHT (c) 1989-2007.
    610 *  On-Line Applications Research Corporation (OAR).
  • cpukit/rtems/src/timerfirewhen.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Timer Fire When
     5 *  @ingroup ClassicTimer
     6 */
     7
    18/*
    2  *  Timer Manager - rtems_timer_fire_when 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_fire_when
    28  *
    29  *  This directive allows a thread to start a timer.
    30  *
    31  *  Input parameters:
    32  *    id        - timer id
    33  *    wall_time - time of day to fire timer
    34  *    routine   - routine to schedule
    35  *    user_data - passed as argument to routine when it is fired
    36  *
    37  *  Output parameters:
    38  *    RTEMS_SUCCESSFUL - if successful
    39  *    error code       - if unsuccessful
    40  */
    4129
    4230rtems_status_code rtems_timer_fire_when(
  • cpukit/rtems/src/timerserverfireafter.c

    r9465fca r60ceb61  
     1/**
     2 *  @file
     3 *
     4 *  @brief RTEMS Timer Server Fire After
     5 *  @ingroup ClassicTimer
     6 */
     7
    18/*
    2  *  Timer Manager - rtems_timer_server fire_after 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_server_fire_after
    28  *
    29  *  This directive allows a thread to start a timer which will by
    30  *  executed by the Timer Server when it fires.
    31  *
    32  *  Input parameters:
    33  *    id        - timer id
    34  *    ticks     - interval until routine is fired
    35  *    routine   - routine to schedule
    36  *    user_data - passed as argument to routine when it is fired
    37  *
    38  *  Output parameters:
    39  *    RTEMS_SUCCESSFUL - if successful
    40  *    error code       - if unsuccessful
    41  */
    4229
    4330rtems_status_code rtems_timer_server_fire_after(
Note: See TracChangeset for help on using the changeset viewer.