Commit 8ae3fbf8 authored by Boris Brezillon's avatar Boris Brezillon Committed by Miquel Raynal
Browse files

mtd: rawnand: Move JEDEC code to nand_jedec.c 



This moves JEDEC related code to nand_jedec.c and JEDEC related
struct/macros to include/linux/mtd/jedec.h.

Signed-off-by: default avatarBoris Brezillon <boris.brezillon@bootlin.com>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
parent 1c325cc5

drivers/mtd/nand/raw/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -59,6 +59,7 @@ obj-$(CONFIG_MTD_NAND_TEGRA) += tegra_nand.o 


nand-objs := nand_base.o nand_legacy.o nand_bbt.o nand_timings.o nand_ids.o

nand-objs += nand_onfi.o

nand-objs += nand_jedec.o

nand-objs += nand_amd.o

nand-objs += nand_hynix.o

nand-objs += nand_macronix.o

drivers/mtd/nand/raw/internals.h

+3 −0
Original line number Diff line number Diff line
@@ -108,4 +108,7 @@ int nand_legacy_check_hooks(struct nand_chip *chip); 
u16 onfi_crc16(u16 crc, u8 const *p, size_t len);

int nand_onfi_detect(struct nand_chip *chip);



/* JEDEC functions */

int nand_jedec_detect(struct nand_chip *chip);



#endif /* __LINUX_RAWNAND_INTERNALS */

drivers/mtd/nand/raw/nand_base.c

+1 −97
Original line number Diff line number Diff line
@@ -4387,102 +4387,6 @@ void sanitize_string(uint8_t *s, size_t len) 
	strim(s);

}



/*

 * Check if the NAND chip is JEDEC compliant, returns 1 if it is, 0 otherwise.

 */

static int nand_flash_detect_jedec(struct nand_chip *chip)

{

	struct mtd_info *mtd = nand_to_mtd(chip);

	struct nand_jedec_params *p;

	struct jedec_ecc_info *ecc;

	int jedec_version = 0;

	char id[5];

	int i, val, ret;



	/* Try JEDEC for unknown chip or LP */

	ret = nand_readid_op(chip, 0x40, id, sizeof(id));

	if (ret || strncmp(id, "JEDEC", sizeof(id)))

		return 0;



	/* JEDEC chip: allocate a buffer to hold its parameter page */

	p = kzalloc(sizeof(*p), GFP_KERNEL);

	if (!p)

		return -ENOMEM;



	ret = nand_read_param_page_op(chip, 0x40, NULL, 0);

	if (ret) {

		ret = 0;

		goto free_jedec_param_page;

	}



	for (i = 0; i < 3; i++) {

		ret = nand_read_data_op(chip, p, sizeof(*p), true);

		if (ret) {

			ret = 0;

			goto free_jedec_param_page;

		}



		if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 510) ==

				le16_to_cpu(p->crc))

			break;

	}



	if (i == 3) {

		pr_err("Could not find valid JEDEC parameter page; aborting\n");

		goto free_jedec_param_page;

	}



	/* Check version */

	val = le16_to_cpu(p->revision);

	if (val & (1 << 2))

		jedec_version = 10;

	else if (val & (1 << 1))

		jedec_version = 1; /* vendor specific version */



	if (!jedec_version) {

		pr_info("unsupported JEDEC version: %d\n", val);

		goto free_jedec_param_page;

	}



	sanitize_string(p->manufacturer, sizeof(p->manufacturer));

	sanitize_string(p->model, sizeof(p->model));

	chip->parameters.model = kstrdup(p->model, GFP_KERNEL);

	if (!chip->parameters.model) {

		ret = -ENOMEM;

		goto free_jedec_param_page;

	}



	mtd->writesize = le32_to_cpu(p->byte_per_page);



	/* Please reference to the comment for nand_flash_detect_onfi. */

	mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);

	mtd->erasesize *= mtd->writesize;



	mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);



	/* Please reference to the comment for nand_flash_detect_onfi. */

	chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);

	chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;

	chip->bits_per_cell = p->bits_per_cell;



	if (le16_to_cpu(p->features) & JEDEC_FEATURE_16_BIT_BUS)

		chip->options |= NAND_BUSWIDTH_16;



	/* ECC info */

	ecc = &p->ecc_info[0];



	if (ecc->codeword_size >= 9) {

		chip->ecc_strength_ds = ecc->ecc_bits;

		chip->ecc_step_ds = 1 << ecc->codeword_size;

	} else {

		pr_warn("Invalid codeword size\n");

	}



free_jedec_param_page:

	kfree(p);

	return ret;

}



/*

 * nand_id_has_period - Check if an ID string has a given wraparound period

 * @id_data: the ID string
@@ -4795,7 +4699,7 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type) 
			goto ident_done;



		/* Check if the chip is JEDEC compliant */

		ret = nand_flash_detect_jedec(chip);

		ret = nand_jedec_detect(chip);

		if (ret < 0)

			return ret;

		else if (ret)

drivers/mtd/nand/raw/nand_jedec.c

0 → 100644
+113 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0

/*

 *  Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)

 *		  2002-2006 Thomas Gleixner (tglx@linutronix.de)

 *

 *  Credits:

 *	David Woodhouse for adding multichip support

 *

 *	Aleph One Ltd. and Toby Churchill Ltd. for supporting the

 *	rework for 2K page size chips

 *

 * This file contains all ONFI helpers.

 */



#include <linux/slab.h>



#include "internals.h"



/*

 * Check if the NAND chip is JEDEC compliant, returns 1 if it is, 0 otherwise.

 */

