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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/**
* @file
*
* @brief Classic Input/Output Manager API
*
* This file emulates the old Classic RTEMS IO manager directives
* which register and lookup names using the in-memory filesystem.
*/
/*
* COPYRIGHT (c) 1989-2008.
* 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_IO_H
#define _RTEMS_IO_H
#ifndef SAPI_IO_EXTERN
#define SAPI_IO_EXTERN extern
#endif
#include <rtems/rtems/status.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup ClassicIO Input/Output
*
* @ingroup ClassicRTEMS
*
*/
/**@{**/
typedef uint32_t rtems_device_major_number;
typedef uint32_t rtems_device_minor_number;
typedef rtems_status_code rtems_device_driver;
typedef rtems_device_driver (*rtems_device_driver_entry)(
rtems_device_major_number,
rtems_device_minor_number,
void *
);
typedef struct {
rtems_device_driver_entry initialization_entry;
rtems_device_driver_entry open_entry;
rtems_device_driver_entry close_entry;
rtems_device_driver_entry read_entry;
rtems_device_driver_entry write_entry;
rtems_device_driver_entry control_entry;
} rtems_driver_address_table;
/**
* @name Device Driver Maintainance
*/
/**@{**/
/**
* @brief Returns @c RTEMS_IO_ERROR.
*
* @retval RTEMS_IO_ERROR Only this one.
*/
rtems_status_code rtems_io_driver_io_error(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Registers and initializes the device with the device driver table
* @a driver_table and major number @a major.
*
* If the major number equals zero a major number will be obtained. The major
* number of the registered driver will be returned in @a registered_major.
*
* After a successful registration rtems_io_initialize() will be called to
* initialize the device.
*
* @retval RTEMS_SUCCESSFUL Device successfully registered and initialized.
* @retval RTEMS_INVALID_ADDRESS Pointer to driver table or to registered
* major number are invalid. Device driver table is empty.
* @retval RTEMS_INVALID_NUMBER Invalid major number.
* @retval RTEMS_TOO_MANY No major number available.
* @retval RTEMS_RESOURCE_IN_USE Major number in use.
* @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
* @retval * Status code depends on rtems_io_initialize().
*/
rtems_status_code rtems_io_register_driver(
rtems_device_major_number major,
const rtems_driver_address_table *driver_table,
rtems_device_major_number *registered_major
);
/**
* @brief Unregister a driver from the device driver table.
*
* @param[in] major is the device major number.
*
* @retval RTEMS_SUCCESSFUL Device driver successfully unregistered.
* @retval RTEMS_UNSATISFIED Invalid major number.
* @retval RTEMS_CALLED_FROM_ISR Called from interrupt context.
*/
rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major
);
/**
* @brief Registers the name @a device_name in the file system for the device
* with number tuple @a major and @a minor.
*
* This assumes that all registered devices are character devices.
*
* @retval RTEMS_SUCCESSFUL Name successfully registered.
* @retval RTEMS_TOO_MANY Name already in use or other errors.
*/
rtems_status_code rtems_io_register_name(
const char *device_name,
rtems_device_major_number major,
rtems_device_minor_number minor
);
/** @} */
/**
* @brief IO driver initialization.
*
* This routine is the initialization directive of the IO manager.
*
* @param[in] major is the device drive number
* @param[in] minor is the device number
* @param[in] argument is the pointer to the argument(s)
*
* @return status code
*/
rtems_status_code rtems_io_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Opening for the IO manager.
*
* Opens a device driver with the number @a major.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_open(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Closing for the IO manager.
*
* This routine is the close directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_close(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Reading for the IO manager.
*
* This routine is the read directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_read(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Writing for the IO manager.
*
* This routine is the write directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/**
* @brief Control for the IO manager.
*
* This routine is the control directive of the IO manager.
*
* @param[in] major is the device driver number.
* @param[in] minor is the device number.
* @param[in] argument is the pointer to the argument(s).
*
* @return Status code.
*/
rtems_status_code rtems_io_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *argument
);
/** @} */
/** @} */
typedef struct {
const char *device_name;
size_t device_name_length;
rtems_device_major_number major;
rtems_device_minor_number minor;
} rtems_driver_name_t;
/**
* @deprecated Use stat() instead.
*/
rtems_status_code rtems_io_lookup_name(
const char *name,
rtems_driver_name_t *device_info
) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
extern const size_t _IO_Number_of_drivers;
extern rtems_driver_address_table _IO_Driver_address_table[];
/**
* @brief Initialization of all device drivers.
*
* Initializes all device drivers.
*/
void _IO_Initialize_all_drivers( void );
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
