[people/ms/u-boot.git] / common / update.c

/*
 * (C) Copyright 2008 Semihalf
 *
 * Written by: Rafal Czubak <rcz@semihalf.com>
 *             Bartlomiej Sieka <tur@semihalf.com>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>

#if !(defined(CONFIG_FIT) && defined(CONFIG_OF_LIBFDT))
#error "CONFIG_FIT and CONFIG_OF_LIBFDT are required for auto-update feature"
#endif

#if defined(CONFIG_UPDATE_TFTP) && !defined(CONFIG_MTD_NOR_FLASH)
#error "CONFIG_UPDATE_TFTP and !CONFIG_MTD_NOR_FLASH needed for legacy behaviour"
#endif

#include <command.h>
#include <flash.h>
#include <net.h>
#include <net/tftp.h>
#include <malloc.h>
#include <dfu.h>
#include <errno.h>

/* env variable holding the location of the update file */
#define UPDATE_FILE_ENV		"updatefile"

/* set configuration defaults if needed */
#ifndef CONFIG_UPDATE_LOAD_ADDR
#define CONFIG_UPDATE_LOAD_ADDR	0x100000
#endif

#ifndef CONFIG_UPDATE_TFTP_MSEC_MAX
#define CONFIG_UPDATE_TFTP_MSEC_MAX	100
#endif

#ifndef CONFIG_UPDATE_TFTP_CNT_MAX
#define CONFIG_UPDATE_TFTP_CNT_MAX	0
#endif

extern ulong tftp_timeout_ms;
extern int tftp_timeout_count_max;
extern ulong load_addr;
#ifdef CONFIG_MTD_NOR_FLASH
extern flash_info_t flash_info[];
static uchar *saved_prot_info;
#endif
static int update_load(char *filename, ulong msec_max, int cnt_max, ulong addr)
{
	int size, rv;
	ulong saved_timeout_msecs;
	int saved_timeout_count;
	char *saved_netretry, *saved_bootfile;

	rv = 0;
	/* save used globals and env variable */
	saved_timeout_msecs = tftp_timeout_ms;
	saved_timeout_count = tftp_timeout_count_max;
	saved_netretry = strdup(getenv("netretry"));
	saved_bootfile = strdup(net_boot_file_name);

	/* set timeouts for auto-update */
	tftp_timeout_ms = msec_max;
	tftp_timeout_count_max = cnt_max;

	/* we don't want to retry the connection if errors occur */
	setenv("netretry", "no");

	/* download the update file */
	load_addr = addr;
	copy_filename(net_boot_file_name, filename, sizeof(net_boot_file_name));
	size = net_loop(TFTPGET);

	if (size < 0)
		rv = 1;
	else if (size > 0)
		flush_cache(addr, size);

	/* restore changed globals and env variable */
	tftp_timeout_ms = saved_timeout_msecs;
	tftp_timeout_count_max = saved_timeout_count;

	setenv("netretry", saved_netretry);
	if (saved_netretry != NULL)
		free(saved_netretry);

	if (saved_bootfile != NULL) {
		copy_filename(net_boot_file_name, saved_bootfile,
			      sizeof(net_boot_file_name));
		free(saved_bootfile);
	}

	return rv;
}

