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