1500856ebSRafal Jaworowski /* 2f2302d44SStefan Roese * (C) Copyright 2007-2008 Semihalf 3500856ebSRafal Jaworowski * 4500856ebSRafal Jaworowski * Written by: Rafal Jaworowski <raj@semihalf.com> 5500856ebSRafal Jaworowski * 61a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 7500856ebSRafal Jaworowski */ 8500856ebSRafal Jaworowski 9500856ebSRafal Jaworowski #include <config.h> 10500856ebSRafal Jaworowski #include <common.h> 11500856ebSRafal Jaworowski #include <api_public.h> 12500856ebSRafal Jaworowski 133d0ea311SMatthias Fuchs #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE) 143d0ea311SMatthias Fuchs #include <usb.h> 153d0ea311SMatthias Fuchs #endif 163d0ea311SMatthias Fuchs 17500856ebSRafal Jaworowski #define DEBUG 18500856ebSRafal Jaworowski #undef DEBUG 19500856ebSRafal Jaworowski 20500856ebSRafal Jaworowski #ifdef DEBUG 21500856ebSRafal Jaworowski #define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt, ##args); } while (0) 22500856ebSRafal Jaworowski #else 23500856ebSRafal Jaworowski #define debugf(fmt, args...) 24500856ebSRafal Jaworowski #endif 25500856ebSRafal Jaworowski 26500856ebSRafal Jaworowski #define errf(fmt, args...) do { printf("ERROR @ %s(): ", __func__); printf(fmt, ##args); } while (0) 27500856ebSRafal Jaworowski 28500856ebSRafal Jaworowski 29500856ebSRafal Jaworowski #define ENUM_IDE 0 30500856ebSRafal Jaworowski #define ENUM_USB 1 31500856ebSRafal Jaworowski #define ENUM_SCSI 2 32500856ebSRafal Jaworowski #define ENUM_MMC 3 33f2302d44SStefan Roese #define ENUM_SATA 4 34f2302d44SStefan Roese #define ENUM_MAX 5 35500856ebSRafal Jaworowski 36500856ebSRafal Jaworowski struct stor_spec { 37500856ebSRafal Jaworowski int max_dev; 38500856ebSRafal Jaworowski int enum_started; 39500856ebSRafal Jaworowski int enum_ended; 40500856ebSRafal Jaworowski int type; /* "external" type: DT_STOR_{IDE,USB,etc} */ 41f2302d44SStefan Roese char *name; 42500856ebSRafal Jaworowski }; 43500856ebSRafal Jaworowski 445d81c6dfSEmmanuel Vadot static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, }; 45500856ebSRafal Jaworowski 46500856ebSRafal Jaworowski 47500856ebSRafal Jaworowski void dev_stor_init(void) 48500856ebSRafal Jaworowski { 491b769881SJean-Christophe PLAGNIOL-VILLARD #if defined(CONFIG_CMD_IDE) 506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE; 51500856ebSRafal Jaworowski specs[ENUM_IDE].enum_started = 0; 52500856ebSRafal Jaworowski specs[ENUM_IDE].enum_ended = 0; 53500856ebSRafal Jaworowski specs[ENUM_IDE].type = DEV_TYP_STOR | DT_STOR_IDE; 54500856ebSRafal Jaworowski specs[ENUM_IDE].name = "ide"; 55500856ebSRafal Jaworowski #endif 56f2302d44SStefan Roese #if defined(CONFIG_CMD_MMC) 576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE; 58f2302d44SStefan Roese specs[ENUM_MMC].enum_started = 0; 59f2302d44SStefan Roese specs[ENUM_MMC].enum_ended = 0; 60f2302d44SStefan Roese specs[ENUM_MMC].type = DEV_TYP_STOR | DT_STOR_MMC; 61f2302d44SStefan Roese specs[ENUM_MMC].name = "mmc"; 62f2302d44SStefan Roese #endif 63f2302d44SStefan Roese #if defined(CONFIG_CMD_SATA) 646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE; 65f2302d44SStefan Roese specs[ENUM_SATA].enum_started = 0; 66f2302d44SStefan Roese specs[ENUM_SATA].enum_ended = 0; 67f2302d44SStefan Roese specs[ENUM_SATA].type = DEV_TYP_STOR | DT_STOR_SATA; 68f2302d44SStefan Roese specs[ENUM_SATA].name = "sata"; 69500856ebSRafal Jaworowski #endif 70c649e3c9SSimon Glass #if defined(CONFIG_SCSI) 716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD specs[ENUM_SCSI].max_dev = CONFIG_SYS_SCSI_MAX_DEVICE; 72500856ebSRafal Jaworowski specs[ENUM_SCSI].enum_started = 0; 73500856ebSRafal Jaworowski specs[ENUM_SCSI].enum_ended = 0; 74500856ebSRafal Jaworowski specs[ENUM_SCSI].type = DEV_TYP_STOR | DT_STOR_SCSI; 75500856ebSRafal Jaworowski specs[ENUM_SCSI].name = "scsi"; 76500856ebSRafal Jaworowski #endif 77f2302d44SStefan Roese #if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE) 78f2302d44SStefan Roese specs[ENUM_USB].max_dev = USB_MAX_STOR_DEV; 79f2302d44SStefan Roese specs[ENUM_USB].enum_started = 0; 80f2302d44SStefan Roese specs[ENUM_USB].enum_ended = 0; 81f2302d44SStefan Roese specs[ENUM_USB].type = DEV_TYP_STOR | DT_STOR_USB; 82f2302d44SStefan Roese specs[ENUM_USB].name = "usb"; 83f2302d44SStefan Roese #endif 84500856ebSRafal Jaworowski } 85500856ebSRafal Jaworowski 86500856ebSRafal Jaworowski /* 87500856ebSRafal Jaworowski * Finds next available device in the storage group 88500856ebSRafal Jaworowski * 89500856ebSRafal Jaworowski * type: storage group type - ENUM_IDE, ENUM_SCSI etc. 90500856ebSRafal Jaworowski * 91500856ebSRafal Jaworowski * first: if 1 the first device in the storage group is returned (if 92500856ebSRafal Jaworowski * exists), if 0 the next available device is searched 93500856ebSRafal Jaworowski * 94500856ebSRafal Jaworowski * more: returns 0/1 depending if there are more devices in this group 95500856ebSRafal Jaworowski * available (for future iterations) 96500856ebSRafal Jaworowski * 97500856ebSRafal Jaworowski * returns: 0/1 depending if device found in this iteration 98500856ebSRafal Jaworowski */ 99500856ebSRafal Jaworowski static int dev_stor_get(int type, int first, int *more, struct device_info *di) 100500856ebSRafal Jaworowski { 101500856ebSRafal Jaworowski int found = 0; 102500856ebSRafal Jaworowski *more = 0; 103500856ebSRafal Jaworowski 104500856ebSRafal Jaworowski int i; 105500856ebSRafal Jaworowski 1064101f687SSimon Glass struct blk_desc *dd; 107500856ebSRafal Jaworowski 1085d81c6dfSEmmanuel Vadot /* Wasn't configured for this type, return 0 directly */ 1095d81c6dfSEmmanuel Vadot if (specs[type].name == NULL) 1105d81c6dfSEmmanuel Vadot return 0; 1115d81c6dfSEmmanuel Vadot 112500856ebSRafal Jaworowski if (first) { 113db1d9e78SSimon Glass di->cookie = (void *)blk_get_dev(specs[type].name, 0); 114f2302d44SStefan Roese if (di->cookie == NULL) 115f2302d44SStefan Roese return 0; 116f2302d44SStefan Roese else 117500856ebSRafal Jaworowski found = 1; 118500856ebSRafal Jaworowski 119c9db75a0SWalt Feasel /* 120c9db75a0SWalt Feasel * provide hint if there are more devices in 121c9db75a0SWalt Feasel * this group to enumerate 122c9db75a0SWalt Feasel */ 123ce2a07b7SAndreas Färber if (1 < specs[type].max_dev) 124ce2a07b7SAndreas Färber *more = 1; 125ce2a07b7SAndreas Färber 126500856ebSRafal Jaworowski } else { 127500856ebSRafal Jaworowski for (i = 0; i < specs[type].max_dev; i++) 128db1d9e78SSimon Glass if (di->cookie == 129db1d9e78SSimon Glass (void *)blk_get_dev(specs[type].name, i)) { 130c9db75a0SWalt Feasel /* 131c9db75a0SWalt Feasel * previous cookie found -- advance to the 132c9db75a0SWalt Feasel * next device, if possible 133c9db75a0SWalt Feasel */ 134500856ebSRafal Jaworowski 135500856ebSRafal Jaworowski if (++i >= specs[type].max_dev) { 136500856ebSRafal Jaworowski /* out of range, no more to enum */ 137500856ebSRafal Jaworowski di->cookie = NULL; 138500856ebSRafal Jaworowski break; 139500856ebSRafal Jaworowski } 140500856ebSRafal Jaworowski 141db1d9e78SSimon Glass di->cookie = (void *)blk_get_dev( 142db1d9e78SSimon Glass specs[type].name, i); 143f2302d44SStefan Roese if (di->cookie == NULL) 144f2302d44SStefan Roese return 0; 145f2302d44SStefan Roese else 146500856ebSRafal Jaworowski found = 1; 147500856ebSRafal Jaworowski 148c9db75a0SWalt Feasel /* 149c9db75a0SWalt Feasel * provide hint if there are more devices in 150c9db75a0SWalt Feasel * this group to enumerate 151c9db75a0SWalt Feasel */ 152500856ebSRafal Jaworowski if ((i + 1) < specs[type].max_dev) 153500856ebSRafal Jaworowski *more = 1; 154500856ebSRafal Jaworowski 155500856ebSRafal Jaworowski break; 156500856ebSRafal Jaworowski } 157500856ebSRafal Jaworowski } 158500856ebSRafal Jaworowski 159500856ebSRafal Jaworowski if (found) { 160500856ebSRafal Jaworowski di->type = specs[type].type; 161500856ebSRafal Jaworowski 162500856ebSRafal Jaworowski if (di->cookie != NULL) { 1634101f687SSimon Glass dd = (struct blk_desc *)di->cookie; 164500856ebSRafal Jaworowski if (dd->type == DEV_TYPE_UNKNOWN) { 165500856ebSRafal Jaworowski debugf("device instance exists, but is not active.."); 166500856ebSRafal Jaworowski found = 0; 167500856ebSRafal Jaworowski } else { 168500856ebSRafal Jaworowski di->di_stor.block_count = dd->lba; 169500856ebSRafal Jaworowski di->di_stor.block_size = dd->blksz; 170500856ebSRafal Jaworowski } 171500856ebSRafal Jaworowski } 172500856ebSRafal Jaworowski 173500856ebSRafal Jaworowski } else 174500856ebSRafal Jaworowski di->cookie = NULL; 175500856ebSRafal Jaworowski 176500856ebSRafal Jaworowski return found; 177500856ebSRafal Jaworowski } 178500856ebSRafal Jaworowski 179500856ebSRafal Jaworowski 180c9db75a0SWalt Feasel /* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */ 181c9db75a0SWalt Feasel 1824101f687SSimon Glass static int dev_stor_type(struct blk_desc *dd) 183500856ebSRafal Jaworowski { 184500856ebSRafal Jaworowski int i, j; 185500856ebSRafal Jaworowski 186500856ebSRafal Jaworowski for (i = ENUM_IDE; i < ENUM_MAX; i++) 187500856ebSRafal Jaworowski for (j = 0; j < specs[i].max_dev; j++) 188db1d9e78SSimon Glass if (dd == blk_get_dev(specs[i].name, j)) 189500856ebSRafal Jaworowski return i; 190500856ebSRafal Jaworowski 191500856ebSRafal Jaworowski return ENUM_MAX; 192500856ebSRafal Jaworowski } 193500856ebSRafal Jaworowski 194500856ebSRafal Jaworowski 195c9db75a0SWalt Feasel /* returns: 0/1 whether cookie points to some device in this group */ 196c9db75a0SWalt Feasel 197500856ebSRafal Jaworowski static int dev_is_stor(int type, struct device_info *di) 198500856ebSRafal Jaworowski { 199500856ebSRafal Jaworowski return (dev_stor_type(di->cookie) == type) ? 1 : 0; 200500856ebSRafal Jaworowski } 201500856ebSRafal Jaworowski 202500856ebSRafal Jaworowski 203500856ebSRafal Jaworowski static int dev_enum_stor(int type, struct device_info *di) 204500856ebSRafal Jaworowski { 205500856ebSRafal Jaworowski int found = 0, more = 0; 206500856ebSRafal Jaworowski 207500856ebSRafal Jaworowski debugf("called, type %d\n", type); 208500856ebSRafal Jaworowski 209500856ebSRafal Jaworowski /* 210500856ebSRafal Jaworowski * Formulae for enumerating storage devices: 211500856ebSRafal Jaworowski * 1. if cookie (hint from previous enum call) is NULL we start again 212500856ebSRafal Jaworowski * with enumeration, so return the first available device, done. 213500856ebSRafal Jaworowski * 214500856ebSRafal Jaworowski * 2. if cookie is not NULL, check if it identifies some device in 215500856ebSRafal Jaworowski * this group: 216500856ebSRafal Jaworowski * 217500856ebSRafal Jaworowski * 2a. if cookie is a storage device from our group (IDE, USB etc.), 218500856ebSRafal Jaworowski * return next available (if exists) in this group 219500856ebSRafal Jaworowski * 220500856ebSRafal Jaworowski * 2b. if it isn't device from our group, check if such devices were 221500856ebSRafal Jaworowski * ever enumerated before: 222500856ebSRafal Jaworowski * - if not, return the first available device from this group 223500856ebSRafal Jaworowski * - else return 0 224500856ebSRafal Jaworowski */ 225500856ebSRafal Jaworowski 226500856ebSRafal Jaworowski if (di->cookie == NULL) { 227500856ebSRafal Jaworowski debugf("group%d - enum restart\n", type); 228500856ebSRafal Jaworowski 229500856ebSRafal Jaworowski /* 230500856ebSRafal Jaworowski * 1. Enumeration (re-)started: take the first available 231500856ebSRafal Jaworowski * device, if exists 232500856ebSRafal Jaworowski */ 233500856ebSRafal Jaworowski found = dev_stor_get(type, 1, &more, di); 234500856ebSRafal Jaworowski specs[type].enum_started = 1; 235500856ebSRafal Jaworowski 236500856ebSRafal Jaworowski } else if (dev_is_stor(type, di)) { 237500856ebSRafal Jaworowski debugf("group%d - enum continued for the next device\n", type); 238500856ebSRafal Jaworowski 239500856ebSRafal Jaworowski if (specs[type].enum_ended) { 240500856ebSRafal Jaworowski debugf("group%d - nothing more to enum!\n", type); 241500856ebSRafal Jaworowski return 0; 242500856ebSRafal Jaworowski } 243500856ebSRafal Jaworowski 244500856ebSRafal Jaworowski /* 2a. Attempt to take a next available device in the group */ 245500856ebSRafal Jaworowski found = dev_stor_get(type, 0, &more, di); 246500856ebSRafal Jaworowski 247500856ebSRafal Jaworowski } else { 248500856ebSRafal Jaworowski if (specs[type].enum_ended) { 249500856ebSRafal Jaworowski debugf("group %d - already enumerated, skipping\n", type); 250500856ebSRafal Jaworowski return 0; 251500856ebSRafal Jaworowski } 252500856ebSRafal Jaworowski 253500856ebSRafal Jaworowski debugf("group%d - first time enum\n", type); 254500856ebSRafal Jaworowski 255500856ebSRafal Jaworowski if (specs[type].enum_started == 0) { 256500856ebSRafal Jaworowski /* 257500856ebSRafal Jaworowski * 2b. If enumerating devices in this group did not 258500856ebSRafal Jaworowski * happen before, it means the cookie pointed to a 259*83f9ecbeSWalt Feasel * device from some other group (another storage 260500856ebSRafal Jaworowski * group, or network); in this case try to take the 261500856ebSRafal Jaworowski * first available device from our group 262500856ebSRafal Jaworowski */ 263500856ebSRafal Jaworowski specs[type].enum_started = 1; 264500856ebSRafal Jaworowski 265500856ebSRafal Jaworowski /* 266500856ebSRafal Jaworowski * Attempt to take the first device in this group: 267500856ebSRafal Jaworowski *'first element' flag is set 268500856ebSRafal Jaworowski */ 269500856ebSRafal Jaworowski found = dev_stor_get(type, 1, &more, di); 270500856ebSRafal Jaworowski 271500856ebSRafal Jaworowski } else { 272500856ebSRafal Jaworowski errf("group%d - out of order iteration\n", type); 273500856ebSRafal Jaworowski found = 0; 274500856ebSRafal Jaworowski more = 0; 275500856ebSRafal Jaworowski } 276500856ebSRafal Jaworowski } 277500856ebSRafal Jaworowski 278500856ebSRafal Jaworowski /* 279500856ebSRafal Jaworowski * If there are no more devices in this group, consider its 280500856ebSRafal Jaworowski * enumeration finished 281500856ebSRafal Jaworowski */ 282500856ebSRafal Jaworowski specs[type].enum_ended = (!more) ? 1 : 0; 283500856ebSRafal Jaworowski 284500856ebSRafal Jaworowski if (found) 285500856ebSRafal Jaworowski debugf("device found, returning cookie 0x%08x\n", 286500856ebSRafal Jaworowski (u_int32_t)di->cookie); 287500856ebSRafal Jaworowski else 288500856ebSRafal Jaworowski debugf("no device found\n"); 289500856ebSRafal Jaworowski 290500856ebSRafal Jaworowski return found; 291500856ebSRafal Jaworowski } 292500856ebSRafal Jaworowski 293500856ebSRafal Jaworowski void dev_enum_reset(void) 294500856ebSRafal Jaworowski { 295500856ebSRafal Jaworowski int i; 296500856ebSRafal Jaworowski 297500856ebSRafal Jaworowski for (i = 0; i < ENUM_MAX; i ++) { 298500856ebSRafal Jaworowski specs[i].enum_started = 0; 299500856ebSRafal Jaworowski specs[i].enum_ended = 0; 300500856ebSRafal Jaworowski } 301500856ebSRafal Jaworowski } 302500856ebSRafal Jaworowski 303500856ebSRafal Jaworowski int dev_enum_storage(struct device_info *di) 304500856ebSRafal Jaworowski { 305500856ebSRafal Jaworowski int i; 306500856ebSRafal Jaworowski 307c9db75a0SWalt Feasel /* check: ide, usb, scsi, mmc */ 308500856ebSRafal Jaworowski for (i = ENUM_IDE; i < ENUM_MAX; i ++) { 309500856ebSRafal Jaworowski if (dev_enum_stor(i, di)) 310500856ebSRafal Jaworowski return 1; 311500856ebSRafal Jaworowski } 312500856ebSRafal Jaworowski 313500856ebSRafal Jaworowski return 0; 314500856ebSRafal Jaworowski } 315500856ebSRafal Jaworowski 3164101f687SSimon Glass static int dev_stor_is_valid(int type, struct blk_desc *dd) 317500856ebSRafal Jaworowski { 318500856ebSRafal Jaworowski int i; 319500856ebSRafal Jaworowski 320500856ebSRafal Jaworowski for (i = 0; i < specs[type].max_dev; i++) 321db1d9e78SSimon Glass if (dd == blk_get_dev(specs[type].name, i)) 322500856ebSRafal Jaworowski if (dd->type != DEV_TYPE_UNKNOWN) 323500856ebSRafal Jaworowski return 1; 324500856ebSRafal Jaworowski 325500856ebSRafal Jaworowski return 0; 326500856ebSRafal Jaworowski } 327500856ebSRafal Jaworowski 328500856ebSRafal Jaworowski 329500856ebSRafal Jaworowski int dev_open_stor(void *cookie) 330500856ebSRafal Jaworowski { 331500856ebSRafal Jaworowski int type = dev_stor_type(cookie); 332500856ebSRafal Jaworowski 333500856ebSRafal Jaworowski if (type == ENUM_MAX) 334500856ebSRafal Jaworowski return API_ENODEV; 335500856ebSRafal Jaworowski 3364101f687SSimon Glass if (dev_stor_is_valid(type, (struct blk_desc *)cookie)) 337500856ebSRafal Jaworowski return 0; 338500856ebSRafal Jaworowski 339500856ebSRafal Jaworowski return API_ENODEV; 340500856ebSRafal Jaworowski } 341500856ebSRafal Jaworowski 342500856ebSRafal Jaworowski 343500856ebSRafal Jaworowski int dev_close_stor(void *cookie) 344500856ebSRafal Jaworowski { 345500856ebSRafal Jaworowski /* 346500856ebSRafal Jaworowski * Not much to do as we actually do not alter storage devices upon 347500856ebSRafal Jaworowski * close 348500856ebSRafal Jaworowski */ 349500856ebSRafal Jaworowski return 0; 350500856ebSRafal Jaworowski } 351500856ebSRafal Jaworowski 352500856ebSRafal Jaworowski 353500856ebSRafal Jaworowski lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start) 354500856ebSRafal Jaworowski { 355500856ebSRafal Jaworowski int type; 3564101f687SSimon Glass struct blk_desc *dd = (struct blk_desc *)cookie; 357500856ebSRafal Jaworowski 358500856ebSRafal Jaworowski if ((type = dev_stor_type(dd)) == ENUM_MAX) 359500856ebSRafal Jaworowski return 0; 360500856ebSRafal Jaworowski 361500856ebSRafal Jaworowski if (!dev_stor_is_valid(type, dd)) 362500856ebSRafal Jaworowski return 0; 363500856ebSRafal Jaworowski 364500856ebSRafal Jaworowski if ((dd->block_read) == NULL) { 365f2302d44SStefan Roese debugf("no block_read() for device 0x%08x\n", cookie); 366500856ebSRafal Jaworowski return 0; 367500856ebSRafal Jaworowski } 368500856ebSRafal Jaworowski 3697c4213f6SStephen Warren return dd->block_read(dd, start, len, buf); 370500856ebSRafal Jaworowski } 371