1 /* 2 Common Flash Interface probe code. 3 (C) 2000 Red Hat. GPL'd. 4 */ 5 6 #include <linux/module.h> 7 #include <linux/types.h> 8 #include <linux/kernel.h> 9 #include <linux/init.h> 10 #include <asm/io.h> 11 #include <asm/byteorder.h> 12 #include <linux/errno.h> 13 #include <linux/slab.h> 14 #include <linux/interrupt.h> 15 16 #include <linux/mtd/xip.h> 17 #include <linux/mtd/map.h> 18 #include <linux/mtd/cfi.h> 19 #include <linux/mtd/gen_probe.h> 20 21 //#define DEBUG_CFI 22 23 #ifdef DEBUG_CFI 24 static void print_cfi_ident(struct cfi_ident *); 25 #endif 26 27 static int cfi_probe_chip(struct map_info *map, __u32 base, 28 unsigned long *chip_map, struct cfi_private *cfi); 29 static int cfi_chip_setup(struct map_info *map, struct cfi_private *cfi); 30 31 struct mtd_info *cfi_probe(struct map_info *map); 32 33 #ifdef CONFIG_MTD_XIP 34 35 /* only needed for short periods, so this is rather simple */ 36 #define xip_disable() local_irq_disable() 37 38 #define xip_allowed(base, map) \ 39 do { \ 40 (void) map_read(map, base); \ 41 xip_iprefetch(); \ 42 local_irq_enable(); \ 43 } while (0) 44 45 #define xip_enable(base, map, cfi) \ 46 do { \ 47 cfi_qry_mode_off(base, map, cfi); \ 48 xip_allowed(base, map); \ 49 } while (0) 50 51 #define xip_disable_qry(base, map, cfi) \ 52 do { \ 53 xip_disable(); \ 54 cfi_qry_mode_on(base, map, cfi); \ 55 } while (0) 56 57 #else 58 59 #define xip_disable() do { } while (0) 60 #define xip_allowed(base, map) do { } while (0) 61 #define xip_enable(base, map, cfi) do { } while (0) 62 #define xip_disable_qry(base, map, cfi) do { } while (0) 63 64 #endif 65 66 /* check for QRY. 67 in: interleave,type,mode 68 ret: table index, <0 for error 69 */ 70 71 static int __xipram cfi_probe_chip(struct map_info *map, __u32 base, 72 unsigned long *chip_map, struct cfi_private *cfi) 73 { 74 int i; 75 76 if ((base + 0) >= map->size) { 77 printk(KERN_NOTICE 78 "Probe at base[0x00](0x%08lx) past the end of the map(0x%08lx)\n", 79 (unsigned long)base, map->size -1); 80 return 0; 81 } 82 if ((base + 0xff) >= map->size) { 83 printk(KERN_NOTICE 84 "Probe at base[0x55](0x%08lx) past the end of the map(0x%08lx)\n", 85 (unsigned long)base + 0x55, map->size -1); 86 return 0; 87 } 88 89 xip_disable(); 90 if (!cfi_qry_mode_on(base, map, cfi)) { 91 xip_enable(base, map, cfi); 92 return 0; 93 } 94 95 if (!cfi->numchips) { 96 /* This is the first time we're called. Set up the CFI 97 stuff accordingly and return */ 98 return cfi_chip_setup(map, cfi); 99 } 100 101 /* Check each previous chip to see if it's an alias */ 102 for (i=0; i < (base >> cfi->chipshift); i++) { 103 unsigned long start; 104 if(!test_bit(i, chip_map)) { 105 /* Skip location; no valid chip at this address */ 106 continue; 107 } 108 start = i << cfi->chipshift; 109 /* This chip should be in read mode if it's one 110 we've already touched. */ 111 if (cfi_qry_present(map, start, cfi)) { 112 /* Eep. This chip also had the QRY marker. 113 * Is it an alias for the new one? */ 114 cfi_qry_mode_off(start, map, cfi); 115 116 /* If the QRY marker goes away, it's an alias */ 117 if (!cfi_qry_present(map, start, cfi)) { 118 xip_allowed(base, map); 119 printk(KERN_DEBUG "%s: Found an alias at 0x%x for the chip at 0x%lx\n", 120 map->name, base, start); 121 return 0; 122 } 123 /* Yes, it's actually got QRY for data. Most 124 * unfortunate. Stick the new chip in read mode 125 * too and if it's the same, assume it's an alias. */ 126 /* FIXME: Use other modes to do a proper check */ 127 cfi_qry_mode_off(base, map, cfi); 128 129 if (cfi_qry_present(map, base, cfi)) { 130 xip_allowed(base, map); 131 printk(KERN_DEBUG "%s: Found an alias at 0x%x for the chip at 0x%lx\n", 132 map->name, base, start); 133 return 0; 134 } 135 } 136 } 137 138 /* OK, if we got to here, then none of the previous chips appear to 139 be aliases for the current one. */ 140 set_bit((base >> cfi->chipshift), chip_map); /* Update chip map */ 141 cfi->numchips++; 142 143 /* Put it back into Read Mode */ 144 cfi_qry_mode_off(base, map, cfi); 145 xip_allowed(base, map); 146 147 printk(KERN_INFO "%s: Found %d x%d devices at 0x%x in %d-bit bank\n", 148 map->name, cfi->interleave, cfi->device_type*8, base, 149 map->bankwidth*8); 150 151 return 1; 152 } 153 154 static int __xipram cfi_chip_setup(struct map_info *map, 155 struct cfi_private *cfi) 156 { 157 int ofs_factor = cfi->interleave*cfi->device_type; 158 __u32 base = 0; 159 int num_erase_regions = cfi_read_query(map, base + (0x10 + 28)*ofs_factor); 160 int i; 161 162 xip_enable(base, map, cfi); 163 #ifdef DEBUG_CFI 164 printk("Number of erase regions: %d\n", num_erase_regions); 165 #endif 166 if (!num_erase_regions) 167 return 0; 168 169 cfi->cfiq = kmalloc(sizeof(struct cfi_ident) + num_erase_regions * 4, GFP_KERNEL); 170 if (!cfi->cfiq) { 171 printk(KERN_WARNING "%s: kmalloc failed for CFI ident structure\n", map->name); 172 return 0; 173 } 174 175 memset(cfi->cfiq,0,sizeof(struct cfi_ident)); 176 177 cfi->cfi_mode = CFI_MODE_CFI; 178 179 /* Read the CFI info structure */ 180 xip_disable_qry(base, map, cfi); 181 for (i=0; i<(sizeof(struct cfi_ident) + num_erase_regions * 4); i++) 182 ((unsigned char *)cfi->cfiq)[i] = cfi_read_query(map,base + (0x10 + i)*ofs_factor); 183 184 /* Note we put the device back into Read Mode BEFORE going into Auto 185 * Select Mode, as some devices support nesting of modes, others 186 * don't. This way should always work. 187 * On cmdset 0001 the writes of 0xaa and 0x55 are not needed, and 188 * so should be treated as nops or illegal (and so put the device 189 * back into Read Mode, which is a nop in this case). 190 */ 191 cfi_send_gen_cmd(0xf0, 0, base, map, cfi, cfi->device_type, NULL); 192 cfi_send_gen_cmd(0xaa, 0x555, base, map, cfi, cfi->device_type, NULL); 193 cfi_send_gen_cmd(0x55, 0x2aa, base, map, cfi, cfi->device_type, NULL); 194 cfi_send_gen_cmd(0x90, 0x555, base, map, cfi, cfi->device_type, NULL); 195 cfi->mfr = cfi_read_query16(map, base); 196 cfi->id = cfi_read_query16(map, base + ofs_factor); 197 198 /* Get AMD/Spansion extended JEDEC ID */ 199 if (cfi->mfr == CFI_MFR_AMD && (cfi->id & 0xff) == 0x7e) 200 cfi->id = cfi_read_query(map, base + 0xe * ofs_factor) << 8 | 201 cfi_read_query(map, base + 0xf * ofs_factor); 202 203 /* Put it back into Read Mode */ 204 cfi_qry_mode_off(base, map, cfi); 205 xip_allowed(base, map); 206 207 /* Do any necessary byteswapping */ 208 cfi->cfiq->P_ID = le16_to_cpu(cfi->cfiq->P_ID); 209 210 cfi->cfiq->P_ADR = le16_to_cpu(cfi->cfiq->P_ADR); 211 cfi->cfiq->A_ID = le16_to_cpu(cfi->cfiq->A_ID); 212 cfi->cfiq->A_ADR = le16_to_cpu(cfi->cfiq->A_ADR); 213 cfi->cfiq->InterfaceDesc = le16_to_cpu(cfi->cfiq->InterfaceDesc); 214 cfi->cfiq->MaxBufWriteSize = le16_to_cpu(cfi->cfiq->MaxBufWriteSize); 215 216 #ifdef DEBUG_CFI 217 /* Dump the information therein */ 218 print_cfi_ident(cfi->cfiq); 219 #endif 220 221 for (i=0; i<cfi->cfiq->NumEraseRegions; i++) { 222 cfi->cfiq->EraseRegionInfo[i] = le32_to_cpu(cfi->cfiq->EraseRegionInfo[i]); 223 224 #ifdef DEBUG_CFI 225 printk(" Erase Region #%d: BlockSize 0x%4.4X bytes, %d blocks\n", 226 i, (cfi->cfiq->EraseRegionInfo[i] >> 8) & ~0xff, 227 (cfi->cfiq->EraseRegionInfo[i] & 0xffff) + 1); 228 #endif 229 } 230 231 printk(KERN_INFO "%s: Found %d x%d devices at 0x%x in %d-bit bank\n", 232 map->name, cfi->interleave, cfi->device_type*8, base, 233 map->bankwidth*8); 234 235 return 1; 236 } 237 238 #ifdef DEBUG_CFI 239 static char *vendorname(__u16 vendor) 240 { 241 switch (vendor) { 242 case P_ID_NONE: 243 return "None"; 244 245 case P_ID_INTEL_EXT: 246 return "Intel/Sharp Extended"; 247 248 case P_ID_AMD_STD: 249 return "AMD/Fujitsu Standard"; 250 251 case P_ID_INTEL_STD: 252 return "Intel/Sharp Standard"; 253 254 case P_ID_AMD_EXT: 255 return "AMD/Fujitsu Extended"; 256 257 case P_ID_WINBOND: 258 return "Winbond Standard"; 259 260 case P_ID_ST_ADV: 261 return "ST Advanced"; 262 263 case P_ID_MITSUBISHI_STD: 264 return "Mitsubishi Standard"; 265 266 case P_ID_MITSUBISHI_EXT: 267 return "Mitsubishi Extended"; 268 269 case P_ID_SST_PAGE: 270 return "SST Page Write"; 271 272 case P_ID_INTEL_PERFORMANCE: 273 return "Intel Performance Code"; 274 275 case P_ID_INTEL_DATA: 276 return "Intel Data"; 277 278 case P_ID_RESERVED: 279 return "Not Allowed / Reserved for Future Use"; 280 281 default: 282 return "Unknown"; 283 } 284 } 285 286 287 static void print_cfi_ident(struct cfi_ident *cfip) 288 { 289 #if 0 290 if (cfip->qry[0] != 'Q' || cfip->qry[1] != 'R' || cfip->qry[2] != 'Y') { 291 printk("Invalid CFI ident structure.\n"); 292 return; 293 } 294 #endif 295 printk("Primary Vendor Command Set: %4.4X (%s)\n", cfip->P_ID, vendorname(cfip->P_ID)); 296 if (cfip->P_ADR) 297 printk("Primary Algorithm Table at %4.4X\n", cfip->P_ADR); 298 else 299 printk("No Primary Algorithm Table\n"); 300 301 printk("Alternative Vendor Command Set: %4.4X (%s)\n", cfip->A_ID, vendorname(cfip->A_ID)); 302 if (cfip->A_ADR) 303 printk("Alternate Algorithm Table at %4.4X\n", cfip->A_ADR); 304 else 305 printk("No Alternate Algorithm Table\n"); 306 307 308 printk("Vcc Minimum: %2d.%d V\n", cfip->VccMin >> 4, cfip->VccMin & 0xf); 309 printk("Vcc Maximum: %2d.%d V\n", cfip->VccMax >> 4, cfip->VccMax & 0xf); 310 if (cfip->VppMin) { 311 printk("Vpp Minimum: %2d.%d V\n", cfip->VppMin >> 4, cfip->VppMin & 0xf); 312 printk("Vpp Maximum: %2d.%d V\n", cfip->VppMax >> 4, cfip->VppMax & 0xf); 313 } 314 else 315 printk("No Vpp line\n"); 316 317 printk("Typical byte/word write timeout: %d µs\n", 1<<cfip->WordWriteTimeoutTyp); 318 printk("Maximum byte/word write timeout: %d µs\n", (1<<cfip->WordWriteTimeoutMax) * (1<<cfip->WordWriteTimeoutTyp)); 319 320 if (cfip->BufWriteTimeoutTyp || cfip->BufWriteTimeoutMax) { 321 printk("Typical full buffer write timeout: %d µs\n", 1<<cfip->BufWriteTimeoutTyp); 322 printk("Maximum full buffer write timeout: %d µs\n", (1<<cfip->BufWriteTimeoutMax) * (1<<cfip->BufWriteTimeoutTyp)); 323 } 324 else 325 printk("Full buffer write not supported\n"); 326 327 printk("Typical block erase timeout: %d ms\n", 1<<cfip->BlockEraseTimeoutTyp); 328 printk("Maximum block erase timeout: %d ms\n", (1<<cfip->BlockEraseTimeoutMax) * (1<<cfip->BlockEraseTimeoutTyp)); 329 if (cfip->ChipEraseTimeoutTyp || cfip->ChipEraseTimeoutMax) { 330 printk("Typical chip erase timeout: %d ms\n", 1<<cfip->ChipEraseTimeoutTyp); 331 printk("Maximum chip erase timeout: %d ms\n", (1<<cfip->ChipEraseTimeoutMax) * (1<<cfip->ChipEraseTimeoutTyp)); 332 } 333 else 334 printk("Chip erase not supported\n"); 335 336 printk("Device size: 0x%X bytes (%d MiB)\n", 1 << cfip->DevSize, 1<< (cfip->DevSize - 20)); 337 printk("Flash Device Interface description: 0x%4.4X\n", cfip->InterfaceDesc); 338 switch(cfip->InterfaceDesc) { 339 case CFI_INTERFACE_X8_ASYNC: 340 printk(" - x8-only asynchronous interface\n"); 341 break; 342 343 case CFI_INTERFACE_X16_ASYNC: 344 printk(" - x16-only asynchronous interface\n"); 345 break; 346 347 case CFI_INTERFACE_X8_BY_X16_ASYNC: 348 printk(" - supports x8 and x16 via BYTE# with asynchronous interface\n"); 349 break; 350 351 case CFI_INTERFACE_X32_ASYNC: 352 printk(" - x32-only asynchronous interface\n"); 353 break; 354 355 case CFI_INTERFACE_X16_BY_X32_ASYNC: 356 printk(" - supports x16 and x32 via Word# with asynchronous interface\n"); 357 break; 358 359 case CFI_INTERFACE_NOT_ALLOWED: 360 printk(" - Not Allowed / Reserved\n"); 361 break; 362 363 default: 364 printk(" - Unknown\n"); 365 break; 366 } 367 368 printk("Max. bytes in buffer write: 0x%x\n", 1<< cfip->MaxBufWriteSize); 369 printk("Number of Erase Block Regions: %d\n", cfip->NumEraseRegions); 370 371 } 372 #endif /* DEBUG_CFI */ 373 374 static struct chip_probe cfi_chip_probe = { 375 .name = "CFI", 376 .probe_chip = cfi_probe_chip 377 }; 378 379 struct mtd_info *cfi_probe(struct map_info *map) 380 { 381 /* 382 * Just use the generic probe stuff to call our CFI-specific 383 * chip_probe routine in all the possible permutations, etc. 384 */ 385 return mtd_do_chip_probe(map, &cfi_chip_probe); 386 } 387 388 static struct mtd_chip_driver cfi_chipdrv = { 389 .probe = cfi_probe, 390 .name = "cfi_probe", 391 .module = THIS_MODULE 392 }; 393 394 static int __init cfi_probe_init(void) 395 { 396 register_mtd_chip_driver(&cfi_chipdrv); 397 return 0; 398 } 399 400 static void __exit cfi_probe_exit(void) 401 { 402 unregister_mtd_chip_driver(&cfi_chipdrv); 403 } 404 405 module_init(cfi_probe_init); 406 module_exit(cfi_probe_exit); 407 408 MODULE_LICENSE("GPL"); 409 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org> et al."); 410 MODULE_DESCRIPTION("Probe code for CFI-compliant flash chips"); 411