include/nand.h

   1 /*
   2  * (C) Copyright 2005
   3  * 2N Telekomunikace, a.s. <www.2n.cz>
   4  * Ladislav Michl <michl@2n.cz>
   5  *
   6  * See file CREDITS for list of people who contributed to this
   7  * project.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  */
  13
  14 #ifndef _NAND_H_
  15 #define _NAND_H_
  16
  17 #include <config.h>
  18
  19 extern void nand_init(void);
  20
  21 #include <linux/compat.h>
  22 #include <linux/mtd/mtd.h>
  23 #include <linux/mtd/nand.h>
  24
  25 #ifdef CONFIG_SYS_NAND_SELF_INIT
  26 void board_nand_init(void);
  27 int nand_register(int devnum);
  28 #else
  29 extern int board_nand_init(struct nand_chip *nand);
  30 #endif
  31
  32 typedef struct mtd_info nand_info_t;
  33
  34 extern int nand_curr_device;
  35 extern nand_info_t nand_info[];
  36
  37 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  38 {
  39         return mtd_read(info, ofs, *len, (size_t *)len, buf);
  40 }
  41
  42 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  43 {
  44         return mtd_write(info, ofs, *len, (size_t *)len, buf);
  45 }
  46
  47 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
  48 {
  49         return mtd_block_isbad(info, ofs);
  50 }
  51
  52 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
  53 {
  54         struct erase_info instr;
  55
  56         instr.mtd = info;
  57         instr.addr = off;
  58         instr.len = size;
  59         instr.callback = 0;
  60
  61         return mtd_erase(info, &instr);
  62 }
  63
  64
  65 /*****************************************************************************
  66  * declarations from nand_util.c
  67  ****************************************************************************/
  68
  69 struct nand_write_options {
  70         u_char *buffer;         /* memory block containing image to write */
  71         ulong length;           /* number of bytes to write */
  72         ulong offset;           /* start address in NAND */
  73         int quiet;              /* don't display progress messages */
  74         int autoplace;          /* if true use auto oob layout */
  75         int forcejffs2;         /* force jffs2 oob layout */
  76         int forceyaffs;         /* force yaffs oob layout */
  77         int noecc;              /* write without ecc */
  78         int writeoob;           /* image contains oob data */
  79         int pad;                /* pad to page size */
  80         int blockalign;         /* 1|2|4 set multiple of eraseblocks
  81                                  * to align to */
  82 };
  83
  84 typedef struct nand_write_options nand_write_options_t;
  85 typedef struct mtd_oob_ops mtd_oob_ops_t;
  86
  87 struct nand_read_options {
  88         u_char *buffer;         /* memory block in which read image is written*/
  89         ulong length;           /* number of bytes to read */
  90         ulong offset;           /* start address in NAND */
  91         int quiet;              /* don't display progress messages */
  92         int readoob;            /* put oob data in image */
  93 };
  94
  95 typedef struct nand_read_options nand_read_options_t;
  96
  97 struct nand_erase_options {
  98         loff_t length;          /* number of bytes to erase */
  99         loff_t offset;          /* first address in NAND to erase */
 100         int quiet;              /* don't display progress messages */
 101         int jffs2;              /* if true: format for jffs2 usage
 102                                  * (write appropriate cleanmarker blocks) */
 103         int scrub;              /* if true, really clean NAND by erasing
 104                                  * bad blocks (UNSAFE) */
 105
 106         /* Don't include skipped bad blocks in size to be erased */
 107         int spread;
 108         /* maximum size that actual may be in order to not exceed the buf */
 109         loff_t lim;
 110 };
 111
 112 typedef struct nand_erase_options nand_erase_options_t;
 113
 114 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 115                        size_t *actual, loff_t lim, u_char *buffer);
 116
 117 #define WITH_YAFFS_OOB  (1 << 0) /* whether write with yaffs format. This flag
 118                                   * is a 'mode' meaning it cannot be mixed with
 119                                   * other flags */
 120 #define WITH_DROP_FFS   (1 << 1) /* drop trailing all-0xff pages */
 121
 122 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 123                         size_t *actual, loff_t lim, u_char *buffer, int flags);
 124 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
 125 int nand_torture(nand_info_t *nand, loff_t offset);
 126
 127 #define NAND_LOCK_STATUS_TIGHT  0x01
 128 #define NAND_LOCK_STATUS_UNLOCK 0x04
 129
 130 int nand_lock(nand_info_t *meminfo, int tight);
 131 int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
 132         int allexcept);
 133 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
 134
 135 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
 136 void nand_deselect(void);
 137
 138 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
 139 void board_nand_select_device(struct nand_chip *nand, int chip);
 140 #endif
 141
 142 __attribute__((noreturn)) void nand_boot(void);
 143
 144 #endif
 145
 146 #ifdef CONFIG_ENV_OFFSET_OOB
 147 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
 148                                     as block number*/
 149 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
 150                                         stored as byte number */
 151 #define ENV_OFFSET_SIZE 8
 152 int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
 153 #endif
 154 int spl_nand_erase_one(int block, int page);