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

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

#include <config.h>
#include <common.h>
#include <api_public.h>
#include <part.h>
#include <scsi.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_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 = 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) */
}


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

	if (type == ENUM_MAX)
		return 0;

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

#ifdef CONFIG_BLK
	return blk_dwrite(dd, start, len, buf);
#else
	if (dd->block_write == NULL) {
		debugf("no block_write() for device 0x%08x\n", cookie);
		return 0;
	}

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