tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * linux/include/linux/mtd/onenand.h
3 *
4 * Copyright © 2005-2009 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
12#ifndef __LINUX_MTD_ONENAND_H
13#define __LINUX_MTD_ONENAND_H
14
15#include <linux/spinlock.h>
16#include <linux/completion.h>
17#include <linux/mtd/flashchip.h>
18#include <linux/mtd/onenand_regs.h>
19#include <linux/mtd/bbm.h>
20
21#define MAX_DIES 2
22#define MAX_BUFFERRAM 2
23
24/* Scan and identify a OneNAND device */
25extern int onenand_scan(struct mtd_info *mtd, int max_chips);
26/* Free resources held by the OneNAND device */
27extern void onenand_release(struct mtd_info *mtd);
28
29/**
30 * struct onenand_bufferram - OneNAND BufferRAM Data
31 * @blockpage: block & page address in BufferRAM
32 */
33struct onenand_bufferram {
34 int blockpage;
35};
36
37/**
38 * struct onenand_chip - OneNAND Private Flash Chip Data
39 * @base: [BOARDSPECIFIC] address to access OneNAND
40 * @dies: [INTERN][FLEX-ONENAND] number of dies on chip
41 * @boundary: [INTERN][FLEX-ONENAND] Boundary of the dies
42 * @diesize: [INTERN][FLEX-ONENAND] Size of the dies
43 * @chipsize: [INTERN] the size of one chip for multichip arrays
44 * FIXME For Flex-OneNAND, chipsize holds maximum possible
45 * device size ie when all blocks are considered MLC
46 * @device_id: [INTERN] device ID
47 * @density_mask: chip density, used for DDP devices
48 * @verstion_id: [INTERN] version ID
49 * @options: [BOARDSPECIFIC] various chip options. They can
50 * partly be set to inform onenand_scan about
51 * @erase_shift: [INTERN] number of address bits in a block
52 * @page_shift: [INTERN] number of address bits in a page
53 * @page_mask: [INTERN] a page per block mask
54 * @writesize: [INTERN] a real page size
55 * @bufferram_index: [INTERN] BufferRAM index
56 * @bufferram: [INTERN] BufferRAM info
57 * @readw: [REPLACEABLE] hardware specific function for read short
58 * @writew: [REPLACEABLE] hardware specific function for write short
59 * @command: [REPLACEABLE] hardware specific function for writing
60 * commands to the chip
61 * @wait: [REPLACEABLE] hardware specific function for wait on ready
62 * @bbt_wait: [REPLACEABLE] hardware specific function for bbt wait on ready
63 * @unlock_all: [REPLACEABLE] hardware specific function for unlock all
64 * @read_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
65 * @write_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
66 * @read_word: [REPLACEABLE] hardware specific function for read
67 * register of OneNAND
68 * @write_word: [REPLACEABLE] hardware specific function for write
69 * register of OneNAND
70 * @mmcontrol: sync burst read function
71 * @block_markbad: function to mark a block as bad
72 * @scan_bbt: [REPLACEALBE] hardware specific function for scanning
73 * Bad block Table
74 * @chip_lock: [INTERN] spinlock used to protect access to this
75 * structure and the chip
76 * @wq: [INTERN] wait queue to sleep on if a OneNAND
77 * operation is in progress
78 * @state: [INTERN] the current state of the OneNAND device
79 * @page_buf: [INTERN] page main data buffer
80 * @oob_buf: [INTERN] page oob data buffer
81 * @subpagesize: [INTERN] holds the subpagesize
82 * @ecclayout: [REPLACEABLE] the default ecc placement scheme
83 * @bbm: [REPLACEABLE] pointer to Bad Block Management
84 * @priv: [OPTIONAL] pointer to private chip date
85 */
86struct onenand_chip {
87 void __iomem *base;
88 unsigned dies;
89 unsigned boundary[MAX_DIES];
90 loff_t diesize[MAX_DIES];
91 unsigned int chipsize;
92 unsigned int device_id;
93 unsigned int version_id;
94 unsigned int technology;
95 unsigned int density_mask;
96 unsigned int options;
97
98 unsigned int erase_shift;
99 unsigned int page_shift;
100 unsigned int page_mask;
101 unsigned int writesize;
102
103 unsigned int bufferram_index;
104 struct onenand_bufferram bufferram[MAX_BUFFERRAM];
105
106 int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len);
107 int (*wait)(struct mtd_info *mtd, int state);
108 int (*bbt_wait)(struct mtd_info *mtd, int state);
109 void (*unlock_all)(struct mtd_info *mtd);
110 int (*read_bufferram)(struct mtd_info *mtd, int area,
111 unsigned char *buffer, int offset, size_t count);
112 int (*write_bufferram)(struct mtd_info *mtd, int area,
113 const unsigned char *buffer, int offset, size_t count);
114 unsigned short (*read_word)(void __iomem *addr);
115 void (*write_word)(unsigned short value, void __iomem *addr);
116 void (*mmcontrol)(struct mtd_info *mtd, int sync_read);
117 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
118 int (*scan_bbt)(struct mtd_info *mtd);
119
120 struct completion complete;
121 int irq;
122
123 spinlock_t chip_lock;
124 wait_queue_head_t wq;
125 flstate_t state;
126 unsigned char *page_buf;
127 unsigned char *oob_buf;
128
129 int subpagesize;
130 struct nand_ecclayout *ecclayout;
131
132 void *bbm;
133
134 void *priv;
135};
136
137/*
138 * Helper macros
139 */
140#define ONENAND_PAGES_PER_BLOCK (1<<6)
141
142#define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index)
143#define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1)
144#define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1)
145#define ONENAND_SET_PREV_BUFFERRAM(this) (this->bufferram_index ^= 1)
146#define ONENAND_SET_BUFFERRAM0(this) (this->bufferram_index = 0)
147#define ONENAND_SET_BUFFERRAM1(this) (this->bufferram_index = 1)
148
149#define FLEXONENAND(this) \
150 (this->device_id & DEVICE_IS_FLEXONENAND)
151#define ONENAND_GET_SYS_CFG1(this) \
152 (this->read_word(this->base + ONENAND_REG_SYS_CFG1))
153#define ONENAND_SET_SYS_CFG1(v, this) \
154 (this->write_word(v, this->base + ONENAND_REG_SYS_CFG1))
155
156#define ONENAND_IS_DDP(this) \
157 (this->device_id & ONENAND_DEVICE_IS_DDP)
158
159#define ONENAND_IS_MLC(this) \
160 (this->technology & ONENAND_TECHNOLOGY_IS_MLC)
161
162#ifdef CONFIG_MTD_ONENAND_2X_PROGRAM
163#define ONENAND_IS_2PLANE(this) \
164 (this->options & ONENAND_HAS_2PLANE)
165#else
166#define ONENAND_IS_2PLANE(this) (0)
167#endif
168
169/* Check byte access in OneNAND */
170#define ONENAND_CHECK_BYTE_ACCESS(addr) (addr & 0x1)
171
172/*
173 * Options bits
174 */
175#define ONENAND_HAS_CONT_LOCK (0x0001)
176#define ONENAND_HAS_UNLOCK_ALL (0x0002)
177#define ONENAND_HAS_2PLANE (0x0004)
178#define ONENAND_SKIP_UNLOCK_CHECK (0x0100)
179#define ONENAND_PAGEBUF_ALLOC (0x1000)
180#define ONENAND_OOBBUF_ALLOC (0x2000)
181
182/*
183 * OneNAND Flash Manufacturer ID Codes
184 */
185#define ONENAND_MFR_SAMSUNG 0xec
186#define ONENAND_MFR_NUMONYX 0x20
187
188/**
189 * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure
190 * @name: Manufacturer name
191 * @id: manufacturer ID code of device.
192*/
193struct onenand_manufacturers {
194 int id;
195 char *name;
196};
197
198int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
199 struct mtd_oob_ops *ops);
200unsigned onenand_block(struct onenand_chip *this, loff_t addr);
201loff_t onenand_addr(struct onenand_chip *this, int block);
202int flexonenand_region(struct mtd_info *mtd, loff_t addr);
203
204struct mtd_partition;
205
206struct onenand_platform_data {
207 void (*mmcontrol)(struct mtd_info *mtd, int sync_read);
208 struct mtd_partition *parts;
209 unsigned int nr_parts;
210};
211
212#endif /* __LINUX_MTD_ONENAND_H */