[u-boot.git] / drivers / dfu / dfu.c

/*
 * dfu.c -- DFU back-end routines
 *
 * Copyright (C) 2012 Samsung Electronics
 * author: Lukasz Majewski <[email protected]>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <errno.h>
#include <malloc.h>
#include <mmc.h>
#include <fat.h>
#include <dfu.h>
#include <hash.h>
#include <linux/list.h>
#include <linux/compiler.h>

static LIST_HEAD(dfu_list);
static int dfu_alt_num;
static int alt_num_cnt;
static struct hash_algo *dfu_hash_algo;

/*
 * The purpose of the dfu_usb_get_reset() function is to
 * provide information if after USB_DETACH request
 * being sent the dfu-util performed reset of USB
 * bus.
 *
 * Described behaviour is the only way to distinct if
 * user has typed -e (detach) or -R (reset) when invoking
 * dfu-util command.
 *
 */
__weak bool dfu_usb_get_reset(void)
{
#ifdef CONFIG_SPL_DFU_NO_RESET
	return false;
#else
	return true;
#endif
}

static int dfu_find_alt_num(const char *s)
{
	int i = 0;

	for (; *s; s++)
		if (*s == ';')
			i++;

	return ++i;
}

int dfu_init_env_entities(char *interface, char *devstr)
{
	const char *str_env;
	char *env_bkp;
	int ret;

#ifdef CONFIG_SET_DFU_ALT_INFO
	set_dfu_alt_info(interface, devstr);
#endif
	str_env = env_get("dfu_alt_info");
	if (!str_env) {
		error("\"dfu_alt_info\" env variable not defined!\n");
		return -EINVAL;
	}

	env_bkp = strdup(str_env);
	ret = dfu_config_entities(env_bkp, interface, devstr);
	if (ret) {
		error("DFU entities configuration failed!\n");
		return ret;
	}

	free(env_bkp);
	return 0;
}

static unsigned char *dfu_buf;
static unsigned long dfu_buf_size;

unsigned char *dfu_free_buf(void)
{
	free(dfu_buf);
	dfu_buf = NULL;
	return dfu_buf;
}

unsigned long dfu_get_buf_size(void)
{
	return dfu_buf_size;
}

unsigned char *dfu_get_buf(struct dfu_entity *dfu)
{
	char *s;

	if (dfu_buf != NULL)
		return dfu_buf;

	s = env_get("dfu_bufsiz");
	if (s)
		dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);

	if (!s || !dfu_buf_size)
		dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;

	if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
		dfu_buf_size = dfu->max_buf_size;

	dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
	if (dfu_buf == NULL)
		printf("%s: Could not memalign 0x%lx bytes\n",
		       __func__, dfu_buf_size);

	return dfu_buf;
}

static char *dfu_get_hash_algo(void)
{
	char *s;

	s = env_get("dfu_hash_algo");
	if (!s)
		return NULL;

	if (!strcmp(s, "crc32")) {
		debug("%s: DFU hash method: %s\n", __func__, s);
		return s;
	}

	error("DFU hash method: %s not supported!\n", s);
	return NULL;
}

static int dfu_write_buffer_drain(struct dfu_entity *dfu)
{
	long w_size;
	int ret;

	/* flush size? */
	w_size = dfu->i_buf - dfu->i_buf_start;
	if (w_size == 0)
		return 0;

	if (dfu_hash_algo)
		dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
					   dfu->i_buf_start, w_size, 0);

	ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
	if (ret)
		debug("%s: Write error!\n", __func__);

	/* point back */
	dfu->i_buf = dfu->i_buf_start;

	/* update offset */
	dfu->offset += w_size;

	puts("#");

	return ret;
}

void dfu_transaction_cleanup(struct dfu_entity *dfu)
{
	/* clear everything */
	dfu->crc = 0;
	dfu->offset = 0;
	dfu->i_blk_seq_num = 0;
	dfu->i_buf_start = dfu_get_buf(dfu);
	dfu->i_buf_end = dfu->i_buf_start;
	dfu->i_buf = dfu->i_buf_start;
	dfu->r_left = 0;
	dfu->b_left = 0;
	dfu->bad_skip = 0;

	dfu->inited = 0;
}

