linux/mtd/spinand.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright (c) 2016-2017 Micron Technology, Inc.
15 #include <linux/mtd/nand.h>
16 #include <linux/spi/spi.h>
17 #include <linux/spi/spi-mem.h>
20  * Standard SPI NAND flash operations
144  * Standard SPI NAND flash commands
197  * struct spinand_id - SPI NAND id structure
214  * struct spinand_devid - SPI NAND device id structure
222  *	    read_id opcode + 1-byte address.
233  * struct manufacurer_ops - SPI NAND manufacturer specific operations
234  * @init: initialize a SPI NAND device
235  * @cleanup: cleanup a SPI NAND device
237  * Each SPI NAND manufacturer driver should implement this interface so that
238  * NAND chips coming from this vendor can be initialized properly.
246  * struct spinand_manufacturer - SPI NAND manufacturer instance
250  * @chips: supported SPI NANDs under current manufacturer
251  * @nchips: number of SPI NANDs available in chips array
262 /* SPI NAND manufacturers */
276  * struct spinand_op_variants - SPI NAND operation variants
280  * Some operations like read-from-cache/write-to-cache have several variants
283  * by a chip and let the core pick the best one based on the SPI mem controller
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
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
410  * struct spinand_device - SPI NAND device instance
411  * @base: NAND device instance
412  * @spimem: pointer to the SPI mem object
413  * @lock: lock used to serialize accesses to the NAND
414  * @id: NAND ID as returned by READ_ID
415  * @flags: NAND flags
416  * @op_templates: various SPI mem op templates
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
475  * mtd_to_spinand() - Get the SPI NAND device attached to an MTD instance
478  * Return: the SPI NAND device attached to @mtd.
486  * spinand_to_mtd() - Get the MTD device embedded in a SPI NAND device
487  * @spinand: 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
498  * @nand: NAND object
500  * Return: the SPI NAND device embedding @nand.
502 static inline struct spinand_device *nand_to_spinand(struct nand_device *nand)  in nand_to_spinand()  argument
504 	return container_of(nand, struct spinand_device, base);  in nand_to_spinand()
508  * spinand_to_nand() - Get the NAND device embedded in a SPI NAND object
509  * @spinand: SPI NAND device
511  * Return: the NAND device embedded in @spinand.
516 	return &spinand->base;  in spinand_to_nand()
520  * spinand_set_of_node - Attach a DT node to a SPI NAND device
521  * @spinand: SPI NAND device
524  * Attach a DT node to a SPI NAND device.
529 	nanddev_set_of_node(&spinand->base, np);  in spinand_set_of_node()