Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 1 | /* |
| 2 | * linux/include/linux/mtd/onenand.h |
| 3 | * |
Kyungmin Park | 75384b0 | 2007-01-18 11:10:57 +0900 | [diff] [blame] | 4 | * Copyright (C) 2005-2007 Samsung Electronics |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 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> |
Kyungmin Park | 2c22120 | 2006-11-16 11:23:48 +0900 | [diff] [blame] | 16 | #include <linux/completion.h> |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 17 | #include <linux/mtd/onenand_regs.h> |
Kyungmin Park | cdc0013 | 2005-09-03 07:15:48 +0100 | [diff] [blame] | 18 | #include <linux/mtd/bbm.h> |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 19 | |
| 20 | #define MAX_BUFFERRAM 2 |
| 21 | |
| 22 | /* Scan and identify a OneNAND device */ |
| 23 | extern int onenand_scan(struct mtd_info *mtd, int max_chips); |
| 24 | /* Free resources held by the OneNAND device */ |
| 25 | extern void onenand_release(struct mtd_info *mtd); |
| 26 | |
Randy Dunlap | ea9b6dc | 2006-06-28 21:48:38 -0700 | [diff] [blame] | 27 | /* |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 28 | * onenand_state_t - chip states |
| 29 | * Enumeration for OneNAND flash chip state |
| 30 | */ |
| 31 | typedef enum { |
| 32 | FL_READY, |
| 33 | FL_READING, |
| 34 | FL_WRITING, |
| 35 | FL_ERASING, |
| 36 | FL_SYNCING, |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 37 | FL_LOCKING, |
Kyungmin Park | 493c646 | 2006-05-12 17:03:07 +0300 | [diff] [blame] | 38 | FL_RESETING, |
| 39 | FL_OTPING, |
Kyungmin Park | a41371e | 2005-09-29 03:55:31 +0100 | [diff] [blame] | 40 | FL_PM_SUSPENDED, |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 41 | } onenand_state_t; |
| 42 | |
| 43 | /** |
| 44 | * struct onenand_bufferram - OneNAND BufferRAM Data |
Kyungmin Park | abf3c0f | 2007-02-02 09:29:36 +0900 | [diff] [blame] | 45 | * @blockpage: block & page address in BufferRAM |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 46 | */ |
| 47 | struct onenand_bufferram { |
Kyungmin Park | abf3c0f | 2007-02-02 09:29:36 +0900 | [diff] [blame] | 48 | int blockpage; |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 49 | }; |
| 50 | |
| 51 | /** |
| 52 | * struct onenand_chip - OneNAND Private Flash Chip Data |
Randy Dunlap | ea9b6dc | 2006-06-28 21:48:38 -0700 | [diff] [blame] | 53 | * @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 Dunlap | ea9b6dc | 2006-06-28 21:48:38 -0700 | [diff] [blame] | 62 | * @page_mask: [INTERN] a page per block mask |
| 63 | * @bufferram_index: [INTERN] BufferRAM index |
| 64 | * @bufferram: [INTERN] BufferRAM info |
| 65 | * @readw: [REPLACEABLE] hardware specific function for read short |
| 66 | * @writew: [REPLACEABLE] hardware specific function for write short |
| 67 | * @command: [REPLACEABLE] hardware specific function for writing |
| 68 | * commands to the chip |
| 69 | * @wait: [REPLACEABLE] hardware specific function for wait on ready |
| 70 | * @read_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area |
| 71 | * @write_bufferram: [REPLACEABLE] hardware specific function for BufferRAM Area |
| 72 | * @read_word: [REPLACEABLE] hardware specific function for read |
| 73 | * register of OneNAND |
| 74 | * @write_word: [REPLACEABLE] hardware specific function for write |
| 75 | * register of OneNAND |
| 76 | * @mmcontrol: sync burst read function |
| 77 | * @block_markbad: function to mark a block as bad |
| 78 | * @scan_bbt: [REPLACEALBE] hardware specific function for scanning |
| 79 | * Bad block Table |
| 80 | * @chip_lock: [INTERN] spinlock used to protect access to this |
| 81 | * structure and the chip |
| 82 | * @wq: [INTERN] wait queue to sleep on if a OneNAND |
| 83 | * operation is in progress |
| 84 | * @state: [INTERN] the current state of the OneNAND device |
Kyungmin Park | 470bc84 | 2007-03-09 10:08:11 +0900 | [diff] [blame] | 85 | * @page_buf: [INTERN] page main data buffer |
| 86 | * @oob_buf: [INTERN] page oob data buffer |
Kyungmin Park | 60d84f9 | 2006-12-22 16:21:54 +0900 | [diff] [blame] | 87 | * @subpagesize: [INTERN] holds the subpagesize |
Randy Dunlap | ea9b6dc | 2006-06-28 21:48:38 -0700 | [diff] [blame] | 88 | * @ecclayout: [REPLACEABLE] the default ecc placement scheme |
| 89 | * @bbm: [REPLACEABLE] pointer to Bad Block Management |
| 90 | * @priv: [OPTIONAL] pointer to private chip date |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 91 | */ |
| 92 | struct onenand_chip { |
| 93 | void __iomem *base; |
| 94 | unsigned int chipsize; |
| 95 | unsigned int device_id; |
Kyungmin Park | 28b79ff | 2006-09-26 09:45:28 +0000 | [diff] [blame] | 96 | unsigned int version_id; |
Kyungmin Park | 83a3683 | 2005-09-29 04:53:16 +0100 | [diff] [blame] | 97 | unsigned int density_mask; |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 98 | unsigned int options; |
| 99 | |
| 100 | unsigned int erase_shift; |
| 101 | unsigned int page_shift; |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 102 | unsigned int page_mask; |
| 103 | |
| 104 | unsigned int bufferram_index; |
| 105 | struct onenand_bufferram bufferram[MAX_BUFFERRAM]; |
| 106 | |
| 107 | int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len); |
| 108 | int (*wait)(struct mtd_info *mtd, int state); |
| 109 | int (*read_bufferram)(struct mtd_info *mtd, int area, |
| 110 | unsigned char *buffer, int offset, size_t count); |
| 111 | int (*write_bufferram)(struct mtd_info *mtd, int area, |
| 112 | const unsigned char *buffer, int offset, size_t count); |
| 113 | unsigned short (*read_word)(void __iomem *addr); |
| 114 | void (*write_word)(unsigned short value, void __iomem *addr); |
Kyungmin Park | 52b0eea | 2005-09-03 07:07:19 +0100 | [diff] [blame] | 115 | void (*mmcontrol)(struct mtd_info *mtd, int sync_read); |
Kyungmin Park | cdc0013 | 2005-09-03 07:15:48 +0100 | [diff] [blame] | 116 | int (*block_markbad)(struct mtd_info *mtd, loff_t ofs); |
| 117 | int (*scan_bbt)(struct mtd_info *mtd); |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 118 | |
Kyungmin Park | 2c22120 | 2006-11-16 11:23:48 +0900 | [diff] [blame] | 119 | struct completion complete; |
| 120 | int irq; |
| 121 | |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 122 | spinlock_t chip_lock; |
| 123 | wait_queue_head_t wq; |
| 124 | onenand_state_t state; |
Kyungmin Park | 532a37c | 2005-12-16 11:17:29 +0900 | [diff] [blame] | 125 | unsigned char *page_buf; |
Kyungmin Park | 470bc84 | 2007-03-09 10:08:11 +0900 | [diff] [blame] | 126 | unsigned char *oob_buf; |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 127 | |
Kyungmin Park | 60d84f9 | 2006-12-22 16:21:54 +0900 | [diff] [blame] | 128 | int subpagesize; |
Thomas Gleixner | 5bd34c0 | 2006-05-27 22:16:10 +0200 | [diff] [blame] | 129 | struct nand_ecclayout *ecclayout; |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 130 | |
Thomas Gleixner | 5bd34c0 | 2006-05-27 22:16:10 +0200 | [diff] [blame] | 131 | void *bbm; |
Kyungmin Park | cdc0013 | 2005-09-03 07:15:48 +0100 | [diff] [blame] | 132 | |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 133 | void *priv; |
| 134 | }; |
| 135 | |
Kyungmin Park | fcc3147 | 2005-09-03 07:20:08 +0100 | [diff] [blame] | 136 | /* |
| 137 | * Helper macros |
| 138 | */ |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 139 | #define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index) |
| 140 | #define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1) |
| 141 | #define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1) |
Adrian Hunter | a8de85d | 2007-01-04 09:51:26 +0200 | [diff] [blame] | 142 | #define ONENAND_SET_PREV_BUFFERRAM(this) (this->bufferram_index ^= 1) |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 143 | |
Kyungmin Park | fcc3147 | 2005-09-03 07:20:08 +0100 | [diff] [blame] | 144 | #define ONENAND_GET_SYS_CFG1(this) \ |
| 145 | (this->read_word(this->base + ONENAND_REG_SYS_CFG1)) |
| 146 | #define ONENAND_SET_SYS_CFG1(v, this) \ |
| 147 | (this->write_word(v, this->base + ONENAND_REG_SYS_CFG1)) |
| 148 | |
Kyungmin Park | 738d61f | 2007-01-15 17:09:14 +0900 | [diff] [blame] | 149 | #define ONENAND_IS_DDP(this) \ |
| 150 | (this->device_id & ONENAND_DEVICE_IS_DDP) |
| 151 | |
Kyungmin Park | 9c01f87d | 2006-05-12 17:02:31 +0300 | [diff] [blame] | 152 | /* Check byte access in OneNAND */ |
| 153 | #define ONENAND_CHECK_BYTE_ACCESS(addr) (addr & 0x1) |
| 154 | |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 155 | /* |
| 156 | * Options bits |
| 157 | */ |
Kyungmin Park | 28b79ff | 2006-09-26 09:45:28 +0000 | [diff] [blame] | 158 | #define ONENAND_HAS_CONT_LOCK (0x0001) |
| 159 | #define ONENAND_HAS_UNLOCK_ALL (0x0002) |
Kyungmin Park | 532a37c | 2005-12-16 11:17:29 +0900 | [diff] [blame] | 160 | #define ONENAND_PAGEBUF_ALLOC (0x1000) |
Kyungmin Park | 470bc84 | 2007-03-09 10:08:11 +0900 | [diff] [blame] | 161 | #define ONENAND_OOBBUF_ALLOC (0x2000) |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 162 | |
| 163 | /* |
| 164 | * OneNAND Flash Manufacturer ID Codes |
| 165 | */ |
| 166 | #define ONENAND_MFR_SAMSUNG 0xec |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 167 | |
| 168 | /** |
Randy Dunlap | ea9b6dc | 2006-06-28 21:48:38 -0700 | [diff] [blame] | 169 | * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure |
| 170 | * @name: Manufacturer name |
| 171 | * @id: manufacturer ID code of device. |
Kyungmin Park | cd5f634 | 2005-07-11 11:41:53 +0100 | [diff] [blame] | 172 | */ |
| 173 | struct onenand_manufacturers { |
| 174 | int id; |
| 175 | char *name; |
| 176 | }; |
| 177 | |
| 178 | #endif /* __LINUX_MTD_ONENAND_H */ |