int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
{
	int ret = 0;

	if (dfu->inited)
		return 0;

	dfu_transaction_cleanup(dfu);

	if (dfu->i_buf_start == NULL)
		return -ENOMEM;

	dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();

	if (read) {
		ret = dfu->get_medium_size(dfu, &dfu->r_left);
		if (ret < 0)
			return ret;
		debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
	}

	dfu->inited = 1;

	return 0;
}

int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
{
	int ret = 0;

	ret = dfu_write_buffer_drain(dfu);
	if (ret)
		return ret;

	if (dfu->flush_medium)
		ret = dfu->flush_medium(dfu);

	if (dfu_hash_algo)
		printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
		       dfu->crc);

	dfu_transaction_cleanup(dfu);

	return ret;
}

int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
{
	int ret;

	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
	      __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
	      (unsigned long)(dfu->i_buf - dfu->i_buf_start));

	ret = dfu_transaction_initiate(dfu, false);
	if (ret < 0)
		return ret;

	if (dfu->i_blk_seq_num != blk_seq_num) {
		printf("%s: Wrong sequence number! [%d] [%d]\n",
		       __func__, dfu->i_blk_seq_num, blk_seq_num);
		dfu_transaction_cleanup(dfu);
		return -1;
	}

	/* DFU 1.1 standard says:
	 * The wBlockNum field is a block sequence number. It increments each
	 * time a block is transferred, wrapping to zero from 65,535. It is used
	 * to provide useful context to the DFU loader in the device."
	 *
	 * This means that it's a 16 bit counter that roll-overs at
	 * 0xffff -> 0x0000. By having a typical 4K transfer block
	 * we roll-over at exactly 256MB. Not very fun to debug.
	 *
	 * Handling rollover, and having an inited variable,
	 * makes things work.
	 */

	/* handle rollover */
	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;

	/* flush buffer if overflow */
	if ((dfu->i_buf + size) > dfu->i_buf_end) {
		ret = dfu_write_buffer_drain(dfu);
		if (ret) {
			dfu_transaction_cleanup(dfu);
			return ret;
		}
	}

	/* we should be in buffer now (if not then size too large) */
	if ((dfu->i_buf + size) > dfu->i_buf_end) {
		error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
		      size, dfu->i_buf_end);
		dfu_transaction_cleanup(dfu);
		return -1;
	}

	memcpy(dfu->i_buf, buf, size);
	dfu->i_buf += size;

	/* if end or if buffer full flush */
	if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
		ret = dfu_write_buffer_drain(dfu);
		if (ret) {
			dfu_transaction_cleanup(dfu);
			return ret;
		}
	}

	return 0;
}

static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
{
	long chunk;
	int ret, readn;

	readn = 0;
	while (size > 0) {
		/* get chunk that can be read */
		chunk = min((long)size, dfu->b_left);
		/* consume */
		if (chunk > 0) {
			memcpy(buf, dfu->i_buf, chunk);
			if (dfu_hash_algo)
				dfu_hash_algo->hash_update(dfu_hash_algo,
							   &dfu->crc, buf,
							   chunk, 0);

			dfu->i_buf += chunk;
			dfu->b_left -= chunk;
			size -= chunk;
			buf += chunk;
			readn += chunk;
		}

		/* all done */
		if (size > 0) {
			/* no more to read */
			if (dfu->r_left == 0)
				break;

			dfu->i_buf = dfu->i_buf_start;
			dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;

			/* got to read, but buffer is empty */
			if (dfu->b_left > dfu->r_left)
				dfu->b_left = dfu->r_left;
			ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
					&dfu->b_left);
			if (ret != 0) {
				debug("%s: Read error!\n", __func__);
				return ret;
			}
			dfu->offset += dfu->b_left;
			dfu->r_left -= dfu->b_left;

			puts("#");
		}
	}

	return readn;
}

int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
{
	int ret = 0;

	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
	       __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);

	ret = dfu_transaction_initiate(dfu, true);
	if (ret < 0)
		return ret;

	if (dfu->i_blk_seq_num != blk_seq_num) {
		printf("%s: Wrong sequence number! [%d] [%d]\n",
		       __func__, dfu->i_blk_seq_num, blk_seq_num);
		return -1;
	}
	/* handle rollover */
	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;

	ret = dfu_read_buffer_fill(dfu, buf, size);
	if (ret < 0) {
		printf("%s: Failed to fill buffer\n", __func__);
		return -1;
	}

	if (ret < size) {
		if (dfu_hash_algo)
			debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
			      dfu_hash_algo->name, dfu->crc);
		puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");

		dfu_transaction_cleanup(dfu);
	}

	return ret;
}

