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

/*
 * (C) Copyright 2008 Semihalf
 *
 * Written by: Rafal Czubak <rcz@semihalf.com>
 *             Bartlomiej Sieka <tur@semihalf.com>
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */

#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_SYS_NO_FLASH)
#error "CONFIG_SYS_NO_FLASH defined, but FLASH is required for auto-update feature"
#endif

#include <command.h>
#include <flash.h>
#include <net.h>
#include <net/tftp.h>
#include <malloc.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 TftpRRQTimeoutMSecs;
extern int TftpRRQTimeoutCountMax;
extern flash_info_t flash_info[];
extern ulong load_addr;

static uchar *saved_prot_info;

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 = TftpRRQTimeoutMSecs;
	saved_timeout_count = TftpRRQTimeoutCountMax;
	saved_netretry = strdup(getenv("netretry"));
	saved_bootfile = strdup(BootFile);

	/* set timeouts for auto-update */
	TftpRRQTimeoutMSecs = msec_max;
	TftpRRQTimeoutCountMax = 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(BootFile, filename, sizeof(BootFile));
	size = NetLoop(TFTPGET);

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

	/* restore changed globals and env variable */
	TftpRRQTimeoutMSecs = saved_timeout_msecs;
	TftpRRQTimeoutCountMax = saved_timeout_count;

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

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

	return rv;
}

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;
}

static int update_flash(ulong addr_source, ulong addr_first, ulong size)
{
	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;
	}

	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 *filename, *env_addr;
	int images_noffset, ndepth, noffset;
	ulong update_addr, update_fladdr, update_size;
	void *fit;
	int ret = 0;

	/* 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;

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

		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_flash(update_addr, update_fladdr, update_size)) {
			printf("Error: can't flash update, aborting\n");
			ret = 1;
			goto next_node;
		}
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	*
	7	* See file CREDITS for list of people who contributed to this
	8	* project.
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License as
	12	* published by the Free Software Foundation; either version 2 of
	13	* the License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	23	* MA 02111-1307 USA
	24	*
	25	*/
	26
	27	#include <common.h>
	28
	29	#if !(defined(CONFIG_FIT) && defined(CONFIG_OF_LIBFDT))
	30	#error "CONFIG_FIT and CONFIG_OF_LIBFDT are required for auto-update feature"
	31	#endif
	32
6d0f6bcf JCPV	33	#if defined(CONFIG_SYS_NO_FLASH)
6d0f6bcf JCPV	34	#error "CONFIG_SYS_NO_FLASH defined, but FLASH is required for auto-update feature"
4bae9090 BS	35	#endif
	36
	37	#include <command.h>
	38	#include <flash.h>
	39	#include <net.h>
