Changeset 78ab0c5 in rtems


Ignore:
Timestamp:
Jul 28, 2009, 3:22:23 PM (10 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, master
Children:
f1b90cc
Parents:
5eac0853
Message:

Add Doxygen cleanups.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libcsupport/include/console.h

    r5eac0853 r78ab0c5  
    2525#endif
    2626
     27/**
     28 *  This macro defines the standard name for the console device
     29 *  that is available to applications.
     30 */
    2731#define CONSOLE_DEVICE_NAME "/dev/console"
    2832
     33/**
     34 *  This macro defines the standard device driver table entry for
     35 *  a console device driver.
     36 */
    2937#define CONSOLE_DRIVER_TABLE_ENTRY \
    3038  { console_initialize, console_open, console_close, \
    3139    console_read, console_write, console_control }
    3240
     41/**
     42 *  @brief Console Initialization Entry Point
     43 *
     44 *  This method initializes the console device driver.
     45 *
     46 *  @param[in] major is the device driver major number
     47 *  @param[in] minor is the device driver minor number
     48 *  @param[in] arg is the parameters to this call
     49 *
     50 *  @return This method returns RTEMS_SUCCESSFUL when
     51 *          the device driver is successfully initialized.
     52 */
    3353rtems_device_driver console_initialize(
    34   rtems_device_major_number,
    35   rtems_device_minor_number,
    36   void *
     54  rtems_device_major_number  major,
     55  rtems_device_minor_number  minor,
     56  void                      *arg
     57);
     58 
     59/**
     60 *  @brief Console Open Entry Point
     61 *
     62 *  This method opens a specific device supported by the
     63 *  console device driver.
     64 *
     65 *  @param[in] major is the device driver major number
     66 *  @param[in] minor is the device driver minor number
     67 *  @param[in] arg is the parameters to this call
     68 *
     69 *  @return This method returns RTEMS_SUCCESSFUL when
     70 *          the device driver is successfully opened.
     71 */
     72rtems_device_driver console_open(
     73  rtems_device_major_number  major,
     74  rtems_device_minor_number  minor,
     75  void                      *arg
    3776);
    3877
    39 rtems_device_driver console_open(
    40   rtems_device_major_number,
    41   rtems_device_minor_number,
    42   void *
     78/**
     79 *  @brief Console Close Entry Point
     80 *
     81 *  This method closes a specific device supported by the
     82 *  console device driver.
     83 *
     84 *  @param[in] major is the device driver major number
     85 *  @param[in] minor is the device driver minor number
     86 *  @param[in] arg is the parameters to this call
     87 *
     88 *  @return This method returns RTEMS_SUCCESSFUL when
     89 *          the device is successfully closed.
     90 */
     91rtems_device_driver console_close(
     92  rtems_device_major_number  major,
     93  rtems_device_minor_number  minor,
     94  void                      *arg
    4395);
    4496
    45 rtems_device_driver console_close(
    46   rtems_device_major_number,
    47   rtems_device_minor_number,
    48   void *
     97/**
     98 *  @brief Console Read Entry Point
     99 *
     100 *  This method reads from a specific device supported by the
     101 *  console device driver.
     102 *
     103 *  @param[in] major is the device driver major number
     104 *  @param[in] minor is the device driver minor number
     105 *  @param[in] arg is the parameters to this call
     106 *
     107 *  @return This method returns RTEMS_SUCCESSFUL when
     108 *          the device is successfully read from.
     109 */
     110rtems_device_driver console_read(
     111  rtems_device_major_number  major,
     112  rtems_device_minor_number  minor,
     113  void                      *arg
    49114);
    50115
    51 rtems_device_driver console_read(
    52   rtems_device_major_number,
    53   rtems_device_minor_number,
    54   void *
     116/**
     117 *  @brief Console Write Entry Point
     118 *
     119 *  This method writes to a specific device supported by the
     120 *  console device driver.
     121 *
     122 *  @param[in] major is the device driver major number
     123 *  @param[in] minor is the device driver minor number
     124 *  @param[in] arg is the parameters to this call
     125 *
     126 *  @return This method returns RTEMS_SUCCESSFUL when
     127 *          the device is successfully written.
     128 */
     129rtems_device_driver console_write(
     130  rtems_device_major_number  major,
     131  rtems_device_minor_number  minor,
     132  void                      *arg
    55133);
    56134
    57 rtems_device_driver console_write(
    58   rtems_device_major_number,
    59   rtems_device_minor_number,
    60   void *
    61 );
    62 
     135/**
     136 *  @brief Console IO Control Entry Point
     137 *
     138 *  This method performs an IO Control operation on a
     139 *  specific device supported by the console device driver.
     140 *
     141 *  @param[in] major is the device driver major number
     142 *  @param[in] minor is the device driver minor number
     143 *  @param[in] arg is the parameters to this call
     144 *
     145 *  @return This method returns RTEMS_SUCCESSFUL when
     146 *          the device driver IO control operation is
     147 *          successfully performed.
     148 */
    63149rtems_device_driver console_control(
    64   rtems_device_major_number,
    65   rtems_device_minor_number,
    66   void *
     150  rtems_device_major_number  major,
     151  rtems_device_minor_number  minor,
     152  void                      *arg
    67153);
    68154
Note: See TracChangeset for help on using the changeset viewer.