[people/ms/u-boot.git] / tools / rkspi.c

/*
 * (C) Copyright 2015 Google,  Inc
 * Written by Simon Glass <sjg@chromium.org>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 *
 * See README.rockchip for details of the rkspi format
 */

#include "imagetool.h"
#include <image.h>
#include <rc4.h>
#include "mkimage.h"
#include "rkcommon.h"

enum {
	RKSPI_SECT_LEN		= RK_BLK_SIZE * 4,
};

static void rkspi_set_header(void *buf, struct stat *sbuf, int ifd,
			     struct image_tool_params *params)
{
	int sector;
	unsigned int size;
	int ret;

	size = params->orig_file_size;
	ret = rkcommon_set_header(buf, size, params);
	debug("size %x\n", size);
	if (ret) {
		/* TODO(sjg@chromium.org): This method should return an error */
		printf("Warning: SPL image is too large (size %#x) and will "
		       "not boot\n", size);
	}

	/*
	 * Spread the image out so we only use the first 2KB of each 4KB
	 * region. This is a feature of the SPI format required by the Rockchip
	 * boot ROM. Its rationale is unknown.
	 */
	for (sector = size / RKSPI_SECT_LEN - 1; sector >= 0; sector--) {
		debug("sector %u\n", sector);
		memmove(buf + sector * RKSPI_SECT_LEN * 2,
			buf + sector * RKSPI_SECT_LEN,
			RKSPI_SECT_LEN);
		memset(buf + sector * RKSPI_SECT_LEN * 2 + RKSPI_SECT_LEN,
		       '\0', RKSPI_SECT_LEN);
	}
}

static int rkspi_check_image_type(uint8_t type)
{
	if (type == IH_TYPE_RKSPI)
		return EXIT_SUCCESS;
	else
		return EXIT_FAILURE;
}

/*
 * The SPI payload needs to be padded out to make space for odd half-sector
 * layout used in flash (i.e. only the first 2K of each 4K sector is used).
 */
static int rkspi_vrec_header(struct image_tool_params *params,
			     struct image_type_params *tparams)
{
	int padding = rkcommon_vrec_header(params, tparams, RK_INIT_SIZE_ALIGN);
	/*
	 * The file size has not been adjusted at this point (our caller will
	 * eventually add the header/padding to the file_size), so we need to
	 * add up the header_size, file_size and padding ourselves.
	 */
	int padded_size = tparams->header_size + params->file_size + padding;

	/*
	 * We need to store the original file-size (i.e. before padding), as
	 * imagetool does not set this during its adjustment of file_size.
	 */
	params->orig_file_size = padded_size;

	/*
	 * Converting to the SPI format (i.e. splitting each 4K page into two
	 * 2K subpages and then padding these 2K pages up to take a complete
	 * 4K sector again) will will double the image size.
	 *
	 * Thus we return the padded_size as an additional padding requirement
	 * (be sure to add this to the padding returned from the common code).
	 */
	return padded_size + padding;
}

/*
 * rk_spi parameters
 */
U_BOOT_IMAGE_TYPE(
	rkspi,
	"Rockchip SPI Boot Image support",
	0,
	NULL,
	rkcommon_check_params,
	rkcommon_verify_header,
	rkcommon_print_header,
	rkspi_set_header,
	NULL,
	rkspi_check_image_type,
	NULL,
	rkspi_vrec_header
);
Commit	Line	Data
10b84fe1 SG	1	/*
	2	* (C) Copyright 2015 Google, Inc
	3	* Written by Simon Glass <sjg@chromium.org>
	4	*
	5	* SPDX-License-Identifier: GPL-2.0+
	6	*
	7	* See README.rockchip for details of the rkspi format
	8	*/
	9
	10	#include "imagetool.h"
	11	#include <image.h>
	12	#include <rc4.h>
	13	#include "mkimage.h"
	14	#include "rkcommon.h"
	15
	16	enum {
10b84fe1 SG	17	RKSPI_SECT_LEN = RK_BLK_SIZE * 4,
	18	};
	19
