/**
* @file rtems/console.h
*
* 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.com/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
*
* @return This method returns RTEMS_SUCCESSFUL when
* 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
*
* @return This method returns RTEMS_SUCCESSFUL when
* 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
*
* @return This method returns RTEMS_SUCCESSFUL when
* the device 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
*
* @return This method returns RTEMS_SUCCESSFUL when
* 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
*
* @return This method returns RTEMS_SUCCESSFUL when
* 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
*
* @return This method returns RTEMS_SUCCESSFUL when
* 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 */
