drivers/mtd/chips/cfi_probe.c

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