int nand_jedec_detect(struct nand_chip *chip)

{

	struct mtd_info *mtd = nand_to_mtd(chip);

	struct nand_jedec_params *p;

	struct jedec_ecc_info *ecc;

	int jedec_version = 0;

	char id[5];

	int i, val, ret;



	/* Try JEDEC for unknown chip or LP */

	ret = nand_readid_op(chip, 0x40, id, sizeof(id));

	if (ret || strncmp(id, "JEDEC", sizeof(id)))

		return 0;



	/* JEDEC chip: allocate a buffer to hold its parameter page */

	p = kzalloc(sizeof(*p), GFP_KERNEL);

	if (!p)

		return -ENOMEM;



	ret = nand_read_param_page_op(chip, 0x40, NULL, 0);

	if (ret) {

		ret = 0;

		goto free_jedec_param_page;

	}



	for (i = 0; i < 3; i++) {

		ret = nand_read_data_op(chip, p, sizeof(*p), true);

		if (ret) {

			ret = 0;

			goto free_jedec_param_page;

		}



		if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 510) ==

				le16_to_cpu(p->crc))

			break;

	}



	if (i == 3) {

		pr_err("Could not find valid JEDEC parameter page; aborting\n");

		goto free_jedec_param_page;

	}



	/* Check version */

	val = le16_to_cpu(p->revision);

	if (val & (1 << 2))

		jedec_version = 10;

	else if (val & (1 << 1))

		jedec_version = 1; /* vendor specific version */



	if (!jedec_version) {

		pr_info("unsupported JEDEC version: %d\n", val);

		goto free_jedec_param_page;

	}



	sanitize_string(p->manufacturer, sizeof(p->manufacturer));

	sanitize_string(p->model, sizeof(p->model));

	chip->parameters.model = kstrdup(p->model, GFP_KERNEL);

	if (!chip->parameters.model) {

		ret = -ENOMEM;

		goto free_jedec_param_page;

	}



	mtd->writesize = le32_to_cpu(p->byte_per_page);



	/* Please reference to the comment for nand_flash_detect_onfi. */

	mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);

	mtd->erasesize *= mtd->writesize;



	mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);



	/* Please reference to the comment for nand_flash_detect_onfi. */

	chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);

	chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;

	chip->bits_per_cell = p->bits_per_cell;



	if (le16_to_cpu(p->features) & JEDEC_FEATURE_16_BIT_BUS)

		chip->options |= NAND_BUSWIDTH_16;



	/* ECC info */

	ecc = &p->ecc_info[0];



	if (ecc->codeword_size >= 9) {

		chip->ecc_strength_ds = ecc->ecc_bits;

		chip->ecc_step_ds = 1 << ecc->codeword_size;

	} else {

		pr_warn("Invalid codeword size\n");

	}



free_jedec_param_page:

	kfree(p);

	return ret;

}

include/linux/mtd/jedec.h

0 → 100644
+91 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 */

/*

 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>

 *			 Steven J. Hill <sjhill@realitydiluted.com>

 *			 Thomas Gleixner <tglx@linutronix.de>

 *

 * Contains all JEDEC related definitions

 */



#ifndef __LINUX_MTD_JEDEC_H

#define __LINUX_MTD_JEDEC_H



struct jedec_ecc_info {

	u8 ecc_bits;

	u8 codeword_size;

	__le16 bb_per_lun;

	__le16 block_endurance;

	u8 reserved[2];

} __packed;



/* JEDEC features */

#define JEDEC_FEATURE_16_BIT_BUS	(1 << 0)



struct nand_jedec_params {

	/* rev info and features block */

	/* 'J' 'E' 'S' 'D'  */

	u8 sig[4];

	__le16 revision;

	__le16 features;

	u8 opt_cmd[3];

	__le16 sec_cmd;

	u8 num_of_param_pages;

	u8 reserved0[18];



	/* manufacturer information block */

	char manufacturer[12];

	char model[20];

	u8 jedec_id[6];

	u8 reserved1[10];



	/* memory organization block */

	__le32 byte_per_page;

	__le16 spare_bytes_per_page;

	u8 reserved2[6];

	__le32 pages_per_block;

	__le32 blocks_per_lun;

	u8 lun_count;

	u8 addr_cycles;

	u8 bits_per_cell;

	u8 programs_per_page;

	u8 multi_plane_addr;

	u8 multi_plane_op_attr;

	u8 reserved3[38];



	/* electrical parameter block */

	__le16 async_sdr_speed_grade;

	__le16 toggle_ddr_speed_grade;

	__le16 sync_ddr_speed_grade;

	u8 async_sdr_features;

	u8 toggle_ddr_features;

	u8 sync_ddr_features;

	__le16 t_prog;

	__le16 t_bers;

	__le16 t_r;

	__le16 t_r_multi_plane;

	__le16 t_ccs;

	__le16 io_pin_capacitance_typ;

	__le16 input_pin_capacitance_typ;

	__le16 clk_pin_capacitance_typ;

	u8 driver_strength_support;

	__le16 t_adl;

	u8 reserved4[36];



	/* ECC and endurance block */

	u8 guaranteed_good_blocks;

	__le16 guaranteed_block_endurance;

	struct jedec_ecc_info ecc_info[4];

	u8 reserved5[29];



	/* reserved */

	u8 reserved6[148];



	/* vendor */

	__le16 vendor_rev_num;

	u8 reserved7[88];



	/* CRC for Parameter Page */

	__le16 crc;

} __packed;



#endif /* __LINUX_MTD_JEDEC_H */