[thirdparty/u-boot.git] / tools / rkspi.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2015 Google,  Inc
 * Written by Simon Glass <sjg@chromium.org>
 *
 * 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;

	size = params->orig_file_size;

	rkcommon_set_header(buf, sbuf, ifd, params);

	/*
	 * 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.
	 */
	if (params->vflag)
		fprintf(stderr, "Spreading spi image from %u to %u\n",
			size, params->file_size);

	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 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)
{
	rkcommon_vrec_header(params, tparams);

	/*
	 * 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) which will double the image size.
	 */
	params->file_size = ROUND(params->file_size, RKSPI_SECT_LEN) << 1;

	/* Ignoring pad len, since we are using our own copy_image() */
	return 0;
}

/*
 * 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
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
10b84fe1 SG	2	/*
	3	* (C) Copyright 2015 Google, Inc
	4	* Written by Simon Glass <sjg@chromium.org>
	5	*
10b84fe1 SG	6	* See README.rockchip for details of the rkspi format
	7	*/
	8
	9	#include "imagetool.h"
	10	#include <image.h>
	11	#include <rc4.h>
	12	#include "mkimage.h"
	13	#include "rkcommon.h"
	14
	15	enum {
10b84fe1 SG	16	RKSPI_SECT_LEN = RK_BLK_SIZE * 4,
	17	};
	18
10b84fe1 SG	19	static void rkspi_set_header(void buf, struct stat sbuf, int ifd,
	20	struct image_tool_params *params)
	21	{
	22	int sector;
	23	unsigned int size;
10b84fe1 SG	24
10b84fe1 SG	25	size = params->orig_file_size;
eea6cd8d JC	26
eea6cd8d JC	27	rkcommon_set_header(buf, sbuf, ifd, params);
10b84fe1	28
10b84fe1 SG	29	/*
	30	* Spread the image out so we only use the first 2KB of each 4KB
	31	* region. This is a feature of the SPI format required by the Rockchip
	32	* boot ROM. Its rationale is unknown.
	33	*/
eea6cd8d JC	34	if (params->vflag)
	35	fprintf(stderr, "Spreading spi image from %u to %u\n",
	36	size, params->file_size);
	37
10b84fe1	38	for (sector = size / RKSPI_SECT_LEN - 1; sector >= 0; sector--) {
25525ebe	39	debug("sector %u\n", sector);
10b84fe1 SG	40	memmove(buf + sector * RKSPI_SECT_LEN * 2,
	41	buf + sector * RKSPI_SECT_LEN,
	42	RKSPI_SECT_LEN);
	43	memset(buf + sector * RKSPI_SECT_LEN * 2 + RKSPI_SECT_LEN,
	44	'\0', RKSPI_SECT_LEN);
	45	}
	46	}
	47
10b84fe1 SG	48	static int rkspi_check_image_type(uint8_t type)
	49	{
	50	if (type == IH_TYPE_RKSPI)
	51	return EXIT_SUCCESS;
	52	else
	53	return EXIT_FAILURE;
	54	}
	55
366aad4d	56	/*
eea6cd8d JC	57	* The SPI payload needs to make space for odd half-sector layout used in flash
eea6cd8d JC	58	* (i.e. only the first 2K of each 4K sector is used).
366aad4d	59	*/
10b84fe1 SG	60	static int rkspi_vrec_header(struct image_tool_params *params,
	61	struct image_type_params *tparams)
	62	{
eea6cd8d	63	rkcommon_vrec_header(params, tparams);
10b84fe1	64
366aad4d PT	65	/*
	66	* Converting to the SPI format (i.e. splitting each 4K page into two
	67	* 2K subpages and then padding these 2K pages up to take a complete
eea6cd8d	68	* 4K sector again) which will double the image size.
366aad4d	69	*/
eea6cd8d JC	70	params->file_size = ROUND(params->file_size, RKSPI_SECT_LEN) << 1;
	71
	72	/* Ignoring pad len, since we are using our own copy_image() */
	73	return 0;
10b84fe1 SG	74	}
	75
	76	/*
	77	* rk_spi parameters
	78	*/
	79	U_BOOT_IMAGE_TYPE(
	80	rkspi,
	81	"Rockchip SPI Boot Image support",
111bcc4f PT	82	0,
111bcc4f PT	83	NULL,
7bf274b9	84	rkcommon_check_params,
2fb371ff PT	85	rkcommon_verify_header,
2fb371ff PT	86	rkcommon_print_header,
10b84fe1	87	rkspi_set_header,
2fb371ff	88	NULL,
10b84fe1 SG	89	rkspi_check_image_type,
	90	NULL,
	91	rkspi_vrec_header
	92	);