06370590	40	#include <net/tftp.h>
4bae9090 BS	41	#include <malloc.h>
	42
	43	/* env variable holding the location of the update file */
	44	#define UPDATE_FILE_ENV "updatefile"
	45
	46	/* set configuration defaults if needed */
	47	#ifndef CONFIG_UPDATE_LOAD_ADDR
	48	#define CONFIG_UPDATE_LOAD_ADDR 0x100000
	49	#endif
	50
	51	#ifndef CONFIG_UPDATE_TFTP_MSEC_MAX
	52	#define CONFIG_UPDATE_TFTP_MSEC_MAX 100
	53	#endif
	54
	55	#ifndef CONFIG_UPDATE_TFTP_CNT_MAX
	56	#define CONFIG_UPDATE_TFTP_CNT_MAX 0
	57	#endif
	58
	59	extern ulong TftpRRQTimeoutMSecs;
	60	extern int TftpRRQTimeoutCountMax;
	61	extern flash_info_t flash_info[];
	62	extern ulong load_addr;
	63
	64	static uchar *saved_prot_info;
	65
	66	static int update_load(char *filename, ulong msec_max, int cnt_max, ulong addr)
	67	{
	68	int size, rv;
	69	ulong saved_timeout_msecs;
	70	int saved_timeout_count;
	71	char saved_netretry, saved_bootfile;
	72
	73	rv = 0;
	74	/* save used globals and env variable */
	75	saved_timeout_msecs = TftpRRQTimeoutMSecs;
	76	saved_timeout_count = TftpRRQTimeoutCountMax;
	77	saved_netretry = strdup(getenv("netretry"));
	78	saved_bootfile = strdup(BootFile);
	79
	80	/* set timeouts for auto-update */
	81	TftpRRQTimeoutMSecs = msec_max;
	82	TftpRRQTimeoutCountMax = cnt_max;
	83
	84	/* we don't want to retry the connection if errors occur */
	85	setenv("netretry", "no");
	86
	87	/* download the update file */
	88	load_addr = addr;
	89	copy_filename(BootFile, filename, sizeof(BootFile));
e4bf0c5c	90	size = NetLoop(TFTPGET);
4bae9090 BS	91
	92	if (size < 0)
	93	rv = 1;
	94	else if (size > 0)
	95	flush_cache(addr, size);
	96
	97	/* restore changed globals and env variable */
	98	TftpRRQTimeoutMSecs = saved_timeout_msecs;
	99	TftpRRQTimeoutCountMax = saved_timeout_count;
	100
	101	setenv("netretry", saved_netretry);
	102	if (saved_netretry != NULL)
	103	free(saved_netretry);
	104
	105	if (saved_bootfile != NULL) {
	106	copy_filename(BootFile, saved_bootfile, sizeof(BootFile));
	107	free(saved_bootfile);
	108	}
	109
	110	return rv;
	111	}
	112
	113	static int update_flash_protect(int prot, ulong addr_first, ulong addr_last)
	114	{
	115	uchar *sp_info_ptr;
	116	ulong s;
	117	int i, bank, cnt;
	118	flash_info_t *info;
	119
	120	sp_info_ptr = NULL;
	121
	122	if (prot == 0) {
	123	saved_prot_info =
6d0f6bcf	124	calloc(CONFIG_SYS_MAX_FLASH_BANKS * CONFIG_SYS_MAX_FLASH_SECT, 1);
4bae9090 BS	125	if (!saved_prot_info)
	126	return 1;
	127	}
	128
6d0f6bcf	129	for (bank = 0; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
4bae9090 BS	130	cnt = 0;
	131	info = &flash_info[bank];
	132
	133	/* Nothing to do if the bank doesn't exist */
	134	if (info->sector_count == 0)
	135	return 0;
	136
	137	/* Point to current bank protection information */
6d0f6bcf	138	sp_info_ptr = saved_prot_info + (bank * CONFIG_SYS_MAX_FLASH_SECT);
4bae9090 BS	139
	140	/*
	141	* Adjust addr_first or addr_last if we are on bank boundary.
	142	* Address space between banks must be continuous for other
	143	* flash functions (like flash_sect_erase or flash_write) to
	144	* succeed. Banks must also be numbered in correct order,
	145	* according to increasing addresses.
	146	*/
	147	if (addr_last > info->start[0] + info->size - 1)
	148	addr_last = info->start[0] + info->size - 1;
	149	if (addr_first < info->start[0])
	150	addr_first = info->start[0];
	151
	152	for (i = 0; i < info->sector_count; i++) {
	153	/* Save current information about protected sectors */
	154	if (prot == 0) {
	155	s = info->start[i];
	156	if ((s >= addr_first) && (s <= addr_last))
	157	sp_info_ptr[i] = info->protect[i];
	158
	159	}
	160
	161	/* Protect/unprotect sectors */
	162	if (sp_info_ptr[i] == 1) {
6d0f6bcf	163	#if defined(CONFIG_SYS_FLASH_PROTECTION)
4bae9090 BS	164	if (flash_real_protect(info, i, prot))
	165	return 1;
	166	#else
	167	info->protect[i] = prot;
	168	#endif
	169	cnt++;
	170	}
	171	}
	172
	173	if (cnt) {
	174	printf("%sProtected %d sectors\n",
	175	prot ? "": "Un-", cnt);
	176	}
	177	}
	178
	179	if((prot == 1) && saved_prot_info)
	180	free(saved_prot_info);
	181
	182	return 0;
	183	}
	184
	185	static int update_flash(ulong addr_source, ulong addr_first, ulong size)
	186	{
	187	ulong addr_last = addr_first + size - 1;
	188
	189	/* round last address to the sector boundary */
	190	if (flash_sect_roundb(&addr_last) > 0)
	191	return 1;
	192
	193	if (addr_first >= addr_last) {
	194	printf("Error: end address exceeds addressing space\n");
	195	return 1;
	196	}
	197
	198	/* remove protection on processed sectors */
	199	if (update_flash_protect(0, addr_first, addr_last) > 0) {
	200	printf("Error: could not unprotect flash sectors\n");
	201	return 1;
	202	}
	203
	204	printf("Erasing 0x%08lx - 0x%08lx", addr_first, addr_last);
	205	if (flash_sect_erase(addr_first, addr_last) > 0) {
	206	printf("Error: could not erase flash\n");
	207	return 1;
	208	}
	209
	210	printf("Copying to flash...");
	211	if (flash_write((char *)addr_source, addr_first, size) > 0) {
	212	printf("Error: could not copy to flash\n");
	213	return 1;
	214	}
	215	printf("done\n");
	216
	217	/* enable protection on processed sectors */
	218	if (update_flash_protect(1, addr_first, addr_last) > 0) {
	219	printf("Error: could not protect flash sectors\n");
	220	return 1;
	221	}
	222
	223	return 0;
	224	}
	225
	226	static int update_fit_getparams(const void fit, int noffset, ulong addr,
	227	ulong fladdr, ulong size)
228	{
229	const void *data;
230
231	if (fit_image_get_data(fit, noffset, &data, (size_t *)size))
232	return 1;
233
234	if (fit_image_get_load(fit, noffset, (ulong *)fladdr))
235	return 1;
236
237	*addr = (ulong)data;
238
239	return 0;
240	}
241
8d6b7320	242	int update_tftp(ulong addr)
4bae9090 BS	243	{
	244	char filename, env_addr;
	245	int images_noffset, ndepth, noffset;
	246	ulong update_addr, update_fladdr, update_size;
4bae9090	247	void *fit;
8d6b7320 AP	248	int ret = 0;
	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
	297	printf("Processing update '%s' :",
	298	fit_get_name(fit, noffset, NULL));
	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;
	313	}
	314	if (update_flash(update_addr, update_fladdr, update_size)) {
	315	printf("Error: can't flash update, aborting\n");
8d6b7320	316	ret = 1;
4bae9090 BS	317	goto next_node;
	318	}
	319	next_node:
	320	noffset = fdt_next_node(fit, noffset, &ndepth);
	321	}
	322
8d6b7320	323	return ret;
4bae9090	324	}