#ifdef CONFIG_MTD_NOR_FLASH
static int update_flash_protect(int prot, ulong addr_first, ulong addr_last)
{
	uchar *sp_info_ptr;
	ulong s;
	int i, bank, cnt;
	flash_info_t *info;

	sp_info_ptr = NULL;

	if (prot == 0) {
		saved_prot_info =
			calloc(CONFIG_SYS_MAX_FLASH_BANKS * CONFIG_SYS_MAX_FLASH_SECT, 1);
		if (!saved_prot_info)
			return 1;
	}

	for (bank = 0; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
		cnt = 0;
		info = &flash_info[bank];

		/* Nothing to do if the bank doesn't exist */
		if (info->sector_count == 0)
			return 0;

		/* Point to current bank protection information */
		sp_info_ptr = saved_prot_info + (bank * CONFIG_SYS_MAX_FLASH_SECT);

		/*
		 * Adjust addr_first or addr_last if we are on bank boundary.
		 * Address space between banks must be continuous for other
		 * flash functions (like flash_sect_erase or flash_write) to
		 * succeed. Banks must also be numbered in correct order,
		 * according to increasing addresses.
		 */
		if (addr_last > info->start[0] + info->size - 1)
			addr_last = info->start[0] + info->size - 1;
		if (addr_first < info->start[0])
			addr_first = info->start[0];

		for (i = 0; i < info->sector_count; i++) {
			/* Save current information about protected sectors */
			if (prot == 0) {
				s = info->start[i];
				if ((s >= addr_first) && (s <= addr_last))
					sp_info_ptr[i] = info->protect[i];

			}

			/* Protect/unprotect sectors */
			if (sp_info_ptr[i] == 1) {
#if defined(CONFIG_SYS_FLASH_PROTECTION)
				if (flash_real_protect(info, i, prot))
					return 1;
#else
				info->protect[i] = prot;
#endif
				cnt++;
			}
		}

		if (cnt) {
			printf("%sProtected %d sectors\n",
						prot ? "": "Un-", cnt);
		}
	}

	if((prot == 1) && saved_prot_info)
		free(saved_prot_info);

	return 0;
}
#endif

static int update_flash(ulong addr_source, ulong addr_first, ulong size)
{
#ifdef CONFIG_MTD_NOR_FLASH
	ulong addr_last = addr_first + size - 1;

	/* round last address to the sector boundary */
	if (flash_sect_roundb(&addr_last) > 0)
		return 1;

	if (addr_first >= addr_last) {
		printf("Error: end address exceeds addressing space\n");
		return 1;
	}

	/* remove protection on processed sectors */
	if (update_flash_protect(0, addr_first, addr_last) > 0) {
		printf("Error: could not unprotect flash sectors\n");
		return 1;
	}

	printf("Erasing 0x%08lx - 0x%08lx", addr_first, addr_last);
	if (flash_sect_erase(addr_first, addr_last) > 0) {
		printf("Error: could not erase flash\n");
		return 1;
	}

	printf("Copying to flash...");
	if (flash_write((char *)addr_source, addr_first, size) > 0) {
		printf("Error: could not copy to flash\n");
		return 1;
	}
	printf("done\n");

	/* enable protection on processed sectors */
	if (update_flash_protect(1, addr_first, addr_last) > 0) {
		printf("Error: could not protect flash sectors\n");
		return 1;
	}
#endif
	return 0;
}

static int update_fit_getparams(const void *fit, int noffset, ulong *addr,
						ulong *fladdr, ulong *size)
{
	const void *data;

	if (fit_image_get_data(fit, noffset, &data, (size_t *)size))
		return 1;

	if (fit_image_get_load(fit, noffset, (ulong *)fladdr))
		return 1;

	*addr = (ulong)data;

	return 0;
}

