Git Browser for ODROID
Code Review Sign In
git.odroid.com / yocto / kernel / common / 727d37826bd19905424d6f5cf8351fcb4be71206 / . / drivers / mtd / nand / raw / internals.h
blob: f624b7b8041316b478ce3b319b3f2b60ae8fb5aa [file] [log] [blame]
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]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 */
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]19#define NAND_MFR_AMD 0x01
20#define NAND_MFR_ATO 0x9b
21#define NAND_MFR_EON 0x92
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]22#define NAND_MFR_ESMT 0xc8
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]23#define NAND_MFR_FUJITSU 0x04
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]24#define NAND_MFR_HYNIX 0xad
25#define NAND_MFR_INTEL 0x89
26#define NAND_MFR_MACRONIX 0xc2
27#define NAND_MFR_MICRON 0x2c
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]28#define NAND_MFR_NATIONAL 0x8f
29#define NAND_MFR_RENESAS 0x07
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]30#define NAND_MFR_SAMSUNG 0xec
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]31#define NAND_MFR_SANDISK 0x45
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]32#define NAND_MFR_STMICRO 0x20
33#define NAND_MFR_TOSHIBA 0x98
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]34#define NAND_MFR_WINBOND 0xef
35
36/**
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.
45 */
46struct 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);
52};
53
54/**
55 * struct nand_manufacturer - NAND Flash Manufacturer structure
56 * @name: Manufacturer name
57 * @id: manufacturer ID code of device.
58 * @ops: manufacturer operations
59 */
60struct nand_manufacturer {
61 int id;
62 char *name;
63 const struct nand_manufacturer_ops *ops;
64};
65
66
67extern struct nand_flash_dev nand_flash_ids[];
68
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]69extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]70extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]71extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
Marcel Ziswiler727d3782018-09-06 23:30:19 +0200[diff] [blame^]72extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
73extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
74extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]75
76/* Core functions */
77const struct nand_manufacturer *nand_get_manufacturer(u8 id);
78int nand_markbad_bbm(struct nand_chip *chip, loff_t ofs);
79int nand_erase_nand(struct nand_chip *chip, struct erase_info *instr,
80 int allowbbt);
81int onfi_fill_data_interface(struct nand_chip *chip,
82 enum nand_data_interface_type type,
83 int timing_mode);
84int nand_get_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
85int nand_set_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
86int nand_read_page_raw_notsupp(struct nand_chip *chip, u8 *buf,
87 int oob_required, int page);
88int nand_write_page_raw_notsupp(struct nand_chip *chip, const u8 *buf,
89 int oob_required, int page);
90int nand_exit_status_op(struct nand_chip *chip);
Boris Brezillon1c325cc2018-09-07 00:38:50 +0200[diff] [blame]91int nand_read_param_page_op(struct nand_chip *chip, u8 page, void *buf,
92 unsigned int len);
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]93void nand_decode_ext_id(struct nand_chip *chip);
Boris Brezillon3d4af7c2018-09-07 00:38:49 +0200[diff] [blame]94void panic_nand_wait(struct nand_chip *chip, unsigned long timeo);
Boris Brezillon1c325cc2018-09-07 00:38:50 +0200[diff] [blame]95void sanitize_string(uint8_t *s, size_t len);
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]96
97/* BBT functions */
98int nand_markbad_bbt(struct nand_chip *chip, loff_t offs);
99int nand_isreserved_bbt(struct nand_chip *chip, loff_t offs);
100int nand_isbad_bbt(struct nand_chip *chip, loff_t offs, int allowbbt);
101
Boris Brezillon3d4af7c2018-09-07 00:38:49 +0200[diff] [blame]102/* Legacy */
103void nand_legacy_set_defaults(struct nand_chip *chip);
104void nand_legacy_adjust_cmdfunc(struct nand_chip *chip);
105int nand_legacy_check_hooks(struct nand_chip *chip);
106
Boris Brezillon1c325cc2018-09-07 00:38:50 +0200[diff] [blame]107/* ONFI functions */
108u16 onfi_crc16(u16 crc, u8 const *p, size_t len);
109int nand_onfi_detect(struct nand_chip *chip);
110
Boris Brezillon8ae3fbf2018-09-07 00:38:51 +0200[diff] [blame]111/* JEDEC functions */
112int nand_jedec_detect(struct nand_chip *chip);
113
Boris Brezillon348d56a2018-09-07 00:38:48 +0200[diff] [blame]114#endif /* __LINUX_RAWNAND_INTERNALS */