[thirdparty/u-boot.git] / drivers / fastboot / fb_nand.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright 2014 Broadcom Corporation.
 * Copyright 2015 Free Electrons.
 */

#include <config.h>
#include <common.h>

#include <fastboot.h>
#include <image-sparse.h>

#include <linux/mtd/mtd.h>
#include <jffs2/jffs2.h>
#include <nand.h>

struct fb_nand_sparse {
	struct mtd_info		*mtd;
	struct part_info	*part;
};

__weak int board_fastboot_erase_partition_setup(char *name)
{
	return 0;
}

__weak int board_fastboot_write_partition_setup(char *name)
{
	return 0;
}

static int fb_nand_lookup(const char *partname,
			  struct mtd_info **mtd,
			  struct part_info **part,
			  char *response)
{
	struct mtd_device *dev;
	int ret;
	u8 pnum;

	ret = mtdparts_init();
	if (ret) {
		pr_err("Cannot initialize MTD partitions\n");
		fastboot_fail("cannot init mtdparts", response);
		return ret;
	}

	ret = find_dev_and_part(partname, &dev, &pnum, part);
	if (ret) {
		pr_err("cannot find partition: '%s'", partname);
		fastboot_fail("cannot find partition", response);
		return ret;
	}

	if (dev->id->type != MTD_DEV_TYPE_NAND) {
		pr_err("partition '%s' is not stored on a NAND device",
		      partname);
		fastboot_fail("not a NAND device", response);
		return -EINVAL;
	}

	*mtd = get_nand_dev_by_index(dev->id->num);

	return 0;
}

static int _fb_nand_erase(struct mtd_info *mtd, struct part_info *part)
{
	nand_erase_options_t opts;
	int ret;

	memset(&opts, 0, sizeof(opts));
	opts.offset = part->offset;
	opts.length = part->size;
	opts.quiet = 1;

	printf("Erasing blocks 0x%llx to 0x%llx\n",
	       part->offset, part->offset + part->size);

	ret = nand_erase_opts(mtd, &opts);
	if (ret)
		return ret;

	printf("........ erased 0x%llx bytes from '%s'\n",
	       part->size, part->name);

	return 0;
}

static int _fb_nand_write(struct mtd_info *mtd, struct part_info *part,
			  void *buffer, u32 offset,
			  size_t length, size_t *written)
{
	int flags = WITH_WR_VERIFY;

#ifdef CONFIG_FASTBOOT_FLASH_NAND_TRIMFFS
	flags |= WITH_DROP_FFS;
#endif

	return nand_write_skip_bad(mtd, offset, &length, written,
				   part->size - (offset - part->offset),
				   buffer, flags);
}

static lbaint_t fb_nand_sparse_write(struct sparse_storage *info,
		lbaint_t blk, lbaint_t blkcnt, const void *buffer)
{
	struct fb_nand_sparse *sparse = info->priv;
	size_t written;
	int ret;

	ret = _fb_nand_write(sparse->mtd, sparse->part, (void *)buffer,
			     blk * info->blksz,
			     blkcnt * info->blksz, &written);
	if (ret < 0) {
		printf("Failed to write sparse chunk\n");
		return ret;
	}

/* TODO - verify that the value "written" includes the "bad-blocks" ... */

	/*
	 * the return value must be 'blkcnt' ("good-blocks") plus the
	 * number of "bad-blocks" encountered within this space...
	 */
	return written / info->blksz;
}

static lbaint_t fb_nand_sparse_reserve(struct sparse_storage *info,
		lbaint_t blk, lbaint_t blkcnt)
{
	int bad_blocks = 0;

/*
 * TODO - implement a function to determine the total number
 * of blocks which must be used in order to reserve the specified
 * number ("blkcnt") of "good-blocks", starting at "blk"...
 * ( possibly something like the "check_skip_len()" function )
 */

	/*
	 * the return value must be 'blkcnt' ("good-blocks") plus the
	 * number of "bad-blocks" encountered within this space...
	 */
	return blkcnt + bad_blocks;
}

/**
 * fastboot_nand_get_part_info() - Lookup NAND partion by name
 *
 * @part_name: Named device to lookup
 * @part_info: Pointer to returned part_info pointer
 * @response: Pointer to fastboot response buffer
 */
int fastboot_nand_get_part_info(char *part_name, struct part_info **part_info,
				char *response)
{
	struct mtd_info *mtd = NULL;

	return fb_nand_lookup(part_name, &mtd, part_info, response);
}

