]> git.sur5r.net Git - openocd/blob - src/flash/mflash.h
David Brownell <david-b@pacbell.net>:
[openocd] / src / flash / mflash.h
1 /***************************************************************************
2  *   Copyright (C) 2007-2008 by unsik Kim <donari75@gmail.com>             *
3  *                                                                         *
4  *   This program is free software; you can redistribute it and/or modify  *
5  *   it under the terms of the GNU General Public License as published by  *
6  *   the Free Software Foundation; either version 2 of the License, or     *
7  *   (at your option) any later version.                                   *
8  *                                                                         *
9  *   This program is distributed in the hope that it will be useful,       *
10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
12  *   GNU General Public License for more details.                          *
13  *                                                                         *
14  *   You should have received a copy of the GNU General Public License     *
15  *   along with this program; if not, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19
20 #ifndef _MFLASH_H
21 #define _MFLASH_H
22
23 #include "target.h"
24
25 typedef unsigned long mg_io_uint32;
26 typedef unsigned short mg_io_uint16;
27 typedef unsigned char mg_io_uint8;
28
29 typedef struct mflash_gpio_num_s
30 {
31         char port[2];
32         signed short num;
33 } mflash_gpio_num_t;
34
35 typedef struct mflash_gpio_drv_s
36 {
37         char *name;
38         int (*set_gpio_to_output) (mflash_gpio_num_t gpio);
39         int (*set_gpio_output_val) (mflash_gpio_num_t gpio, u8 val);
40 } mflash_gpio_drv_t;
41
42 typedef struct _mg_io_type_drv_info {
43
44         mg_io_uint16 general_configuration;                             /* 00 */
45         mg_io_uint16 number_of_cylinders;                               /* 01 */
46         mg_io_uint16 reserved1;                                                 /* 02 */
47         mg_io_uint16 number_of_heads;                                   /* 03 */
48         mg_io_uint16 unformatted_bytes_per_track;               /* 04 */
49         mg_io_uint16 unformatted_bytes_per_sector;              /* 05 */
50         mg_io_uint16 sectors_per_track;                                 /* 06 */
51         mg_io_uint16  vendor_unique1[3];                                /* 07/08/09 */
52
53         mg_io_uint8  serial_number[20];                                 /* 10~19 */
54
55         mg_io_uint16 buffer_type;                                               /* 20 */
56         mg_io_uint16 buffer_sector_size;                                /* 21 */
57         mg_io_uint16 number_of_ecc_bytes;                               /* 22 */
58
59         mg_io_uint8  firmware_revision[8];                              /* 23~26 */
60         mg_io_uint8  model_number[40];                                  /* 27 */
61
62         mg_io_uint8  maximum_block_transfer;                    /* 47 low byte */
63         mg_io_uint8  vendor_unique2;                                    /* 47 high byte */
64         mg_io_uint16 dword_io;                                                  /* 48 */
65
66         mg_io_uint16 capabilities;                                              /* 49 */
67         mg_io_uint16 reserved2;                                                 /* 50 */
68
69         mg_io_uint8  vendor_unique3;                                    /* 51 low byte */
70         mg_io_uint8  pio_cycle_timing_mode;                             /* 51 high byte */
71         mg_io_uint8  vendor_unique4;                                    /* 52 low byte */
72         mg_io_uint8  dma_cycle_timing_mode;                             /* 52 high byte */
73         mg_io_uint16 translation_fields_valid;                  /* 53 (low bit) */
74         mg_io_uint16 number_of_current_cylinders;               /* 54 */
75         mg_io_uint16 number_of_current_heads;                   /* 55 */
76         mg_io_uint16 current_sectors_per_track;                 /* 56 */
77         mg_io_uint16 current_sector_capacity_lo;                /* 57 & 58 */
78         mg_io_uint16 current_sector_capacity_hi;                /* 57 & 58 */
79         mg_io_uint8  multi_sector_count;                                /* 59 low */
80         mg_io_uint8  multi_sector_setting_valid;                /* 59 high (low bit) */
81
82         mg_io_uint16 total_user_addressable_sectors_lo; /* 60 & 61 */
83         mg_io_uint16 total_user_addressable_sectors_hi; /* 60 & 61 */
84
85         mg_io_uint8  single_dma_modes_supported;                /* 62 low byte */
86         mg_io_uint8  single_dma_transfer_active;                /* 62 high byte */
87         mg_io_uint8  multi_dma_modes_supported;                 /* 63 low byte */
88         mg_io_uint8  multi_dma_transfer_active;                 /* 63 high byte */
89         mg_io_uint16 adv_pio_mode;
90         mg_io_uint16 min_dma_cyc;
91         mg_io_uint16 recommend_dma_cyc;
92         mg_io_uint16 min_pio_cyc_no_iordy;
93         mg_io_uint16 min_pio_cyc_with_iordy;
94         mg_io_uint8  reserved3[22];
95         mg_io_uint16 major_ver_num;
96         mg_io_uint16 minor_ver_num;
97         mg_io_uint16 feature_cmd_set_suprt0;
98         mg_io_uint16 feature_cmd_set_suprt1;
99         mg_io_uint16 feature_cmd_set_suprt2;
100         mg_io_uint16 feature_cmd_set_en0;
101         mg_io_uint16 feature_cmd_set_en1;
102         mg_io_uint16 feature_cmd_set_en2;
103         mg_io_uint16 reserved4;
104         mg_io_uint16 req_time_for_security_er_done;
105         mg_io_uint16 req_time_for_enhan_security_er_done;
106         mg_io_uint16 adv_pwr_mgm_lvl_val;
107         mg_io_uint16 reserved5;
108         mg_io_uint16 re_of_hw_rst;
109         mg_io_uint8  reserved6[68];
110         mg_io_uint16 security_stas;
111         mg_io_uint8  vendor_uniq_bytes[62];
112         mg_io_uint16 cfa_pwr_mode;
113         mg_io_uint8  reserved7[186];
114
115         mg_io_uint16 scts_per_secure_data_unit;
116         mg_io_uint16 integrity_word;
117
118 } mg_io_type_drv_info;
119
120 typedef struct _mg_pll_t
121 {
122         unsigned int   lock_cyc;
123         unsigned short feedback_div;    /* 9bit divider */
124         unsigned char  input_div;       /* 5bit divider */
125         unsigned char  output_div;      /* 2bit divider */
126 } mg_pll_t;
127
128 typedef struct mg_drv_info_s {
129         mg_io_type_drv_info drv_id;
130         u32 tot_sects;
131 } mg_drv_info_t;
132
133 typedef struct mflash_bank_s
134 {
135         u32 base;
136
137         mflash_gpio_num_t rst_pin;
138
139         mflash_gpio_drv_t *gpio_drv;
140         target_t *target;
141         mg_drv_info_t *drv_info;
142 } mflash_bank_t;
143
144 extern int mflash_register_commands(struct command_context_s *cmd_ctx);
145 extern int mflash_init_drivers(struct command_context_s *cmd_ctx);
146
147 #define MG_MFLASH_SECTOR_SIZE           (0x200)         /* 512Bytes = 2^9 */
148 #define MG_MFLASH_SECTOR_SIZE_MASK      (0x200-1)
149 #define MG_MFLASH_SECTOR_SIZE_SHIFT     (9)
150
151 #define MG_BUFFER_OFFSET        0x8000
152 #define MG_REG_OFFSET           0xC000
153 #define MG_REG_FEATURE          0x2             /* write case */
154 #define MG_REG_ERROR            0x2             /* read case */
155 #define MG_REG_SECT_CNT         0x4
156 #define MG_REG_SECT_NUM         0x6
157 #define MG_REG_CYL_LOW          0x8
158 #define MG_REG_CYL_HIGH         0xA
159 #define MG_REG_DRV_HEAD         0xC
160 #define MG_REG_COMMAND          0xE             /* write case */
161 #define MG_REG_STATUS           0xE             /* read  case */
162 #define MG_REG_DRV_CTRL         0x10
163 #define MG_REG_BURST_CTRL       0x12
164
165 #define MG_OEM_DISK_WAIT_TIME_LONG              15000   /* msec */
166 #define MG_OEM_DISK_WAIT_TIME_NORMAL    3000    /* msec */
167 #define MG_OEM_DISK_WAIT_TIME_SHORT             1000    /* msec */
168
169 #define MG_PLL_CLK_OUT 66000000.0 /* 66Mhz */
170 #define MG_PLL_MAX_FEEDBACKDIV_VAL 512
171 #define MG_PLL_MAX_INPUTDIV_VAL 32
172 #define MG_PLL_MAX_OUTPUTDIV_VAL 4
173
174 #define MG_PLL_STD_INPUTCLK 12000000.0 /* 12Mhz */
175 #define MG_PLL_STD_LOCKCYCLE 10000
176
177 #define MG_UNLOCK_OTP_AREA 0xFF
178
179 #define MG_FILEIO_CHUNK 1048576
180
181 typedef enum _mg_io_type_wait{
182
183         mg_io_wait_bsy       = 1,
184         mg_io_wait_not_bsy   = 2,
185         mg_io_wait_rdy       = 3,
186         mg_io_wait_drq       = 4,       /* wait for data request */
187         mg_io_wait_drq_noerr = 5,       /* wait for DRQ but ignore the error status bit */
188         mg_io_wait_rdy_noerr = 6        /* wait for ready, but ignore error status bit */
189
190 } mg_io_type_wait;
191
192 /*= "Status Register" bit masks. */
193 typedef enum _mg_io_type_rbit_status{
194
195         mg_io_rbit_status_error            = 0x01, /* error bit in status register */
196         mg_io_rbit_status_corrected_error  = 0x04, /* corrected error in status register */
197         mg_io_rbit_status_data_req         = 0x08, /* data request bit in status register */
198         mg_io_rbit_status_seek_done        = 0x10, /* DSC - Drive Seek Complete */
199         mg_io_rbit_status_write_fault      = 0x20, /* DWF - Drive Write Fault */
200         mg_io_rbit_status_ready            = 0x40,
201         mg_io_rbit_status_busy             = 0x80
202
203 } mg_io_type_rbit_status;
204
205 /*= "Error Register" bit masks. */
206 typedef enum _mg_io_type_rbit_error{
207
208         mg_io_rbit_err_general          = 0x01,
209         mg_io_rbit_err_aborted          = 0x04,
210         mg_io_rbit_err_bad_sect_num     = 0x10,
211         mg_io_rbit_err_uncorrectable    = 0x40,
212         mg_io_rbit_err_bad_block        = 0x80
213
214 } mg_io_type_rbit_error;
215
216 /* = "Device Control Register" bit. */
217 typedef enum _mg_io_type_rbit_devc{
218
219         mg_io_rbit_devc_intr      = 0x02,       /* interrupt enable bit (1:disable, 0:enable) */
220         mg_io_rbit_devc_srst      = 0x04        /* softwrae reset bit (1:assert, 0:de-assert) */
221
222 } mg_io_type_rbit_devc;
223
224 /* "Drive Select/Head Register" values. */
225 typedef enum _mg_io_type_rval_dev{
226
227         mg_io_rval_dev_must_be_on      =   0x80, /* These 1 bits are always on */
228         mg_io_rval_dev_drv_master      =  (0x00 | mg_io_rval_dev_must_be_on), /* Master */
229         mg_io_rval_dev_drv_slave0      =  (0x10 | mg_io_rval_dev_must_be_on), /* Slave0 */
230         mg_io_rval_dev_drv_slave1      =  (0x20 | mg_io_rval_dev_must_be_on), /* Slave1 */
231         mg_io_rval_dev_drv_slave2      =  (0x30 | mg_io_rval_dev_must_be_on), /* Slave2 */
232         mg_io_rval_dev_lba_mode        =  (0x40 | mg_io_rval_dev_must_be_on)
233
234 } mg_io_type_rval_dev;
235
236 typedef enum _mg_io_type_cmd
237 {
238         mg_io_cmd_read             =0x20,
239         mg_io_cmd_write            =0x30,
240
241         mg_io_cmd_setmul           =0xC6,
242         mg_io_cmd_readmul          =0xC4,
243         mg_io_cmd_writemul         =0xC5,
244
245         mg_io_cmd_idle             =0x97, /* 0xE3 */
246         mg_io_cmd_idle_immediate   =0x95, /* 0xE1 */
247
248         mg_io_cmd_setsleep         =0x99, /* 0xE6 */
249         mg_io_cmd_stdby            =0x96, /* 0xE2 */
250         mg_io_cmd_stdby_immediate  =0x94, /* 0xE0 */
251
252         mg_io_cmd_identify         =0xEC,
253         mg_io_cmd_set_feature      =0xEF,
254
255         mg_io_cmd_confirm_write    =0x3C,
256         mg_io_cmd_confirm_read     =0x40,
257         mg_io_cmd_wakeup           =0xC3
258
259 } mg_io_type_cmd;
260
261 typedef enum _mg_feature_id
262 {
263         mg_feature_id_transmode = 0x3
264 } mg_feature_id;
265
266 typedef enum _mg_feature_val
267 {
268         mg_feature_val_trans_default = 0x0,
269         mg_feature_val_trans_vcmd = 0x3,
270         mg_feature_val_trand_vcmds = 0x2
271 } mg_feature_val;
272
273 typedef enum _mg_vcmd
274 {
275         mg_vcmd_update_xipinfo = 0xFA, /* FWPATCH commmand through IOM I/O */
276         mg_vcmd_verify_fwpatch = 0xFB, /* FWPATCH commmand through IOM I/O */
277         mg_vcmd_update_stgdrvinfo = 0xFC, /* IOM identificatin info program command */
278         mg_vcmd_prep_fwpatch = 0xFD, /* FWPATCH commmand through IOM I/O */
279         mg_vcmd_exe_fwpatch = 0xFE, /* FWPATCH commmand through IOM I/O */
280         mg_vcmd_wr_pll = 0x8B,
281         mg_vcmd_purge_nand = 0x8C, /* Only for  Seagle */
282         mg_vcmd_lock_otp = 0x8D,
283         mg_vcmd_rd_otp = 0x8E,
284         mg_vcmd_wr_otp = 0x8F
285 } mg_vcmd;
286
287 typedef enum _mg_opmode
288 {
289         mg_op_mode_xip = 1, /* TRUE XIP */
290         mg_op_mode_snd = 2, /* BOOT+Storage */
291         mg_op_mode_stg = 0  /* Only Storage */
292 } mg_opmode;
293
294 #endif