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