/**
 * fastboot_nand_flash_write() - Write image to NAND for fastboot
 *
 * @cmd: Named device to write image to
 * @download_buffer: Pointer to image data
 * @download_bytes: Size of image data
 * @response: Pointer to fastboot response buffer
 */
void fastboot_nand_flash_write(const char *cmd, void *download_buffer,
			       u32 download_bytes, char *response)
{
	struct part_info *part;
	struct mtd_info *mtd = NULL;
	int ret;

	ret = fb_nand_lookup(cmd, &mtd, &part, response);
	if (ret) {
		pr_err("invalid NAND device");
		fastboot_fail("invalid NAND device", response);
		return;
	}

	ret = board_fastboot_write_partition_setup(part->name);
	if (ret)
		return;

	if (is_sparse_image(download_buffer)) {
		struct fb_nand_sparse sparse_priv;
		struct sparse_storage sparse;

		sparse_priv.mtd = mtd;
		sparse_priv.part = part;

		sparse.blksz = mtd->writesize;
		sparse.start = part->offset / sparse.blksz;
		sparse.size = part->size / sparse.blksz;
		sparse.write = fb_nand_sparse_write;
		sparse.reserve = fb_nand_sparse_reserve;
		sparse.mssg = fastboot_fail;

		printf("Flashing sparse image at offset " LBAFU "\n",
		       sparse.start);

		sparse.priv = &sparse_priv;
		ret = write_sparse_image(&sparse, cmd, download_buffer,
					 response);
		if (!ret)
			fastboot_okay(NULL, response);
	} else {
		printf("Flashing raw image at offset 0x%llx\n",
		       part->offset);

		ret = _fb_nand_write(mtd, part, download_buffer, part->offset,
				     download_bytes, NULL);

		printf("........ wrote %u bytes to '%s'\n",
		       download_bytes, part->name);
	}

	if (ret) {
		fastboot_fail("error writing the image", response);
		return;
	}

	fastboot_okay(NULL, response);
}

/**
 * fastboot_nand_flash_erase() - Erase NAND for fastboot
 *
 * @cmd: Named device to erase
 * @response: Pointer to fastboot response buffer
 */
