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