Changeset e4f2fe1 in rtems


Ignore:
Timestamp:
Aug 6, 2009, 4:32:54 PM (10 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, master
Children:
ee8512a
Parents:
cba16514
Message:

2009-08-06 Christian Mauderer <christian.mauderer@…>

  • rtems/include/rtems/rtems/types.h: Improve documentation.
Location:
cpukit
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • cpukit/ChangeLog

    rcba16514 re4f2fe1  
     12009-08-06      Christian Mauderer <christian.mauderer@embedded-brains.de>
     2
     3        * rtems/include/rtems/rtems/types.h: Improve documentation.
     4
    152009-08-06      Joel Sherrill <joel.sherrill@oarcorp.com>
    26
  • cpukit/rtems/include/rtems/rtems/types.h

    rcba16514 re4f2fe1  
    11/**
    2  * @file rtems/rtems/types.h
    3  *
    4  *  This include file defines the types used by the RTEMS API.
     2 * @file
     3 *
     4 * @ingroup ClassicRTEMS
     5 *
     6 * @brief Types used by the Classic API.
    57 */
    68
     
    1719#ifndef _RTEMS_RTEMS_TYPES_H
    1820#define _RTEMS_RTEMS_TYPES_H
    19 
    20 /**
    21  *  @defgroup ClassicTypes Types
    22  *
    23  *  @ingroup ClassicRTEMS
    24  *
    25  *  This encapsulates functionality which XXX
    26  */
    27 /**@{*/
    2821
    2922/*
     
    4740#endif
    4841
    49 /** This type defines a single precision float. */
     42/**
     43 * @addtogroup ClassicRTEMS
     44 *
     45 * @{
     46 */
     47
    5048#ifdef RTEMS_DEPRECATED_TYPES
     49/**
     50 * @brief Single precision float type.
     51 *
     52 * @deprecated Use @c float instead.
     53 */
    5154typedef single_precision rtems_single;
    5255
    53 /** This type defines a double precision float. */
     56/**
     57 * @brief Double precision float type.
     58 *
     59 * @deprecated Use @c double instead.
     60 */
    5461typedef double_precision rtems_double;
    5562
    56 /** This type defines the RTEMS boolean type . */
     63/**
     64 * @brief RTEMS boolean type.
     65 *
     66 * @deprecated Use @c bool instead
     67 */
    5768typedef boolean          rtems_boolean;
    5869#endif
    5970
    60 /** This type defines is for Classic API object names. */
     71/**
     72 * @brief Classic API object name Type.
     73 *
     74 * Contains the name of a Classic API object. It is an unsigned 32 bit integer
     75 * which can be treated as a numeric value or initialized using
     76 * rtems_build_name() to contain four ASCII characters.
     77 */
    6178typedef uint32_t         rtems_name;
    6279
    6380/**
    64  *  This type defines is for RTEMS object Id.  Although this
    65  *  type name is specific to the Classic API, the format of
    66  *  an object Id is the same across all APIs.
     81 * @brief Used to manage and manipulate RTEMS object identifier.
    6782 */
    6883typedef Objects_Id       rtems_id;
    6984
    7085/**
    71  *  This defines a value that is an invalid object Id.
     86 * @brief Invalid object identifier value.
     87 *
     88 * No object can have this identifier value.
    7289 */
    7390#define RTEMS_ID_NONE OBJECTS_ID_NONE
    7491
    7592/**
    76  * This type is the public name for task context area.
     93 * @brief Public name for task context area.
    7794 */
    7895typedef Context_Control            rtems_context;
     
    8097#if (CPU_HARDWARE_FP == TRUE) || (CPU_SOFTWARE_FP == TRUE)
    8198/**
    82  * This type is the public name for task floating point context area.
     99 * @brief Public name for task floating point context area.
    83100 */
    84101typedef Context_Control_fp         rtems_context_fp;
     
    86103
    87104/**
    88  * This type is the public name for the architecture specific
    89  * stack frame built as part of vectoring an interrupt.
     105 * @brief Defines the format of the interrupt stack frame as it appears to a
     106 * user ISR.
     107 *
     108 * This data structure may not be defined on all ports
    90109 */
    91110typedef CPU_Interrupt_frame        rtems_interrupt_frame;
    92111
    93112/**
    94  *  This type defines the public name for the information
    95  *  structure returned by the Heap Handler via the Region
    96  *  Manager.
     113 * @brief Information structure returned by the Heap Handler via the Region
     114 * Manager.
    97115 */
    98116typedef Heap_Information_block region_information_block;
    99117
    100118/**
    101  *  This type defines the public name for the type that is
    102  *  used to manage intervals specified by clock ticks.
     119 * @brief Used to manage and manipulate intervals specified by clock ticks.
    103120 */
    104121typedef Watchdog_Interval rtems_interval;
    105122
    106123/**
    107  *  This is the public type used to represent the CPU usage per thread.
    108  *
    109  *  @note When using nanosecond granularity timing, RTEMS may internally
    110  *        use a variety of represenations.
     124 * @brief Represents the CPU usage per thread.
     125 *
     126 * When using nano seconds granularity timing, RTEMS may internally use a
     127 * variety of represenations.
    111128 */
    112129#ifndef __RTEMS_USE_TICKS_CPU_USAGE_STATISTICS__
     
    118135
    119136/**
    120  *  The following record defines the time of control block.  This
    121  *  control block is used to maintain the current time of day.
    122  *
    123  *  @note This is an RTEID (a.k.a. Classic API) style time/date.
     137 * @brief Data structure to manage and manipulate calendar time.
    124138 */
    125139typedef struct {
    126   /** This field is the year, A.D. */
     140  /**
     141   * @brief Year, A.D.
     142   */
    127143  uint32_t   year;
    128   /** This field is the month, 1 -> 12 */
     144  /**
     145   * @brief Month, 1 .. 12.
     146   */
    129147  uint32_t   month;
    130   /** This field is the day, 1 -> 31 */
     148  /**
     149   * @brief Day, 1 .. 31.
     150   */
    131151  uint32_t   day;
    132   /** This field is the hour, 0 -> 23 */
     152  /**
     153   * @brief Hour, 0 .. 23.
     154   */
    133155  uint32_t   hour;
    134   /** This field is the minute, 0 -> 59 */
     156  /**
     157   * @brief Minute, 0 .. 59.
     158   */
    135159  uint32_t   minute;
    136   /** This field is the second, 0 -> 59 */
     160  /**
     161   * @brief Second, 0 .. 59.
     162   */
    137163  uint32_t   second;
    138   /** This field is the elapsed ticks between secs */
     164  /**
     165   * @brief Elapsed ticks between seconds.
     166   */
    139167  uint32_t   ticks;
    140168}   rtems_time_of_day;
    141169
    142170/**
    143  *  This defines the public name for an RTEMS API task mode type.
     171 * @brief Task mode type.
    144172 */
    145173typedef Modes_Control rtems_mode;
     
    150178#if defined(RTEMS_MULTIPROCESSING)
    151179/**
    152  * This defines the public name for the set of MPCI packet
    153  * classes which are internally dispatched to the managers.
     180 * @brief Set of MPCI packet classes which are internally dispatched to the
     181 * managers.
    154182 */
    155183typedef MP_packet_Classes          rtems_mp_packet_classes;
    156184
    157185/**
    158  * This defines the public name for the common prefix
    159  * found at the beginning of each MPCI packet sent between
    160  * nodes. This can be thought of as an envelope.
     186 * @brief Prefix found at the beginning of each MPCI packet sent between nodes.
    161187 */
    162188typedef MP_packet_Prefix           rtems_packet_prefix;
    163189
    164190/**
    165  * This defines the public name for the type for an indirect pointer
    166  * to the initialization entry point for an MPCI handler.
     191 * @brief Indirect pointer to the initialization entry point for an MPCI
     192 * handler.
    167193 */
    168194typedef MPCI_initialization_entry  rtems_mpci_initialization_entry;
    169195
    170196/**
    171  * This defines the public name for the type for an indirect pointer
    172  * to the get_packet entry point for an MPCI handler.
     197 * @brief Indirect pointer to the get_packet entry point for an MPCI handler.
    173198 */
    174199typedef MPCI_get_packet_entry      rtems_mpci_get_packet_entry;
    175200
    176201/**
    177  * This defines the public name for the type for an indirect pointer
    178  * to the return_packet entry point for an MPCI handler.
     202 * @brief Indirect pointer to the return_packet entry point for an MPCI
     203 * handler.
    179204 */
    180205typedef MPCI_return_packet_entry   rtems_mpci_return_packet_entry;
    181206
    182207/**
    183  * This defines the public name for the type for an indirect pointer
    184  * to the send_packet entry point for an MPCI handler.
     208 * @brief Indirect pointer to the send_packet entry point for an MPCI handler.
    185209 */
    186210typedef MPCI_send_entry            rtems_mpci_send_packet_entry;
    187211
    188212/**
    189  * This defines the public name for the type for an indirect pointer
    190  * to the receive entry point for an MPCI handler.
     213 * @brief Indirect pointer to the receive entry point for an MPCI handler.
    191214 */
    192215typedef MPCI_receive_entry         rtems_mpci_receive_packet_entry;
    193216
    194217/**
    195  * This defines the public name for the return type from every
    196  * MPCI handler routine.
     218 * @brief Return type from every MPCI handler routine.
    197219 */
    198220typedef MPCI_Entry                 rtems_mpci_entry;
    199221
    200222/**
    201  * This defines the public name for the structure which is used to
    202  * configure an MPCI handler.
     223 * @brief Structure which is used to configure an MPCI handler.
    203224 */
    204225typedef MPCI_Control               rtems_mpci_table;
    205226
    206227#endif
     228
     229/** @} */
    207230
    208231#ifdef __cplusplus
     
    210233#endif
    211234
    212 /**@}*/
    213 
    214235#endif
    215236/* end of include file */
Note: See TracChangeset for help on using the changeset viewer.