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