1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2018 - Bootlin
5 * Author: Boris Brezillon <boris.brezillon@bootlin.com>
7 * Header containing internal definitions to be used only by core files.
8 * NAND controller drivers should not include this file.
11 #ifndef __LINUX_RAWNAND_INTERNALS
12 #define __LINUX_RAWNAND_INTERNALS
14 #include <linux/mtd/rawnand.h>
17 * NAND Flash Manufacturer ID Codes
19 #define NAND_MFR_AMD 0x01
20 #define NAND_MFR_ATO 0x9b
21 #define NAND_MFR_EON 0x92
22 #define NAND_MFR_ESMT 0xc8
23 #define NAND_MFR_FUJITSU 0x04
24 #define NAND_MFR_HYNIX 0xad
25 #define NAND_MFR_INTEL 0x89
26 #define NAND_MFR_MACRONIX 0xc2
27 #define NAND_MFR_MICRON 0x2c
28 #define NAND_MFR_NATIONAL 0x8f
29 #define NAND_MFR_RENESAS 0x07
30 #define NAND_MFR_SAMSUNG 0xec
31 #define NAND_MFR_SANDISK 0x45
32 #define NAND_MFR_STMICRO 0x20
33 #define NAND_MFR_TOSHIBA 0x98
34 #define NAND_MFR_WINBOND 0xef
37 * struct nand_manufacturer_ops - NAND Manufacturer operations
38 * @detect: detect the NAND memory organization and capabilities
39 * @init: initialize all vendor specific fields (like the ->read_retry()
40 * implementation) if any.
41 * @cleanup: the ->init() function may have allocated resources, ->cleanup()
42 * is here to let vendor specific code release those resources.
43 * @fixup_onfi_param_page: apply vendor specific fixups to the ONFI parameter
44 * page. This is called after the checksum is verified.
46 struct nand_manufacturer_ops {
47 void (*detect)(struct nand_chip *chip);
48 int (*init)(struct nand_chip *chip);
49 void (*cleanup)(struct nand_chip *chip);
50 void (*fixup_onfi_param_page)(struct nand_chip *chip,
51 struct nand_onfi_params *p);
55 * struct nand_manufacturer - NAND Flash Manufacturer structure
56 * @name: Manufacturer name
57 * @id: manufacturer ID code of device.
58 * @ops: manufacturer operations
60 struct nand_manufacturer {
63 const struct nand_manufacturer_ops *ops;
67 extern struct nand_flash_dev nand_flash_ids[];
69 extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
70 extern const struct nand_manufacturer_ops esmt_nand_manuf_ops;
71 extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
72 extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
73 extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
74 extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
75 extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
78 const struct nand_manufacturer *nand_get_manufacturer(u8 id);
79 int nand_markbad_bbm(struct nand_chip *chip, loff_t ofs);
80 int nand_erase_nand(struct nand_chip *chip, struct erase_info *instr,
82 int onfi_fill_data_interface(struct nand_chip *chip,
83 enum nand_data_interface_type type,
85 int nand_get_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
86 int nand_set_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
87 int nand_read_page_raw_notsupp(struct nand_chip *chip, u8 *buf,
88 int oob_required, int page);
89 int nand_write_page_raw_notsupp(struct nand_chip *chip, const u8 *buf,
90 int oob_required, int page);
91 int nand_exit_status_op(struct nand_chip *chip);
92 int nand_read_param_page_op(struct nand_chip *chip, u8 page, void *buf,
94 void nand_decode_ext_id(struct nand_chip *chip);
95 void panic_nand_wait(struct nand_chip *chip, unsigned long timeo);
96 void sanitize_string(uint8_t *s, size_t len);
99 int nand_markbad_bbt(struct nand_chip *chip, loff_t offs);
100 int nand_isreserved_bbt(struct nand_chip *chip, loff_t offs);
101 int nand_isbad_bbt(struct nand_chip *chip, loff_t offs, int allowbbt);
104 void nand_legacy_set_defaults(struct nand_chip *chip);
105 void nand_legacy_adjust_cmdfunc(struct nand_chip *chip);
106 int nand_legacy_check_hooks(struct nand_chip *chip);
109 u16 onfi_crc16(u16 crc, u8 const *p, size_t len);
110 int nand_onfi_detect(struct nand_chip *chip);
112 /* JEDEC functions */
113 int nand_jedec_detect(struct nand_chip *chip);
115 #endif /* __LINUX_RAWNAND_INTERNALS */