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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
/**
* \file
*
* \brief SAM SPI Flash Driver for SAMB11
*
* Copyright (C) 2015-2016 Atmel Corporation. All rights reserved.
*
* \asf_license_start
*
* \page License
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The name of Atmel may not be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 4. This software may only be redistributed and used in connection with an
* Atmel microcontroller product.
*
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* \asf_license_stop
*
*/
/*
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
*/
#ifndef SPI_FLASH_H_INCLUDED
#define SPI_FLASH_H_INCLUDED
/**
* \defgroup asfdoc_samb_spi_flash_group SAM SPI Flash Driver (SPI Flash)
*
* This driver for Atmel® | SMART SAM devices provides an interface for the
* configuration and management of the device's SPI Flash functionality. The
* following driver API modes are covered by this manual:
*
* The following peripherals are used by this module:
* - SPI Flash (SPI Flash Management)
*
* The following devices can use this module:
* - Atmel | SMART SAM B11
*
* The outline of this documentation is as follows:
* - \ref asfdoc_samb_spi_flash_prerequisites
* - \ref asfdoc_samb_spi_flash_module_overview
* - \ref asfdoc_samb_spi_flash_special_considerations
* - \ref asfdoc_samb_spi_flash_extra_info
* - \ref asfdoc_samb_spi_flash_examples
* - \ref asfdoc_samb_spi_flash_api_overview
*
*
* \section asfdoc_samb_spi_flash_prerequisites Prerequisites
*
* There are no prerequisites for this module.
*
*
* \section asfdoc_samb_spi_flash_module_overview Module Overview
* The AHB SPI-Flash Controller is used to access the internal stacked FLASH
* memory to access various instruction/data code needed for storing
* application code, code patches, and OTA images.
*
* The table above describes the stacked SPI Flash memory organization and layout.
* Boot up, the ROM boot loader starts loading different sections of from the
* flash by first reading the flash header to figure out the locations and sizes
* for different sections, then copying the sections one by one into their
* respective memory regions. The header and all sections have CRC calculated
* for integrity check. If CRC fails, section will not be loaded into RAM.
*
* <table>
* <tr>
* <th>SPI flash memory address</th>
* <th>Function description</th>
* </tr>
* <tr>
* <td>0x0000 ~ 0x0FFF</td>
* <td>Flash Header</td>
* </tr>
* <tr>
* <td>0x1000 ~ End of patch section (according to patch size)</td>
* <td>Patch image section</td>
* </tr>
* <tr>
* <td>User App Start Section ~ User App End Section <=254KB</td>
* <td>USER APP</td>
* </tr>
* <tr>
* <td>NVDS 4KB</td>
* <td>NVDS</td>
* </tr>
* </table>
*
* \section asfdoc_samb_spi_flash_special_considerations Special Considerations
* There are no special considerations for this module.
*
* \section asfdoc_samb_spi_flash_extra_info Extra Information
*
* For extra information, see \ref asfdoc_samb_spi_flash_extra. This includes:
* - \ref asfdoc_samb_spi_flash_extra_acronyms
* - \ref asfdoc_samb_spi_flash_extra_dependencies
* - \ref asfdoc_samb_spi_flash_extra_errata
* - \ref asfdoc_samb_spi_flash_extra_history
*
*
* \section asfdoc_samb_spi_flash_examples Examples
*
* For a list of examples related to this driver, see
* \ref asfdoc_samb_spi_flash_exqsg.
*
*
* \section asfdoc_samb_spi_flash_api_overview API Overview
* @{
*/
#include <stdint.h>
#include <string.h>
#include <compiler.h>
#include <gpio.h>
#ifdef __cplusplus
extern "C" {
#endif
/** Flash memory size: 256 KBytes */
#define FLASH_MEMORY_SIZE 0x40000
/** Accessible NVDS area start spi flash address */
#define FLASH_NVDS_START_ADDRESS 0x3F000
/** Accessible NVDS area spi flash size */
#define FLASH_NVDS_SIZE 0x1000
/** Flash memory sector size 4 KBytes */
#define FLASH_SECTOR_SIZE 0x1000
/** Flash memory page size: 256 Bytes */
#define FLASH_PAGE_SIZE 0x100
/** Flash sector Mask */
#define FLASH_SECT_MASK 0xFFF000
/** Flash page mask */
#define FLASH_PAGE_MASK 0xFFFF00
/** SPI flash write enable */
#define SPI_FLASH_CMD_WRITE_ENABLE 0x06
/** SPI flash write disable */
#define SPI_FLASH_CMD_WRITE_DISABLE 0x04
/** SPI flash read identification */
#define SPI_FLASH_CMD_READ_ID 0x9F
/** SPI flash read status register */
#define SPI_FLASH_CMD_READ_STATUS 0x05
/** SPI flash write status register */
#define SPI_FLASH_CMD_WRITE_STATUS 0x01
/** SPI flash read data bytes */
#define SPI_FLASH_CMD_READ_DATA 0x03
/** SPI flash read data bytes at higher speed */
#define SPI_FLASH_CMD_READ_HIGH_SPEED 0x0B
/** SPI flash page program */
#define SPI_FLASH_CMD_PAGE_PROGRAM 0x02
/** SPI flash sector erase */
#define SPI_FLASH_CMD_SECTOR_ERASE 0x20
/** SPI flash bulk erase */
#define SPI_FLASH_CMD_BULK_ERASE 0xC7
/** SPI flash deep power-down */
#define SPI_FLASH_CMD_ENTER_LOW_POWER 0xB9
/** SPI flash release from deep power down */
#define SPI_FLASH_CMD_LEAVE_LOW_POWER 0xAB
/** SPI flash direction: send command */
#define SPI_FLASH_DIRECTION_CMD 0x01
/** SPI flash direction: program or erase */
#define SPI_FLASH_DIRECTION_PRO 0x0F
/** SPI flash direction: read data */
#define SPI_FLASH_DIRECTION_READ 0x1F
/** \name SPI flash callback config
* @{
*/
void spi_flash_init(void) ;
/** @}*/
/** \name SPI flash read/write/erase operation
* @{
*/
uint32_t spi_flash_rdid(void);
void spi_flash_read(uint8_t *read_buf, uint32_t flash_addr, uint32_t size);
int8_t spi_flash_write(void *write_buf, uint32_t flash_addr, uint32_t size);
void spi_flash_sector_erase(uint32_t flash_addr);
uint8_t spi_flash_erase(uint32_t start_offset, uint32_t size);
void spi_flash_enter_low_power_mode(void);
void spi_flash_leave_low_power_mode(void);
void spi_flash_clock_init(void);
void spi_flash_turn_off(void);
void spi_flash_turn_on(void);
/** @}*/
/** @}*/
#ifdef __cplusplus
}
#endif
/**
* \page asfdoc_samb_spi_flash_extra Extra Information for SPI Flash Driver
*
* \section asfdoc_samb_spi_flash_extra_acronyms Acronyms
* Below is a table listing the acronyms used in this module, along with their
* intended meanings.
*
* <table>
* <tr>
* <th>Acronym</th>
* <th>Description</th>
* </tr>
* <tr>
* <td>SPI Flash</td>
* <td>Serial Peripheral Interface Flash</td>
* </tr>
* </table>
*
*
* \section asfdoc_samb_spi_flash_extra_dependencies Dependencies
* There are no dependencies related to this driver.
*
*
* \section asfdoc_samb_spi_flash_extra_errata Errata
* There are no errata related to this driver.
*
*
* \section asfdoc_samb_spi_flash_extra_history Module History
* An overview of the module history is presented in the table below, with
* details on the enhancements and fixes made to the module since its first
* release. The current version of this corresponds to the newest version in
* the table.
*
* <table>
* <tr>
* <th>Changelog</th>
* </tr>
* <tr>
* <td>Initial Release</td>
* </tr>
* </table>
*/
/**
* \page asfdoc_samb_spi_flash_exqsg Examples for SPI Flash Driver
*
* This is a list of the available Quick Start guides (QSGs) and example
* applications for \ref asfdoc_samb_spi_flash_group. QSGs are simple examples with
* step-by-step instructions to configure and use this driver in a selection of
* use cases. Note that QSGs can be compiled as a standalone application or be
* added to the user application.
*
* - \subpage asfdoc_samb_spi_flash_basic_use_case
*
* \page asfdoc_samb_spi_flash_document_revision_history Document Revision History
*
* <table>
* <tr>
* <th>Doc. Rev.</td>
* <th>Date</td>
* <th>Comments</td>
* </tr>
* <tr>
* <td>A</td>
* <td>09/2015</td>
* <td>Initial release</td>
* </tr>
* </table>
*/
#endif
|
