forked from sparkfun/AmbiqSuiteSDK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patham_devices_fireball.h
242 lines (217 loc) · 8.84 KB
/
am_devices_fireball.h
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
//*****************************************************************************
//
//! @file am_devices_fireball.h
//!
//! @brief Fireball board control.
//
//*****************************************************************************
//*****************************************************************************
//
// Copyright (c) 2020, Ambiq Micro
// All rights reserved.
//
// 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 of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// Third party software included in this distribution is subject to the
// additional license terms as defined in the /docs/licenses directory.
//
// 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 HOLDER 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.
//
// This is part of revision 2.4.2 of the AmbiqSuite Development Package.
//
//*****************************************************************************
#ifndef AM_DEVICES_FIREBALL_H
#define AM_DEVICES_FIREBALL_H
#include <stdint.h>
#ifdef __cplusplus
extern "C"
{
#endif
//
// Fireball driver is included.
//
//#define AM_DEVICES_FIREBALL 1
//
// Fireball version info.
// These 16-bit values are returned by a call to:
// am_devices_fireball_control(AM_DEVICES_FIREBALL_STATE_ID_GET, &x);
//
#define FIREBALL_ID 0x7710
#define FIREBALL2_ID 0x7712
#define FIREBALL3_ID 0x7713
//*****************************************************************************
//
//! Enums for am_devices_fireball_control()
//
//*****************************************************************************
typedef enum
{
//
// General
//
AM_DEVICES_FIREBALL_STATE_FBGEN_GET = 1, // 1=Orig Fireball, 2=Fireball2
AM_DEVICES_FIREBALL_STATE_ID_GET, // Get actual ID from Fireball
AM_DEVICES_FIREBALL_STATE_VER_GET, // Get Fireball firmware version
AM_DEVICES_FIREBALL_STATE_LED_BLINK, // Blink LED n times (n is the call parameter)
//
// Fireball device resets
//
AM_DEVICES_FIREBALL_STATE_ALL_RESET,
AM_DEVICES_FIREBALL_STATE_SX9300_RESET,
AM_DEVICES_FIREBALL_STATE_BNO055_RESET,
AM_DEVICES_FIREBALL_STATE_MSPI_RESET,
AM_DEVICES_FIREBALL_STATE_MKB1_RESET,
AM_DEVICES_FIREBALL_STATE_MKB2_RESET,
//
// States for Fireball
//
AM_DEVICES_FIREBALL_STATE_SPI_FLASH,
AM_DEVICES_FIREBALL_STATE_SPI_FRAM,
AM_DEVICES_FIREBALL_STATE_I2C_IOM0,
AM_DEVICES_FIREBALL_STATE_I2C_IOM1,
AM_DEVICES_FIREBALL_STATE_I2C_IOM2,
AM_DEVICES_FIREBALL_STATE_I2C_IOM3,
AM_DEVICES_FIREBALL_STATE_I2C_IOM4,
AM_DEVICES_FIREBALL_STATE_I2C_IOM5,
AM_DEVICES_FIREBALL_STATE_OCTAL_FLASH_CE0,
AM_DEVICES_FIREBALL_STATE_OCTAL_FLASH_CE1,
AM_DEVICES_FIREBALL_STATE_TWIN_QUAD_CE0_CE1,
//
// Fireball2 device resets
//
AM_DEVICES_FIREBALL2_STATE_GLOBAL_RESET, // New for Fireball2 global reset
AM_DEVICES_FIREBALL2_STATE_SX9300_RESET,
AM_DEVICES_FIREBALL2_STATE_BNO055_RESET,
AM_DEVICES_FIREBALL2_STATE_MSPI_RESET,
AM_DEVICES_FIREBALL2_STATE_MKB1_RESET,
AM_DEVICES_FIREBALL2_STATE_MKB2_RESET,
AM_DEVICES_FIREBALL2_STATE_GP30_RESET,
AM_DEVICES_FIREBALL2_STATE_ALL_RESET, // Reset all devices individually
//
// States for Fireball2
//
AM_DEVICES_FIREBALL2_STATE_SPI_FRAM_PSRAM_1P8,
AM_DEVICES_FIREBALL2_STATE_SPI_PSRAM_FLASH_3P3,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM0,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM1,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM2,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM3,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM4,
AM_DEVICES_FIREBALL2_STATE_I2C_IOM5,
AM_DEVICES_FIREBALL2_STATE_MSPI_FRAM_PSRAM_FLASH_1P8,
AM_DEVICES_FIREBALL2_STATE_MSPI_PSRAM_FLASH_3P3,
AM_DEVICES_FIREBALL2_STATE_SC_8_9_16,
AM_DEVICES_FIREBALL2_STATE_SC_17_32_26,
AM_DEVICES_FIREBALL2_STATE_SC_19_18_46,
AM_DEVICES_FIREBALL2_STATE_SC_31_37_21,
AM_DEVICES_FIREBALL2_STATE_PDM_10_29,
AM_DEVICES_FIREBALL2_STATE_PDM_12_15,
AM_DEVICES_FIREBALL2_STATE_PDM_14_11,
AM_DEVICES_FIREBALL2_STATE_PDM_22_34,
AM_DEVICES_FIREBALL2_STATE_PDM_37_36,
AM_DEVICES_FIREBALL2_STATE_PDM_46_45,
AM_DEVICES_FIREBALL2_STATE_PDM_AMP_IN,
AM_DEVICES_FIREBALL2_STATE_I2S_DAC,
AM_DEVICES_FIREBALL2_STATE_STEPPER,
//
// States for Fireball3.
// Most are the same as for FB2 except for a few new ones.
// However, the ordering is important such that FB2 states should
// map to similar FB3 states by simply adding an offset.
//
// FB3 device reset states
AM_DEVICES_FIREBALL3_STATE_GLOBAL_RESET,
AM_DEVICES_FIREBALL3_STATE_SX9300_RESET,
AM_DEVICES_FIREBALL3_STATE_BNO055_RESET,
AM_DEVICES_FIREBALL3_STATE_MSPI_RESET,
AM_DEVICES_FIREBALL3_STATE_MKB1_RESET,
AM_DEVICES_FIREBALL3_STATE_MKB2_RESET,
AM_DEVICES_FIREBALL3_STATE_GP30_RESET,
AM_DEVICES_FIREBALL3_STATE_ALL_RESET, // Reset all devices individually
AM_DEVICES_FIREBALL3_STATE_SPI_FRAM_PSRAM_1P8,
AM_DEVICES_FIREBALL3_STATE_SPI_PSRAM_FLASH_3P3,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM0,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM1,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM2,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM3,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM4,
AM_DEVICES_FIREBALL3_STATE_I2C_IOM5,
AM_DEVICES_FIREBALL3_STATE_MSPI0_PSRAM_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI0_PSRAM_3P3,
AM_DEVICES_FIREBALL3_STATE_SC_8_9_16,
AM_DEVICES_FIREBALL3_STATE_SC_17_32_26,
AM_DEVICES_FIREBALL3_STATE_SC_19_18_46,
AM_DEVICES_FIREBALL3_STATE_SC_31_37_21,
AM_DEVICES_FIREBALL3_STATE_PDM_10_29,
AM_DEVICES_FIREBALL3_STATE_PDM_12_15,
AM_DEVICES_FIREBALL3_STATE_PDM_14_11,
AM_DEVICES_FIREBALL3_STATE_PDM_22_34,
AM_DEVICES_FIREBALL3_STATE_PDM_37_36,
AM_DEVICES_FIREBALL3_STATE_PDM_46_45,
AM_DEVICES_FIREBALL3_STATE_PDM_AMP_IN,
AM_DEVICES_FIREBALL3_STATE_I2S_DAC,
AM_DEVICES_FIREBALL3_STATE_STEPPER,
// New states for FB3
AM_DEVICES_FIREBALL3_STATE_MSPI0_FLASH_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI0_FT812,
AM_DEVICES_FIREBALL3_STATE_MSPI0_DISPLAY,
AM_DEVICES_FIREBALL3_STATE_MSPI1_PSRAM_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI1_FLASH_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI1_PSRAM_3P3,
AM_DEVICES_FIREBALL3_STATE_MSPI1_FT812,
AM_DEVICES_FIREBALL3_STATE_MSPI1_DISPLAY,
AM_DEVICES_FIREBALL3_STATE_MSPI2_PSRAM_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI2_FLASH_1P8,
AM_DEVICES_FIREBALL3_STATE_MSPI2_PSRAM_3P3,
AM_DEVICES_FIREBALL3_STATE_MSPI2_FT812,
AM_DEVICES_FIREBALL3_STATE_MSPI2_DISPLAY,
//
// End of valid states
//
AM_DEVICES_FIREBALL_STATE_INVALID
} am_devices_fireball_control_e;
//
// Define valid first/last states for each board.
//
#define AM_DEVICES_FIREBALL_STATE_FIRST AM_DEVICES_FIREBALL_STATE_ALL_RESET
#define AM_DEVICES_FIREBALL_STATE_LAST AM_DEVICES_FIREBALL_STATE_TWIN_QUAD_CE0_CE1
#define AM_DEVICES_FIREBALL2_STATE_FIRST AM_DEVICES_FIREBALL2_STATE_GLOBAL_RESET
#define AM_DEVICES_FIREBALL2_STATE_LAST AM_DEVICES_FIREBALL2_STATE_STEPPER
#define AM_DEVICES_FIREBALL3_STATE_FIRST AM_DEVICES_FIREBALL3_STATE_GLOBAL_RESET
#define AM_DEVICES_FIREBALL3_STATE_LAST AM_DEVICES_FIREBALL3_STATE_STEPPER
//*****************************************************************************
//
//! @brief Set FIREBALL state.
//!
//! @param eState - Designate which state to put the FIREBALL. The state
//! number indicates which peripherals are muxed in.
//
//*****************************************************************************
extern uint32_t am_devices_fireball_control(am_devices_fireball_control_e eState,
void *pArgs);
#ifdef __cplusplus
}
#endif
#endif // AM_DEVICES_FIREBALL_H