1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2007-2008 Semihalf
5 * Written by: Rafal Jaworowski <raj@semihalf.com>
10 #include <api_public.h>
14 #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
22 #define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt, ##args); } while (0)
24 #define debugf(fmt, args...)
27 #define errf(fmt, args...) do { printf("ERROR @ %s(): ", __func__); printf(fmt, ##args); } while (0)
41 int type; /* "external" type: DT_STOR_{IDE,USB,etc} */
45 static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, };
47 void dev_stor_init(void)
49 #if defined(CONFIG_IDE)
50 specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE;
51 specs[ENUM_IDE].enum_started = 0;
52 specs[ENUM_IDE].enum_ended = 0;
53 specs[ENUM_IDE].type = DEV_TYP_STOR | DT_STOR_IDE;
54 specs[ENUM_IDE].name = "ide";
56 #if defined(CONFIG_CMD_MMC)
57 specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE;
58 specs[ENUM_MMC].enum_started = 0;
59 specs[ENUM_MMC].enum_ended = 0;
60 specs[ENUM_MMC].type = DEV_TYP_STOR | DT_STOR_MMC;
61 specs[ENUM_MMC].name = "mmc";
63 #if defined(CONFIG_SATA)
64 specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE;
65 specs[ENUM_SATA].enum_started = 0;
66 specs[ENUM_SATA].enum_ended = 0;
67 specs[ENUM_SATA].type = DEV_TYP_STOR | DT_STOR_SATA;
68 specs[ENUM_SATA].name = "sata";
70 #if defined(CONFIG_SCSI)
71 specs[ENUM_SCSI].max_dev = SCSI_MAX_DEVICE;
72 specs[ENUM_SCSI].enum_started = 0;
73 specs[ENUM_SCSI].enum_ended = 0;
74 specs[ENUM_SCSI].type = DEV_TYP_STOR | DT_STOR_SCSI;
75 specs[ENUM_SCSI].name = "scsi";
77 #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
78 specs[ENUM_USB].max_dev = USB_MAX_STOR_DEV;
79 specs[ENUM_USB].enum_started = 0;
80 specs[ENUM_USB].enum_ended = 0;
81 specs[ENUM_USB].type = DEV_TYP_STOR | DT_STOR_USB;
82 specs[ENUM_USB].name = "usb";
87 * Finds next available device in the storage group
89 * type: storage group type - ENUM_IDE, ENUM_SCSI etc.
91 * more: returns 0/1 depending if there are more devices in this group
92 * available (for future iterations)
94 * returns: 0/1 depending if device found in this iteration
96 static int dev_stor_get(int type, int *more, struct device_info *di)
103 /* Wasn't configured for this type, return 0 directly */
104 if (specs[type].name == NULL)
107 if (di->cookie != NULL) {
108 /* Find the last device we've returned */
109 for (i = 0; i < specs[type].max_dev; i++) {
111 (void *)blk_get_dev(specs[type].name, i)) {
122 for (; i < specs[type].max_dev; i++) {
123 di->cookie = (void *)blk_get_dev(specs[type].name, i);
125 if (di->cookie != NULL) {
131 if (i == specs[type].max_dev)
137 di->type = specs[type].type;
139 dd = (struct blk_desc *)di->cookie;
140 if (dd->type == DEV_TYPE_UNKNOWN) {
141 debugf("device instance exists, but is not active..");
144 di->di_stor.block_count = dd->lba;
145 di->di_stor.block_size = dd->blksz;
155 /* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */
157 static int dev_stor_type(struct blk_desc *dd)
161 for (i = ENUM_IDE; i < ENUM_MAX; i++)
162 for (j = 0; j < specs[i].max_dev; j++)
163 if (dd == blk_get_dev(specs[i].name, j))
170 /* returns: 0/1 whether cookie points to some device in this group */
172 static int dev_is_stor(int type, struct device_info *di)
174 return (dev_stor_type(di->cookie) == type) ? 1 : 0;
178 static int dev_enum_stor(int type, struct device_info *di)
180 int found = 0, more = 0;
182 debugf("called, type %d\n", type);
185 * Formulae for enumerating storage devices:
186 * 1. if cookie (hint from previous enum call) is NULL we start again
187 * with enumeration, so return the first available device, done.
189 * 2. if cookie is not NULL, check if it identifies some device in
192 * 2a. if cookie is a storage device from our group (IDE, USB etc.),
193 * return next available (if exists) in this group
195 * 2b. if it isn't device from our group, check if such devices were
196 * ever enumerated before:
197 * - if not, return the first available device from this group
201 if (di->cookie == NULL) {
202 debugf("group%d - enum restart\n", type);
205 * 1. Enumeration (re-)started: take the first available
208 found = dev_stor_get(type, &more, di);
209 specs[type].enum_started = 1;
211 } else if (dev_is_stor(type, di)) {
212 debugf("group%d - enum continued for the next device\n", type);
214 if (specs[type].enum_ended) {
215 debugf("group%d - nothing more to enum!\n", type);
219 /* 2a. Attempt to take a next available device in the group */
220 found = dev_stor_get(type, &more, di);
223 if (specs[type].enum_ended) {
224 debugf("group %d - already enumerated, skipping\n", type);
228 debugf("group%d - first time enum\n", type);
230 if (specs[type].enum_started == 0) {
232 * 2b. If enumerating devices in this group did not
233 * happen before, it means the cookie pointed to a
234 * device from some other group (another storage
235 * group, or network); in this case try to take the
236 * first available device from our group
238 specs[type].enum_started = 1;
241 * Attempt to take the first device in this group:
242 *'first element' flag is set
244 found = dev_stor_get(type, &more, di);
247 errf("group%d - out of order iteration\n", type);
254 * If there are no more devices in this group, consider its
255 * enumeration finished
257 specs[type].enum_ended = (!more) ? 1 : 0;
260 debugf("device found, returning cookie 0x%08x\n",
261 (u_int32_t)di->cookie);
263 debugf("no device found\n");
268 void dev_enum_reset(void)
272 for (i = 0; i < ENUM_MAX; i ++) {
273 specs[i].enum_started = 0;
274 specs[i].enum_ended = 0;
278 int dev_enum_storage(struct device_info *di)
282 /* check: ide, usb, scsi, mmc */
283 for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
284 if (dev_enum_stor(i, di))
291 static int dev_stor_is_valid(int type, struct blk_desc *dd)
295 for (i = 0; i < specs[type].max_dev; i++)
296 if (dd == blk_get_dev(specs[type].name, i))
297 if (dd->type != DEV_TYPE_UNKNOWN)
304 int dev_open_stor(void *cookie)
306 int type = dev_stor_type(cookie);
308 if (type == ENUM_MAX)
311 if (dev_stor_is_valid(type, (struct blk_desc *)cookie))
318 int dev_close_stor(void *cookie)
321 * Not much to do as we actually do not alter storage devices upon
328 lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
331 struct blk_desc *dd = (struct blk_desc *)cookie;
333 if ((type = dev_stor_type(dd)) == ENUM_MAX)
336 if (!dev_stor_is_valid(type, dd))
340 return blk_dread(dd, start, len, buf);
342 if ((dd->block_read) == NULL) {
343 debugf("no block_read() for device 0x%08x\n", cookie);
347 return dd->block_read(dd, start, len, buf);
348 #endif /* defined(CONFIG_BLK) */
352 lbasize_t dev_write_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
354 struct blk_desc *dd = (struct blk_desc *)cookie;
355 int type = dev_stor_type(dd);
357 if (type == ENUM_MAX)
360 if (!dev_stor_is_valid(type, dd))
364 return blk_dwrite(dd, start, len, buf);
366 if (dd->block_write == NULL) {
367 debugf("no block_write() for device 0x%08x\n", cookie);
371 return dd->block_write(dd, start, len, buf);
372 #endif /* defined(CONFIG_BLK) */