- prepare OpenOCD for branching, created ./trunk/
[fw/openocd] / 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         struct target_s *target;
29         working_area_t *write_algorithm;
30         working_area_t *erase_check_algorithm;
31                 
32         char qry[3];
33         
34         /* identification string */
35         u16 pri_id;
36         u16 pri_addr;
37         u16 alt_id;
38         u16 alt_addr;
39         
40         /* device-system interface */
41         u8 vcc_min;
42         u8 vcc_max;
43         u8 vpp_min;
44         u8 vpp_max;
45         u8 word_write_timeout_typ;
46         u8 buf_write_timeout_typ;
47         u8 block_erase_timeout_typ;
48         u8 chip_erase_timeout_typ;
49         u8 word_write_timeout_max;
50         u8 buf_write_timeout_max;
51         u8 block_erase_timeout_max;
52         u8 chip_erase_timeout_max;
53         
54         /* flash geometry */
55         u8 dev_size;
56         u16 interface_desc;
57         u16 max_buf_write_size;
58         u8 num_erase_regions;
59         u32 *erase_region_info;
60         
61         void *pri_ext;
62         void *alt_ext;
63 } cfi_flash_bank_t;
64
65 /* Intel primary extended query table 
66  * as defined for the Advanced+ Boot Block Flash Memory (C3)
67  * and used by the linux kernel cfi driver (as of 2.6.14)
68  */
69 typedef struct cfi_intel_pri_ext_s
70 {
71         char pri[3];
72         u8 major_version;
73         u8 minor_version;
74         u32 feature_support;
75         u8 suspend_cmd_support;
76         u16 blk_status_reg_mask;
77         u8 vcc_optimal;
78         u8 vpp_optimal;
79         u8 num_protection_fields;
80         u16 prot_reg_addr;
81         u8 fact_prot_reg_size;
82         u8 user_prot_reg_size;
83         u8 extra[0];
84 } cfi_intel_pri_ext_t;
85
86 #endif /* CFI_H */