linux/mtd/spinand.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright (c) 2016-2017 Micron Technology, Inc.
17 #include <linux/spi/spi-mem.h>
197  * struct spinand_id - SPI NAND id structure
198  * @data: buffer containing the id bytes. Currently 4 bytes large, but can
200  * @len: ID length
214  * struct spinand_devid - SPI NAND device id structure
215  * @id: device id of current chip
216  * @len: number of bytes in device id
217  * @method: method to read chip id
219  *	    SPINAND_READID_METHOD_OPCODE: chip id is returned immediately
221  *	    SPINAND_READID_METHOD_OPCODE_ADDR: chip id is returned after
222  *	    read_id opcode + 1-byte address.
223  *	    SPINAND_READID_METHOD_OPCODE_DUMMY: chip id is returned after
227 	const u8 *id;  member
233  * struct manufacurer_ops - SPI NAND manufacturer specific operations
237  * Each SPI NAND manufacturer driver should implement this interface so that
246  * struct spinand_manufacturer - SPI NAND manufacturer instance
247  * @id: manufacturer ID
248  * @name: manufacturer name
249  * @devid_len: number of bytes in device ID
250  * @chips: supported SPI NANDs under current manufacturer
252  * @ops: manufacturer operations
255 	u8 id;  member
276  * struct spinand_op_variants - SPI NAND operation variants
280  * Some operations like read-from-cache/write-to-cache have several variants
299  * spinand_ecc_info - description of the on-die ECC implemented by a SPI NAND
303  *		-EBADMSG if there are uncorrectable errors. I can also return
306  * @ooblayout: the OOB layout used by the on-die ECC implementation
319  * struct spinand_ondie_ecc_conf - private SPI-NAND on-die ECC engine structure
321  *          ->get_status() is not populated by the spinand device.
328  * struct spinand_info - Structure used to describe SPI NAND chips
330  * @devid: device ID
331  * @flags: OR-ing of the SPINAND_XXX flags
334  * @eccinfo: on-die ECC info
336  * @op_variants.read_cache: variants of the read-cache operation
337  * @op_variants.write_cache: variants of the write-cache operation
338  * @op_variants.update_cache: variants of the update-cache operation
340  *		   multi-die chips
343  * Each SPI NAND manufacturer driver should have a spinand_info table
366 		.id = (const u8[]){ __VA_ARGS__ },			\
410  * struct spinand_device - SPI NAND device instance
414  * @id: NAND ID as returned by READ_ID
424  * @eccinfo: on-die ECC information
429  *		because the spi-mem interface explicitly requests that buffers
430  *		passed in spi_mem_op be DMA-able, so we can't based the bufs on
432  * @manufacturer: SPI NAND manufacturer information
436  *		A per-transfer check must of course be done to ensure it is
439  * @priv: manufacturer private data
445 	struct spinand_id id;  member
466 	const struct spinand_manufacturer *manufacturer;  member
475  * mtd_to_spinand() - Get the SPI NAND device attached to an MTD instance
486  * spinand_to_mtd() - Get the MTD device embedded in a SPI NAND device
493 	return nanddev_to_mtd(&spinand->base);  in spinand_to_mtd()
497  * nand_to_spinand() - Get the SPI NAND device embedding an NAND object
508  * spinand_to_nand() - Get the NAND device embedded in a SPI NAND object
516 	return &spinand->base;  in spinand_to_nand()
520  * spinand_set_of_node - Attach a DT node to a SPI NAND device
529 	nanddev_set_of_node(&spinand->base, np);  in spinand_set_of_node()