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
  55 /*
  56  * ECC related constants
  57  */
  58 #define DOC_ECC_BCH_M                   14
  59 #define DOC_ECC_BCH_T                   4
  60 #define DOC_ECC_BCH_PRIMPOLY            0x4443
  61 #define DOC_ECC_BCH_SIZE                7
  62 #define DOC_ECC_BCH_COVERED_BYTES                               \
  63         (DOC_LAYOUT_PAGE_SIZE + DOC_LAYOUT_OOB_PAGEINFO_SZ +    \
  64          DOC_LAYOUT_OOB_HAMMING_SZ)
  65 #define DOC_ECC_BCH_TOTAL_BYTES                                 \
  66         (DOC_ECC_BCH_COVERED_BYTES + DOC_LAYOUT_OOB_BCH_SZ)
  67
  68 /*
  69  * Blocks distribution
  70  */
  71 #define DOC_LAYOUT_BLOCK_BBT            0
  72 #define DOC_LAYOUT_BLOCK_OTP            0
  73 #define DOC_LAYOUT_BLOCK_FIRST_DATA     6
  74
  75 #define DOC_LAYOUT_PAGE_BBT             4
  76
  77 /*
  78  * Extra page OOB (16 bytes wide) layout
  79  */
  80 #define DOC_LAYOUT_OOB_PAGEINFO_OFS     0
  81 #define DOC_LAYOUT_OOB_HAMMING_OFS      7
  82 #define DOC_LAYOUT_OOB_BCH_OFS          8
  83 #define DOC_LAYOUT_OOB_UNUSED_OFS       15
  84 #define DOC_LAYOUT_OOB_PAGEINFO_SZ      7
  85 #define DOC_LAYOUT_OOB_HAMMING_SZ       1
  86 #define DOC_LAYOUT_OOB_BCH_SZ           7
  87 #define DOC_LAYOUT_OOB_UNUSED_SZ        1
  88
  89
  90 #define DOC_CHIPID_G3                   0x200
  91 #define DOC_ERASE_MARK                  0xaa
  92 #define DOC_MAX_NBFLOORS                4
  93 /*
  94  * Flash registers
  95  */
  96 #define DOC_CHIPID                      0x1000
  97 #define DOC_TEST                        0x1004
  98 #define DOC_BUSLOCK                     0x1006
  99 #define DOC_ENDIANCONTROL               0x1008
 100 #define DOC_DEVICESELECT                0x100a
 101 #define DOC_ASICMODE                    0x100c
 102 #define DOC_CONFIGURATION               0x100e
 103 #define DOC_INTERRUPTCONTROL            0x1010
 104 #define DOC_READADDRESS                 0x101a
 105 #define DOC_DATAEND                     0x101e
 106 #define DOC_INTERRUPTSTATUS             0x1020
 107
 108 #define DOC_FLASHSEQUENCE               0x1032
 109 #define DOC_FLASHCOMMAND                0x1034
 110 #define DOC_FLASHADDRESS                0x1036
 111 #define DOC_FLASHCONTROL                0x1038
 112 #define DOC_NOP                         0x103e
 113
 114 #define DOC_ECCCONF0                    0x1040
 115 #define DOC_ECCCONF1                    0x1042
 116 #define DOC_ECCPRESET                   0x1044
 117 #define DOC_HAMMINGPARITY               0x1046
 118 #define DOC_BCH_HW_ECC(idx)             (0x1048 + idx)
 119
 120 #define DOC_PROTECTION                  0x1056
 121 #define DOC_DPS0_KEY                    0x105c
 122 #define DOC_DPS1_KEY                    0x105e
 123 #define DOC_DPS0_ADDRLOW                0x1060
 124 #define DOC_DPS0_ADDRHIGH               0x1062
 125 #define DOC_DPS1_ADDRLOW                0x1064
 126 #define DOC_DPS1_ADDRHIGH               0x1066
 127 #define DOC_DPS0_STATUS                 0x106c
 128 #define DOC_DPS1_STATUS                 0x106e
 129
 130 #define DOC_ASICMODECONFIRM             0x1072
 131 #define DOC_CHIPID_INV                  0x1074
 132 #define DOC_POWERMODE                   0x107c
 133
 134 /*
 135  * Flash sequences
 136  * A sequence is preset before one or more commands are input to the chip.
 137  */
 138 #define DOC_SEQ_RESET                   0x00
 139 #define DOC_SEQ_PAGE_SIZE_532           0x03
 140 #define DOC_SEQ_SET_FASTMODE            0x05
 141 #define DOC_SEQ_SET_RELIABLEMODE        0x09
 142 #define DOC_SEQ_READ                    0x12
 143 #define DOC_SEQ_SET_PLANE1              0x0e
 144 #define DOC_SEQ_SET_PLANE2              0x10
 145 #define DOC_SEQ_PAGE_SETUP              0x1d
 146 #define DOC_SEQ_ERASE                   0x27
 147 #define DOC_SEQ_PLANES_STATUS           0x31
 148
 149 /*
 150  * Flash commands
 151  */
 152 #define DOC_CMD_READ_PLANE1             0x00
 153 #define DOC_CMD_SET_ADDR_READ           0x05
 154 #define DOC_CMD_READ_ALL_PLANES         0x30
 155 #define DOC_CMD_READ_PLANE2             0x50
 156 #define DOC_CMD_READ_FLASH              0xe0
 157 #define DOC_CMD_PAGE_SIZE_532           0x3c
 158
 159 #define DOC_CMD_PROG_BLOCK_ADDR         0x60
 160 #define DOC_CMD_PROG_CYCLE1             0x80
 161 #define DOC_CMD_PROG_CYCLE2             0x10
 162 #define DOC_CMD_PROG_CYCLE3             0x11
 163 #define DOC_CMD_ERASECYCLE2             0xd0
 164 #define DOC_CMD_READ_STATUS             0x70
 165 #define DOC_CMD_PLANES_STATUS           0x71
 166
 167 #define DOC_CMD_RELIABLE_MODE           0x22
 168 #define DOC_CMD_FAST_MODE               0xa2
 169
 170 #define DOC_CMD_RESET                   0xff
 171
 172 /*
 173  * Flash register : DOC_FLASHCONTROL
 174  */
 175 #define DOC_CTRL_VIOLATION              0x20
 176 #define DOC_CTRL_CE                     0x10
 177 #define DOC_CTRL_UNKNOWN_BITS           0x08
 178 #define DOC_CTRL_PROTECTION_ERROR       0x04
 179 #define DOC_CTRL_SEQUENCE_ERROR         0x02
 180 #define DOC_CTRL_FLASHREADY             0x01
 181
 182 /*
 183  * Flash register : DOC_ASICMODE
 184  */
 185 #define DOC_ASICMODE_RESET              0x00
 186 #define DOC_ASICMODE_NORMAL             0x01
 187 #define DOC_ASICMODE_POWERDOWN          0x02
 188 #define DOC_ASICMODE_MDWREN             0x04
 189 #define DOC_ASICMODE_BDETCT_RESET       0x08
 190 #define DOC_ASICMODE_RSTIN_RESET        0x10
 191 #define DOC_ASICMODE_RAM_WE             0x20
 192
 193 /*
 194  * Flash register : DOC_ECCCONF0
 195  */
 196 #define DOC_ECCCONF0_WRITE_MODE         0x0000
 197 #define DOC_ECCCONF0_READ_MODE          0x8000
 198 #define DOC_ECCCONF0_AUTO_ECC_ENABLE    0x4000
 199 #define DOC_ECCCONF0_HAMMING_ENABLE     0x1000
 200 #define DOC_ECCCONF0_BCH_ENABLE         0x0800
 201 #define DOC_ECCCONF0_DATA_BYTES_MASK    0x07ff
 202
 203 /*
 204  * Flash register : DOC_ECCCONF1
 205  */
 206 #define DOC_ECCCONF1_BCH_SYNDROM_ERR    0x80
 207 #define DOC_ECCCONF1_UNKOWN1            0x40
 208 #define DOC_ECCCONF1_PAGE_IS_WRITTEN    0x20
 209 #define DOC_ECCCONF1_UNKOWN3            0x10
 210 #define DOC_ECCCONF1_HAMMING_BITS_MASK  0x0f
 211
 212 /*
 213  * Flash register : DOC_PROTECTION
 214  */
 215 #define DOC_PROTECT_FOUNDRY_OTP_LOCK    0x01
 216 #define DOC_PROTECT_CUSTOMER_OTP_LOCK   0x02
 217 #define DOC_PROTECT_LOCK_INPUT          0x04
 218 #define DOC_PROTECT_STICKY_LOCK         0x08
 219 #define DOC_PROTECT_PROTECTION_ENABLED  0x10
 220 #define DOC_PROTECT_IPL_DOWNLOAD_LOCK   0x20
 221 #define DOC_PROTECT_PROTECTION_ERROR    0x80
 222
 223 /*
 224  * Flash register : DOC_DPS0_STATUS and DOC_DPS1_STATUS
 225  */
 226 #define DOC_DPS_OTP_PROTECTED           0x01
 227 #define DOC_DPS_READ_PROTECTED          0x02
 228 #define DOC_DPS_WRITE_PROTECTED         0x04
 229 #define DOC_DPS_HW_LOCK_ENABLED         0x08
 230 #define DOC_DPS_KEY_OK                  0x80
 231
 232 /*
 233  * Flash register : DOC_CONFIGURATION
 234  */
 235 #define DOC_CONF_IF_CFG                 0x80
 236 #define DOC_CONF_MAX_ID_MASK            0x30
 237 #define DOC_CONF_VCCQ_3V                0x01
 238
 239 /*
 240  * Flash register : DOC_READADDRESS
 241  */
 242 #define DOC_READADDR_INC                0x8000
 243 #define DOC_READADDR_ONE_BYTE           0x4000
 244 #define DOC_READADDR_ADDR_MASK          0x1fff
 245
 246 /*
 247  * Flash register : DOC_POWERMODE
 248  */
 249 #define DOC_POWERDOWN_READY             0x80
 250
 251 /*
 252  * Status of erase and write operation
 253  */
 254 #define DOC_PLANES_STATUS_FAIL          0x01
 255 #define DOC_PLANES_STATUS_PLANE0_KO     0x02
 256 #define DOC_PLANES_STATUS_PLANE1_KO     0x04
 257
 258 /*
 259  * DPS key management
 260  *
 261  * Each floor of docg3 has 2 protection areas: DPS0 and DPS1. These areas span
 262  * across block boundaries, and define whether these blocks can be read or
 263  * written.
 264  * The definition is dynamically stored in page 0 of blocks (2,3) for DPS0, and
 265  * page 0 of blocks (4,5) for DPS1.
 266  */
 267 #define DOC_LAYOUT_DPS_KEY_LENGTH       8
 268
 269 /**
 270  * struct docg3 - DiskOnChip driver private data
 271  * @dev: the device currently under control
 272  * @base: mapped IO space
 273  * @device_id: number of the cascaded DoCG3 device (0, 1, 2 or 3)
 274  * @if_cfg: if true, reads are on 16bits, else reads are on 8bits
 275
 276  * @reliable: if 0, docg3 in normal mode, if 1 docg3 in fast mode, if 2 in
 277  *            reliable mode
 278  *            Fast mode implies more errors than normal mode.
 279  *            Reliable mode implies that page 2*n and 2*n+1 are clones.
 280  * @bbt: bad block table cache
 281  * @oob_write_ofs: offset of the MTD where this OOB should belong (ie. in next
 282  *                 page_write)
 283  * @oob_autoecc: if 1, use only bytes 0-7, 15, and fill the others with HW ECC
 284  *               if 0, use all the 16 bytes.
 285  * @oob_write_buf: prepared OOB for next page_write
 286  * @debugfs_root: debugfs root node
 287  */
 288 struct docg3 {
 289         struct device *dev;
 290         void __iomem *base;
 291         unsigned int device_id:4;
 292         unsigned int if_cfg:1;
 293         unsigned int reliable:2;
 294         int max_block;
 295         u8 *bbt;
 296         loff_t oob_write_ofs;
 297         int oob_autoecc;
 298         u8 oob_write_buf[DOC_LAYOUT_OOB_SIZE];
 299         struct dentry *debugfs_root;
 300 };
 301
 302 #define doc_err(fmt, arg...) dev_err(docg3->dev, (fmt), ## arg)
 303 #define doc_info(fmt, arg...) dev_info(docg3->dev, (fmt), ## arg)
 304 #define doc_dbg(fmt, arg...) dev_dbg(docg3->dev, (fmt), ## arg)
 305 #define doc_vdbg(fmt, arg...) dev_vdbg(docg3->dev, (fmt), ## arg)
 306
 307 #define DEBUGFS_RO_ATTR(name, show_fct) \
 308         static int name##_open(struct inode *inode, struct file *file) \
 309         { return single_open(file, show_fct, inode->i_private); }      \
 310         static const struct file_operations name##_fops = { \
 311                 .owner = THIS_MODULE, \
 312                 .open = name##_open, \
 313                 .llseek = seq_lseek, \
 314                 .read = seq_read, \
 315                 .release = single_release \
 316         };
 317 #endif
 318
 319 /*
 320  * Trace events part
 321  */
 322 #undef TRACE_SYSTEM
 323 #define TRACE_SYSTEM docg3
 324
 325 #if !defined(_MTD_DOCG3_TRACE) || defined(TRACE_HEADER_MULTI_READ)
 326 #define _MTD_DOCG3_TRACE
 327
 328 #include <linux/tracepoint.h>
 329
 330 TRACE_EVENT(docg3_io,
 331             TP_PROTO(int op, int width, u16 reg, int val),
 332             TP_ARGS(op, width, reg, val),
 333             TP_STRUCT__entry(
 334                     __field(int, op)
 335                     __field(unsigned char, width)
 336                     __field(u16, reg)
 337                     __field(int, val)),
 338             TP_fast_assign(
 339                     __entry->op = op;
 340                     __entry->width = width;
 341                     __entry->reg = reg;
 342                     __entry->val = val;),
 343             TP_printk("docg3: %s%02d reg=%04x, val=%04x",
 344                       __entry->op ? "write" : "read", __entry->width,
 345                       __entry->reg, __entry->val)
 346         );
 347 #endif
 348
 349 /* This part must be outside protection */
 350 #undef TRACE_INCLUDE_PATH
 351 #undef TRACE_INCLUDE_FILE
 352 #define TRACE_INCLUDE_PATH .
 353 #define TRACE_INCLUDE_FILE docg3
 354 #include <trace/define_trace.h>