void fastboot_nand_erase(const char *cmd, char *response)
{
	struct part_info *part;
	struct mtd_info *mtd = NULL;
	int ret;

	ret = fb_nand_lookup(cmd, &mtd, &part, response);
	if (ret) {
		pr_err("invalid NAND device");
		fastboot_fail("invalid NAND device", response);
		return;
	}

	ret = board_fastboot_erase_partition_setup(part->name);
	if (ret)
		return;

	ret = _fb_nand_erase(mtd, part);
	if (ret) {
		pr_err("failed erasing from device %s", mtd->name);
		fastboot_fail("failed erasing from device", response);
		return;
	}

	fastboot_okay(NULL, response);
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
bf8940d3 MR	2	/*
	3	* Copyright 2014 Broadcom Corporation.
	4	* Copyright 2015 Free Electrons.
bf8940d3 MR	5	*/
	6
	7	#include <config.h>
	8	#include <common.h>
	9
bf8940d3	10	#include <fastboot.h>
3d4ef38d	11	#include <image-sparse.h>
bf8940d3 MR	12
	13	#include <linux/mtd/mtd.h>
	14	#include <jffs2/jffs2.h>
	15	#include <nand.h>
	16
bf8940d3	17	struct fb_nand_sparse {
cc0f08cd	18	struct mtd_info *mtd;
bf8940d3 MR	19	struct part_info *part;
	20	};
	21
6fb77c48 MR	22	__weak int board_fastboot_erase_partition_setup(char *name)
	23	{
	24	return 0;
	25	}
	26
	27	__weak int board_fastboot_write_partition_setup(char *name)
	28	{
	29	return 0;
	30	}
	31
9bc34799	32	static int fb_nand_lookup(const char *partname,
61717571	33	struct mtd_info **mtd,
c4ded03e AK	34	struct part_info **part,
c4ded03e AK	35	char *response)
bf8940d3 MR	36	{
	37	struct mtd_device *dev;
	38	int ret;
	39	u8 pnum;
	40
	41	ret = mtdparts_init();
	42	if (ret) {
9b643e31	43	pr_err("Cannot initialize MTD partitions\n");
c4ded03e	44	fastboot_fail("cannot init mtdparts", response);
bf8940d3 MR	45	return ret;
	46	}
	47
	48	ret = find_dev_and_part(partname, &dev, &pnum, part);
	49	if (ret) {
9b643e31	50	pr_err("cannot find partition: '%s'", partname);
c4ded03e	51	fastboot_fail("cannot find partition", response);
bf8940d3 MR	52	return ret;
	53	}
	54
	55	if (dev->id->type != MTD_DEV_TYPE_NAND) {
9b643e31	56	pr_err("partition '%s' is not stored on a NAND device",
bf8940d3	57	partname);
c4ded03e	58	fastboot_fail("not a NAND device", response);
bf8940d3 MR	59	return -EINVAL;
	60	}
	61
edba8cc4	62	*mtd = get_nand_dev_by_index(dev->id->num);
bf8940d3 MR	63
	64	return 0;
	65	}
	66
151c06ec	67	static int _fb_nand_erase(struct mtd_info mtd, struct part_info part)
bf8940d3 MR	68	{
	69	nand_erase_options_t opts;
	70	int ret;
	71
	72	memset(&opts, 0, sizeof(opts));
	73	opts.offset = part->offset;
	74	opts.length = part->size;
	75	opts.quiet = 1;
	76
	77	printf("Erasing blocks 0x%llx to 0x%llx\n",
	78	part->offset, part->offset + part->size);
	79
151c06ec	80	ret = nand_erase_opts(mtd, &opts);
bf8940d3 MR	81	if (ret)
	82	return ret;
	83
	84	printf("........ erased 0x%llx bytes from '%s'\n",
	85	part->size, part->name);
	86
	87	return 0;
	88	}
	89
151c06ec	90	static int _fb_nand_write(struct mtd_info mtd, struct part_info part,
f73a7df9	91	void *buffer, u32 offset,
52fdf107	92	size_t length, size_t *written)
bf8940d3 MR	93	{
	94	int flags = WITH_WR_VERIFY;
	95
	96	#ifdef CONFIG_FASTBOOT_FLASH_NAND_TRIMFFS
	97	flags \|= WITH_DROP_FFS;
	98	#endif
	99
151c06ec	100	return nand_write_skip_bad(mtd, offset, &length, written,
bf8940d3 MR	101	part->size - (offset - part->offset),
	102	buffer, flags);
	103	}
	104
cc0f08cd SR	105	static lbaint_t fb_nand_sparse_write(struct sparse_storage *info,
cc0f08cd SR	106	lbaint_t blk, lbaint_t blkcnt, const void *buffer)
bf8940d3	107	{
cc0f08cd	108	struct fb_nand_sparse *sparse = info->priv;
bf8940d3 MR	109	size_t written;
	110	int ret;
	111
cc0f08cd SR	112	ret = _fb_nand_write(sparse->mtd, sparse->part, (void *)buffer,
	113	blk * info->blksz,
	114	blkcnt * info->blksz, &written);
bf8940d3 MR	115	if (ret < 0) {
	116	printf("Failed to write sparse chunk\n");
	117	return ret;
	118	}
	119
cc0f08cd SR	120	/* TODO - verify that the value "written" includes the "bad-blocks" ... */
	121
	122	/*
	123	* the return value must be 'blkcnt' ("good-blocks") plus the
	124	* number of "bad-blocks" encountered within this space...
	125	*/
	126	return written / info->blksz;
bf8940d3 MR	127	}
bf8940d3 MR	128
2c724046 SR	129	static lbaint_t fb_nand_sparse_reserve(struct sparse_storage *info,
	130	lbaint_t blk, lbaint_t blkcnt)
	131	{
	132	int bad_blocks = 0;
	133
	134	/*
	135	* TODO - implement a function to determine the total number
	136	* of blocks which must be used in order to reserve the specified
	137	* number ("blkcnt") of "good-blocks", starting at "blk"...
	138	* ( possibly something like the "check_skip_len()" function )
	139	*/
	140
	141	/*
	142	* the return value must be 'blkcnt' ("good-blocks") plus the
	143	* number of "bad-blocks" encountered within this space...
	144	*/
	145	return blkcnt + bad_blocks;
	146	}
	147
f73a7df9 AK	148	/**
	149	* fastboot_nand_get_part_info() - Lookup NAND partion by name
	150	*
	151	* @part_name: Named device to lookup
	152	* @part_info: Pointer to returned part_info pointer
	153	* @response: Pointer to fastboot response buffer
	154	*/
	155	int fastboot_nand_get_part_info(char part_name, struct part_info *part_info,
	156	char *response)
	157	{
	158	struct mtd_info *mtd = NULL;
	159
	160	return fb_nand_lookup(part_name, &mtd, part_info, response);
	161	}
	162
d1a119d4 AK	163	/**
	164	* fastboot_nand_flash_write() - Write image to NAND for fastboot
	165	*
	166	* @cmd: Named device to write image to
	167	* @download_buffer: Pointer to image data
	168	* @download_bytes: Size of image data
	169	* @response: Pointer to fastboot response buffer
	170	*/
	171	void fastboot_nand_flash_write(const char cmd, void download_buffer,
f73a7df9	172	u32 download_bytes, char *response)
bf8940d3 MR	173	{
bf8940d3 MR	174	struct part_info *part;
151c06ec	175	struct mtd_info *mtd = NULL;
bf8940d3 MR	176	int ret;
bf8940d3 MR	177
c4ded03e	178	ret = fb_nand_lookup(cmd, &mtd, &part, response);
bf8940d3	179	if (ret) {
9b643e31	180	pr_err("invalid NAND device");
c4ded03e	181	fastboot_fail("invalid NAND device", response);
bf8940d3 MR	182	return;
	183	}
	184
6fb77c48 MR	185	ret = board_fastboot_write_partition_setup(part->name);
	186	if (ret)
	187	return;
	188
bf8940d3 MR	189	if (is_sparse_image(download_buffer)) {
bf8940d3 MR	190	struct fb_nand_sparse sparse_priv;
cc0f08cd	191	struct sparse_storage sparse;
bf8940d3	192
cc0f08cd	193	sparse_priv.mtd = mtd;
bf8940d3 MR	194	sparse_priv.part = part;
bf8940d3 MR	195
cc0f08cd SR	196	sparse.blksz = mtd->writesize;
	197	sparse.start = part->offset / sparse.blksz;
	198	sparse.size = part->size / sparse.blksz;
bf8940d3	199	sparse.write = fb_nand_sparse_write;
2c724046	200	sparse.reserve = fb_nand_sparse_reserve;
2f83f219	201	sparse.mssg = fastboot_fail;
bf8940d3	202
cc0f08cd SR	203	printf("Flashing sparse image at offset " LBAFU "\n",
	204	sparse.start);
	205
	206	sparse.priv = &sparse_priv;
c4ded03e AK	207	ret = write_sparse_image(&sparse, cmd, download_buffer,
c4ded03e AK	208	response);
2f83f219	209	if (!ret)
c4ded03e	210	fastboot_okay(NULL, response);
bf8940d3 MR	211	} else {
	212	printf("Flashing raw image at offset 0x%llx\n",
	213	part->offset);
	214
151c06ec	215	ret = _fb_nand_write(mtd, part, download_buffer, part->offset,
bf8940d3 MR	216	download_bytes, NULL);
	217
	218	printf("........ wrote %u bytes to '%s'\n",
	219	download_bytes, part->name);
	220	}
	221
	222	if (ret) {
c4ded03e	223	fastboot_fail("error writing the image", response);
bf8940d3 MR	224	return;
	225	}
	226
c4ded03e	227	fastboot_okay(NULL, response);
bf8940d3 MR	228	}
bf8940d3 MR	229
d1a119d4 AK	230	/**
	231	* fastboot_nand_flash_erase() - Erase NAND for fastboot
	232	*
	233	* @cmd: Named device to erase
	234	* @response: Pointer to fastboot response buffer
	235	*/
	236	void fastboot_nand_erase(const char cmd, char response)
bf8940d3 MR	237	{
bf8940d3 MR	238	struct part_info *part;
151c06ec	239	struct mtd_info *mtd = NULL;
bf8940d3 MR	240	int ret;
bf8940d3 MR	241
c4ded03e	242	ret = fb_nand_lookup(cmd, &mtd, &part, response);
bf8940d3	243	if (ret) {
9b643e31	244	pr_err("invalid NAND device");
c4ded03e	245	fastboot_fail("invalid NAND device", response);
bf8940d3 MR	246	return;
	247	}
	248
6fb77c48 MR	249	ret = board_fastboot_erase_partition_setup(part->name);
	250	if (ret)
	251	return;
	252
151c06ec	253	ret = _fb_nand_erase(mtd, part);
bf8940d3	254	if (ret) {
9b643e31	255	pr_err("failed erasing from device %s", mtd->name);
c4ded03e	256	fastboot_fail("failed erasing from device", response);
bf8940d3 MR	257	return;
	258	}
	259
c4ded03e	260	fastboot_okay(NULL, response);
bf8940d3	261	}