Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit abbe26d1 authored by Boris Brezillon's avatar Boris Brezillon
Browse files

mtd: nand: Add manufacturer specific initialization/detection steps



A lot of NANDs are implementing generic features in a non-generic way,
or are providing advanced auto-detection logic where the NAND ID bytes
meaning changes with the NAND generation.

Providing this vendor specific initialization step will allow us to get
rid of full-id entries in the nand_ids table or all the vendor specific
cases added over the time in the generic NAND ID decoding logic.

Signed-off-by: default avatarBoris Brezillon <boris.brezillon@free-electrons.com>
parent bcc678c2
Loading
Loading
Loading
Loading
+65 −10
Original line number Original line Diff line number Diff line
@@ -3819,7 +3819,7 @@ static int nand_get_bits_per_cell(u8 cellinfo)
 * chip. The rest of the parameters must be decoded according to generic or
 * chip. The rest of the parameters must be decoded according to generic or
 * manufacturer-specific "extended ID" decoding patterns.
 * manufacturer-specific "extended ID" decoding patterns.
 */
 */
static void nand_decode_ext_id(struct nand_chip *chip)
void nand_decode_ext_id(struct nand_chip *chip)
{
{
	struct mtd_info *mtd = nand_to_mtd(chip);
	struct mtd_info *mtd = nand_to_mtd(chip);
	int extid, id_len = chip->id.len;
	int extid, id_len = chip->id.len;
@@ -3944,6 +3944,7 @@ static void nand_decode_ext_id(struct nand_chip *chip)


	}
	}
}
}
EXPORT_SYMBOL_GPL(nand_decode_ext_id);


/*
/*
 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
@@ -4047,6 +4048,53 @@ static bool find_full_id_nand(struct nand_chip *chip,
	return false;
	return false;
}
}


/*
 * Manufacturer detection. Only used when the NAND is not ONFI or JEDEC
 * compliant and does not have a full-id or legacy-id entry in the nand_ids
 * table.
 */
static void nand_manufacturer_detect(struct nand_chip *chip)
{
	/*
	 * Try manufacturer detection if available and use
	 * nand_decode_ext_id() otherwise.
	 */
	if (chip->manufacturer.desc && chip->manufacturer.desc->ops &&
	    chip->manufacturer.desc->ops->detect)
		chip->manufacturer.desc->ops->detect(chip);
	else
		nand_decode_ext_id(chip);
}

/*
 * Manufacturer initialization. This function is called for all NANDs including
 * ONFI and JEDEC compliant ones.
 * Manufacturer drivers should put all their specific initialization code in
 * their ->init() hook.
 */
static int nand_manufacturer_init(struct nand_chip *chip)
{
	if (!chip->manufacturer.desc || !chip->manufacturer.desc->ops ||
	    !chip->manufacturer.desc->ops->init)
		return 0;

	return chip->manufacturer.desc->ops->init(chip);
}

/*
 * Manufacturer cleanup. This function is called for all NANDs including
 * ONFI and JEDEC compliant ones.
 * Manufacturer drivers should put all their specific cleanup code in their
 * ->cleanup() hook.
 */
static void nand_manufacturer_cleanup(struct nand_chip *chip)
{
	/* Release manufacturer private data */
	if (chip->manufacturer.desc && chip->manufacturer.desc->ops &&
	    chip->manufacturer.desc->ops->cleanup)
		chip->manufacturer.desc->ops->cleanup(chip);
}

/*
/*
 * Get the flash and manufacturer id and lookup if the type is supported.
 * Get the flash and manufacturer id and lookup if the type is supported.
 */
 */
@@ -4055,7 +4103,7 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type)
	const struct nand_manufacturer *manufacturer;
	const struct nand_manufacturer *manufacturer;
	struct mtd_info *mtd = nand_to_mtd(chip);
	struct mtd_info *mtd = nand_to_mtd(chip);
	int busw;
	int busw;
	int i;
	int i, ret;
	u8 *id_data = chip->id.data;
	u8 *id_data = chip->id.data;
	u8 maf_id, dev_id;
	u8 maf_id, dev_id;


@@ -4096,6 +4144,10 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type)


	chip->id.len = nand_id_len(id_data, 8);
	chip->id.len = nand_id_len(id_data, 8);


	/* Try to identify manufacturer */
	manufacturer = nand_get_manufacturer(maf_id);
	chip->manufacturer.desc = manufacturer;

	if (!type)
	if (!type)
		type = nand_flash_ids;
		type = nand_flash_ids;


@@ -4142,12 +4194,11 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type)


	chip->chipsize = (uint64_t)type->chipsize << 20;
	chip->chipsize = (uint64_t)type->chipsize << 20;


	if (!type->pagesize) {
	if (!type->pagesize)
		/* Decode parameters from extended ID */
		nand_manufacturer_detect(chip);
		nand_decode_ext_id(chip);
	else
	} else {
		nand_decode_id(chip, type);
		nand_decode_id(chip, type);
	}

	/* Get chip options */
	/* Get chip options */
	chip->options |= type->options;
	chip->options |= type->options;


