[J-u-boot.git] / api / api_storage.c

/*
 * (C) Copyright 2007-2008 Semihalf
 *
 * Written by: Rafal Jaworowski <[email protected]>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <config.h>
#include <common.h>
#include <api_public.h>

#if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
#include <usb.h>
#endif

#define DEBUG
#undef DEBUG

#ifdef DEBUG
#define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt, ##args); } while (0)
#else
#define debugf(fmt, args...)
#endif

#define errf(fmt, args...) do { printf("ERROR @ %s(): ", __func__); printf(fmt, ##args); } while (0)


#define ENUM_IDE	0
#define ENUM_USB	1
#define ENUM_SCSI	2
#define ENUM_MMC	3
#define ENUM_SATA	4
#define ENUM_MAX	5

struct stor_spec {
	int		max_dev;
	int		enum_started;
	int		enum_ended;
	int		type;	/* "external" type: DT_STOR_{IDE,USB,etc} */
	char		*name;
};

static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, };


void dev_stor_init(void)
{
#if defined(CONFIG_CMD_IDE)
	specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE;
	specs[ENUM_IDE].enum_started = 0;
	specs[ENUM_IDE].enum_ended = 0;
	specs[ENUM_IDE].type = DEV_TYP_STOR | DT_STOR_IDE;
	specs[ENUM_IDE].name = "ide";
#endif
#if defined(CONFIG_CMD_MMC)
	specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE;
	specs[ENUM_MMC].enum_started = 0;
	specs[ENUM_MMC].enum_ended = 0;
	specs[ENUM_MMC].type = DEV_TYP_STOR | DT_STOR_MMC;
	specs[ENUM_MMC].name = "mmc";
#endif
#if defined(CONFIG_CMD_SATA)
	specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE;
	specs[ENUM_SATA].enum_started = 0;
	specs[ENUM_SATA].enum_ended = 0;
	specs[ENUM_SATA].type = DEV_TYP_STOR | DT_STOR_SATA;
	specs[ENUM_SATA].name = "sata";
#endif
#if defined(CONFIG_SCSI)
	specs[ENUM_SCSI].max_dev = CONFIG_SYS_SCSI_MAX_DEVICE;
	specs[ENUM_SCSI].enum_started = 0;
	specs[ENUM_SCSI].enum_ended = 0;
	specs[ENUM_SCSI].type = DEV_TYP_STOR | DT_STOR_SCSI;
	specs[ENUM_SCSI].name = "scsi";
#endif
#if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
	specs[ENUM_USB].max_dev = USB_MAX_STOR_DEV;
	specs[ENUM_USB].enum_started = 0;
	specs[ENUM_USB].enum_ended = 0;
	specs[ENUM_USB].type = DEV_TYP_STOR | DT_STOR_USB;
	specs[ENUM_USB].name = "usb";
#endif
}

/*
 * Finds next available device in the storage group
 *
 * type:	storage group type - ENUM_IDE, ENUM_SCSI etc.
 *
 * more:	returns 0/1 depending if there are more devices in this group
 *		available (for future iterations)
 *
 * returns:	0/1 depending if device found in this iteration
 */
static int dev_stor_get(int type, int *more, struct device_info *di)
{
	struct blk_desc *dd;
	int found = 0;
	int i = 0;

	/* Wasn't configured for this type, return 0 directly */
	if (specs[type].name == NULL)
		return 0;

	if (di->cookie != NULL) {
		/* Find the last device we've returned  */
		for (i = 0; i < specs[type].max_dev; i++) {
			if (di->cookie ==
			    (void *)blk_get_dev(specs[type].name, i)) {
				i += 1;
				break;
			}
		}
	}

	for (; i < specs[type].max_dev; i++) {
		di->cookie = (void *)blk_get_dev(specs[type].name, i);

		if (di->cookie != NULL) {
			found = 1;
			break;
		}
	}

	if (i == specs[type].max_dev)
		*more = 0;
	else
		*more = 1;

	if (found) {
		di->type = specs[type].type;

		dd = (struct blk_desc *)di->cookie;
		if (dd->type == DEV_TYPE_UNKNOWN) {
			debugf("device instance exists, but is not active..");
			found = 0;
		} else {
			di->di_stor.block_count = dd->lba;
			di->di_stor.block_size = dd->blksz;
		}
	} else {
		di->cookie = NULL;
	}

	return found;
}


/* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */

static int dev_stor_type(struct blk_desc *dd)
{
	int i, j;

	for (i = ENUM_IDE; i < ENUM_MAX; i++)
		for (j = 0; j < specs[i].max_dev; j++)
			if (dd == blk_get_dev(specs[i].name, j))
				return i;

	return ENUM_MAX;
}


/* returns: 0/1 whether cookie points to some device in this group */

static int dev_is_stor(int type, struct device_info *di)
{
	return (dev_stor_type(di->cookie) == type) ? 1 : 0;
}


static int dev_enum_stor(int type, struct device_info *di)
{
	int found = 0, more = 0;

	debugf("called, type %d\n", type);

	/*
	 * Formulae for enumerating storage devices:
	 * 1. if cookie (hint from previous enum call) is NULL we start again
	 *    with enumeration, so return the first available device, done.
	 *
	 * 2. if cookie is not NULL, check if it identifies some device in
	 *    this group:
	 *
	 * 2a. if cookie is a storage device from our group (IDE, USB etc.),
	 *     return next available (if exists) in this group
	 *
	 * 2b. if it isn't device from our group, check if such devices were
	 *     ever enumerated before:
	 *     - if not, return the first available device from this group
	 *     - else return 0
	 */

	if (di->cookie == NULL) {
		debugf("group%d - enum restart\n", type);

		/*
		 * 1. Enumeration (re-)started: take the first available
		 * device, if exists
		 */
		found = dev_stor_get(type, &more, di);
		specs[type].enum_started = 1;

	} else if (dev_is_stor(type, di)) {
		debugf("group%d - enum continued for the next device\n", type);

		if (specs[type].enum_ended) {
			debugf("group%d - nothing more to enum!\n", type);
			return 0;
		}

		/* 2a. Attempt to take a next available device in the group */
		found = dev_stor_get(type, &more, di);

	} else {
		if (specs[type].enum_ended) {
			debugf("group %d - already enumerated, skipping\n", type);
			return 0;
		}

		debugf("group%d - first time enum\n", type);

		if (specs[type].enum_started == 0) {
			/*
			 * 2b.  If enumerating devices in this group did not
			 * happen before, it means the cookie pointed to a
			 * device from some other group (another storage
			 * group, or network); in this case try to take the
			 * first available device from our group
			 */
			specs[type].enum_started = 1;

			/*
			 * Attempt to take the first device in this group:
			 *'first element' flag is set
			 */
			found = dev_stor_get(type, &more, di);

		} else {
			errf("group%d - out of order iteration\n", type);
			found = 0;
			more = 0;
		}
	}

	/*
	 * If there are no more devices in this group, consider its
	 * enumeration finished
	 */
	specs[type].enum_ended = (!more) ? 1 : 0;

	if (found)
		debugf("device found, returning cookie 0x%08x\n",
		       (u_int32_t)di->cookie);
	else
		debugf("no device found\n");

	return found;
}

void dev_enum_reset(void)
{
	int i;

	for (i = 0; i < ENUM_MAX; i ++) {
		specs[i].enum_started = 0;
		specs[i].enum_ended = 0;
	}
}

int dev_enum_storage(struct device_info *di)
{
	int i;

	/* check: ide, usb, scsi, mmc */
	for (i = ENUM_IDE; i < ENUM_MAX; i ++) {
		if (dev_enum_stor(i, di))
			return 1;
	}

	return 0;
}

