Changeset a1f9934 in rtems


Ignore:
Timestamp:
Jan 4, 2013, 3:01:21 PM (7 years ago)
Author:
Mathew Kallada <matkallada@…>
Branches:
4.11, master
Children:
00c1cd5
Parents:
455bd4e
git-author:
Mathew Kallada <matkallada@…> (01/04/13 15:01:21)
git-committer:
Jennifer Averett <jennifer.averett@…> (01/04/13 15:01:21)
Message:

score: Doxygen Clean Up Task #3

Location:
cpukit/score
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • cpukit/score/cpu/mips/rtems/mips/idtcpu.h

    r455bd4e ra1f9934  
    1 /*
    2 
    3 Based upon IDT provided code with the following release:
    4 
    5 This source code has been made available to you by IDT on an AS-IS
    6 basis. Anyone receiving this source is licensed under IDT copyrights
    7 to use it in any way he or she deems fit, including copying it,
    8 modifying it, compiling it, and redistributing it either with or
    9 without modifications.  No license under IDT patents or patent
    10 applications is to be implied by the copyright license.
    11 
    12 Any user of this software should understand that IDT cannot provide
    13 technical support for this software and will not be responsible for
    14 any consequences resulting from the use of this software.
    15 
    16 Any person who transfers this source code or any derivative work must
    17 include the IDT copyright notice, this paragraph, and the preceeding
    18 two paragraphs in the transferred software.
    19 
    20 COPYRIGHT IDT CORPORATION 1996
    21 LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
    22 */
    23 
    24 /*
    25 ** idtcpu.h -- cpu related defines
    26 */
     1/**
     2 *  @file idtcpu.h
     3 *
     4 *  @brief CPU Related Definitions
     5 *
     6 * 950313: Ketan added sreg/lreg and R_SZ for 64-bit saves
     7 *         added Register definition for XContext reg.
     8 *         Look towards end of this file.
     9 */
     10
     11/*
     12 * Based upon IDT provided code with the following release:
     13 *
     14 * This source code has been made available to you by IDT on an AS-IS
     15 * basis. Anyone receiving this source is licensed under IDT copyrights
     16 * to use it in any way he or she deems fit, including copying it,
     17 * modifying it, compiling it, and redistributing it either with or
     18 * without modifications.  No license under IDT patents or patent
     19 * applications is to be implied by the copyright license.
     20 *
     21 * Any user of this software should understand that IDT cannot provide
     22 * technical support for this software and will not be responsible for
     23 * any consequences resulting from the use of this software.
     24 *
     25 * Any person who transfers this source code or any derivative work must
     26 * include the IDT copyright notice, this paragraph, and the preceeding
     27 * two paragraphs in the transferred software.
     28 *
     29 * COPYRIGHT IDT CORPORATION 1996
     30 * LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
     31 */
    2732
    2833#ifndef _RTEMS_MIPS_IDTCPU_H
    2934#define _RTEMS_MIPS_IDTCPU_H
     35
     36/**
     37 *  @defgroup MipsSet_idtcpu CPU Related Definitions
     38 *
     39 *  @ingroup MIPS
     40 *
     41 */
     42/**@{*/
    3043
    3144/*
     
    93106*/
    94107#define MINCACHE        0x200           /* 512       For 3041. */
    95 #define MAXCACHE        0x40000         /* 256*1024   256k */   
     108#define MAXCACHE        0x40000         /* 256*1024   256k */
    96109
    97110#if  __mips == 32
     
    692705#endif
    693706
     707/**@}*/
    694708#endif /* _RTEMS_MIPS_IDTCPU_H */
    695 
  • cpukit/score/cpu/mips/rtems/mips/iregdef.h

    r455bd4e ra1f9934  
    1 /*
    2 
    3 Based upon IDT provided code with the following release:
    4 
    5 This source code has been made available to you by IDT on an AS-IS
    6 basis. Anyone receiving this source is licensed under IDT copyrights
    7 to use it in any way he or she deems fit, including copying it,
    8 modifying it, compiling it, and redistributing it either with or
    9 without modifications.  No license under IDT patents or patent
    10 applications is to be implied by the copyright license.
    11 
    12 Any user of this software should understand that IDT cannot provide
    13 technical support for this software and will not be responsible for
    14 any consequences resulting from the use of this software.
    15 
    16 Any person who transfers this source code or any derivative work must
    17 include the IDT copyright notice, this paragraph, and the preceeding
    18 two paragraphs in the transferred software.
    19 
    20 COPYRIGHT IDT CORPORATION 1996
    21 LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
    22 
    23 
    24 /*
    25 **      iregdef.h - IDT R3000 register structure header file
    26 **
    27 **      Copyright 1989 Integrated Device Technology, Inc
    28 **      All Rights Reserved
    29 **
    30 */
    31 #ifndef _RTEMS_MIPS_IREGDEF_H
    32 #define _RTEMS_MIPS_IREGDEF_H
    33 
    34 /*
     1/**
     2 *  @file iregdef.h
     3 *
     4 *  @brief IDT R3000 Register Structure
     5 *
    356 * 950313: Ketan added sreg/lreg and R_SZ for 64-bit saves
    367 *         added Register definition for XContext reg.
    378 *         Look towards end of this file.
    389 */
     10
    3911/*
    40 ** register names
    41 */
     12 *      Copyright 1989 Integrated Device Technology, Inc
     13 *      All Rights Reserved
     14 *
     15 * Based upon IDT provided code with the following release:
     16 *
     17 * This source code has been made available to you by IDT on an AS-IS
     18 * basis. Anyone receiving this source is licensed under IDT copyrights
     19 * to use it in any way he or she deems fit, including copying it,
     20 * modifying it, compiling it, and redistributing it either with or
     21 * without modifications.  No license under IDT patents or patent
     22 * applications is to be implied by the copyright license.
     23 *
     24 * Any user of this software should understand that IDT cannot provide
     25 * technical support for this software and will not be responsible for
     26 * any consequences resulting from the use of this software.
     27 *
     28 * Any person who transfers this source code or any derivative work must
     29 * include the IDT copyright notice, this paragraph, and the preceeding
     30 * two paragraphs in the transferred software.
     31 *
     32 * COPYRIGHT IDT CORPORATION 1996
     33 * LICENSED MATERIAL - PROGRAM PROPERTY OF IDT
     34 */
     35
     36#ifndef _RTEMS_MIPS_IREGDEF_H
     37#define _RTEMS_MIPS_IREGDEF_H
     38
     39/**
     40 *  @defgroup MipsSet_iregdef Register Structure
     41 *
     42 *  @ingroup MIPS
     43 *
     44 */
     45/**@{*/
     46
     47/* register names */
     48
    4249#define r0      $0
    4350#define r1      $1
     
    327334#endif
    328335
     336/**@}*/
    329337#endif /* _RTEMS_MIPS_IREGDEF_H */
    330 
  • cpukit/score/cpu/mips/rtems/score/cpu.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file
    3  * 
    4  *  Mips CPU Dependent Header File
     3 *
     4 *  @brief Mips CPU Dependent Header File
    55 *
    66 *  Conversion to MIPS port by Alan Cudmore <alanc@linuxstart.com> and
     
    4343#define _RTEMS_SCORE_CPU_H
    4444
     45/**
     46 *  @defgroup ScoreCPU CPU CPU
     47 *
     48 *  @ingroup Score
     49 *
     50 */
     51/**@{*/
     52
    4553#ifdef __cplusplus
    4654extern "C" {
     
    212220 */
    213221
    214 #define CPU_ALL_TASKS_ARE_FP CPU_HARDWARE_FP 
     222#define CPU_ALL_TASKS_ARE_FP CPU_HARDWARE_FP
    215223
    216224/*
     
    11731181#endif
    11741182
    1175 #endif
     1183/**@}*/
     1184#endif
  • cpukit/score/cpu/mips/rtems/score/mips.h

    r455bd4e ra1f9934  
    11/**
    22 * @file rtems/score/mips.h
     3 *
     4 * @brief Information to build RTEMS for a "no cpu" while in protected mode.
     5 *
     6 *  This file contains the information required to build
     7 *  RTEMS for a particular member of the "no cpu"
     8 *  family when executing in protected mode.  It does
     9 *  this by setting variables to indicate which implementation
     10 *  dependent features are present in a particular member
     11 *  of the family.
    312 */
    413
     
    1423#ifndef _RTEMS_SCORE_MIPS_H
    1524#define _RTEMS_SCORE_MIPS_H
     25
     26/**
     27 *  @defgroup ScoreMips RTEMS no cpu Build Information
     28 *
     29 *  @ingroup Score
     30 *
     31 */
     32/**@{*/
    1633
    1734#ifdef __cplusplus
     
    278295#endif
    279296
     297/**@}*/
    280298#endif /* _RTEMS_SCORE_MIPS_H */
    281299/* end of include file */
  • cpukit/score/cpu/mips/rtems/score/types.h

    r455bd4e ra1f9934  
    11/**
    22 * @file rtems/score/types.h
     3 *
     4 * @brief Type Definitions Pertaining to the MIPS Processor Family
     5 *
     6 *  This include file contains type definitions pertaining to the MIPS
     7 *  processor family.
    38 */
    49
    510/*
    6  *  This include file contains type definitions pertaining to the MIPS
    7  *  processor family.
    8  *
    911 *  COPYRIGHT (c) 1989-2001.
    1012 *  On-Line Applications Research Corporation (OAR).
     
    1820#ifndef _RTEMS_SCORE_TYPES_H
    1921#define _RTEMS_SCORE_TYPES_H
     22
     23/**
     24 *  @defgroup ScoreTypes MIPS Processor Family Type Definitions
     25 *
     26 *  @ingroup Score
     27 *
     28 */
     29/**@{*/
    2030
    2131#include <rtems/score/basedefs.h>
     
    4151#endif  /* !ASM */
    4252
     53/**@}*/
    4354#endif
  • cpukit/score/include/rtems/bspsmp.h

    r455bd4e ra1f9934  
    2727 *  @defgroup RTEMS BSP SMP Interface
    2828 *
     29 *  @ingroup Score
     30 *
    2931 *  This defines the interface between RTEMS and the BSP for
    3032 *  SMP support.  The interface uses the term primary
     
    4850#ifndef ASM
    4951/**
    50  *  @brief Maximum Number of CPUs in SMP System
     52 *  @brief Maximum number of CPUs in SMP system.
    5153 *
    5254 *  This variable is set during the SMP initialization sequence to
     
    5658
    5759/**
    58  *  @brief Initialize Secondary CPUs
     60 *  @brief Initialize secondary CPUs.
    5961 *
    6062 *  This method is invoked by RTEMS during initialization to bring the
     
    6466 *              can handle
    6567 *
    66  *  @return This method returns the number of cores available in the
     68 *  @retval This method returns the number of cores available in the
    6769 *          system.
    6870 */
     
    7274
    7375/**
    74  *  @brief Obtain Current CPU Index
     76 *  @brief Obtain current CPU index.
    7577 *
    7678 *  This method is invoked by RTEMS when it needs to know the index
    7779 *  of the CPU it is executing on.
    7880 *
    79  *  @return This method returns the current CPU index.
     81 *  @retval This method returns the current CPU index.
    8082 */
    8183int bsp_smp_processor_id(void) RTEMS_COMPILER_PURE_ATTRIBUTE;
    8284
    8385/**
    84  *  @brief Make Request of Another CPU
     86 *  @brief Make request of another CPU.
    8587 *
    8688 *  This method is invoked by RTEMS when it needs to make a request
     
    9799
    98100/**
    99  *  @brief Generate a Interprocessor Broadcast Interrupt
     101 *  @brief Generate an interprocessor broadcast interrupt.
    100102 *
    101103 *  This method is invoked when RTEMS wants to let all of the other
     
    111113
    112114/**
    113  *  @brief Generate a Interprocessor Interrupt
     115 *  @brief Generate a interprocessor interrupt.
    114116 *
    115117 *  This method is invoked by RTEMS to let @a cpu know that it
     
    123125
    124126/**
    125  *  @brief Obtain CPU Core Number
     127 *  @brief Obtain CPU core number.
    126128 *
    127129 *  This method is invoked by RTEMS when it needs to know which core
     
    131133 *  preempt a thread on another node.
    132134 *
    133  *  @return This method returns the Id of the current CPU core.
     135 *  @retval This method returns the Id of the current CPU core.
    134136 */
    135137int   bsp_smp_processor_id( void );
     
    146148
    147149/**
    148  *  @brief RTEMS SMP Secondary CPU Initialize
     150 *  @brief Initialize secondary CPU and coordinates.
    149151 *
    150152 *  This method is the C entry point which secondary CPUs should
     
    167169
    168170/**
    169  *  @brief RTEMS SMP Proccess Interrupt
     171 *  @brief Process the incoming interprocessor request.
    170172 *
    171173 *  This is the method called by the BSP's interrupt handler
     
    190192#endif
    191193
     194/**@}*/
    192195#endif
    193196
  • cpukit/score/include/rtems/score/address.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/address.h
     3 *
     4 *  @brief Information Required to Manipulate Physical Addresses
    35 *
    46 *  This include file contains the information required to manipulate
  • cpukit/score/include/rtems/score/apimutex.h

    r455bd4e ra1f9934  
    44 * @ingroup ScoreAPIMutex
    55 *
    6  * @brief API Mutex Handler API.
     6 * @brief API Mutex Handler API
    77 */
    88
     
    7777 */
    7878void _API_Mutex_Lock(
    79    API_Mutex_Control *mutex 
     79   API_Mutex_Control *mutex
    8080   );
    8181
    8282/**
    83  *  @brief Releases the Specified API Mutex
     83 *  @brief Releases the specified API mutex.
    8484 *
    8585 *  Releases the specified @a mutex.
     
    106106
    107107/**
    108  *  @brief Memory Allocation Mutex
     108 *  @brief Memory allocation mutex.
    109109 *
    110110 *  This points to the API Mutex instance used to ensure that only
     
    114114
    115115/**
    116  *  @brief Macro to Ease Locking the Allocator Mutex
     116 *  @brief Macro to ease locking the allocator mutex.
    117117 *
    118118 *  This macro makes it explicit that one is locking the allocator mutex.
     
    122122
    123123/**
    124  *  @brief Macro to Ease Unlocking the Allocator Mutex
     124 *  @brief Macro to ease unlocking the allocator mutex.
    125125 *
    126126 *  This macro makes it explicit that one is unlocking the allocator mutex.
  • cpukit/score/include/rtems/score/chain.h

    r455bd4e ra1f9934  
    44 * @ingroup ScoreChain
    55 *
    6  * @brief Chain Handler API.
     6 * @brief Chain Handler API
    77 */
    88
     
    108108
    109109/**
    110  *  @brief Initialize a Chain Header
     110 *  @brief Initialize a chain header.
    111111 *
    112112 *  This routine initializes @a the_chain structure to manage the
     
    128128
    129129/**
    130  *  @brief Extract the specified node from a chain
     130 *  @brief Extract the specified node from a chain.
    131131 *
    132132 *  This routine extracts @a the_node from the chain on which it resides.
     
    143143
    144144/**
    145  *  @brief Obtain the first node on a chain
     145 *  @brief Obtain the first node on a chain.
    146146 *
    147147 *  This function removes the first node from @a the_chain and returns
    148148 *  a pointer to that node.  If @a the_chain is empty, then NULL is returned.
    149149 *
    150  *  @return This method returns a pointer a node.  If a node was removed,
     150 *  @retval This method returns a pointer a node.  If a node was removed,
    151151 *          then a pointer to that node is returned.  If @a the_chain was
    152152 *          empty, then NULL is returned.
     
    159159
    160160/**
    161  *  @brief Insert a node on a chain
     161 *  @brief Insert a node on a chain.
    162162 *
    163163 *  This routine inserts @a the_node on a chain immediately following
     
    180180
    181181/**
    182  *  @brief Append a node on the end of a chain
     182 *  @brief Append a node on the end of a chain.
    183183 *
    184184 *  This routine appends @a the_node onto the end of @a the_chain.
     
    263263 * operation.
    264264 *
    265  * @return The node count of the chain.
     265 * @retval The node count of the chain.
    266266 */
    267267size_t _Chain_Node_count_unprotected( const Chain_Control *chain );
  • cpukit/score/include/rtems/score/corespinlock.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/corespinlock.h
     3 *
     4 *  @brief Constants and Structures Associated with the Spinlock Handler
    35 *
    46 *  This include file contains all the constants and structures associated
     
    111113
    112114/**
    113  *  @brief Initialized a spinlock
     115 *  @brief Initialize the spinlock.
    114116 *
    115117 *  This routine initializes the spinlock based on the parameters passed.
     
    124126
    125127/**
    126  *  @brief Wait for Spinlock
     128 *  @brief Wait for spinlock.
     129 *
    127130 *  This routine wait for the spinlock to be released.  If the spinlock
    128131 *  is set to automatic and this is the appropriate thread, then it returns
     
    134137 *  @param[in] timeout is the maximum number of ticks to spin (0 is forever)
    135138 *
    136  * @return A status is returned which indicates the success or failure of
     139 * @retval A status is returned which indicates the success or failure of
    137140 *         this operation.
    138141 */
     
    144147
    145148/**
    146  * @brief Manually release Spinlock
    147  * 
     149 * @brief Manually release the spinlock.
     150 *
    148151 *  This routine manually releases the spinlock.  All of the threads waiting
    149152 *  for the spinlock will be readied.
  • cpukit/score/include/rtems/score/isr.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/isr.h
     3 *
     4 *  @brief Data Related to the Management of Processor Interrupt Levels
    35 *
    46 *  This include file contains all the constants and structures associated
     
    8890
    8991/**
    90  *  @brief Initialize the ISR Handler
     92 *  @brief Initialize the ISR handler.
    9193 *
    9294 *  This routine performs the initialization necessary for the ISR handler.
     
    9597
    9698/**
    97  *  @brief Disable Interrupts on This Core
     99 *  @brief Disable interrupts on this core.
    98100 *
    99101 *  This routine disables all interrupts so that a critical section
    100102 *  of code can be executing without being interrupted.
    101103 *
    102  *  @return The argument @a _level will contain the previous interrupt
     104 *  @retval The argument @a _level will contain the previous interrupt
    103105 *          mask level.
    104106 */
     
    110112
    111113/**
    112  *  @brief Enable Interrupts on This Core
     114 *  @brief Enable interrupts on this core.
    113115 *
    114116 *  This routine enables interrupts to the previous interrupt mask
     
    126128
    127129/**
    128  *  @brief Temporarily Enable Interrupts on This Core
     130 *  @brief Temporarily enable interrupts on this core.
    129131 *
    130132 *  This routine temporarily enables interrupts to the previous
     
    154156
    155157/**
    156  *  @brief Initialize SMP Interrupt Critical Section Support
     158 *  @brief Initialize SMP interrupt critical section support.
    157159 *
    158160 *  This method initializes the variables required by the SMP implementation
     
    162164
    163165/**
    164  *  @brief Enter Interrupt Critical Section on SMP System
     166 *  @brief Enter interrupt critical section on SMP system.
    165167 *
    166168 *  This method is used to enter an interrupt critical section that
    167169 *  is honored across all cores in an SMP system.
    168170 *
    169  *  @return This method returns the previous interrupt mask level.
     171 *  @retval This method returns the previous interrupt mask level.
    170172 */
    171173ISR_Level _ISR_SMP_Disable(void);
    172174
    173175/**
    174  *  @brief Exit Interrupt Critical Section on SMP System
     176 *  @brief Exit interrupt critical section on SMP system.
    175177 *
    176178 *  This method is used to exit an interrupt critical section that
     
    183185
    184186/**
    185  *  @brief Temporarily Exit Interrupt Critical Section on SMP System
     187 *  @brief Temporarily exit interrupt critical section on SMP system.
    186188 *
    187189 *  This method is used to temporarily exit an interrupt critical section
     
    194196
    195197/**
    196  *  @brief Enter SMP interrupt code
     198 *  @brief Enter SMP interrupt code.
    197199 *
    198200 *  This method is used to enter the SMP interrupt section.
    199201 *
    200  *  @return This method returns the isr level.
     202 *  @retval This method returns the isr level.
    201203 */
    202204int _ISR_SMP_Enter(void);
    203205
    204206/**
    205  *  @brief Exit SMP interrupt code
     207 *  @brief Exit SMP interrupt code.
    206208 *
    207209 *  This method is used to exit the SMP interrupt.
    208210 *
    209  *  @return This method returns 0 on a simple return and returns 1 on a
     211 *  @retval This method returns 0 on a simple return and returns 1 on a
    210212 *  dispatching return.
    211213 */
     
    215217
    216218/**
    217  *  @brief Enter Interrupt Disable Critical Section
     219 *  @brief Enter interrupt disable critical section.
    218220 *
    219221 *  This routine enters an interrupt disable critical section.  When
     
    223225 *  CPU interrupts.
    224226 *
    225  *  @return The argument @a _level will contain the previous interrupt
     227 *  @retval The argument @a _level will contain the previous interrupt
    226228 *          mask level.
    227229 */
     
    235237
    236238/**
    237  *  @brief Exits Interrupt Disable Critical Section
     239 *  @brief Exits interrupt disable critical section.
    238240 *
    239241 *  This routine exits an interrupt disable critical section.  When
     
    242244 *  CPU interrupts.
    243245 *
    244  *  @return The argument @a _level will contain the previous interrupt
     246 *  @retval The argument @a _level will contain the previous interrupt
    245247 *          mask level.
    246248 */
     
    254256
    255257/**
    256  *  @brief Temporarily Exit Interrupt Disable Critical Section
     258 *  @brief Temporarily exit interrupt disable critical section.
    257259 *
    258260 *  This routine is used to temporarily enable interrupts
     
    264266 *  properly protects itself.
    265267 *
    266  *  @return The argument @a _level will contain the previous interrupt
     268 *  @retval The argument @a _level will contain the previous interrupt
    267269 *          mask level.
    268270 */
     
    276278
    277279/**
    278  *  @brief Install Interrupt Handler Vector
     280 *  @brief Install interrupt handler vector.
    279281 *
    280282 *  This routine installs new_handler as the interrupt service routine
     
    290292 *             to the old handler
    291293 *
    292  *  @return *_old_handler will be set to the old ISR handler
     294 *  @retval *_old_handler will be set to the old ISR handler
    293295 */
    294296#define _ISR_Install_vector( _vector, _new_handler, _old_handler ) \
     
    296298
    297299/**
    298  *  @brief Return Current Interrupt Level
     300 *  @brief Return current interrupt level.
    299301 *
    300302 *  This routine returns the current interrupt level.
     
    303305 *  XXX document implementation including references if appropriate
    304306 *
    305  *  @return This method returns the current level.
     307 *  @retval This method returns the current level.
    306308 */
    307309#define _ISR_Get_level() \
     
    309311
    310312/**
    311  *  @brief Set Current Interrupt Level
     313 *  @brief Set current interrupt level.
    312314 *
    313315 *  This routine sets the current interrupt level to that specified
     
    325327
    326328/**
    327  *  @brief ISR Handler or Dispatcher
     329 *  @brief ISR interrupt dispatcher.
    328330 *
    329331 *  This routine is the interrupt dispatcher.  ALL interrupts
     
    341343
    342344/**
    343  *  @brief ISR Wrapper for Thread Dispatcher
     345 *  @brief ISR wrapper for thread dispatcher.
    344346 *
    345347 *  This routine provides a wrapper so that the routine
     
    356358
    357359/**
    358  *  @brief Is an ISR in Progress
     360 *  @brief Checks if an ISR in progress.
    359361 *
    360362 *  This function returns true if the processor is currently servicing
     
    362364 *  that the caller is an interrupt service routine, NOT a thread.
    363365 *
    364  *  @return This methods returns true when called from an ISR.
     366 *  @retval This methods returns true when called from an ISR.
    365367 */
    366368#if (CPU_PROVIDES_ISR_IS_IN_PROGRESS == TRUE)
  • cpukit/score/include/rtems/score/scheduleredf.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/scheduleredf.h
     3 *
     4 *  @brief Data Related to the Manipulation of Threads for the EDF Scheduler
    35 *
    46 *  This include file contains all the constants and structures associated
     
    2830
    2931/**
     32 *  @defgroup ScoreScheduler
     33 *
     34 *  @ingroup Score
     35 *
    3036 *  @addtogroup ScoreScheduler
    3137 *
     
    99105
    100106/**
    101  * @brief Scheduler EDF Initialize
     107 * @brief Initialize EDF scheduler.
    102108 *
    103109 * This routine initializes the EDF scheduler.
     
    106112
    107113/**
    108  *  @brief Removes Thread from Ready Queue
     114 *  @brief Removes thread from ready queue.
    109115 *
    110116 *  This routine removes @a the_thread from the scheduling decision,
     
    120126
    121127/**
    122  *  @brief Scheduler EDF Schedule
     128 *  @brief Sets the heir thread to be the next ready thread
     129 *  in the rbtree ready queue.
    123130 *
    124131 *  This kernel routine sets the heir thread to be the next ready thread
     
    128135
    129136/**
    130  *  @brief Scheduler EDF Allocate
     137 *  @brief Allocates EDF specific information of @a the_thread.
    131138 *
    132139 *  This routine allocates EDF specific information of @a the_thread.
     
    140147
    141148/**
    142  *  @brief Frees EDF information of a thread 
     149 *  @brief Frees EDF information of a thread.
    143150 *
    144151 *  This routine frees the EDF specific information of @a the_thread.
     
    152159
    153160/**
    154  *  @brief Scheduler EDF Update
     161 *  @brief Updates position in the ready queue of @a the_thread.
    155162 *
    156163 *  This routine updates position in the ready queue of @a the_thread.
     
    164171
    165172/**
    166  *  @brief Scheduler EDF Unblock
     173 *  @brief Adds @a the_thread to the scheduling decision.
    167174 *
    168175 *  This routine adds @a the_thread to the scheduling decision, that is,
     
    177184
    178185/**
    179  *  @brief Scheduler EDF Yield
     186 *  @brief invoked when a thread wishes to voluntarily
     187 *  transfer control of the processor to another thread
     188 *  with equal deadline.
    180189 *
    181190 *  This routine is invoked when a thread wishes to voluntarily
     
    190199
    191200/**
    192  *  @brief Scheduler EDF Enqueue
     201 *  @brief Put @a the_thread to the rbtree ready queue.
    193202 *
    194203 *  This routine puts @a the_thread to the rbtree ready queue.
     
    201210
    202211/**
    203  *  @brief Enqueues a thread to the ready queue
     212 *  @brief Enqueue a thread to the ready queue.
    204213 *
    205214 *  This routine puts @a the_thread to the rbtree ready queue.
     
    213222
    214223/**
    215  *  @brief Scheduler EDF Extract
     224 *  @brief Remove a specific thread from the scheduler's set
     225 *  of ready threads.
    216226 *
    217227 *  This routine removes a specific thread from the scheduler's set
     
    225235
    226236/**
    227  *  @brief Scheduler EDF Priority compare
     237 *  @brief Explicitly compare absolute dedlines (priorities) of threads.
    228238 *
    229239 * This routine explicitly compares absolute dedlines (priorities) of threads.
    230240 * In case of EDF scheduling time overflow is taken into account.
    231241 *
    232  * @return >0 for p1 > p2; 0 for p1 == p2; <0 for p1 < p2.
     242 * @retval >0 for p1 > p2; 0 for p1 == p2; <0 for p1 < p2.
    233243 */
    234244int _Scheduler_EDF_Priority_compare (
     
    238248
    239249/**
    240  *  @brief Scheduler EDF Release job
     250 *  @brief Called when a new job of task is released.
    241251 *
    242252 *  This routine is called when a new job of task is released.
  • cpukit/score/include/rtems/score/schedulersimple.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/schedulersimple.h
     3 *
     4 *  @brief Manipulation of Threads Simple-Priority-Based Ready Queue
    35 *
    46 *  This include file contains all the constants and structures associated
    57 *  with the manipulation of threads on a simple-priority-based ready queue.
    6  *
    7  *
     8 */
     9
     10/*
    811 *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
    912 *
     
    1720
    1821/**
     22 *  @defgroup ScoreScheduler
     23 *
     24 *  @ingroup Score
     25 *
    1926 *  @addtogroup ScoreScheduler
    20  *
    2127 */
    2228/**@{*/
     
    5157
    5258/**
    53  *  @brief Initializes simple scheduler
     59 *  @brief Initialize simple scheduler.
    5460 *
    5561 *  This routine initializes the simple scheduler.
     
    6571
    6672/**
    67  *  @brief Simple Schedule
     73 *  @brief Invoked when a thread wishes to voluntarily
     74 *  transfer control of the processor to another thread in the queue.
    6875 *
    6976 *  This routine is invoked when a thread wishes to voluntarily
     
    8087
    8188/**
    82  *  @brief Removes a thread from the queue
     89 *  @brief Remove a simple-priority-based thread from the queue.
    8390 *
    8491 *  This routine removes @a the_thread from the scheduling decision,
     
    94101
    95102/**
    96  *  @brief Scheduler Simple Handler / Unblock
     103 *  @brief Unblock a simple-priority-based thread.
     104 *
    97105 *  This routine adds @a the_thread to the scheduling decision,
    98106 *  that is, adds it to the ready queue and
     
    106114
    107115/**
    108  *  @brief Removes a thread from a simple queue
     116 *  @brief Removes a simple-priority-based thread from a simple queue.
    109117 *
    110118 *  This routine removes a specific thread from the specified
     
    118126
    119127/**
    120  *  @brief Puts thread onto the ready queue
     128 *  @brief Puts simple-priority-based thread onto the ready queue.
    121129 *
    122130 *  This routine puts @a the_thread on to the ready queue.
     
    129137
    130138/**
    131  *  @brief Scheduler simple Enqueue first
     139 *  @brief Put simple-priority-based @a the_thread to
     140 *  the head of the ready queue.
    132141 *
    133142 *  This routine puts @a the_thread to the head of the ready queue.
     
    141150
    142151/**
    143  *  @brief Returns empty placeholder for scheduler
     152 *  @brief Return empty placeholder for the simple scheduler.
    144153 *
    145154 *  This routine is a place holder for any memeory allocation needed
     
    150159 *             management memory for
    151160 *
    152  *  @return this routine returns -1 since this is just an empty placeholder
     161 *  @retval this routine returns -1 since this is just an empty placeholder
    153162 *  and the return value may be defined differently by each scheduler.
    154163 */
     
    158167
    159168/**
    160  *  @breif Stub for schedule update
     169 *  @breif Stub for simple schedule update.
    161170 *
    162171 *  This routine does nothing, and is used as a stub for Schedule update
     
    170179
    171180/**
    172  *  @brief Stub for schedule free
     181 *  @brief Stub for simple schedule free.
    173182 *
    174183 *  This routine does nothing, and is used as a stub for Schedule free
     
    194203
    195204/**
    196  *  @brief Scheduler Simple Ready Queue Enqueue First
     205 *  @brief Puts simple-priority-based @a the_thread on to the ready queue
     206 *  at the beginning of its priority group.
    197207 *
    198208 *  This routine puts @a the_thread on to the ready queue
  • cpukit/score/include/rtems/score/schedulersimplesmp.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/schedulersimplesmp.h
     3 *
     4 *  @brief Manipulation of Threads on a Simple-Priority-Based Ready Queue
    35 *
    46 *  This include file contains all the constants and structures associated
     
    2224
    2325/**
     26 *  @defgroup ScoreScheduler
     27 *
     28 *  @ingroup Score
     29 *
    2430 *  @addtogroup ScoreScheduler
    2531 *
     
    6369
    6470/**
    65  *  @brief Scheduler Simple SMP Schedule Method
     71 *  @brief Allocates ready SMP threads to individual cores in an SMP system.
    6672 *
    6773 *  This routine allocates ready threads to individual cores in an SMP
     
    7278
    7379/**
    74  *  @brief Scheduler Simple SMP Block Method
     80 *  @brief Remove SMP @a the_thread from the ready queue.
    7581 *
    7682 *  This routine removes @a the_thread from the scheduling decision,
     
    8692
    8793/**
    88  *  @brief Scheduler Simple SMP Unblock Method
     94 *  @brief Adds SMP @a the_thread to the ready queue and updates any
     95 *  appropriate scheduling variables, for example the heir thread.
    8996 *
    9097 *  This routine adds @a the_thread to the scheduling decision,
     
    99106
    100107/**
    101  *  @brief Scheduler Simple SMP Tick Method
     108 *  @brief Invoked as part of processing each SMP clock tick.
    102109 *
    103110 *  This routine is invoked as part of processing each clock tick.
  • cpukit/score/include/rtems/score/smplock.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/smplock.h
     3 *
     4 *  @brief Interface for Atomic Locks
    35 *
    46 *  This include file defines the interface for atomic locks
     
    5557
    5658/**
    57  *  @brief Initialize a Lock
     59 *  @brief Initialize a lock.
    5860 *
    5961 *  This method is used to initialize the lock at @a lock.
     
    6668
    6769/**
    68  *  @brief Obtain a Lock
     70 *  @brief Obtain a lock.
    6971 *
    7072 *  This method is used to obtain the lock at @a lock.
     
    7274 *  @param [in] lock is the address of the lock to obtain.
    7375 *
    74  *  @return This method returns with processor interrupts disabled.
     76 *  @retval This method returns with processor interrupts disabled.
    7577 *          The previous level is returned.
    7678 */
     
    8082
    8183/**
    82  *  @brief Release a Lock
     84 *  @brief Release a lock.
    8385 *
    8486 *  This method is used to release the lock at @a lock.
     
    9294
    9395/**
    94  *  @brief Initialize a Lock
     96 *  @brief Initialize a lock.
    9597 *
    9698 *  This method is used to initialize the lock at @a lock.
     
    103105
    104106/**
    105  *  @brief Obtain a Lock
     107 *  @brief Obtain a lock.
    106108 *
    107109 *  This method is used to obtain the lock at @a lock.  ISR's are
     
    116118 *  @param [in] lock is the address of the lock to obtain.
    117119 *
    118  *  @return This method returns with processor interrupts disabled.
     120 *  @retval This method returns with processor interrupts disabled.
    119121 *          The previous level is returned.
    120122 */
     
    124126
    125127/**
    126  *  @brief Release a Lock
     128 *  @brief Release a lock.
    127129 *
    128  *  This method is used to release the lock at @a lock. 
     130 *  This method is used to release the lock at @a lock.
    129131 *
    130132 *  @note ISR's are reenabled by this method and are expected to be
  • cpukit/score/include/rtems/score/threadmp.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/threadmp.h
     3 *
     4 *  @brief Multiprocessing Portion of the Thread Package
    35 *
    46 *  This include file contains the specification for all routines
     
    2123 *  @defgroup ScoreThreadMP Thread Handler Multiprocessing Support
    2224 *
     25 *  @ingroup Score
     26 *
    2327 *  This handler encapsulates functionality which is related to managing
    2428 *  threads in a multiprocessor system configuration.  This handler must
     
    3337
    3438/**
    35  *  @brief MP Thread Handler Initialization
     39 *  @brief Initialize MP thread handler.
    3640 *
    3741 *  This routine initializes the multiprocessing portion of the Thread Handler.
     
    4246
    4347/**
    44  *  @brief MP Thread Proxy Allocate
     48 *  @brief Allocate a MP proxy control block from
     49 *  the inactive chain of free proxy control blocks.
    4550 *
    4651 *  This  allocates a proxy control block from
     
    5560
    5661/**
    57  *  @brief MP Thread Proxy Find
     62 *  @brief Removes the MP proxy control block for the specified
     63 *  id from the active chain of proxy control blocks.
    5864 *
    5965 *  This function removes the proxy control block for the specified
     
    6571
    6672/**
    67  *  @brief Active Proxy Set
     73 *  @brief Manage the active set MP proxies.
    6874 *
    6975 * The following chain is used to manage the active set proxies.
     
    7278
    7379/**
    74  *  @brief Inactive Proxy Set
     80 *  @brief Manage the inactive set of MP proxies.
    7581 *
    7682 * The following chain is used to manage the inactive set of proxies.
  • cpukit/score/include/rtems/score/threadsync.h

    r455bd4e ra1f9934  
    11/**
    2  *  @file  rtems/score/threadsync.h
     2 *  @file rtems/score/threadsync.h
     3 *
     4 *  @brief Synchronize Thread Blocking Operations with Actions in an ISR
    35 *
    46 *  This include file contains all constants and structures associated
  • cpukit/score/include/rtems/score/timestamp64.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/score/timestamp64.h
     3 *
     4 *  @brief Helpers for Manipulating 64-bit Integer Timestamps
    35 *
    46 *  This include file contains helpers for manipulating
     
    6264
    6365/**
    64  *  @brief Set Timestamp to Seconds Nanosecond
     66 *  @brief Set 64-bit timestamp to seconds nanosecond.
    6567 *
    6668 *  This method sets the timestamp to the specified seconds and nanoseconds
     
    9092
    9193/**
    92  *  @brief Zero Timestamp
    93  *
    94  *  This method sets the timestamp to zero.
    95  *  value.
     94 *  @brief Sets the 64-bit timestamp to zero.
     95 *
     96 *  This method sets the timestamp to zero value.
    9697 *
    9798 *  @param[in] _time points to the timestamp instance to zero.
     
    107108
    108109/**
    109  *  @brief Is Timestamp Valid
     110 *  @brief Determines the validity of a 64-bit timestamp.
    110111 *
    111112 *  This method determines the validity of a timestamp.
     
    113114 *  @param[in] _time points to the timestamp instance to validate.
    114115 *
    115  *  @return This method returns true if @a time is valid and
     116 *  @retval This method returns true if @a time is valid and
    116117 *          false otherwise.
    117118 */
     
    128129
    129130/**
    130  *  @brief Timestamp Less Than Operator
     131 *  @brief The "less than" operator for 64-bit timestamps.
    131132 *
    132133 *  This method is the less than operator for timestamps.
     
    135136 *  @param[in] _rhs points to the right hand side timestamp
    136137 *
    137  *  @return This method returns true if @a _lhs is less than the @a _rhs and
     138 *  @retval This method returns true if @a _lhs is less than the @a _rhs and
    138139 *          false otherwise.
    139140 */
     
    160161
    161162/**
    162  *  @brief Timestamp equal to Operator
     163 *  @brief The "equal to" operator for 64-bit timestamps.
    163164 *
    164165 *  This method is the is equal to than operator for timestamps.
     
    167168 *  @param[in] _rhs points to the right hand side timestamp
    168169 *
    169  *  @return This method returns true if @a _lhs is equal to  @a _rhs and
     170 *  @retval This method returns true if @a _lhs is equal to  @a _rhs and
    170171 *          false otherwise.
    171172 */
     
    189190
    190191/**
    191  *  @brief Add to a Timestamp
     192 *  @brief Add two 64-bit timestamps.
    192193 *
    193194 *  This routine adds two timestamps.  The second argument is added
     
    197198 *  @param[in] _add points to the timestamp to add to the first argument
    198199 *
    199  *  @return This method returns the number of seconds @a time increased by.
     200 *  @retval This method returns the number of seconds @a time increased by.
    200201 */
    201202#if CPU_TIMESTAMP_USE_INT64_INLINE == TRUE
     
    210211
    211212/**
    212  *  @brief Convert Timestamp to Number of Ticks
     213 *  @brief Convert 64-bit timestamp to number of ticks.
    213214 *
    214215 *  This routine convert the @a time timestamp to the corresponding number
     
    217218 *  @param[in] _time points to the time to be converted
    218219 *
    219  *  @return This method returns the number of ticks computed.
     220 *  @retval This method returns the number of ticks computed.
    220221 */
    221222uint32_t _Timestamp64_To_ticks(
     
    224225
    225226/**
    226  *  @brief Convert Ticks to Timestamp
     227 *  @brief Convert ticks to 64-bit timestamp.
    227228 *
    228229 *  This routine converts the @a _ticks value to the corresponding
     
    247248
    248249/**
    249  *  @brief Subtract Two Timestamp
     250 *  @brief Subtract two 64-bit timestamps.
    250251 *
    251252 *  This routine subtracts two timestamps.  @a result is set to
     
    278279
    279280/**
    280  *  @brief Divide Timestamp By Integer
     281 *  @brief Divide 64-bit timestamp by an integer.
    281282 *
    282283 *  This routine divides a timestamp by an integer value.  The expected
     
    300301
    301302/**
    302  *  @brief Divide Timestamp
     303 *  @brief Divide 64-bit timestamp by another 64-bit timestamp.
    303304 *
    304305 *  This routine divides a timestamp by another timestamp.  The
     
    325326
    326327/**
    327  *  @brief Get Seconds Portion of Timestamp
     328 *  @brief Get seconds portion of a 64-bit timestamp.
    328329 *
    329330 *  This method returns the seconds portion of the specified timestamp
     
    331332 *  @param[in] _time points to the timestamp
    332333 *
    333  *  @return The seconds portion of @a _time.
     334 *  @retval The seconds portion of @a _time.
    334335 */
    335336#if CPU_TIMESTAMP_USE_INT64_INLINE == TRUE
     
    350351
    351352/**
    352  *  @brief Get Nanoseconds Portion of Timestamp
     353 *  @brief Get nanoseconds portion of a 64-bit timestamp.
    353354 *
    354355 *  This method returns the nanoseconds portion of the specified timestamp
     
    356357 *  @param[in] _time points to the timestamp
    357358 *
    358  *  @return The nanoseconds portion of @a _time.
     359 *  @retval The nanoseconds portion of @a _time.
    359360 */
    360361#if CPU_TIMESTAMP_USE_INT64_INLINE == TRUE
     
    377378
    378379/**
    379  *  @brief Convert Timestamp to struct timespec
     380 *  @brief Convert 64-bit timestamp to struct timespec.
    380381 *
    381382 *  This method returns the seconds portion of the specified timestamp
     
    404405
    405406/**
    406  *  @brief Convert Timestamp to struct timeval
     407 *  @brief Convert 64-bit timestamp to struct timeval.
    407408 *
    408409 *  This method returns the seconds portion of the specified timestamp
  • cpukit/score/include/rtems/score/wkspace.h

    r455bd4e ra1f9934  
    11/**
    2  *  @file  rtems/score/wkspace.h
     2 *  @file rtems/score/wkspace.h
     3 *
     4 *  @brief Information Related to the RAM Workspace
    35 *
    46 *  This include file contains information related to the
     
    4547
    4648/**
    47  * @brief Workspace Handler Initialization
     49 * @brief Initilize workspace handler.
    4850 *
    4951 *  This routine performs the initialization necessary for this handler.
     
    5658
    5759/**
    58  * @brief Allocate Memory from Workspace
     60 * @brief Allocate memory from workspace.
    5961 *
    6062 *  This routine returns the address of a block of memory of size
     
    6466 *  @param size is the requested size
    6567 *
    66  *  @return a pointer to the requested memory or NULL.
     68 *  @retval a pointer to the requested memory or NULL.
    6769 */
    6870void *_Workspace_Allocate(
     
    7173
    7274/**
    73  * @brief Free Memory to the Workspace
     75 * @brief Free memory to the workspace.
    7476 *
    7577 *  This function frees the specified block of memory.  If the block
     
    8991
    9092/**
    91  * @brief Workspace Allocate or Fail with Fatal Error
     93 * @brief Workspace allocate or fail with fatal error.
    9294 *
    9395 *  This routine returns the address of a block of memory of @a size
     
    9698 *
    9799 *  @param[in] size is the desired number of bytes to allocate
    98  *  @return If successful, the starting address of the allocated memory
     100 *  @retval If successful, the starting address of the allocated memory
    99101 */
    100102void *_Workspace_Allocate_or_fatal_error(
     
    103105
    104106/**
    105  * @brief Duplicates String with Memory from the Workspace
     107 * @brief Duplicates string with memory from the workspace.
    106108 *
    107109 * @param[in] string is the pointer to a zero terminated string.
    108110 * @param[in] len is the length of the string (equal to strlen(string)).
    109111 *
    110  * @return NULL Not enough memory.
    111  * @return other Duplicated string.
     112 * @retval NULL Not enough memory.
     113 * @retval other Duplicated string.
    112114 */
    113115char *_Workspace_String_duplicate(
  • cpukit/score/include/rtems/seterr.h

    r455bd4e ra1f9934  
    11/**
    22 *  @file  rtems/seterr.h
     3 *
     4 *  @brief Data which Ease the Burden of Consistently Setting Errno
    35 *
    46 *  This file contains macros and definitions which ease the burden
     
    1719#ifndef _RTEMS_SETERR_H
    1820#define _RTEMS_SETERR_H
     21
     22/**
     23 *  @defgroup ScoreSetErr Set Errno
     24 *
     25 *  @ingroup Score
     26 *
     27 */
     28/**@{*/
    1929
    2030#include <errno.h>
     
    4252  do { errno = (_error); return (_cast) -1; } while(0)
    4353
     54/**@}*/
    4455#endif
    4556/* end of include file */
Note: See TracChangeset for help on using the changeset viewer.