LXR linux/drivers/mtd/nand/raw/internals.h

   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#define NAND_MFR_TOSHIBA        0x98
  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
  69extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
  70extern const struct nand_manufacturer_ops esmt_nand_manuf_ops;
  71extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
  72extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
  73extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
  74extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
  75extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
  76
  77/* Core functions */
  78const struct nand_manufacturer *nand_get_manufacturer(u8 id);
  79int nand_markbad_bbm(struct nand_chip *chip, loff_t ofs);
  80int nand_erase_nand(struct nand_chip *chip, struct erase_info *instr,
  81                    int allowbbt);
  82int onfi_fill_data_interface(struct nand_chip *chip,
  83                             enum nand_data_interface_type type,
  84                             int timing_mode);
  85int nand_get_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
  86int nand_set_features(struct nand_chip *chip, int addr, u8 *subfeature_param);
  87int nand_read_page_raw_notsupp(struct nand_chip *chip, u8 *buf,
  88                               int oob_required, int page);
  89int nand_write_page_raw_notsupp(struct nand_chip *chip, const u8 *buf,
  90                                int oob_required, int page);
  91int nand_exit_status_op(struct nand_chip *chip);
  92int nand_read_param_page_op(struct nand_chip *chip, u8 page, void *buf,
  93                            unsigned int len);
  94void nand_decode_ext_id(struct nand_chip *chip);
  95void panic_nand_wait(struct nand_chip *chip, unsigned long timeo);
  96void sanitize_string(uint8_t *s, size_t len);
  97
  98static inline bool nand_has_exec_op(struct nand_chip *chip)
  99{
 100        if (!chip->controller || !chip->controller->ops ||
 101            !chip->controller->ops->exec_op)
 102                return false;
 103
 104        return true;
 105}
 106
 107static inline int nand_exec_op(struct nand_chip *chip,
 108                               const struct nand_operation *op)
 109{
 110        if (!nand_has_exec_op(chip))
 111                return -ENOTSUPP;
 112
 113        if (WARN_ON(op->cs >= chip->numchips))
 114                return -EINVAL;
 115
 116        return chip->controller->ops->exec_op(chip, op, false);
 117}
 118
 119static inline bool nand_has_setup_data_iface(struct nand_chip *chip)
 120{
 121        if (!chip->controller || !chip->controller->ops ||
 122            !chip->controller->ops->setup_data_interface)
 123                return false;
 124
 125        if (chip->options & NAND_KEEP_TIMINGS)
 126                return false;
 127
 128        return true;
 129}
 130
 131/* BBT functions */
 132int nand_markbad_bbt(struct nand_chip *chip, loff_t offs);
 133int nand_isreserved_bbt(struct nand_chip *chip, loff_t offs);
 134int nand_isbad_bbt(struct nand_chip *chip, loff_t offs, int allowbbt);
 135
 136/* Legacy */
 137void nand_legacy_set_defaults(struct nand_chip *chip);
 138void nand_legacy_adjust_cmdfunc(struct nand_chip *chip);
 139int nand_legacy_check_hooks(struct nand_chip *chip);
 140
 141/* ONFI functions */
 142u16 onfi_crc16(u16 crc, u8 const *p, size_t len);
 143int nand_onfi_detect(struct nand_chip *chip);
 144
 145/* JEDEC functions */
 146int nand_jedec_detect(struct nand_chip *chip);
 147
 148#endif /* __LINUX_RAWNAND_INTERNALS */
 149