drivers/mtd/devices/docg3.h

   1 /*
   2  * Handles the M-Systems DiskOnChip G3 chip
   3  *
   4  * Copyright (C) 2011 Robert Jarzmik
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef _MTD_DOCG3_H
  23 #define _MTD_DOCG3_H
  24
  25 /*
  26  * Flash memory areas :
  27  *   - 0x0000 .. 0x07ff : IPL
  28  *   - 0x0800 .. 0x0fff : Data area
  29  *   - 0x1000 .. 0x17ff : Registers
  30  *   - 0x1800 .. 0x1fff : Unknown
  31  */
  32 #define DOC_IOSPACE_IPL                 0x0000
  33 #define DOC_IOSPACE_DATA                0x0800
  34 #define DOC_IOSPACE_SIZE                0x2000
  35
  36 /*
  37  * DOC G3 layout and adressing scheme
  38  *   A page address for the block "b", plane "P" and page "p":
  39  *   address = [bbbb bPpp pppp]
  40  */
  41
  42 #define DOC_ADDR_PAGE_MASK              0x3f
  43 #define DOC_ADDR_BLOCK_SHIFT            6
  44 #define DOC_LAYOUT_NBPLANES             2
  45 #define DOC_LAYOUT_PAGES_PER_BLOCK      64
  46 #define DOC_LAYOUT_PAGE_SIZE            512
  47 #define DOC_LAYOUT_OOB_SIZE             16
  48 #define DOC_LAYOUT_WEAR_SIZE            8
  49 #define DOC_LAYOUT_PAGE_OOB_SIZE                                \
  50         (DOC_LAYOUT_PAGE_SIZE + DOC_LAYOUT_OOB_SIZE)
  51 #define DOC_LAYOUT_WEAR_OFFSET          (DOC_LAYOUT_PAGE_OOB_SIZE * 2)
  52 #define DOC_LAYOUT_BLOCK_SIZE                                   \
  53         (DOC_LAYOUT_PAGES_PER_BLOCK * DOC_LAYOUT_PAGE_SIZE)
  54 #define DOC_ECC_BCH_SIZE                7
  55 #define DOC_ECC_BCH_COVERED_BYTES                               \
  56         (DOC_LAYOUT_PAGE_SIZE + DOC_LAYOUT_OOB_PAGEINFO_SZ +    \
  57          DOC_LAYOUT_OOB_HAMMING_SZ + DOC_LAYOUT_OOB_BCH_SZ)
  58
  59 /*
  60  * Blocks distribution
  61  */
  62 #define DOC_LAYOUT_BLOCK_BBT            0
  63 #define DOC_LAYOUT_BLOCK_OTP            0
  64 #define DOC_LAYOUT_BLOCK_FIRST_DATA     6
  65
  66 #define DOC_LAYOUT_PAGE_BBT             4
  67
  68 /*
  69  * Extra page OOB (16 bytes wide) layout
  70  */
  71 #define DOC_LAYOUT_OOB_PAGEINFO_OFS     0
  72 #define DOC_LAYOUT_OOB_HAMMING_OFS      7
  73 #define DOC_LAYOUT_OOB_BCH_OFS          8
  74 #define DOC_LAYOUT_OOB_UNUSED_OFS       15
  75 #define DOC_LAYOUT_OOB_PAGEINFO_SZ      7
  76 #define DOC_LAYOUT_OOB_HAMMING_SZ       1
  77 #define DOC_LAYOUT_OOB_BCH_SZ           7
  78 #define DOC_LAYOUT_OOB_UNUSED_SZ        1
  79
  80
  81 #define DOC_CHIPID_G3                   0x200
  82 #define DOC_ERASE_MARK                  0xaa
  83 #define DOC_MAX_NBFLOORS                4
  84 /*
  85  * Flash registers
  86  */
  87 #define DOC_CHIPID                      0x1000
  88 #define DOC_TEST                        0x1004
  89 #define DOC_BUSLOCK                     0x1006
  90 #define DOC_ENDIANCONTROL               0x1008
  91 #define DOC_DEVICESELECT                0x100a
  92 #define DOC_ASICMODE                    0x100c
  93 #define DOC_CONFIGURATION               0x100e
  94 #define DOC_INTERRUPTCONTROL            0x1010
  95 #define DOC_READADDRESS                 0x101a
  96 #define DOC_DATAEND                     0x101e
  97 #define DOC_INTERRUPTSTATUS             0x1020
  98
  99 #define DOC_FLASHSEQUENCE               0x1032
 100 #define DOC_FLASHCOMMAND                0x1034
 101 #define DOC_FLASHADDRESS                0x1036
 102 #define DOC_FLASHCONTROL                0x1038
 103 #define DOC_NOP                         0x103e
 104
 105 #define DOC_ECCCONF0                    0x1040
 106 #define DOC_ECCCONF1                    0x1042
 107 #define DOC_ECCPRESET                   0x1044
 108 #define DOC_HAMMINGPARITY               0x1046
 109 #define DOC_BCH_SYNDROM(idx)            (0x1048 + (idx << 0))
 110
 111 #define DOC_PROTECTION                  0x1056
 112 #define DOC_DPS0_ADDRLOW                0x1060
 113 #define DOC_DPS0_ADDRHIGH               0x1062
 114 #define DOC_DPS1_ADDRLOW                0x1064
 115 #define DOC_DPS1_ADDRHIGH               0x1066
 116 #define DOC_DPS0_STATUS                 0x106c
 117 #define DOC_DPS1_STATUS                 0x106e
 118
 119 #define DOC_ASICMODECONFIRM             0x1072
 120 #define DOC_CHIPID_INV                  0x1074
 121
 122 /*
 123  * Flash sequences
 124  * A sequence is preset before one or more commands are input to the chip.
 125  */
 126 #define DOC_SEQ_RESET                   0x00
 127 #define DOC_SEQ_PAGE_SIZE_532           0x03
 128 #define DOC_SEQ_SET_MODE                0x09
 129 #define DOC_SEQ_READ                    0x12
 130 #define DOC_SEQ_SET_PLANE1              0x0e
 131 #define DOC_SEQ_SET_PLANE2              0x10
 132 #define DOC_SEQ_PAGE_SETUP              0x1d
 133 #define DOC_SEQ_ERASE                   0x27
 134 #define DOC_SEQ_PLANES_STATUS           0x31
 135
 136 /*
 137  * Flash commands
 138  */
 139 #define DOC_CMD_READ_PLANE1             0x00
 140 #define DOC_CMD_SET_ADDR_READ           0x05
 141 #define DOC_CMD_READ_ALL_PLANES         0x30
 142 #define DOC_CMD_READ_PLANE2             0x50
 143 #define DOC_CMD_READ_FLASH              0xe0
 144 #define DOC_CMD_PAGE_SIZE_532           0x3c
 145
 146 #define DOC_CMD_PROG_BLOCK_ADDR         0x60
 147 #define DOC_CMD_PROG_CYCLE1             0x80
 148 #define DOC_CMD_PROG_CYCLE2             0x10
 149 #define DOC_CMD_PROG_CYCLE3             0x11
 150 #define DOC_CMD_ERASECYCLE2             0xd0
 151 #define DOC_CMD_READ_STATUS             0x70
 152 #define DOC_CMD_PLANES_STATUS           0x71
 153
 154 #define DOC_CMD_RELIABLE_MODE           0x22
 155 #define DOC_CMD_FAST_MODE               0xa2
 156
 157 #define DOC_CMD_RESET                   0xff
 158
 159 /*
 160  * Flash register : DOC_FLASHCONTROL
 161  */
 162 #define DOC_CTRL_VIOLATION              0x20
 163 #define DOC_CTRL_CE                     0x10
 164 #define DOC_CTRL_UNKNOWN_BITS           0x08
 165 #define DOC_CTRL_PROTECTION_ERROR       0x04
 166 #define DOC_CTRL_SEQUENCE_ERROR         0x02
 167 #define DOC_CTRL_FLASHREADY             0x01
 168
 169 /*
 170  * Flash register : DOC_ASICMODE
 171  */
 172 #define DOC_ASICMODE_RESET              0x00
 173 #define DOC_ASICMODE_NORMAL             0x01
 174 #define DOC_ASICMODE_POWERDOWN          0x02
 175 #define DOC_ASICMODE_MDWREN             0x04
 176 #define DOC_ASICMODE_BDETCT_RESET       0x08
 177 #define DOC_ASICMODE_RSTIN_RESET        0x10
 178 #define DOC_ASICMODE_RAM_WE             0x20
 179
 180 /*
 181  * Flash register : DOC_ECCCONF0
 182  */
 183 #define DOC_ECCCONF0_READ_MODE          0x8000
 184 #define DOC_ECCCONF0_AUTO_ECC_ENABLE    0x4000
 185 #define DOC_ECCCONF0_HAMMING_ENABLE     0x1000
 186 #define DOC_ECCCONF0_BCH_ENABLE         0x0800
 187 #define DOC_ECCCONF0_DATA_BYTES_MASK    0x07ff
 188
 189 /*
 190  * Flash register : DOC_ECCCONF1
 191  */
 192 #define DOC_ECCCONF1_BCH_SYNDROM_ERR    0x80
 193 #define DOC_ECCCONF1_UNKOWN1            0x40
 194 #define DOC_ECCCONF1_PAGE_IS_WRITTEN    0x20
 195 #define DOC_ECCCONF1_UNKOWN3            0x10
 196 #define DOC_ECCCONF1_HAMMING_BITS_MASK  0x0f
 197
 198 /*
 199  * Flash register : DOC_PROTECTION
 200  */
 201 #define DOC_PROTECT_FOUNDRY_OTP_LOCK    0x01
 202 #define DOC_PROTECT_CUSTOMER_OTP_LOCK   0x02
 203 #define DOC_PROTECT_LOCK_INPUT          0x04
 204 #define DOC_PROTECT_STICKY_LOCK         0x08
 205 #define DOC_PROTECT_PROTECTION_ENABLED  0x10
 206 #define DOC_PROTECT_IPL_DOWNLOAD_LOCK   0x20
 207 #define DOC_PROTECT_PROTECTION_ERROR    0x80
 208
 209 /*
 210  * Flash register : DOC_DPS0_STATUS and DOC_DPS1_STATUS
 211  */
 212 #define DOC_DPS_OTP_PROTECTED           0x01
 213 #define DOC_DPS_READ_PROTECTED          0x02
 214 #define DOC_DPS_WRITE_PROTECTED         0x04
 215 #define DOC_DPS_HW_LOCK_ENABLED         0x08
 216 #define DOC_DPS_KEY_OK                  0x80
 217
 218 /*
 219  * Flash register : DOC_CONFIGURATION
 220  */
 221 #define DOC_CONF_IF_CFG                 0x80
 222 #define DOC_CONF_MAX_ID_MASK            0x30
 223 #define DOC_CONF_VCCQ_3V                0x01
 224
 225 /*
 226  * Flash register : DOC_READADDRESS
 227  */
 228 #define DOC_READADDR_INC                0x8000
 229 #define DOC_READADDR_ONE_BYTE           0x4000
 230 #define DOC_READADDR_ADDR_MASK          0x1fff
 231
 232 /*
 233  * Status of erase and write operation
 234  */
 235 #define DOC_PLANES_STATUS_FAIL          0x01
 236 #define DOC_PLANES_STATUS_PLANE0_KO     0x02
 237 #define DOC_PLANES_STATUS_PLANE1_KO     0x04
 238
 239 /**
 240  * struct docg3 - DiskOnChip driver private data
 241  * @dev: the device currently under control
 242  * @base: mapped IO space
 243  * @device_id: number of the cascaded DoCG3 device (0, 1, 2 or 3)
 244  * @if_cfg: if true, reads are on 16bits, else reads are on 8bits
 245  * @bbt: bad block table cache
 246  * @oob_write_ofs: offset of the MTD where this OOB should belong (ie. in next
 247  *                 page_write)
 248  * @oob_autoecc: if 1, use only bytes 0-7, 15, and fill the others with HW ECC
 249  *               if 0, use all the 16 bytes.
 250  * @oob_write_buf: prepared OOB for next page_write
 251  * @debugfs_root: debugfs root node
 252  */
 253 struct docg3 {
 254         struct device *dev;
 255         void __iomem *base;
 256         unsigned int device_id:4;
 257         unsigned int if_cfg:1;
 258         int max_block;
 259         u8 *bbt;
 260         loff_t oob_write_ofs;
 261         int oob_autoecc;
 262         u8 oob_write_buf[DOC_LAYOUT_OOB_SIZE];
 263         struct dentry *debugfs_root;
 264 };
 265
 266 #define doc_err(fmt, arg...) dev_err(docg3->dev, (fmt), ## arg)
 267 #define doc_info(fmt, arg...) dev_info(docg3->dev, (fmt), ## arg)
 268 #define doc_dbg(fmt, arg...) dev_dbg(docg3->dev, (fmt), ## arg)
 269 #define doc_vdbg(fmt, arg...) dev_vdbg(docg3->dev, (fmt), ## arg)
 270
 271 #define DEBUGFS_RO_ATTR(name, show_fct) \
 272         static int name##_open(struct inode *inode, struct file *file) \
 273         { return single_open(file, show_fct, inode->i_private); }      \
 274         static const struct file_operations name##_fops = { \
 275                 .owner = THIS_MODULE, \
 276                 .open = name##_open, \
 277                 .llseek = seq_lseek, \
 278                 .read = seq_read, \
 279                 .release = single_release \
 280         };
 281 #endif
 282
 283 /*
 284  * Trace events part
 285  */
 286 #undef TRACE_SYSTEM
 287 #define TRACE_SYSTEM docg3
 288
 289 #if !defined(_MTD_DOCG3_TRACE) || defined(TRACE_HEADER_MULTI_READ)
 290 #define _MTD_DOCG3_TRACE
 291
 292 #include <linux/tracepoint.h>
 293
 294 TRACE_EVENT(docg3_io,
 295             TP_PROTO(int op, int width, u16 reg, int val),
 296             TP_ARGS(op, width, reg, val),
 297             TP_STRUCT__entry(
 298                     __field(int, op)
 299                     __field(unsigned char, width)
 300                     __field(u16, reg)
 301                     __field(int, val)),
 302             TP_fast_assign(
 303                     __entry->op = op;
 304                     __entry->width = width;
 305                     __entry->reg = reg;
 306                     __entry->val = val;),
 307             TP_printk("docg3: %s%02d reg=%04x, val=%04x",
 308                       __entry->op ? "write" : "read", __entry->width,
 309                       __entry->reg, __entry->val)
 310         );
 311 #endif
 312
 313 /* This part must be outside protection */
 314 #undef TRACE_INCLUDE_PATH
 315 #undef TRACE_INCLUDE_FILE
 316 #define TRACE_INCLUDE_PATH .
 317 #define TRACE_INCLUDE_FILE docg3
 318 #include <trace/define_trace.h>