int update_tftp(ulong addr, char *interface, char *devstring)
{
	char *filename, *env_addr, *fit_image_name;
	ulong update_addr, update_fladdr, update_size;
	int images_noffset, ndepth, noffset;
	bool update_tftp_dfu;
	int ret = 0;
	void *fit;

	if (interface == NULL && devstring == NULL) {
		update_tftp_dfu = false;
	} else if (interface && devstring) {
		update_tftp_dfu = true;
	} else {
		error("Interface: %s and devstring: %s not supported!\n",
		      interface, devstring);
		return -EINVAL;
	}

	/* use already present image */
	if (addr)
		goto got_update_file;

	printf("Auto-update from TFTP: ");

	/* get the file name of the update file */
	filename = getenv(UPDATE_FILE_ENV);
	if (filename == NULL) {
		printf("failed, env. variable '%s' not found\n",
							UPDATE_FILE_ENV);
		return 1;
	}

	printf("trying update file '%s'\n", filename);

	/* get load address of downloaded update file */
	if ((env_addr = getenv("loadaddr")) != NULL)
		addr = simple_strtoul(env_addr, NULL, 16);
	else
		addr = CONFIG_UPDATE_LOAD_ADDR;


	if (update_load(filename, CONFIG_UPDATE_TFTP_MSEC_MAX,
					CONFIG_UPDATE_TFTP_CNT_MAX, addr)) {
		printf("Can't load update file, aborting auto-update\n");
		return 1;
	}

got_update_file:
	fit = (void *)addr;

	if (!fit_check_format((void *)fit)) {
		printf("Bad FIT format of the update file, aborting "
							"auto-update\n");
		return 1;
	}

	/* process updates */
	images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);

	ndepth = 0;
	noffset = fdt_next_node(fit, images_noffset, &ndepth);
	while (noffset >= 0 && ndepth > 0) {
		if (ndepth != 1)
			goto next_node;

		fit_image_name = (char *)fit_get_name(fit, noffset, NULL);
		printf("Processing update '%s' :", fit_image_name);

		if (!fit_image_verify(fit, noffset)) {
			printf("Error: invalid update hash, aborting\n");
			ret = 1;
			goto next_node;
		}

		printf("\n");
		if (update_fit_getparams(fit, noffset, &update_addr,
					&update_fladdr, &update_size)) {
			printf("Error: can't get update parameteres, "
								"aborting\n");
			ret = 1;
			goto next_node;
		}

		if (!update_tftp_dfu) {
			if (update_flash(update_addr, update_fladdr,
					 update_size)) {
				printf("Error: can't flash update, aborting\n");
				ret = 1;
				goto next_node;
			}
		} else if (fit_image_check_type(fit, noffset,
						IH_TYPE_FIRMWARE)) {
			ret = dfu_tftp_write(fit_image_name, update_addr,
					     update_size, interface, devstring);
			if (ret)
				return ret;
		}
next_node:
		noffset = fdt_next_node(fit, noffset, &ndepth);
	}

	return ret;
}
Commit	Line	Data
4bae9090 BS	1	/*
	2	* (C) Copyright 2008 Semihalf
	3	*
	4	* Written by: Rafal Czubak <rcz@semihalf.com>
	5	* Bartlomiej Sieka <tur@semihalf.com>
	6	*
1a459660	7	* SPDX-License-Identifier: GPL-2.0+
4bae9090 BS	8	*/
	9
	10	#include <common.h>
	11
	12	#if !(defined(CONFIG_FIT) && defined(CONFIG_OF_LIBFDT))
	13	#error "CONFIG_FIT and CONFIG_OF_LIBFDT are required for auto-update feature"
	14	#endif
	15
e856bdcf MY	16	#if defined(CONFIG_UPDATE_TFTP) && !defined(CONFIG_MTD_NOR_FLASH)
e856bdcf MY	17	#error "CONFIG_UPDATE_TFTP and !CONFIG_MTD_NOR_FLASH needed for legacy behaviour"
c7ff5528 LM	18	#endif
c7ff5528 LM	19
4bae9090 BS	20	#include <command.h>
	21	#include <flash.h>
	22	#include <net.h>
06370590	23	#include <net/tftp.h>
4bae9090	24	#include <malloc.h>
c7ff5528 LM	25	#include <dfu.h>
c7ff5528 LM	26	#include <errno.h>
4bae9090 BS	27
	28	/* env variable holding the location of the update file */
	29	#define UPDATE_FILE_ENV "updatefile"
	30
	31	/* set configuration defaults if needed */
	32	#ifndef CONFIG_UPDATE_LOAD_ADDR
	33	#define CONFIG_UPDATE_LOAD_ADDR 0x100000
	34	#endif
	35
	36	#ifndef CONFIG_UPDATE_TFTP_MSEC_MAX
	37	#define CONFIG_UPDATE_TFTP_MSEC_MAX 100
	38	#endif
	39
	40	#ifndef CONFIG_UPDATE_TFTP_CNT_MAX
	41	#define CONFIG_UPDATE_TFTP_CNT_MAX 0
	42	#endif
	43
