Skip to content

Commit ea9c576

Browse files
antmakantmak
committed
feat(spiflash): add initial structure for SPI Flash support and early stages code
1 parent 82ba404 commit ea9c576

File tree

30 files changed

+15001
-6
lines changed

30 files changed

+15001
-6
lines changed

‎CMakeLists.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,12 @@ target_include_directories(${ESP_STUB_LIB}
3434
INTERFACE include
3535
PRIVATE include/esp-stub-lib
3636
)
37+
# Public within the library
3738
include_directories(include)
39+
include_directories(include/esp-stub-lib)
3840

3941
# STUB_COMPILE_DEFS is optional definitions coming from the parent CMakeLists.txt
40-
target_compile_definitions(${ESP_STUB_LIB} PRIVATE ${STUB_COMPILE_DEFS})
42+
add_compile_definitions(${STUB_COMPILE_DEFS})
4143

4244
add_subdirectory(src/${ESP_TARGET} ${ESP_TARGET_LIB})
4345

‎example/stub_main.c

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ int stub_main(int cmd, ...)
9191

9292
stub_lib_flash_init(&flash_state);
9393

94+
stub_lib_flash_info_t info;
95+
stub_lib_flash_get_info(&info);
96+
stub_lib_flash_info_print(&info);
97+
9498
const struct stub_cmd_handler *handler = cmd_handlers;
9599
while (handler->handler) {
96100
if (handler->cmd == cmd) {

‎include/esp-stub-lib/flash.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ typedef struct stub_flash_info {
1818
uint32_t encrypted;
1919
} stub_lib_flash_info_t;
2020

21+
// TODO: error codes
2122
#ifdef __cplusplus
2223
extern "C" {
2324
#endif // __cplusplus
2425

2526
void stub_lib_flash_init(void **state);
2627
void stub_lib_flash_deinit(const void *state);
2728
void stub_lib_flash_get_info(stub_lib_flash_info_t *info);
29+
void stub_lib_flash_info_print(const stub_lib_flash_info_t *info);
2830
int stub_lib_flash_read_buff(uint32_t addr, void *buffer, uint32_t size);
2931
int stub_lib_flash_write_buff(uint32_t addr, const void *buffer, uint32_t size, int encrypt);
3032
int stub_lib_flash_erase_area(uint32_t addr, uint32_t size);

‎include/private/rom.h

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
3+
*
4+
* SPDX-License-Identifier: Apache-2.0 OR MIT
5+
*/
6+
7+
/*
8+
All common ROM definitions among targets
9+
10+
If specific - move it to <target>/include/target/
11+
*/
12+
13+
#pragma once
14+
15+
#include <stdint.h>
16+
17+
typedef struct esp_rom_spiflash_chip {
18+
uint32_t device_id;
19+
uint32_t chip_size; // chip size in bytes
20+
uint32_t block_size;
21+
uint32_t sector_size;
22+
uint32_t page_size;
23+
uint32_t status_mask;
24+
} esp_rom_spiflash_chip_t;

‎include/private/soc_utils.h

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/*
2+
* SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
3+
*
4+
* SPDX-License-Identifier: Apache-2.0 OR MIT
5+
*/
6+
7+
/*
8+
SOC utils
9+
*/
10+
11+
#pragma once
12+
13+
#define BIT(nr) (1UL << (nr))
14+
#define BIT64(nr) (1ULL << (nr))
15+
16+
#define ETS_UNCACHED_ADDR(addr) (addr)
17+
#define ETS_CACHED_ADDR(addr) (addr)
18+
19+
//write value to register
20+
#define REG_WRITE(_r, _v) do { \
21+
(*(volatile uint32_t *)(_r)) = (_v); \
22+
} while(0)
23+
24+
//read value from register
25+
#define REG_READ(_r) ({ \
26+
(*(volatile uint32_t *)(_r)); \
27+
})
28+
29+
//get bit or get bits from register
30+
#define REG_GET_BIT(_r, _b) ({ \
31+
(*(volatile uint32_t*)(_r) & (_b)); \
32+
})
33+
34+
//set bit or set bits to register
35+
#define REG_SET_BIT(_r, _b) do { \
36+
*(volatile uint32_t*)(_r) = (*(volatile uint32_t*)(_r)) | (_b); \
37+
} while(0)
38+
39+
//clear bit or clear bits of register
40+
#define REG_CLR_BIT(_r, _b) do { \
41+
*(volatile uint32_t*)(_r) = (*(volatile uint32_t*)(_r)) & (~(_b)); \
42+
} while(0)
43+
44+
//set bits of register controlled by mask
45+
#define REG_SET_BITS(_r, _b, _m) do { \
46+
*(volatile uint32_t*)(_r) = (*(volatile uint32_t*)(_r) & ~(_m)) | ((_b) & (_m)); \
47+
} while(0)
48+
49+
//get field from register, uses field _S & _V to determine mask
50+
#define REG_GET_FIELD(_r, _f) ({ \
51+
((REG_READ(_r) >> (_f##_S)) & (_f##_V)); \
52+
})
53+
54+
//set field of a register from variable, uses field _S & _V to determine mask
55+
#define REG_SET_FIELD(_r, _f, _v) do { \
56+
REG_WRITE((_r),((REG_READ(_r) & ~((_f##_V) << (_f##_S)))|(((_v) & (_f##_V))<<(_f##_S)))); \
57+
} while(0)
58+
59+
//get field value from a variable, used when _f is not left shifted by _f##_S
60+
#define VALUE_GET_FIELD(_r, _f) (((_r) >> (_f##_S)) & (_f))
61+
62+
//get field value from a variable, used when _f is left shifted by _f##_S
63+
#define VALUE_GET_FIELD2(_r, _f) (((_r) & (_f))>> (_f##_S))
64+
65+
//set field value to a variable, used when _f is not left shifted by _f##_S
66+
#define VALUE_SET_FIELD(_r, _f, _v) ((_r)=(((_r) & ~((_f) << (_f##_S)))|((_v)<<(_f##_S))))
67+
68+
//set field value to a variable, used when _f is left shifted by _f##_S
69+
#define VALUE_SET_FIELD2(_r, _f, _v) ((_r)=(((_r) & ~(_f))|((_v)<<(_f##_S))))
70+
71+
//generate a value from a field value, used when _f is not left shifted by _f##_S
72+
#define FIELD_TO_VALUE(_f, _v) (((_v)&(_f))<<_f##_S)
73+
74+
//generate a value from a field value, used when _f is left shifted by _f##_S
75+
#define FIELD_TO_VALUE2(_f, _v) (((_v)<<_f##_S) & (_f))
76+
77+
//read value from register
78+
#define READ_PERI_REG(addr) ({ \
79+
(*((volatile uint32_t *)ETS_UNCACHED_ADDR(addr))); \
80+
})
81+
82+
//write value to register
83+
#define WRITE_PERI_REG(addr, val) do { \
84+
(*((volatile uint32_t *)ETS_UNCACHED_ADDR(addr))) = (uint32_t)(val); \
85+
} while(0)
86+
87+
//clear bits of register controlled by mask
88+
#define CLEAR_PERI_REG_MASK(reg, mask) do { \
89+
WRITE_PERI_REG((reg), (READ_PERI_REG(reg)&(~(mask)))); \
90+
} while(0)
91+
92+
//set bits of register controlled by mask
93+
#define SET_PERI_REG_MASK(reg, mask) do { \
94+
WRITE_PERI_REG((reg), (READ_PERI_REG(reg)|(mask))); \
95+
} while(0)
96+
97+
//get bits of register controlled by mask
98+
#define GET_PERI_REG_MASK(reg, mask) ({ \
99+
(READ_PERI_REG(reg) & (mask)); \
100+
})
101+
102+
//get bits of register controlled by highest bit and lowest bit
103+
#define GET_PERI_REG_BITS(reg, hipos,lowpos) ({ \
104+
((READ_PERI_REG(reg)>>(lowpos))&((1<<((hipos)-(lowpos)+1))-1)); \
105+
})
106+
107+
//set bits of register controlled by mask and shift
108+
#define SET_PERI_REG_BITS(reg,bit_map,value,shift) do { \
109+
WRITE_PERI_REG((reg),(READ_PERI_REG(reg)&(~((bit_map)<<(shift))))|(((value) & (bit_map))<<(shift)) ); \
110+
} while(0)
111+
112+
//get field of register
113+
#define GET_PERI_REG_BITS2(reg, mask,shift) ({ \
114+
((READ_PERI_REG(reg)>>(shift))&(mask)); \
115+
})

‎include/target/flash.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,12 @@
66

77
#pragma once
88

9+
#include <stdint.h>
10+
11+
struct esp_rom_spiflash_chip;
12+
913
void stub_target_flash_init(void *state);
1014
void stub_target_flash_deinit(const void *state);
15+
uint32_t stub_target_flash_device_id(void);
16+
void stub_target_flash_unlock(void);
17+
const struct esp_rom_spiflash_chip *stub_target_flash_get_rom_flashchip(void);

‎src/esp32/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ target_include_directories(${ESP_TARGET_LIB}
1111

1212
target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32.rom.ld)
1313
target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32.rom.libc-funcs.ld)
14+
target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32.rom.libgcc.ld)

0 commit comments

Comments
 (0)