api_storage.c 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2007-2008 Semihalf
  4. *
  5. * Written by: Rafal Jaworowski <raj@semihalf.com>
  6. */
  7. #include <config.h>
  8. #include <common.h>
  9. #include <api_public.h>
  10. #include <part.h>
  11. #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
  12. #include <usb.h>
  13. #endif
  14. #define DEBUG
  15. #undef DEBUG
  16. #ifdef DEBUG
  17. #define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt, ##args); } while (0)
  18. #else
  19. #define debugf(fmt, args...)
  20. #endif
  21. #define errf(fmt, args...) do { printf("ERROR @ %s(): ", __func__); printf(fmt, ##args); } while (0)
  22. #define ENUM_IDE 0
  23. #define ENUM_USB 1
  24. #define ENUM_SCSI 2
  25. #define ENUM_MMC 3
  26. #define ENUM_SATA 4
  27. #define ENUM_MAX 5
  28. struct stor_spec {
  29. int max_dev;
  30. int enum_started;
  31. int enum_ended;
  32. int type; /* "external" type: DT_STOR_{IDE,USB,etc} */
  33. char *name;
  34. };
  35. static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, };
  36. #ifndef CONFIG_SYS_MMC_MAX_DEVICE
  37. #define CONFIG_SYS_MMC_MAX_DEVICE 1
  38. #endif
  39. void dev_stor_init(void)
  40. {
  41. #if defined(CONFIG_IDE)
  42. specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE;
  43. specs[ENUM_IDE].enum_started = 0;
  44. specs[ENUM_IDE].enum_ended = 0;
  45. specs[ENUM_IDE].type = DEV_TYP_STOR | DT_STOR_IDE;
  46. specs[ENUM_IDE].name = "ide";
  47. #endif
  48. #if defined(CONFIG_CMD_MMC)
  49. specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE;
  50. specs[ENUM_MMC].enum_started = 0;
  51. specs[ENUM_MMC].enum_ended = 0;
  52. specs[ENUM_MMC].type = DEV_TYP_STOR | DT_STOR_MMC;
  53. specs[ENUM_MMC].name = "mmc";
  54. #endif
  55. #if defined(CONFIG_SATA)
  56. specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE;
  57. specs[ENUM_SATA].enum_started = 0;
  58. specs[ENUM_SATA].enum_ended = 0;
  59. specs[ENUM_SATA].type = DEV_TYP_STOR | DT_STOR_SATA;
  60. specs[ENUM_SATA].name = "sata";
  61. #endif
  62. #if defined(CONFIG_SCSI)
  63. specs[ENUM_SCSI].max_dev = CONFIG_SYS_SCSI_MAX_DEVICE;
  64. specs[ENUM_SCSI].enum_started = 0;
  65. specs[ENUM_SCSI].enum_ended = 0;
  66. specs[ENUM_SCSI].type = DEV_TYP_STOR | DT_STOR_SCSI;
  67. specs[ENUM_SCSI].name = "scsi";
  68. #endif
  69. #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
  70. specs[ENUM_USB].max_dev = USB_MAX_STOR_DEV;
  71. specs[ENUM_USB].enum_started = 0;
  72. specs[ENUM_USB].enum_ended = 0;
  73. specs[ENUM_USB].type = DEV_TYP_STOR | DT_STOR_USB;
  74. specs[ENUM_USB].name = "usb";
  75. #endif
  76. }
  77. /*
  78. * Finds next available device in the storage group
  79. *
  80. * type: storage group type - ENUM_IDE, ENUM_SCSI etc.
  81. *
  82. * more: returns 0/1 depending if there are more devices in this group
  83. * available (for future iterations)
  84. *
  85. * returns: 0/1 depending if device found in this iteration
  86. */
  87. static int dev_stor_get(int type, int *more, struct device_info *di)
  88. {
  89. struct blk_desc *dd;
  90. int found = 0;
  91. int found_last = 0;
  92. int i = 0;
  93. /* Wasn't configured for this type, return 0 directly */
  94. if (specs[type].name == NULL)
  95. return 0;
  96. if (di->cookie != NULL) {
  97. /* Find the last device we've returned */
  98. for (i = 0; i < specs[type].max_dev; i++) {
  99. if (di->cookie ==
  100. (void *)blk_get_dev(specs[type].name, i)) {
  101. i += 1;
  102. found_last = 1;
  103. break;
  104. }
  105. }
  106. if (!found_last)
  107. i = 0;
  108. }
  109. for (; i < specs[type].max_dev; i++) {
  110. di->cookie = (void *)blk_get_dev(specs[type].name, i);
  111. if (di->cookie != NULL) {
  112. found = 1;
  113. break;
  114. }
  115. }
  116. if (i == specs[type].max_dev)
  117. *more = 0;
  118. else
  119. *more = 1;
  120. if (found) {
  121. di->type = specs[type].type;
  122. dd = (struct blk_desc *)di->cookie;
  123. if (dd->type == DEV_TYPE_UNKNOWN) {
  124. debugf("device instance exists, but is not active..");
  125. found = 0;
  126. } else {
  127. di->di_stor.block_count = dd->lba;
  128. di->di_stor.block_size = dd->blksz;
  129. }
  130. } else {
  131. di->cookie = NULL;
  132. }
  133. return found;
  134. }
  135. /* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */
  136. static int dev_stor_type(struct blk_desc *dd)
  137. {
  138. int i, j;
  139. for (i = ENUM_IDE; i < ENUM_MAX; i++)
  140. for (j = 0; j < specs[i].max_dev; j++)
  141. if (dd == blk_get_dev(specs[i].name, j))
  142. return i;
  143. return ENUM_MAX;
  144. }
  145. /* returns: 0/1 whether cookie points to some device in this group */
  146. static int dev_is_stor(int type, struct device_info *di)
  147. {
  148. return (dev_stor_type(di->cookie) == type) ? 1 : 0;
  149. }
  150. static int dev_enum_stor(int type, struct device_info *di)
  151. {
  152. int found = 0, more = 0;
  153. debugf("called, type %d\n", type);
  154. /*
  155. * Formulae for enumerating storage devices:
  156. * 1. if cookie (hint from previous enum call) is NULL we start again
  157. * with enumeration, so return the first available device, done.
  158. *
  159. * 2. if cookie is not NULL, check if it identifies some device in
  160. * this group:
  161. *
  162. * 2a. if cookie is a storage device from our group (IDE, USB etc.),
  163. * return next available (if exists) in this group
  164. *
  165. * 2b. if it isn't device from our group, check if such devices were
  166. * ever enumerated before:
  167. * - if not, return the first available device from this group
  168. * - else return 0
  169. */
  170. if (di->cookie == NULL) {
  171. debugf("group%d - enum restart\n", type);
  172. /*
  173. * 1. Enumeration (re-)started: take the first available
  174. * device, if exists
  175. */
  176. found = dev_stor_get(type, &more, di);
  177. specs[type].enum_started = 1;
  178. } else if (dev_is_stor(type, di)) {
  179. debugf("group%d - enum continued for the next device\n", type);
  180. if (specs[type].enum_ended) {
  181. debugf("group%d - nothing more to enum!\n", type);
  182. return 0;
  183. }
  184. /* 2a. Attempt to take a next available device in the group */
  185. found = dev_stor_get(type, &more, di);
  186. } else {
  187. if (specs[type].enum_ended) {
  188. debugf("group %d - already enumerated, skipping\n", type);
  189. return 0;
  190. }
  191. debugf("group%d - first time enum\n", type);
  192. if (specs[type].enum_started == 0) {
  193. /*
  194. * 2b. If enumerating devices in this group did not
  195. * happen before, it means the cookie pointed to a
  196. * device from some other group (another storage
  197. * group, or network); in this case try to take the
  198. * first available device from our group
  199. */
  200. specs[type].enum_started = 1;
  201. /*
  202. * Attempt to take the first device in this group:
  203. *'first element' flag is set
  204. */
  205. found = dev_stor_get(type, &more, di);
  206. } else {
  207. errf("group%d - out of order iteration\n", type);
  208. found = 0;
  209. more = 0;
  210. }
  211. }
  212. /*
  213. * If there are no more devices in this group, consider its
  214. * enumeration finished
  215. */
  216. specs[type].enum_ended = (!more) ? 1 : 0;
  217. if (found)
  218. debugf("device found, returning cookie 0x%08x\n",
  219. (u_int32_t)di->cookie);
  220. else
  221. debugf("no device found\n");
  222. return found;
  223. }
  224. void dev_enum_reset(void)
  225. {
  226. int i;
  227. for (i = 0; i < ENUM_MAX; i ++) {
  228. specs[i].enum_started = 0;
  229. specs[i].enum_ended = 0;
  230. }
  231. }
  232. int dev_enum_storage(struct device_info *di)
  233. {
  234. int i;
  235. /* check: ide, usb, scsi, mmc */
  236. for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
  237. if (dev_enum_stor(i, di))
  238. return 1;
  239. }
  240. return 0;
  241. }
  242. static int dev_stor_is_valid(int type, struct blk_desc *dd)
  243. {
  244. int i;
  245. for (i = 0; i < specs[type].max_dev; i++)
  246. if (dd == blk_get_dev(specs[type].name, i))
  247. if (dd->type != DEV_TYPE_UNKNOWN)
  248. return 1;
  249. return 0;
  250. }
  251. int dev_open_stor(void *cookie)
  252. {
  253. int type = dev_stor_type(cookie);
  254. if (type == ENUM_MAX)
  255. return API_ENODEV;
  256. if (dev_stor_is_valid(type, (struct blk_desc *)cookie))
  257. return 0;
  258. return API_ENODEV;
  259. }
  260. int dev_close_stor(void *cookie)
  261. {
  262. /*
  263. * Not much to do as we actually do not alter storage devices upon
  264. * close
  265. */
  266. return 0;
  267. }
  268. lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
  269. {
  270. int type;
  271. struct blk_desc *dd = (struct blk_desc *)cookie;
  272. if ((type = dev_stor_type(dd)) == ENUM_MAX)
  273. return 0;
  274. if (!dev_stor_is_valid(type, dd))
  275. return 0;
  276. #ifdef CONFIG_BLK
  277. return blk_dread(dd, start, len, buf);
  278. #else
  279. if ((dd->block_read) == NULL) {
  280. debugf("no block_read() for device 0x%08x\n", cookie);
  281. return 0;
  282. }
  283. return dd->block_read(dd, start, len, buf);
  284. #endif /* defined(CONFIG_BLK) */
  285. }
  286. lbasize_t dev_write_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
  287. {
  288. struct blk_desc *dd = (struct blk_desc *)cookie;
  289. int type = dev_stor_type(dd);
  290. if (type == ENUM_MAX)
  291. return 0;
  292. if (!dev_stor_is_valid(type, dd))
  293. return 0;
  294. #ifdef CONFIG_BLK
  295. return blk_dwrite(dd, start, len, buf);
  296. #else
  297. if (dd->block_write == NULL) {
  298. debugf("no block_write() for device 0x%08x\n", cookie);
  299. return 0;
  300. }
  301. return dd->block_write(dd, start, len, buf);
  302. #endif /* defined(CONFIG_BLK) */
  303. }