8885c5fe JH	44	extern ulong tftp_timeout_ms;
8885c5fe JH	45	extern int tftp_timeout_count_max;
4bae9090	46	extern ulong load_addr;
e856bdcf	47	#ifdef CONFIG_MTD_NOR_FLASH
66a64723	48	extern flash_info_t flash_info[];
4bae9090	49	static uchar *saved_prot_info;
66a64723	50	#endif
4bae9090 BS	51	static int update_load(char *filename, ulong msec_max, int cnt_max, ulong addr)
	52	{
	53	int size, rv;
	54	ulong saved_timeout_msecs;
	55	int saved_timeout_count;
	56	char saved_netretry, saved_bootfile;
	57
	58	rv = 0;
	59	/* save used globals and env variable */
8885c5fe JH	60	saved_timeout_msecs = tftp_timeout_ms;
8885c5fe JH	61	saved_timeout_count = tftp_timeout_count_max;
4bae9090	62	saved_netretry = strdup(getenv("netretry"));
1411157d	63	saved_bootfile = strdup(net_boot_file_name);
4bae9090 BS	64
4bae9090 BS	65	/* set timeouts for auto-update */
8885c5fe JH	66	tftp_timeout_ms = msec_max;
8885c5fe JH	67	tftp_timeout_count_max = cnt_max;
4bae9090 BS	68
	69	/* we don't want to retry the connection if errors occur */
	70	setenv("netretry", "no");
	71
	72	/* download the update file */
	73	load_addr = addr;
1411157d	74	copy_filename(net_boot_file_name, filename, sizeof(net_boot_file_name));
bc0571fc	75	size = net_loop(TFTPGET);
4bae9090 BS	76
	77	if (size < 0)
	78	rv = 1;
	79	else if (size > 0)
	80	flush_cache(addr, size);
	81
	82	/* restore changed globals and env variable */
8885c5fe JH	83	tftp_timeout_ms = saved_timeout_msecs;
8885c5fe JH	84	tftp_timeout_count_max = saved_timeout_count;
4bae9090 BS	85
	86	setenv("netretry", saved_netretry);
	87	if (saved_netretry != NULL)
	88	free(saved_netretry);
	89
	90	if (saved_bootfile != NULL) {
1411157d JH	91	copy_filename(net_boot_file_name, saved_bootfile,
1411157d JH	92	sizeof(net_boot_file_name));
4bae9090 BS	93	free(saved_bootfile);
	94	}
	95
	96	return rv;
	97	}
	98
