src/flash/nor/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, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 #ifndef OPENOCD_FLASH_NOR_CFI_H
  20 #define OPENOCD_FLASH_NOR_CFI_H
  21
  22 #define CFI_STATUS_POLL_MASK_DQ5_DQ6_DQ7 0xE0 /* DQ5..DQ7 */
  23 #define CFI_STATUS_POLL_MASK_DQ6_DQ7     0xC0 /* DQ6..DQ7 */
  24
  25 struct cfi_flash_bank {
  26         bool x16_as_x8;
  27         bool jedec_probe;
  28         bool not_cfi;
  29         bool probed;
  30
  31         enum target_endianness endianness;
  32         bool data_swap;
  33
  34         uint16_t manufacturer;
  35         uint16_t device_id;
  36
  37         uint8_t qry[3];
  38
  39         /* identification string */
  40         uint16_t pri_id;
  41         uint16_t pri_addr;
  42         uint16_t alt_id;
  43         uint16_t alt_addr;
  44
  45         /* device-system interface */
  46         uint8_t vcc_min;
  47         uint8_t vcc_max;
  48         uint8_t vpp_min;
  49         uint8_t vpp_max;
  50         uint8_t word_write_timeout_typ;
  51         uint8_t buf_write_timeout_typ;
  52         uint8_t block_erase_timeout_typ;
  53         uint8_t chip_erase_timeout_typ;
  54         uint8_t word_write_timeout_max;
  55         uint8_t buf_write_timeout_max;
  56         uint8_t block_erase_timeout_max;
  57         uint8_t chip_erase_timeout_max;
  58
  59         uint8_t status_poll_mask;
  60
  61         /* flash geometry */
  62         uint32_t dev_size;
  63         uint16_t interface_desc;
  64         uint16_t max_buf_write_size;
  65         uint8_t num_erase_regions;
  66         uint32_t *erase_region_info;
  67
  68         void *pri_ext;
  69         void *alt_ext;
  70
  71         /* calculated timeouts */
  72         unsigned word_write_timeout;
  73         unsigned buf_write_timeout;
  74         unsigned block_erase_timeout;
  75         unsigned chip_erase_timeout;
  76
  77         /* memory accessors */
  78         int (*write_mem)(struct flash_bank *bank, target_addr_t addr,
  79                          uint32_t count, const uint8_t *buffer);
  80         int (*read_mem)(struct flash_bank *bank, target_addr_t addr,
  81                         uint32_t count, uint8_t *buffer);
  82 };
  83
  84 /* Intel primary extended query table
  85  * as defined for the Advanced+ Boot Block Flash Memory (C3)
  86  * and used by the linux kernel cfi driver (as of 2.6.14)
  87  */
  88 struct cfi_intel_pri_ext {
  89         uint8_t pri[3];
  90         uint8_t major_version;
  91         uint8_t minor_version;
  92         uint32_t feature_support;
  93         uint8_t suspend_cmd_support;
  94         uint16_t blk_status_reg_mask;
  95         uint8_t vcc_optimal;
  96         uint8_t vpp_optimal;
  97         uint8_t num_protection_fields;
  98         uint16_t prot_reg_addr;
  99         uint8_t fact_prot_reg_size;
 100         uint8_t user_prot_reg_size;
 101         uint8_t extra[0];
 102 };
 103
 104 /* Spansion primary extended query table as defined for and used by
 105  * the linux kernel cfi driver (as of 2.6.15)
 106  */
 107 struct cfi_spansion_pri_ext {
 108         uint8_t  pri[3];
 109         uint8_t  major_version;
 110         uint8_t  minor_version;
 111         uint8_t  silicon_revision; /* bits 1-0: Address Sensitive Unlock */
 112         uint8_t  erase_suspend;
 113         uint8_t  blk_prot;
 114         uint8_t  tmp_blk_unprotected;
 115         uint8_t  blk_prot_unprot;
 116         uint8_t  simultaneous_ops;
 117         uint8_t  burst_mode;
 118         uint8_t  page_mode;
 119         uint8_t  vpp_min;
 120         uint8_t  vpp_max;
 121         uint8_t  top_bottom;
 122         int _reversed_geometry;
 123         uint32_t _unlock1;
 124         uint32_t _unlock2;
 125 };
 126
 127 /* Atmel primary extended query table as defined for and used by
 128  * the linux kernel cfi driver (as of 2.6.20+)
 129  */
 130 struct cfi_atmel_pri_ext {
 131         uint8_t pri[3];
 132         uint8_t major_version;
 133         uint8_t minor_version;
 134         uint8_t features;
 135         uint8_t bottom_boot;
 136         uint8_t burst_mode;
 137         uint8_t page_mode;
 138 };
 139
 140 enum {
 141         CFI_UNLOCK_555_2AA,
 142         CFI_UNLOCK_5555_2AAA,
 143 };
 144
 145 struct cfi_unlock_addresses {
 146         uint32_t unlock1;
 147         uint32_t unlock2;
 148 };
 149
 150 struct cfi_fixup {
 151         uint16_t mfr;
 152         uint16_t id;
 153         void (*fixup)(struct flash_bank *bank, const void *param);
 154         const void *param;
 155 };
 156
 157 int cfi_erase(struct flash_bank *bank, unsigned int first, unsigned int last);
 158 int cfi_protect(struct flash_bank *bank, int set, unsigned int first,
 159                 unsigned int last);
 160 int cfi_probe(struct flash_bank *bank);
 161 int cfi_auto_probe(struct flash_bank *bank);
 162 int cfi_protect_check(struct flash_bank *bank);
 163 int cfi_get_info(struct flash_bank *bank, struct command_invocation *cmd);
 164 int cfi_flash_bank_cmd(struct flash_bank *bank, unsigned int argc, const char **argv);
 165
 166 uint32_t cfi_flash_address(struct flash_bank *bank, int sector, uint32_t offset);
 167 int cfi_spansion_unlock_seq(struct flash_bank *bank);
 168 int cfi_send_command(struct flash_bank *bank, uint8_t cmd, uint32_t address);
 169 int cfi_write_word(struct flash_bank *bank, uint8_t *word, uint32_t address);
 170 int cfi_spansion_wait_status_busy(struct flash_bank *bank, int timeout);
 171 int cfi_reset(struct flash_bank *bank);
 172
 173 int cfi_target_read_memory(struct flash_bank *bank, target_addr_t addr,
 174                            uint32_t count, uint8_t *buffer);
 175
 176 #define CFI_MFR_AMD             0x0001
 177 #define CFI_MFR_FUJITSU 0x0004
 178 #define CFI_MFR_ATMEL   0x001F
 179 #define CFI_MFR_ST              0x0020  /* STMicroelectronics */
 180 #define CFI_MFR_AMIC    0x0037
 181 #define CFI_MFR_SST             0x00BF
 182 #define CFI_MFR_MX              0x00C2
 183 #define CFI_MFR_EON             0x007F
 184
 185 #define CFI_MFR_ANY             0xffff
 186 #define CFI_ID_ANY              0xffff
 187
 188 #define CFI_MAX_BUS_WIDTH       4
 189 #define CFI_MAX_CHIP_WIDTH      4
 190
 191 #endif /* OPENOCD_FLASH_NOR_CFI_H */