static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
			   char *interface, char *devstr)
{
	char *st;

	debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
	st = strsep(&s, " ");
	strcpy(dfu->name, st);

	dfu->alt = alt;
	dfu->max_buf_size = 0;
	dfu->free_entity = NULL;

	/* Specific for mmc device */
	if (strcmp(interface, "mmc") == 0) {
		if (dfu_fill_entity_mmc(dfu, devstr, s))
			return -1;
	} else if (strcmp(interface, "nand") == 0) {
		if (dfu_fill_entity_nand(dfu, devstr, s))
			return -1;
	} else if (strcmp(interface, "ram") == 0) {
		if (dfu_fill_entity_ram(dfu, devstr, s))
			return -1;
	} else if (strcmp(interface, "sf") == 0) {
		if (dfu_fill_entity_sf(dfu, devstr, s))
			return -1;
	} else {
		printf("%s: Device %s not (yet) supported!\n",
		       __func__,  interface);
		return -1;
	}
	dfu_get_buf(dfu);

	return 0;
}

void dfu_free_entities(void)
{
	struct dfu_entity *dfu, *p, *t = NULL;

	dfu_free_buf();
	list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
		list_del(&dfu->list);
		if (dfu->free_entity)
			dfu->free_entity(dfu);
		t = dfu;
	}
	if (t)
		free(t);
	INIT_LIST_HEAD(&dfu_list);

	alt_num_cnt = 0;
}

int dfu_config_entities(char *env, char *interface, char *devstr)
{
	struct dfu_entity *dfu;
	int i, ret;
	char *s;

	dfu_alt_num = dfu_find_alt_num(env);
	debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);

	dfu_hash_algo = NULL;
	s = dfu_get_hash_algo();
	if (s) {
		ret = hash_lookup_algo(s, &dfu_hash_algo);
		if (ret)
			error("Hash algorithm %s not supported\n", s);
	}

	dfu = calloc(sizeof(*dfu), dfu_alt_num);
	if (!dfu)
		return -1;
	for (i = 0; i < dfu_alt_num; i++) {

		s = strsep(&env, ";");
		ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
				      devstr);
		if (ret) {
			free(dfu);
			return -1;
		}

		list_add_tail(&dfu[i].list, &dfu_list);
		alt_num_cnt++;
	}

	return 0;
}

const char *dfu_get_dev_type(enum dfu_device_type t)
{
	const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM", "SF" };
	return dev_t[t];
}

const char *dfu_get_layout(enum dfu_layout l)
{
	const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
					   "EXT3", "EXT4", "RAM_ADDR" };
	return dfu_layout[l];
}

void dfu_show_entities(void)
{
	struct dfu_entity *dfu;

	puts("DFU alt settings list:\n");

	list_for_each_entry(dfu, &dfu_list, list) {
		printf("dev: %s alt: %d name: %s layout: %s\n",
		       dfu_get_dev_type(dfu->dev_type), dfu->alt,
		       dfu->name, dfu_get_layout(dfu->layout));
	}
}

int dfu_get_alt_number(void)
{
	return dfu_alt_num;
}

struct dfu_entity *dfu_get_entity(int alt)
{
	struct dfu_entity *dfu;

	list_for_each_entry(dfu, &dfu_list, list) {
		if (dfu->alt == alt)
			return dfu;
	}

	return NULL;
}

int dfu_get_alt(char *name)
{
	struct dfu_entity *dfu;
	char *str;

	list_for_each_entry(dfu, &dfu_list, list) {
		if (dfu->name[0] != '/') {
			if (!strncmp(dfu->name, name, strlen(dfu->name)))
				return dfu->alt;
		} else {
			/*
			 * One must also consider absolute path
			 * (/boot/bin/uImage) available at dfu->name when
			 * compared "plain" file name (uImage)
			 *
			 * It is the case for e.g. thor gadget where lthor SW
			 * sends only the file name, so only the very last part
			 * of path must be checked for equality
			 */

			str = strstr(dfu->name, name);
			if (!str)
				continue;

			/*
			 * Check if matching substring is the last element of
			 * dfu->name (uImage)
			 */
			if (strlen(dfu->name) ==
			    ((str - dfu->name) + strlen(name)))
				return dfu->alt;
		}
	}

	return -ENODEV;
}

