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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Copyright 2018-2020 NXP
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*
*/
#include "fsl_iap.h"
/* Component ID definition, used by tools. */
#ifndef FSL_COMPONENT_ID
#define FSL_COMPONENT_ID "platform.drivers.iap"
#endif
/*!
* @addtogroup rom_api
* @{
*/
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @brief FLEXSPI Flash driver API Interface */
typedef struct
{
uint32_t version;
status_t (*init)(uint32_t instance, flexspi_nor_config_t *config);
status_t (*page_program)(uint32_t instance, flexspi_nor_config_t *config, uint32_t dstAddr, const uint32_t *src);
status_t (*erase_all)(uint32_t instance, flexspi_nor_config_t *config);
status_t (*erase)(uint32_t instance, flexspi_nor_config_t *config, uint32_t start, uint32_t length);
status_t (*erase_sector)(uint32_t instance, flexspi_nor_config_t *config, uint32_t address);
status_t (*erase_block)(uint32_t instance, flexspi_nor_config_t *config, uint32_t address);
status_t (*get_config)(uint32_t instance, flexspi_nor_config_t *config, serial_nor_config_option_t *option);
status_t (*read)(uint32_t instance, flexspi_nor_config_t *config, uint32_t *dst, uint32_t start, uint32_t bytes);
status_t (*xfer)(uint32_t instance, flexspi_xfer_t *xfer);
status_t (*update_lut)(uint32_t instance, uint32_t seqIndex, const uint32_t *lutBase, uint32_t numberOfSeq);
status_t (*set_clock_source)(uint32_t clockSrc);
void (*config_clock)(uint32_t instance, uint32_t freqOption, uint32_t sampleClkMode);
} flexspi_nor_flash_driver_t;
/*! @brief OTP driver API Interface */
typedef struct
{
status_t (*init)(uint32_t src_clk_freq);
status_t (*deinit)(void);
status_t (*fuse_read)(uint32_t addr, uint32_t *data);
status_t (*fuse_program)(uint32_t addr, uint32_t data, bool lock);
status_t (*crc_calc)(uint32_t *src, uint32_t numberOfWords, uint32_t *crcChecksum);
status_t (*reload)(void);
status_t (*crc_check)(uint32_t start_addr, uint32_t end_addr, uint32_t crc_addr);
} ocotp_driver_t;
/*!
* @brief Root of the bootloader API tree.
*
* An instance of this struct resides in read-only memory in the bootloader. It
* provides a user application access to APIs exported by the bootloader.
*
* @note The order of existing fields must not be changed.
*/
typedef struct BootloaderTree
{
void (*runBootloader)(iap_boot_option_t *arg); /*!< Function to start the bootloader executing. */
uint32_t version; /*!< Bootloader version number. */
const char *copyright; /*!< Copyright string. */
const uint32_t reserved0;
const uint32_t reserved1;
const uint32_t reserved2;
const uint32_t reserved3;
const flexspi_nor_flash_driver_t *flexspiNorDriver; /*!< FlexSPI NOR FLASH Driver API. */
const ocotp_driver_t *otpDriver; /*!< OTP driver API. */
const uint32_t reserved4;
} bootloader_tree_t;
/*******************************************************************************
* Definitions
******************************************************************************/
#define ROM_API_TREE ((uint32_t *)FSL_ROM_API_BASE_ADDR)
#define BOOTLOADER_API_TREE_POINTER ((bootloader_tree_t *)ROM_API_TREE)
/*! Get pointer to flexspi/otp driver API table in ROM. */
#define FLEXSPI_API_TREE BOOTLOADER_API_TREE_POINTER->flexspiNorDriver
#define OTP_API_TREE BOOTLOADER_API_TREE_POINTER->otpDriver
/*******************************************************************************
* Variables
******************************************************************************/
/*******************************************************************************
* runBootloader API
******************************************************************************/
void IAP_RunBootLoader(iap_boot_option_t *option)
{
BOOTLOADER_API_TREE_POINTER->runBootloader(option);
}
/*******************************************************************************
* FlexSPI NOR driver
******************************************************************************/
status_t IAP_FlexspiNorInit(uint32_t instance, flexspi_nor_config_t *config)
{
return FLEXSPI_API_TREE->init(instance, config);
}
status_t IAP_FlexspiNorPageProgram(uint32_t instance,
flexspi_nor_config_t *config,
uint32_t dstAddr,
const uint32_t *src)
{
return FLEXSPI_API_TREE->page_program(instance, config, dstAddr, src);
}
status_t IAP_FlexspiNorEraseAll(uint32_t instance, flexspi_nor_config_t *config)
{
return FLEXSPI_API_TREE->erase_all(instance, config);
}
status_t IAP_FlexspiNorErase(uint32_t instance, flexspi_nor_config_t *config, uint32_t start, uint32_t length)
{
return FLEXSPI_API_TREE->erase(instance, config, start, length);
}
status_t IAP_FlexspiNorEraseSector(uint32_t instance, flexspi_nor_config_t *config, uint32_t address)
{
return FLEXSPI_API_TREE->erase_sector(instance, config, address);
}
status_t IAP_FlexspiNorEraseBlock(uint32_t instance, flexspi_nor_config_t *config, uint32_t address)
{
return FLEXSPI_API_TREE->erase_block(instance, config, address);
}
status_t IAP_FlexspiNorGetConfig(uint32_t instance, flexspi_nor_config_t *config, serial_nor_config_option_t *option)
{
return FLEXSPI_API_TREE->get_config(instance, config, option);
}
status_t IAP_FlexspiNorRead(
uint32_t instance, flexspi_nor_config_t *config, uint32_t *dst, uint32_t start, uint32_t bytes)
{
return FLEXSPI_API_TREE->read(instance, config, dst, start, bytes);
}
status_t IAP_FlexspiXfer(uint32_t instance, flexspi_xfer_t *xfer)
{
return FLEXSPI_API_TREE->xfer(instance, xfer);
}
status_t IAP_FlexspiUpdateLut(uint32_t instance, uint32_t seqIndex, const uint32_t *lutBase, uint32_t numberOfSeq)
{
return FLEXSPI_API_TREE->update_lut(instance, seqIndex, lutBase, numberOfSeq);
}
status_t IAP_FlexspiSetClockSource(uint32_t clockSrc)
{
return FLEXSPI_API_TREE->set_clock_source(clockSrc);
}
void IAP_FlexspiConfigClock(uint32_t instance, uint32_t freqOption, uint32_t sampleClkMode)
{
FLEXSPI_API_TREE->config_clock(instance, freqOption, sampleClkMode);
}
AT_QUICKACCESS_SECTION_CODE(status_t IAP_FlexspiNorAutoConfig(uint32_t instance,
flexspi_nor_config_t *config,
serial_nor_config_option_t *option))
{
/* Wait until the FLEXSPI is idle */
register uint32_t delaycnt = 10000u;
status_t status;
while ((delaycnt--) != 0U)
{
}
status = FLEXSPI_API_TREE->get_config(instance, config, option);
if (status == kStatus_Success)
{
status = FLEXSPI_API_TREE->init(instance, config);
}
return status;
}
/*******************************************************************************
* OTP driver
******************************************************************************/
status_t IAP_OtpInit(uint32_t src_clk_freq)
{
return OTP_API_TREE->init(src_clk_freq);
}
status_t IAP_OtpDeinit(void)
{
return OTP_API_TREE->deinit();
}
status_t IAP_OtpFuseRead(uint32_t addr, uint32_t *data)
{
return OTP_API_TREE->fuse_read(addr, data);
}
status_t IAP_OtpFuseProgram(uint32_t addr, uint32_t data, bool lock)
{
return OTP_API_TREE->fuse_program(addr, data, lock);
}
status_t IAP_OtpCrcCalc(uint32_t *src, uint32_t numberOfWords, uint32_t *crcChecksum)
{
return OTP_API_TREE->crc_calc(src, numberOfWords, crcChecksum);
}
status_t IAP_OtpShadowRegisterReload(void)
{
return OTP_API_TREE->reload();
}
status_t IAP_OtpCrcCheck(uint32_t start_addr, uint32_t end_addr, uint32_t crc_addr)
{
return OTP_API_TREE->crc_check(start_addr, end_addr, crc_addr);
}
|
