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