[people/ms/u-boot.git] / api / api_storage.c

/*
 * (C) Copyright 2007-2008 Semihalf
 *
 * Written by: Rafal Jaworowski <raj@semihalf.com>
 *
 * 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.
 *
 * first:	if 1 the first device in the storage group is returned (if
 *              exists), if 0 the next available device is searched
 *
 * 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 first, int *more, struct device_info *di)
{
	int found = 0;
	*more = 0;

	int i;

	struct blk_desc *dd;

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

	if (first) {
		di->cookie = (void *)blk_get_dev(specs[type].name, 0);
		if (di->cookie == NULL)
			return 0;
		else
			found = 1;

		/*
		 * provide hint if there are more devices in
		 * this group to enumerate
		 */
		if (1 < specs[type].max_dev)
			*more = 1;

	} else {
		for (i = 0; i < specs[type].max_dev; i++)
			if (di->cookie ==
			    (void *)blk_get_dev(specs[type].name, i)) {
				/*
				 * previous cookie found -- advance to the
				 * next device, if possible
				 */

				if (++i >= specs[type].max_dev) {
					/* out of range, no more to enum */
					di->cookie = NULL;
					break;
				}

				di->cookie = (void *)blk_get_dev(
							specs[type].name, i);
				if (di->cookie == NULL)
					return 0;
				else
					found = 1;

				/*
				 * provide hint if there are more devices in
				 * this group to enumerate
				 */
				if ((i + 1) < specs[type].max_dev)
					*more = 1;

				break;
			}
	}

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

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