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

/*
 * dfu.c -- DFU back-end routines
 *
 * Copyright (C) 2012 Samsung Electronics
 * author: Lukasz Majewski <l.majewski@samsung.com>
 *
 * 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 = getenv("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 = getenv("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 = getenv("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_write_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_buf;
	dfu->i_buf_end = dfu_buf;
	dfu->i_buf = dfu->i_buf_start;
	dfu->inited = 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_write_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));

	if (!dfu->inited) {
		/* initial state */
		dfu->crc = 0;
		dfu->offset = 0;
		dfu->bad_skip = 0;
		dfu->i_blk_seq_num = 0;
		dfu->i_buf_start = dfu_get_buf(dfu);
		if (dfu->i_buf_start == NULL)
			return -ENOMEM;
		dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
		dfu->i_buf = dfu->i_buf_start;

		dfu->inited = 1;
	}

	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_write_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_write_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_write_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_write_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);

	if (!dfu->inited) {
		dfu->i_buf_start = dfu_get_buf(dfu);
		if (dfu->i_buf_start == NULL)
			return -ENOMEM;

		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->i_blk_seq_num = 0;
		dfu->crc = 0;
		dfu->offset = 0;
		dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
		dfu->i_buf = dfu->i_buf_start;
		dfu->b_left = 0;

		dfu->bad_skip = 0;

		dfu->inited = 1;
	}

	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->i_blk_seq_num = 0;
		dfu->crc = 0;
		dfu->offset = 0;
		dfu->i_buf_start = dfu_buf;
		dfu->i_buf_end = dfu_buf;
		dfu->i_buf = dfu->i_buf_start;
		dfu->b_left = 0;

		dfu->bad_skip = 0;

		dfu->inited = 0;
	}

	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 <l.majewski@samsung.com>
	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
