git.sur5r.net Git - openocd/blob - src/flash/cfi.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef CFI_H
  21 #define CFI_H
  22
  23 #include "flash.h"
  24 #include "target.h"
  25
  26 typedef struct cfi_flash_bank_s
  27 {
  28         working_area_t *write_algorithm;
  29         working_area_t *erase_check_algorithm;
  30
  31         int x16_as_x8;
  32         int jedec_probe;
  33         int not_cfi;
  34
  35         u16 manufacturer;
  36         u16 device_id;
  37
  38         char qry[3];
  39
  40         /* identification string */
  41         u16 pri_id;
  42         u16 pri_addr;
  43         u16 alt_id;
  44         u16 alt_addr;
  45
  46         /* device-system interface */
  47         u8 vcc_min;
  48         u8 vcc_max;
  49         u8 vpp_min;
  50         u8 vpp_max;
  51         u8 word_write_timeout_typ;
  52         u8 buf_write_timeout_typ;
  53         u8 block_erase_timeout_typ;
  54         u8 chip_erase_timeout_typ;
  55         u8 word_write_timeout_max;
  56         u8 buf_write_timeout_max;
  57         u8 block_erase_timeout_max;
  58         u8 chip_erase_timeout_max;
  59
  60         /* flash geometry */
  61         u8 dev_size;
  62         u16 interface_desc;
  63         u16 max_buf_write_size;
  64         u8 num_erase_regions;
  65         u32 *erase_region_info;
  66
  67         void *pri_ext;
  68         void *alt_ext;
  69 } cfi_flash_bank_t;
  70
  71 /* Intel primary extended query table
  72  * as defined for the Advanced+ Boot Block Flash Memory (C3)
  73  * and used by the linux kernel cfi driver (as of 2.6.14)
  74  */
  75 typedef struct cfi_intel_pri_ext_s
  76 {
  77         char pri[3];
  78         u8 major_version;
  79         u8 minor_version;
  80         u32 feature_support;
  81         u8 suspend_cmd_support;
  82         u16 blk_status_reg_mask;
  83         u8 vcc_optimal;
  84         u8 vpp_optimal;
  85         u8 num_protection_fields;
  86         u16 prot_reg_addr;
  87         u8 fact_prot_reg_size;
  88         u8 user_prot_reg_size;
  89         u8 extra[0];
  90 } cfi_intel_pri_ext_t;
  91
  92 /* Spansion primary extended query table as defined for and used by
  93  * the linux kernel cfi driver (as of 2.6.15)
  94  */
  95 typedef struct cfi_spansion_pri_ext_s
  96 {
  97         u8  pri[3];
  98         u8  major_version;
  99         u8  minor_version;
 100         u8  SiliconRevision; /* bits 1-0: Address Sensitive Unlock */
 101         u8  EraseSuspend;
 102         u8  BlkProt;
 103         u8  TmpBlkUnprotect;
 104         u8  BlkProtUnprot;
 105         u8  SimultaneousOps;
 106         u8  BurstMode;
 107         u8  PageMode;
 108         u8  VppMin;
 109         u8  VppMax;
 110         u8  TopBottom;
 111         int _reversed_geometry;
 112         u32 _unlock1;
 113         u32 _unlock2;
 114 } cfi_spansion_pri_ext_t;
 115
 116 /* Atmel primary extended query table as defined for and used by
 117  * the linux kernel cfi driver (as of 2.6.20+)
 118  */
 119 typedef struct cfi_atmel_pri_ext_s
 120 {
 121         u8 pri[3];
 122         u8 major_version;
 123         u8 minor_version;
 124         u8 features;
 125         u8 bottom_boot;
 126         u8 burst_mode;
 127         u8 page_mode;
 128 } cfi_atmel_pri_ext_t;
 129
 130 enum {
 131         CFI_UNLOCK_555_2AA,
 132         CFI_UNLOCK_5555_2AAA,
 133 };
 134
 135 typedef struct cfi_unlock_addresses_s
 136 {
 137         u32 unlock1;
 138         u32 unlock2;
 139 } cfi_unlock_addresses_t;
 140
 141 typedef struct cfi_fixup_s
 142 {
 143         u16 mfr;
 144         u16 id;
 145         void (*fixup)(flash_bank_t *flash, void *param);
 146         void *param;
 147 } cfi_fixup_t;
 148
 149 #define CFI_MFR_AMD             0x0001
 150 #define CFI_MFR_ATMEL   0x001F
 151 #define CFI_MFR_ST              0x0020  /* STMicroelectronics */
 152 #define CFI_MFR_SST             0x00BF
 153
 154 #define CFI_MFR_ANY             0xffff
 155 #define CFI_ID_ANY              0xffff
 156
 157 #endif /* CFI_H */