1 /* 2 * (C) Copyright 2007-2008 Semihalf 3 * 4 * Written by: Rafal Jaworowski <raj@semihalf.com> 5 * 6 * SPDX-License-Identifier: GPL-2.0+ 7 */ 8 9 #include <config.h> 10 #include <common.h> 11 #include <api_public.h> 12 13 #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE) 14 #include <usb.h> 15 #endif 16 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 33 #define ENUM_SATA 4 34 #define ENUM_MAX 5 35 36 struct stor_spec { 37 int max_dev; 38 int enum_started; 39 int enum_ended; 40 int type; /* "external" type: DT_STOR_{IDE,USB,etc} */ 41 char *name; 42 }; 43 44 static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, }; 45 46 47 void dev_stor_init(void) 48 { 49 #if defined(CONFIG_CMD_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"; 55 #endif 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"; 62 #endif 63 #if defined(CONFIG_CMD_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"; 69 #endif 70 #if defined(CONFIG_SCSI) 71 specs[ENUM_SCSI].max_dev = CONFIG_SYS_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"; 76 #endif 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"; 83 #endif 84 } 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 */ 99 static 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 struct blk_desc *dd; 107 108 /* Wasn't configured for this type, return 0 directly */ 109 if (specs[type].name == NULL) 110 return 0; 111 112 if (first) { 113 di->cookie = (void *)blk_get_dev(specs[type].name, 0); 114 if (di->cookie == NULL) 115 return 0; 116 else 117 found = 1; 118 119 /* provide hint if there are more devices in 120 * this group to enumerate */ 121 if (1 < specs[type].max_dev) 122 *more = 1; 123 124 } else { 125 for (i = 0; i < specs[type].max_dev; i++) 126 if (di->cookie == 127 (void *)blk_get_dev(specs[type].name, i)) { 128 /* previous cookie found -- advance to the 129 * next device, if possible */ 130 131 if (++i >= specs[type].max_dev) { 132 /* out of range, no more to enum */ 133 di->cookie = NULL; 134 break; 135 } 136 137 di->cookie = (void *)blk_get_dev( 138 specs[type].name, i); 139 if (di->cookie == NULL) 140 return 0; 141 else 142 found = 1; 143 144 /* provide hint if there are more devices in 145 * this group to enumerate */ 146 if ((i + 1) < specs[type].max_dev) 147 *more = 1; 148 149 break; 150 } 151 } 152 153 if (found) { 154 di->type = specs[type].type; 155 156 if (di->cookie != NULL) { 157 dd = (struct blk_desc *)di->cookie; 158 if (dd->type == DEV_TYPE_UNKNOWN) { 159 debugf("device instance exists, but is not active.."); 160 found = 0; 161 } else { 162 di->di_stor.block_count = dd->lba; 163 di->di_stor.block_size = dd->blksz; 164 } 165 } 166 167 } else 168 di->cookie = NULL; 169 170 return found; 171 } 172 173 174 /* 175 * returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc 176 */ 177 static int dev_stor_type(struct blk_desc *dd) 178 { 179 int i, j; 180 181 for (i = ENUM_IDE; i < ENUM_MAX; i++) 182 for (j = 0; j < specs[i].max_dev; j++) 183 if (dd == blk_get_dev(specs[i].name, j)) 184 return i; 185 186 return ENUM_MAX; 187 } 188 189 190 /* 191 * returns: 0/1 whether cookie points to some device in this group 192 */ 193 static int dev_is_stor(int type, struct device_info *di) 194 { 195 return (dev_stor_type(di->cookie) == type) ? 1 : 0; 196 } 197 198 199 static int dev_enum_stor(int type, struct device_info *di) 200 { 201 int found = 0, more = 0; 202 203 debugf("called, type %d\n", type); 204 205 /* 206 * Formulae for enumerating storage devices: 207 * 1. if cookie (hint from previous enum call) is NULL we start again 208 * with enumeration, so return the first available device, done. 209 * 210 * 2. if cookie is not NULL, check if it identifies some device in 211 * this group: 212 * 213 * 2a. if cookie is a storage device from our group (IDE, USB etc.), 214 * return next available (if exists) in this group 215 * 216 * 2b. if it isn't device from our group, check if such devices were 217 * ever enumerated before: 218 * - if not, return the first available device from this group 219 * - else return 0 220 */ 221 222 if (di->cookie == NULL) { 223 224 debugf("group%d - enum restart\n", type); 225 226 /* 227 * 1. Enumeration (re-)started: take the first available 228 * device, if exists 229 */ 230 found = dev_stor_get(type, 1, &more, di); 231 specs[type].enum_started = 1; 232 233 } else if (dev_is_stor(type, di)) { 234 235 debugf("group%d - enum continued for the next device\n", type); 236 237 if (specs[type].enum_ended) { 238 debugf("group%d - nothing more to enum!\n", type); 239 return 0; 240 } 241 242 /* 2a. Attempt to take a next available device in the group */ 243 found = dev_stor_get(type, 0, &more, di); 244 245 } else { 246 247 if (specs[type].enum_ended) { 248 debugf("group %d - already enumerated, skipping\n", type); 249 return 0; 250 } 251 252 debugf("group%d - first time enum\n", type); 253 254 if (specs[type].enum_started == 0) { 255 /* 256 * 2b. If enumerating devices in this group did not 257 * happen before, it means the cookie pointed to a 258 * device frome some other group (another storage 259 * group, or network); in this case try to take the 260 * first available device from our group 261 */ 262 specs[type].enum_started = 1; 263 264 /* 265 * Attempt to take the first device in this group: 266 *'first element' flag is set 267 */ 268 found = dev_stor_get(type, 1, &more, di); 269 270 } else { 271 errf("group%d - out of order iteration\n", type); 272 found = 0; 273 more = 0; 274 } 275 } 276 277 /* 278 * If there are no more devices in this group, consider its 279 * enumeration finished 280 */ 281 specs[type].enum_ended = (!more) ? 1 : 0; 282 283 if (found) 284 debugf("device found, returning cookie 0x%08x\n", 285 (u_int32_t)di->cookie); 286 else 287 debugf("no device found\n"); 288 289 return found; 290 } 291 292 void dev_enum_reset(void) 293 { 294 int i; 295 296 for (i = 0; i < ENUM_MAX; i ++) { 297 specs[i].enum_started = 0; 298 specs[i].enum_ended = 0; 299 } 300 } 301 302 int dev_enum_storage(struct device_info *di) 303 { 304 int i; 305 306 /* 307 * check: ide, usb, scsi, mmc 308 */ 309 for (i = ENUM_IDE; i < ENUM_MAX; i ++) { 310 if (dev_enum_stor(i, di)) 311 return 1; 312 } 313 314 return 0; 315 } 316 317 static int dev_stor_is_valid(int type, struct blk_desc *dd) 318 { 319 int i; 320 321 for (i = 0; i < specs[type].max_dev; i++) 322 if (dd == blk_get_dev(specs[type].name, i)) 323 if (dd->type != DEV_TYPE_UNKNOWN) 324 return 1; 325 326 return 0; 327 } 328 329 330 int dev_open_stor(void *cookie) 331 { 332 int type = dev_stor_type(cookie); 333 334 if (type == ENUM_MAX) 335 return API_ENODEV; 336 337 if (dev_stor_is_valid(type, (struct blk_desc *)cookie)) 338 return 0; 339 340 return API_ENODEV; 341 } 342 343 344 int dev_close_stor(void *cookie) 345 { 346 /* 347 * Not much to do as we actually do not alter storage devices upon 348 * close 349 */ 350 return 0; 351 } 352 353 354 lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start) 355 { 356 int type; 357 struct blk_desc *dd = (struct blk_desc *)cookie; 358 359 if ((type = dev_stor_type(dd)) == ENUM_MAX) 360 return 0; 361 362 if (!dev_stor_is_valid(type, dd)) 363 return 0; 364 365 if ((dd->block_read) == NULL) { 366 debugf("no block_read() for device 0x%08x\n", cookie); 367 return 0; 368 } 369 370 return dd->block_read(dd, start, len, buf); 371 } 372