blob: bc2b4d6b8cc76de796d98ecb69e1f581212df6b9 [file] [log] [blame]
Rafal Jaworowski500856e2008-01-09 19:39:36 +01001/*
Stefan Roesef2302d42008-08-06 14:05:38 +02002 * (C) Copyright 2007-2008 Semihalf
Rafal Jaworowski500856e2008-01-09 19:39:36 +01003 *
4 * Written by: Rafal Jaworowski <raj@semihalf.com>
5 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02006 * SPDX-License-Identifier: GPL-2.0+
Rafal Jaworowski500856e2008-01-09 19:39:36 +01007 */
8
9#include <config.h>
Rafal Jaworowski500856e2008-01-09 19:39:36 +010010#include <common.h>
11#include <api_public.h>
12
Matthias Fuchs3d0ea312008-09-24 10:29:37 +020013#if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
14#include <usb.h>
15#endif
16
Rafal Jaworowski500856e2008-01-09 19:39:36 +010017#define DEBUG
18#undef DEBUG
19
20#ifdef DEBUG
21#define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt, ##args); } while (0)
22#else
23#define debugf(fmt, args...)
24#endif
25
26#define errf(fmt, args...) do { printf("ERROR @ %s(): ", __func__); printf(fmt, ##args); } while (0)
27
28
29#define ENUM_IDE 0
30#define ENUM_USB 1
31#define ENUM_SCSI 2
32#define ENUM_MMC 3
Stefan Roesef2302d42008-08-06 14:05:38 +020033#define ENUM_SATA 4
34#define ENUM_MAX 5
Rafal Jaworowski500856e2008-01-09 19:39:36 +010035
36struct stor_spec {
37 int max_dev;
38 int enum_started;
39 int enum_ended;
40 int type; /* "external" type: DT_STOR_{IDE,USB,etc} */
Stefan Roesef2302d42008-08-06 14:05:38 +020041 char *name;
Rafal Jaworowski500856e2008-01-09 19:39:36 +010042};
43
44static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, "" }, };
45
46
47void dev_stor_init(void)
48{
Jean-Christophe PLAGNIOL-VILLARD1b769882008-01-25 07:54:47 +010049#if defined(CONFIG_CMD_IDE)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020050 specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE;
Rafal Jaworowski500856e2008-01-09 19:39:36 +010051 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";
55#endif
Stefan Roesef2302d42008-08-06 14:05:38 +020056#if defined(CONFIG_CMD_MMC)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020057 specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE;
Stefan Roesef2302d42008-08-06 14:05:38 +020058 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";
62#endif
63#if defined(CONFIG_CMD_SATA)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020064 specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE;
Stefan Roesef2302d42008-08-06 14:05:38 +020065 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";
Rafal Jaworowski500856e2008-01-09 19:39:36 +010069#endif
Jean-Christophe PLAGNIOL-VILLARD1b769882008-01-25 07:54:47 +010070#if defined(CONFIG_CMD_SCSI)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020071 specs[ENUM_SCSI].max_dev = CONFIG_SYS_SCSI_MAX_DEVICE;
Rafal Jaworowski500856e2008-01-09 19:39:36 +010072 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";
76#endif
Stefan Roesef2302d42008-08-06 14:05:38 +020077#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";
83#endif
Rafal Jaworowski500856e2008-01-09 19:39:36 +010084}
85
86/*
87 * Finds next available device in the storage group
88 *
89 * type: storage group type - ENUM_IDE, ENUM_SCSI etc.
90 *
91 * first: if 1 the first device in the storage group is returned (if
92 * exists), if 0 the next available device is searched
93 *
94 * more: returns 0/1 depending if there are more devices in this group
95 * available (for future iterations)
96 *
97 * returns: 0/1 depending if device found in this iteration
98 */
99static int dev_stor_get(int type, int first, int *more, struct device_info *di)
100{
101 int found = 0;
102 *more = 0;
103
104 int i;
105
106 block_dev_desc_t *dd;
107
108 if (first) {
109 di->cookie = (void *)get_dev(specs[type].name, 0);
Stefan Roesef2302d42008-08-06 14:05:38 +0200110 if (di->cookie == NULL)
111 return 0;
112 else
113 found = 1;
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100114
Andreas Färberce2a07b2015-09-14 12:21:34 +0200115 /* provide hint if there are more devices in
116 * this group to enumerate */
117 if (1 < specs[type].max_dev)
118 *more = 1;
119
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100120 } else {
121 for (i = 0; i < specs[type].max_dev; i++)
122 if (di->cookie == (void *)get_dev(specs[type].name, i)) {
123 /* previous cookie found -- advance to the
124 * next device, if possible */
125
126 if (++i >= specs[type].max_dev) {
127 /* out of range, no more to enum */
128 di->cookie = NULL;
129 break;
130 }
131
132 di->cookie = (void *)get_dev(specs[type].name, i);
Stefan Roesef2302d42008-08-06 14:05:38 +0200133 if (di->cookie == NULL)
134 return 0;
135 else
136 found = 1;
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100137
138 /* provide hint if there are more devices in
139 * this group to enumerate */
140 if ((i + 1) < specs[type].max_dev)
141 *more = 1;
142
143 break;
144 }
145 }
146
147 if (found) {
148 di->type = specs[type].type;
149
150 if (di->cookie != NULL) {
151 dd = (block_dev_desc_t *)di->cookie;
152 if (dd->type == DEV_TYPE_UNKNOWN) {
153 debugf("device instance exists, but is not active..");
154 found = 0;
155 } else {
156 di->di_stor.block_count = dd->lba;
157 di->di_stor.block_size = dd->blksz;
158 }
159 }
160
161 } else
162 di->cookie = NULL;
163
164 return found;
165}
166
167
168/*
169 * returns: ENUM_IDE, ENUM_USB etc. based on block_dev_desc_t
170 */
171static int dev_stor_type(block_dev_desc_t *dd)
172{
173 int i, j;
174
175 for (i = ENUM_IDE; i < ENUM_MAX; i++)
176 for (j = 0; j < specs[i].max_dev; j++)
177 if (dd == get_dev(specs[i].name, j))
178 return i;
179
180 return ENUM_MAX;
181}
182
183
184/*
185 * returns: 0/1 whether cookie points to some device in this group
186 */
187static int dev_is_stor(int type, struct device_info *di)
188{
189 return (dev_stor_type(di->cookie) == type) ? 1 : 0;
190}
191
192
193static int dev_enum_stor(int type, struct device_info *di)
194{
195 int found = 0, more = 0;
196
197 debugf("called, type %d\n", type);
198
199 /*
200 * Formulae for enumerating storage devices:
201 * 1. if cookie (hint from previous enum call) is NULL we start again
202 * with enumeration, so return the first available device, done.
203 *
204 * 2. if cookie is not NULL, check if it identifies some device in
205 * this group:
206 *
207 * 2a. if cookie is a storage device from our group (IDE, USB etc.),
208 * return next available (if exists) in this group
209 *
210 * 2b. if it isn't device from our group, check if such devices were
211 * ever enumerated before:
212 * - if not, return the first available device from this group
213 * - else return 0
214 */
215
216 if (di->cookie == NULL) {
217
218 debugf("group%d - enum restart\n", type);
219
220 /*
221 * 1. Enumeration (re-)started: take the first available
222 * device, if exists
223 */
224 found = dev_stor_get(type, 1, &more, di);
225 specs[type].enum_started = 1;
226
227 } else if (dev_is_stor(type, di)) {
228
229 debugf("group%d - enum continued for the next device\n", type);
230
231 if (specs[type].enum_ended) {
232 debugf("group%d - nothing more to enum!\n", type);
233 return 0;
234 }
235
236 /* 2a. Attempt to take a next available device in the group */
237 found = dev_stor_get(type, 0, &more, di);
238
239 } else {
240
241 if (specs[type].enum_ended) {
242 debugf("group %d - already enumerated, skipping\n", type);
243 return 0;
244 }
245
246 debugf("group%d - first time enum\n", type);
247
248 if (specs[type].enum_started == 0) {
249 /*
250 * 2b. If enumerating devices in this group did not
251 * happen before, it means the cookie pointed to a
252 * device frome some other group (another storage
253 * group, or network); in this case try to take the
254 * first available device from our group
255 */
256 specs[type].enum_started = 1;
257
258 /*
259 * Attempt to take the first device in this group:
260 *'first element' flag is set
261 */
262 found = dev_stor_get(type, 1, &more, di);
263
264 } else {
265 errf("group%d - out of order iteration\n", type);
266 found = 0;
267 more = 0;
268 }
269 }
270
271 /*
272 * If there are no more devices in this group, consider its
273 * enumeration finished
274 */
275 specs[type].enum_ended = (!more) ? 1 : 0;
276
277 if (found)
278 debugf("device found, returning cookie 0x%08x\n",
279 (u_int32_t)di->cookie);
280 else
281 debugf("no device found\n");
282
283 return found;
284}
285
286void dev_enum_reset(void)
287{
288 int i;
289
290 for (i = 0; i < ENUM_MAX; i ++) {
291 specs[i].enum_started = 0;
292 specs[i].enum_ended = 0;
293 }
294}
295
296int dev_enum_storage(struct device_info *di)
297{
298 int i;
299
300 /*
301 * check: ide, usb, scsi, mmc
302 */
303 for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
304 if (dev_enum_stor(i, di))
305 return 1;
306 }
307
308 return 0;
309}
310
311static int dev_stor_is_valid(int type, block_dev_desc_t *dd)
312{
313 int i;
314
315 for (i = 0; i < specs[type].max_dev; i++)
316 if (dd == get_dev(specs[type].name, i))
317 if (dd->type != DEV_TYPE_UNKNOWN)
318 return 1;
319
320 return 0;
321}
322
323
324int dev_open_stor(void *cookie)
325{
326 int type = dev_stor_type(cookie);
327
328 if (type == ENUM_MAX)
329 return API_ENODEV;
330
331 if (dev_stor_is_valid(type, (block_dev_desc_t *)cookie))
332 return 0;
333
334 return API_ENODEV;
335}
336
337
338int dev_close_stor(void *cookie)
339{
340 /*
341 * Not much to do as we actually do not alter storage devices upon
342 * close
343 */
344 return 0;
345}
346
347
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100348lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
349{
350 int type;
351 block_dev_desc_t *dd = (block_dev_desc_t *)cookie;
352
353 if ((type = dev_stor_type(dd)) == ENUM_MAX)
354 return 0;
355
356 if (!dev_stor_is_valid(type, dd))
357 return 0;
358
359 if ((dd->block_read) == NULL) {
Stefan Roesef2302d42008-08-06 14:05:38 +0200360 debugf("no block_read() for device 0x%08x\n", cookie);
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100361 return 0;
362 }
363
Stephen Warren7c4213f2015-12-07 11:38:48 -0700364 return dd->block_read(dd, start, len, buf);
Rafal Jaworowski500856e2008-01-09 19:39:36 +0100365}