blk-uclass.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Copyright (C) 2016 Google, Inc
  4. * Written by Simon Glass <sjg@chromium.org>
  5. */
  6. #include <common.h>
  7. #include <blk.h>
  8. #include <dm.h>
  9. #include <malloc.h>
  10. #include <part.h>
  11. #include <dm/device-internal.h>
  12. #include <dm/lists.h>
  13. #include <dm/uclass-internal.h>
  14. #include <linux/err.h>
  15. static const char *if_typename_str[IF_TYPE_COUNT] = {
  16. [IF_TYPE_IDE] = "ide",
  17. [IF_TYPE_SCSI] = "scsi",
  18. [IF_TYPE_ATAPI] = "atapi",
  19. [IF_TYPE_USB] = "usb",
  20. [IF_TYPE_DOC] = "doc",
  21. [IF_TYPE_MMC] = "mmc",
  22. [IF_TYPE_SD] = "sd",
  23. [IF_TYPE_SATA] = "sata",
  24. [IF_TYPE_HOST] = "host",
  25. [IF_TYPE_NVME] = "nvme",
  26. [IF_TYPE_EFI] = "efi",
  27. [IF_TYPE_VIRTIO] = "virtio",
  28. };
  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,
  42. };
  43. static enum if_type if_typename_to_iftype(const char *if_typename)
  44. {
  45. int i;
  46. for (i = 0; i < IF_TYPE_COUNT; i++) {
  47. if (if_typename_str[i] &&
  48. !strcmp(if_typename, if_typename_str[i]))
  49. return i;
  50. }
  51. return IF_TYPE_UNKNOWN;
  52. }
  53. static enum uclass_id if_type_to_uclass_id(enum if_type if_type)
  54. {
  55. return if_type_uclass_id[if_type];
  56. }
  57. const char *blk_get_if_type_name(enum if_type if_type)
  58. {
  59. return if_typename_str[if_type];
  60. }
  61. struct blk_desc *blk_get_devnum_by_type(enum if_type if_type, int devnum)
  62. {
  63. struct blk_desc *desc;
  64. struct udevice *dev;
  65. int ret;
  66. ret = blk_get_device(if_type, devnum, &dev);
  67. if (ret)
  68. return NULL;
  69. desc = dev_get_uclass_platdata(dev);
  70. return desc;
  71. }
  72. /*
  73. * This function is complicated with driver model. We look up the interface
  74. * name in a local table. This gives us an interface type which we can match
  75. * against the uclass of the block device's parent.
  76. */
  77. struct blk_desc *blk_get_devnum_by_typename(const char *if_typename, int devnum)
  78. {
  79. enum uclass_id uclass_id;
  80. enum if_type if_type;
  81. struct udevice *dev;
  82. struct uclass *uc;
  83. int ret;
  84. if_type = if_typename_to_iftype(if_typename);
  85. if (if_type == IF_TYPE_UNKNOWN) {
  86. debug("%s: Unknown interface type '%s'\n", __func__,
  87. if_typename);
  88. return NULL;
  89. }
  90. uclass_id = if_type_to_uclass_id(if_type);
  91. if (uclass_id == UCLASS_INVALID) {
  92. debug("%s: Unknown uclass for interface type'\n",
  93. if_typename_str[if_type]);
  94. return NULL;
  95. }
  96. ret = uclass_get(UCLASS_BLK, &uc);
  97. if (ret)
  98. return NULL;
  99. uclass_foreach_dev(dev, uc) {
  100. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  101. debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
  102. if_type, devnum, dev->name, desc->if_type, desc->devnum);
  103. if (desc->devnum != devnum)
  104. continue;
  105. /* Find out the parent device uclass */
  106. if (device_get_uclass_id(dev->parent) != uclass_id) {
  107. debug("%s: parent uclass %d, this dev %d\n", __func__,
  108. device_get_uclass_id(dev->parent), uclass_id);
  109. continue;
  110. }
  111. if (device_probe(dev))
  112. return NULL;
  113. debug("%s: Device desc %p\n", __func__, desc);
  114. return desc;
  115. }
  116. debug("%s: No device found\n", __func__);
  117. return NULL;
  118. }
  119. /**
  120. * blk_get_by_device() - Get the block device descriptor for the given device
  121. * @dev: Instance of a storage device
  122. *
  123. * Return: With block device descriptor on success , NULL if there is no such
  124. * block device.
  125. */
  126. struct blk_desc *blk_get_by_device(struct udevice *dev)
  127. {
  128. struct udevice *child_dev;
  129. device_foreach_child(child_dev, dev) {
  130. if (device_get_uclass_id(child_dev) != UCLASS_BLK)
  131. continue;
  132. return dev_get_uclass_platdata(child_dev);
  133. }
  134. debug("%s: No block device found\n", __func__);
  135. return NULL;
  136. }
  137. /**
  138. * get_desc() - Get the block device descriptor for the given device number
  139. *
  140. * @if_type: Interface type
  141. * @devnum: Device number (0 = first)
  142. * @descp: Returns block device descriptor on success
  143. * @return 0 on success, -ENODEV if there is no such device and no device
  144. * with a higher device number, -ENOENT if there is no such device but there
  145. * is one with a higher number, or other -ve on other error.
  146. */
  147. static int get_desc(enum if_type if_type, int devnum, struct blk_desc **descp)
  148. {
  149. bool found_more = false;
  150. struct udevice *dev;
  151. struct uclass *uc;
  152. int ret;
  153. *descp = NULL;
  154. ret = uclass_get(UCLASS_BLK, &uc);
  155. if (ret)
  156. return ret;
  157. uclass_foreach_dev(dev, uc) {
  158. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  159. debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
  160. if_type, devnum, dev->name, desc->if_type, desc->devnum);
  161. if (desc->if_type == if_type) {
  162. if (desc->devnum == devnum) {
  163. ret = device_probe(dev);
  164. if (ret)
  165. return ret;
  166. *descp = desc;
  167. return 0;
  168. } else if (desc->devnum > devnum) {
  169. found_more = true;
  170. }
  171. }
  172. }
  173. return found_more ? -ENOENT : -ENODEV;
  174. }
  175. int blk_select_hwpart_devnum(enum if_type if_type, int devnum, int hwpart)
  176. {
  177. struct udevice *dev;
  178. int ret;
  179. ret = blk_get_device(if_type, devnum, &dev);
  180. if (ret)
  181. return ret;
  182. return blk_select_hwpart(dev, hwpart);
  183. }
  184. int blk_list_part(enum if_type if_type)
  185. {
  186. struct blk_desc *desc;
  187. int devnum, ok;
  188. int ret;
  189. for (ok = 0, devnum = 0;; ++devnum) {
  190. ret = get_desc(if_type, devnum, &desc);
  191. if (ret == -ENODEV)
  192. break;
  193. else if (ret)
  194. continue;
  195. if (desc->part_type != PART_TYPE_UNKNOWN) {
  196. ++ok;
  197. if (devnum)
  198. putc('\n');
  199. part_print(desc);
  200. }
  201. }
  202. if (!ok)
  203. return -ENODEV;
  204. return 0;
  205. }
  206. int blk_print_part_devnum(enum if_type if_type, int devnum)
  207. {
  208. struct blk_desc *desc;
  209. int ret;
  210. ret = get_desc(if_type, devnum, &desc);
  211. if (ret)
  212. return ret;
  213. if (desc->type == DEV_TYPE_UNKNOWN)
  214. return -ENOENT;
  215. part_print(desc);
  216. return 0;
  217. }
  218. void blk_list_devices(enum if_type if_type)
  219. {
  220. struct blk_desc *desc;
  221. int ret;
  222. int i;
  223. for (i = 0;; ++i) {
  224. ret = get_desc(if_type, i, &desc);
  225. if (ret == -ENODEV)
  226. break;
  227. else if (ret)
  228. continue;
  229. if (desc->type == DEV_TYPE_UNKNOWN)
  230. continue; /* list only known devices */
  231. printf("Device %d: ", i);
  232. dev_print(desc);
  233. }
  234. }
  235. int blk_print_device_num(enum if_type if_type, int devnum)
  236. {
  237. struct blk_desc *desc;
  238. int ret;
  239. ret = get_desc(if_type, devnum, &desc);
  240. if (ret)
  241. return ret;
  242. printf("\nIDE device %d: ", devnum);
  243. dev_print(desc);
  244. return 0;
  245. }
  246. int blk_show_device(enum if_type if_type, int devnum)
  247. {
  248. struct blk_desc *desc;
  249. int ret;
  250. printf("\nDevice %d: ", devnum);
  251. ret = get_desc(if_type, devnum, &desc);
  252. if (ret == -ENODEV || ret == -ENOENT) {
  253. printf("unknown device\n");
  254. return -ENODEV;
  255. }
  256. if (ret)
  257. return ret;
  258. dev_print(desc);
  259. if (desc->type == DEV_TYPE_UNKNOWN)
  260. return -ENOENT;
  261. return 0;
  262. }
  263. ulong blk_read_devnum(enum if_type if_type, int devnum, lbaint_t start,
  264. lbaint_t blkcnt, void *buffer)
  265. {
  266. struct blk_desc *desc;
  267. ulong n;
  268. int ret;
  269. ret = get_desc(if_type, devnum, &desc);
  270. if (ret)
  271. return ret;
  272. n = blk_dread(desc, start, blkcnt, buffer);
  273. if (IS_ERR_VALUE(n))
  274. return n;
  275. return n;
  276. }
  277. ulong blk_write_devnum(enum if_type if_type, int devnum, lbaint_t start,
  278. lbaint_t blkcnt, const void *buffer)
  279. {
  280. struct blk_desc *desc;
  281. int ret;
  282. ret = get_desc(if_type, devnum, &desc);
  283. if (ret)
  284. return ret;
  285. return blk_dwrite(desc, start, blkcnt, buffer);
  286. }
  287. int blk_select_hwpart(struct udevice *dev, int hwpart)
  288. {
  289. const struct blk_ops *ops = blk_get_ops(dev);
  290. if (!ops)
  291. return -ENOSYS;
  292. if (!ops->select_hwpart)
  293. return 0;
  294. return ops->select_hwpart(dev, hwpart);
  295. }
  296. int blk_dselect_hwpart(struct blk_desc *desc, int hwpart)
  297. {
  298. return blk_select_hwpart(desc->bdev, hwpart);
  299. }
  300. int blk_first_device(int if_type, struct udevice **devp)
  301. {
  302. struct blk_desc *desc;
  303. int ret;
  304. ret = uclass_find_first_device(UCLASS_BLK, devp);
  305. if (ret)
  306. return ret;
  307. if (!*devp)
  308. return -ENODEV;
  309. do {
  310. desc = dev_get_uclass_platdata(*devp);
  311. if (desc->if_type == if_type)
  312. return 0;
  313. ret = uclass_find_next_device(devp);
  314. if (ret)
  315. return ret;
  316. } while (*devp);
  317. return -ENODEV;
  318. }
  319. int blk_next_device(struct udevice **devp)
  320. {
  321. struct blk_desc *desc;
  322. int ret, if_type;
  323. desc = dev_get_uclass_platdata(*devp);
  324. if_type = desc->if_type;
  325. do {
  326. ret = uclass_find_next_device(devp);
  327. if (ret)
  328. return ret;
  329. if (!*devp)
  330. return -ENODEV;
  331. desc = dev_get_uclass_platdata(*devp);
  332. if (desc->if_type == if_type)
  333. return 0;
  334. } while (1);
  335. }
  336. int blk_find_device(int if_type, int devnum, struct udevice **devp)
  337. {
  338. struct uclass *uc;
  339. struct udevice *dev;
  340. int ret;
  341. ret = uclass_get(UCLASS_BLK, &uc);
  342. if (ret)
  343. return ret;
  344. uclass_foreach_dev(dev, uc) {
  345. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  346. debug("%s: if_type=%d, devnum=%d: %s, %d, %d\n", __func__,
  347. if_type, devnum, dev->name, desc->if_type, desc->devnum);
  348. if (desc->if_type == if_type && desc->devnum == devnum) {
  349. *devp = dev;
  350. return 0;
  351. }
  352. }
  353. return -ENODEV;
  354. }
  355. int blk_get_device(int if_type, int devnum, struct udevice **devp)
  356. {
  357. int ret;
  358. ret = blk_find_device(if_type, devnum, devp);
  359. if (ret)
  360. return ret;
  361. return device_probe(*devp);
  362. }
  363. unsigned long blk_dread(struct blk_desc *block_dev, lbaint_t start,
  364. lbaint_t blkcnt, void *buffer)
  365. {
  366. struct udevice *dev = block_dev->bdev;
  367. const struct blk_ops *ops = blk_get_ops(dev);
  368. ulong blks_read;
  369. if (!ops->read)
  370. return -ENOSYS;
  371. if (blkcache_read(block_dev->if_type, block_dev->devnum,
  372. start, blkcnt, block_dev->blksz, buffer))
  373. return blkcnt;
  374. blks_read = ops->read(dev, start, blkcnt, buffer);
  375. if (blks_read == blkcnt)
  376. blkcache_fill(block_dev->if_type, block_dev->devnum,
  377. start, blkcnt, block_dev->blksz, buffer);
  378. return blks_read;
  379. }
  380. unsigned long blk_dwrite(struct blk_desc *block_dev, lbaint_t start,
  381. lbaint_t blkcnt, const void *buffer)
  382. {
  383. struct udevice *dev = block_dev->bdev;
  384. const struct blk_ops *ops = blk_get_ops(dev);
  385. if (!ops->write)
  386. return -ENOSYS;
  387. blkcache_invalidate(block_dev->if_type, block_dev->devnum);
  388. return ops->write(dev, start, blkcnt, buffer);
  389. }
  390. unsigned long blk_derase(struct blk_desc *block_dev, lbaint_t start,
  391. lbaint_t blkcnt)
  392. {
  393. struct udevice *dev = block_dev->bdev;
  394. const struct blk_ops *ops = blk_get_ops(dev);
  395. if (!ops->erase)
  396. return -ENOSYS;
  397. blkcache_invalidate(block_dev->if_type, block_dev->devnum);
  398. return ops->erase(dev, start, blkcnt);
  399. }
  400. int blk_get_from_parent(struct udevice *parent, struct udevice **devp)
  401. {
  402. struct udevice *dev;
  403. enum uclass_id id;
  404. int ret;
  405. device_find_first_child(parent, &dev);
  406. if (!dev) {
  407. debug("%s: No block device found for parent '%s'\n", __func__,
  408. parent->name);
  409. return -ENODEV;
  410. }
  411. id = device_get_uclass_id(dev);
  412. if (id != UCLASS_BLK) {
  413. debug("%s: Incorrect uclass %s for block device '%s'\n",
  414. __func__, uclass_get_name(id), dev->name);
  415. return -ENOTBLK;
  416. }
  417. ret = device_probe(dev);
  418. if (ret)
  419. return ret;
  420. *devp = dev;
  421. return 0;
  422. }
  423. int blk_find_max_devnum(enum if_type if_type)
  424. {
  425. struct udevice *dev;
  426. int max_devnum = -ENODEV;
  427. struct uclass *uc;
  428. int ret;
  429. ret = uclass_get(UCLASS_BLK, &uc);
  430. if (ret)
  431. return ret;
  432. uclass_foreach_dev(dev, uc) {
  433. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  434. if (desc->if_type == if_type && desc->devnum > max_devnum)
  435. max_devnum = desc->devnum;
  436. }
  437. return max_devnum;
  438. }
  439. int blk_next_free_devnum(enum if_type if_type)
  440. {
  441. int ret;
  442. ret = blk_find_max_devnum(if_type);
  443. if (ret == -ENODEV)
  444. return 0;
  445. if (ret < 0)
  446. return ret;
  447. return ret + 1;
  448. }
  449. static int blk_claim_devnum(enum if_type if_type, int devnum)
  450. {
  451. struct udevice *dev;
  452. struct uclass *uc;
  453. int ret;
  454. ret = uclass_get(UCLASS_BLK, &uc);
  455. if (ret)
  456. return ret;
  457. uclass_foreach_dev(dev, uc) {
  458. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  459. if (desc->if_type == if_type && desc->devnum == devnum) {
  460. int next = blk_next_free_devnum(if_type);
  461. if (next < 0)
  462. return next;
  463. desc->devnum = next;
  464. return 0;
  465. }
  466. }
  467. return -ENOENT;
  468. }
  469. int blk_create_device(struct udevice *parent, const char *drv_name,
  470. const char *name, int if_type, int devnum, int blksz,
  471. lbaint_t lba, struct udevice **devp)
  472. {
  473. struct blk_desc *desc;
  474. struct udevice *dev;
  475. int ret;
  476. if (devnum == -1) {
  477. devnum = blk_next_free_devnum(if_type);
  478. } else {
  479. ret = blk_claim_devnum(if_type, devnum);
  480. if (ret < 0 && ret != -ENOENT)
  481. return ret;
  482. }
  483. if (devnum < 0)
  484. return devnum;
  485. ret = device_bind_driver(parent, drv_name, name, &dev);
  486. if (ret)
  487. return ret;
  488. desc = dev_get_uclass_platdata(dev);
  489. desc->if_type = if_type;
  490. desc->blksz = blksz;
  491. desc->log2blksz = LOG2(desc->blksz);
  492. desc->lba = lba;
  493. desc->part_type = PART_TYPE_UNKNOWN;
  494. desc->bdev = dev;
  495. desc->devnum = devnum;
  496. *devp = dev;
  497. return 0;
  498. }
  499. int blk_create_devicef(struct udevice *parent, const char *drv_name,
  500. const char *name, int if_type, int devnum, int blksz,
  501. lbaint_t lba, struct udevice **devp)
  502. {
  503. char dev_name[30], *str;
  504. int ret;
  505. snprintf(dev_name, sizeof(dev_name), "%s.%s", parent->name, name);
  506. str = strdup(dev_name);
  507. if (!str)
  508. return -ENOMEM;
  509. ret = blk_create_device(parent, drv_name, str, if_type, devnum,
  510. blksz, lba, devp);
  511. if (ret) {
  512. free(str);
  513. return ret;
  514. }
  515. device_set_name_alloced(*devp);
  516. return 0;
  517. }
  518. int blk_unbind_all(int if_type)
  519. {
  520. struct uclass *uc;
  521. struct udevice *dev, *next;
  522. int ret;
  523. ret = uclass_get(UCLASS_BLK, &uc);
  524. if (ret)
  525. return ret;
  526. uclass_foreach_dev_safe(dev, next, uc) {
  527. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  528. if (desc->if_type == if_type) {
  529. ret = device_remove(dev, DM_REMOVE_NORMAL);
  530. if (ret)
  531. return ret;
  532. ret = device_unbind(dev);
  533. if (ret)
  534. return ret;
  535. }
  536. }
  537. return 0;
  538. }
  539. static int blk_post_probe(struct udevice *dev)
  540. {
  541. #if defined(CONFIG_PARTITIONS) && defined(CONFIG_HAVE_BLOCK_DEVICE)
  542. struct blk_desc *desc = dev_get_uclass_platdata(dev);
  543. part_init(desc);
  544. #endif
  545. return 0;
  546. }
  547. UCLASS_DRIVER(blk) = {
  548. .id = UCLASS_BLK,
  549. .name = "blk",
  550. .post_probe = blk_post_probe,
  551. .per_device_platdata_auto_alloc_size = sizeof(struct blk_desc),
  552. };