int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
{
	unsigned long dfu_buf_size, write, left = size;
	int i, ret = 0;
	void *dp = buf;

	/*
	 * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
	 * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
	 * into account.
	 */
	dfu_get_buf(dfu);
	dfu_buf_size = dfu_get_buf_size();
	debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);

	for (i = 0; left > 0; i++) {
		write = min(dfu_buf_size, left);

		debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
		      dp, left, write);
		ret = dfu_write(dfu, dp, write, i);
		if (ret) {
			error("DFU write failed\n");
			return ret;
		}

		dp += write;
		left -= write;
	}

	ret = dfu_flush(dfu, NULL, 0, i);
	if (ret)
		error("DFU flush failed!");

	return ret;
}
Commit	Line	Data
f22b11c1 ŁM	1	/*
	2	* dfu.c -- DFU back-end routines
	3	*
	4	* Copyright (C) 2012 Samsung Electronics
	5	* author: Lukasz Majewski <[email protected]>
	6	*
1a459660	7	* SPDX-License-Identifier: GPL-2.0+
f22b11c1 ŁM	8	*/
	9
	10	#include <common.h>
e7e75c70	11	#include <errno.h>
f22b11c1 ŁM	12	#include <malloc.h>
	13	#include <mmc.h>
	14	#include <fat.h>
	15	#include <dfu.h>
bd694244	16	#include <hash.h>
f22b11c1 ŁM	17	#include <linux/list.h>
	18	#include <linux/compiler.h>
	19
	20	static LIST_HEAD(dfu_list);
	21	static int dfu_alt_num;
b627eb46	22	static int alt_num_cnt;
bd694244	23	static struct hash_algo *dfu_hash_algo;
f22b11c1	24
1cc03c5c ŁM	25	/*
	26	* The purpose of the dfu_usb_get_reset() function is to
	27	* provide information if after USB_DETACH request
	28	* being sent the dfu-util performed reset of USB
	29	* bus.
	30	*
	31	* Described behaviour is the only way to distinct if
	32	* user has typed -e (detach) or -R (reset) when invoking
	33	* dfu-util command.
	34	*
	35	*/
	36	__weak bool dfu_usb_get_reset(void)
	37	{
66928afb R	38	#ifdef CONFIG_SPL_DFU_NO_RESET
	39	return false;
	40	#else
1cc03c5c	41	return true;
66928afb	42	#endif
1cc03c5c ŁM	43	}
1cc03c5c ŁM	44
f22b11c1 ŁM	45	static int dfu_find_alt_num(const char *s)
	46	{
	47	int i = 0;
	48
	49	for (; *s; s++)
	50	if (*s == ';')
	51	i++;
	52
	53	return ++i;
	54	}
	55
dd64827e	56	int dfu_init_env_entities(char interface, char devstr)
765c5ae5 ŁM	57	{
	58	const char *str_env;
	59	char *env_bkp;
	60	int ret;
	61
899a5282 PM	62	#ifdef CONFIG_SET_DFU_ALT_INFO
	63	set_dfu_alt_info(interface, devstr);
	64	#endif
00caae6d	65	str_env = env_get("dfu_alt_info");
765c5ae5 ŁM	66	if (!str_env) {
	67	error("\"dfu_alt_info\" env variable not defined!\n");
	68	return -EINVAL;
	69	}
	70
	71	env_bkp = strdup(str_env);
dd64827e	72	ret = dfu_config_entities(env_bkp, interface, devstr);
765c5ae5 ŁM	73	if (ret) {
	74	error("DFU entities configuration failed!\n");
	75	return ret;
	76	}
	77
	78	free(env_bkp);
	79	return 0;
	80	}
	81
e7e75c70	82	static unsigned char *dfu_buf;
a7e6892f	83	static unsigned long dfu_buf_size;
e7e75c70	84
d4278263	85	unsigned char *dfu_free_buf(void)
e7e75c70 HS	86	{
	87	free(dfu_buf);
	88	dfu_buf = NULL;
	89	return dfu_buf;
	90	}
	91
4fb12789 ŁM	92	unsigned long dfu_get_buf_size(void)
	93	{
	94	return dfu_buf_size;
	95	}
	96
