2 * linux/include/linux/mtd/onenand.h
4 * Copyright (C) 2005-2007 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
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.
12 #ifndef __LINUX_MTD_ONENAND_H
13 #define __LINUX_MTD_ONENAND_H
15 #include <linux/mtd/onenand_regs.h>
17 /* Note: The header order is impoertant */
18 #include <onenand_uboot.h>
20 #include <linux/mtd/compat.h>
21 #include <linux/mtd/bbm.h>
23 #define MAX_BUFFERRAM 2
24 #define MAX_ONENAND_PAGESIZE (2048 + 64)
26 /* Scan and identify a OneNAND device */
27 extern int onenand_scan (struct mtd_info
*mtd
, int max_chips
);
28 /* Free resources held by the OneNAND device */
29 extern void onenand_release (struct mtd_info
*mtd
);
32 * struct onenand_bufferram - OneNAND BufferRAM Data
33 * @param blockpage block & page address in BufferRAM
35 struct onenand_bufferram
{
40 * struct onenand_chip - OneNAND Private Flash Chip Data
41 * @param base [BOARDSPECIFIC] address to access OneNAND
42 * @param chipsize [INTERN] the size of one chip for multichip arrays
43 * @param device_id [INTERN] device ID
44 * @param verstion_id [INTERN] version ID
45 * @param options [BOARDSPECIFIC] various chip options. They can partly be set to inform onenand_scan about
46 * @param erase_shift [INTERN] number of address bits in a block
47 * @param page_shift [INTERN] number of address bits in a page
48 * @param ppb_shift [INTERN] number of address bits in a pages per block
49 * @param page_mask [INTERN] a page per block mask
50 * @param writesize [INTERN] a real page size
51 * @param bufferam_index [INTERN] BufferRAM index
52 * @param bufferam [INTERN] BufferRAM info
53 * @param readw [REPLACEABLE] hardware specific function for read short
54 * @param writew [REPLACEABLE] hardware specific function for write short
55 * @param command [REPLACEABLE] hardware specific function for writing commands to the chip
56 * @param wait [REPLACEABLE] hardware specific function for wait on ready
57 * @param read_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area
58 * @param write_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area
59 * @param chip_lock [INTERN] spinlock used to protect access to this structure and the chip
60 * @param wq [INTERN] wait queue to sleep on if a OneNAND operation is in progress
61 * @param state [INTERN] the current state of the OneNAND device
62 * @param autooob [REPLACEABLE] the default (auto)placement scheme
63 * @param priv [OPTIONAL] pointer to private chip date
67 unsigned int chipsize
;
68 unsigned int device_id
;
69 unsigned int version_id
;
70 unsigned int density_mask
;
73 unsigned int erase_shift
;
74 unsigned int page_shift
;
75 unsigned int ppb_shift
; /* Pages per block shift */
76 unsigned int page_mask
;
77 unsigned int writesize
;
79 unsigned int bufferram_index
;
80 struct onenand_bufferram bufferram
[MAX_BUFFERRAM
];
82 int (*command
) (struct mtd_info
*mtd
, int cmd
, loff_t address
,
84 int (*wait
) (struct mtd_info
*mtd
, int state
);
85 int (*bbt_wait
) (struct mtd_info
*mtd
, int state
);
86 int (*read_bufferram
) (struct mtd_info
*mtd
, loff_t addr
, int area
,
87 unsigned char *buffer
, int offset
, size_t count
);
88 int (*read_spareram
) (struct mtd_info
*mtd
, loff_t addr
, int area
,
89 unsigned char *buffer
, int offset
, size_t count
);
90 int (*write_bufferram
) (struct mtd_info
*mtd
, loff_t addr
, int area
,
91 const unsigned char *buffer
, int offset
,
93 unsigned short (*read_word
) (void __iomem
*addr
);
94 void (*write_word
) (unsigned short value
, void __iomem
*addr
);
95 void (*mmcontrol
) (struct mtd_info
*mtd
, int sync_read
);
96 int (*block_markbad
)(struct mtd_info
*mtd
, loff_t ofs
);
97 int (*scan_bbt
)(struct mtd_info
*mtd
);
99 unsigned char *main_buf
;
100 unsigned char *spare_buf
;
101 #ifdef DONT_USE_UBOOT
102 spinlock_t chip_lock
;
103 wait_queue_head_t wq
;
106 unsigned char *page_buf
;
107 unsigned char *oob_buf
;
109 struct nand_oobinfo
*autooob
;
111 struct nand_ecclayout
*ecclayout
;
121 #define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index)
122 #define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1)
123 #define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1)
124 #define ONENAND_SET_PREV_BUFFERRAM(this) (this->bufferram_index ^= 1)
125 #define ONENAND_SET_BUFFERRAM0(this) (this->bufferram_index = 0)
126 #define ONENAND_SET_BUFFERRAM1(this) (this->bufferram_index = 1)
128 #define ONENAND_IS_DDP(this) \
129 (this->device_id & ONENAND_DEVICE_IS_DDP)
131 #define ONENAND_IS_2PLANE(this) (0)
136 #define ONENAND_HAS_CONT_LOCK (0x0001)
137 #define ONENAND_HAS_UNLOCK_ALL (0x0002)
138 #define ONENAND_HAS_2PLANE (0x0004)
139 #define ONENAND_PAGEBUF_ALLOC (0x1000)
140 #define ONENAND_OOBBUF_ALLOC (0x2000)
143 * OneNAND Flash Manufacturer ID Codes
145 #define ONENAND_MFR_SAMSUNG 0xec
148 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
149 * @param name: Manufacturer name
150 * @param id: manufacturer ID code of device.
152 struct onenand_manufacturers
{
157 int onenand_bbt_read_oob(struct mtd_info
*mtd
, loff_t from
,
158 struct mtd_oob_ops
*ops
);
160 #endif /* __LINUX_MTD_ONENAND_H */