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>
175  * struct spinand_id - SPI NAND id structure
192  * struct spinand_devid - SPI NAND device id structure
200  *	    read_id opcode + 1-byte address.
211  * struct manufacurer_ops - SPI NAND manufacturer specific operations
224  * struct spinand_manufacturer - SPI NAND manufacturer instance
263  * struct spinand_op_variants - SPI NAND operation variants
267  * Some operations like read-from-cache/write-to-cache have several variants
268  * depending on the number of IO lines you use to transfer data or address
270  * by a chip and let the core pick the best one based on the SPI mem controller
286  * spinand_ecc_info - description of the on-die ECC implemented by a SPI NAND
290  *		-EBADMSG if there are uncorrectable errors. I can also return
293  * @ooblayout: the OOB layout used by the on-die ECC implementation
304  * struct spinand_ondie_ecc_conf - private SPI-NAND on-die ECC engine structure
306  *          ->get_status() is not populated by the spinand device.
313  * struct spinand_info - Structure used to describe SPI NAND chips
316  * @flags: OR-ing of the SPINAND_XXX flags
319  * @eccinfo: on-die ECC info
321  * @op_variants.read_cache: variants of the read-cache operation
322  * @op_variants.write_cache: variants of the write-cache operation
323  * @op_variants.update_cache: variants of the update-cache operation
324  * @select_target: function used to select a target/die. Required only for
325  *		   multi-die chips
387  * struct spinand_device - SPI NAND device instance
397  * @select_target: select a specific target/die. Usually called before sending
399  *		   this die. Only required if your chip exposes several dies
400  * @cur_target: currently selected target/die
401  * @eccinfo: on-die ECC information
402  * @cfg_cache: config register cache. One entry per die
406  *		because the spi-mem interface explicitly requests that buffers
407  *		passed in spi_mem_op be DMA-able, so we can't based the bufs on
442  * mtd_to_spinand() - Get the SPI NAND device attached to an MTD instance
453  * spinand_to_mtd() - Get the MTD device embedded in a SPI NAND device
460 	return nanddev_to_mtd(&spinand->base);  in spinand_to_mtd()
464  * nand_to_spinand() - Get the SPI NAND device embedding an NAND object
475  * spinand_to_nand() - Get the NAND device embedded in a SPI NAND object
483 	return &spinand->base;  in spinand_to_nand()
487  * spinand_set_of_node - Attach a DT node to a SPI NAND device
496 	nanddev_set_of_node(&spinand->base, np);  in spinand_set_of_node()