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