1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2016 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
10 #include <dm/device-internal.h>
12 #include <dm/uclass-internal.h>
14 static const char *if_typename_str[IF_TYPE_COUNT] = {
15 [IF_TYPE_IDE] = "ide",
16 [IF_TYPE_SCSI] = "scsi",
17 [IF_TYPE_ATAPI] = "atapi",
18 [IF_TYPE_USB] = "usb",
19 [IF_TYPE_DOC] = "doc",
20 [IF_TYPE_MMC] = "mmc",
22 [IF_TYPE_SATA] = "sata",
23 [IF_TYPE_HOST] = "host",
24 [IF_TYPE_NVME] = "nvme",
25 [IF_TYPE_EFI] = "efi",
26 [IF_TYPE_VIRTIO] = "virtio",
29 static enum uclass_id if_type_uclass_id[IF_TYPE_COUNT] = {
30 [IF_TYPE_IDE] = UCLASS_IDE,
31 [IF_TYPE_SCSI] = UCLASS_SCSI,
32 [IF_TYPE_ATAPI] = UCLASS_INVALID,
33 [IF_TYPE_USB] = UCLASS_MASS_STORAGE,
34 [IF_TYPE_DOC] = UCLASS_INVALID,
35 [IF_TYPE_MMC] = UCLASS_MMC,
36 [IF_TYPE_SD] = UCLASS_INVALID,
37 [IF_TYPE_SATA] = UCLASS_AHCI,
38 [IF_TYPE_HOST] = UCLASS_ROOT,
39 [IF_TYPE_NVME] = UCLASS_NVME,
40 [IF_TYPE_EFI] = UCLASS_EFI,
41 [IF_TYPE_VIRTIO] = UCLASS_VIRTIO,
44 static enum if_type if_typename_to_iftype(const char *if_typename)
48 for (i = 0; i < IF_TYPE_COUNT; i++) {
49 if (if_typename_str[i] &&
50 !strcmp(if_typename, if_typename_str[i]))
54 return IF_TYPE_UNKNOWN;
57 static enum uclass_id if_type_to_uclass_id(enum if_type if_type)
59 return if_type_uclass_id[if_type];
62 const char *blk_get_if_type_name(enum if_type if_type)
64 return if_typename_str[if_type];
67 struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum)
69 struct blk_desc *desc;
73 ret = blk_get_device(if_type, devnum, &dev);
76 desc = dev_get_uclass_platdata(dev);
82 * This function is complicated with driver model. We look up the interface
83 * name in a local table. This gives us an interface type which we can match
84 * against the uclass of the block device's parent.
86 struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, int devnum)
88 enum uclass_id uclass_id;
94 if_type = if_typename_to_iftype(if_typename);
95 if (if_type == IF_TYPE_UNKNOWN) {
96 debug("%s: Unknown interface type '%s'\n", __func__,
100 uclass_id = if_type_to_uclass_id(if_type);
101 if (uclass_id == UCLASS_INVALID) {
102 debug("%s: Unknown uclass for interface type'\n",
103 if_typename_str[if_type]);
107 ret = uclass_get(UCLASS_BLK, &uc);
110 uclass_foreach_dev(dev, uc) {
111 struct blk_desc *desc = dev_get_uclass_platdata(dev);
113 debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
114 if_type, devnum, dev->name, desc->if_type, desc->devnum);
115 if (desc->devnum != devnum)
118 /* Find out the parent device uclass */
119 if (device_get_uclass_id(dev->parent) != uclass_id) {
120 debug("%s: parent uclass %d, this dev %d\n", __func__,
121 device_get_uclass_id(dev->parent), uclass_id);
125 if (device_probe(dev))
128 debug("%s: Device desc %p\n", __func__, desc);
131 debug("%s: No device found\n", __func__);
137 * blk_get_by_device() - Get the block device descriptor for the given device
138 * @dev: Instance of a storage device
140 * Return: With block device descriptor on success , NULL if there is no such
143 struct blk_desc *blk_get_by_device(struct udevice *dev)
145 struct udevice *child_dev, *next;
147 device_foreach_child_safe(child_dev, next, dev) {
148 if (device_get_uclass_id(child_dev) != UCLASS_BLK)
151 return dev_get_uclass_platdata(child_dev);
154 debug("%s: No block device found\n", __func__);
160 * get_desc() - Get the block device descriptor for the given device number
162 * @if_type: Interface type
163 * @devnum: Device number (0 = first)
164 * @descp: Returns block device descriptor on success
165 * @return 0 on success, -ENODEV if there is no such device and no device
166 * with a higher device number, -ENOENT if there is no such device but there
167 * is one with a higher number, or other -ve on other error.
169 static int get_desc(enum if_type if_type, int devnum, struct blk_desc **descp)
171 bool found_more = false;
177 ret = uclass_get(UCLASS_BLK, &uc);
180 uclass_foreach_dev(dev, uc) {
181 struct blk_desc *desc = dev_get_uclass_platdata(dev);
183 debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
184 if_type, devnum, dev->name, desc->if_type, desc->devnum);
185 if (desc->if_type == if_type) {
186 if (desc->devnum == devnum) {
187 ret = device_probe(dev);
193 } else if (desc->devnum > devnum) {
199 return found_more ? -ENOENT : -ENODEV;
202 int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart)
207 ret = blk_get_device(if_type, devnum, &dev);
211 ret = blk_select_hwpart(dev, hwpart);
213 blkcache_invalidate(if_type, devnum);
218 int blk_list_part(enum if_type if_type)
220 struct blk_desc *desc;
224 for (ok = 0, devnum = 0;; ++devnum) {
225 ret = get_desc(if_type, devnum, &desc);
230 if (desc->part_type != PART_TYPE_UNKNOWN) {
243 int blk_print_part_devnum(enum if_type if_type, int devnum)
245 struct blk_desc *desc;
248 ret = get_desc(if_type, devnum, &desc);
251 if (desc->type == DEV_TYPE_UNKNOWN)
258 void blk_list_devices(enum if_type if_type)
260 struct blk_desc *desc;
265 ret = get_desc(if_type, i, &desc);
270 if (desc->type == DEV_TYPE_UNKNOWN)
271 continue; /* list only known devices */
272 printf("Device %d: ", i);
277 int blk_print_device_num(enum if_type if_type, int devnum)
279 struct blk_desc *desc;
282 ret = get_desc(if_type, devnum, &desc);
285 printf("\nIDE device %d: ", devnum);
291 int blk_show_device(enum if_type if_type, int devnum)
293 struct blk_desc *desc;
296 printf("\nDevice %d: ", devnum);
297 ret = get_desc(if_type, devnum, &desc);
298 if (ret == -ENODEV || ret == -ENOENT) {
299 printf("unknown device\n");
306 if (desc->type == DEV_TYPE_UNKNOWN)
312 ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start,
313 lbaint_t blkcnt, void *buffer)
315 struct blk_desc *desc;
319 ret = get_desc(if_type, devnum, &desc);
322 n = blk_dread(desc, start, blkcnt, buffer);
329 ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start,
330 lbaint_t blkcnt, const void *buffer)
332 struct blk_desc *desc;
335 ret = get_desc(if_type, devnum, &desc);
338 return blk_dwrite(desc, start, blkcnt, buffer);
341 int blk_select_hwpart(struct udevice *dev, int hwpart)
343 const struct blk_ops *ops = blk_get_ops(dev);
347 if (!ops->select_hwpart)
350 return ops->select_hwpart(dev, hwpart);
353 int blk_dselect_hwpart(struct blk_desc *desc, int hwpart)
357 ret = blk_select_hwpart(desc->bdev, hwpart);
359 blkcache_invalidate(desc->if_type, desc->devnum);
364 int blk_first_device(int if_type, struct udevice **devp)
366 struct blk_desc *desc;
369 ret = uclass_find_first_device(UCLASS_BLK, devp);
375 desc = dev_get_uclass_platdata(*devp);
376 if (desc->if_type == if_type)
378 ret = uclass_find_next_device(devp);
386 int blk_next_device(struct udevice **devp)
388 struct blk_desc *desc;
391 desc = dev_get_uclass_platdata(*devp);
392 if_type = desc->if_type;
394 ret = uclass_find_next_device(devp);
399 desc = dev_get_uclass_platdata(*devp);
400 if (desc->if_type == if_type)
405 int blk_find_device(int if_type, int devnum, struct udevice **devp)
411 ret = uclass_get(UCLASS_BLK, &uc);
414 uclass_foreach_dev(dev, uc) {
415 struct blk_desc *desc = dev_get_uclass_platdata(dev);
417 debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
418 if_type, devnum, dev->name, desc->if_type, desc->devnum);
419 if (desc->if_type == if_type && desc->devnum == devnum) {
428 int blk_get_device(int if_type, int devnum, struct udevice **devp)
432 ret = blk_find_device(if_type, devnum, devp);
436 return device_probe(*devp);
439 unsigned long blk_dread(struct blk_desc *block_dev, lbaint_t start,
440 lbaint_t blkcnt, void *buffer)
442 struct udevice *dev = block_dev->bdev;
443 const struct blk_ops *ops = blk_get_ops(dev);
449 if (blkcache_read(block_dev->if_type, block_dev->devnum,
450 start, blkcnt, block_dev->blksz, buffer))
452 blks_read = ops->read(dev, start, blkcnt, buffer);
453 if (blks_read == blkcnt)
454 blkcache_fill(block_dev->if_type, block_dev->devnum,
455 start, blkcnt, block_dev->blksz, buffer);
460 unsigned long blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
461 lbaint_t blkcnt, const void *buffer)
463 struct udevice *dev = block_dev->bdev;
464 const struct blk_ops *ops = blk_get_ops(dev);
469 blkcache_invalidate(block_dev->if_type, block_dev->devnum);
470 return ops->write(dev, start, blkcnt, buffer);
473 unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start,
476 struct udevice *dev = block_dev->bdev;
477 const struct blk_ops *ops = blk_get_ops(dev);
482 blkcache_invalidate(block_dev->if_type, block_dev->devnum);
483 return ops->erase(dev, start, blkcnt);
486 int blk_get_from_parent(struct udevice *parent, struct udevice **devp)
492 device_find_first_child(parent, &dev);
494 debug("%s: No block device found for parent '%s'\n", __func__,
498 id = device_get_uclass_id(dev);
499 if (id != UCLASS_BLK) {
500 debug("%s: Incorrect uclass %s for block device '%s'\n",
501 __func__, uclass_get_name(id), dev->name);
504 ret = device_probe(dev);
512 int blk_find_max_devnum(enum if_type if_type)
515 int max_devnum = -ENODEV;
519 ret = uclass_get(UCLASS_BLK, &uc);
522 uclass_foreach_dev(dev, uc) {
523 struct blk_desc *desc = dev_get_uclass_platdata(dev);
525 if (desc->if_type == if_type && desc->devnum > max_devnum)
526 max_devnum = desc->devnum;
532 int blk_next_free_devnum(enum if_type if_type)
536 ret = blk_find_max_devnum(if_type);
545 static int blk_claim_devnum(enum if_type if_type, int devnum)
551 ret = uclass_get(UCLASS_BLK, &uc);
554 uclass_foreach_dev(dev, uc) {
555 struct blk_desc *desc = dev_get_uclass_platdata(dev);
557 if (desc->if_type == if_type && desc->devnum == devnum) {
558 int next = blk_next_free_devnum(if_type);
570 int blk_create_device(struct udevice *parent, const char *drv_name,
571 const char *name, int if_type, int devnum, int blksz,
572 lbaint_t lba, struct udevice **devp)
574 struct blk_desc *desc;
579 devnum = blk_next_free_devnum(if_type);
581 ret = blk_claim_devnum(if_type, devnum);
582 if (ret < 0 && ret != -ENOENT)
587 ret = device_bind_driver(parent, drv_name, name, &dev);
590 desc = dev_get_uclass_platdata(dev);
591 desc->if_type = if_type;
594 desc->part_type = PART_TYPE_UNKNOWN;
596 desc->devnum = devnum;
602 int blk_create_devicef(struct udevice *parent, const char *drv_name,
603 const char *name, int if_type, int devnum, int blksz,
604 lbaint_t lba, struct udevice **devp)
606 char dev_name[30], *str;
609 snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name);
610 str = strdup(dev_name);
614 ret = blk_create_device(parent, drv_name, str, if_type, devnum,
620 device_set_name_alloced(*devp);
625 int blk_unbind_all(int if_type)
628 struct udevice *dev, *next;
631 ret = uclass_get(UCLASS_BLK, &uc);
634 uclass_foreach_dev_safe(dev, next, uc) {
635 struct blk_desc *desc = dev_get_uclass_platdata(dev);
637 if (desc->if_type == if_type) {
638 ret = device_remove(dev, DM_REMOVE_NORMAL);
641 ret = device_unbind(dev);
650 static int blk_post_probe(struct udevice *dev)
652 #if defined(CONFIG_PARTITIONS) && defined(CONFIG_HAVE_BLOCK_DEVICE)
653 struct blk_desc *desc = dev_get_uclass_platdata(dev);
661 UCLASS_DRIVER(blk) = {
664 .post_probe = blk_post_probe,
665 .per_device_platdata_auto_alloc_size = sizeof(struct blk_desc),