api/api_storage.c

   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  * more:        returns 0/1 depending if there are more devices in this group
  92  *              available (for future iterations)
  93  *
  94  * returns:     0/1 depending if device found in this iteration
  95  */
  96 static int dev_stor_get(int type, int *more, struct device_info *di)
  97 {
  98         struct blk_desc *dd;
  99         int found = 0;
 100         int i = 0;
 101
 102         /* Wasn't configured for this type, return 0 directly */
 103         if (specs[type].name == NULL)
 104                 return 0;
 105
 106         if (di->cookie != NULL) {
 107                 /* Find the last device we've returned  */
 108                 for (i = 0; i < specs[type].max_dev; i++) {
 109                         if (di->cookie ==
 110                             (void *)blk_get_dev(specs[type].name, i)) {
 111                                 i += 1;
 112                                 break;
 113                         }
 114                 }
 115         }
 116
 117         for (; i < specs[type].max_dev; i++) {
 118                 di->cookie = (void *)blk_get_dev(specs[type].name, i);
 119
 120                 if (di->cookie != NULL) {
 121                         found = 1;
 122                         break;
 123                 }
 124         }
 125
 126         if (i == specs[type].max_dev)
 127                 *more = 0;
 128         else
 129                 *more = 1;
 130
 131         if (found) {
 132                 di->type = specs[type].type;
 133
 134                 dd = (struct blk_desc *)di->cookie;
 135                 if (dd->type == DEV_TYPE_UNKNOWN) {
 136                         debugf("device instance exists, but is not active..");
 137                         found = 0;
 138                 } else {
 139                         di->di_stor.block_count = dd->lba;
 140                         di->di_stor.block_size = dd->blksz;
 141                 }
 142         } else {
 143                 di->cookie = NULL;
 144         }
 145
 146         return found;
 147 }
 148
 149
 150 /* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */
 151
 152 static int dev_stor_type(struct blk_desc *dd)
 153 {
 154         int i, j;
 155
 156         for (i = ENUM_IDE; i < ENUM_MAX; i++)
 157                 for (j = 0; j < specs[i].max_dev; j++)
 158                         if (dd == blk_get_dev(specs[i].name, j))
 159                                 return i;
 160
 161         return ENUM_MAX;
 162 }
 163
 164
 165 /* returns: 0/1 whether cookie points to some device in this group */
 166
 167 static int dev_is_stor(int type, struct device_info *di)
 168 {
 169         return (dev_stor_type(di->cookie) == type) ? 1 : 0;
 170 }
 171
 172
 173 static int dev_enum_stor(int type, struct device_info *di)
 174 {
 175         int found = 0, more = 0;
 176
 177         debugf("called, type %d\n", type);
 178
 179         /*
 180          * Formulae for enumerating storage devices:
 181          * 1. if cookie (hint from previous enum call) is NULL we start again
 182          *    with enumeration, so return the first available device, done.
 183          *
 184          * 2. if cookie is not NULL, check if it identifies some device in
 185          *    this group:
 186          *
 187          * 2a. if cookie is a storage device from our group (IDE, USB etc.),
 188          *     return next available (if exists) in this group
 189          *
 190          * 2b. if it isn't device from our group, check if such devices were
 191          *     ever enumerated before:
 192          *     - if not, return the first available device from this group
 193          *     - else return 0
 194          */
 195
 196         if (di->cookie == NULL) {
 197                 debugf("group%d - enum restart\n", type);
 198
 199                 /*
 200                  * 1. Enumeration (re-)started: take the first available
 201                  * device, if exists
 202                  */
 203                 found = dev_stor_get(type, &more, di);
 204                 specs[type].enum_started = 1;
 205
 206         } else if (dev_is_stor(type, di)) {
 207                 debugf("group%d - enum continued for the next device\n", type);
 208
 209                 if (specs[type].enum_ended) {
 210                         debugf("group%d - nothing more to enum!\n", type);
 211                         return 0;
 212                 }
 213
 214                 /* 2a. Attempt to take a next available device in the group */
 215                 found = dev_stor_get(type, &more, di);
 216
 217         } else {
 218                 if (specs[type].enum_ended) {
 219                         debugf("group %d - already enumerated, skipping\n", type);
 220                         return 0;
 221                 }
 222
 223                 debugf("group%d - first time enum\n", type);
 224
 225                 if (specs[type].enum_started == 0) {
 226                         /*
 227                          * 2b.  If enumerating devices in this group did not
 228                          * happen before, it means the cookie pointed to a
 229                          * device from some other group (another storage
 230                          * group, or network); in this case try to take the
 231                          * first available device from our group
 232                          */
 233                         specs[type].enum_started = 1;
 234
 235                         /*
 236                          * Attempt to take the first device in this group:
 237                          *'first element' flag is set
 238                          */
 239                         found = dev_stor_get(type, &more, di);
 240
 241                 } else {
 242                         errf("group%d - out of order iteration\n", type);
 243                         found = 0;
 244                         more = 0;
 245                 }
 246         }
 247
 248         /*
 249          * If there are no more devices in this group, consider its
 250          * enumeration finished
 251          */
 252         specs[type].enum_ended = (!more) ? 1 : 0;
 253
 254         if (found)
 255                 debugf("device found, returning cookie 0x%08x\n",
 256                        (u_int32_t)di->cookie);
 257         else
 258                 debugf("no device found\n");
 259
 260         return found;
 261 }
 262
 263 void dev_enum_reset(void)
 264 {
 265         int i;
 266
 267         for (i = 0; i < ENUM_MAX; i ++) {
 268                 specs[i].enum_started = 0;
 269                 specs[i].enum_ended = 0;
 270         }
 271 }
 272
 273 int dev_enum_storage(struct device_info *di)
 274 {
 275         int i;
 276
 277         /* check: ide, usb, scsi, mmc */
 278         for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
 279                 if (dev_enum_stor(i, di))
 280                         return 1;
 281         }
 282
 283         return 0;
 284 }
 285
 286 static int dev_stor_is_valid(int type, struct blk_desc *dd)
 287 {
 288         int i;
 289
 290         for (i = 0; i < specs[type].max_dev; i++)
 291                 if (dd == blk_get_dev(specs[type].name, i))
 292                         if (dd->type != DEV_TYPE_UNKNOWN)
 293                                 return 1;
 294
 295         return 0;
 296 }
 297
 298
 299 int dev_open_stor(void *cookie)
 300 {
 301         int type = dev_stor_type(cookie);
 302
 303         if (type == ENUM_MAX)
 304                 return API_ENODEV;
 305
 306         if (dev_stor_is_valid(type, (struct blk_desc *)cookie))
 307                 return 0;
 308
 309         return API_ENODEV;
 310 }
 311
 312
 313 int dev_close_stor(void *cookie)
 314 {
 315         /*
 316          * Not much to do as we actually do not alter storage devices upon
 317          * close
 318          */
 319         return 0;
 320 }
 321
 322
 323 lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
 324 {
 325         int type;
 326         struct blk_desc *dd = (struct blk_desc *)cookie;
 327
 328         if ((type = dev_stor_type(dd)) == ENUM_MAX)
 329                 return 0;
 330
 331         if (!dev_stor_is_valid(type, dd))
 332                 return 0;
 333
 334 #ifdef CONFIG_BLK
 335         return blk_dread(dd, start, len, buf);
 336 #else
 337         if ((dd->block_read) == NULL) {
 338                 debugf("no block_read() for device 0x%08x\n", cookie);
 339                 return 0;
 340         }
 341
 342         return dd->block_read(dd, start, len, buf);
 343 #endif  /* defined(CONFIG_BLK) */
 344 }