7ac1b410	97	unsigned char dfu_get_buf(struct dfu_entity dfu)
e7e75c70 HS	98	{
	99	char *s;
	100
	101	if (dfu_buf != NULL)
	102	return dfu_buf;
	103
00caae6d	104	s = env_get("dfu_bufsiz");
f597fc3d PM	105	if (s)
	106	dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
	107
	108	if (!s \|\| !dfu_buf_size)
	109	dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
	110
7ac1b410 SW	111	if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
7ac1b410 SW	112	dfu_buf_size = dfu->max_buf_size;
e7e75c70 HS	113
	114	dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
	115	if (dfu_buf == NULL)
	116	printf("%s: Could not memalign 0x%lx bytes\n",
	117	__func__, dfu_buf_size);
	118
	119	return dfu_buf;
	120	}
f22b11c1	121
bd694244 ŁM	122	static char *dfu_get_hash_algo(void)
	123	{
	124	char *s;
	125
00caae6d	126	s = env_get("dfu_hash_algo");
3d83e675	127	if (!s)
bd694244 ŁM	128	return NULL;
bd694244 ŁM	129
3d83e675 ŁM	130	if (!strcmp(s, "crc32")) {
	131	debug("%s: DFU hash method: %s\n", __func__, s);
	132	return s;
	133	}
	134
	135	error("DFU hash method: %s not supported!\n", s);
bd694244 ŁM	136	return NULL;
	137	}
	138
ea2453d5 PA	139	static int dfu_write_buffer_drain(struct dfu_entity *dfu)
	140	{
	141	long w_size;
	142	int ret;
	143
	144	/* flush size? */
	145	w_size = dfu->i_buf - dfu->i_buf_start;
	146	if (w_size == 0)
	147	return 0;
	148
bd694244 ŁM	149	if (dfu_hash_algo)
	150	dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
	151	dfu->i_buf_start, w_size, 0);
ea2453d5 PA	152
	153	ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
	154	if (ret)
	155	debug("%s: Write error!\n", __func__);
	156
	157	/* point back */
	158	dfu->i_buf = dfu->i_buf_start;
	159
	160	/* update offset */
	161	dfu->offset += w_size;
	162
	163	puts("#");
	164
	165	return ret;
	166	}
	167
57da0607	168	void dfu_transaction_cleanup(struct dfu_entity *dfu)
3ee9593f SW	169	{
3ee9593f SW	170	/* clear everything */
3ee9593f SW	171	dfu->crc = 0;
	172	dfu->offset = 0;
	173	dfu->i_blk_seq_num = 0;
6fa8dddd PD	174	dfu->i_buf_start = dfu_get_buf(dfu);
6fa8dddd PD	175	dfu->i_buf_end = dfu->i_buf_start;
3ee9593f	176	dfu->i_buf = dfu->i_buf_start;
57da0607 PD	177	dfu->r_left = 0;
	178	dfu->b_left = 0;
	179	dfu->bad_skip = 0;
	180
3ee9593f SW	181	dfu->inited = 0;
	182	}
	183
6fa8dddd PD	184	int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
	185	{
	186	int ret = 0;
	187
	188	if (dfu->inited)
	189	return 0;
	190
	191	dfu_transaction_cleanup(dfu);
	192
	193	if (dfu->i_buf_start == NULL)
	194	return -ENOMEM;
	195
	196	dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
	197
	198	if (read) {
	199	ret = dfu->get_medium_size(dfu, &dfu->r_left);
	200	if (ret < 0)
	201	return ret;
	202	debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
	203	}
	204
	205	dfu->inited = 1;
	206
	207	return 0;
	208	}
	209
a2199afe HS	210	int dfu_flush(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
	211	{
	212	int ret = 0;
	213
1aa4bdc8 PM	214	ret = dfu_write_buffer_drain(dfu);
	215	if (ret)
	216	return ret;
	217
a2199afe HS	218	if (dfu->flush_medium)
	219	ret = dfu->flush_medium(dfu);
	220
bd694244 ŁM	221	if (dfu_hash_algo)
	222	printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
	223	dfu->crc);
a2199afe	224
57da0607	225	dfu_transaction_cleanup(dfu);
a2199afe HS	226
	227	return ret;
	228	}
	229