static int dev_stor_is_valid(int type, struct blk_desc *dd)
{
	int i;

	for (i = 0; i < specs[type].max_dev; i++)
		if (dd == blk_get_dev(specs[type].name, i))
			if (dd->type != DEV_TYPE_UNKNOWN)
				return 1;

	return 0;
}


int dev_open_stor(void *cookie)
{
	int type = dev_stor_type(cookie);

	if (type == ENUM_MAX)
		return API_ENODEV;

	if (dev_stor_is_valid(type, (struct blk_desc *)cookie))
		return 0;

	return API_ENODEV;
}


int dev_close_stor(void *cookie)
{
	/*
	 * Not much to do as we actually do not alter storage devices upon
	 * close
	 */
	return 0;
}


lbasize_t dev_read_stor(void *cookie, void *buf, lbasize_t len, lbastart_t start)
{
	int type;
	struct blk_desc *dd = (struct blk_desc *)cookie;

	if ((type = dev_stor_type(dd)) == ENUM_MAX)
		return 0;

	if (!dev_stor_is_valid(type, dd))
		return 0;

	if ((dd->block_read) == NULL) {
		debugf("no block_read() for device 0x%08x\n", cookie);
		return 0;
	}

	return dd->block_read(dd, start, len, buf);
}
Commit	Line	Data
500856eb	1	/*
f2302d44	2	* (C) Copyright 2007-2008 Semihalf
500856eb RJ	3	*
	4	* Written by: Rafal Jaworowski <[email protected]>
	5	*
1a459660	6	* SPDX-License-Identifier: GPL-2.0+
500856eb RJ	7	*/
	8
	9	#include <config.h>
500856eb RJ	10	#include <common.h>
	11	#include <api_public.h>
	12
3d0ea311 MF	13	#if defined(CONFIG_CMD_USB) && defined(CONFIG_USB_STORAGE)
	14	#include <usb.h>
	15	#endif
	16
500856eb RJ	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
f2302d44 SR	33	#define ENUM_SATA 4
f2302d44 SR	34	#define ENUM_MAX 5
500856eb RJ	35
	36	struct stor_spec {
	37	int max_dev;
	38	int enum_started;
	39	int enum_ended;
e3d7675a	40	int type; /* "external" type: DT_STOR_{IDE,USB,etc} */
f2302d44	41	char *name;
500856eb RJ	42	};
500856eb RJ	43
5d81c6df	44	static struct stor_spec specs[ENUM_MAX] = { { 0, 0, 0, 0, NULL }, };
500856eb RJ	45
	46
	47	void dev_stor_init(void)
	48	{
1b769881	49	#if defined(CONFIG_CMD_IDE)
6d0f6bcf	50	specs[ENUM_IDE].max_dev = CONFIG_SYS_IDE_MAXDEVICE;
500856eb RJ	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
f2302d44	56	#if defined(CONFIG_CMD_MMC)
6d0f6bcf	57	specs[ENUM_MMC].max_dev = CONFIG_SYS_MMC_MAX_DEVICE;
f2302d44 SR	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)
6d0f6bcf	64	specs[ENUM_SATA].max_dev = CONFIG_SYS_SATA_MAX_DEVICE;
f2302d44 SR	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";
500856eb	69	#endif
c649e3c9	70	#if defined(CONFIG_SCSI)
6d0f6bcf	71	specs[ENUM_SCSI].max_dev = CONFIG_SYS_SCSI_MAX_DEVICE;
500856eb RJ	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
f2302d44 SR	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
500856eb RJ	84	}
	85
	86	/*
	87	* Finds next available device in the storage group
	88	*
	89	* type: storage group type - ENUM_IDE, ENUM_SCSI etc.
	90	*
500856eb RJ	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	*/
d3e8f630	96	static int dev_stor_get(int type, int more, struct device_info di)
500856eb	97	{
4101f687	98	struct blk_desc *dd;
d3e8f630 EV	99	int found = 0;
d3e8f630 EV	100	int i = 0;
500856eb	101
5d81c6df EV	102	/* Wasn't configured for this type, return 0 directly */
	103	if (specs[type].name == NULL)
	104	return 0;
	105
d3e8f630 EV	106	if (di->cookie != NULL) {
	107	/* Find the last device we've returned */
	108	for (i = 0; i < specs[type].max_dev; i++) {
db1d9e78 SG	109	if (di->cookie ==
db1d9e78 SG	110	(void *)blk_get_dev(specs[type].name, i)) {
d3e8f630	111	i += 1;
500856eb RJ	112	break;
500856eb RJ	113	}
d3e8f630	114	}
500856eb RJ	115	}
500856eb RJ	116
d3e8f630 EV	117	for (; i < specs[type].max_dev; i++) {
d3e8f630 EV	118	di->cookie = (void *)blk_get_dev(specs[type].name, i);
500856eb RJ	119
500856eb RJ	120	if (di->cookie != NULL) {
d3e8f630 EV	121	found = 1;
d3e8f630 EV	122	break;
500856eb	123	}
d3e8f630 EV	124	}
	125
	126	if (i == specs[type].max_dev)
	127	*more = 0;
	128	else
	129	*more = 1;
500856eb	130
d3e8f630 EV	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 {
500856eb	143	di->cookie = NULL;
d3e8f630	144	}
500856eb RJ	145
	146	return found;
	147	}
	148
	149
