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

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2007-2008 Semihalf
 *
 * Written by: Rafal Jaworowski <raj@semihalf.com>
 */

#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 }, };

#ifndef CONFIG_SYS_MMC_MAX_DEVICE
#define CONFIG_SYS_MMC_MAX_DEVICE	1
#endif

void dev_stor_init(void)
{
#if defined(CONFIG_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_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 found_last = 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;
				found_last = 1;
				break;
			}
		}

		if (!found_last)
			i = 0;
	}

	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;

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