f22b11c1 ŁM	230	int dfu_write(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
f22b11c1 ŁM	231	{
3ee9593f	232	int ret;
f22b11c1	233
e621c7ab	234	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
ea2453d5	235	__func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
e621c7ab	236	(unsigned long)(dfu->i_buf - dfu->i_buf_start));
f22b11c1	237
6fa8dddd PD	238	ret = dfu_transaction_initiate(dfu, false);
	239	if (ret < 0)
	240	return ret;
f22b11c1	241
ea2453d5	242	if (dfu->i_blk_seq_num != blk_seq_num) {
f22b11c1	243	printf("%s: Wrong sequence number! [%d] [%d]\n",
ea2453d5	244	__func__, dfu->i_blk_seq_num, blk_seq_num);
57da0607	245	dfu_transaction_cleanup(dfu);
f22b11c1 ŁM	246	return -1;
	247	}
	248
ea2453d5 PA	249	/* DFU 1.1 standard says:
	250	* The wBlockNum field is a block sequence number. It increments each
	251	* time a block is transferred, wrapping to zero from 65,535. It is used
	252	* to provide useful context to the DFU loader in the device."
	253	*
	254	* This means that it's a 16 bit counter that roll-overs at
	255	* 0xffff -> 0x0000. By having a typical 4K transfer block
	256	* we roll-over at exactly 256MB. Not very fun to debug.
	257	*
	258	* Handling rollover, and having an inited variable,
	259	* makes things work.
	260	*/
	261
	262	/* handle rollover */
	263	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
	264
	265	/* flush buffer if overflow */
	266	if ((dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f SW	267	ret = dfu_write_buffer_drain(dfu);
3ee9593f SW	268	if (ret) {
57da0607	269	dfu_transaction_cleanup(dfu);
3ee9593f SW	270	return ret;
3ee9593f SW	271	}
ea2453d5	272	}
f22b11c1	273
ea2453d5 PA	274	/* we should be in buffer now (if not then size too large) */
ea2453d5 PA	275	if ((dfu->i_buf + size) > dfu->i_buf_end) {
a7d2c3cd ŁM	276	error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
a7d2c3cd ŁM	277	size, dfu->i_buf_end);
57da0607	278	dfu_transaction_cleanup(dfu);
ea2453d5 PA	279	return -1;
	280	}
	281
	282	memcpy(dfu->i_buf, buf, size);
	283	dfu->i_buf += size;
	284
	285	/* if end or if buffer full flush */
	286	if (size == 0 \|\| (dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f SW	287	ret = dfu_write_buffer_drain(dfu);
3ee9593f SW	288	if (ret) {
57da0607	289	dfu_transaction_cleanup(dfu);
3ee9593f SW	290	return ret;
3ee9593f SW	291	}
ea2453d5 PA	292	}
ea2453d5 PA	293
3ee9593f	294	return 0;
ea2453d5 PA	295	}
	296
	297	static int dfu_read_buffer_fill(struct dfu_entity dfu, void buf, int size)
	298	{
	299	long chunk;
	300	int ret, readn;
	301
	302	readn = 0;
	303	while (size > 0) {
	304	/* get chunk that can be read */
b4141195	305	chunk = min((long)size, dfu->b_left);
ea2453d5 PA	306	/* consume */
	307	if (chunk > 0) {
	308	memcpy(buf, dfu->i_buf, chunk);
bd694244 ŁM	309	if (dfu_hash_algo)
	310	dfu_hash_algo->hash_update(dfu_hash_algo,
	311	&dfu->crc, buf,
	312	chunk, 0);
	313
ea2453d5 PA	314	dfu->i_buf += chunk;
	315	dfu->b_left -= chunk;
	316	size -= chunk;
	317	buf += chunk;
	318	readn += chunk;
	319	}
	320
	321	/* all done */
	322	if (size > 0) {
	323	/* no more to read */
	324	if (dfu->r_left == 0)
	325	break;
	326
	327	dfu->i_buf = dfu->i_buf_start;
	328	dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
	329
	330	/* got to read, but buffer is empty */
	331	if (dfu->b_left > dfu->r_left)
	332	dfu->b_left = dfu->r_left;
	333	ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
	334	&dfu->b_left);
	335	if (ret != 0) {
	336	debug("%s: Read error!\n", __func__);
	337	return ret;
	338	}
	339	dfu->offset += dfu->b_left;
	340	dfu->r_left -= dfu->b_left;
	341
	342	puts("#");
	343	}
	344	}
	345
	346	return readn;
f22b11c1 ŁM	347	}
	348
	349	int dfu_read(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
	350	{
f22b11c1 ŁM	351	int ret = 0;
	352
	353	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
ea2453d5 PA	354	__func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
ea2453d5 PA	355
6fa8dddd PD	356	ret = dfu_transaction_initiate(dfu, true);
	357	if (ret < 0)
	358	return ret;
f22b11c1	359
ea2453d5	360	if (dfu->i_blk_seq_num != blk_seq_num) {
f22b11c1	361	printf("%s: Wrong sequence number! [%d] [%d]\n",
ea2453d5	362	__func__, dfu->i_blk_seq_num, blk_seq_num);
f22b11c1 ŁM	363	return -1;
f22b11c1 ŁM	364	}
ea2453d5 PA	365	/* handle rollover */
ea2453d5 PA	366	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
f22b11c1	367
ea2453d5 PA	368	ret = dfu_read_buffer_fill(dfu, buf, size);
	369	if (ret < 0) {
	370	printf("%s: Failed to fill buffer\n", __func__);
	371	return -1;
f22b11c1	372	}
ea2453d5 PA	373
ea2453d5 PA	374	if (ret < size) {
bd694244 ŁM	375	if (dfu_hash_algo)
	376	debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
	377	dfu_hash_algo->name, dfu->crc);
ea2453d5 PA	378	puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
ea2453d5 PA	379
57da0607	380	dfu_transaction_cleanup(dfu);
ea2453d5 PA	381	}
ea2453d5 PA	382
f22b11c1 ŁM	383	return ret;
	384	}
	385
	386	static int dfu_fill_entity(struct dfu_entity dfu, char s, int alt,
dd64827e	387	char interface, char devstr)
f22b11c1 ŁM	388	{
	389	char *st;
	390
dd64827e	391	debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
f22b11c1 ŁM	392	st = strsep(&s, " ");
	393	strcpy(dfu->name, st);
	394
f22b11c1	395	dfu->alt = alt;
7ac1b410	396	dfu->max_buf_size = 0;
cb7bd2e0	397	dfu->free_entity = NULL;
f22b11c1 ŁM	398
	399	/* Specific for mmc device */
	400	if (strcmp(interface, "mmc") == 0) {
dd64827e	401	if (dfu_fill_entity_mmc(dfu, devstr, s))
f22b11c1	402	return -1;
c6631764	403	} else if (strcmp(interface, "nand") == 0) {
dd64827e	404	if (dfu_fill_entity_nand(dfu, devstr, s))
c6631764	405	return -1;
a9479f04	406	} else if (strcmp(interface, "ram") == 0) {
dd64827e	407	if (dfu_fill_entity_ram(dfu, devstr, s))
a9479f04	408	return -1;
6f12ebf6 SW	409	} else if (strcmp(interface, "sf") == 0) {
	410	if (dfu_fill_entity_sf(dfu, devstr, s))
	411	return -1;
f22b11c1 ŁM	412	} else {
	413	printf("%s: Device %s not (yet) supported!\n",
	414	__func__, interface);
	415	return -1;
	416	}
806bd245	417	dfu_get_buf(dfu);
f22b11c1 ŁM	418
	419	return 0;
	420	}
	421
	422	void dfu_free_entities(void)
	423	{
	424	struct dfu_entity dfu, p, *t = NULL;
	425
806bd245	426	dfu_free_buf();
f22b11c1 ŁM	427	list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
f22b11c1 ŁM	428	list_del(&dfu->list);
cb7bd2e0 SW	429	if (dfu->free_entity)
cb7bd2e0 SW	430	dfu->free_entity(dfu);
f22b11c1 ŁM	431	t = dfu;
	432	}
	433	if (t)
	434	free(t);
	435	INIT_LIST_HEAD(&dfu_list);