c9db75a0 WF	150	/* returns: ENUM_IDE, ENUM_USB etc. based on struct blk_desc */
c9db75a0 WF	151
4101f687	152	static int dev_stor_type(struct blk_desc *dd)
500856eb RJ	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++)
db1d9e78	158	if (dd == blk_get_dev(specs[i].name, j))
500856eb RJ	159	return i;
	160
	161	return ENUM_MAX;
	162	}
	163
	164
c9db75a0 WF	165	/* returns: 0/1 whether cookie points to some device in this group */
c9db75a0 WF	166
500856eb RJ	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) {
500856eb RJ	197	debugf("group%d - enum restart\n", type);
	198
	199	/*
	200	* 1. Enumeration (re-)started: take the first available
	201	* device, if exists
	202	*/
d3e8f630	203	found = dev_stor_get(type, &more, di);
500856eb RJ	204	specs[type].enum_started = 1;
	205
	206	} else if (dev_is_stor(type, di)) {
500856eb RJ	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 */
d3e8f630	215	found = dev_stor_get(type, &more, di);
500856eb RJ	216
500856eb RJ	217	} else {
500856eb RJ	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
83f9ecbe	229	* device from some other group (another storage
500856eb RJ	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	*/
d3e8f630	239	found = dev_stor_get(type, &more, di);
500856eb RJ	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",
e5fbf2a7	256	(u_int32_t)di->cookie);
500856eb RJ	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
c9db75a0	277	/* check: ide, usb, scsi, mmc */
500856eb RJ	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
4101f687	286	static int dev_stor_is_valid(int type, struct blk_desc *dd)
500856eb RJ	287	{
	288	int i;
	289
	290	for (i = 0; i < specs[type].max_dev; i++)
db1d9e78	291	if (dd == blk_get_dev(specs[type].name, i))
500856eb RJ	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
4101f687	306	if (dev_stor_is_valid(type, (struct blk_desc *)cookie))
500856eb RJ	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
500856eb RJ	323	lbasize_t dev_read_stor(void cookie, void buf, lbasize_t len, lbastart_t start)
	324	{
	325	int type;
4101f687	326	struct blk_desc dd = (struct blk_desc )cookie;
500856eb RJ	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	if ((dd->block_read) == NULL) {
f2302d44	335	debugf("no block_read() for device 0x%08x\n", cookie);
500856eb RJ	336	return 0;
	337	}
	338
7c4213f6	339	return dd->block_read(dd, start, len, buf);
500856eb	340	}