1 /* 2 * linux/include/linux/mtd/onenand.h 3 * 4 * Copyright (C) 2005-2007 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/mtd/onenand_regs.h> 16 17 /* Note: The header order is impoertant */ 18 #include <onenand_uboot.h> 19 20 #include <linux/mtd/compat.h> 21 #include <linux/mtd/bbm.h> 22 23 #define MAX_BUFFERRAM 2 24 #define MAX_ONENAND_PAGESIZE (2048 + 64) 25 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); 30 31 /** 32 * struct onenand_bufferram - OneNAND BufferRAM Data 33 * @param block block address in BufferRAM 34 * @param page page address in BufferRAM 35 * @param valid valid flag 36 */ 37 struct onenand_bufferram { 38 int block; 39 int page; 40 int valid; 41 }; 42 43 /** 44 * struct onenand_chip - OneNAND Private Flash Chip Data 45 * @param base [BOARDSPECIFIC] address to access OneNAND 46 * @param chipsize [INTERN] the size of one chip for multichip arrays 47 * @param device_id [INTERN] device ID 48 * @param verstion_id [INTERN] version ID 49 * @param options [BOARDSPECIFIC] various chip options. They can partly be set to inform onenand_scan about 50 * @param erase_shift [INTERN] number of address bits in a block 51 * @param page_shift [INTERN] number of address bits in a page 52 * @param ppb_shift [INTERN] number of address bits in a pages per block 53 * @param page_mask [INTERN] a page per block mask 54 * @param bufferam_index [INTERN] BufferRAM index 55 * @param bufferam [INTERN] BufferRAM info 56 * @param readw [REPLACEABLE] hardware specific function for read short 57 * @param writew [REPLACEABLE] hardware specific function for write short 58 * @param command [REPLACEABLE] hardware specific function for writing commands to the chip 59 * @param wait [REPLACEABLE] hardware specific function for wait on ready 60 * @param read_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area 61 * @param write_bufferram [REPLACEABLE] hardware specific function for BufferRAM Area 62 * @param chip_lock [INTERN] spinlock used to protect access to this structure and the chip 63 * @param wq [INTERN] wait queue to sleep on if a OneNAND operation is in progress 64 * @param state [INTERN] the current state of the OneNAND device 65 * @param autooob [REPLACEABLE] the default (auto)placement scheme 66 * @param priv [OPTIONAL] pointer to private chip date 67 */ 68 struct onenand_chip { 69 void __iomem *base; 70 unsigned int chipsize; 71 unsigned int device_id; 72 unsigned int options; 73 74 unsigned int erase_shift; 75 unsigned int page_shift; 76 unsigned int ppb_shift; /* Pages per block shift */ 77 unsigned int page_mask; 78 79 unsigned int bufferram_index; 80 struct onenand_bufferram bufferram[MAX_BUFFERRAM]; 81 82 int (*command) (struct mtd_info * mtd, int cmd, loff_t address, 83 size_t len); 84 int (*wait) (struct mtd_info * mtd, int state); 85 int (*read_bufferram) (struct mtd_info * mtd, int area, 86 unsigned char *buffer, int offset, size_t count); 87 int (*write_bufferram) (struct mtd_info * mtd, int area, 88 const unsigned char *buffer, int offset, 89 size_t count); 90 unsigned short (*read_word) (void __iomem * addr); 91 void (*write_word) (unsigned short value, void __iomem * addr); 92 void (*mmcontrol) (struct mtd_info * mtd, int sync_read); 93 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs); 94 int (*scan_bbt)(struct mtd_info *mtd); 95 96 spinlock_t chip_lock; 97 wait_queue_head_t wq; 98 int state; 99 100 struct nand_oobinfo *autooob; 101 102 void *bbm; 103 104 void *priv; 105 }; 106 107 #define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index) 108 #define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1) 109 #define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1) 110 111 /* 112 * Options bits 113 */ 114 #define ONENAND_CONT_LOCK (0x0001) 115 116 /* 117 * OneNAND Flash Manufacturer ID Codes 118 */ 119 #define ONENAND_MFR_SAMSUNG 0xec 120 #define ONENAND_MFR_UNKNOWN 0x00 121 122 /** 123 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure 124 * @param name: Manufacturer name 125 * @param id: manufacturer ID code of device. 126 */ 127 struct onenand_manufacturers { 128 int id; 129 char *name; 130 }; 131 132 #endif /* __LINUX_MTD_ONENAND_H */ 133