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 /*
  20  * All boards using a given driver must convert to self-init
  21  * at the same time, so do it here.  When all drivers are
  22  * converted, this will go away.
  23  */
  24 #ifdef CONFIG_SPL_BUILD
  25 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_FSL_IFC)
  26 #define CONFIG_SYS_NAND_SELF_INIT
  27 #endif
  28 #else
  29 #if defined(CONFIG_NAND_FSL_ELBC) || defined(CONFIG_NAND_ATMEL)\
  30         || defined(CONFIG_NAND_FSL_IFC)
  31 #define CONFIG_SYS_NAND_SELF_INIT
  32 #endif
  33 #endif
  34
  35 extern void nand_init(void);
  36
  37 #include <linux/compat.h>
  38 #include <linux/mtd/mtd.h>
  39 #include <linux/mtd/nand.h>
  40
  41 #ifdef CONFIG_SYS_NAND_SELF_INIT
  42 void board_nand_init(void);
  43 int nand_register(int devnum);
  44 #else
  45 extern int board_nand_init(struct nand_chip *nand);
  46 #endif
  47
  48 typedef struct mtd_info nand_info_t;
  49
  50 extern int nand_curr_device;
  51 extern nand_info_t nand_info[];
  52
  53 static inline int nand_read(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  54 {
  55         return mtd_read(info, ofs, *len, (size_t *)len, buf);
  56 }
  57
  58 static inline int nand_write(nand_info_t *info, loff_t ofs, size_t *len, u_char *buf)
  59 {
  60         return mtd_write(info, ofs, *len, (size_t *)len, buf);
  61 }
  62
  63 static inline int nand_block_isbad(nand_info_t *info, loff_t ofs)
  64 {
  65         return mtd_block_isbad(info, ofs);
  66 }
  67
  68 static inline int nand_erase(nand_info_t *info, loff_t off, size_t size)
  69 {
  70         struct erase_info instr;
  71
  72         instr.mtd = info;
  73         instr.addr = off;
  74         instr.len = size;
  75         instr.callback = 0;
  76
  77         return mtd_erase(info, &instr);
  78 }
  79
  80
  81 /*****************************************************************************
  82  * declarations from nand_util.c
  83  ****************************************************************************/
  84
  85 struct nand_write_options {
  86         u_char *buffer;         /* memory block containing image to write */
  87         ulong length;           /* number of bytes to write */
  88         ulong offset;           /* start address in NAND */
  89         int quiet;              /* don't display progress messages */
  90         int autoplace;          /* if true use auto oob layout */
  91         int forcejffs2;         /* force jffs2 oob layout */
  92         int forceyaffs;         /* force yaffs oob layout */
  93         int noecc;              /* write without ecc */
  94         int writeoob;           /* image contains oob data */
  95         int pad;                /* pad to page size */
  96         int blockalign;         /* 1|2|4 set multiple of eraseblocks
  97                                  * to align to */
  98 };
  99
 100 typedef struct nand_write_options nand_write_options_t;
 101 typedef struct mtd_oob_ops mtd_oob_ops_t;
 102
 103 struct nand_read_options {
 104         u_char *buffer;         /* memory block in which read image is written*/
 105         ulong length;           /* number of bytes to read */
 106         ulong offset;           /* start address in NAND */
 107         int quiet;              /* don't display progress messages */
 108         int readoob;            /* put oob data in image */
 109 };
 110
 111 typedef struct nand_read_options nand_read_options_t;
 112
 113 struct nand_erase_options {
 114         loff_t length;          /* number of bytes to erase */
 115         loff_t offset;          /* first address in NAND to erase */
 116         int quiet;              /* don't display progress messages */
 117         int jffs2;              /* if true: format for jffs2 usage
 118                                  * (write appropriate cleanmarker blocks) */
 119         int scrub;              /* if true, really clean NAND by erasing
 120                                  * bad blocks (UNSAFE) */
 121
 122         /* Don't include skipped bad blocks in size to be erased */
 123         int spread;
 124         /* maximum size that actual may be in order to not exceed the buf */
 125         loff_t lim;
 126 };
 127
 128 typedef struct nand_erase_options nand_erase_options_t;
 129
 130 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 131                        size_t *actual, loff_t lim, u_char *buffer);
 132
 133 #define WITH_YAFFS_OOB  (1 << 0) /* whether write with yaffs format. This flag
 134                                   * is a 'mode' meaning it cannot be mixed with
 135                                   * other flags */
 136 #define WITH_DROP_FFS   (1 << 1) /* drop trailing all-0xff pages */
 137
 138 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
 139                         size_t *actual, loff_t lim, u_char *buffer, int flags);
 140 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts);
 141 int nand_torture(nand_info_t *nand, loff_t offset);
 142
 143 #define NAND_LOCK_STATUS_TIGHT  0x01
 144 #define NAND_LOCK_STATUS_UNLOCK 0x04
 145
 146 int nand_lock(nand_info_t *meminfo, int tight);
 147 int nand_unlock(nand_info_t *meminfo, loff_t start, size_t length,
 148         int allexcept);
 149 int nand_get_lock_status(nand_info_t *meminfo, loff_t offset);
 150
 151 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst);
 152 void nand_deselect(void);
 153
 154 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
 155 void board_nand_select_device(struct nand_chip *nand, int chip);
 156 #endif
 157
 158 __attribute__((noreturn)) void nand_boot(void);
 159
 160 #endif
 161
 162 #ifdef CONFIG_ENV_OFFSET_OOB
 163 #define ENV_OOB_MARKER 0x30425645 /*"EVB0" in little-endian -- offset is stored
 164                                     as block number*/
 165 #define ENV_OOB_MARKER_OLD 0x30564e45 /*"ENV0" in little-endian -- offset is
 166                                         stored as byte number */
 167 #define ENV_OFFSET_SIZE 8
 168 int get_nand_env_oob(nand_info_t *nand, unsigned long *result);
 169 #endif