]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
1a73661b SG |
2 | /* |
3 | * (C) Copyright 2000-2004 | |
4 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. | |
1a73661b SG |
5 | */ |
6 | ||
7 | #ifndef BLK_H | |
8 | #define BLK_H | |
9 | ||
ff98cb90 PJ |
10 | #include <efi.h> |
11 | ||
1a73661b SG |
12 | #ifdef CONFIG_SYS_64BIT_LBA |
13 | typedef uint64_t lbaint_t; | |
14 | #define LBAFlength "ll" | |
15 | #else | |
16 | typedef ulong lbaint_t; | |
17 | #define LBAFlength "l" | |
18 | #endif | |
19 | #define LBAF "%" LBAFlength "x" | |
20 | #define LBAFU "%" LBAFlength "u" | |
21 | ||
22 | /* Interface types: */ | |
5ec4f1a5 SG |
23 | enum if_type { |
24 | IF_TYPE_UNKNOWN = 0, | |
25 | IF_TYPE_IDE, | |
26 | IF_TYPE_SCSI, | |
27 | IF_TYPE_ATAPI, | |
28 | IF_TYPE_USB, | |
29 | IF_TYPE_DOC, | |
30 | IF_TYPE_MMC, | |
31 | IF_TYPE_SD, | |
32 | IF_TYPE_SATA, | |
33 | IF_TYPE_HOST, | |
ffab6945 | 34 | IF_TYPE_NVME, |
05ef48a2 | 35 | IF_TYPE_EFI, |
5ec4f1a5 SG |
36 | |
37 | IF_TYPE_COUNT, /* Number of interface types */ | |
38 | }; | |
1a73661b | 39 | |
eb81b1a4 BM |
40 | #define BLK_VEN_SIZE 40 |
41 | #define BLK_PRD_SIZE 20 | |
42 | #define BLK_REV_SIZE 8 | |
43 | ||
ff98cb90 PJ |
44 | /* |
45 | * Identifies the partition table type (ie. MBR vs GPT GUID) signature | |
46 | */ | |
47 | enum sig_type { | |
48 | SIG_TYPE_NONE, | |
49 | SIG_TYPE_MBR, | |
50 | SIG_TYPE_GUID, | |
51 | ||
52 | SIG_TYPE_COUNT /* Number of signature types */ | |
53 | }; | |
54 | ||
09d71aac SG |
55 | /* |
56 | * With driver model (CONFIG_BLK) this is uclass platform data, accessible | |
57 | * with dev_get_uclass_platdata(dev) | |
58 | */ | |
1a73661b | 59 | struct blk_desc { |
09d71aac SG |
60 | /* |
61 | * TODO: With driver model we should be able to use the parent | |
62 | * device's uclass instead. | |
63 | */ | |
5ec4f1a5 | 64 | enum if_type if_type; /* type of the interface */ |
bcce53d0 | 65 | int devnum; /* device number */ |
1a73661b SG |
66 | unsigned char part_type; /* partition type */ |
67 | unsigned char target; /* target SCSI ID */ | |
68 | unsigned char lun; /* target LUN */ | |
69 | unsigned char hwpart; /* HW partition, e.g. for eMMC */ | |
70 | unsigned char type; /* device type */ | |
71 | unsigned char removable; /* removable device */ | |
72 | #ifdef CONFIG_LBA48 | |
73 | /* device can use 48bit addr (ATA/ATAPI v7) */ | |
74 | unsigned char lba48; | |
75 | #endif | |
76 | lbaint_t lba; /* number of blocks */ | |
77 | unsigned long blksz; /* block size */ | |
78 | int log2blksz; /* for convenience: log2(blksz) */ | |
eb81b1a4 BM |
79 | char vendor[BLK_VEN_SIZE + 1]; /* device vendor string */ |
80 | char product[BLK_PRD_SIZE + 1]; /* device product number */ | |
81 | char revision[BLK_REV_SIZE + 1]; /* firmware revision */ | |
ff98cb90 PJ |
82 | enum sig_type sig_type; /* Partition table signature type */ |
83 | union { | |
84 | uint32_t mbr_sig; /* MBR integer signature */ | |
85 | efi_guid_t guid_sig; /* GPT GUID Signature */ | |
86 | }; | |
c4d660d4 | 87 | #if CONFIG_IS_ENABLED(BLK) |
b6694a33 SG |
88 | /* |
89 | * For now we have a few functions which take struct blk_desc as a | |
90 | * parameter. This field allows them to look up the associated | |
91 | * device. Once these functions are removed we can drop this field. | |
92 | */ | |
09d71aac SG |
93 | struct udevice *bdev; |
94 | #else | |
1a73661b SG |
95 | unsigned long (*block_read)(struct blk_desc *block_dev, |
96 | lbaint_t start, | |
97 | lbaint_t blkcnt, | |
98 | void *buffer); | |
99 | unsigned long (*block_write)(struct blk_desc *block_dev, | |
100 | lbaint_t start, | |
101 | lbaint_t blkcnt, | |
102 | const void *buffer); | |
103 | unsigned long (*block_erase)(struct blk_desc *block_dev, | |
104 | lbaint_t start, | |
105 | lbaint_t blkcnt); | |
106 | void *priv; /* driver private struct pointer */ | |
09d71aac | 107 | #endif |
1a73661b SG |
108 | }; |
109 | ||
110 | #define BLOCK_CNT(size, blk_desc) (PAD_COUNT(size, blk_desc->blksz)) | |
111 | #define PAD_TO_BLOCKSIZE(size, blk_desc) \ | |
112 | (PAD_SIZE(size, blk_desc->blksz)) | |
113 | ||
6fef62cc | 114 | #if CONFIG_IS_ENABLED(BLOCK_CACHE) |
e40cf34a EN |
115 | /** |
116 | * blkcache_read() - attempt to read a set of blocks from cache | |
117 | * | |
118 | * @param iftype - IF_TYPE_x for type of device | |
119 | * @param dev - device index of particular type | |
120 | * @param start - starting block number | |
121 | * @param blkcnt - number of blocks to read | |
122 | * @param blksz - size in bytes of each block | |
123 | * @param buf - buffer to contain cached data | |
124 | * | |
125 | * @return - '1' if block returned from cache, '0' otherwise. | |
126 | */ | |
c8e4d2a8 EN |
127 | int blkcache_read(int iftype, int dev, |
128 | lbaint_t start, lbaint_t blkcnt, | |
129 | unsigned long blksz, void *buffer); | |
e40cf34a EN |
130 | |
131 | /** | |
132 | * blkcache_fill() - make data read from a block device available | |
133 | * to the block cache | |
134 | * | |
135 | * @param iftype - IF_TYPE_x for type of device | |
136 | * @param dev - device index of particular type | |
137 | * @param start - starting block number | |
138 | * @param blkcnt - number of blocks available | |
139 | * @param blksz - size in bytes of each block | |
140 | * @param buf - buffer containing data to cache | |
141 | * | |
142 | */ | |
c8e4d2a8 EN |
143 | void blkcache_fill(int iftype, int dev, |
144 | lbaint_t start, lbaint_t blkcnt, | |
145 | unsigned long blksz, void const *buffer); | |
e40cf34a EN |
146 | |
147 | /** | |
148 | * blkcache_invalidate() - discard the cache for a set of blocks | |
149 | * because of a write or device (re)initialization. | |
150 | * | |
151 | * @param iftype - IF_TYPE_x for type of device | |
152 | * @param dev - device index of particular type | |
153 | */ | |
c8e4d2a8 | 154 | void blkcache_invalidate(int iftype, int dev); |
e40cf34a EN |
155 | |
156 | /** | |
157 | * blkcache_configure() - configure block cache | |
158 | * | |
159 | * @param blocks - maximum blocks per entry | |
160 | * @param entries - maximum entries in cache | |
161 | */ | |
162 | void blkcache_configure(unsigned blocks, unsigned entries); | |
163 | ||
164 | /* | |
165 | * statistics of the block cache | |
166 | */ | |
167 | struct block_cache_stats { | |
168 | unsigned hits; | |
169 | unsigned misses; | |
170 | unsigned entries; /* current entry count */ | |
171 | unsigned max_blocks_per_entry; | |
172 | unsigned max_entries; | |
173 | }; | |
174 | ||
175 | /** | |
176 | * get_blkcache_stats() - return statistics and reset | |
177 | * | |
178 | * @param stats - statistics are copied here | |
179 | */ | |
180 | void blkcache_stats(struct block_cache_stats *stats); | |
181 | ||
182 | #else | |
183 | ||
c8e4d2a8 EN |
184 | static inline int blkcache_read(int iftype, int dev, |
185 | lbaint_t start, lbaint_t blkcnt, | |
186 | unsigned long blksz, void *buffer) | |
e40cf34a EN |
187 | { |
188 | return 0; | |
189 | } | |
190 | ||
c8e4d2a8 EN |
191 | static inline void blkcache_fill(int iftype, int dev, |
192 | lbaint_t start, lbaint_t blkcnt, | |
193 | unsigned long blksz, void const *buffer) {} | |
e40cf34a | 194 | |
c8e4d2a8 | 195 | static inline void blkcache_invalidate(int iftype, int dev) {} |
e40cf34a EN |
196 | |
197 | #endif | |
198 | ||
c4d660d4 | 199 | #if CONFIG_IS_ENABLED(BLK) |
09d71aac SG |
200 | struct udevice; |
201 | ||
202 | /* Operations on block devices */ | |
203 | struct blk_ops { | |
204 | /** | |
205 | * read() - read from a block device | |
206 | * | |
207 | * @dev: Device to read from | |
208 | * @start: Start block number to read (0=first) | |
209 | * @blkcnt: Number of blocks to read | |
210 | * @buffer: Destination buffer for data read | |
211 | * @return number of blocks read, or -ve error number (see the | |
212 | * IS_ERR_VALUE() macro | |
213 | */ | |
214 | unsigned long (*read)(struct udevice *dev, lbaint_t start, | |
215 | lbaint_t blkcnt, void *buffer); | |
216 | ||
217 | /** | |
218 | * write() - write to a block device | |
219 | * | |
220 | * @dev: Device to write to | |
221 | * @start: Start block number to write (0=first) | |
222 | * @blkcnt: Number of blocks to write | |
223 | * @buffer: Source buffer for data to write | |
224 | * @return number of blocks written, or -ve error number (see the | |
225 | * IS_ERR_VALUE() macro | |
226 | */ | |
227 | unsigned long (*write)(struct udevice *dev, lbaint_t start, | |
228 | lbaint_t blkcnt, const void *buffer); | |
229 | ||
230 | /** | |
231 | * erase() - erase a section of a block device | |
232 | * | |
233 | * @dev: Device to (partially) erase | |
234 | * @start: Start block number to erase (0=first) | |
235 | * @blkcnt: Number of blocks to erase | |
236 | * @return number of blocks erased, or -ve error number (see the | |
237 | * IS_ERR_VALUE() macro | |
238 | */ | |
239 | unsigned long (*erase)(struct udevice *dev, lbaint_t start, | |
240 | lbaint_t blkcnt); | |
cd0fb55b SG |
241 | |
242 | /** | |
243 | * select_hwpart() - select a particular hardware partition | |
244 | * | |
245 | * Some devices (e.g. MMC) can support partitioning at the hardware | |
246 | * level. This is quite separate from the normal idea of | |
247 | * software-based partitions. MMC hardware partitions must be | |
248 | * explicitly selected. Once selected only the region of the device | |
249 | * covered by that partition is accessible. | |
250 | * | |
251 | * The MMC standard provides for two boot partitions (numbered 1 and 2), | |
252 | * rpmb (3), and up to 4 addition general-purpose partitions (4-7). | |
253 | * | |
254 | * @desc: Block device to update | |
255 | * @hwpart: Hardware partition number to select. 0 means the raw | |
256 | * device, 1 is the first partition, 2 is the second, etc. | |
257 | * @return 0 if OK, -ve on error | |
258 | */ | |
259 | int (*select_hwpart)(struct udevice *dev, int hwpart); | |
09d71aac SG |
260 | }; |
261 | ||
262 | #define blk_get_ops(dev) ((struct blk_ops *)(dev)->driver->ops) | |
263 | ||
264 | /* | |
265 | * These functions should take struct udevice instead of struct blk_desc, | |
266 | * but this is convenient for migration to driver model. Add a 'd' prefix | |
267 | * to the function operations, so that blk_read(), etc. can be reserved for | |
268 | * functions with the correct arguments. | |
269 | */ | |
270 | unsigned long blk_dread(struct blk_desc *block_dev, lbaint_t start, | |
271 | lbaint_t blkcnt, void *buffer); | |
272 | unsigned long blk_dwrite(struct blk_desc *block_dev, lbaint_t start, | |
273 | lbaint_t blkcnt, const void *buffer); | |
274 | unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start, | |
275 | lbaint_t blkcnt); | |
276 | ||
6139281a SG |
277 | /** |
278 | * blk_find_device() - Find a block device | |
279 | * | |
280 | * This function does not activate the device. The device will be returned | |
281 | * whether or not it is activated. | |
282 | * | |
283 | * @if_type: Interface type (enum if_type_t) | |
284 | * @devnum: Device number (specific to each interface type) | |
285 | * @devp: the device, if found | |
286 | * @return 0 if found, -ENODEV if no device found, or other -ve error value | |
287 | */ | |
288 | int blk_find_device(int if_type, int devnum, struct udevice **devp); | |
289 | ||
09d71aac SG |
290 | /** |
291 | * blk_get_device() - Find and probe a block device ready for use | |
292 | * | |
293 | * @if_type: Interface type (enum if_type_t) | |
294 | * @devnum: Device number (specific to each interface type) | |
295 | * @devp: the device, if found | |
6139281a | 296 | * @return 0 if found, -ENODEV if no device found, or other -ve error value |
09d71aac SG |
297 | */ |
298 | int blk_get_device(int if_type, int devnum, struct udevice **devp); | |
299 | ||
300 | /** | |
301 | * blk_first_device() - Find the first device for a given interface | |
302 | * | |
303 | * The device is probed ready for use | |
304 | * | |
305 | * @devnum: Device number (specific to each interface type) | |
306 | * @devp: the device, if found | |
307 | * @return 0 if found, -ENODEV if no device, or other -ve error value | |
308 | */ | |
309 | int blk_first_device(int if_type, struct udevice **devp); | |
310 | ||
311 | /** | |
312 | * blk_next_device() - Find the next device for a given interface | |
313 | * | |
314 | * This can be called repeatedly after blk_first_device() to iterate through | |
315 | * all devices of the given interface type. | |
316 | * | |
317 | * The device is probed ready for use | |
318 | * | |
319 | * @devp: On entry, the previous device returned. On exit, the next | |
320 | * device, if found | |
321 | * @return 0 if found, -ENODEV if no device, or other -ve error value | |
322 | */ | |
323 | int blk_next_device(struct udevice **devp); | |
324 | ||
325 | /** | |
326 | * blk_create_device() - Create a new block device | |
327 | * | |
328 | * @parent: Parent of the new device | |
329 | * @drv_name: Driver name to use for the block device | |
330 | * @name: Name for the device | |
331 | * @if_type: Interface type (enum if_type_t) | |
52138fd4 SG |
332 | * @devnum: Device number, specific to the interface type, or -1 to |
333 | * allocate the next available number | |
09d71aac | 334 | * @blksz: Block size of the device in bytes (typically 512) |
5fe7702e | 335 | * @lba: Total number of blocks of the device |
09d71aac SG |
336 | * @devp: the new device (which has not been probed) |
337 | */ | |
338 | int blk_create_device(struct udevice *parent, const char *drv_name, | |
339 | const char *name, int if_type, int devnum, int blksz, | |
5fe7702e | 340 | lbaint_t lba, struct udevice **devp); |
09d71aac | 341 | |
9107c973 SG |
342 | /** |
343 | * blk_create_devicef() - Create a new named block device | |
344 | * | |
345 | * @parent: Parent of the new device | |
346 | * @drv_name: Driver name to use for the block device | |
347 | * @name: Name for the device (parent name is prepended) | |
348 | * @if_type: Interface type (enum if_type_t) | |
349 | * @devnum: Device number, specific to the interface type, or -1 to | |
350 | * allocate the next available number | |
351 | * @blksz: Block size of the device in bytes (typically 512) | |
5fe7702e | 352 | * @lba: Total number of blocks of the device |
9107c973 SG |
353 | * @devp: the new device (which has not been probed) |
354 | */ | |
355 | int blk_create_devicef(struct udevice *parent, const char *drv_name, | |
356 | const char *name, int if_type, int devnum, int blksz, | |
5fe7702e | 357 | lbaint_t lba, struct udevice **devp); |
9107c973 | 358 | |
09d71aac SG |
359 | /** |
360 | * blk_prepare_device() - Prepare a block device for use | |
361 | * | |
362 | * This reads partition information from the device if supported. | |
363 | * | |
364 | * @dev: Device to prepare | |
365 | * @return 0 if ok, -ve on error | |
366 | */ | |
367 | int blk_prepare_device(struct udevice *dev); | |
368 | ||
369 | /** | |
370 | * blk_unbind_all() - Unbind all device of the given interface type | |
371 | * | |
372 | * The devices are removed and then unbound. | |
373 | * | |
374 | * @if_type: Interface type to unbind | |
375 | * @return 0 if OK, -ve on error | |
376 | */ | |
377 | int blk_unbind_all(int if_type); | |
378 | ||
52138fd4 SG |
379 | /** |
380 | * blk_find_max_devnum() - find the maximum device number for an interface type | |
381 | * | |
382 | * Finds the last allocated device number for an interface type @if_type. The | |
383 | * next number is safe to use for a newly allocated device. | |
384 | * | |
385 | * @if_type: Interface type to scan | |
386 | * @return maximum device number found, or -ENODEV if none, or other -ve on | |
387 | * error | |
388 | */ | |
389 | int blk_find_max_devnum(enum if_type if_type); | |
390 | ||
cd0fb55b SG |
391 | /** |
392 | * blk_select_hwpart() - select a hardware partition | |
393 | * | |
394 | * Select a hardware partition if the device supports it (typically MMC does) | |
395 | * | |
396 | * @dev: Device to update | |
397 | * @hwpart: Partition number to select | |
398 | * @return 0 if OK, -ve on error | |
399 | */ | |
400 | int blk_select_hwpart(struct udevice *dev, int hwpart); | |
401 | ||
4bdb49a7 TR |
402 | /** |
403 | * blk_get_from_parent() - obtain a block device by looking up its parent | |
404 | * | |
405 | * All devices with | |
406 | */ | |
407 | int blk_get_from_parent(struct udevice *parent, struct udevice **devp); | |
408 | ||
09d71aac SG |
409 | #else |
410 | #include <errno.h> | |
2a981dc2 SG |
411 | /* |
412 | * These functions should take struct udevice instead of struct blk_desc, | |
413 | * but this is convenient for migration to driver model. Add a 'd' prefix | |
414 | * to the function operations, so that blk_read(), etc. can be reserved for | |
415 | * functions with the correct arguments. | |
416 | */ | |
417 | static inline ulong blk_dread(struct blk_desc *block_dev, lbaint_t start, | |
418 | lbaint_t blkcnt, void *buffer) | |
419 | { | |
e40cf34a EN |
420 | ulong blks_read; |
421 | if (blkcache_read(block_dev->if_type, block_dev->devnum, | |
422 | start, blkcnt, block_dev->blksz, buffer)) | |
423 | return blkcnt; | |
424 | ||
2a981dc2 SG |
425 | /* |
426 | * We could check if block_read is NULL and return -ENOSYS. But this | |
427 | * bloats the code slightly (cause some board to fail to build), and | |
428 | * it would be an error to try an operation that does not exist. | |
429 | */ | |
e40cf34a EN |
430 | blks_read = block_dev->block_read(block_dev, start, blkcnt, buffer); |
431 | if (blks_read == blkcnt) | |
432 | blkcache_fill(block_dev->if_type, block_dev->devnum, | |
433 | start, blkcnt, block_dev->blksz, buffer); | |
434 | ||
435 | return blks_read; | |
2a981dc2 SG |
436 | } |
437 | ||
438 | static inline ulong blk_dwrite(struct blk_desc *block_dev, lbaint_t start, | |
439 | lbaint_t blkcnt, const void *buffer) | |
440 | { | |
e40cf34a | 441 | blkcache_invalidate(block_dev->if_type, block_dev->devnum); |
2a981dc2 SG |
442 | return block_dev->block_write(block_dev, start, blkcnt, buffer); |
443 | } | |
444 | ||
445 | static inline ulong blk_derase(struct blk_desc *block_dev, lbaint_t start, | |
446 | lbaint_t blkcnt) | |
447 | { | |
e40cf34a | 448 | blkcache_invalidate(block_dev->if_type, block_dev->devnum); |
2a981dc2 SG |
449 | return block_dev->block_erase(block_dev, start, blkcnt); |
450 | } | |
6eef6eac SG |
451 | |
452 | /** | |
453 | * struct blk_driver - Driver for block interface types | |
454 | * | |
455 | * This provides access to the block devices for each interface type. One | |
456 | * driver should be provided using U_BOOT_LEGACY_BLK() for each interface | |
457 | * type that is to be supported. | |
458 | * | |
459 | * @if_typename: Interface type name | |
460 | * @if_type: Interface type | |
461 | * @max_devs: Maximum number of devices supported | |
462 | * @desc: Pointer to list of devices for this interface type, | |
463 | * or NULL to use @get_dev() instead | |
464 | */ | |
465 | struct blk_driver { | |
466 | const char *if_typename; | |
467 | enum if_type if_type; | |
468 | int max_devs; | |
469 | struct blk_desc *desc; | |
470 | /** | |
471 | * get_dev() - get a pointer to a block device given its number | |
472 | * | |
473 | * Each interface allocates its own devices and typically | |
474 | * struct blk_desc is contained with the interface's data structure. | |
475 | * There is no global numbering for block devices. This method allows | |
476 | * the device for an interface type to be obtained when @desc is NULL. | |
477 | * | |
478 | * @devnum: Device number (0 for first device on that interface, | |
479 | * 1 for second, etc. | |
480 | * @descp: Returns pointer to the block device on success | |
481 | * @return 0 if OK, -ve on error | |
482 | */ | |
483 | int (*get_dev)(int devnum, struct blk_desc **descp); | |
484 | ||
485 | /** | |
486 | * select_hwpart() - Select a hardware partition | |
487 | * | |
488 | * Some devices (e.g. MMC) can support partitioning at the hardware | |
489 | * level. This is quite separate from the normal idea of | |
490 | * software-based partitions. MMC hardware partitions must be | |
491 | * explicitly selected. Once selected only the region of the device | |
492 | * covered by that partition is accessible. | |
493 | * | |
494 | * The MMC standard provides for two boot partitions (numbered 1 and 2), | |
495 | * rpmb (3), and up to 4 addition general-purpose partitions (4-7). | |
496 | * Partition 0 is the main user-data partition. | |
497 | * | |
498 | * @desc: Block device descriptor | |
499 | * @hwpart: Hardware partition number to select. 0 means the main | |
500 | * user-data partition, 1 is the first partition, 2 is | |
501 | * the second, etc. | |
502 | * @return 0 if OK, other value for an error | |
503 | */ | |
504 | int (*select_hwpart)(struct blk_desc *desc, int hwpart); | |
505 | }; | |
506 | ||
507 | /* | |
508 | * Declare a new U-Boot legacy block driver. New drivers should use driver | |
509 | * model (UCLASS_BLK). | |
510 | */ | |
511 | #define U_BOOT_LEGACY_BLK(__name) \ | |
512 | ll_entry_declare(struct blk_driver, __name, blk_driver) | |
513 | ||
514 | struct blk_driver *blk_driver_lookup_type(int if_type); | |
515 | ||
09d71aac | 516 | #endif /* !CONFIG_BLK */ |
2a981dc2 | 517 | |
6eef6eac SG |
518 | /** |
519 | * blk_get_devnum_by_typename() - Get a block device by type and number | |
520 | * | |
521 | * This looks through the available block devices of the given type, returning | |
522 | * the one with the given @devnum. | |
523 | * | |
524 | * @if_type: Block device type | |
525 | * @devnum: Device number | |
526 | * @return point to block device descriptor, or NULL if not found | |
527 | */ | |
528 | struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum); | |
529 | ||
530 | /** | |
531 | * blk_get_devnum_by_type() - Get a block device by type name, and number | |
532 | * | |
533 | * This looks up the block device type based on @if_typename, then calls | |
534 | * blk_get_devnum_by_type(). | |
535 | * | |
536 | * @if_typename: Block device type name | |
537 | * @devnum: Device number | |
538 | * @return point to block device descriptor, or NULL if not found | |
539 | */ | |
540 | struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, | |
541 | int devnum); | |
542 | ||
543 | /** | |
544 | * blk_dselect_hwpart() - select a hardware partition | |
545 | * | |
546 | * This selects a hardware partition (such as is supported by MMC). The block | |
547 | * device size may change as this effectively points the block device to a | |
548 | * partition at the hardware level. See the select_hwpart() method above. | |
549 | * | |
550 | * @desc: Block device descriptor for the device to select | |
551 | * @hwpart: Partition number to select | |
552 | * @return 0 if OK, -ve on error | |
553 | */ | |
554 | int blk_dselect_hwpart(struct blk_desc *desc, int hwpart); | |
555 | ||
556 | /** | |
557 | * blk_list_part() - list the partitions for block devices of a given type | |
558 | * | |
559 | * This looks up the partition type for each block device of type @if_type, | |
560 | * then displays a list of partitions. | |
561 | * | |
562 | * @if_type: Block device type | |
563 | * @return 0 if OK, -ENODEV if there is none of that type | |
564 | */ | |
565 | int blk_list_part(enum if_type if_type); | |
566 | ||
567 | /** | |
568 | * blk_list_devices() - list the block devices of a given type | |
569 | * | |
570 | * This lists each block device of the type @if_type, showing the capacity | |
571 | * as well as type-specific information. | |
572 | * | |
573 | * @if_type: Block device type | |
574 | */ | |
575 | void blk_list_devices(enum if_type if_type); | |
576 | ||
577 | /** | |
578 | * blk_show_device() - show information about a given block device | |
579 | * | |
580 | * This shows the block device capacity as well as type-specific information. | |
581 | * | |
582 | * @if_type: Block device type | |
583 | * @devnum: Device number | |
584 | * @return 0 if OK, -ENODEV for invalid device number | |
585 | */ | |
586 | int blk_show_device(enum if_type if_type, int devnum); | |
587 | ||
588 | /** | |
589 | * blk_print_device_num() - show information about a given block device | |
590 | * | |
591 | * This is similar to blk_show_device() but returns an error if the block | |
592 | * device type is unknown. | |
593 | * | |
594 | * @if_type: Block device type | |
595 | * @devnum: Device number | |
596 | * @return 0 if OK, -ENODEV for invalid device number, -ENOENT if the block | |
597 | * device is not connected | |
598 | */ | |
599 | int blk_print_device_num(enum if_type if_type, int devnum); | |
600 | ||
601 | /** | |
602 | * blk_print_part_devnum() - print the partition information for a device | |
603 | * | |
604 | * @if_type: Block device type | |
605 | * @devnum: Device number | |
606 | * @return 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if | |
607 | * the interface type is not supported, other -ve on other error | |
608 | */ | |
609 | int blk_print_part_devnum(enum if_type if_type, int devnum); | |
610 | ||
611 | /** | |
612 | * blk_read_devnum() - read blocks from a device | |
613 | * | |
614 | * @if_type: Block device type | |
615 | * @devnum: Device number | |
616 | * @blkcnt: Number of blocks to read | |
617 | * @buffer: Address to write data to | |
618 | * @return number of blocks read, or -ve error number on error | |
619 | */ | |
620 | ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start, | |
621 | lbaint_t blkcnt, void *buffer); | |
622 | ||
623 | /** | |
624 | * blk_write_devnum() - write blocks to a device | |
625 | * | |
626 | * @if_type: Block device type | |
627 | * @devnum: Device number | |
628 | * @blkcnt: Number of blocks to write | |
629 | * @buffer: Address to read data from | |
630 | * @return number of blocks written, or -ve error number on error | |
631 | */ | |
632 | ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start, | |
633 | lbaint_t blkcnt, const void *buffer); | |
634 | ||
635 | /** | |
636 | * blk_select_hwpart_devnum() - select a hardware partition | |
637 | * | |
638 | * This is similar to blk_dselect_hwpart() but it looks up the interface and | |
639 | * device number. | |
640 | * | |
641 | * @if_type: Block device type | |
642 | * @devnum: Device number | |
643 | * @hwpart: Partition number to select | |
644 | * @return 0 if OK, -ve on error | |
645 | */ | |
646 | int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart); | |
647 | ||
6faa4ed7 SG |
648 | /** |
649 | * blk_get_if_type_name() - Get the name of an interface type | |
650 | * | |
651 | * @if_type: Interface type to check | |
652 | * @return name of interface, or NULL if none | |
653 | */ | |
654 | const char *blk_get_if_type_name(enum if_type if_type); | |
655 | ||
4395f667 SG |
656 | /** |
657 | * blk_common_cmd() - handle common commands with block devices | |
658 | * | |
659 | * @args: Number of arguments to the command (argv[0] is the command itself) | |
660 | * @argv: Command arguments | |
661 | * @if_type: Interface type | |
662 | * @cur_devnump: Current device number for this interface type | |
663 | * @return 0 if OK, CMD_RET_ERROR on error | |
664 | */ | |
665 | int blk_common_cmd(int argc, char * const argv[], enum if_type if_type, | |
666 | int *cur_devnump); | |
667 | ||
1a73661b | 668 | #endif |