1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
7 #define LOG_CATEGORY UCLASS_BLK
15 #include <dm/device-internal.h>
17 #include <dm/uclass-internal.h>
18 #include <linux/err.h>
23 } uclass_idname_str[] = {
24 { UCLASS_IDE, "ide" },
25 { UCLASS_SCSI, "scsi" },
26 { UCLASS_USB, "usb" },
27 { UCLASS_MMC, "mmc" },
28 { UCLASS_AHCI, "sata" },
29 { UCLASS_HOST, "host" },
30 { UCLASS_NVME, "nvme" },
31 { UCLASS_EFI_MEDIA, "efi" },
32 { UCLASS_EFI_LOADER, "efiloader" },
33 { UCLASS_VIRTIO, "virtio" },
34 { UCLASS_PVBLOCK, "pvblock" },
37 static enum uclass_id uclass_name_to_iftype(const char *uclass_idname)
41 for (i = 0; i < ARRAY_SIZE(uclass_idname_str); i++) {
42 if (!strcmp(uclass_idname, uclass_idname_str[i].name))
43 return uclass_idname_str[i].id;
46 return UCLASS_INVALID;
49 static enum uclass_id conv_uclass_id(enum uclass_id uclass_id)
52 * This strange adjustment is used because we use UCLASS_MASS_STORAGE
53 * for USB storage devices, so need to return this as the uclass to
54 * use for USB. In fact USB_UCLASS is for USB controllers, not
57 * The name of the UCLASS_MASS_STORAGE uclass driver is
58 * "usb_mass_storage", but we want to use "usb" in things like the
59 * 'part list' command and when showing interfaces.
61 * So for now we have this one-way conversion.
63 * The fix for this is possibly to:
64 * - rename UCLASS_MASS_STORAGE name to "usb"
65 * - rename UCLASS_USB name to "usb_ctlr"
66 * - use UCLASS_MASS_STORAGE instead of UCLASS_USB in if_typename_str
68 if (uclass_id == UCLASS_USB)
69 return UCLASS_MASS_STORAGE;
73 const char *blk_get_uclass_name(enum uclass_id uclass_id)
77 for (i = 0; i < ARRAY_SIZE(uclass_idname_str); i++) {
78 if (uclass_idname_str[i].id == uclass_id)
79 return uclass_idname_str[i].name;
85 struct blk_desc *blk_get_devnum_by_uclass_id(enum uclass_id uclass_id, int devnum)
87 struct blk_desc *desc;
91 ret = blk_get_device(uclass_id, devnum, &dev);
94 desc = dev_get_uclass_plat(dev);
100 * This function is complicated with driver model. We look up the interface
101 * name in a local table. This gives us an interface type which we can match
102 * against the uclass of the block device's parent.
104 struct blk_desc *blk_get_devnum_by_uclass_idname(const char *uclass_idname, int devnum)
106 enum uclass_id uclass_id;
112 type = uclass_name_to_iftype(uclass_idname);
113 if (type == UCLASS_INVALID) {
114 debug("%s: Unknown interface type '%s'\n", __func__,
118 uclass_id = conv_uclass_id(type);
119 if (uclass_id == UCLASS_INVALID) {
120 debug("%s: Unknown uclass for interface type'\n",
121 blk_get_uclass_name(type));
125 ret = uclass_get(UCLASS_BLK, &uc);
128 uclass_foreach_dev(dev, uc) {
129 struct blk_desc *desc = dev_get_uclass_plat(dev);
131 debug("%s: uclass_id=%d, devnum=%d: %s, %d, %d\n", __func__,
132 type, devnum, dev->name, desc->uclass_id, desc->devnum);
133 if (desc->devnum != devnum)
136 /* Find out the parent device uclass */
137 if (device_get_uclass_id(dev->parent) != uclass_id) {
138 debug("%s: parent uclass %d, this dev %d\n", __func__,
139 device_get_uclass_id(dev->parent), uclass_id);
143 if (device_probe(dev))
146 debug("%s: Device desc %p\n", __func__, desc);
149 debug("%s: No device found\n", __func__);
155 * blk_get_by_device() - Get the block device descriptor for the given device
156 * @dev: Instance of a storage device
158 * Return: With block device descriptor on success , NULL if there is no such
161 struct blk_desc *blk_get_by_device(struct udevice *dev)
163 struct udevice *child_dev;
165 device_foreach_child(child_dev, dev) {
166 if (device_get_uclass_id(child_dev) != UCLASS_BLK)
169 return dev_get_uclass_plat(child_dev);
172 debug("%s: No block device found\n", __func__);
178 * get_desc() - Get the block device descriptor for the given device number
180 * @uclass_id: Interface type
181 * @devnum: Device number (0 = first)
182 * @descp: Returns block device descriptor on success
183 * Return: 0 on success, -ENODEV if there is no such device and no device
184 * with a higher device number, -ENOENT if there is no such device but there
185 * is one with a higher number, or other -ve on other error.
187 static int get_desc(enum uclass_id uclass_id, int devnum, struct blk_desc **descp)
189 bool found_more = false;
195 ret = uclass_get(UCLASS_BLK, &uc);
198 uclass_foreach_dev(dev, uc) {
199 struct blk_desc *desc = dev_get_uclass_plat(dev);
201 debug("%s: uclass_id=%d, devnum=%d: %s, %d, %d\n", __func__,
202 uclass_id, devnum, dev->name, desc->uclass_id, desc->devnum);
203 if (desc->uclass_id == uclass_id) {
204 if (desc->devnum == devnum) {
205 ret = device_probe(dev);
211 } else if (desc->devnum > devnum) {
217 return found_more ? -ENOENT : -ENODEV;
220 int blk_select_hwpart_devnum(enum uclass_id uclass_id, int devnum, int hwpart)
225 ret = blk_get_device(uclass_id, devnum, &dev);
229 return blk_select_hwpart(dev, hwpart);
232 int blk_list_part(enum uclass_id uclass_id)
234 struct blk_desc *desc;
238 for (ok = 0, devnum = 0;; ++devnum) {
239 ret = get_desc(uclass_id, devnum, &desc);
244 if (desc->part_type != PART_TYPE_UNKNOWN) {
257 int blk_print_part_devnum(enum uclass_id uclass_id, int devnum)
259 struct blk_desc *desc;
262 ret = get_desc(uclass_id, devnum, &desc);
265 if (desc->type == DEV_TYPE_UNKNOWN)
272 void blk_list_devices(enum uclass_id uclass_id)
274 struct blk_desc *desc;
279 ret = get_desc(uclass_id, i, &desc);
284 if (desc->type == DEV_TYPE_UNKNOWN)
285 continue; /* list only known devices */
286 printf("Device %d: ", i);
291 int blk_print_device_num(enum uclass_id uclass_id, int devnum)
293 struct blk_desc *desc;
296 ret = get_desc(uclass_id, devnum, &desc);
299 printf("\nIDE device %d: ", devnum);
305 int blk_show_device(enum uclass_id uclass_id, int devnum)
307 struct blk_desc *desc;
310 printf("\nDevice %d: ", devnum);
311 ret = get_desc(uclass_id, devnum, &desc);
312 if (ret == -ENODEV || ret == -ENOENT) {
313 printf("unknown device\n");
320 if (desc->type == DEV_TYPE_UNKNOWN)
326 ulong blk_read_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
327 lbaint_t blkcnt, void *buffer)
329 struct blk_desc *desc;
333 ret = get_desc(uclass_id, devnum, &desc);
336 n = blk_dread(desc, start, blkcnt, buffer);
343 ulong blk_write_devnum(enum uclass_id uclass_id, int devnum, lbaint_t start,
344 lbaint_t blkcnt, const void *buffer)
346 struct blk_desc *desc;
349 ret = get_desc(uclass_id, devnum, &desc);
352 return blk_dwrite(desc, start, blkcnt, buffer);
355 int blk_select_hwpart(struct udevice *dev, int hwpart)
357 const struct blk_ops *ops = blk_get_ops(dev);
361 if (!ops->select_hwpart)
364 return ops->select_hwpart(dev, hwpart);
367 int blk_dselect_hwpart(struct blk_desc *desc, int hwpart)
369 return blk_select_hwpart(desc->bdev, hwpart);
372 int blk_first_device(int uclass_id, struct udevice **devp)
374 struct blk_desc *desc;
377 ret = uclass_find_first_device(UCLASS_BLK, devp);
383 desc = dev_get_uclass_plat(*devp);
384 if (desc->uclass_id == uclass_id)
386 ret = uclass_find_next_device(devp);
394 int blk_next_device(struct udevice **devp)
396 struct blk_desc *desc;
399 desc = dev_get_uclass_plat(*devp);
400 uclass_id = desc->uclass_id;
402 ret = uclass_find_next_device(devp);
407 desc = dev_get_uclass_plat(*devp);
408 if (desc->uclass_id == uclass_id)
413 int blk_find_device(int uclass_id, int devnum, struct udevice **devp)
419 ret = uclass_get(UCLASS_BLK, &uc);
422 uclass_foreach_dev(dev, uc) {
423 struct blk_desc *desc = dev_get_uclass_plat(dev);
425 debug("%s: uclass_id=%d, devnum=%d: %s, %d, %d\n", __func__,
426 uclass_id, devnum, dev->name, desc->uclass_id, desc->devnum);
427 if (desc->uclass_id == uclass_id && desc->devnum == devnum) {
436 int blk_get_device(int uclass_id, int devnum, struct udevice **devp)
440 ret = blk_find_device(uclass_id, devnum, devp);
444 return device_probe(*devp);
447 long blk_read(struct udevice *dev, lbaint_t start, lbaint_t blkcnt, void *buf)
449 struct blk_desc *desc = dev_get_uclass_plat(dev);
450 const struct blk_ops *ops = blk_get_ops(dev);
456 if (blkcache_read(desc->uclass_id, desc->devnum,
457 start, blkcnt, desc->blksz, buf))
459 blks_read = ops->read(dev, start, blkcnt, buf);
460 if (blks_read == blkcnt)
461 blkcache_fill(desc->uclass_id, desc->devnum, start, blkcnt,
467 long blk_write(struct udevice *dev, lbaint_t start, lbaint_t blkcnt,
470 struct blk_desc *desc = dev_get_uclass_plat(dev);
471 const struct blk_ops *ops = blk_get_ops(dev);
476 blkcache_invalidate(desc->uclass_id, desc->devnum);
478 return ops->write(dev, start, blkcnt, buf);
481 long blk_erase(struct udevice *dev, lbaint_t start, lbaint_t blkcnt)
483 struct blk_desc *desc = dev_get_uclass_plat(dev);
484 const struct blk_ops *ops = blk_get_ops(dev);
489 blkcache_invalidate(desc->uclass_id, desc->devnum);
491 return ops->erase(dev, start, blkcnt);
494 ulong blk_dread(struct blk_desc *desc, lbaint_t start, lbaint_t blkcnt,
497 return blk_read(desc->bdev, start, blkcnt, buffer);
500 ulong blk_dwrite(struct blk_desc *desc, lbaint_t start, lbaint_t blkcnt,
503 return blk_write(desc->bdev, start, blkcnt, buffer);
506 ulong blk_derase(struct blk_desc *desc, lbaint_t start, lbaint_t blkcnt)
508 return blk_erase(desc->bdev, start, blkcnt);
511 int blk_find_from_parent(struct udevice *parent, struct udevice **devp)
515 if (device_find_first_child_by_uclass(parent, UCLASS_BLK, &dev)) {
516 debug("%s: No block device found for parent '%s'\n", __func__,
525 int blk_get_from_parent(struct udevice *parent, struct udevice **devp)
530 ret = blk_find_from_parent(parent, &dev);
533 ret = device_probe(dev);
541 const char *blk_get_devtype(struct udevice *dev)
543 struct udevice *parent = dev_get_parent(dev);
545 return uclass_get_name(device_get_uclass_id(parent));
548 int blk_find_max_devnum(enum uclass_id uclass_id)
551 int max_devnum = -ENODEV;
555 ret = uclass_get(UCLASS_BLK, &uc);
558 uclass_foreach_dev(dev, uc) {
559 struct blk_desc *desc = dev_get_uclass_plat(dev);
561 if (desc->uclass_id == uclass_id && desc->devnum > max_devnum)
562 max_devnum = desc->devnum;
568 int blk_next_free_devnum(enum uclass_id uclass_id)
572 ret = blk_find_max_devnum(uclass_id);
581 static int blk_flags_check(struct udevice *dev, enum blk_flag_t req_flags)
583 const struct blk_desc *desc = dev_get_uclass_plat(dev);
584 enum blk_flag_t flags;
586 flags = desc->removable ? BLKF_REMOVABLE : BLKF_FIXED;
588 return flags & req_flags ? 0 : 1;
591 int blk_find_first(enum blk_flag_t flags, struct udevice **devp)
595 for (ret = uclass_find_first_device(UCLASS_BLK, devp);
596 *devp && !blk_flags_check(*devp, flags);
597 ret = uclass_find_next_device(devp))
603 int blk_find_next(enum blk_flag_t flags, struct udevice **devp)
607 for (ret = uclass_find_next_device(devp);
608 *devp && !blk_flags_check(*devp, flags);
609 ret = uclass_find_next_device(devp))
615 int blk_first_device_err(enum blk_flag_t flags, struct udevice **devp)
617 for (uclass_first_device(UCLASS_BLK, devp);
619 uclass_next_device(devp)) {
620 if (!blk_flags_check(*devp, flags))
627 int blk_next_device_err(enum blk_flag_t flags, struct udevice **devp)
629 for (uclass_next_device(devp);
631 uclass_next_device(devp)) {
632 if (!blk_flags_check(*devp, flags))
639 int blk_count_devices(enum blk_flag_t flag)
644 blk_foreach_probe(flag, dev)
650 static int blk_claim_devnum(enum uclass_id uclass_id, int devnum)
656 ret = uclass_get(UCLASS_BLK, &uc);
659 uclass_foreach_dev(dev, uc) {
660 struct blk_desc *desc = dev_get_uclass_plat(dev);
662 if (desc->uclass_id == uclass_id && desc->devnum == devnum) {
663 int next = blk_next_free_devnum(uclass_id);
675 int blk_create_device(struct udevice *parent, const char *drv_name,
676 const char *name, int uclass_id, int devnum, int blksz,
677 lbaint_t lba, struct udevice **devp)
679 struct blk_desc *desc;
684 devnum = blk_next_free_devnum(uclass_id);
686 ret = blk_claim_devnum(uclass_id, devnum);
687 if (ret < 0 && ret != -ENOENT)
692 ret = device_bind_driver(parent, drv_name, name, &dev);
695 desc = dev_get_uclass_plat(dev);
696 desc->uclass_id = uclass_id;
698 desc->log2blksz = LOG2(desc->blksz);
700 desc->part_type = PART_TYPE_UNKNOWN;
702 desc->devnum = devnum;
708 int blk_create_devicef(struct udevice *parent, const char *drv_name,
709 const char *name, int uclass_id, int devnum, int blksz,
710 lbaint_t lba, struct udevice **devp)
712 char dev_name[30], *str;
715 snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name);
716 str = strdup(dev_name);
720 ret = blk_create_device(parent, drv_name, str, uclass_id, devnum,
726 device_set_name_alloced(*devp);
731 int blk_probe_or_unbind(struct udevice *dev)
735 ret = device_probe(dev);
737 log_debug("probing %s failed\n", dev->name);
744 int blk_unbind_all(int uclass_id)
747 struct udevice *dev, *next;
750 ret = uclass_get(UCLASS_BLK, &uc);
753 uclass_foreach_dev_safe(dev, next, uc) {
754 struct blk_desc *desc = dev_get_uclass_plat(dev);
756 if (desc->uclass_id == uclass_id) {
757 ret = device_remove(dev, DM_REMOVE_NORMAL);
760 ret = device_unbind(dev);
769 static int blk_post_probe(struct udevice *dev)
771 if (CONFIG_IS_ENABLED(PARTITIONS) && blk_enabled()) {
772 struct blk_desc *desc = dev_get_uclass_plat(dev);
776 if (desc->part_type != PART_TYPE_UNKNOWN &&
777 part_create_block_devices(dev))
778 debug("*** creating partitions failed\n");
784 UCLASS_DRIVER(blk) = {
787 .post_probe = blk_post_probe,
788 .per_device_plat_auto = sizeof(struct blk_desc),