[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 <blk.h>

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

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