api_storage.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  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, "" }, };
  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_CMD_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. * first: if 1 the first device in the storage group is returned (if
  80. * exists), if 0 the next available device is searched
  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 first, int *more, struct device_info *di)
  88. {
  89. int found = 0;
  90. *more = 0;
  91. int i;
  92. block_dev_desc_t *dd;
  93. if (first) {
  94. di->cookie = (void *)get_dev(specs[type].name, 0);
  95. if (di->cookie == NULL)
  96. return 0;
  97. else
  98. found = 1;
  99. /* provide hint if there are more devices in
  100. * this group to enumerate */
  101. if (1 < specs[type].max_dev)
  102. *more = 1;
  103. } else {
  104. for (i = 0; i < specs[type].max_dev; i++)
  105. if (di->cookie == (void *)get_dev(specs[type].name, i)) {
  106. /* previous cookie found -- advance to the
  107. * next device, if possible */
  108. if (++i >= specs[type].max_dev) {
  109. /* out of range, no more to enum */
  110. di->cookie = NULL;
  111. break;
  112. }
  113. di->cookie = (void *)get_dev(specs[type].name, i);
  114. if (di->cookie == NULL)
  115. return 0;
  116. else
  117. found = 1;
  118. /* provide hint if there are more devices in
  119. * this group to enumerate */
  120. if ((i + 1) < specs[type].max_dev)
  121. *more = 1;
  122. break;
  123. }
  124. }
  125. if (found) {
  126. di->type = specs[type].type;
  127. if (di->cookie != NULL) {
  128. dd = (block_dev_desc_t *)di->cookie;
  129. if (dd->type == DEV_TYPE_UNKNOWN) {
  130. debugf("device instance exists, but is not active..");
  131. found = 0;
  132. } else {
  133. di->di_stor.block_count = dd->lba;
  134. di->di_stor.block_size = dd->blksz;
  135. }
  136. }
  137. } else
  138. di->cookie = NULL;
  139. return found;
  140. }
  141. /*
  142. * returns: ENUM_IDE, ENUM_USB etc. based on block_dev_desc_t
  143. */
  144. static int dev_stor_type(block_dev_desc_t *dd)
  145. {
  146. int i, j;
  147. for (i = ENUM_IDE; i < ENUM_MAX; i++)
  148. for (j = 0; j < specs[i].max_dev; j++)
  149. if (dd == get_dev(specs[i].name, j))
  150. return i;
  151. return ENUM_MAX;
  152. }
  153. /*
  154. * returns: 0/1 whether cookie points to some device in this group
  155. */
  156. static int dev_is_stor(int type, struct device_info *di)
  157. {
  158. return (dev_stor_type(di->cookie) == type) ? 1 : 0;
  159. }
  160. static int dev_enum_stor(int type, struct device_info *di)
  161. {
  162. int found = 0, more = 0;
  163. debugf("called, type %d\n", type);
  164. /*
  165. * Formulae for enumerating storage devices:
  166. * 1. if cookie (hint from previous enum call) is NULL we start again
  167. * with enumeration, so return the first available device, done.
  168. *
  169. * 2. if cookie is not NULL, check if it identifies some device in
  170. * this group:
  171. *
  172. * 2a. if cookie is a storage device from our group (IDE, USB etc.),
  173. * return next available (if exists) in this group
  174. *
  175. * 2b. if it isn't device from our group, check if such devices were
  176. * ever enumerated before:
  177. * - if not, return the first available device from this group
  178. * - else return 0
  179. */
  180. if (di->cookie == NULL) {
  181. debugf("group%d - enum restart\n", type);
  182. /*
  183. * 1. Enumeration (re-)started: take the first available
  184. * device, if exists
  185. */
  186. found = dev_stor_get(type, 1, &more, di);
  187. specs[type].enum_started = 1;
  188. } else if (dev_is_stor(type, di)) {
  189. debugf("group%d - enum continued for the next device\n", type);
  190. if (specs[type].enum_ended) {
  191. debugf("group%d - nothing more to enum!\n", type);
  192. return 0;
  193. }
  194. /* 2a. Attempt to take a next available device in the group */
  195. found = dev_stor_get(type, 0, &more, di);
  196. } else {
  197. if (specs[type].enum_ended) {
  198. debugf("group %d - already enumerated, skipping\n", type);
  199. return 0;
  200. }
  201. debugf("group%d - first time enum\n", type);
  202. if (specs[type].enum_started == 0) {
  203. /*
  204. * 2b. If enumerating devices in this group did not
  205. * happen before, it means the cookie pointed to a
  206. * device frome some other group (another storage
  207. * group, or network); in this case try to take the
  208. * first available device from our group
  209. */
  210. specs[type].enum_started = 1;
  211. /*
  212. * Attempt to take the first device in this group:
  213. *'first element' flag is set
  214. */
  215. found = dev_stor_get(type, 1, &more, di);
  216. } else {
  217. errf("group%d - out of order iteration\n", type);
  218. found = 0;
  219. more = 0;
  220. }
  221. }
  222. /*
  223. * If there are no more devices in this group, consider its
  224. * enumeration finished
  225. */
  226. specs[type].enum_ended = (!more) ? 1 : 0;
  227. if (found)
  228. debugf("device found, returning cookie 0x%08x\n",
  229. (u_int32_t)di->cookie);
  230. else
  231. debugf("no device found\n");
  232. return found;
  233. }
  234. void dev_enum_reset(void)
  235. {
  236. int i;
  237. for (i = 0; i < ENUM_MAX; i ++) {
  238. specs[i].enum_started = 0;
  239. specs[i].enum_ended = 0;
  240. }
  241. }
  242. int dev_enum_storage(struct device_info *di)
  243. {
  244. int i;
  245. /*
  246. * check: ide, usb, scsi, mmc
  247. */
  248. for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
  249. if (dev_enum_stor(i, di))
  250. return 1;
  251. }
  252. return 0;
  253. }
  254. static int dev_stor_is_valid(int type, block_dev_desc_t *dd)
  255. {
  256. int i;
  257. for (i = 0; i < specs[type].max_dev; i++)
  258. if (dd == get_dev(specs[type].name, i))
  259. if (dd->type != DEV_TYPE_UNKNOWN)
  260. return 1;
  261. return 0;
  262. }
  263. int dev_open_stor(void *cookie)
  264. {
  265. int type = dev_stor_type(cookie);
  266. if (type == ENUM_MAX)
  267. return API_ENODEV;
  268. if (dev_stor_is_valid(type, (block_dev_desc_t *)cookie))
  269. return 0;
  270. return API_ENODEV;
  271. }
  272. int dev_close_stor(void *cookie)
  273. {
  274. /*
  275. * Not much to do as we actually do not alter storage devices upon
  276. * close
  277. */
  278. return 0;
  279. }
  280. lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
  281. {
  282. int type;
  283. block_dev_desc_t *dd = (block_dev_desc_t *)cookie;
  284. if ((type = dev_stor_type(dd)) == ENUM_MAX)
  285. return 0;
  286. if (!dev_stor_is_valid(type, dd))
  287. return 0;
  288. if ((dd->block_read) == NULL) {
  289. debugf("no block_read() for device 0x%08x\n", cookie);
  290. return 0;
  291. }
  292. return dd->block_read(dd, start, len, buf);
  293. }