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
|
/****************************************************************************
* arch/arm/src/lpc43/chip/lpc43_spifi.h
*
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* 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. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS 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.
*
****************************************************************************
*
* NOTE: The SPIFI ROM interface is not defined in the LPC43xx user manual.
* Some information in this file drivers from the NXP header file
* spifi_rom_api.h. I do not believe that any copyright restrictions apply.
* But just to be certain:
*
* Copyright(C) 2011, NXP Semiconductor
* All rights reserved.
*
* Software that is described herein is for illustrative purposes only which
* provides customers with programming information regarding the products.
* This software is supplied "AS IS" without any warranties. NXP
* Semiconductors assumes no responsibility or liability for the use of the
* software, conveys no license or title under any patent, copyright, or
* mask work right to the product. NXP Semiconductors reserves the right to
* make changes in the software without notification. NXP Semiconductors
* also make no representation or warranty that such application will be
* suitable for the specified use without further testing or modification.
* Permission to use, copy, modify, and distribute this software and its
* documentation is hereby granted, under NXP Semiconductors' relevant
* copyright in the software, without fee, provided that it is used in
* conjunction with NXP Semiconductors microcontrollers. This copyright,
* permission, and disclaimer notice must appear in all copies of this code.
*
****************************************************************************/
#ifndef __ARCH_ARM_SRC_LPC43XX_CHIP_LPC43_SPIFI_H
#define __ARCH_ARM_SRC_LPC43XX_CHIP_LPC43_SPIFI_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* The largest protection block of any serial flash that the ROM driver
* can handle
*/
#define SPIFI_LONGEST_PROTBLOCK 68
/* Protection flag bit definitions */
#define SPIFI_RWPROT (1 << 0)
/* Instruction classes for wait_busy */
#define SPIFI_STAT_INST 0
#define SPIFI_BLOCK_ERASE 1
#define SPIFI_PROG_INST 2
#define SPIFI_CHIP_ERASE 3
/* Bit definitions in options operands (MODE3, RCVCLK, and FULLCLK
* have the same relationship as in the Control register)
*/
#define S_MODE3 (1 << 0)
#define S_MODE0 (0)
#define S_MINIMAL (1 << 1)
#define S_MAXIMAL (0)
#define S_FORCE_ERASE (1 << 2)
#define S_ERASE_NOT_REQD (1 << 3)
#define S_CALLER_ERASE (1 << 3)
#define S_ERASE_AS_REQD (0)
#define S_VERIFY_PROG (1 << 4)
#define S_VERIFY_ERASE (1 << 5)
#define S_NO_VERIFY (0)
#define S_FULLCLK (1 << 6)
#define S_HALFCLK (0)
#define S_RCVCLK (1 << 7)
#define S_INTCLK (0)
#define S_DUAL (1 << 8)
#define S_CALLER_PROT (1 << 9)
#define S_DRIVER_PROT (0)
/* The length of a standard program command is 256 on all devices */
#define PROG_SIZE 256
/* SPI ROM driver table pointer */
#define SPIFI_ROM_PTR LPC43_ROM_DRIVER_TABLE6
#define pSPIFI *((struct spifi_driver_s **)SPIFI_ROM_PTR)
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Public Types
****************************************************************************/
#ifndef __ASSEMBLY__
/* Protection/sector descriptors */
struct spfi_desc_s
{
uint32_t base;
uint8_t flags;
int8_t log2;
uint16_t rept;
};
/* The SPFI device state structure, passed to all ROM driver methods. */
struct spifi_dev_s
{
uint32_t base;
uint32_t regbase;
uint32_t devsize;
uint32_t memsize;
uint8_t mfger;
uint8_t devtype;
uint8_t devid;
uint8_t busy;
union
{
uint16_t h;
uint8_t b[2];
} stat;
uint16_t reserved;
uint16_t setprot;
uint16_t writeprot;
uint32_t memcmd;
uint32_t progcmd;
uint16_t sectors;
uint16_t protbytes;
uint32_t opts;
uint32_t errcheck;
uint8_t eraseshifts[4];
uint8_t eraseops[4];
struct spfi_desc_s *protents;
char prot[SPIFI_LONGEST_PROTBLOCK];
};
/* Operands of program and erase ROM driver methods */
struct spifi_operands_s
{
uint8_t *dest;
uint32_t length;
uint8_t *scratch;
int32_t protect;
uint32_t options;
};
/* Interface to SPIFI ROM driver */
#ifndef CONFIG_SPIFI_LIBRARY
struct spifi_driver_s
{
int32_t (*spifi_init)(struct spifi_dev_s *dev, uint32_t cshigh,
uint32_t options, uint32_t mhz);
int32_t (*spifi_program)(struct spifi_dev_s *dev, const uint8_t *source,
struct spifi_operands_s *opers);
int32_t (*spifi_erase)(struct spifi_dev_s *dev,
struct spifi_operands_s *opers);
/* Mode switching */
void (*cancel_mem_mode)(struct spifi_dev_s *dev);
void (*set_mem_mode)(struct spifi_dev_s *dev);
/* Mid level functions */
int32_t (*checkAd)(struct spifi_dev_s *dev,
struct spifi_operands_s *opers);
int32_t (*setProt)(struct spifi_dev_s *dev,
struct spifi_operands_s *opers, uint8_t *change, uint8_t *saveprot);
int32_t (*check_block) (struct spifi_dev_s *dev, uint8_t *source,
struct spifi_operands_s *opers, uint32_t check_program);
int32_t (*send_erase_cmd)(struct spifi_dev_s *dev, uint8_t op,
uint32_t addr);
uint32_t (*ck_erase) (struct spifi_dev_s *dev, uint32_t *addr,
uint32_t length);
int32_t (*prog_block)(struct spifi_dev_s *dev, uint8_t *source,
struct spifi_operands_s *opers, uint32_t *left_in_page);
uint32_t (*ck_prog)(struct spifi_dev_s *dev, uint8_t *source, uint8_t *dest,
uint32_t length);
/* Low level functions */
void (*setsize) (struct spifi_dev_s *dev, int32_t value);
int32_t (*setdev)(struct spifi_dev_s *dev, uint32_t opts,
uint32_t mem_cmd, uint32_t prog_cmd);
uint32_t (*cmd)(uint8_t op, uint8_t addrlen, uint8_t intLen, uint16_t len);
uint32_t (*readad)(struct spifi_dev_s *dev, uint32_t cmd, uint32_t addr);
void (*send04)(struct spifi_dev_s *dev, uint8_t op, uint8_t len,
uint32_t value);
void (*wren_sendad)(struct spifi_dev_s *dev, uint32_t cmd,
uint32_t addr, uint32_t value);
int32_t (*write_stat)(struct spifi_dev_s *dev, uint8_t len,
uint16_t value);
int32_t (*wait_busy)(struct spifi_dev_s *dev, uint8_t prog_or_erase);
};
#endif
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
EXTERN int32_t spifi_init(struct spifi_dev_s *dev, uint32_t cshigh,
uint32_t options, uint32_t mhz);
EXTERN int32_t spifi_program(struct spifi_dev_s *dev, const uint8_t *source,
struct spifi_operands_s *opers);
EXTERN int32_t spifi_erase(struct spifi_dev_s *dev,
struct spifi_operands_s *opers);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __ARCH_ARM_SRC_LPC43XX_CHIP_LPC43_SPIFI_H */
|
