tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
fork
Configure Feed
Select the types of activity you want to include in your feed.
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (c) 2018 - Bootlin
4 *
5 * Author: Boris Brezillon <boris.brezillon@bootlin.com>
6 *
7 * Header containing internal definitions to be used only by core files.
8 * NAND controller drivers should not include this file.
9 */
10
11#ifndef __LINUX_RAWNAND_INTERNALS
12#define __LINUX_RAWNAND_INTERNALS
13
14#include <linux/mtd/rawnand.h>
15
16/*
17 * NAND Flash Manufacturer ID Codes
18 */
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/* Kioxia is new name of Toshiba memory. */
34#define NAND_MFR_TOSHIBA 0x98
35#define NAND_MFR_WINBOND 0xef
36
37/**
38 * struct nand_manufacturer_ops - NAND Manufacturer operations
39 * @detect: detect the NAND memory organization and capabilities
40 * @init: initialize all vendor specific fields (like the ->read_retry()
41 * implementation) if any.
42 * @cleanup: the ->init() function may have allocated resources, ->cleanup()
43 * is here to let vendor specific code release those resources.
44 * @fixup_onfi_param_page: apply vendor specific fixups to the ONFI parameter
45 * page. This is called after the checksum is verified.
46 */
47struct nand_manufacturer_ops {
48 void (*detect)(struct nand_chip *chip);
49 int (*init)(struct nand_chip *chip);
50 void (*cleanup)(struct nand_chip *chip);
51 void (*fixup_onfi_param_page)(struct nand_chip *chip,
52 struct nand_onfi_params *p);
53};
54
55/**
56 * struct nand_manufacturer - NAND Flash Manufacturer structure
57 * @name: Manufacturer name
58 * @id: manufacturer ID code of device.
59 * @ops: manufacturer operations
60 */
61struct nand_manufacturer {
62 int id;
63 char *name;
64 const struct nand_manufacturer_ops *ops;
65};
66
67
68extern struct nand_flash_dev nand_flash_ids[];
69
70extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
71extern const struct nand_manufacturer_ops esmt_nand_manuf_ops;
72extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
73extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
74extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
75extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
76extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
77
78/* Core functions */
79const struct nand_manufacturer *nand_get_manufacturer(u8 id);
80int nand_bbm_get_next_page(struct nand_chip *chip, int page);
81int nand_markbad_bbm(struct nand_chip *chip, loff_t ofs);
82int nand_erase_nand(struct nand_chip *chip, struct erase_info *instr,
83 int allowbbt);
84int onfi_fill_data_interface(struct nand_chip *chip,
85 enum nand_data_interface_type type,
86 int timing_mode);
87int nand_get_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
88int nand_set_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
89int nand_read_page_raw_notsupp(struct nand_chip *chip, u8 *buf,
90 int oob_required, int page);
91int nand_write_page_raw_notsupp(struct nand_chip *chip, const u8 *buf,
92 int oob_required, int page);
93int nand_exit_status_op(struct nand_chip *chip);
94int nand_read_param_page_op(struct nand_chip *chip, u8 page, void *buf,
95 unsigned int len);
96void nand_decode_ext_id(struct nand_chip *chip);
97void panic_nand_wait(struct nand_chip *chip, unsigned long timeo);
98void sanitize_string(uint8_t *s, size_t len);
99
100static inline bool nand_has_exec_op(struct nand_chip *chip)
101{
102 if (!chip->controller || !chip->controller->ops ||
103 !chip->controller->ops->exec_op)
104 return false;
105
106 return true;
107}
108
109static inline int nand_exec_op(struct nand_chip *chip,
110 const struct nand_operation *op)
111{
112 if (!nand_has_exec_op(chip))
113 return -ENOTSUPP;
114
115 if (WARN_ON(op->cs >= nanddev_ntargets(&chip->base)))
116 return -EINVAL;
117
118 return chip->controller->ops->exec_op(chip, op, false);
119}
120
121static inline bool nand_has_setup_data_iface(struct nand_chip *chip)
122{
123 if (!chip->controller || !chip->controller->ops ||
124 !chip->controller->ops->setup_data_interface)
125 return false;
126
127 if (chip->options & NAND_KEEP_TIMINGS)
128 return false;
129
130 return true;
131}
132
133/* BBT functions */
134int nand_markbad_bbt(struct nand_chip *chip, loff_t offs);
135int nand_isreserved_bbt(struct nand_chip *chip, loff_t offs);
136int nand_isbad_bbt(struct nand_chip *chip, loff_t offs, int allowbbt);
137
138/* Legacy */
139void nand_legacy_set_defaults(struct nand_chip *chip);
140void nand_legacy_adjust_cmdfunc(struct nand_chip *chip);
141int nand_legacy_check_hooks(struct nand_chip *chip);
142
143/* ONFI functions */
144u16 onfi_crc16(u16 crc, u8 const *p, size_t len);
145int nand_onfi_detect(struct nand_chip *chip);
146
147/* JEDEC functions */
148int nand_jedec_detect(struct nand_chip *chip);
149
150#endif /* __LINUX_RAWNAND_INTERNALS */