WXK
2024-04-18 4b421322afff4020c6b2c1bece996a7f9cd67337
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*******************************************************************************
 * File Name         : SPIFlash.h
 * Description       :
 * Created on        : 2019Äê3ÔÂ11ÈÕ
 * Author            : www.hido-studio.com
 *******************************************************************************/
 
#ifndef FML_SPIFLASH_H_
#define FML_SPIFLASH_H_
/*******************************************************************************
 *                              Include Files                                  *
 *******************************************************************************/
#include "HIDO_TypeDef.h"
#include "SPI_hal.h"
 
/*******************************************************************************
 *                                  Macro                                      *
 *******************************************************************************/
 
/*******************************************************************************
 *                             Type Definition                                 *
 *******************************************************************************/
typedef enum
{
    SPI_FLASH_ID_0 = 0,
 
    SPI_FLASH_ID_LAST,
}E_SPIFlashID;
 
typedef enum
{
    SPI_FLASH_PIN_CS,
    SPI_FLASH_PIN_MISO,
    SPI_FLASH_PIN_MOSI,
    SPI_FLASH_PIN_SCK,
 
    SPI_FLASH_PIN_LAST,
}E_SPIFlashPin;
 
typedef enum
{
    SPI_FLASH_SECTOR_ERASE_MODE_4K,
    SPI_FLASH_SECTOR_ERASE_MODE_32K,
    SPI_FLASH_SECTOR_ERASE_MODE_64K,
 
    SPI_FLASH_SECTOR_ERASE_MODE_LAST,
}E_SPIFlashSectorEraseMode;
/*******************************************************************************
 *                             Global Function                                 *
 *******************************************************************************/
 
/*******************************************************************************
 * Function Name     : SPIFlash_BulkErase
 * Description       : SPIFlashÕûƬ²Á³ý
 * Input             : _eID SPIFlash ID
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_BulkErase(E_SPIFlashID _eID);
 
/*******************************************************************************
 * Function Name     : SPIFlash_Read
 * Description       : SPIFlash¶ÁÈ¡Êý¾Ý
 * Input             : _eID SPIFlash ID
 *                   : _u32SrcAddr Ô´µØÖ·
 *                   : _u32SrcLen Ô´³¤¶È
 * Output            : _pu8DstBuf Ä¿µÄµØÖ·
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_Read(E_SPIFlashID _eID, HIDO_UINT8 *_pu8DstBuf, HIDO_UINT32 _u32SrcAddr, HIDO_UINT32 _u32SrcLen);
 
/*******************************************************************************
 * Function Name     : SPIFlash_Write
 * Description       : SPIFlashдÊý¾Ý
 * Input             : _eID SPIFlash ID
 *                   : _u32DstAddr Ä¿µÄµØÖ·
 *                   : _pu8SrcBuf Ô´µØÖ·
 *                   : _u32SrcLen Ô´Êý¾Ý³¤¶È
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_Write(E_SPIFlashID _eID, HIDO_UINT32 _u32DstAddr, HIDO_UINT8 *_pu8SrcBuf, HIDO_UINT32 _u32SrcLen);
 
/*******************************************************************************
 * Function Name     : SPIFlash_Erase
 * Description       : SPIFlash ²Á³ý
 * Input             : _eID SPIFlash ID
 *                   : _u32EraseAddr ²Á³ýµØÖ·
 *                   : _u32EraseLen ²Á³ý³¤¶È
 *                   : _eEraseMode ²Á³ýģʽ
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_Erase(E_SPIFlashID _eID, HIDO_UINT32 _u32EraseAddr, HIDO_UINT32 _u32EraseLen, E_SPIFlashSectorEraseMode _eEraseMode);
 
/*******************************************************************************
 * Function Name     : SPIFlash_ReadJedecID
 * Description       : SPIFlash¶ÁȡоƬID
 * Input             :  _eID Flash ID
 *                   : _u32IDBufSize ID»º´æ´óС
 * Output            : _pu8IDBuf ID»º´æ
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_ReadJedecID(E_SPIFlashID _eID, HIDO_UINT8 *_pu8IDBuf, HIDO_UINT32 _u32IDBufSize);
 
/*******************************************************************************
 * Function Name     : SPIFlash_PowerDown
 * Description       : SPIFlash Ö´ÐÐPOWER_DOWN
 * Input             : _eID Flash ID
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_PowerDown(E_SPIFlashID _eID);
 
/*******************************************************************************
 * Function Name     : SPIFlash_ReleasePowerDown
 * Description       : SPIFlash Ö´ÐÐRELEASE_POWER_DOWN
 * Input             : _eID Flash ID
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_ReleasePowerDown(E_SPIFlashID _eID);
 
/*******************************************************************************
 * Function Name     : SPIFlash_SPIRegister
 * Description       : SPIFlash¹Ü½Å×¢²á
 * Input             : _eID Flash ID
 *                   : _eSPI_ID SPI ID
 * Output            : None
 * Return            : None
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_VOID SPIFlash_SPIRegister(E_SPIFlashID _eID, E_SPI_ID _eSPI_ID);
 
/*******************************************************************************
 * Function Name     : SPIFlash_PinRegister
 * Description       : SPIFlash¹Ü½Å×¢²á
 * Input             : _eID Flash ID
 *                   : _ePin ¹Ü½ÅÃû³Æ
 *                   : _pGPIO GPIOx
 *                   : _u16Pin GPIO_PIN_x
 * Output            : None
 * Return            : None
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_VOID SPIFlash_PinRegister(E_SPIFlashID _eID, E_SPIFlashPin _ePin, HIDO_VOID *_pGPIO, HIDO_UINT16 _u16Pin);
 
/*******************************************************************************
 * Function Name     : SPIFlash_UnInit
 * Description       : SPIFlash·´³õʼ»¯
 * Input             : _eID Flash ID
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_UnInit(E_SPIFlashID _eID);
 
/*******************************************************************************
 * Function Name     : SPIFlash_Init
 * Description       : SPIFlash³õʼ»¯
 * Input             : None
 * Output            : None
 * Return            : HIDO_OK ³É¹¦, HIDO_ERR Ê§°Ü
 * Author            : www.hido-studio.com
 * Modified Date:    : 2021Äê5ÔÂ07ÈÕ
 *******************************************************************************/
HIDO_INT32 SPIFlash_Init(E_SPIFlashID _eID);
 
#endif /* FML_SPIFLASH_H_ */