include/nand.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * (C) Copyright 2005
   4  * 2N Telekomunikace, a.s. <www.2n.cz>
   5  * Ladislav Michl <michl@2n.cz>
   6  */
   7
   8 #ifndef _NAND_H_
   9 #define _NAND_H_
  10
  11 extern void nand_init(void);
  12 void nand_reinit(void);
  13 unsigned long nand_size(void);
  14 unsigned int nand_page_size(void);
  15
  16 #include <linux/compat.h>
  17 #include <linux/mtd/mtd.h>
  18
  19 int nand_mtd_to_devnum(struct mtd_info *mtd);
  20
  21 #if CONFIG_IS_ENABLED(SYS_NAND_SELF_INIT)
  22 void board_nand_init(void);
  23 int nand_register(int devnum, struct mtd_info *mtd);
  24 void nand_unregister(struct mtd_info *mtd);
  25 #else
  26 struct nand_chip;
  27
  28 extern int board_nand_init(struct nand_chip *nand);
  29 #endif
  30
  31 extern int nand_curr_device;
  32
  33 static inline int nand_read(struct mtd_info *info, loff_t ofs, size_t *len,
  34                             u_char *buf)
  35 {
  36         return mtd_read(info, ofs, *len, (size_t *)len, buf);
  37 }
  38
  39 static inline int nand_write(struct mtd_info *info, loff_t ofs, size_t *len,
  40                              u_char *buf)
  41 {
  42         return mtd_write(info, ofs, *len, (size_t *)len, buf);
  43 }
  44
  45 static inline int nand_block_isbad(struct mtd_info *info, loff_t ofs)
  46 {
  47         return mtd_block_isbad(info, ofs);
  48 }
  49
  50 static inline int nand_erase(struct mtd_info *info, loff_t off, size_t size)
  51 {
  52         struct erase_info instr;
  53
  54         instr.mtd = info;
  55         instr.addr = off;
  56         instr.len = size;
  57
  58         return mtd_erase(info, &instr);
  59 }
  60
  61 /*****************************************************************************
  62  * declarations from nand_util.c
  63  ****************************************************************************/
  64
  65 typedef struct mtd_oob_ops mtd_oob_ops_t;
  66
  67 struct nand_erase_options {
  68         loff_t length;          /* number of bytes to erase */
  69         loff_t offset;          /* first address in NAND to erase */
  70         int quiet;              /* don't display progress messages */
  71         int jffs2;              /* if true: format for jffs2 usage
  72                                  * (write appropriate cleanmarker blocks) */
  73         int scrub;              /* if true, really clean NAND by erasing
  74                                  * bad blocks (UNSAFE) */
  75
  76         /* Don't include skipped bad blocks in size to be erased */
  77         int spread;
  78         /* maximum size that actual may be in order to not exceed the buf */
  79         loff_t lim;
  80 };
  81
  82 typedef struct nand_erase_options nand_erase_options_t;
  83
  84 int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  85                        size_t *actual, loff_t lim, u_char *buffer);
  86
  87 #define WITH_DROP_FFS   (1 << 0) /* drop trailing all-0xff pages */
  88 #define WITH_WR_VERIFY  (1 << 1) /* verify data was written correctly */
  89
  90 int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  91                         size_t *actual, loff_t lim, u_char *buffer, int flags);
  92 int nand_erase_opts(struct mtd_info *mtd,
  93                     const nand_erase_options_t *opts);
  94 int nand_torture(struct mtd_info *mtd, loff_t offset);
  95 int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
  96                          loff_t ofs);
  97 int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf);
  98
  99 #define NAND_LOCK_STATUS_TIGHT  0x01
 100 #define NAND_LOCK_STATUS_UNLOCK 0x04
 101
 102 int nand_lock(struct mtd_info *mtd, int tight);
 103 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
 104                 int allexcept);
 105 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset);
 106
 107 u32 nand_spl_adjust_offset(u32 sector, u32 offs);
 108 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
 109 int nand_spl_read_block(int block, int offset, int len, void *dst);
 110 void nand_deselect(void);
 111
 112 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
 113 void board_nand_select_device(struct nand_chip *nand, int chip);
 114 #endif
 115
 116 __attribute__((noreturn)) void nand_boot(void);
 117
 118 #ifdef CONFIG_ENV_OFFSET_OOB
 119 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
 120                                     as block number*/
 121 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
 122                                         stored as byte number */
 123 #define ENV_OFFSET_SIZE 8
 124 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result);
 125 #endif
 126 int spl_nand_erase_one(int block, int page);
 127
 128 /* platform specific init functions */
 129 void sunxi_nand_init(void);
 130
 131 /*
 132  * get_nand_dev_by_index - Get the nand info based in index.
 133  *
 134  * @dev - index to the nand device.
 135  *
 136  * returns pointer to the nand device info structure or NULL on failure.
 137  */
 138 struct mtd_info *get_nand_dev_by_index(int dev);
 139
 140 #endif /* _NAND_H_ */