diff options
Diffstat (limited to 'include/rtems/console.h')
| -rw-r--r-- | include/rtems/console.h | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/include/rtems/console.h b/include/rtems/console.h new file mode 100644 index 0000000000..dbd749c60a --- /dev/null +++ b/include/rtems/console.h @@ -0,0 +1,155 @@ +/** + * @file + * + * @brief Console Driver for all Boards + * + * This file describes the Console Device Driver for all boards. + * This driver provides support for the standard C Library. + */ + +/* + * COPYRIGHT (c) 1989-2011. + * On-Line Applications Research Corporation (OAR). + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.org/license/LICENSE. + */ + +#ifndef _RTEMS_CONSOLE_H +#define _RTEMS_CONSOLE_H + +#include <rtems/io.h> /* rtems_device_driver */ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * This macro defines the standard name for the console device + * that is available to applications. + */ +#define CONSOLE_DEVICE_NAME "/dev/console" + +/** + * This macro defines the standard device driver table entry for + * a console device driver. + */ +#define CONSOLE_DRIVER_TABLE_ENTRY \ + { console_initialize, console_open, console_close, \ + console_read, console_write, console_control } + +/** + * @brief Console initialization entry point. + * + * This method initializes the console device driver. + * + * @param[in] major is the device driver major number. + * @param[in] minor is the device driver minor number. + * @param[in] arg is the parameters to this call. + * + * @retval RTEMS_SUCCESSFUL The device driver is successfully initialized. + */ +rtems_device_driver console_initialize( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +/** + * @brief Console open entry point. + * + * This method opens a specific device supported by the + * console device driver. + * + * @param[in] major is the device driver major number + * @param[in] minor is the device driver minor number + * @param[in] arg is the parameters to this call + * + * @retval RTEMS_SUCCESSFUL The device driver is successfully opened. + */ +rtems_device_driver console_open( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +/** + * @brief Console close entry point. + * + * This method closes a specific device supported by the + * console device driver. + * + * @param[in] major is the device driver major number + * @param[in] minor is the device driver minor number + * @param[in] arg is the parameters to this call + * + * @retval RTEMS_SUCCESSFUL The device driver is successfully closed. + */ +rtems_device_driver console_close( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +/** + * @brief Console read entry point. + * + * This method reads from a specific device supported by the + * console device driver. + * + * @param[in] major is the device driver major number + * @param[in] minor is the device driver minor number + * @param[in] arg is the parameters to this call + * + * @retval RTEMS_SUCCESSFUL The device is successfully read from. + */ +rtems_device_driver console_read( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +/** + * @brief Console write entry point. + * + * This method writes to a specific device supported by the + * console device driver. + * + * @param[in] major is the device driver major number + * @param[in] minor is the device driver minor number + * @param[in] arg is the parameters to this call + * + * @retval RTEMS_SUCCESSFUL The device is successfully written. + */ +rtems_device_driver console_write( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +/** + * @brief Console IO control entry point. + * + * This method performs an IO Control operation on a + * specific device supported by the console device driver. + * + * @param[in] major is the device driver major number + * @param[in] minor is the device driver minor number + * @param[in] arg is the parameters to this call + * + * @retval RTEMS_SUCCESSFUL the device driver IO control operation is + * successfully performed. + */ +rtems_device_driver console_control( + rtems_device_major_number major, + rtems_device_minor_number minor, + void *arg +); + +#ifdef __cplusplus +} +#endif + +#endif +/* end of include file */ |