765c5ae5 ŁM	65	str_env = getenv("dfu_alt_info");
	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
	104	s = getenv("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
	126	s = getenv("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
3ee9593f SW	168	void dfu_write_transaction_cleanup(struct dfu_entity *dfu)
	169	{
	170	/* clear everything */
3ee9593f SW	171	dfu->crc = 0;
	172	dfu->offset = 0;
	173	dfu->i_blk_seq_num = 0;
	174	dfu->i_buf_start = dfu_buf;
	175	dfu->i_buf_end = dfu_buf;
	176	dfu->i_buf = dfu->i_buf_start;
	177	dfu->inited = 0;
	178	}
	179
a2199afe HS	180	int dfu_flush(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
	181	{
	182	int ret = 0;
	183
1aa4bdc8 PM	184	ret = dfu_write_buffer_drain(dfu);
	185	if (ret)
	186	return ret;
	187
a2199afe HS	188	if (dfu->flush_medium)
	189	ret = dfu->flush_medium(dfu);
	190
bd694244 ŁM	191	if (dfu_hash_algo)
	192	printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
	193	dfu->crc);
a2199afe	194
3ee9593f	195	dfu_write_transaction_cleanup(dfu);
a2199afe HS	196
	197	return ret;
	198	}
	199
f22b11c1 ŁM	200	int dfu_write(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
f22b11c1 ŁM	201	{
3ee9593f	202	int ret;
f22b11c1	203
e621c7ab	204	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
ea2453d5	205	__func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
e621c7ab	206	(unsigned long)(dfu->i_buf - dfu->i_buf_start));
f22b11c1	207
ea2453d5 PA	208	if (!dfu->inited) {
	209	/* initial state */
	210	dfu->crc = 0;
	211	dfu->offset = 0;
c6631764	212	dfu->bad_skip = 0;
ea2453d5	213	dfu->i_blk_seq_num = 0;
7ac1b410	214	dfu->i_buf_start = dfu_get_buf(dfu);
e7e75c70 HS	215	if (dfu->i_buf_start == NULL)
e7e75c70 HS	216	return -ENOMEM;
7ac1b410	217	dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
ea2453d5 PA	218	dfu->i_buf = dfu->i_buf_start;
	219
	220	dfu->inited = 1;
f22b11c1 ŁM	221	}
f22b11c1 ŁM	222
ea2453d5	223	if (dfu->i_blk_seq_num != blk_seq_num) {
f22b11c1	224	printf("%s: Wrong sequence number! [%d] [%d]\n",
ea2453d5	225	__func__, dfu->i_blk_seq_num, blk_seq_num);
3ee9593f	226	dfu_write_transaction_cleanup(dfu);
f22b11c1 ŁM	227	return -1;
	228	}
	229
ea2453d5 PA	230	/* DFU 1.1 standard says:
	231	* The wBlockNum field is a block sequence number. It increments each
	232	* time a block is transferred, wrapping to zero from 65,535. It is used
	233	* to provide useful context to the DFU loader in the device."
	234	*
	235	* This means that it's a 16 bit counter that roll-overs at
	236	* 0xffff -> 0x0000. By having a typical 4K transfer block
	237	* we roll-over at exactly 256MB. Not very fun to debug.
	238	*
	239	* Handling rollover, and having an inited variable,
	240	* makes things work.
	241	*/
	242
	243	/* handle rollover */
	244	dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
	245
	246	/* flush buffer if overflow */
	247	if ((dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f SW	248	ret = dfu_write_buffer_drain(dfu);
	249	if (ret) {
	250	dfu_write_transaction_cleanup(dfu);
	251	return ret;
	252	}
ea2453d5	253	}
f22b11c1	254
ea2453d5 PA	255	/* we should be in buffer now (if not then size too large) */
ea2453d5 PA	256	if ((dfu->i_buf + size) > dfu->i_buf_end) {
a7d2c3cd ŁM	257	error("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
a7d2c3cd ŁM	258	size, dfu->i_buf_end);
3ee9593f	259	dfu_write_transaction_cleanup(dfu);
ea2453d5 PA	260	return -1;
	261	}
	262
	263	memcpy(dfu->i_buf, buf, size);
	264	dfu->i_buf += size;
	265
	266	/* if end or if buffer full flush */
	267	if (size == 0 \|\| (dfu->i_buf + size) > dfu->i_buf_end) {
3ee9593f SW	268	ret = dfu_write_buffer_drain(dfu);
	269	if (ret) {
	270	dfu_write_transaction_cleanup(dfu);
	271	return ret;
	272	}
ea2453d5 PA	273	}
ea2453d5 PA	274
3ee9593f	275	return 0;
ea2453d5 PA	276	}
	277
	278	static int dfu_read_buffer_fill(struct dfu_entity dfu, void buf, int size)
	279	{
	280	long chunk;
	281	int ret, readn;
	282
	283	readn = 0;
	284	while (size > 0) {
	285	/* get chunk that can be read */
b4141195	286	chunk = min((long)size, dfu->b_left);
ea2453d5 PA	287	/* consume */
	288	if (chunk > 0) {
	289	memcpy(buf, dfu->i_buf, chunk);
bd694244 ŁM	290	if (dfu_hash_algo)
	291	dfu_hash_algo->hash_update(dfu_hash_algo,
	292	&dfu->crc, buf,
	293	chunk, 0);
	294
ea2453d5 PA	295	dfu->i_buf += chunk;
	296	dfu->b_left -= chunk;
	297	size -= chunk;
	298	buf += chunk;
	299	readn += chunk;
	300	}
	301
	302	/* all done */
	303	if (size > 0) {
	304	/* no more to read */
	305	if (dfu->r_left == 0)
	306	break;
	307
	308	dfu->i_buf = dfu->i_buf_start;
	309	dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
	310
	311	/* got to read, but buffer is empty */
	312	if (dfu->b_left > dfu->r_left)
	313	dfu->b_left = dfu->r_left;
	314	ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
	315	&dfu->b_left);
	316	if (ret != 0) {
	317	debug("%s: Read error!\n", __func__);
	318	return ret;
	319	}
	320	dfu->offset += dfu->b_left;
	321	dfu->r_left -= dfu->b_left;
	322
	323	puts("#");
	324	}
	325	}
	326
	327	return readn;
f22b11c1 ŁM	328	}
	329
	330	int dfu_read(struct dfu_entity dfu, void buf, int size, int blk_seq_num)
	331	{
f22b11c1 ŁM	332	int ret = 0;
	333
	334	debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
ea2453d5 PA	335	__func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
	336
	337	if (!dfu->inited) {
7ac1b410	338	dfu->i_buf_start = dfu_get_buf(dfu);
9df49553 ŁM	339	if (dfu->i_buf_start == NULL)
	340	return -ENOMEM;
	341
4de51201 PD	342	ret = dfu->get_medium_size(dfu, &dfu->r_left);
	343	if (ret < 0)
	344	return ret;
ea2453d5	345
15970d87	346	debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
ea2453d5 PA	347
	348	dfu->i_blk_seq_num = 0;
	349	dfu->crc = 0;
	350	dfu->offset = 0;
7ac1b410	351	dfu->i_buf_end = dfu_get_buf(dfu) + dfu_buf_size;
ea2453d5	352	dfu->i_buf = dfu->i_buf_start;
0e285b50	353	dfu->b_left = 0;
ea2453d5	354
c6631764 PA	355	dfu->bad_skip = 0;
c6631764 PA	356
ea2453d5	357	dfu->inited = 1;
f22b11c1 ŁM	358	}
f22b11c1 ŁM	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");
	379
	380	dfu->i_blk_seq_num = 0;
	381	dfu->crc = 0;
	382	dfu->offset = 0;
	383	dfu->i_buf_start = dfu_buf;
e7e75c70	384	dfu->i_buf_end = dfu_buf;
ea2453d5 PA	385	dfu->i_buf = dfu->i_buf_start;
	386	dfu->b_left = 0;
	387
c6631764 PA	388	dfu->bad_skip = 0;
c6631764 PA	389
ea2453d5 PA	390	dfu->inited = 0;
	391	}
	392
f22b11c1 ŁM	393	return ret;
	394	}
	395
	396	static int dfu_fill_entity(struct dfu_entity dfu, char s, int alt,
dd64827e	397	char interface, char devstr)
f22b11c1 ŁM	398	{
	399	char *st;
	400
dd64827e	401	debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
f22b11c1 ŁM	402	st = strsep(&s, " ");
	403	strcpy(dfu->name, st);
	404
f22b11c1	405	dfu->alt = alt;
7ac1b410	406	dfu->max_buf_size = 0;
cb7bd2e0	407	dfu->free_entity = NULL;
f22b11c1 ŁM	408
	409	/* Specific for mmc device */
	410	if (strcmp(interface, "mmc") == 0) {
dd64827e	411	if (dfu_fill_entity_mmc(dfu, devstr, s))
f22b11c1	412	return -1;
c6631764	413	} else if (strcmp(interface, "nand") == 0) {
dd64827e	414	if (dfu_fill_entity_nand(dfu, devstr, s))
c6631764	415	return -1;
a9479f04	416	} else if (strcmp(interface, "ram") == 0) {
dd64827e	417	if (dfu_fill_entity_ram(dfu, devstr, s))
a9479f04	418	return -1;
6f12ebf6 SW	419	} else if (strcmp(interface, "sf") == 0) {
	420	if (dfu_fill_entity_sf(dfu, devstr, s))
	421	return -1;
f22b11c1 ŁM	422	} else {
	423	printf("%s: Device %s not (yet) supported!\n",
	424	__func__, interface);
	425	return -1;
	426	}
806bd245	427	dfu_get_buf(dfu);
f22b11c1 ŁM	428
	429	return 0;
	430	}
	431
	432	void dfu_free_entities(void)
	433	{
	434	struct dfu_entity dfu, p, *t = NULL;
	435
806bd245	436	dfu_free_buf();
f22b11c1 ŁM	437	list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
f22b11c1 ŁM	438	list_del(&dfu->list);
cb7bd2e0 SW	439	if (dfu->free_entity)
cb7bd2e0 SW	440	dfu->free_entity(dfu);
f22b11c1 ŁM	441	t = dfu;
	442	}
	443	if (t)
	444	free(t);
	445	INIT_LIST_HEAD(&dfu_list);
b627eb46 PM	446
b627eb46 PM	447	alt_num_cnt = 0;
f22b11c1 ŁM	448	}
f22b11c1 ŁM	449
dd64827e	450	int dfu_config_entities(char env, char interface, char *devstr)
f22b11c1 ŁM	451	{
	452	struct dfu_entity *dfu;
	453	int i, ret;
	454	char *s;
	455
	456	dfu_alt_num = dfu_find_alt_num(env);
	457	debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
	458
bd694244 ŁM	459	dfu_hash_algo = NULL;
	460	s = dfu_get_hash_algo();
	461	if (s) {
	462	ret = hash_lookup_algo(s, &dfu_hash_algo);
	463	if (ret)
	464	error("Hash algorithm %s not supported\n", s);
	465	}
	466
f22b11c1 ŁM	467	dfu = calloc(sizeof(*dfu), dfu_alt_num);
	468	if (!dfu)
	469	return -1;
	470	for (i = 0; i < dfu_alt_num; i++) {
	471
	472	s = strsep(&env, ";");
dd64827e SW	473	ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
dd64827e SW	474	devstr);
5d8fae79 PF	475	if (ret) {
5d8fae79 PF	476	free(dfu);
f22b11c1	477	return -1;
5d8fae79	478	}
f22b11c1 ŁM	479
f22b11c1 ŁM	480	list_add_tail(&dfu[i].list, &dfu_list);
b627eb46	481	alt_num_cnt++;
f22b11c1 ŁM	482	}
	483
	484	return 0;
	485	}
	486
	487	const char *dfu_get_dev_type(enum dfu_device_type t)
	488	{
dd93a8e9	489	const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM", "SF" };
f22b11c1 ŁM	490	return dev_t[t];
	491	}
	492
	493	const char *dfu_get_layout(enum dfu_layout l)
	494	{
	495	const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
a9479f04	496	"EXT3", "EXT4", "RAM_ADDR" };
f22b11c1 ŁM	497	return dfu_layout[l];
	498	}
	499
	500	void dfu_show_entities(void)
	501	{
	502	struct dfu_entity *dfu;
	503
	504	puts("DFU alt settings list:\n");
	505
	506	list_for_each_entry(dfu, &dfu_list, list) {
	507	printf("dev: %s alt: %d name: %s layout: %s\n",
	508	dfu_get_dev_type(dfu->dev_type), dfu->alt,
	509	dfu->name, dfu_get_layout(dfu->layout));
	510	}
	511	}
	512
	513	int dfu_get_alt_number(void)
	514	{
	515	return dfu_alt_num;
	516	}
	517
	518	struct dfu_entity *dfu_get_entity(int alt)
	519	{
	520	struct dfu_entity *dfu;
	521
	522	list_for_each_entry(dfu, &dfu_list, list) {
	523	if (dfu->alt == alt)
	524	return dfu;
	525	}
	526
	527	return NULL;
	528	}
