api_storage.c 7.5 KB

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