Changeset 01d43180 in rtems


Ignore:
Timestamp:
Dec 9, 2013, 9:04:40 PM (6 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.11, master
Children:
fa820b9
Parents:
2b3a648
git-author:
Joel Sherrill <joel.sherrill@…> (12/09/13 21:04:40)
git-committer:
Joel Sherrill <joel.sherrill@…> (12/10/13 01:50:55)
Message:

posix/config.h: Comment clean up

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/posix/include/rtems/posix/config.h

    r2b3a648 r01d43180  
    99
    1010/*
    11  *  COPYRIGHT (c) 1989-2008.
     11 *  COPYRIGHT (c) 1989-2013.
    1212 *  On-Line Applications Research Corporation (OAR).
    1313 *
     
    2626#endif
    2727
    28 /*
    29  *  XXX
     28/**
     29 *  @defgroup ClassicConfig Configuration
    3030 *
    31  *  The following records define the Configuration Table.  The
    32  *  information contained in this table is required in all
    33  *  RTEMS systems, whether single or multiprocessor.  This
    34  *  table primarily defines the following:
     31 *  @ingroup ClassicRTEMS
     32 *
     33 *  This encapsulates functionality related to the application's configuration
     34 *  of the Classic API including the maximum number of each class of objects.
     35 */
     36/**@{*/
     37
     38/**
     39 *  For now, we are only allowing the user to specify the entry point
     40 *  and stack size for POSIX initialization threads.
     41 */
     42typedef struct {
     43  /** This is the entry point for a POSIX initialization thread. */
     44  void       *(*thread_entry)(void *);
     45  /** This is the stack size for a POSIX initialization thread. */
     46  int       stack_size;
     47} posix_initialization_threads_table;
     48
     49/**
     50 *  The following records define the POSIX Configuration Table.
     51 *  The information contained in this table is required in all
     52 *  RTEMS systems which include POSIX threads support, whether
     53 *  single or multiprocessor.  This table primarily defines the
     54 *  following:
    3555 *
    3656 *     + required number of each object type
    3757 */
     58typedef struct {
     59  /**
     60   * This field contains the maximum number of POSIX API
     61   * threads which are configured for this application.
     62   */
     63  uint32_t                            maximum_threads;
    3864
    39 /*
    40  *  For now, we are only allowing the user to specify the entry point
    41  *  and stack size for POSIX initialization threads.
    42  */
     65  /**
     66   * This field contains the maximum number of POSIX API
     67   * mutexes which are configured for this application.
     68   */
     69  uint32_t                            maximum_mutexes;
    4370
    44 typedef struct {
    45   void       *(*thread_entry)(void *);
    46   int       stack_size;
    47 } posix_initialization_threads_table;
     71  /**
     72   * This field contains the maximum number of POSIX API
     73   * condition variables which are configured for this application.
     74   */
     75  uint32_t                            maximum_condition_variables;
    4876
    49 typedef struct {
    50   uint32_t                            maximum_threads;
    51   uint32_t                            maximum_mutexes;
    52   uint32_t                            maximum_condition_variables;
     77  /**
     78   * This field contains the maximum number of POSIX API
     79   * keys which are configured for this application.
     80   */
    5381  uint32_t                            maximum_keys;
     82
     83  /**
     84   * This field contains the maximum number of POSIX API
     85   * key value pairs which are configured for this application.
     86   *
     87   * @note There can be potentially be a key/value pair for
     88   *       every thread to use every key. But normally this
     89   *       many are not needed in a system.
     90   */
    5491  uint32_t                            maximum_key_value_pairs;
     92
     93  /**
     94   * This field contains the maximum number of POSIX API
     95   * timers which are configured for this application.
     96   */
    5597  uint32_t                            maximum_timers;
     98
     99  /**
     100   * This field contains the maximum number of POSIX API
     101   * queued signals which are configured for this application.
     102   */
    56103  uint32_t                            maximum_queued_signals;
     104
     105  /**
     106   * This field contains the maximum number of POSIX API
     107   * message queues which are configured for this application.
     108   */
    57109  uint32_t                            maximum_message_queues;
     110
     111  /**
     112   * This field contains the maximum number of POSIX API
     113   * message queue file descriptors which are configured
     114   * for this application.
     115   *
     116   * @note There can be one or more file descriptors used with
     117   *       each message queue. This value should be greater than
     118   *       or equal to the number of message queues.
     119   */
    58120  uint32_t                            maximum_message_queue_descriptors;
     121
     122  /**
     123   * This field contains the maximum number of POSIX API
     124   * semaphores which are configured for this application.
     125   */
    59126  uint32_t                            maximum_semaphores;
     127
     128  /**
     129   * This field contains the maximum number of POSIX API
     130   * barriers which are configured for this application.
     131   */
    60132  uint32_t                            maximum_barriers;
     133
     134  /**
     135   * This field contains the maximum number of POSIX API
     136   * read/write locks which are configured for this application.
     137   */
    61138  uint32_t                            maximum_rwlocks;
     139
     140  /**
     141   * This field contains the maximum number of POSIX API
     142   * spinlocks which are configured for this application.
     143   */
    62144  uint32_t                            maximum_spinlocks;
     145
     146  /**
     147   * This field contains the number of POSIX API Initialization
     148   * threads listed in @a User_initialization_thread_table.
     149   */
    63150  uint32_t                            number_of_initialization_threads;
     151
     152  /**
     153   * This field contains the list of POSIX API Initialization threads.
     154   */
    64155  posix_initialization_threads_table *User_initialization_threads_table;
    65156} posix_api_configuration_table;
     
    73164extern posix_api_configuration_table Configuration_POSIX_API;
    74165
     166/**@}*/
    75167#ifdef __cplusplus
    76168}
Note: See TracChangeset for help on using the changeset viewer.