build: cleanup src/flash directory
[fw/openocd] / src / flash / mflash.h
index 0520c5fa9fd6c34078124aebc995e37cd329d765..d1284ff894ebf01771c5c42ed5d3fc1bc4b16a1f 100644 (file)
@@ -26,17 +26,15 @@ typedef unsigned long mg_io_uint32;
 typedef unsigned short mg_io_uint16;
 typedef unsigned char mg_io_uint8;
 
-struct mflash_gpio_num
-{
+struct mflash_gpio_num {
        char port[2];
        signed short num;
 };
 
-struct mflash_gpio_drv
-{
+struct mflash_gpio_drv {
        const char *name;
-       int (*set_gpio_to_output) (struct mflash_gpio_num gpio);
-       int (*set_gpio_output_val) (struct mflash_gpio_num gpio, uint8_t val);
+       int (*set_gpio_to_output)(struct mflash_gpio_num gpio);
+       int (*set_gpio_output_val)(struct mflash_gpio_num gpio, uint8_t val);
 };
 
 typedef struct _mg_io_type_drv_info {
@@ -48,50 +46,50 @@ typedef struct _mg_io_type_drv_info {
        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_uint16  vendor_unique1[3];                                /* 07/08/09 */
+       mg_io_uint16 vendor_unique1[3];                                 /* 07/08/09 */
 
-       mg_io_uint8  serial_number[20];                                 /* 10~19 */
+       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 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_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_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_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_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_uint8 reserved3[22];
        mg_io_uint16 major_ver_num;
        mg_io_uint16 minor_ver_num;
        mg_io_uint16 feature_cmd_set_suprt0;
@@ -106,23 +104,22 @@ typedef struct _mg_io_type_drv_info {
        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_uint8 reserved6[68];
        mg_io_uint16 security_stas;
-       mg_io_uint8  vendor_uniq_bytes[62];
+       mg_io_uint8 vendor_uniq_bytes[62];
        mg_io_uint16 cfa_pwr_mode;
-       mg_io_uint8  reserved7[186];
+       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_pll_t
-{
-       unsigned int   lock_cyc;
+typedef struct _mg_pll_t {
+       unsigned int lock_cyc;
        unsigned short feedback_div;    /* 9bit divider */
-       unsigned char  input_div;       /* 5bit divider */
-       unsigned char  output_div;      /* 2bit divider */
+       unsigned char input_div;        /* 5bit divider */
+       unsigned char output_div;       /* 2bit divider */
 } mg_pll_t;
 
 struct mg_drv_info {
@@ -130,8 +127,7 @@ struct mg_drv_info {
        uint32_t tot_sects;
 };
 
-struct mflash_bank
-{
+struct mflash_bank {
        uint32_t base;
 
        struct mflash_gpio_num rst_pin;
@@ -143,34 +139,34 @@ struct mflash_bank
 
 int mflash_register_commands(struct command_context *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 */
-
-#define MG_PLL_CLK_OUT 66000000.0 /* 66Mhz */
+#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 */
+
+#define MG_PLL_CLK_OUT 66000000.0      /* 66Mhz */
 #define MG_PLL_MAX_FEEDBACKDIV_VAL 512
 #define MG_PLL_MAX_INPUTDIV_VAL 32
 #define MG_PLL_MAX_OUTPUTDIV_VAL 4
 
-#define MG_PLL_STD_INPUTCLK 12000000.0 /* 12Mhz */
+#define MG_PLL_STD_INPUTCLK 12000000.0 /* 12Mhz */
 #define MG_PLL_STD_LOCKCYCLE 10000
 
 #define MG_UNLOCK_OTP_AREA 0xFF
@@ -184,7 +180,7 @@ int mflash_register_commands(struct command_context *cmd_ctx);
 #define ERROR_MG_INVALID_OSC (-1605)
 #define ERROR_MG_UNSUPPORTED_SOC (-1606)
 
-typedef enum _mg_io_type_wait{
+typedef enum _mg_io_type_wait {
 
        mg_io_wait_bsy       = 1,
        mg_io_wait_not_bsy   = 2,
@@ -196,20 +192,20 @@ typedef enum _mg_io_type_wait{
 } mg_io_type_wait;
 
 /*= "Status Register" bit masks. */
-typedef enum _mg_io_type_rbit_status{
+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_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{
+typedef enum _mg_io_type_rbit_error {
 
        mg_io_rbit_err_general          = 0x01,
        mg_io_rbit_err_aborted          = 0x04,
@@ -220,7 +216,7 @@ typedef enum _mg_io_type_rbit_error{
 } mg_io_type_rbit_error;
 
 /* = "Device Control Register" bit. */
-typedef enum _mg_io_type_rbit_devc{
+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) */
@@ -228,73 +224,68 @@ typedef enum _mg_io_type_rbit_devc{
 } mg_io_type_rbit_devc;
 
 /* "Drive Select/Head Register" values. */
-typedef enum _mg_io_type_rval_dev{
+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_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,
+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_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_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_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_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_cmd_confirm_write    = 0x3C,
+       mg_io_cmd_confirm_read     = 0x40,
+       mg_io_cmd_wakeup           = 0xC3
 
 } mg_io_type_cmd;
 
-typedef enum _mg_feature_id
-{
+typedef enum _mg_feature_id {
        mg_feature_id_transmode = 0x3
 } mg_feature_id;
 
-typedef enum _mg_feature_val
-{
+typedef enum _mg_feature_val {
        mg_feature_val_trans_default = 0x0,
        mg_feature_val_trans_vcmd = 0x3,
        mg_feature_val_trand_vcmds = 0x2
 } mg_feature_val;
 
-typedef enum _mg_vcmd
-{
-       mg_vcmd_update_xipinfo = 0xFA, /* FWPATCH commmand through IOM I/O */
-       mg_vcmd_verify_fwpatch = 0xFB, /* FWPATCH commmand through IOM I/O */
-       mg_vcmd_update_stgdrvinfo = 0xFC, /* IOM identificatin info program command */
-       mg_vcmd_prep_fwpatch = 0xFD, /* FWPATCH commmand through IOM I/O */
-       mg_vcmd_exe_fwpatch = 0xFE, /* FWPATCH commmand through IOM I/O */
+typedef enum _mg_vcmd {
+       mg_vcmd_update_xipinfo = 0xFA,  /* FWPATCH commmand through IOM I/O */
+       mg_vcmd_verify_fwpatch = 0xFB,  /* FWPATCH commmand through IOM I/O */
+       mg_vcmd_update_stgdrvinfo = 0xFC,       /* IOM identificatin info program command */
+       mg_vcmd_prep_fwpatch = 0xFD,    /* FWPATCH commmand through IOM I/O */
+       mg_vcmd_exe_fwpatch = 0xFE,     /* FWPATCH commmand through IOM I/O */
        mg_vcmd_wr_pll = 0x8B,
-       mg_vcmd_purge_nand = 0x8C, /* Only for  Seagle */
+       mg_vcmd_purge_nand = 0x8C,      /* Only for  Seagle */
        mg_vcmd_lock_otp = 0x8D,
        mg_vcmd_rd_otp = 0x8E,
        mg_vcmd_wr_otp = 0x8F
 } mg_vcmd;
 
-typedef enum _mg_opmode
-{
-       mg_op_mode_xip = 1, /* TRUE XIP */
-       mg_op_mode_snd = 2, /* BOOT + Storage */
-       mg_op_mode_stg = 0  /* Only Storage */
+typedef enum _mg_opmode {
+       mg_op_mode_xip = 1,     /* TRUE XIP */
+       mg_op_mode_snd = 2,     /* BOOT + Storage */
+       mg_op_mode_stg = 0      /* Only Storage */
 } mg_opmode;
 
 #endif