linux/mtd/doc2000.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * Linux driver for Disk-On-Chip devices
0004  *
0005  * Copyright © 1999 Machine Vision Holdings, Inc.
0006  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
0007  * Copyright © 2002-2003 Greg Ungerer <gerg@snapgear.com>
0008  * Copyright © 2002-2003 SnapGear Inc
0009  */
0010
0011 #ifndef __MTD_DOC2000_H__
0012 #define __MTD_DOC2000_H__
0013
0014 #include <linux/mtd/mtd.h>
0015 #include <linux/mutex.h>
0016
0017 #define DoC_Sig1 0
0018 #define DoC_Sig2 1
0019
0020 #define DoC_ChipID      0x1000
0021 #define DoC_DOCStatus       0x1001
0022 #define DoC_DOCControl      0x1002
0023 #define DoC_FloorSelect     0x1003
0024 #define DoC_CDSNControl     0x1004
0025 #define DoC_CDSNDeviceSelect    0x1005
0026 #define DoC_ECCConf         0x1006
0027 #define DoC_2k_ECCStatus    0x1007
0028
0029 #define DoC_CDSNSlowIO      0x100d
0030 #define DoC_ECCSyndrome0    0x1010
0031 #define DoC_ECCSyndrome1    0x1011
0032 #define DoC_ECCSyndrome2    0x1012
0033 #define DoC_ECCSyndrome3    0x1013
0034 #define DoC_ECCSyndrome4    0x1014
0035 #define DoC_ECCSyndrome5    0x1015
0036 #define DoC_AliasResolution     0x101b
0037 #define DoC_ConfigInput     0x101c
0038 #define DoC_ReadPipeInit    0x101d
0039 #define DoC_WritePipeTerm   0x101e
0040 #define DoC_LastDataRead    0x101f
0041 #define DoC_NOP         0x1020
0042
0043 #define DoC_Mil_CDSN_IO     0x0800
0044 #define DoC_2k_CDSN_IO      0x1800
0045
0046 #define DoC_Mplus_NOP           0x1002
0047 #define DoC_Mplus_AliasResolution   0x1004
0048 #define DoC_Mplus_DOCControl        0x1006
0049 #define DoC_Mplus_AccessStatus      0x1008
0050 #define DoC_Mplus_DeviceSelect      0x1008
0051 #define DoC_Mplus_Configuration     0x100a
0052 #define DoC_Mplus_OutputControl     0x100c
0053 #define DoC_Mplus_FlashControl      0x1020
0054 #define DoC_Mplus_FlashSelect       0x1022
0055 #define DoC_Mplus_FlashCmd      0x1024
0056 #define DoC_Mplus_FlashAddress      0x1026
0057 #define DoC_Mplus_FlashData0        0x1028
0058 #define DoC_Mplus_FlashData1        0x1029
0059 #define DoC_Mplus_ReadPipeInit      0x102a
0060 #define DoC_Mplus_LastDataRead      0x102c
0061 #define DoC_Mplus_LastDataRead1     0x102d
0062 #define DoC_Mplus_WritePipeTerm     0x102e
0063 #define DoC_Mplus_ECCSyndrome0      0x1040
0064 #define DoC_Mplus_ECCSyndrome1      0x1041
0065 #define DoC_Mplus_ECCSyndrome2      0x1042
0066 #define DoC_Mplus_ECCSyndrome3      0x1043
0067 #define DoC_Mplus_ECCSyndrome4      0x1044
0068 #define DoC_Mplus_ECCSyndrome5      0x1045
0069 #define DoC_Mplus_ECCConf       0x1046
0070 #define DoC_Mplus_Toggle        0x1046
0071 #define DoC_Mplus_DownloadStatus    0x1074
0072 #define DoC_Mplus_CtrlConfirm       0x1076
0073 #define DoC_Mplus_Power         0x1fff
0074
0075 /* How to access the device?
0076  * On ARM, it'll be mmap'd directly with 32-bit wide accesses.
0077  * On PPC, it's mmap'd and 16-bit wide.
0078  * Others use readb/writeb
0079  */
0080 #if defined(__arm__)
0081 static inline u8 ReadDOC_(u32 __iomem *addr, unsigned long reg)
0082 {
0083     return __raw_readl(addr + reg);
0084 }
0085 static inline void WriteDOC_(u8 data, u32 __iomem *addr, unsigned long reg)
0086 {
0087     __raw_writel(data, addr + reg);
0088     wmb();
0089 }
0090 #define DOC_IOREMAP_LEN 0x8000
0091 #elif defined(__ppc__)
0092 static inline u8 ReadDOC_(u16 __iomem *addr, unsigned long reg)
0093 {
0094     return __raw_readw(addr + reg);
0095 }
0096 static inline void WriteDOC_(u8 data, u16 __iomem *addr, unsigned long reg)
0097 {
0098     __raw_writew(data, addr + reg);
0099     wmb();
0100 }
0101 #define DOC_IOREMAP_LEN 0x4000
0102 #else
0103 #define ReadDOC_(adr, reg)      readb((void __iomem *)(adr) + (reg))
0104 #define WriteDOC_(d, adr, reg)  writeb(d, (void __iomem *)(adr) + (reg))
0105 #define DOC_IOREMAP_LEN 0x2000
0106
0107 #endif
0108
0109 #if defined(__i386__) || defined(__x86_64__)
0110 #define USE_MEMCPY
0111 #endif
0112
0113 /* These are provided to directly use the DoC_xxx defines */
0114 #define ReadDOC(adr, reg)      ReadDOC_(adr,DoC_##reg)
0115 #define WriteDOC(d, adr, reg)  WriteDOC_(d,adr,DoC_##reg)
0116
0117 #define DOC_MODE_RESET      0
0118 #define DOC_MODE_NORMAL     1
0119 #define DOC_MODE_RESERVED1  2
0120 #define DOC_MODE_RESERVED2  3
0121
0122 #define DOC_MODE_CLR_ERR    0x80
0123 #define DOC_MODE_RST_LAT    0x10
0124 #define DOC_MODE_BDECT      0x08
0125 #define DOC_MODE_MDWREN     0x04
0126
0127 #define DOC_ChipID_Doc2k    0x20
0128 #define DOC_ChipID_Doc2kTSOP    0x21    /* internal number for MTD */
0129 #define DOC_ChipID_DocMil   0x30
0130 #define DOC_ChipID_DocMilPlus32 0x40
0131 #define DOC_ChipID_DocMilPlus16 0x41
0132
0133 #define CDSN_CTRL_FR_B      0x80
0134 #define CDSN_CTRL_FR_B0     0x40
0135 #define CDSN_CTRL_FR_B1     0x80
0136
0137 #define CDSN_CTRL_ECC_IO    0x20
0138 #define CDSN_CTRL_FLASH_IO  0x10
0139 #define CDSN_CTRL_WP        0x08
0140 #define CDSN_CTRL_ALE       0x04
0141 #define CDSN_CTRL_CLE       0x02
0142 #define CDSN_CTRL_CE        0x01
0143
0144 #define DOC_ECC_RESET       0
0145 #define DOC_ECC_ERROR       0x80
0146 #define DOC_ECC_RW      0x20
0147 #define DOC_ECC__EN         0x08
0148 #define DOC_TOGGLE_BIT      0x04
0149 #define DOC_ECC_RESV        0x02
0150 #define DOC_ECC_IGNORE      0x01
0151
0152 #define DOC_FLASH_CE        0x80
0153 #define DOC_FLASH_WP        0x40
0154 #define DOC_FLASH_BANK      0x02
0155
0156 /* We have to also set the reserved bit 1 for enable */
0157 #define DOC_ECC_EN (DOC_ECC__EN | DOC_ECC_RESV)
0158 #define DOC_ECC_DIS (DOC_ECC_RESV)
0159
0160 struct Nand {
0161     char floor, chip;
0162     unsigned long curadr;
0163     unsigned char curmode;
0164     /* Also some erase/write/pipeline info when we get that far */
0165 };
0166
0167 #define MAX_FLOORS 4
0168 #define MAX_CHIPS 4
0169
0170 #define MAX_FLOORS_MIL 1
0171 #define MAX_CHIPS_MIL 1
0172
0173 #define MAX_FLOORS_MPLUS 2
0174 #define MAX_CHIPS_MPLUS 1
0175
0176 #define ADDR_COLUMN 1
0177 #define ADDR_PAGE 2
0178 #define ADDR_COLUMN_PAGE 3
0179
0180 struct DiskOnChip {
0181     unsigned long physadr;
0182     void __iomem *virtadr;
0183     unsigned long totlen;
0184     unsigned char ChipID; /* Type of DiskOnChip */
0185     int ioreg;
0186
0187     unsigned long mfr; /* Flash IDs - only one type of flash per device */
0188     unsigned long id;
0189     int chipshift;
0190     char page256;
0191     char pageadrlen;
0192     char interleave; /* Internal interleaving - Millennium Plus style */
0193     unsigned long erasesize;
0194
0195     int curfloor;
0196     int curchip;
0197
0198     int numchips;
0199     struct Nand *chips;
0200     struct mtd_info *nextdoc;
0201     struct mutex lock;
0202 };
0203
0204 int doc_decode_ecc(unsigned char sector[512], unsigned char ecc1[6]);
0205
0206 #endif /* __MTD_DOC2000_H__ */