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