fed936ed ŁM	529
	530	int dfu_get_alt(char *name)
	531	{
	532	struct dfu_entity *dfu;
5610b057	533	char *str;
fed936ed ŁM	534
fed936ed ŁM	535	list_for_each_entry(dfu, &dfu_list, list) {
5610b057 ŁM	536	if (dfu->name[0] != '/') {
	537	if (!strncmp(dfu->name, name, strlen(dfu->name)))
	538	return dfu->alt;
	539	} else {
	540	/*
	541	* One must also consider absolute path
	542	* (/boot/bin/uImage) available at dfu->name when
	543	* compared "plain" file name (uImage)
	544	*
	545	* It is the case for e.g. thor gadget where lthor SW
	546	* sends only the file name, so only the very last part
	547	* of path must be checked for equality
	548	*/
	549
	550	str = strstr(dfu->name, name);
	551	if (!str)
	552	continue;
	553
	554	/*
	555	* Check if matching substring is the last element of
	556	* dfu->name (uImage)
	557	*/
	558	if (strlen(dfu->name) ==
	559	((str - dfu->name) + strlen(name)))
	560	return dfu->alt;
	561	}
fed936ed ŁM	562	}
	563
	564	return -ENODEV;
	565	}
2092e461 LM	566
	567	int dfu_write_from_mem_addr(struct dfu_entity dfu, void buf, int size)
	568	{
	569	unsigned long dfu_buf_size, write, left = size;
	570	int i, ret = 0;
	571	void *dp = buf;
	572
	573	/*
	574	* Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
	575	* has been properly initialized - e.g. if "dfu_bufsiz" has been taken
	576	* into account.
	577	*/
	578	dfu_get_buf(dfu);
	579	dfu_buf_size = dfu_get_buf_size();
	580	debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
	581
	582	for (i = 0; left > 0; i++) {
	583	write = min(dfu_buf_size, left);
	584
	585	debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
	586	dp, left, write);
	587	ret = dfu_write(dfu, dp, write, i);
	588	if (ret) {
	589	error("DFU write failed\n");
	590	return ret;
	591	}
	592
	593	dp += write;
	594	left -= write;
	595	}
	596
	597	ret = dfu_flush(dfu, NULL, 0, i);
	598	if (ret)
	599	error("DFU flush failed!");
	600
	601	return ret;
	602	}