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