b627eb46 PM	436
b627eb46 PM	437	alt_num_cnt = 0;
f22b11c1 ŁM	438	}
f22b11c1 ŁM	439
dd64827e	440	int dfu_config_entities(char env, char interface, char *devstr)
f22b11c1 ŁM	441	{
	442	struct dfu_entity *dfu;
	443	int i, ret;
	444	char *s;
	445
	446	dfu_alt_num = dfu_find_alt_num(env);
	447	debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
	448
bd694244 ŁM	449	dfu_hash_algo = NULL;
	450	s = dfu_get_hash_algo();
	451	if (s) {
	452	ret = hash_lookup_algo(s, &dfu_hash_algo);
	453	if (ret)
	454	error("Hash algorithm %s not supported\n", s);
	455	}
	456
f22b11c1 ŁM	457	dfu = calloc(sizeof(*dfu), dfu_alt_num);
	458	if (!dfu)
	459	return -1;
	460	for (i = 0; i < dfu_alt_num; i++) {
	461
	462	s = strsep(&env, ";");
dd64827e SW	463	ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
dd64827e SW	464	devstr);
5d8fae79 PF	465	if (ret) {
5d8fae79 PF	466	free(dfu);
f22b11c1	467	return -1;
5d8fae79	468	}
f22b11c1 ŁM	469
f22b11c1 ŁM	470	list_add_tail(&dfu[i].list, &dfu_list);
b627eb46	471	alt_num_cnt++;
f22b11c1 ŁM	472	}
	473
	474	return 0;
	475	}
	476
	477	const char *dfu_get_dev_type(enum dfu_device_type t)
	478	{
dd93a8e9	479	const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM", "SF" };
f22b11c1 ŁM	480	return dev_t[t];
	481	}
	482
	483	const char *dfu_get_layout(enum dfu_layout l)
	484	{
	485	const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
a9479f04	486	"EXT3", "EXT4", "RAM_ADDR" };
f22b11c1 ŁM	487	return dfu_layout[l];
	488	}
	489
	490	void dfu_show_entities(void)
	491	{
	492	struct dfu_entity *dfu;
	493
	494	puts("DFU alt settings list:\n");
	495
	496	list_for_each_entry(dfu, &dfu_list, list) {
	497	printf("dev: %s alt: %d name: %s layout: %s\n",
	498	dfu_get_dev_type(dfu->dev_type), dfu->alt,
	499	dfu->name, dfu_get_layout(dfu->layout));
	500	}
	501	}
	502
	503	int dfu_get_alt_number(void)
	504	{
	505	return dfu_alt_num;
	506	}
	507
	508	struct dfu_entity *dfu_get_entity(int alt)
	509	{
	510	struct dfu_entity *dfu;
	511
	512	list_for_each_entry(dfu, &dfu_list, list) {
	513	if (dfu->alt == alt)
	514	return dfu;
	515	}
	516
	517	return NULL;
	518	}
