api_storage.c 8.1 KB

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