1 /*
2 * Copyright (c) 2024, chasel
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 *
6 * Change Logs:
7 * Date Author Notes
8 * 2024-6-21 chasel first version
9 */
10
11 #include <board.h>
12 #include <rtconfig.h>
13 #include <rtdef.h>
14
15 #ifdef BSP_USING_ON_CHIP_FLASH
16 #include "drv_config.h"
17 #include "drv_flash.h"
18
19 #if defined(RT_USING_FAL)
20 #include "fal.h"
21 #endif
22
23 #define DRV_DEBUG
24 #define LOG_TAG "drv.flash"
25 #include <drv_log.h>
26
27 /**
28 * Read data from flash.
29 * @note This operation's units is word.
30 *
31 * @param addr flash address
32 * @param buf buffer to store read data
33 * @param size read bytes size
34 *
35 * @return result
36 */
stm32_flash_read(rt_uint32_t addr,rt_uint8_t * buf,size_t size)37 int stm32_flash_read(rt_uint32_t addr, rt_uint8_t *buf, size_t size)
38 {
39 size_t i;
40
41 if ((addr + size) > STM32_FLASH_END_ADDRESS)
42 {
43 LOG_E("read outrange flash size! addr is (0x%p)", (void* )(addr + size));
44 return -RT_EINVAL;
45 }
46
47 for (i = 0; i < size; i++, buf++, addr++)
48 {
49 *buf = *(rt_uint8_t *) addr;
50 }
51
52 return size;
53 }
54
55 /**
56 * Write data to flash.
57 * @note This operation's units is word.
58 * @note This operation must after erase. @see flash_erase.
59 *
60 * @param addr flash address
61 * @param buf the write data buffer
62 * @param size write bytes size
63 *
64 * @return result
65 */
66
stm32_flash_write(rt_uint32_t addr,const uint8_t * buf,size_t size)67 int stm32_flash_write(rt_uint32_t addr, const uint8_t *buf, size_t size)
68 {
69 rt_err_t result = RT_EOK;
70 rt_uint32_t end_addr = addr + size;
71
72 if (addr % 4 != 0)
73 {
74 LOG_E("write addr must be 4-byte alignment");
75 return -RT_EINVAL;
76 }
77
78 if ((end_addr) > STM32_FLASH_END_ADDRESS)
79 {
80 LOG_E("write outrange flash size! addr is (0x%p)", (void * )(addr + size));
81 return -RT_EINVAL;
82 }
83
84 HAL_FLASH_Unlock();
85
86 while (addr < end_addr)
87 {
88 if (HAL_FLASH_Program(FLASH_TYPEPROGRAM_WORD, addr, *((rt_uint32_t *) buf)) == HAL_OK)
89 {
90 if (*(rt_uint32_t *) addr != *(rt_uint32_t *) buf)
91 {
92 result = -RT_ERROR;
93 break;
94 }
95 addr += 4;
96 buf += 4;
97 }
98 else
99 {
100 result = -RT_ERROR;
101 break;
102 }
103 }
104
105 HAL_FLASH_Lock();
106
107 if (result != RT_EOK)
108 {
109 return result;
110 }
111
112 return size;
113 }
114
115 /**
116 * Erase data on flash.
117 * @note This operation is irreversible.
118 * @note This operation's units is different which on many chips.
119 *
120 * @param addr flash address
121 * @param size erase bytes size
122 *
123 * @return result
124 */
stm32_flash_erase(rt_uint32_t addr,size_t size)125 int stm32_flash_erase(rt_uint32_t addr, size_t size)
126 {
127 rt_err_t result = RT_EOK;
128 uint32_t PAGEError = 0;
129
130 /*Variable used for Erase procedure*/
131 FLASH_EraseInitTypeDef EraseInitStruct;
132
133 if ((addr + size) > STM32_FLASH_END_ADDRESS)
134 {
135 LOG_E("ERROR: erase outrange flash size! addr is (0x%p)\n", (void * )(addr + size));
136 return -RT_EINVAL;
137 }
138
139 HAL_FLASH_Unlock();
140
141 /* Fill EraseInit structure*/
142 EraseInitStruct.TypeErase = FLASH_TYPEERASE_PAGES;
143 EraseInitStruct.PageAddress = addr;
144 EraseInitStruct.NbPages = (size + FLASH_PAGE_SIZE - 1) / FLASH_PAGE_SIZE;
145
146 if (HAL_FLASHEx_Erase(&EraseInitStruct, &PAGEError) != HAL_OK)
147 {
148 result = -RT_ERROR;
149 goto __exit;
150 }
151
152 __exit: HAL_FLASH_Lock();
153
154 if (result != RT_EOK)
155 {
156 return result;
157 }
158
159 LOG_D("erase done: addr (0x%p), size %d", (void* )addr, size);
160 return size;
161 }
162
163 #if defined(RT_USING_FAL)
164
165 static int fal_flash_read(long offset, rt_uint8_t *buf, size_t size);
166 static int fal_flash_write(long offset, const rt_uint8_t *buf, size_t size);
167 static int fal_flash_erase(long offset, size_t size);
168
169 const struct fal_flash_dev stm32_onchip_flash = { "onchip_flash", STM32_FLASH_START_ADRESS, STM32_FLASH_SIZE,
170 FLASH_PAGE_SIZE, { NULL, fal_flash_read, fal_flash_write, fal_flash_erase } };
171
fal_flash_read(long offset,rt_uint8_t * buf,size_t size)172 static int fal_flash_read(long offset, rt_uint8_t *buf, size_t size)
173 {
174 return stm32_flash_read(stm32_onchip_flash.addr + offset, buf, size);
175 }
176
fal_flash_write(long offset,const rt_uint8_t * buf,size_t size)177 static int fal_flash_write(long offset, const rt_uint8_t *buf, size_t size)
178 {
179 return stm32_flash_write(stm32_onchip_flash.addr + offset, buf, size);
180 }
181
fal_flash_erase(long offset,size_t size)182 static int fal_flash_erase(long offset, size_t size)
183 {
184 return stm32_flash_erase(stm32_onchip_flash.addr + offset, size);
185 }
186
187 #endif
188 #endif /* BSP_USING_ON_CHIP_FLASH */
189