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