jtag_get_device() now returns NULL and reports error instead of invoking exit()
[fw/openocd] / src / flash / mflash.h
index 3fc935a2cfef1d89424b19d38f363f431c07c697..7e7e7c64e760b118e1df8fa6f6249d2fe3fb2f0d 100644 (file)
-/***************************************************************************\r
- *   Copyright (C) 2007-2008 by unsik Kim <donari75@gmail.com>             *\r
- *                                                                         *\r
- *   This program is free software; you can redistribute it and/or modify  *\r
- *   it under the terms of the GNU General Public License as published by  *\r
- *   the Free Software Foundation; either version 2 of the License, or     *\r
- *   (at your option) any later version.                                   *\r
- *                                                                         *\r
- *   This program is distributed in the hope that it will be useful,       *\r
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *\r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *\r
- *   GNU General Public License for more details.                          *\r
- *                                                                         *\r
- *   You should have received a copy of the GNU General Public License     *\r
- *   along with this program; if not, write to the                         *\r
- *   Free Software Foundation, Inc.,                                       *\r
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *\r
- ***************************************************************************/\r
-\r
-#ifndef _MFLASH_H\r
-#define _MFLASH_H\r
-\r
-typedef unsigned long mg_io_uint32;\r
-typedef unsigned short mg_io_uint16;\r
-typedef unsigned char mg_io_uint8;\r
-\r
-typedef struct mflash_gpio_num_s\r
-{\r
-       char port[2];\r
-       signed short num;\r
-} mflash_gpio_num_t;\r
-\r
-typedef struct mflash_gpio_drv_s\r
-{\r
-       char *name;\r
-       int (*set_gpio_to_output) (mflash_gpio_num_t gpio);\r
-       int (*set_gpio_output_val) (mflash_gpio_num_t gpio, u8 val);\r
-} mflash_gpio_drv_t;\r
-\r
-typedef struct _mg_io_type_drv_info {\r
-\r
-    mg_io_uint16 general_configuration;            // 00\r
-    mg_io_uint16 number_of_cylinders;               // 01\r
-    mg_io_uint16 reserved1;                       // 02\r
-    mg_io_uint16 number_of_heads;                   // 03\r
-    mg_io_uint16 unformatted_bytes_per_track;        // 04\r
-    mg_io_uint16 unformatted_bytes_per_sector;       // 05\r
-    mg_io_uint16 sectors_per_track;                 // 06\r
-    mg_io_uint8  vendor_unique1[6];                // 07/08/09\r
-\r
-    mg_io_uint8  serial_number[20];                // 10~19\r
-\r
-    mg_io_uint16 buffer_type;                      // 20\r
-    mg_io_uint16 buffer_sector_size;                // 21\r
-    mg_io_uint16 number_of_ecc_bytes;                // 22\r
-\r
-    mg_io_uint8  firmware_revision[8];             // 23~26\r
-    mg_io_uint8  model_number[40];                 // 27\r
-\r
-    mg_io_uint8  maximum_block_transfer;            // 47 low byte\r
-    mg_io_uint8  vendor_unique2;                   // 47 high byte\r
-    mg_io_uint16 dword_io;                    // 48\r
-\r
-    mg_io_uint16 capabilities;                    // 49\r
-    mg_io_uint16 reserved2;                       // 50\r
-\r
-    mg_io_uint8  vendor_unique3;                   // 51 low byte\r
-    mg_io_uint8  pio_cycle_timing_mode;              // 51 high byte\r
-    mg_io_uint8  vendor_unique4;                   // 52 low byte\r
-    mg_io_uint8  dma_cycle_timing_mode;              // 52 high byte\r
-    mg_io_uint16 translation_fields_valid;          // 53 (low bit)\r
-    mg_io_uint16 number_of_current_cylinders;        // 54\r
-    mg_io_uint16 number_of_current_heads;            // 55\r
-    mg_io_uint16 current_sectors_per_track;          // 56\r
-    mg_io_uint16 current_sector_capacity_lo;      // 57 & 58\r
-    mg_io_uint16 current_sector_capacity_hi;     // 57 & 58\r
-    mg_io_uint8  multi_sector_count;                // 59 low\r
-    mg_io_uint8  multi_sector_setting_valid;         // 59 high (low bit)\r
-\r
-    mg_io_uint16 total_user_addressable_sectors_lo;     // 60 & 61\r
-    mg_io_uint16 total_user_addressable_sectors_hi;     // 60 & 61\r
-\r
-    mg_io_uint8  single_dma_modes_supported;         // 62 low byte\r
-    mg_io_uint8  single_dma_transfer_active;         // 62 high byte\r
-    mg_io_uint8  multi_dma_modes_supported;          // 63 low byte\r
-    mg_io_uint8  multi_dma_transfer_active;          // 63 high byte\r
-    mg_io_uint16 adv_pio_mode;\r
-    mg_io_uint16 min_dma_cyc;\r
-    mg_io_uint16 recommend_dma_cyc;\r
-    mg_io_uint16 min_pio_cyc_no_iordy;\r
-    mg_io_uint16 min_pio_cyc_with_iordy;\r
-    mg_io_uint8  reserved3[22];\r
-    mg_io_uint16 major_ver_num;\r
-    mg_io_uint16 minor_ver_num;\r
-    mg_io_uint16 feature_cmd_set_suprt0;\r
-    mg_io_uint16 feature_cmd_set_suprt1;\r
-    mg_io_uint16 feature_cmd_set_suprt2;\r
-    mg_io_uint16 feature_cmd_set_en0;\r
-    mg_io_uint16 feature_cmd_set_en1;\r
-    mg_io_uint16 feature_cmd_set_en2;\r
-    mg_io_uint16 reserved4;\r
-    mg_io_uint16 req_time_for_security_er_done;\r
-    mg_io_uint16 req_time_for_enhan_security_er_done;\r
-    mg_io_uint16 adv_pwr_mgm_lvl_val;\r
-    mg_io_uint16 reserved5;\r
-    mg_io_uint16 re_of_hw_rst;\r
-    mg_io_uint8  reserved6[68];\r
-    mg_io_uint16 security_stas;\r
-    mg_io_uint8  vendor_uniq_bytes[62];\r
-    mg_io_uint16 cfa_pwr_mode;\r
-    mg_io_uint8  reserved7[186];\r
-\r
-    mg_io_uint16 scts_per_secure_data_unit;\r
-    mg_io_uint16 integrity_word;\r
-\r
-} mg_io_type_drv_info;\r
-\r
-typedef struct mg_drv_info_s {\r
-       mg_io_type_drv_info drv_id;\r
-       u32 tot_sects;\r
-} mg_drv_info_t;\r
-\r
-typedef struct mflash_bank_s\r
-{\r
-       u32 base;\r
-       u32 chip_width;\r
-       u32 bus_width;\r
-\r
-       mflash_gpio_num_t rst_pin;\r
-       mflash_gpio_num_t wp_pin;\r
-       mflash_gpio_num_t dpd_pin;\r
-\r
-       mflash_gpio_drv_t *gpio_drv;\r
-       target_t *target;\r
-       mg_drv_info_t *drv_info;\r
-\r
-       u8 proved;\r
-} mflash_bank_t;\r
-\r
-extern int mflash_register_commands(struct command_context_s *cmd_ctx);\r
-extern int mflash_init_drivers(struct command_context_s *cmd_ctx);\r
-\r
-#define MG_MFLASH_SECTOR_SIZE       (0x200)        //512Bytes = 2^9\r
-#define MG_MFLASH_SECTOR_SIZE_MASK  (0x200-1)\r
-#define MG_MFLASH_SECTOR_SIZE_SHIFT (9)\r
-\r
-#define MG_BUFFER_OFFSET    0x8000\r
-#define MG_REG_OFFSET          0xC000\r
-#define MG_REG_FEATURE         0x2 // write case\r
-#define MG_REG_ERROR           0x2 // read case\r
-#define MG_REG_SECT_CNT                0x4\r
-#define MG_REG_SECT_NUM                0x6\r
-#define MG_REG_CYL_LOW         0x8\r
-#define MG_REG_CYL_HIGH                0xA\r
-#define MG_REG_DRV_HEAD                0xC\r
-#define MG_REG_COMMAND         0xE // write case\r
-#define MG_REG_STATUS          0xE // read  case\r
-#define MG_REG_DRV_CTRL                0x10\r
-#define MG_REG_BURST_CTRL      0x12\r
-\r
-#define MG_OEM_DISK_WAIT_TIME_LONG   15000 // msec\r
-#define MG_OEM_DISK_WAIT_TIME_NORMAL  3000 // msec\r
-#define MG_OEM_DISK_WAIT_TIME_SHORT   1000 // msec\r
-\r
-typedef enum _mg_io_type_wait{\r
-\r
-    mg_io_wait_bsy       = 1,\r
-    mg_io_wait_not_bsy   = 2,\r
-    mg_io_wait_rdy       = 3,\r
-    mg_io_wait_drq       = 4,  // wait for data request\r
-    mg_io_wait_drq_noerr = 5,  // wait for DRQ but ignore the error status bit\r
-    mg_io_wait_rdy_noerr = 6   // wait for ready, but ignore error status bit\r
-\r
-} mg_io_type_wait;\r
-\r
-//= "Status Register" bit masks.\r
-typedef enum _mg_io_type_rbit_status{\r
-\r
-    mg_io_rbit_status_error            = 0x01, // error bit in status register\r
-    mg_io_rbit_status_corrected_error  = 0x04, // corrected error in status register\r
-    mg_io_rbit_status_data_req         = 0x08, // data request bit in status register\r
-    mg_io_rbit_status_seek_done        = 0x10, // DSC - Drive Seek Complete\r
-    mg_io_rbit_status_write_fault      = 0x20, // DWF - Drive Write Fault\r
-    mg_io_rbit_status_ready            = 0x40,\r
-    mg_io_rbit_status_busy             = 0x80\r
-\r
-} mg_io_type_rbit_status;\r
-\r
-//= "Error Register" bit masks.\r
-typedef enum _mg_io_type_rbit_error{\r
-\r
-    mg_io_rbit_err_general          = 0x01,\r
-    mg_io_rbit_err_aborted          = 0x04,\r
-    mg_io_rbit_err_bad_sect_num     = 0x10,\r
-    mg_io_rbit_err_uncorrectable    = 0x40,\r
-    mg_io_rbit_err_bad_block        = 0x80\r
-\r
-} mg_io_type_rbit_error;\r
-\r
-//= "Device Control Register" bit.\r
-typedef enum _mg_io_type_rbit_devc{\r
-\r
-    mg_io_rbit_devc_intr      = 0x02,//  interrupt enable bit (1:disable, 0:enable)\r
-    mg_io_rbit_devc_srst      = 0x04  // softwrae reset bit (1:assert, 0:de-assert)\r
-\r
-} mg_io_type_rbit_devc;\r
-\r
-// "Drive Select/Head Register" values.\r
-typedef enum _mg_io_type_rval_dev{\r
-\r
-    mg_io_rval_dev_must_be_on      =   0x80, // These 1 bits are always on\r
-    mg_io_rval_dev_drv_master      =  (0x00 | mg_io_rval_dev_must_be_on),// Master\r
-    mg_io_rval_dev_drv_slave0      =  (0x10 | mg_io_rval_dev_must_be_on),// Slave0\r
-    mg_io_rval_dev_drv_slave1      =  (0x20 | mg_io_rval_dev_must_be_on),// Slave1\r
-    mg_io_rval_dev_drv_slave2      =  (0x30 | mg_io_rval_dev_must_be_on),// Slave2\r
-    mg_io_rval_dev_lba_mode        =  (0x40 | mg_io_rval_dev_must_be_on)\r
-\r
-} mg_io_type_rval_dev;\r
-\r
-typedef enum _mg_io_type_cmd\r
-{\r
-    mg_io_cmd_read             =0x20,\r
-    mg_io_cmd_write            =0x30,\r
-\r
-    mg_io_cmd_setmul           =0xC6,\r
-    mg_io_cmd_readmul          =0xC4,\r
-    mg_io_cmd_writemul         =0xC5,\r
-\r
-    mg_io_cmd_idle             =0x97,//0xE3\r
-    mg_io_cmd_idle_immediate   =0x95,//0xE1\r
-\r
-    mg_io_cmd_setsleep         =0x99,//0xE6\r
-    mg_io_cmd_stdby            =0x96,//0xE2\r
-    mg_io_cmd_stdby_immediate  =0x94,//0xE0\r
-\r
-    mg_io_cmd_identify         =0xEC,\r
-    mg_io_cmd_set_feature      =0xEF,\r
-\r
-    mg_io_cmd_confirm_write    =0x3C,\r
-    mg_io_cmd_confirm_read     =0x40,\r
-    mg_io_cmd_wakeup           =0xC3\r
-\r
-} mg_io_type_cmd;\r
-\r
-#endif\r
+/***************************************************************************
+ *   Copyright (C) 2007-2008 by unsik Kim <donari75@gmail.com>             *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+#ifndef _MFLASH_H
+#define _MFLASH_H
+
+typedef unsigned long mg_io_uint32;
+typedef unsigned short mg_io_uint16;
+typedef unsigned char mg_io_uint8;
+
+typedef struct mflash_gpio_num_s
+{
+       char port[2];
+       signed short num;
+} mflash_gpio_num_t;
+
+typedef struct mflash_gpio_drv_s
+{
+       char *name;
+       int (*set_gpio_to_output) (mflash_gpio_num_t gpio);
+       int (*set_gpio_output_val) (mflash_gpio_num_t gpio, u8 val);
+} mflash_gpio_drv_t;
+
+typedef struct _mg_io_type_drv_info {
+
+    mg_io_uint16 general_configuration;            // 00
+    mg_io_uint16 number_of_cylinders;               // 01
+    mg_io_uint16 reserved1;                       // 02
+    mg_io_uint16 number_of_heads;                   // 03
+    mg_io_uint16 unformatted_bytes_per_track;        // 04
+    mg_io_uint16 unformatted_bytes_per_sector;       // 05
+    mg_io_uint16 sectors_per_track;                 // 06
+    mg_io_uint8  vendor_unique1[6];                // 07/08/09
+
+    mg_io_uint8  serial_number[20];                // 10~19
+
+    mg_io_uint16 buffer_type;                      // 20
+    mg_io_uint16 buffer_sector_size;                // 21
+    mg_io_uint16 number_of_ecc_bytes;                // 22
+
+    mg_io_uint8  firmware_revision[8];             // 23~26
+    mg_io_uint8  model_number[40];                 // 27
+
+    mg_io_uint8  maximum_block_transfer;            // 47 low byte
+    mg_io_uint8  vendor_unique2;                   // 47 high byte
+    mg_io_uint16 dword_io;                    // 48
+
+    mg_io_uint16 capabilities;                    // 49
+    mg_io_uint16 reserved2;                       // 50
+
+    mg_io_uint8  vendor_unique3;                   // 51 low byte
+    mg_io_uint8  pio_cycle_timing_mode;              // 51 high byte
+    mg_io_uint8  vendor_unique4;                   // 52 low byte
+    mg_io_uint8  dma_cycle_timing_mode;              // 52 high byte
+    mg_io_uint16 translation_fields_valid;          // 53 (low bit)
+    mg_io_uint16 number_of_current_cylinders;        // 54
+    mg_io_uint16 number_of_current_heads;            // 55
+    mg_io_uint16 current_sectors_per_track;          // 56
+    mg_io_uint16 current_sector_capacity_lo;      // 57 & 58
+    mg_io_uint16 current_sector_capacity_hi;     // 57 & 58
+    mg_io_uint8  multi_sector_count;                // 59 low
+    mg_io_uint8  multi_sector_setting_valid;         // 59 high (low bit)
+
+    mg_io_uint16 total_user_addressable_sectors_lo;     // 60 & 61
+    mg_io_uint16 total_user_addressable_sectors_hi;     // 60 & 61
+
+    mg_io_uint8  single_dma_modes_supported;         // 62 low byte
+    mg_io_uint8  single_dma_transfer_active;         // 62 high byte
+    mg_io_uint8  multi_dma_modes_supported;          // 63 low byte
+    mg_io_uint8  multi_dma_transfer_active;          // 63 high byte
+    mg_io_uint16 adv_pio_mode;
+    mg_io_uint16 min_dma_cyc;
+    mg_io_uint16 recommend_dma_cyc;
+    mg_io_uint16 min_pio_cyc_no_iordy;
+    mg_io_uint16 min_pio_cyc_with_iordy;
+    mg_io_uint8  reserved3[22];
+    mg_io_uint16 major_ver_num;
+    mg_io_uint16 minor_ver_num;
+    mg_io_uint16 feature_cmd_set_suprt0;
+    mg_io_uint16 feature_cmd_set_suprt1;
+    mg_io_uint16 feature_cmd_set_suprt2;
+    mg_io_uint16 feature_cmd_set_en0;
+    mg_io_uint16 feature_cmd_set_en1;
+    mg_io_uint16 feature_cmd_set_en2;
+    mg_io_uint16 reserved4;
+    mg_io_uint16 req_time_for_security_er_done;
+    mg_io_uint16 req_time_for_enhan_security_er_done;
+    mg_io_uint16 adv_pwr_mgm_lvl_val;
+    mg_io_uint16 reserved5;
+    mg_io_uint16 re_of_hw_rst;
+    mg_io_uint8  reserved6[68];
+    mg_io_uint16 security_stas;
+    mg_io_uint8  vendor_uniq_bytes[62];
+    mg_io_uint16 cfa_pwr_mode;
+    mg_io_uint8  reserved7[186];
+
+    mg_io_uint16 scts_per_secure_data_unit;
+    mg_io_uint16 integrity_word;
+
+} mg_io_type_drv_info;
+
+typedef struct mg_drv_info_s {
+       mg_io_type_drv_info drv_id;
+       u32 tot_sects;
+} mg_drv_info_t;
+
+typedef struct mflash_bank_s
+{
+       u32 base;
+       u32 chip_width;
+       u32 bus_width;
+
+       mflash_gpio_num_t rst_pin;
+       mflash_gpio_num_t wp_pin;
+       mflash_gpio_num_t dpd_pin;
+
+       mflash_gpio_drv_t *gpio_drv;
+       target_t *target;
+       mg_drv_info_t *drv_info;
+
+       u8 proved;
+} mflash_bank_t;
+
+extern int mflash_register_commands(struct command_context_s *cmd_ctx);
+extern int mflash_init_drivers(struct command_context_s *cmd_ctx);
+
+#define MG_MFLASH_SECTOR_SIZE       (0x200)        //512Bytes = 2^9
+#define MG_MFLASH_SECTOR_SIZE_MASK  (0x200-1)
+#define MG_MFLASH_SECTOR_SIZE_SHIFT (9)
+
+#define MG_BUFFER_OFFSET    0x8000
+#define MG_REG_OFFSET          0xC000
+#define MG_REG_FEATURE         0x2 // write case
+#define MG_REG_ERROR           0x2 // read case
+#define MG_REG_SECT_CNT                0x4
+#define MG_REG_SECT_NUM                0x6
+#define MG_REG_CYL_LOW         0x8
+#define MG_REG_CYL_HIGH                0xA
+#define MG_REG_DRV_HEAD                0xC
+#define MG_REG_COMMAND         0xE // write case
+#define MG_REG_STATUS          0xE // read  case
+#define MG_REG_DRV_CTRL                0x10
+#define MG_REG_BURST_CTRL      0x12
+
+#define MG_OEM_DISK_WAIT_TIME_LONG   15000 // msec
+#define MG_OEM_DISK_WAIT_TIME_NORMAL  3000 // msec
+#define MG_OEM_DISK_WAIT_TIME_SHORT   1000 // msec
+
+typedef enum _mg_io_type_wait{
+
+    mg_io_wait_bsy       = 1,
+    mg_io_wait_not_bsy   = 2,
+    mg_io_wait_rdy       = 3,
+    mg_io_wait_drq       = 4,  // wait for data request
+    mg_io_wait_drq_noerr = 5,  // wait for DRQ but ignore the error status bit
+    mg_io_wait_rdy_noerr = 6   // wait for ready, but ignore error status bit
+
+} mg_io_type_wait;
+
+//= "Status Register" bit masks.
+typedef enum _mg_io_type_rbit_status{
+
+    mg_io_rbit_status_error            = 0x01, // error bit in status register
+    mg_io_rbit_status_corrected_error  = 0x04, // corrected error in status register
+    mg_io_rbit_status_data_req         = 0x08, // data request bit in status register
+    mg_io_rbit_status_seek_done        = 0x10, // DSC - Drive Seek Complete
+    mg_io_rbit_status_write_fault      = 0x20, // DWF - Drive Write Fault
+    mg_io_rbit_status_ready            = 0x40,
+    mg_io_rbit_status_busy             = 0x80
+
+} mg_io_type_rbit_status;
+
+//= "Error Register" bit masks.
+typedef enum _mg_io_type_rbit_error{
+
+    mg_io_rbit_err_general          = 0x01,
+    mg_io_rbit_err_aborted          = 0x04,
+    mg_io_rbit_err_bad_sect_num     = 0x10,
+    mg_io_rbit_err_uncorrectable    = 0x40,
+    mg_io_rbit_err_bad_block        = 0x80
+
+} mg_io_type_rbit_error;
+
+//= "Device Control Register" bit.
+typedef enum _mg_io_type_rbit_devc{
+
+    mg_io_rbit_devc_intr      = 0x02,//  interrupt enable bit (1:disable, 0:enable)
+    mg_io_rbit_devc_srst      = 0x04  // softwrae reset bit (1:assert, 0:de-assert)
+
+} mg_io_type_rbit_devc;
+
+// "Drive Select/Head Register" values.
+typedef enum _mg_io_type_rval_dev{
+
+    mg_io_rval_dev_must_be_on      =   0x80, // These 1 bits are always on
+    mg_io_rval_dev_drv_master      =  (0x00 | mg_io_rval_dev_must_be_on),// Master
+    mg_io_rval_dev_drv_slave0      =  (0x10 | mg_io_rval_dev_must_be_on),// Slave0
+    mg_io_rval_dev_drv_slave1      =  (0x20 | mg_io_rval_dev_must_be_on),// Slave1
+    mg_io_rval_dev_drv_slave2      =  (0x30 | mg_io_rval_dev_must_be_on),// Slave2
+    mg_io_rval_dev_lba_mode        =  (0x40 | mg_io_rval_dev_must_be_on)
+
+} mg_io_type_rval_dev;
+
+typedef enum _mg_io_type_cmd
+{
+    mg_io_cmd_read             =0x20,
+    mg_io_cmd_write            =0x30,
+
+    mg_io_cmd_setmul           =0xC6,
+    mg_io_cmd_readmul          =0xC4,
+    mg_io_cmd_writemul         =0xC5,
+
+    mg_io_cmd_idle             =0x97,//0xE3
+    mg_io_cmd_idle_immediate   =0x95,//0xE1
+
+    mg_io_cmd_setsleep         =0x99,//0xE6
+    mg_io_cmd_stdby            =0x96,//0xE2
+    mg_io_cmd_stdby_immediate  =0x94,//0xE0
+
+    mg_io_cmd_identify         =0xEC,
+    mg_io_cmd_set_feature      =0xEF,
+
+    mg_io_cmd_confirm_write    =0x3C,
+    mg_io_cmd_confirm_read     =0x40,
+    mg_io_cmd_wakeup           =0xC3
+
+} mg_io_type_cmd;
+
+#endif