fed936ed ŁM	519
	520	int dfu_get_alt(char *name)
	521	{
	522	struct dfu_entity *dfu;
5610b057	523	char *str;
fed936ed ŁM	524
fed936ed ŁM	525	list_for_each_entry(dfu, &dfu_list, list) {
5610b057 ŁM	526	if (dfu->name[0] != '/') {
	527	if (!strncmp(dfu->name, name, strlen(dfu->name)))
	528	return dfu->alt;
	529	} else {
	530	/*
	531	* One must also consider absolute path
	532	* (/boot/bin/uImage) available at dfu->name when
	533	* compared "plain" file name (uImage)
	534	*
	535	* It is the case for e.g. thor gadget where lthor SW
	536	* sends only the file name, so only the very last part
	537	* of path must be checked for equality
	538	*/
	539
	540	str = strstr(dfu->name, name);
	541	if (!str)
	542	continue;
	543
	544	/*
	545	* Check if matching substring is the last element of
	546	* dfu->name (uImage)
	547	*/
	548	if (strlen(dfu->name) ==
	549	((str - dfu->name) + strlen(name)))
	550	return dfu->alt;
	551	}
fed936ed ŁM	552	}
	553
	554	return -ENODEV;
	555	}
2092e461 LM	556
	557	int dfu_write_from_mem_addr(struct dfu_entity dfu, void buf, int size)
	558	{
	559	unsigned long dfu_buf_size, write, left = size;
	560	int i, ret = 0;
	561	void *dp = buf;
	562
	563	/*
	564	* Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
	565	* has been properly initialized - e.g. if "dfu_bufsiz" has been taken
	566	* into account.
	567	*/
	568	dfu_get_buf(dfu);
	569	dfu_buf_size = dfu_get_buf_size();
	570	debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
	571
	572	for (i = 0; left > 0; i++) {
	573	write = min(dfu_buf_size, left);
	574
	575	debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
	576	dp, left, write);
	577	ret = dfu_write(dfu, dp, write, i);
	578	if (ret) {
	579	error("DFU write failed\n");
	580	return ret;
	581	}
	582
	583	dp += write;
	584	left -= write;
	585	}
	586
	587	ret = dfu_flush(dfu, NULL, 0, i);
	588	if (ret)
	589	error("DFU flush failed!");
	590
	591	return ret;
	592	}