api/api_storage.c

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