include/blk.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2004
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  */
   6
   7 #ifndef BLK_H
   8 #define BLK_H
   9
  10 #include <bouncebuf.h>
  11 #include <dm/uclass-id.h>
  12 #include <efi.h>
  13
  14 #ifdef CONFIG_SYS_64BIT_LBA
  15 typedef uint64_t lbaint_t;
  16 #define LBAFlength "ll"
  17 #else
  18 typedef ulong lbaint_t;
  19 #define LBAFlength "l"
  20 #endif
  21 #define LBAF "%" LBAFlength "x"
  22 #define LBAFU "%" LBAFlength "u"
  23
  24 struct udevice;
  25
  26 static inline bool blk_enabled(void)
  27 {
  28         return CONFIG_IS_ENABLED(BLK) || IS_ENABLED(CONFIG_SPL_LEGACY_BLOCK);
  29 }
  30
  31 #define BLK_VEN_SIZE            40
  32 #define BLK_PRD_SIZE            20
  33 #define BLK_REV_SIZE            8
  34
  35 #define PART_FORMAT_PCAT        0x1
  36 #define PART_FORMAT_GPT         0x2
  37
  38 /*
  39  * Identifies the partition table type (ie. MBR vs GPT GUID) signature
  40  */
  41 enum sig_type {
  42         SIG_TYPE_NONE,
  43         SIG_TYPE_MBR,
  44         SIG_TYPE_GUID,
  45
  46         SIG_TYPE_COUNT                  /* Number of signature types */
  47 };
  48
  49 /*
  50  * With driver model (CONFIG_BLK) this is uclass platform data, accessible
  51  * with dev_get_uclass_plat(dev)
  52  */
  53 struct blk_desc {
  54         /*
  55          * TODO: With driver model we should be able to use the parent
  56          * device's uclass instead.
  57          */
  58         enum uclass_id  uclass_id;      /* type of the interface */
  59         int             devnum;         /* device number */
  60         unsigned char   part_type;      /* partition type */
  61         unsigned char   target;         /* target SCSI ID */
  62         unsigned char   lun;            /* target LUN */
  63         unsigned char   hwpart;         /* HW partition, e.g. for eMMC */
  64         unsigned char   type;           /* device type */
  65         unsigned char   removable;      /* removable device */
  66         /* device can use 48bit addr (ATA/ATAPI v7) */
  67         bool    lba48;
  68         unsigned char   atapi;          /* Use ATAPI protocol */
  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 */
  76         union {
  77                 uint32_t mbr_sig;       /* MBR integer signature */
  78                 efi_guid_t guid_sig;    /* GPT GUID Signature */
  79         };
  80 #if CONFIG_IS_ENABLED(BLK)
  81         /*
  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.
  85          */
  86         struct udevice *bdev;
  87 #else
  88         unsigned long   (*block_read)(struct blk_desc *block_dev,
  89                                       lbaint_t start,
  90                                       lbaint_t blkcnt,
  91                                       void *buffer);
  92         unsigned long   (*block_write)(struct blk_desc *block_dev,
  93                                        lbaint_t start,
  94                                        lbaint_t blkcnt,
  95                                        const void *buffer);
  96         unsigned long   (*block_erase)(struct blk_desc *block_dev,
  97                                        lbaint_t start,
  98                                        lbaint_t blkcnt);
  99         void            *priv;          /* driver private struct pointer */
 100 #endif
 101 };
 102
 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))
 106
 107 #if CONFIG_IS_ENABLED(BLOCK_CACHE)
 108 /**
 109  * blkcache_read() - attempt to read a set of blocks from cache
 110  *
 111  * @param iftype - uclass_id_x for type of device
 112  * @param dev - device index of particular type
 113  * @param start - starting block number
 114  * @param blkcnt - number of blocks to read
 115  * @param blksz - size in bytes of each block
 116  * @param buffer - buffer to contain cached data
 117  *
 118  * Return: - 1 if block returned from cache, 0 otherwise.
 119  */
 120 int blkcache_read(int iftype, int dev,
 121                   lbaint_t start, lbaint_t blkcnt,
 122                   unsigned long blksz, void *buffer);
 123
 124 /**
 125  * blkcache_fill() - make data read from a block device available
 126  * to the block cache
 127  *
 128  * @param iftype - uclass_id_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 available
 132  * @param blksz - size in bytes of each block
 133  * @param buffer - buffer containing data to cache
 134  *
 135  */
 136 void blkcache_fill(int iftype, int dev,
 137                    lbaint_t start, lbaint_t blkcnt,
 138                    unsigned long blksz, void const *buffer);
 139
 140 /**
 141  * blkcache_invalidate() - discard the cache for a set of blocks
 142  * because of a write or device (re)initialization.
 143  *
 144  * @iftype - UCLASS_ID_ for type of device, or -1 for any
 145  * @dev - device index of particular type, if @iftype is not -1
 146  */
 147 void blkcache_invalidate(int iftype, int dev);
 148
 149 /**
 150  * blkcache_configure() - configure block cache
 151  *
 152  * @param blocks - maximum blocks per entry
 153  * @param entries - maximum entries in cache
 154  */
 155 void blkcache_configure(unsigned blocks, unsigned entries);
 156
 157 /*
 158  * statistics of the block cache
 159  */
 160 struct block_cache_stats {
 161         unsigned hits;
 162         unsigned misses;
 163         unsigned entries; /* current entry count */
 164         unsigned max_blocks_per_entry;
 165         unsigned max_entries;
 166 };
 167
 168 /**
 169  * get_blkcache_stats() - return statistics and reset
 170  *
 171  * @param stats - statistics are copied here
 172  */
 173 void blkcache_stats(struct block_cache_stats *stats);
 174
 175 /** blkcache_free() - free all memory allocated to the block cache */
 176 void blkcache_free(void);
 177
 178 #else
 179
 180 static inline int blkcache_read(int iftype, int dev,
 181                                 lbaint_t start, lbaint_t blkcnt,
 182                                 unsigned long blksz, void *buffer)
 183 {
 184         return 0;
 185 }
 186
 187 static inline void blkcache_fill(int iftype, int dev,
 188                                  lbaint_t start, lbaint_t blkcnt,
 189                                  unsigned long blksz, void const *buffer) {}
 190
 191 static inline void blkcache_invalidate(int iftype, int dev) {}
 192
 193 static inline void blkcache_free(void) {}
 194
 195 #endif
 196
 197 #if CONFIG_IS_ENABLED(BLK)
 198 struct udevice;
 199
 200 /* Operations on block devices */
 201 struct blk_ops {
 202         /**
 203          * read() - read from a block device
 204          *
 205          * @dev:        Device to read from
 206          * @start:      Start block number to read (0=first)
 207          * @blkcnt:     Number of blocks to read
 208          * @buffer:     Destination buffer for data read
 209          * @return number of blocks read, or -ve error number (see the
 210          * IS_ERR_VALUE() macro
 211          */
 212         unsigned long (*read)(struct udevice *dev, lbaint_t start,
 213                               lbaint_t blkcnt, void *buffer);
 214
 215         /**
 216          * write() - write to a block device
 217          *
 218          * @dev:        Device to write to
 219          * @start:      Start block number to write (0=first)
 220          * @blkcnt:     Number of blocks to write
 221          * @buffer:     Source buffer for data to write
 222          * @return number of blocks written, or -ve error number (see the
 223          * IS_ERR_VALUE() macro
 224          */
 225         unsigned long (*write)(struct udevice *dev, lbaint_t start,
 226                                lbaint_t blkcnt, const void *buffer);
 227
 228         /**
 229          * erase() - erase a section of a block device
 230          *
 231          * @dev:        Device to (partially) erase
 232          * @start:      Start block number to erase (0=first)
 233          * @blkcnt:     Number of blocks to erase
 234          * @return number of blocks erased, or -ve error number (see the
 235          * IS_ERR_VALUE() macro
 236          */
 237         unsigned long (*erase)(struct udevice *dev, lbaint_t start,
 238                                lbaint_t blkcnt);
 239
 240         /**
 241          * select_hwpart() - select a particular hardware partition
 242          *
 243          * Some devices (e.g. MMC) can support partitioning at the hardware
 244          * level. This is quite separate from the normal idea of
 245          * software-based partitions. MMC hardware partitions must be
 246          * explicitly selected. Once selected only the region of the device
 247          * covered by that partition is accessible.
 248          *
 249          * The MMC standard provides for two boot partitions (numbered 1 and 2),
 250          * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
 251          *
 252          * @dev:        Block device to update
 253          * @hwpart:     Hardware partition number to select. 0 means the raw
 254          *              device, 1 is the first partition, 2 is the second, etc.
 255          * @return 0 if OK, -ve on error
 256          */
 257         int (*select_hwpart)(struct udevice *dev, int hwpart);
 258
 259 #if IS_ENABLED(CONFIG_BOUNCE_BUFFER)
 260         /**
 261          * buffer_aligned() - test memory alignment of block operation buffer
 262          *
 263          * Some devices have limited DMA capabilities and require that the
 264          * buffers passed to them fit specific properties. This optional
 265          * callback can be used to indicate whether a buffer alignment is
 266          * suitable for the device DMA or not, and trigger use of generic
 267          * bounce buffer implementation to help use of unsuitable buffers
 268          * at the expense of performance degradation.
 269          *
 270          * @dev:        Block device associated with the request
 271          * @state:      Bounce buffer state
 272          * @return 1 if OK, 0 if unaligned
 273          */
 274         int (*buffer_aligned)(struct udevice *dev, struct bounce_buffer *state);
 275 #endif  /* CONFIG_BOUNCE_BUFFER */
 276 };
 277
 278 /*
 279  * These functions should take struct udevice instead of struct blk_desc,
 280  * but this is convenient for migration to driver model. Add a 'd' prefix
 281  * to the function operations, so that blk_read(), etc. can be reserved for
 282  * functions with the correct arguments.
 283  */
 284 unsigned long blk_dread(struct blk_desc *block_dev, lbaint_t start,
 285                         lbaint_t blkcnt, void *buffer);
 286 unsigned long blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
 287                          lbaint_t blkcnt, const void *buffer);
 288 unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start,
 289                          lbaint_t blkcnt);
 290
 291 /**
 292  * blk_read() - Read from a block device
 293  *
 294  * @dev: Device to read from
 295  * @start: Start block for the read
 296  * @blkcnt: Number of blocks to read
 297  * @buf: Place to put the data
 298  * @return number of blocks read (which may be less than @blkcnt),
 299  * or -ve on error. This never returns 0 unless @blkcnt is 0
 300  */
 301 long blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
 302               void *buffer);
 303
 304 /**
 305  * blk_write() - Write to a block device
 306  *
 307  * @dev: Device to write to
 308  * @start: Start block for the write
 309  * @blkcnt: Number of blocks to write
 310  * @buf: Data to write
 311  * @return number of blocks written (which may be less than @blkcnt),
 312  * or -ve on error. This never returns 0 unless @blkcnt is 0
 313  */
 314 long blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
 315                const void *buffer);
 316
 317 /**
 318  * blk_erase() - Erase part of a block device
 319  *
 320  * @dev: Device to erase
 321  * @start: Start block for the erase
 322  * @blkcnt: Number of blocks to erase
 323  * @return number of blocks erased (which may be less than @blkcnt),
 324  * or -ve on error. This never returns 0 unless @blkcnt is 0
 325  */
 326 long blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt);
 327
 328 /**
 329  * blk_find_device() - Find a block device
 330  *
 331  * This function does not activate the device. The device will be returned
 332  * whether or not it is activated.
 333  *
 334  * @uclass_id:  Interface type (enum uclass_id_t)
 335  * @devnum:     Device number (specific to each interface type)
 336  * @devp:       the device, if found
 337  * Return: 0 if found, -ENODEV if no device found, or other -ve error value
 338  */
 339 int blk_find_device(int uclass_id, int devnum, struct udevice **devp);
 340
 341 /**
 342  * blk_get_device() - Find and probe a block device ready for use
 343  *
 344  * @uclass_id:  Interface type (enum uclass_id_t)
 345  * @devnum:     Device number (specific to each interface type)
 346  * @devp:       the device, if found
 347  * Return: 0 if found, -ENODEV if no device found, or other -ve error value
 348  */
 349 int blk_get_device(int uclass_id, int devnum, struct udevice **devp);
 350
 351 /**
 352  * blk_first_device() - Find the first device for a given interface
 353  *
 354  * The device is probed ready for use
 355  *
 356  * @devnum:     Device number (specific to each interface type)
 357  * @devp:       the device, if found
 358  * Return: 0 if found, -ENODEV if no device, or other -ve error value
 359  */
 360 int blk_first_device(int uclass_id, struct udevice **devp);
 361
 362 /**
 363  * blk_next_device() - Find the next device for a given interface
 364  *
 365  * This can be called repeatedly after blk_first_device() to iterate through
 366  * all devices of the given interface type.
 367  *
 368  * The device is probed ready for use
 369  *
 370  * @devp:       On entry, the previous device returned. On exit, the next
 371  *              device, if found
 372  * Return: 0 if found, -ENODEV if no device, or other -ve error value
 373  */
 374 int blk_next_device(struct udevice **devp);
 375
 376 /**
 377  * blk_create_device() - Create a new block device
 378  *
 379  * @parent:     Parent of the new device
 380  * @drv_name:   Driver name to use for the block device
 381  * @name:       Name for the device
 382  * @uclass_id:  Interface type (enum uclass_id_t)
 383  * @devnum:     Device number, specific to the interface type, or -1 to
 384  *              allocate the next available number
 385  * @blksz:      Block size of the device in bytes (typically 512)
 386  * @lba:        Total number of blocks of the device
 387  * @devp:       the new device (which has not been probed)
 388  */
 389 int blk_create_device(struct udevice *parent, const char *drv_name,
 390                       const char *name, int uclass_id, int devnum, int blksz,
 391                       lbaint_t lba, struct udevice **devp);
 392
 393 /**
 394  * blk_create_devicef() - Create a new named block device
 395  *
 396  * @parent:     Parent of the new device
 397  * @drv_name:   Driver name to use for the block device
 398  * @name:       Name for the device (parent name is prepended)
 399  * @uclass_id:  Interface type (enum uclass_id_t)
 400  * @devnum:     Device number, specific to the interface type, or -1 to
 401  *              allocate the next available number
 402  * @blksz:      Block size of the device in bytes (typically 512)
 403  * @lba:        Total number of blocks of the device
 404  * @devp:       the new device (which has not been probed)
 405  */
 406 int blk_create_devicef(struct udevice *parent, const char *drv_name,
 407                        const char *name, int uclass_id, int devnum, int blksz,
 408                        lbaint_t lba, struct udevice **devp);
 409
 410 /**
 411  * blk_probe_or_unbind() - Try to probe
 412  *
 413  * Try to probe the device, primarily for enumerating partitions.
 414  * If it fails, the device itself is unbound since it means that it won't
 415  * work any more.
 416  *
 417  * @dev:        The device to probe
 418  * Return:      0 if OK, -ve on error
 419  */
 420 int blk_probe_or_unbind(struct udevice *dev);
 421
 422 /**
 423  * blk_unbind_all() - Unbind all device of the given interface type
 424  *
 425  * The devices are removed and then unbound.
 426  *
 427  * @uclass_id:  Interface type to unbind
 428  * Return: 0 if OK, -ve on error
 429  */
 430 int blk_unbind_all(int uclass_id);
 431
 432 /**
 433  * blk_find_max_devnum() - find the maximum device number for an interface type
 434  *
 435  * Finds the last allocated device number for an interface type @uclass_id. The
 436  * next number is safe to use for a newly allocated device.
 437  *
 438  * @uclass_id:  Interface type to scan
 439  * Return: maximum device number found, or -ENODEV if none, or other -ve on
 440  * error
 441  */
 442 int blk_find_max_devnum(enum uclass_id uclass_id);
 443
 444 /**
 445  * blk_next_free_devnum() - get the next device number for an interface type
 446  *
 447  * Finds the next number that is safe to use for a newly allocated device for
 448  * an interface type @uclass_id.
 449  *
 450  * @uclass_id:  Interface type to scan
 451  * Return: next device number safe to use, or -ve on error
 452  */
 453 int blk_next_free_devnum(enum uclass_id uclass_id);
 454
 455 /**
 456  * blk_select_hwpart() - select a hardware partition
 457  *
 458  * Select a hardware partition if the device supports it (typically MMC does)
 459  *
 460  * @dev:        Device to update
 461  * @hwpart:     Partition number to select
 462  * Return: 0 if OK, -ve on error
 463  */
 464 int blk_select_hwpart(struct udevice *dev, int hwpart);
 465
 466 /**
 467  * blk_find_from_parent() - find a block device by looking up its parent
 468  *
 469  * All block devices have a parent 'media' device which provides the block
 470  * driver for the block device, ensuring that access to the underlying medium
 471  * is available.
 472  *
 473  * The block device is not activated by this function. See
 474  * blk_get_from_parent() for that.
 475  *
 476  * @parent: Media device
 477  * @devp: Returns the associated block device, if any
 478  * Returns: 0 if OK, -ENODEV if @parent is not a media device and has no
 479  * UCLASS_BLK child
 480  */
 481 int blk_find_from_parent(struct udevice *parent, struct udevice **devp);
 482
 483 /**
 484  * blk_get_from_parent() - obtain a block device by looking up its parent
 485  *
 486  * All block devices have a parent 'media' device which provides the block
 487  * driver for the block device, ensuring that access to the underlying medium
 488  * is available.
 489  *
 490  * The block device is probed and ready for use.
 491  *
 492  * @parent: Media device
 493  * @devp: Returns the associated block device, if any
 494  * Returns: 0 if OK, -ENODEV if @parent is not a media device and has no
 495  * UCLASS_BLK child
 496  */
 497 int blk_get_from_parent(struct udevice *parent, struct udevice **devp);
 498
 499 /**
 500  * blk_get_devtype() - Get the device type of a block device
 501  *
 502  * @dev:        Block device to check
 503  * Return: device tree, i.e. the uclass name of its parent, e.g. "mmc"
 504  */
 505 const char *blk_get_devtype(struct udevice *dev);
 506
 507 /**
 508  * blk_get_by_device() - Get the block device descriptor for the given device
 509  * @dev:        Instance of a storage device (the parent of the block device)
 510  *
 511  * Return: With block device descriptor on success , NULL if there is no such
 512  *         block device.
 513  */
 514 struct blk_desc *blk_get_by_device(struct udevice *dev);
 515
 516 #else
 517 #include <errno.h>
 518 /*
 519  * These functions should take struct udevice instead of struct blk_desc,
 520  * but this is convenient for migration to driver model. Add a 'd' prefix
 521  * to the function operations, so that blk_read(), etc. can be reserved for
 522  * functions with the correct arguments.
 523  */
 524 static inline ulong blk_dread(struct blk_desc *block_dev, lbaint_t start,
 525                               lbaint_t blkcnt, void *buffer)
 526 {
 527         ulong blks_read;
 528         if (blkcache_read(block_dev->uclass_id, block_dev->devnum,
 529                           start, blkcnt, block_dev->blksz, buffer))
 530                 return blkcnt;
 531
 532         /*
 533          * We could check if block_read is NULL and return -ENOSYS. But this
 534          * bloats the code slightly (cause some board to fail to build), and
 535          * it would be an error to try an operation that does not exist.
 536          */
 537         blks_read = block_dev->block_read(block_dev, start, blkcnt, buffer);
 538         if (blks_read == blkcnt)
 539                 blkcache_fill(block_dev->uclass_id, block_dev->devnum,
 540                               start, blkcnt, block_dev->blksz, buffer);
 541
 542         return blks_read;
 543 }
 544
 545 static inline ulong blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
 546                                lbaint_t blkcnt, const void *buffer)
 547 {
 548         blkcache_invalidate(block_dev->uclass_id, block_dev->devnum);
 549         return block_dev->block_write(block_dev, start, blkcnt, buffer);
 550 }
 551
 552 static inline ulong blk_derase(struct blk_desc *block_dev, lbaint_t start,
 553                                lbaint_t blkcnt)
 554 {
 555         blkcache_invalidate(block_dev->uclass_id, block_dev->devnum);
 556         return block_dev->block_erase(block_dev, start, blkcnt);
 557 }
 558
 559 /**
 560  * struct blk_driver - Driver for block interface types
 561  *
 562  * This provides access to the block devices for each interface type. One
 563  * driver should be provided using U_BOOT_LEGACY_BLK() for each interface
 564  * type that is to be supported.
 565  *
 566  * @uclass_idname:      Interface type name
 567  * @uclass_id:          Interface type
 568  * @max_devs:           Maximum number of devices supported
 569  * @desc:               Pointer to list of devices for this interface type,
 570  *                      or NULL to use @get_dev() instead
 571  */
 572 struct blk_driver {
 573         const char *uclass_idname;
 574         enum uclass_id uclass_id;
 575         int max_devs;
 576         struct blk_desc *desc;
 577         /**
 578          * get_dev() - get a pointer to a block device given its number
 579          *
 580          * Each interface allocates its own devices and typically
 581          * struct blk_desc is contained with the interface's data structure.
 582          * There is no global numbering for block devices. This method allows
 583          * the device for an interface type to be obtained when @desc is NULL.
 584          *
 585          * @devnum:     Device number (0 for first device on that interface,
 586          *              1 for second, etc.
 587          * @descp:      Returns pointer to the block device on success
 588          * @return 0 if OK, -ve on error
 589          */
 590         int (*get_dev)(int devnum, struct blk_desc **descp);
 591
 592         /**
 593          * select_hwpart() - Select a hardware partition
 594          *
 595          * Some devices (e.g. MMC) can support partitioning at the hardware
 596          * level. This is quite separate from the normal idea of
 597          * software-based partitions. MMC hardware partitions must be
 598          * explicitly selected. Once selected only the region of the device
 599          * covered by that partition is accessible.
 600          *
 601          * The MMC standard provides for two boot partitions (numbered 1 and 2),
 602          * rpmb (3), and up to 4 addition general-purpose partitions (4-7).
 603          * Partition 0 is the main user-data partition.
 604          *
 605          * @desc:       Block device descriptor
 606          * @hwpart:     Hardware partition number to select. 0 means the main
 607          *              user-data partition, 1 is the first partition, 2 is
 608          *              the second, etc.
 609          * @return 0 if OK, other value for an error
 610          */
 611         int (*select_hwpart)(struct blk_desc *desc, int hwpart);
 612 };
 613
 614 /*
 615  * Declare a new U-Boot legacy block driver. New drivers should use driver
 616  * model (UCLASS_BLK).
 617  */
 618 #define U_BOOT_LEGACY_BLK(__name)                                       \
 619         ll_entry_declare(struct blk_driver, __name, blk_driver)
 620
 621 struct blk_driver *blk_driver_lookup_type(int uclass_id);
 622
 623 #endif /* !CONFIG_BLK */
 624
 625 /**
 626  * blk_get_devnum_by_uclass_idname() - Get a block device by type and number
 627  *
 628  * This looks through the available block devices of the given type, returning
 629  * the one with the given @devnum.
 630  *
 631  * @uclass_id:  Block device type
 632  * @devnum:     Device number
 633  * Return: point to block device descriptor, or NULL if not found
 634  */
 635 struct blk_desc *blk_get_devnum_by_uclass_id(enum uclass_id uclass_id, int devnum);
 636
 637 /**
 638  * blk_get_devnum_by_uclass_id() - Get a block device by type name, and number
 639  *
 640  * This looks up the block device type based on @uclass_idname, then calls
 641  * blk_get_devnum_by_uclass_id().
 642  *
 643  * @uclass_idname:      Block device type name
 644  * @devnum:             Device number
 645  * Return: point to block device descriptor, or NULL if not found
 646  */
 647 struct blk_desc *blk_get_devnum_by_uclass_idname(const char *uclass_idname,
 648                                             int devnum);
 649
 650 /**
 651  * blk_dselect_hwpart() - select a hardware partition
 652  *
 653  * This selects a hardware partition (such as is supported by MMC). The block
 654  * device size may change as this effectively points the block device to a
 655  * partition at the hardware level. See the select_hwpart() method above.
 656  *
 657  * @desc:       Block device descriptor for the device to select
 658  * @hwpart:     Partition number to select
 659  * Return: 0 if OK, -ve on error
 660  */
 661 int blk_dselect_hwpart(struct blk_desc *desc, int hwpart);
 662
 663 /**
 664  * blk_list_part() - list the partitions for block devices of a given type
 665  *
 666  * This looks up the partition type for each block device of type @uclass_id,
 667  * then displays a list of partitions.
 668  *
 669  * @uclass_id:  Block device type
 670  * Return: 0 if OK, -ENODEV if there is none of that type
 671  */
 672 int blk_list_part(enum uclass_id uclass_id);
 673
 674 /**
 675  * blk_list_devices() - list the block devices of a given type
 676  *
 677  * This lists each block device of the type @uclass_id, showing the capacity
 678  * as well as type-specific information.
 679  *
 680  * @uclass_id:  Block device type
 681  */
 682 void blk_list_devices(enum uclass_id uclass_id);
 683
 684 /**
 685  * blk_show_device() - show information about a given block device
 686  *
 687  * This shows the block device capacity as well as type-specific information.
 688  *
 689  * @uclass_id:  Block device type
 690  * @devnum:     Device number
 691  * Return: 0 if OK, -ENODEV for invalid device number
 692  */
 693 int blk_show_device(enum uclass_id uclass_id, int devnum);
 694
 695 /**
 696  * blk_print_device_num() - show information about a given block device
 697  *
 698  * This is similar to blk_show_device() but returns an error if the block
 699  * device type is unknown.
 700  *
 701  * @uclass_id:  Block device type
 702  * @devnum:     Device number
 703  * Return: 0 if OK, -ENODEV for invalid device number, -ENOENT if the block
 704  * device is not connected
 705  */
 706 int blk_print_device_num(enum uclass_id uclass_id, int devnum);
 707
 708 /**
 709  * blk_print_part_devnum() - print the partition information for a device
 710  *
 711  * @uclass_id:  Block device type
 712  * @devnum:     Device number
 713  * Return: 0 if OK, -ENOENT if the block device is not connected, -ENOSYS if
 714  * the interface type is not supported, other -ve on other error
 715  */
 716 int blk_print_part_devnum(enum uclass_id uclass_id, int devnum);
 717
 718 /**
 719  * blk_read_devnum() - read blocks from a device
 720  *
 721  * @uclass_id:  Block device type
 722  * @devnum:     Device number
 723  * @start:      Start block number to read (0=first)
 724  * @blkcnt:     Number of blocks to read
 725  * @buffer:     Address to write data to
 726  * Return: number of blocks read, or -ve error number on error
 727  */
 728 ulong blk_read_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
 729                       lbaint_t blkcnt, void *buffer);
 730
 731 /**
 732  * blk_write_devnum() - write blocks to a device
 733  *
 734  * @uclass_id:  Block device type
 735  * @devnum:     Device number
 736  * @start:      Start block number to write (0=first)
 737  * @blkcnt:     Number of blocks to write
 738  * @buffer:     Address to read data from
 739  * Return: number of blocks written, or -ve error number on error
 740  */
 741 ulong blk_write_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
 742                        lbaint_t blkcnt, const void *buffer);
 743
 744 /**
 745  * blk_select_hwpart_devnum() - select a hardware partition
 746  *
 747  * This is similar to blk_dselect_hwpart() but it looks up the interface and
 748  * device number.
 749  *
 750  * @uclass_id:  Block device type
 751  * @devnum:     Device number
 752  * @hwpart:     Partition number to select
 753  * Return: 0 if OK, -ve on error
 754  */
 755 int blk_select_hwpart_devnum(enum uclass_id uclass_id, int devnum, int hwpart);
 756
 757 /**
 758  * blk_get_uclass_name() - Get the name of an interface type
 759  *
 760  * @uclass_id: Interface type to check
 761  * Return: name of interface, or NULL if none
 762  */
 763 const char *blk_get_uclass_name(enum uclass_id uclass_id);
 764
 765 /**
 766  * blk_common_cmd() - handle common commands with block devices
 767  *
 768  * @args: Number of arguments to the command (argv[0] is the command itself)
 769  * @argv: Command arguments
 770  * @uclass_id: Interface type
 771  * @cur_devnump: Current device number for this interface type
 772  * Return: 0 if OK, CMD_RET_ERROR on error
 773  */
 774 int blk_common_cmd(int argc, char *const argv[], enum uclass_id uclass_id,
 775                    int *cur_devnump);
 776
 777 enum blk_flag_t {
 778         BLKF_FIXED      = 1 << 0,
 779         BLKF_REMOVABLE  = 1 << 1,
 780         BLKF_BOTH       = BLKF_FIXED | BLKF_REMOVABLE,
 781 };
 782
 783 /**
 784  * blk_first_device_err() - Get the first block device
 785  *
 786  * The device returned is probed if necessary, and ready for use
 787  *
 788  * @flags: Indicates type of device to return
 789  * @devp: Returns pointer to the first device in that uclass, or NULL if none
 790  * Return: 0 if found, -ENODEV if not found, other -ve on error
 791  */
 792 int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp);
 793
 794 /**
 795  * blk_next_device_err() - Get the next block device
 796  *
 797  * The device returned is probed if necessary, and ready for use
 798  *
 799  * @flags: Indicates type of device to return
 800  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 801  * to the next device in the uclass if no error occurred, or -ENODEV if
 802  * there is no next device.
 803  * Return: 0 if found, -ENODEV if not found, other -ve on error
 804  */
 805 int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp);
 806
 807 /**
 808  * blk_find_first() - Return the first matching block device
 809  * @flags: Indicates type of device to return
 810  * @devp:       Returns pointer to device, or NULL on error
 811  *
 812  * The device is not prepared for use - this is an internal function.
 813  * The function uclass_get_device_tail() can be used to probe the device.
 814  *
 815  * Note that some devices are considered removable until they have been probed
 816  *
 817  * @return 0 if found, -ENODEV if not found
 818  */
 819 int blk_find_first(enum blk_flag_t flags, struct udevice **devp);
 820
 821 /**
 822  * blk_find_next() - Return the next matching block device
 823  * @flags: Indicates type of device to return
 824  * @devp: On entry, pointer to device to lookup. On exit, returns pointer
 825  * to the next device in the same uclass, or NULL if none
 826  *
 827  * The device is not prepared for use - this is an internal function.
 828  * The function uclass_get_device_tail() can be used to probe the device.
 829  *
 830  * Note that some devices are considered removable until they have been probed
 831  *
 832  * @return 0 if found, -ENODEV if not found
 833  */
 834 int blk_find_next(enum blk_flag_t flags, struct udevice **devp);
 835
 836 /**
 837  * blk_foreach() - iterate through block devices
 838  *
 839  * This creates a for() loop which works through the available block devices in
 840  * order from start to end.
 841  *
 842  * If for some reason the uclass cannot be found, this does nothing.
 843  *
 844  * @_flags: Indicates type of device to return
 845  * @_pos: struct udevice * to hold the current device. Set to NULL when there
 846  * are no more devices.
 847  */
 848 #define blk_foreach(_flags, _pos) \
 849         for (int _ret = blk_find_first(_flags, &_pos); !_ret && _pos; \
 850              _ret = blk_find_next(_flags, &_pos))
 851
 852 /**
 853  * blk_foreach_probe() - Helper function to iteration through block devices
 854  *
 855  * This creates a for() loop which works through the available devices in
 856  * a uclass in order from start to end. Devices are probed if necessary,
 857  * and ready for use.
 858  *
 859  * @flags: Indicates type of device to return
 860  * @dev: struct udevice * to hold the current device. Set to NULL when there
 861  * are no more devices.
 862  */
 863 #define blk_foreach_probe(flags, pos)   \
 864         for (int _ret = blk_first_device_err(flags, &(pos)); \
 865              !_ret && pos; \
 866              _ret = blk_next_device_err(flags, &(pos)))
 867
 868 /**
 869  * blk_count_devices() - count the number of devices of a particular type
 870  *
 871  * @flags: Indicates type of device to find
 872  * Return: number of devices matching those flags
 873  */
 874 int blk_count_devices(enum blk_flag_t flag);
 875
 876 #endif