10b84fe1 SG	20	static void rkspi_set_header(void buf, struct stat sbuf, int ifd,
	21	struct image_tool_params *params)
	22	{
	23	int sector;
	24	unsigned int size;
	25	int ret;
	26
	27	size = params->orig_file_size;
7bf274b9	28	ret = rkcommon_set_header(buf, size, params);
10b84fe1 SG	29	debug("size %x\n", size);
	30	if (ret) {
	31	/* TODO(sjg@chromium.org): This method should return an error */
366aad4d PT	32	printf("Warning: SPL image is too large (size %#x) and will "
366aad4d PT	33	"not boot\n", size);
10b84fe1 SG	34	}
10b84fe1 SG	35
10b84fe1 SG	36	/*
	37	* Spread the image out so we only use the first 2KB of each 4KB
	38	* region. This is a feature of the SPI format required by the Rockchip
	39	* boot ROM. Its rationale is unknown.
	40	*/
	41	for (sector = size / RKSPI_SECT_LEN - 1; sector >= 0; sector--) {
25525ebe	42	debug("sector %u\n", sector);
10b84fe1 SG	43	memmove(buf + sector * RKSPI_SECT_LEN * 2,
	44	buf + sector * RKSPI_SECT_LEN,
	45	RKSPI_SECT_LEN);
	46	memset(buf + sector * RKSPI_SECT_LEN * 2 + RKSPI_SECT_LEN,
	47	'\0', RKSPI_SECT_LEN);
	48	}
	49	}
	50
10b84fe1 SG	51	static int rkspi_check_image_type(uint8_t type)
	52	{
	53	if (type == IH_TYPE_RKSPI)
	54	return EXIT_SUCCESS;
	55	else
	56	return EXIT_FAILURE;
	57	}
	58
366aad4d PT	59	/*
	60	* The SPI payload needs to be padded out to make space for odd half-sector
	61	* layout used in flash (i.e. only the first 2K of each 4K sector is used).
	62	*/
10b84fe1 SG	63	static int rkspi_vrec_header(struct image_tool_params *params,
	64	struct image_type_params *tparams)
	65	{
ad972ac3	66	int padding = rkcommon_vrec_header(params, tparams, RK_INIT_SIZE_ALIGN);
366aad4d PT	67	/*
	68	* The file size has not been adjusted at this point (our caller will
	69	* eventually add the header/padding to the file_size), so we need to
	70	* add up the header_size, file_size and padding ourselves.
	71	*/
	72	int padded_size = tparams->header_size + params->file_size + padding;
10b84fe1	73
366aad4d PT	74	/*
	75	* We need to store the original file-size (i.e. before padding), as
	76	* imagetool does not set this during its adjustment of file_size.
	77	*/
	78	params->orig_file_size = padded_size;
10b84fe1	79
366aad4d PT	80	/*
	81	* Converting to the SPI format (i.e. splitting each 4K page into two
	82	* 2K subpages and then padding these 2K pages up to take a complete
	83	* 4K sector again) will will double the image size.
	84	*
	85	* Thus we return the padded_size as an additional padding requirement
	86	* (be sure to add this to the padding returned from the common code).
	87	*/
	88	return padded_size + padding;
10b84fe1 SG	89	}
	90
	91	/*
	92	* rk_spi parameters
	93	*/
	94	U_BOOT_IMAGE_TYPE(
	95	rkspi,
	96	"Rockchip SPI Boot Image support",
111bcc4f PT	97	0,
111bcc4f PT	98	NULL,
7bf274b9	99	rkcommon_check_params,
2fb371ff PT	100	rkcommon_verify_header,
2fb371ff PT	101	rkcommon_print_header,
10b84fe1	102	rkspi_set_header,
2fb371ff	103	NULL,
10b84fe1 SG	104	rkspi_check_image_type,
	105	NULL,
	106	rkspi_vrec_header
	107	);