api_storage.c 8.8 KB

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