LXR uboot/api/api

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