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
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file serial_nor.h
* @brief Serial NOR driver header.
*
* @addtogroup SERIAL_NOR
* @{
*/
#ifndef HAL_SERIAL_NOR_H
#define HAL_SERIAL_NOR_H
#include "hal_flash.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @name Bus interface modes.
* @{
*/
#define SNOR_BUS_DRIVER_SPI 0U
#define SNOR_BUS_DRIVER_WSPI 1U
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief Physical transport interface.
*/
#if !defined(SNOR_BUS_DRIVER) || defined(__DOXYGEN__)
#define SNOR_BUS_DRIVER SNOR_BUS_DRIVER_WSPI
#endif
/**
* @brief Shared bus switch.
* @details If set to @p TRUE the device acquires bus ownership
* on each transaction.
* @note Requires @p SPI_USE_MUTUAL_EXCLUSION or
* @p WSPI_USE_MUTUAL_EXCLUSION depending on mode selected
* with @p SNOR_BUS_MODE.
*/
#if !defined(SNOR_SHARED_BUS) || defined(__DOXYGEN__)
#define SNOR_SHARED_BUS TRUE
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if (SNOR_BUS_DRIVER == SNOR_BUS_DRIVER_SPI) || defined(__DOXYGEN__)
#define BUSConfig SPIConfig
#define BUSDriver SPIDriver
#elif SNOR_BUS_DRIVER == SNOR_BUS_DRIVER_WSPI
#define BUSConfig WSPIConfig
#define BUSDriver WSPIDriver
#else
#error "invalid SNOR_BUS_DRIVER setting"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a SNOR configuration structure.
*/
typedef struct {
BUSDriver *busp;
const BUSConfig *buscfg;
} SNORConfig;
/**
* @brief @p SNORDriver specific methods.
*/
#define _snor_flash_methods_alone \
/* Read SFDP.*/ \
flash_error_t (*read_sfdp)(void *instance, \
flash_offset_t offset, \
size_t n, \
uint8_t *rp);
/**
* @brief @p SNORDriver specific methods with inherited ones.
*/
#define _snor_flash_methods \
_base_flash_methods \
_snor_flash_methods_alone
/**
* @extends BaseFlashVMT
*
* @brief @p SNOR virtual methods table.
*/
struct SNORDriverVMT {
_snor_flash_methods
};
/**
* @extends BaseFlash
*
* @brief Type of SNOR flash class.
*/
typedef struct {
/**
* @brief SNORDriver Virtual Methods Table.
*/
const struct SNORDriverVMT *vmt;
_base_flash_data
/**
* @brief Current configuration data.
*/
const SNORConfig *config;
/**
* @brief Device ID and unique ID.
*/
uint8_t device_id[20];
} SNORDriver;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void bus_cmd(BUSDriver *busp, uint32_t cmd);
void bus_cmd_send(BUSDriver *busp, uint32_t cmd, size_t n, const uint8_t *p);
void bus_cmd_receive(BUSDriver *busp,
uint32_t cmd,
size_t n,
uint8_t *p);
void bus_cmd_addr(BUSDriver *busp, uint32_t cmd, flash_offset_t offset);
void bus_cmd_addr_send(BUSDriver *busp,
uint32_t cmd,
flash_offset_t offset,
size_t n,
const uint8_t *p);
void bus_cmd_addr_receive(BUSDriver *busp,
uint32_t cmd,
flash_offset_t offset,
size_t n,
uint8_t *p);
#if (SNOR_BUS_DRIVER == SNOR_BUS_DRIVER_WSPI) || defined(__DOXYGEN__)
void bus_cmd_dummy_receive(BUSDriver *busp,
uint32_t cmd,
uint32_t dummy,
size_t n,
uint8_t *p);
void bus_cmd_addr_dummy_receive(BUSDriver *busp,
uint32_t cmd,
flash_offset_t offset,
uint32_t dummy,
size_t n,
uint8_t *p);
#endif
void snorObjectInit(SNORDriver *devp);
void snorStart(SNORDriver *devp, const SNORConfig *config);
void snorStop(SNORDriver *devp);
#if (SNOR_BUS_DRIVER == SNOR_BUS_DRIVER_WSPI) || defined(__DOXYGEN__)
#if (WSPI_SUPPORTS_MEMMAP == TRUE) || defined(__DOXYGEN__)
void snorMemoryMap(SNORDriver *devp, uint8_t ** addrp);
void snorMemoryUnmap(SNORDriver *devp);
#endif /* QSPI_SUPPORTS_MEMMAP == TRUE */
#endif /* SNOR_BUS_MODE != SNOR_BUS_MODE_SPI */
#ifdef __cplusplus
}
#endif
/* Device-specific implementations.*/
#include "hal_flash_device.h"
#endif /* HAL_SERIAL_NOR_H */
/** @} */
|