e856bdcf	99	#ifdef CONFIG_MTD_NOR_FLASH
4bae9090 BS	100	static int update_flash_protect(int prot, ulong addr_first, ulong addr_last)
	101	{
	102	uchar *sp_info_ptr;
	103	ulong s;
	104	int i, bank, cnt;
	105	flash_info_t *info;
	106
	107	sp_info_ptr = NULL;
	108
	109	if (prot == 0) {
	110	saved_prot_info =
6d0f6bcf	111	calloc(CONFIG_SYS_MAX_FLASH_BANKS * CONFIG_SYS_MAX_FLASH_SECT, 1);
4bae9090 BS	112	if (!saved_prot_info)
	113	return 1;
	114	}
	115
6d0f6bcf	116	for (bank = 0; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
4bae9090 BS	117	cnt = 0;
	118	info = &flash_info[bank];
	119
	120	/* Nothing to do if the bank doesn't exist */
	121	if (info->sector_count == 0)
	122	return 0;
	123
	124	/* Point to current bank protection information */
6d0f6bcf	125	sp_info_ptr = saved_prot_info + (bank * CONFIG_SYS_MAX_FLASH_SECT);
4bae9090 BS	126
	127	/*
	128	* Adjust addr_first or addr_last if we are on bank boundary.
	129	* Address space between banks must be continuous for other
	130	* flash functions (like flash_sect_erase or flash_write) to
	131	* succeed. Banks must also be numbered in correct order,
	132	* according to increasing addresses.
	133	*/
	134	if (addr_last > info->start[0] + info->size - 1)
	135	addr_last = info->start[0] + info->size - 1;
	136	if (addr_first < info->start[0])
	137	addr_first = info->start[0];
	138
	139	for (i = 0; i < info->sector_count; i++) {
	140	/* Save current information about protected sectors */
	141	if (prot == 0) {
	142	s = info->start[i];
	143	if ((s >= addr_first) && (s <= addr_last))
	144	sp_info_ptr[i] = info->protect[i];
	145
	146	}
	147
	148	/* Protect/unprotect sectors */
	149	if (sp_info_ptr[i] == 1) {
6d0f6bcf	150	#if defined(CONFIG_SYS_FLASH_PROTECTION)
4bae9090 BS	151	if (flash_real_protect(info, i, prot))
	152	return 1;
	153	#else
	154	info->protect[i] = prot;
	155	#endif
	156	cnt++;
	157	}
	158	}
	159
	160	if (cnt) {
	161	printf("%sProtected %d sectors\n",
	162	prot ? "": "Un-", cnt);
	163	}
	164	}
	165
	166	if((prot == 1) && saved_prot_info)
	167	free(saved_prot_info);
	168
	169	return 0;
	170	}
66a64723	171	#endif
4bae9090 BS	172
	173	static int update_flash(ulong addr_source, ulong addr_first, ulong size)
	174	{
e856bdcf	175	#ifdef CONFIG_MTD_NOR_FLASH
4bae9090 BS	176	ulong addr_last = addr_first + size - 1;
	177
	178	/* round last address to the sector boundary */
	179	if (flash_sect_roundb(&addr_last) > 0)
	180	return 1;
	181
	182	if (addr_first >= addr_last) {
	183	printf("Error: end address exceeds addressing space\n");
	184	return 1;
	185	}
	186
	187	/* remove protection on processed sectors */
	188	if (update_flash_protect(0, addr_first, addr_last) > 0) {
	189	printf("Error: could not unprotect flash sectors\n");
	190	return 1;
	191	}
	192
	193	printf("Erasing 0x%08lx - 0x%08lx", addr_first, addr_last);
	194	if (flash_sect_erase(addr_first, addr_last) > 0) {
	195	printf("Error: could not erase flash\n");
	196	return 1;
	197	}
	198
	199	printf("Copying to flash...");
	200	if (flash_write((char *)addr_source, addr_first, size) > 0) {
	201	printf("Error: could not copy to flash\n");
	202	return 1;
	203	}
	204	printf("done\n");
	205
	206	/* enable protection on processed sectors */
	207	if (update_flash_protect(1, addr_first, addr_last) > 0) {
	208	printf("Error: could not protect flash sectors\n");
	209	return 1;
	210	}
66a64723	211	#endif
4bae9090 BS	212	return 0;
	213	}
	214
	215	static int update_fit_getparams(const void fit, int noffset, ulong addr,
	216	ulong fladdr, ulong size)
	217	{
	218	const void *data;
	219
	220	if (fit_image_get_data(fit, noffset, &data, (size_t *)size))
	221	return 1;
	222
	223	if (fit_image_get_load(fit, noffset, (ulong *)fladdr))
	224	return 1;
	225
	226	*addr = (ulong)data;
	227
	228	return 0;
	229	}
	230
