[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)
{
	return true;
}

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;

		dfu->r_left = dfu->get_medium_size(dfu);
		if (dfu->r_left < 0)
			return dfu->r_left;

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