1 | /** |
---|
2 | * @file |
---|
3 | * |
---|
4 | * @ingroup rtems_blkdev |
---|
5 | * |
---|
6 | * Block device management. |
---|
7 | */ |
---|
8 | |
---|
9 | /* |
---|
10 | * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia |
---|
11 | * Author: Victor V. Vengerov <vvv@oktet.ru> |
---|
12 | * |
---|
13 | * @(#) $Id$ |
---|
14 | */ |
---|
15 | |
---|
16 | #ifndef _RTEMS_BLKDEV_H |
---|
17 | #define _RTEMS_BLKDEV_H |
---|
18 | |
---|
19 | #include <rtems.h> |
---|
20 | #include <sys/ioctl.h> |
---|
21 | |
---|
22 | #ifdef __cplusplus |
---|
23 | extern "C" { |
---|
24 | #endif |
---|
25 | |
---|
26 | /** |
---|
27 | * @defgroup rtems_blkdev Block Device Management |
---|
28 | * |
---|
29 | * @ingroup rtems_libblock |
---|
30 | * |
---|
31 | * Interface between device drivers and the |
---|
32 | * @ref rtems_bdbuf "block device buffer module". |
---|
33 | * |
---|
34 | * The heart of the block device driver is the @ref RTEMS_BLKIO_REQUEST IO |
---|
35 | * control. This call puts IO @ref rtems_blkdev_request "requests" to the block |
---|
36 | * device for asynchronous processing. When a driver executes a request, it |
---|
37 | * invokes the request done callback function to finish the request. |
---|
38 | * |
---|
39 | * @{ |
---|
40 | */ |
---|
41 | |
---|
42 | /** |
---|
43 | * Block device block index type. |
---|
44 | */ |
---|
45 | typedef uint32_t rtems_blkdev_bnum; |
---|
46 | |
---|
47 | /** |
---|
48 | * Block device request type. |
---|
49 | */ |
---|
50 | typedef enum rtems_blkdev_request_op { |
---|
51 | RTEMS_BLKDEV_REQ_READ, /**< Read the requested blocks of data. */ |
---|
52 | RTEMS_BLKDEV_REQ_WRITE, /**< Write the requested blocks of data. */ |
---|
53 | RTEMS_BLKDEV_CAPABILITIES /**< Return the driver capabilities set. */ |
---|
54 | } rtems_blkdev_request_op; |
---|
55 | |
---|
56 | /** |
---|
57 | * Only consecutive multi-sector buffer requests are supported. |
---|
58 | * |
---|
59 | * This option means the cache will only supply multiple buffers that are |
---|
60 | * inorder so the ATA multi-sector command for example can be used. This is a |
---|
61 | * hack to work around the current ATA driver. |
---|
62 | */ |
---|
63 | #define RTEMS_BLKDEV_CAP_MULTISECTOR_CONT (1 << 0) |
---|
64 | |
---|
65 | /** |
---|
66 | * Type for block device request done callback function. |
---|
67 | * |
---|
68 | * @param arg Argument supplied in @ref rtems_blkdev_request. |
---|
69 | * @param status Status code for this operation. |
---|
70 | * @param errno The @c errno value to be passed to the user when status is not |
---|
71 | * equal to @c RTEMS_SUCCESSFUL. |
---|
72 | */ |
---|
73 | typedef void (* rtems_blkdev_request_cb)(void *arg, |
---|
74 | rtems_status_code status, |
---|
75 | int error); |
---|
76 | |
---|
77 | /** |
---|
78 | * Block device scatter or gather buffer structure. |
---|
79 | */ |
---|
80 | typedef struct rtems_blkdev_sg_buffer { |
---|
81 | /** |
---|
82 | * Block index. |
---|
83 | */ |
---|
84 | rtems_blkdev_bnum block; |
---|
85 | |
---|
86 | /** |
---|
87 | * Buffer length. |
---|
88 | */ |
---|
89 | uint32_t length; |
---|
90 | |
---|
91 | /** |
---|
92 | * Buffer pointer. |
---|
93 | */ |
---|
94 | void *buffer; |
---|
95 | |
---|
96 | /** |
---|
97 | * User pointer. |
---|
98 | */ |
---|
99 | void *user; |
---|
100 | } rtems_blkdev_sg_buffer; |
---|
101 | |
---|
102 | /** |
---|
103 | * The block device request structure is used to read or write a number of |
---|
104 | * blocks from or to the device. |
---|
105 | */ |
---|
106 | typedef struct rtems_blkdev_request { |
---|
107 | /** |
---|
108 | * Block device operation (read or write). |
---|
109 | */ |
---|
110 | rtems_blkdev_request_op req; |
---|
111 | |
---|
112 | /** |
---|
113 | * Request done callback function. |
---|
114 | */ |
---|
115 | rtems_blkdev_request_cb req_done; |
---|
116 | |
---|
117 | /** |
---|
118 | * Argument to be passed to callback function. |
---|
119 | */ |
---|
120 | void *done_arg; |
---|
121 | |
---|
122 | /** |
---|
123 | * Last IO operation completion status. |
---|
124 | */ |
---|
125 | rtems_status_code status; |
---|
126 | |
---|
127 | /** |
---|
128 | * If @c status is not equal to @c RTEMS_SUCCESSFUL, this field contains the |
---|
129 | * error number. |
---|
130 | */ |
---|
131 | int error; |
---|
132 | |
---|
133 | /** |
---|
134 | * Number of blocks for this request. |
---|
135 | */ |
---|
136 | uint32_t bufnum; |
---|
137 | |
---|
138 | /** |
---|
139 | * The task requesting the IO operation. |
---|
140 | */ |
---|
141 | rtems_id io_task; |
---|
142 | |
---|
143 | /** |
---|
144 | * List of scatter or gather buffers. |
---|
145 | */ |
---|
146 | rtems_blkdev_sg_buffer bufs[0]; |
---|
147 | } rtems_blkdev_request; |
---|
148 | |
---|
149 | /** |
---|
150 | * The start block in a request. |
---|
151 | * |
---|
152 | * Only valid if the driver has returned the @ref RTEMS_BLKDEV_CAPABILITIES of |
---|
153 | * @ref RTEMS_BLKDEV_CAP_MULTISECTOR_CONT. |
---|
154 | */ |
---|
155 | #define RTEMS_BLKDEV_START_BLOCK(req) (req->bufs[0].block) |
---|
156 | |
---|
157 | /** |
---|
158 | * @name IO Control Request Codes |
---|
159 | * |
---|
160 | * @{ |
---|
161 | */ |
---|
162 | |
---|
163 | #define RTEMS_BLKIO_REQUEST _IOWR('B', 1, rtems_blkdev_request) |
---|
164 | #define RTEMS_BLKIO_GETMEDIABLKSIZE _IO('B', 2) |
---|
165 | #define RTEMS_BLKIO_GETBLKSIZE _IO('B', 3) |
---|
166 | #define RTEMS_BLKIO_SETBLKSIZE _IO('B', 4) |
---|
167 | #define RTEMS_BLKIO_GETSIZE _IO('B', 5) |
---|
168 | #define RTEMS_BLKIO_SYNCDEV _IO('B', 6) |
---|
169 | |
---|
170 | /** @} */ |
---|
171 | |
---|
172 | /** |
---|
173 | * The device driver interface conventions suppose that a driver may contain an |
---|
174 | * initialize, open, close, read, write and IO control entry points. These |
---|
175 | * primitives (except initialize) can be implemented in a generic fashion based |
---|
176 | * upon the supplied block device driver IO control handler. Every block device |
---|
177 | * driver should provide an initialize entry point, which registers the |
---|
178 | * appropriate IO control handler. |
---|
179 | */ |
---|
180 | #define RTEMS_GENERIC_BLOCK_DEVICE_DRIVER_ENTRIES \ |
---|
181 | .open_entry = rtems_blkdev_generic_open, \ |
---|
182 | .close_entry = rtems_blkdev_generic_close, \ |
---|
183 | .read_entry = rtems_blkdev_generic_read, \ |
---|
184 | .write_entry = rtems_blkdev_generic_write, \ |
---|
185 | .control_entry = rtems_blkdev_generic_ioctl |
---|
186 | |
---|
187 | /** |
---|
188 | * Generic block device read primitive. |
---|
189 | * |
---|
190 | * Implemented using block device buffer management primitives. |
---|
191 | */ |
---|
192 | rtems_device_driver |
---|
193 | rtems_blkdev_generic_read( |
---|
194 | rtems_device_major_number major, |
---|
195 | rtems_device_minor_number minor, |
---|
196 | void * arg |
---|
197 | ); |
---|
198 | |
---|
199 | /** |
---|
200 | * Generic block device write primitive. |
---|
201 | * |
---|
202 | * Implemented using block device buffer management primitives. |
---|
203 | */ |
---|
204 | rtems_device_driver |
---|
205 | rtems_blkdev_generic_write( |
---|
206 | rtems_device_major_number major, |
---|
207 | rtems_device_minor_number minor, |
---|
208 | void * arg |
---|
209 | ); |
---|
210 | |
---|
211 | /** |
---|
212 | * Generic block device open primitive. |
---|
213 | * |
---|
214 | * Implemented using block device buffer management primitives. |
---|
215 | */ |
---|
216 | rtems_device_driver |
---|
217 | rtems_blkdev_generic_open( |
---|
218 | rtems_device_major_number major, |
---|
219 | rtems_device_minor_number minor, |
---|
220 | void * arg |
---|
221 | ); |
---|
222 | |
---|
223 | /** |
---|
224 | * Generic block device close primitive. |
---|
225 | * |
---|
226 | * Implemented using block device buffer management primitives. |
---|
227 | */ |
---|
228 | rtems_device_driver |
---|
229 | rtems_blkdev_generic_close( |
---|
230 | rtems_device_major_number major, |
---|
231 | rtems_device_minor_number minor, |
---|
232 | void * arg |
---|
233 | ); |
---|
234 | |
---|
235 | /** |
---|
236 | * Generic block device IO control primitive. |
---|
237 | * |
---|
238 | * Implemented using block device buffer management primitives. |
---|
239 | */ |
---|
240 | rtems_device_driver |
---|
241 | rtems_blkdev_generic_ioctl( |
---|
242 | rtems_device_major_number major, |
---|
243 | rtems_device_minor_number minor, |
---|
244 | void * arg |
---|
245 | ); |
---|
246 | |
---|
247 | /** |
---|
248 | * Common IO control primitive. |
---|
249 | * |
---|
250 | * Use this in all block devices to handle the common set of ioctl requests. |
---|
251 | */ |
---|
252 | int |
---|
253 | rtems_blkdev_ioctl(dev_t dev, uint32_t req, void *argp); |
---|
254 | |
---|
255 | /** @} */ |
---|
256 | |
---|
257 | #ifdef __cplusplus |
---|
258 | } |
---|
259 | #endif |
---|
260 | |
---|
261 | #endif |
---|