api_storage.c 8.1 KB

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