1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/**
* @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
);
/**
* @brief Initializes a simple console device.
*
* See CONFIGURE_APPLICATION_NEEDS_SIMPLE_CONSOLE_DRIVER documentation in the
* "RTEMS Classic API Guide".
*/
void _Console_simple_Initialize( void );
/**
* @brief Initializes a simple task console device.
*
* See CONFIGURE_APPLICATION_NEEDS_SIMPLE_TASK_CONSOLE_DRIVER documentation in
* the "RTEMS Classic API Guide".
*/
void _Console_simple_task_Initialize( void );
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