c7ff5528	231	int update_tftp(ulong addr, char interface, char devstring)
4bae9090	232	{
c7ff5528	233	char filename, env_addr, *fit_image_name;
4bae9090	234	ulong update_addr, update_fladdr, update_size;
c7ff5528 LM	235	int images_noffset, ndepth, noffset;
c7ff5528 LM	236	bool update_tftp_dfu;
8d6b7320	237	int ret = 0;
c7ff5528 LM	238	void *fit;
	239
	240	if (interface == NULL && devstring == NULL) {
	241	update_tftp_dfu = false;
	242	} else if (interface && devstring) {
	243	update_tftp_dfu = true;
	244	} else {
	245	error("Interface: %s and devstring: %s not supported!\n",
	246	interface, devstring);
	247	return -EINVAL;
	248	}
8d6b7320 AP	249
	250	/* use already present image */
	251	if (addr)
	252	goto got_update_file;
4bae9090 BS	253
	254	printf("Auto-update from TFTP: ");
	255
	256	/* get the file name of the update file */
	257	filename = getenv(UPDATE_FILE_ENV);
	258	if (filename == NULL) {
	259	printf("failed, env. variable '%s' not found\n",
	260	UPDATE_FILE_ENV);
8d6b7320	261	return 1;
4bae9090 BS	262	}
	263
	264	printf("trying update file '%s'\n", filename);
	265
	266	/* get load address of downloaded update file */
	267	if ((env_addr = getenv("loadaddr")) != NULL)
	268	addr = simple_strtoul(env_addr, NULL, 16);
	269	else
	270	addr = CONFIG_UPDATE_LOAD_ADDR;
	271
	272
	273	if (update_load(filename, CONFIG_UPDATE_TFTP_MSEC_MAX,
	274	CONFIG_UPDATE_TFTP_CNT_MAX, addr)) {
	275	printf("Can't load update file, aborting auto-update\n");
8d6b7320	276	return 1;
4bae9090 BS	277	}
4bae9090 BS	278
8d6b7320	279	got_update_file:
4bae9090 BS	280	fit = (void *)addr;
	281
	282	if (!fit_check_format((void *)fit)) {
	283	printf("Bad FIT format of the update file, aborting "
	284	"auto-update\n");
8d6b7320	285	return 1;
4bae9090 BS	286	}
	287
	288	/* process updates */
	289	images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
	290
	291	ndepth = 0;
	292	noffset = fdt_next_node(fit, images_noffset, &ndepth);
	293	while (noffset >= 0 && ndepth > 0) {
	294	if (ndepth != 1)
	295	goto next_node;
	296
c7ff5528 LM	297	fit_image_name = (char *)fit_get_name(fit, noffset, NULL);
c7ff5528 LM	298	printf("Processing update '%s' :", fit_image_name);
4bae9090	299
b8da8366	300	if (!fit_image_verify(fit, noffset)) {
4bae9090	301	printf("Error: invalid update hash, aborting\n");
8d6b7320	302	ret = 1;
4bae9090 BS	303	goto next_node;
	304	}
	305
	306	printf("\n");
	307	if (update_fit_getparams(fit, noffset, &update_addr,
	308	&update_fladdr, &update_size)) {
	309	printf("Error: can't get update parameteres, "
	310	"aborting\n");
8d6b7320	311	ret = 1;
4bae9090 BS	312	goto next_node;
4bae9090 BS	313	}
c7ff5528 LM	314
	315	if (!update_tftp_dfu) {
	316	if (update_flash(update_addr, update_fladdr,
	317	update_size)) {
	318	printf("Error: can't flash update, aborting\n");
	319	ret = 1;
	320	goto next_node;
	321	}
	322	} else if (fit_image_check_type(fit, noffset,
	323	IH_TYPE_FIRMWARE)) {
	324	ret = dfu_tftp_write(fit_image_name, update_addr,
	325	update_size, interface, devstring);
	326	if (ret)
	327	return ret;
4bae9090 BS	328	}
	329	next_node:
	330	noffset = fdt_next_node(fit, noffset, &ndepth);
	331	}
	332
8d6b7320	333	return ret;
4bae9090	334	}