1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * (C) Copyright 2000-2004
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
10 #include <dm/uclass-id.h>
13 #ifdef CONFIG_SYS_64BIT_LBA
14 typedef uint64_t lbaint_t;
15 #define LBAFlength "ll"
17 typedef ulong lbaint_t;
18 #define LBAFlength "l"
20 #define LBAF "%" LBAFlength "x"
21 #define LBAFU "%" LBAFlength "u"
25 static inline bool blk_enabled(void)
27 return CONFIG_IS_ENABLED(BLK) || IS_ENABLED(CONFIG_SPL_LEGACY_BLOCK);
30 #define BLK_VEN_SIZE 40
31 #define BLK_PRD_SIZE 20
32 #define BLK_REV_SIZE 8
34 #define PART_FORMAT_PCAT 0x1
35 #define PART_FORMAT_GPT 0x2
38 * Identifies the partition table type (ie. MBR vs GPT GUID) signature
45 SIG_TYPE_COUNT /* Number of signature types */
49 * With driver model (CONFIG_BLK) this is uclass platform data, accessible
50 * with dev_get_uclass_plat(dev)
54 * TODO: With driver model we should be able to use the parent
55 * device's uclass instead.
57 enum uclass_id uclass_id; /* type of the interface */
58 int devnum; /* device number */
59 unsigned char part_type; /* partition type */
60 unsigned char target; /* target SCSI ID */
61 unsigned char lun; /* target LUN */
62 unsigned char hwpart; /* HW partition, e.g. for eMMC */
63 unsigned char type; /* device type */
64 unsigned char removable; /* removable device */
66 /* device can use 48bit addr (ATA/ATAPI v7) */
69 lbaint_t lba; /* number of blocks */
70 unsigned long blksz; /* block size */
71 int log2blksz; /* for convenience: log2(blksz) */
72 char vendor[BLK_VEN_SIZE + 1]; /* device vendor string */
73 char product[BLK_PRD_SIZE + 1]; /* device product number */
74 char revision[BLK_REV_SIZE + 1]; /* firmware revision */
75 enum sig_type sig_type; /* Partition table signature type */
77 uint32_t mbr_sig; /* MBR integer signature */
78 efi_guid_t guid_sig; /* GPT GUID Signature */
80 #if CONFIG_IS_ENABLED(BLK)
82 * For now we have a few functions which take struct blk_desc as a
83 * parameter. This field allows them to look up the associated
84 * device. Once these functions are removed we can drop this field.
88 unsigned long (*block_read)(struct blk_desc *block_dev,
92 unsigned long (*block_write)(struct blk_desc *block_dev,
96 unsigned long (*block_erase)(struct blk_desc *block_dev,
99 void *priv; /* driver private struct pointer */
103 #define BLOCK_CNT(size, blk_desc) (PAD_COUNT(size, blk_desc->blksz))
104 #define PAD_TO_BLOCKSIZE(size, blk_desc) \
105 (PAD_SIZE(size, blk_desc->blksz))
107 #if CONFIG_IS_ENABLED(BLOCK_CACHE)
110 * blkcache_init() - initialize the block cache list pointers
112 int blkcache_init(void);
115 * blkcache_read() - attempt to read a set of blocks from cache
117 * @param iftype - uclass_id_x for type of device
118 * @param dev - device index of particular type
119 * @param start - starting block number
120 * @param blkcnt - number of blocks to read
121 * @param blksz - size in bytes of each block
122 * @param buffer - buffer to contain cached data
124 * Return: - 1 if block returned from cache, 0 otherwise.
126 int blkcache_read(int iftype, int dev,
127 lbaint_t start, lbaint_t blkcnt,
128 unsigned long blksz, void *buffer);
131 * blkcache_fill() - make data read from a block device available
134 * @param iftype - uclass_id_x for type of device
135 * @param dev - device index of particular type
136 * @param start - starting block number
137 * @param blkcnt - number of blocks available
138 * @param blksz - size in bytes of each block
139 * @param buffer - buffer containing data to cache
142 void blkcache_fill(int iftype, int dev,
143 lbaint_t start, lbaint_t blkcnt,
144 unsigned long blksz, void const *buffer);
147 * blkcache_invalidate() - discard the cache for a set of blocks
148 * because of a write or device (re)initialization.
150 * @param iftype - uclass_id_x for type of device
151 * @param dev - device index of particular type
153 void blkcache_invalidate(int iftype, int dev);
156 * blkcache_configure() - configure block cache
158 * @param blocks - maximum blocks per entry
159 * @param entries - maximum entries in cache
161 void blkcache_configure(unsigned blocks, unsigned entries);
164 * statistics of the block cache
166 struct block_cache_stats {
169 unsigned entries; /* current entry count */
170 unsigned max_blocks_per_entry;
171 unsigned max_entries;
175 * get_blkcache_stats() - return statistics and reset
177 * @param stats - statistics are copied here
179 void blkcache_stats(struct block_cache_stats *stats);
183 static inline int blkcache_read(int iftype, int dev,
184 lbaint_t start, lbaint_t blkcnt,
185 unsigned long blksz, void *buffer)
190 static inline void blkcache_fill(int iftype, int dev,
191 lbaint_t start, lbaint_t blkcnt,
192 unsigned long blksz, void const *buffer) {}
194 static inline void blkcache_invalidate(int iftype, int dev) {}
198 #if CONFIG_IS_ENABLED(BLK)
201 /* Operations on block devices */
204 * read() - read from a block device
206 * @dev: Device to read from
207 * @start: Start block number to read (0=first)
208 * @blkcnt: Number of blocks to read
209 * @buffer: Destination buffer for data read
210 * @return number of blocks read, or -ve error number (see the
211 * IS_ERR_VALUE() macro
213 unsigned long (*read)(struct udevice *dev, lbaint_t start,
214 lbaint_t blkcnt, void *buffer);
217 * write() - write to a block device
219 * @dev: Device to write to
220 * @start: Start block number to write (0=first)
221 * @blkcnt: Number of blocks to write
222 * @buffer: Source buffer for data to write
223 * @return number of blocks written, or -ve error number (see the
224 * IS_ERR_VALUE() macro
226 unsigned long (*write)(struct udevice *dev, lbaint_t start,
227 lbaint_t blkcnt, const void *buffer);
230 * erase() - erase a section of a block device
232 * @dev: Device to (partially) erase
233 * @start: Start block number to erase (0=first)
234 * @blkcnt: Number of blocks to erase
235 * @return number of blocks erased, or -ve error number (see the
236 * IS_ERR_VALUE() macro
238 unsigned long (*erase)(struct udevice *dev, lbaint_t start,
242 * select_hwpart() - select a particular hardware partition
244 * Some devices (e.g. MMC) can support partitioning at the hardware
245 * level. This is quite separate from the normal idea of
246 * software-based partitions. MMC hardware partitions must be
247 * explicitly selected. Once selected only the region of the device
248 * covered by that partition is accessible.
250 * The MMC standard provides for two boot partitions (numbered 1 and 2),
251 * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
253 * @dev: Block device to update
254 * @hwpart: Hardware partition number to select. 0 means the raw
255 * device, 1 is the first partition, 2 is the second, etc.
256 * @return 0 if OK, -ve on error
258 int (*select_hwpart)(struct udevice *dev, int hwpart);
261 #define blk_get_ops(dev) ((struct blk_ops *)(dev)->driver->ops)
264 * These functions should take struct udevice instead of struct blk_desc,
265 * but this is convenient for migration to driver model. Add a 'd' prefix
266 * to the function operations, so that blk_read(), etc. can be reserved for
267 * functions with the correct arguments.
269 unsigned long blk_dread(struct blk_desc *block_dev, lbaint_t start,
270 lbaint_t blkcnt, void *buffer);
271 unsigned long blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
272 lbaint_t blkcnt, const void *buffer);
273 unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start,
277 * blk_find_device() - Find a block device
279 * This function does not activate the device. The device will be returned
280 * whether or not it is activated.
282 * @uclass_id: Interface type (enum uclass_id_t)
283 * @devnum: Device number (specific to each interface type)
284 * @devp: the device, if found
285 * Return: 0 if found, -ENODEV if no device found, or other -ve error value
287 int blk_find_device(int uclass_id, int devnum, struct udevice **devp);
290 * blk_get_device() - Find and probe a block device ready for use
292 * @uclass_id: Interface type (enum uclass_id_t)
293 * @devnum: Device number (specific to each interface type)
294 * @devp: the device, if found
295 * Return: 0 if found, -ENODEV if no device found, or other -ve error value
297 int blk_get_device(int uclass_id, int devnum, struct udevice **devp);
300 * blk_first_device() - Find the first device for a given interface
302 * The device is probed ready for use
304 * @devnum: Device number (specific to each interface type)
305 * @devp: the device, if found
306 * Return: 0 if found, -ENODEV if no device, or other -ve error value
308 int blk_first_device(int uclass_id, struct udevice **devp);
311 * blk_next_device() - Find the next device for a given interface
313 * This can be called repeatedly after blk_first_device() to iterate through
314 * all devices of the given interface type.
316 * The device is probed ready for use
318 * @devp: On entry, the previous device returned. On exit, the next
320 * Return: 0 if found, -ENODEV if no device, or other -ve error value
322 int blk_next_device(struct udevice **devp);
325 * blk_create_device() - Create a new block device
327 * @parent: Parent of the new device
328 * @drv_name: Driver name to use for the block device
329 * @name: Name for the device
330 * @uclass_id: Interface type (enum uclass_id_t)
331 * @devnum: Device number, specific to the interface type, or -1 to
332 * allocate the next available number
333 * @blksz: Block size of the device in bytes (typically 512)
334 * @lba: Total number of blocks of the device
335 * @devp: the new device (which has not been probed)
337 int blk_create_device(struct udevice *parent, const char *drv_name,
338 const char *name, int uclass_id, int devnum, int blksz,
339 lbaint_t lba, struct udevice **devp);
342 * blk_create_devicef() - Create a new named block device
344 * @parent: Parent of the new device
345 * @drv_name: Driver name to use for the block device
346 * @name: Name for the device (parent name is prepended)
347 * @uclass_id: Interface type (enum uclass_id_t)
348 * @devnum: Device number, specific to the interface type, or -1 to
349 * allocate the next available number
350 * @blksz: Block size of the device in bytes (typically 512)
351 * @lba: Total number of blocks of the device
352 * @devp: the new device (which has not been probed)
354 int blk_create_devicef(struct udevice *parent, const char *drv_name,
355 const char *name, int uclass_id, int devnum, int blksz,
356 lbaint_t lba, struct udevice **devp);
359 * blk_probe_or_unbind() - Try to probe
361 * Try to probe the device, primarily for enumerating partitions.
362 * If it fails, the device itself is unbound since it means that it won't
365 * @dev: The device to probe
366 * Return: 0 if OK, -ve on error
368 int blk_probe_or_unbind(struct udevice *dev);
371 * blk_unbind_all() - Unbind all device of the given interface type
373 * The devices are removed and then unbound.
375 * @uclass_id: Interface type to unbind
376 * Return: 0 if OK, -ve on error
378 int blk_unbind_all(int uclass_id);
381 * blk_find_max_devnum() - find the maximum device number for an interface type
383 * Finds the last allocated device number for an interface type @uclass_id. The
384 * next number is safe to use for a newly allocated device.
386 * @uclass_id: Interface type to scan
387 * Return: maximum device number found, or -ENODEV if none, or other -ve on
390 int blk_find_max_devnum(enum uclass_id uclass_id);
393 * blk_next_free_devnum() - get the next device number for an interface type
395 * Finds the next number that is safe to use for a newly allocated device for
396 * an interface type @uclass_id.
398 * @uclass_id: Interface type to scan
399 * Return: next device number safe to use, or -ve on error
401 int blk_next_free_devnum(enum uclass_id uclass_id);
404 * blk_select_hwpart() - select a hardware partition
406 * Select a hardware partition if the device supports it (typically MMC does)
408 * @dev: Device to update
409 * @hwpart: Partition number to select
410 * Return: 0 if OK, -ve on error
412 int blk_select_hwpart(struct udevice *dev, int hwpart);
415 * blk_get_from_parent() - obtain a block device by looking up its parent
419 int blk_get_from_parent(struct udevice *parent, struct udevice **devp);
422 * blk_get_devtype() - Get the device type of a block device
424 * @dev: Block device to check
425 * Return: device tree, i.e. the uclass name of its parent, e.g. "mmc"
427 const char *blk_get_devtype(struct udevice *dev);
430 * blk_get_by_device() - Get the block device descriptor for the given device
431 * @dev: Instance of a storage device
433 * Return: With block device descriptor on success , NULL if there is no such
436 struct blk_desc *blk_get_by_device(struct udevice *dev);
441 * These functions should take struct udevice instead of struct blk_desc,
442 * but this is convenient for migration to driver model. Add a 'd' prefix
443 * to the function operations, so that blk_read(), etc. can be reserved for
444 * functions with the correct arguments.
446 static inline ulong blk_dread(struct blk_desc *block_dev, lbaint_t start,
447 lbaint_t blkcnt, void *buffer)
450 if (blkcache_read(block_dev->uclass_id, block_dev->devnum,
451 start, blkcnt, block_dev->blksz, buffer))
455 * We could check if block_read is NULL and return -ENOSYS. But this
456 * bloats the code slightly (cause some board to fail to build), and
457 * it would be an error to try an operation that does not exist.
459 blks_read = block_dev->block_read(block_dev, start, blkcnt, buffer);
460 if (blks_read == blkcnt)
461 blkcache_fill(block_dev->uclass_id, block_dev->devnum,
462 start, blkcnt, block_dev->blksz, buffer);
467 static inline ulong blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
468 lbaint_t blkcnt, const void *buffer)
470 blkcache_invalidate(block_dev->uclass_id, block_dev->devnum);
471 return block_dev->block_write(block_dev, start, blkcnt, buffer);
474 static inline ulong blk_derase(struct blk_desc *block_dev, lbaint_t start,
477 blkcache_invalidate(block_dev->uclass_id, block_dev->devnum);
478 return block_dev->block_erase(block_dev, start, blkcnt);
482 * struct blk_driver - Driver for block interface types
484 * This provides access to the block devices for each interface type. One
485 * driver should be provided using U_BOOT_LEGACY_BLK() for each interface
486 * type that is to be supported.
488 * @uclass_idname: Interface type name
489 * @uclass_id: Interface type
490 * @max_devs: Maximum number of devices supported
491 * @desc: Pointer to list of devices for this interface type,
492 * or NULL to use @get_dev() instead
495 const char *uclass_idname;
496 enum uclass_id uclass_id;
498 struct blk_desc *desc;
500 * get_dev() - get a pointer to a block device given its number
502 * Each interface allocates its own devices and typically
503 * struct blk_desc is contained with the interface's data structure.
504 * There is no global numbering for block devices. This method allows
505 * the device for an interface type to be obtained when @desc is NULL.
507 * @devnum: Device number (0 for first device on that interface,
509 * @descp: Returns pointer to the block device on success
510 * @return 0 if OK, -ve on error
512 int (*get_dev)(int devnum, struct blk_desc **descp);
515 * select_hwpart() - Select a hardware partition
517 * Some devices (e.g. MMC) can support partitioning at the hardware
518 * level. This is quite separate from the normal idea of
519 * software-based partitions. MMC hardware partitions must be
520 * explicitly selected. Once selected only the region of the device
521 * covered by that partition is accessible.
523 * The MMC standard provides for two boot partitions (numbered 1 and 2),
524 * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
525 * Partition 0 is the main user-data partition.
527 * @desc: Block device descriptor
528 * @hwpart: Hardware partition number to select. 0 means the main
529 * user-data partition, 1 is the first partition, 2 is
531 * @return 0 if OK, other value for an error
533 int (*select_hwpart)(struct blk_desc *desc, int hwpart);
537 * Declare a new U-Boot legacy block driver. New drivers should use driver
538 * model (UCLASS_BLK).
540 #define U_BOOT_LEGACY_BLK(__name) \
541 ll_entry_declare(struct blk_driver, __name, blk_driver)
543 struct blk_driver *blk_driver_lookup_type(int uclass_id);
545 #endif /* !CONFIG_BLK */
548 * blk_get_devnum_by_uclass_idname() - Get a block device by type and number
550 * This looks through the available block devices of the given type, returning
551 * the one with the given @devnum.
553 * @uclass_id: Block device type
554 * @devnum: Device number
555 * Return: point to block device descriptor, or NULL if not found
557 struct blk_desc *blk_get_devnum_by_uclass_id(enum uclass_id uclass_id, int devnum);
560 * blk_get_devnum_by_uclass_id() - Get a block device by type name, and number
562 * This looks up the block device type based on @uclass_idname, then calls
563 * blk_get_devnum_by_uclass_id().
565 * @uclass_idname: Block device type name
566 * @devnum: Device number
567 * Return: point to block device descriptor, or NULL if not found
569 struct blk_desc *blk_get_devnum_by_uclass_idname(const char *uclass_idname,
573 * blk_dselect_hwpart() - select a hardware partition
575 * This selects a hardware partition (such as is supported by MMC). The block
576 * device size may change as this effectively points the block device to a
577 * partition at the hardware level. See the select_hwpart() method above.
579 * @desc: Block device descriptor for the device to select
580 * @hwpart: Partition number to select
581 * Return: 0 if OK, -ve on error
583 int blk_dselect_hwpart(struct blk_desc *desc, int hwpart);
586 * blk_list_part() - list the partitions for block devices of a given type
588 * This looks up the partition type for each block device of type @uclass_id,
589 * then displays a list of partitions.
591 * @uclass_id: Block device type
592 * Return: 0 if OK, -ENODEV if there is none of that type
594 int blk_list_part(enum uclass_id uclass_id);
597 * blk_list_devices() - list the block devices of a given type
599 * This lists each block device of the type @uclass_id, showing the capacity
600 * as well as type-specific information.
602 * @uclass_id: Block device type
604 void blk_list_devices(enum uclass_id uclass_id);
607 * blk_show_device() - show information about a given block device
609 * This shows the block device capacity as well as type-specific information.
611 * @uclass_id: Block device type
612 * @devnum: Device number
613 * Return: 0 if OK, -ENODEV for invalid device number
615 int blk_show_device(enum uclass_id uclass_id, int devnum);
618 * blk_print_device_num() - show information about a given block device
620 * This is similar to blk_show_device() but returns an error if the block
621 * device type is unknown.
623 * @uclass_id: Block device type
624 * @devnum: Device number
625 * Return: 0 if OK, -ENODEV for invalid device number, -ENOENT if the block
626 * device is not connected
628 int blk_print_device_num(enum uclass_id uclass_id, int devnum);
631 * blk_print_part_devnum() - print the partition information for a device
633 * @uclass_id: Block device type
634 * @devnum: Device number
635 * Return: 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if
636 * the interface type is not supported, other -ve on other error
638 int blk_print_part_devnum(enum uclass_id uclass_id, int devnum);
641 * blk_read_devnum() - read blocks from a device
643 * @uclass_id: Block device type
644 * @devnum: Device number
645 * @start: Start block number to read (0=first)
646 * @blkcnt: Number of blocks to read
647 * @buffer: Address to write data to
648 * Return: number of blocks read, or -ve error number on error
650 ulong blk_read_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
651 lbaint_t blkcnt, void *buffer);
654 * blk_write_devnum() - write blocks to a device
656 * @uclass_id: Block device type
657 * @devnum: Device number
658 * @start: Start block number to write (0=first)
659 * @blkcnt: Number of blocks to write
660 * @buffer: Address to read data from
661 * Return: number of blocks written, or -ve error number on error
663 ulong blk_write_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
664 lbaint_t blkcnt, const void *buffer);
667 * blk_select_hwpart_devnum() - select a hardware partition
669 * This is similar to blk_dselect_hwpart() but it looks up the interface and
672 * @uclass_id: Block device type
673 * @devnum: Device number
674 * @hwpart: Partition number to select
675 * Return: 0 if OK, -ve on error
677 int blk_select_hwpart_devnum(enum uclass_id uclass_id, int devnum, int hwpart);
680 * blk_get_uclass_name() - Get the name of an interface type
682 * @uclass_id: Interface type to check
683 * Return: name of interface, or NULL if none
685 const char *blk_get_uclass_name(enum uclass_id uclass_id);
688 * blk_common_cmd() - handle common commands with block devices
690 * @args: Number of arguments to the command (argv[0] is the command itself)
691 * @argv: Command arguments
692 * @uclass_id: Interface type
693 * @cur_devnump: Current device number for this interface type
694 * Return: 0 if OK, CMD_RET_ERROR on error
696 int blk_common_cmd(int argc, char *const argv[], enum uclass_id uclass_id,
701 BLKF_REMOVABLE = 1 << 1,
702 BLKF_BOTH = BLKF_FIXED | BLKF_REMOVABLE,
706 * blk_first_device_err() - Get the first block device
708 * The device returned is probed if necessary, and ready for use
710 * @flags: Indicates type of device to return
711 * @devp: Returns pointer to the first device in that uclass, or NULL if none
712 * Return: 0 if found, -ENODEV if not found, other -ve on error
714 int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp);
717 * blk_next_device_err() - Get the next block device
719 * The device returned is probed if necessary, and ready for use
721 * @flags: Indicates type of device to return
722 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
723 * to the next device in the uclass if no error occurred, or -ENODEV if
724 * there is no next device.
725 * Return: 0 if found, -ENODEV if not found, other -ve on error
727 int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp);
730 * blk_find_first() - Return the first matching block device
731 * @flags: Indicates type of device to return
732 * @devp: Returns pointer to device, or NULL on error
734 * The device is not prepared for use - this is an internal function.
735 * The function uclass_get_device_tail() can be used to probe the device.
737 * Note that some devices are considered removable until they have been probed
739 * @return 0 if found, -ENODEV if not found
741 int blk_find_first(enum blk_flag_t flags, struct udevice **devp);
744 * blk_find_next() - Return the next matching block device
745 * @flags: Indicates type of device to return
746 * @devp: On entry, pointer to device to lookup. On exit, returns pointer
747 * to the next device in the same uclass, or NULL if none
749 * The device is not prepared for use - this is an internal function.
750 * The function uclass_get_device_tail() can be used to probe the device.
752 * Note that some devices are considered removable until they have been probed
754 * @return 0 if found, -ENODEV if not found
756 int blk_find_next(enum blk_flag_t flags, struct udevice **devp);
759 * blk_foreach() - iterate through block devices
761 * This creates a for() loop which works through the available block devices in
762 * order from start to end.
764 * If for some reason the uclass cannot be found, this does nothing.
766 * @_flags: Indicates type of device to return
767 * @_pos: struct udevice * to hold the current device. Set to NULL when there
768 * are no more devices.
770 #define blk_foreach(_flags, _pos) \
771 for (int _ret = blk_find_first(_flags, &_pos); !_ret && _pos; \
772 _ret = blk_find_next(_flags, &_pos))
775 * blk_foreach_probe() - Helper function to iteration through block devices
777 * This creates a for() loop which works through the available devices in
778 * a uclass in order from start to end. Devices are probed if necessary,
781 * @flags: Indicates type of device to return
782 * @dev: struct udevice * to hold the current device. Set to NULL when there
783 * are no more devices.
785 #define blk_foreach_probe(flags, pos) \
786 for (int _ret = blk_first_device_err(flags, &(pos)); \
788 _ret = blk_next_device_err(flags, &(pos)))
791 * blk_count_devices() - count the number of devices of a particular type
793 * @flags: Indicates type of device to find
794 * Return: number of devices matching those flags
796 int blk_count_devices(enum blk_flag_t flag);