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  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #ifndef _NAND_H_
  25 #define _NAND_H_
  26
  27 extern void nand_init(void);
  28
  29 #include <linux/mtd/compat.h>
  30 #include <linux/mtd/mtd.h>
  31 #include <linux/mtd/nand.h>
  32
  33 #ifdef CONFIG_SYS_NAND_SELF_INIT
  34 void board_nand_init(void);
  35 int nand_register(int devnum);
  36 #else
  37 extern int board_nand_init(struct nand_chip *nand);
  38 #endif
  39
  40 typedef struct mtd_info nand_info_t;
  41
  42 extern int nand_curr_device;
  43 extern nand_info_t nand_info[];
  44
  45 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  46 {
  47         return info->read(info, ofs, *len, (size_t *)len, buf);
  48 }
  49
  50 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  51 {
  52         return info->write(info, ofs, *len, (size_t *)len, buf);
  53 }
  54
  55 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
  56 {
  57         return info->block_isbad(info, ofs);
  58 }
  59
  60 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
  61 {
  62         struct erase_info instr;
  63
  64         instr.mtd = info;
  65         instr.addr = off;
  66         instr.len = size;
  67         instr.callback = 0;
  68
  69         return info->erase(info, &instr);
  70 }
  71
  72
  73 /*****************************************************************************
  74  * declarations from nand_util.c
  75  ****************************************************************************/
  76
  77 struct nand_write_options {
  78         u_char *buffer;         /* memory block containing image to write */
  79         ulong length;           /* number of bytes to write */
  80         ulong offset;           /* start address in NAND */
  81         int quiet;              /* don't display progress messages */
  82         int autoplace;          /* if true use auto oob layout */
  83         int forcejffs2;         /* force jffs2 oob layout */
  84         int forceyaffs;         /* force yaffs oob layout */
  85         int noecc;              /* write without ecc */
  86         int writeoob;           /* image contains oob data */
  87         int pad;                /* pad to page size */
  88         int blockalign;         /* 1|2|4 set multiple of eraseblocks
  89                                  * to align to */
  90 };
  91
  92 typedef struct nand_write_options nand_write_options_t;
  93 typedef struct mtd_oob_ops mtd_oob_ops_t;
  94
  95 struct nand_read_options {
  96         u_char *buffer;         /* memory block in which read image is written*/
  97         ulong length;           /* number of bytes to read */
  98         ulong offset;           /* start address in NAND */
  99         int quiet;              /* don't display progress messages */
 100         int readoob;            /* put oob data in image */
 101 };
 102
 103 typedef struct nand_read_options nand_read_options_t;
 104
 105 struct nand_erase_options {
 106         loff_t length;          /* number of bytes to erase */
 107         loff_t offset;          /* first address in NAND to erase */
 108         int quiet;              /* don't display progress messages */
 109         int jffs2;              /* if true: format for jffs2 usage
 110                                  * (write appropriate cleanmarker blocks) */
 111         int scrub;              /* if true, really clean NAND by erasing
 112                                  * bad blocks (UNSAFE) */
 113
 114         /* Don't include skipped bad blocks in size to be erased */
 115         int spread;
 116 };
 117
 118 typedef struct nand_erase_options nand_erase_options_t;
 119
 120 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 121                        u_char *buffer);
 122
 123 #define WITH_YAFFS_OOB  (1 << 0) /* whether write with yaffs format. This flag
 124                                   * is a 'mode' meaning it cannot be mixed with
 125                                   * other flags */
 126 #define WITH_DROP_FFS   (1 << 1) /* drop trailing all-0xff pages */
 127
 128 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 129                         u_char *buffer, int flags);
 130 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
 131
 132 #define NAND_LOCK_STATUS_TIGHT  0x01
 133 #define NAND_LOCK_STATUS_LOCK   0x02
 134 #define NAND_LOCK_STATUS_UNLOCK 0x04
 135
 136 int nand_lock( nand_info_t *meminfo, int tight );
 137 int nand_unlock( nand_info_t *meminfo, ulong start, ulong length );
 138 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
 139
 140 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
 141 void nand_deselect(void);
 142
 143 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
 144 void board_nand_select_device(struct nand_chip *nand, int chip);
 145 #endif
 146
 147 __attribute__((noreturn)) void nand_boot(void);
 148
 149 #endif
 150
 151 #ifdef CONFIG_ENV_OFFSET_OOB
 152 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
 153                                     as block number*/
 154 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
 155                                         stored as byte number */
 156 #define ENV_OFFSET_SIZE 8
 157 int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
 158 #endif