Go to the documentation of this file.
35 #ifndef SEMPERFLASH2_H
36 #define SEMPERFLASH2_H
42 #ifdef PREINIT_SUPPORTED
46 #ifdef MikroCCoreVersion
47 #if MikroCCoreVersion >= 1
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_spi_master.h"
67 #define SEMPERFLASH2_MAP_MIKROBUS( cfg, mikrobus ) \
68 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
69 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
70 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
71 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
72 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
73 cfg.io2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
74 cfg.io3 = MIKROBUS( mikrobus, MIKROBUS_INT )
81 #define SEMPERFLASH2_RETVAL uint8_t
83 #define SEMPERFLASH2_OK 0x00
84 #define SEMPERFLASH2_INIT_ERROR 0xFF
91 #define SEMPERFLASH2_MANUFACTURER_DEVICE_ID 0x9F
92 #define SEMPERFLASH2_JEDEC_SERIAL_FLASH_DISCOVER_PARAMS 0x5A
93 #define SEMPERFLASH2_DEVICE_ID 0x4C
94 #define SEMPERFLASH2_READ_STATUS_REG_1 0x05
95 #define SEMPERFLASH2_READ_STATUS_REG_2 0x07
96 #define SEMPERFLASH2_READ_CFG_REG_1 0x35
97 #define SEMPERFLASH2_READ_ANY_REG 0x65
98 #define SEMPERFLASH2_WRITE_ENABLE 0x06
99 #define SEMPERFLASH2_WRITE_ENABLE_VOLATILE 0x50
100 #define SEMPERFLASH2_WRITE_DISABLE 0x04
101 #define SEMPERFLASH2_WRITE_REG 0x01
102 #define SEMPERFLASH2_WRITE_ANY_REG 0x71
103 #define SEMPERFLASH2_CLEAR_PROGRAM_ERASE_ERROR 0x30
104 #define SEMPERFLASH2_ENTER_4_BYTE_ADDR_MODE 0xB7
105 #define SEMPERFLASH2_EXIT_4_BYTE_ADDR_MODE 0xB8
106 #define SEMPERFLASH2_READ_DATA_LEARN_PATT_REG 0x41
107 #define SEMPERFLASH2_PROGRAM_DATA_LEARN_PATT 0x43
108 #define SEMPERFLASH2_WRITE_DATA_LEARN_PATT 0x4A
109 #define SEMPERFLASH2_AUTOBOOT_REG_WRITE 0x15
110 #define SEMPERFLASH2_READ_ECC_STATUS 0x19
111 #define SEMPERFLASH2_CLEAR_ECC_STATUS 0x1B
112 #define SEMPERFLASH2_DATA_INT_CHECK 0x5B
113 #define SEMPERFLASH2_READ_0 0x03
114 #define SEMPERFLASH2_READ_1 0x13
115 #define SEMPERFLASH2_FAST_READ_0 0x0B
116 #define SEMPERFLASH2_FAST_READ_1 0x0C
117 #define SEMPERFLASH2_PROGRAM_PAGE_0 0x02
118 #define SEMPERFLASH2_PROGRAM_PAGE_1 0x12
119 #define SEMPERFLASH2_ERASE_4K_0 0x20
120 #define SEMPERFLASH2_ERASE_4K_1 0x21
121 #define SEMPERFLASH2_ERASE_256K_1 0xD8
122 #define SEMPERFLASH2_ERASE_256K_2 0xDC
123 #define SEMPERFLASH2_ERASE_CHIP_1 0x60
124 #define SEMPERFLASH2_ERASE_CHIP_2 0xC7
125 #define SEMPERFLASH2_ERASE_STATUS 0xD0
126 #define SEMPERFLASH2_ERASE_CNT 0x5D
127 #define SEMPERFLASH2_SUSPEND_ERASE_PROG_DATA_CHECK 0x75
128 #define SEMPERFLASH2_SUSPEND_ERASE_PROG 0x85
129 #define SEMPERFLASH2_RESUME_ERASE_PROG_DATA_CHECK 0x7A
130 #define SEMPERFLASH2_RESUME_ERASE_PROG 0x8A
131 #define SEMPERFLASH2_PROG_SECURE_SILICON_REGION 0x42
132 #define SEMPERFLASH2_READ_SECURE_SILICON_REGION 0x4B
133 #define SEMPERFLASH2_ASP_PROG 0x2F
134 #define SEMPERFLASH2_READ_DYNAMIC_PROTECION_BIT 0xFA
135 #define SEMPERFLASH2_WRITE_DYNAMIC_PROTECION_BIT 0xFB
136 #define SEMPERFLASH2_READ_PRESISTENT_PROTECTION_BIT 0xFC
137 #define SEMPERFLASH2_PROG_PRESISTENT_PROTECTION_BIT 0xFD
138 #define SEMPERFLASH2_ERASE_PRESISTENT_PROTECTION_BIT 0xE4
139 #define SEMPERFLASH2_WRITE_PPB_PROTECTION_LOCK_BIT 0xA6
140 #define SEMPERFLASH2_READ_PROG_PRESISTENT_PROTECION_LOCK_BIT 0xA7
141 #define SEMPERFLASH2_PROG_PASSWORD 0xE8
142 #define SEMPERFLASH2_PASSWORD_UNLOCK 0xE9
143 #define SEMPERFLASH2_SOFT_RESET_ENABLE 0x66
144 #define SEMPERFLASH2_SOFT_RESET 0x99
145 #define SEMPERFLASH2_LEGACY_SOFT_RESET 0xF0
146 #define SEMPERFLASH2_ENTER_DEEP_POWER_DOWN_MODE 0xB9
148 #define SEMPERFLASH2_PIN_STATE_HIGH 1
149 #define SEMPERFLASH2_PIN_STATE_LOW 0
151 #define SEMPERFLASH2_ID_ERROR 0xCC
152 #define SEMPERFLASH2_SIZE_ERROR 0xBB
153 #define SEMPERFLASH2_SUCCESS 0xAA
155 #define SEMPERFLASH2_MANUFACTURER_DEVICE_ID_VALUE 0x34
156 #define SEMPERFLASH2_DEVICE_ID_BYTE_SIZE 8
158 #define SEMPERFLASH2_STATUS_REG_1_DEFAULT 0x00
159 #define SEMPERFLASH2_STATUS_REG_1_PROGRAM_ERASE_REG_WRITE_ENABLE 0x02
160 #define SEMPERFLASH2_STATUS_REG_1_DEVICE_BUSY 0x01
161 #define SEMPERFLASH2_CFG_1_DEFAULT 0x00
162 #define SEMPERFLASH2_CFG_2_DEFAULT 0x00
163 #define SEMPERFLASH2_CFG_3_DEFAULT 0x00
164 #define SEMPERFLASH2_CFG_4_DEFAULT 0x00
166 #define SEMPERFLASH2_MANUFACTURER_DEVICE_ID_VALUE 0x34
167 #define SEMPERFLASH2_MEMORY_BUF_MAX_SIZE 512
408 #endif // _SEMPERFLASH2_H_
Click configuration structure definition.
Definition: semperflash2.h:200
uint8_t spi_mode
Definition: semperflash2.h:217
uint8_t semperflash2_get_device_id(semperflash2_t *ctx, uint8_t *id_buf)
Get device ID function.
uint8_t semperflash2_check_status_reg_1(semperflash2_t *ctx)
Check status register function.
void semperflash2_send_cmd(semperflash2_t *ctx, uint8_t cmd)
Send command function.
pin_name_t miso
Definition: semperflash2.h:203
pin_name_t rst
Definition: semperflash2.h:210
#define SEMPERFLASH2_RETVAL
Definition: semperflash2.h:81
uint8_t semperflash2_read_memory(semperflash2_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Read memory function.
uint8_t cfg1
Definition: semperflash2.h:228
digital_out_t cs
Definition: semperflash2.h:187
void semperflash2_write_config(semperflash2_t *ctx, semperflash2_config_t *cfg_data)
Write configuration function.
Click ctx object definition.
Definition: semperflash2.h:181
spi_master_chip_select_polarity_t cs_polarity
Definition: semperflash2.h:218
pin_name_t io2
Definition: semperflash2.h:211
void semperflash2_generic_write(semperflash2_t *ctx, uint8_t *write_buf, uint16_t buf_size)
Writing data function.
digital_out_t io2
Definition: semperflash2.h:185
pin_name_t chip_select
Definition: semperflash2.h:192
uint8_t semperflash2_check_manufacturer_id(semperflash2_t *ctx)
Check manufacturer ID function.
void semperflash2_transfer_data(semperflash2_t *ctx, uint8_t *write_buf, uint16_t wbuf_size, uint8_t *read_buf, uint16_t rbuf_size)
Transfer data function.
void semperflash2_default_cfg(semperflash2_t *ctx)
Click Default Configuration function.
pin_name_t io3
Definition: semperflash2.h:212
digital_out_t rst
Definition: semperflash2.h:184
Flash configuration structure.
Definition: semperflash2.h:226
pin_name_t cs
Definition: semperflash2.h:206
spi_master_t spi
Definition: semperflash2.h:191
uint8_t cfg3
Definition: semperflash2.h:230
uint32_t spi_speed
Definition: semperflash2.h:216
pin_name_t sck
Definition: semperflash2.h:205
uint8_t semperflash2_write_memory(semperflash2_t *ctx, uint32_t addr, uint8_t *data_buf, uint16_t buf_size)
Write memory function.
SEMPERFLASH2_RETVAL semperflash2_init(semperflash2_t *ctx, semperflash2_cfg_t *cfg)
Initialization function.
void semperflash2_erase_memory(semperflash2_t *ctx, uint32_t addr)
Erase memory function.
pin_name_t mosi
Definition: semperflash2.h:204
uint8_t cfg4
Definition: semperflash2.h:231
uint8_t status_reg1
Definition: semperflash2.h:227
void semperflash2_cfg_setup(semperflash2_cfg_t *cfg)
Config Object Initialization function.
uint8_t cfg2
Definition: semperflash2.h:229
digital_out_t io3
Definition: semperflash2.h:186