blob: 9aa2a9149b583991c75054ffd15b583b8e540f3e [file] [log] [blame]
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01001/*
2 * linux/include/linux/mtd/onenand.h
3 *
Kyungmin Park75384b02007-01-18 11:10:57 +09004 * Copyright (C) 2005-2007 Samsung Electronics
Kyungmin Parkcd5f6342005-07-11 11:41:53 +01005 * 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>
Kyungmin Park2c221202006-11-16 11:23:48 +090016#include <linux/completion.h>
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010017#include <linux/mtd/onenand_regs.h>
Kyungmin Parkcdc00132005-09-03 07:15:48 +010018#include <linux/mtd/bbm.h>
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010019
20#define MAX_BUFFERRAM 2
21
22/* Scan and identify a OneNAND device */
23extern int onenand_scan(struct mtd_info *mtd, int max_chips);
24/* Free resources held by the OneNAND device */
25extern void onenand_release(struct mtd_info *mtd);
26
Randy Dunlapea9b6dc2006-06-28 21:48:38 -070027/*
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010028 * onenand_state_t - chip states
29 * Enumeration for OneNAND flash chip state
30 */
31typedef enum {
32 FL_READY,
33 FL_READING,
34 FL_WRITING,
35 FL_ERASING,
36 FL_SYNCING,
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010037 FL_LOCKING,
Kyungmin Park493c6462006-05-12 17:03:07 +030038 FL_RESETING,
39 FL_OTPING,
Kyungmin Parka41371e2005-09-29 03:55:31 +010040 FL_PM_SUSPENDED,
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010041} onenand_state_t;
42
43/**
44 * struct onenand_bufferram - OneNAND BufferRAM Data
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +090045 * @blockpage: block & page address in BufferRAM
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010046 */
47struct onenand_bufferram {
Kyungmin Parkabf3c0f2007-02-02 09:29:36 +090048 int blockpage;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010049};
50
51/**
52 * struct onenand_chip - OneNAND Private Flash Chip Data
Randy Dunlapea9b6dc2006-06-28 21:48:38 -070053 * @base: [BOARDSPECIFIC] address to access OneNAND
54 * @chipsize: [INTERN] the size of one chip for multichip arrays
55 * @device_id: [INTERN] device ID
56 * @density_mask: chip density, used for DDP devices
57 * @verstion_id: [INTERN] version ID
58 * @options: [BOARDSPECIFIC] various chip options. They can
59 * partly be set to inform onenand_scan about
60 * @erase_shift: [INTERN] number of address bits in a block
61 * @page_shift: [INTERN] number of address bits in a page
Randy Dunlapea9b6dc2006-06-28 21:48:38 -070062 * @page_mask: [INTERN] a page per block mask
Kyungmin Parkee9745f2007-06-30 13:57:49 +090063 * @writesize: [INTERN] a real page size
Randy Dunlapea9b6dc2006-06-28 21:48:38 -070064 * @bufferram_index: [INTERN] BufferRAM index
65 * @bufferram: [INTERN] BufferRAM info
66 * @readw: [REPLACEABLE] hardware specific function for read short
67 * @writew: [REPLACEABLE] hardware specific function for write short
68 * @command: [REPLACEABLE] hardware specific function for writing
69 * commands to the chip
70 * @wait: [REPLACEABLE] hardware specific function for wait on ready
71 * @read_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
72 * @write_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area
73 * @read_word: [REPLACEABLE] hardware specific function for read
74 * register of OneNAND
75 * @write_word: [REPLACEABLE] hardware specific function for write
76 * register of OneNAND
77 * @mmcontrol: sync burst read function
78 * @block_markbad: function to mark a block as bad
79 * @scan_bbt: [REPLACEALBE] hardware specific function for scanning
80 * Bad block Table
81 * @chip_lock: [INTERN] spinlock used to protect access to this
82 * structure and the chip
83 * @wq: [INTERN] wait queue to sleep on if a OneNAND
84 * operation is in progress
85 * @state: [INTERN] the current state of the OneNAND device
Kyungmin Park470bc842007-03-09 10:08:11 +090086 * @page_buf: [INTERN] page main data buffer
87 * @oob_buf: [INTERN] page oob data buffer
Kyungmin Park60d84f92006-12-22 16:21:54 +090088 * @subpagesize: [INTERN] holds the subpagesize
Randy Dunlapea9b6dc2006-06-28 21:48:38 -070089 * @ecclayout: [REPLACEABLE] the default ecc placement scheme
90 * @bbm: [REPLACEABLE] pointer to Bad Block Management
91 * @priv: [OPTIONAL] pointer to private chip date
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010092 */
93struct onenand_chip {
94 void __iomem *base;
95 unsigned int chipsize;
96 unsigned int device_id;
Kyungmin Park28b79ff2006-09-26 09:45:28 +000097 unsigned int version_id;
Kyungmin Park83a36832005-09-29 04:53:16 +010098 unsigned int density_mask;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +010099 unsigned int options;
100
101 unsigned int erase_shift;
102 unsigned int page_shift;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100103 unsigned int page_mask;
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900104 unsigned int writesize;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100105
106 unsigned int bufferram_index;
107 struct onenand_bufferram bufferram[MAX_BUFFERRAM];
108
109 int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len);
110 int (*wait)(struct mtd_info *mtd, int state);
111 int (*read_bufferram)(struct mtd_info *mtd, int area,
112 unsigned char *buffer, int offset, size_t count);
113 int (*write_bufferram)(struct mtd_info *mtd, int area,
114 const unsigned char *buffer, int offset, size_t count);
115 unsigned short (*read_word)(void __iomem *addr);
116 void (*write_word)(unsigned short value, void __iomem *addr);
Kyungmin Park52b0eea2005-09-03 07:07:19 +0100117 void (*mmcontrol)(struct mtd_info *mtd, int sync_read);
Kyungmin Parkcdc00132005-09-03 07:15:48 +0100118 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
119 int (*scan_bbt)(struct mtd_info *mtd);
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100120
Kyungmin Park2c221202006-11-16 11:23:48 +0900121 struct completion complete;
122 int irq;
123
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100124 spinlock_t chip_lock;
125 wait_queue_head_t wq;
126 onenand_state_t state;
Kyungmin Park532a37c2005-12-16 11:17:29 +0900127 unsigned char *page_buf;
Kyungmin Park470bc842007-03-09 10:08:11 +0900128 unsigned char *oob_buf;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100129
Kyungmin Park60d84f92006-12-22 16:21:54 +0900130 int subpagesize;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200131 struct nand_ecclayout *ecclayout;
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100132
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200133 void *bbm;
Kyungmin Parkcdc00132005-09-03 07:15:48 +0100134
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100135 void *priv;
136};
137
Kyungmin Parkfcc31472005-09-03 07:20:08 +0100138/*
139 * Helper macros
140 */
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100141#define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index)
142#define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1)
143#define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1)
Adrian Huntera8de85d2007-01-04 09:51:26 +0200144#define ONENAND_SET_PREV_BUFFERRAM(this) (this->bufferram_index ^= 1)
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900145#define ONENAND_SET_BUFFERRAM0(this) (this->bufferram_index = 0)
146#define ONENAND_SET_BUFFERRAM1(this) (this->bufferram_index = 1)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100147
Kyungmin Parkfcc31472005-09-03 07:20:08 +0100148#define ONENAND_GET_SYS_CFG1(this) \
149 (this->read_word(this->base + ONENAND_REG_SYS_CFG1))
150#define ONENAND_SET_SYS_CFG1(v, this) \
151 (this->write_word(v, this->base + ONENAND_REG_SYS_CFG1))
152
Kyungmin Park738d61f2007-01-15 17:09:14 +0900153#define ONENAND_IS_DDP(this) \
154 (this->device_id & ONENAND_DEVICE_IS_DDP)
155
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900156#ifdef CONFIG_MTD_ONENAND_2X_PROGRAM
157#define ONENAND_IS_2PLANE(this) \
158 (this->options & ONENAND_HAS_2PLANE)
159#else
160#define ONENAND_IS_2PLANE(this) (0)
161#endif
162
Kyungmin Park9c01f872006-05-12 17:02:31 +0300163/* Check byte access in OneNAND */
164#define ONENAND_CHECK_BYTE_ACCESS(addr) (addr & 0x1)
165
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100166/*
167 * Options bits
168 */
Kyungmin Park28b79ff2006-09-26 09:45:28 +0000169#define ONENAND_HAS_CONT_LOCK (0x0001)
170#define ONENAND_HAS_UNLOCK_ALL (0x0002)
Kyungmin Parkee9745f2007-06-30 13:57:49 +0900171#define ONENAND_HAS_2PLANE (0x0004)
Kyungmin Park532a37c2005-12-16 11:17:29 +0900172#define ONENAND_PAGEBUF_ALLOC (0x1000)
Kyungmin Park470bc842007-03-09 10:08:11 +0900173#define ONENAND_OOBBUF_ALLOC (0x2000)
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100174
175/*
176 * OneNAND Flash Manufacturer ID Codes
177 */
178#define ONENAND_MFR_SAMSUNG 0xec
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100179
180/**
Randy Dunlapea9b6dc2006-06-28 21:48:38 -0700181 * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure
182 * @name: Manufacturer name
183 * @id: manufacturer ID code of device.
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100184*/
185struct onenand_manufacturers {
186 int id;
187 char *name;
188};
189
Adrian Bunk607d1cb2008-04-14 17:20:38 +0300190int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
191 struct mtd_oob_ops *ops);
192
Kyungmin Parkcd5f6342005-07-11 11:41:53 +0100193#endif /* __LINUX_MTD_ONENAND_H */