@@ -4159,9 +4210,6 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type)
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
ident_done:
ident_done:


	/* Try to identify manufacturer */
	manufacturer = nand_get_manufacturer(maf_id);

	if (chip->options & NAND_BUSWIDTH_AUTO) {
	if (chip->options & NAND_BUSWIDTH_AUTO) {
		WARN_ON(busw & NAND_BUSWIDTH_16);
		WARN_ON(busw & NAND_BUSWIDTH_16);
		nand_set_defaults(chip);
		nand_set_defaults(chip);
@@ -4202,6 +4250,10 @@ static int nand_detect(struct nand_chip *chip, struct nand_flash_dev *type)
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
		chip->cmdfunc = nand_command_lp;


	ret = nand_manufacturer_init(chip);
	if (ret)
		return ret;

	pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
	pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
		maf_id, dev_id);
		maf_id, dev_id);


@@ -4947,6 +4999,9 @@ void nand_cleanup(struct nand_chip *chip)
	if (chip->badblock_pattern && chip->badblock_pattern->options
	if (chip->badblock_pattern && chip->badblock_pattern->options
			& NAND_BBT_DYNAMICSTRUCT)
			& NAND_BBT_DYNAMICSTRUCT)
		kfree(chip->badblock_pattern);
		kfree(chip->badblock_pattern);

	/* Free manufacturer priv data. */
	nand_manufacturer_cleanup(chip);
}
}
EXPORT_SYMBOL_GPL(nand_cleanup);
EXPORT_SYMBOL_GPL(nand_cleanup);


+35 −0
Original line number Original line Diff line number Diff line
@@ -731,6 +731,20 @@ nand_get_sdr_timings(const struct nand_data_interface *conf)
	return &conf->timings.sdr;
	return &conf->timings.sdr;
}
}


/**
 * struct nand_manufacturer_ops - NAND Manufacturer operations
 * @detect: detect the NAND memory organization and capabilities
 * @init: initialize all vendor specific fields (like the ->read_retry()
 *	  implementation) if any.
 * @cleanup: the ->init() function may have allocated resources, ->cleanup()
 *	     is here to let vendor specific code release those resources.
 */
struct nand_manufacturer_ops {
	void (*detect)(struct nand_chip *chip);
	int (*init)(struct nand_chip *chip);
	void (*cleanup)(struct nand_chip *chip);
};

/**
/**
 * struct nand_chip - NAND Private Flash Chip Data
 * struct nand_chip - NAND Private Flash Chip Data
 * @mtd:		MTD device registered to the MTD framework
 * @mtd:		MTD device registered to the MTD framework
@@ -835,6 +849,7 @@ nand_get_sdr_timings(const struct nand_data_interface *conf)
 *			additional error status checks (determine if errors are
 *			additional error status checks (determine if errors are
 *			correctable).
 *			correctable).
 * @write_page:		[REPLACEABLE] High-level page write function
 * @write_page:		[REPLACEABLE] High-level page write function
 * @manufacturer:	[INTERN] Contains manufacturer information
 */
 */


struct nand_chip {
struct nand_chip {
@@ -923,6 +938,11 @@ struct nand_chip {
	struct nand_bbt_descr *badblock_pattern;
	struct nand_bbt_descr *badblock_pattern;


	void *priv;
	void *priv;

	struct {
		const struct nand_manufacturer *desc;
		void *priv;
	} manufacturer;
};
};


extern const struct mtd_ooblayout_ops nand_ooblayout_sp_ops;
extern const struct mtd_ooblayout_ops nand_ooblayout_sp_ops;
@@ -959,6 +979,17 @@ static inline void nand_set_controller_data(struct nand_chip *chip, void *priv)
	chip->priv = priv;
	chip->priv = priv;
}
}


static inline void nand_set_manufacturer_data(struct nand_chip *chip,
					      void *priv)
{
	chip->manufacturer.priv = priv;
}

static inline void *nand_get_manufacturer_data(struct nand_chip *chip)
{
	return chip->manufacturer.priv;
}

/*
/*
 * NAND Flash Manufacturer ID Codes
 * NAND Flash Manufacturer ID Codes
 */
 */
@@ -1065,10 +1096,12 @@ struct nand_flash_dev {
 * struct nand_manufacturer - NAND Flash Manufacturer structure
 * struct nand_manufacturer - NAND Flash Manufacturer structure
 * @name:	Manufacturer name
 * @name:	Manufacturer name
 * @id:		manufacturer ID code of device.
 * @id:		manufacturer ID code of device.
 * @ops:	manufacturer operations
*/
*/
struct nand_manufacturer {
struct nand_manufacturer {
	int id;
	int id;
	char *name;
	char *name;
	const struct nand_manufacturer_ops *ops;
};
};


const struct nand_manufacturer *nand_get_manufacturer(u8 id);
const struct nand_manufacturer *nand_get_manufacturer(u8 id);
@@ -1246,4 +1279,6 @@ int nand_reset(struct nand_chip *chip, int chipnr);
/* Free resources held by the NAND device */
/* Free resources held by the NAND device */
void nand_cleanup(struct nand_chip *chip);
void nand_cleanup(struct nand_chip *chip);


/* Default extended ID decoding function */
void nand_decode_ext_id(struct nand_chip *chip);
#endif /* __LINUX_MTD_NAND_H */
#endif /* __LINUX_MTD_NAND_H */