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
  25 #define CFI_STATUS_POLL_MASK_DQ5_DQ6_DQ7 0xE0 /* DQ5..DQ7 */
  26 #define CFI_STATUS_POLL_MASK_DQ6_DQ7     0xC0 /* DQ6..DQ7 */
  27
  28 typedef struct cfi_flash_bank_s
  29 {
  30         working_area_t *write_algorithm;
  31
  32         int x16_as_x8;
  33         int jedec_probe;
  34         int not_cfi;
  35         int probed;
  36
  37         uint16_t manufacturer;
  38         uint16_t device_id;
  39
  40         char qry[3];
  41
  42         /* identification string */
  43         uint16_t pri_id;
  44         uint16_t pri_addr;
  45         uint16_t alt_id;
  46         uint16_t alt_addr;
  47
  48         /* device-system interface */
  49         uint8_t vcc_min;
  50         uint8_t vcc_max;
  51         uint8_t vpp_min;
  52         uint8_t vpp_max;
  53         uint8_t word_write_timeout_typ;
  54         uint8_t buf_write_timeout_typ;
  55         uint8_t block_erase_timeout_typ;
  56         uint8_t chip_erase_timeout_typ;
  57         uint8_t word_write_timeout_max;
  58         uint8_t buf_write_timeout_max;
  59         uint8_t block_erase_timeout_max;
  60         uint8_t chip_erase_timeout_max;
  61
  62         uint8_t status_poll_mask;
  63
  64         /* flash geometry */
  65         uint32_t dev_size;
  66         uint16_t interface_desc;
  67         uint16_t max_buf_write_size;
  68         uint8_t num_erase_regions;
  69         uint32_t *erase_region_info;
  70
  71         void *pri_ext;
  72         void *alt_ext;
  73 } cfi_flash_bank_t;
  74
  75 /* Intel primary extended query table
  76  * as defined for the Advanced+ Boot Block Flash Memory (C3)
  77  * and used by the linux kernel cfi driver (as of 2.6.14)
  78  */
  79 typedef struct cfi_intel_pri_ext_s
  80 {
  81         char pri[3];
  82         uint8_t major_version;
  83         uint8_t minor_version;
  84         uint32_t feature_support;
  85         uint8_t suspend_cmd_support;
  86         uint16_t blk_status_reg_mask;
  87         uint8_t vcc_optimal;
  88         uint8_t vpp_optimal;
  89         uint8_t num_protection_fields;
  90         uint16_t prot_reg_addr;
  91         uint8_t fact_prot_reg_size;
  92         uint8_t user_prot_reg_size;
  93         uint8_t extra[0];
  94 } cfi_intel_pri_ext_t;
  95
  96 /* Spansion primary extended query table as defined for and used by
  97  * the linux kernel cfi driver (as of 2.6.15)
  98  */
  99 typedef struct cfi_spansion_pri_ext_s
 100 {
 101         uint8_t  pri[3];
 102         uint8_t  major_version;
 103         uint8_t  minor_version;
 104         uint8_t  SiliconRevision; /* bits 1-0: Address Sensitive Unlock */
 105         uint8_t  EraseSuspend;
 106         uint8_t  BlkProt;
 107         uint8_t  TmpBlkUnprotect;
 108         uint8_t  BlkProtUnprot;
 109         uint8_t  SimultaneousOps;
 110         uint8_t  BurstMode;
 111         uint8_t  PageMode;
 112         uint8_t  VppMin;
 113         uint8_t  VppMax;
 114         uint8_t  TopBottom;
 115         int _reversed_geometry;
 116         uint32_t _unlock1;
 117         uint32_t _unlock2;
 118 } cfi_spansion_pri_ext_t;
 119
 120 /* Atmel primary extended query table as defined for and used by
 121  * the linux kernel cfi driver (as of 2.6.20+)
 122  */
 123 typedef struct cfi_atmel_pri_ext_s
 124 {
 125         uint8_t pri[3];
 126         uint8_t major_version;
 127         uint8_t minor_version;
 128         uint8_t features;
 129         uint8_t bottom_boot;
 130         uint8_t burst_mode;
 131         uint8_t page_mode;
 132 } cfi_atmel_pri_ext_t;
 133
 134 enum {
 135         CFI_UNLOCK_555_2AA,
 136         CFI_UNLOCK_5555_2AAA,
 137 };
 138
 139 typedef struct cfi_unlock_addresses_s
 140 {
 141         uint32_t unlock1;
 142         uint32_t unlock2;
 143 } cfi_unlock_addresses_t;
 144
 145 typedef struct cfi_fixup_s
 146 {
 147         uint16_t mfr;
 148         uint16_t id;
 149         void (*fixup)(flash_bank_t *flash, void *param);
 150         void *param;
 151 } cfi_fixup_t;
 152
 153 #define CFI_MFR_AMD             0x0001
 154 #define CFI_MFR_FUJITSU 0x0004
 155 #define CFI_MFR_ATMEL   0x001F
 156 #define CFI_MFR_ST              0x0020  /* STMicroelectronics */
 157 #define CFI_MFR_AMIC    0x0037
 158 #define CFI_MFR_SST             0x00BF
 159 #define CFI_MFR_MX              0x00C2
 160
 161 #define CFI_MFR_ANY             0xffff
 162 #define CFI_ID_ANY              0xffff
 163
 164 #endif /* CFI_H */