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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
|
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS/RT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file SPC560Pxx/hal_lld.h
* @brief SPC560Pxx HAL subsystem low level driver header.
* @pre This module requires the following macros to be defined in the
* @p board.h file:
* - SPC560P_XOSC_CLK.
* - SPC560P_OSC_BYPASS (optionally).
* .
*
* @addtogroup HAL
* @{
*/
#ifndef _HAL_LLD_H_
#define _HAL_LLD_H_
#include "xpc560p.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @brief Defines the support for realtime counters in the HAL.
*/
#define HAL_IMPLEMENTS_COUNTERS FALSE
/**
* @name Platform identification
* @{
*/
#define PLATFORM_NAME "SPC560Pxx Chassis and Safety"
/** @} */
/**
* @name Absolute Maximum Ratings
* @{
*/
/**
* @brief Maximum XOSC clock frequency.
*/
#define SPC560P_XOSC_CLK_MAX 40000000
/**
* @brief Minimum XOSC clock frequency.
*/
#define SPC560P_XOSC_CLK_MIN 4000000
/**
* @brief Maximum FMPLLs input clock frequency.
*/
#define SPC560P_FMPLLIN_MIN 4000000
/**
* @brief Maximum FMPLLs input clock frequency.
*/
#define SPC560P_FMPLLIN_MAX 16000000
/**
* @brief Maximum FMPLLs VCO clock frequency.
*/
#define SPC560P_FMPLLVCO_MAX 512000000
/**
* @brief Maximum FMPLLs VCO clock frequency.
*/
#define SPC560P_FMPLLVCO_MIN 256000000
/**
* @brief Maximum FMPLL0 output clock frequency.
*/
#define SPC560P_FMPLL0_CLK_MAX 64000000
/**
* @brief Maximum FMPLL1 output clock frequency.
*/
#define SPC560P_FMPLL1_CLK_MAX 120000000
/**
* @brief Maximum FMPLL1 1D1 output clock frequency.
*/
#define SPC560P_FMPLL1_1D1_CLK_MAX 80000000
/** @} */
/**
* @name Internal clock sources
* @{
*/
#define SPC560P_IRC_CLK 16000000 /**< Internal RC oscillator.*/
/** @} */
/**
* @name FMPLL_CR register bits definitions
* @{
*/
#define SPC560P_FMPLL_ODF_DIV2 (0U << 24)
#define SPC560P_FMPLL_ODF_DIV4 (1U << 24)
#define SPC560P_FMPLL_ODF_DIV8 (2U << 24)
#define SPC560P_FMPLL_ODF_DIV16 (3U << 24)
/** @} */
/**
* @name ME_ME register bits definitions
* @{
*/
#define SPC560P_ME_ME_RESET (1U << 0)
#define SPC560P_ME_ME_TEST (2U << 0)
#define SPC560P_ME_ME_SAFE (4U << 0)
#define SPC560P_ME_ME_DRUN (8U << 0)
#define SPC560P_ME_ME_RUN0 (16U << 0)
#define SPC560P_ME_ME_RUN1 (32U << 0)
#define SPC560P_ME_ME_RUN2 (64U << 0)
#define SPC560P_ME_ME_RUN3 (128U << 0)
#define SPC560P_ME_ME_HALT0 (256U << 0)
#define SPC560P_ME_ME_STOP0 (1024U << 0)
/** @} */
/**
* @name ME_xxx_MC registers bits definitions
* @{
*/
#define SPC560P_ME_MC_SYSCLK_MASK (15U << 0)
#define SPC560P_ME_MC_SYSCLK(n) ((n) << 0)
#define SPC560P_ME_MC_SYSCLK_IRC SPC560P_ME_MC_SYSCLK(0)
#define SPC560P_ME_MC_SYSCLK_XOSC SPC560P_ME_MC_SYSCLK(2)
#define SPC560P_ME_MC_SYSCLK_FMPLL0 SPC560P_ME_MC_SYSCLK(4)
#define SPC560P_ME_MC_SYSCLK_FMPLL1 SPC560P_ME_MC_SYSCLK(5)
#define SPC560P_ME_MC_SYSCLK_DISABLED SPC560P_ME_MC_SYSCLK(15)
#define SPC560P_ME_MC_IRCON (1U << 4)
#define SPC560P_ME_MC_XOSC0ON (1U << 5)
#define SPC560P_ME_MC_PLL0ON (1U << 6)
#define SPC560P_ME_MC_PLL1ON (1U << 7)
#define SPC560P_ME_MC_CFLAON_MASK (3U << 16)
#define SPC560P_ME_MC_CFLAON(n) ((n) << 16)
#define SPC560P_ME_MC_CFLAON_PD (1U << 16)
#define SPC560P_ME_MC_CFLAON_LP (2U << 16)
#define SPC560P_ME_MC_CFLAON_NORMAL (3U << 16)
#define SPC560P_ME_MC_DFLAON_MASK (3U << 18)
#define SPC560P_ME_MC_DFLAON(n) ((n) << 18)
#define SPC560P_ME_MC_DFLAON_PD (1U << 18)
#define SPC560P_ME_MC_DFLAON_LP (2U << 18)
#define SPC560P_ME_MC_DFLAON_NORMAL (3U << 18)
#define SPC560P_ME_MC_MVRON (1U << 20)
#define SPC560P_ME_MC_PDO (1U << 23)
/** @} */
/**
* @name ME_MCTL register bits definitions
* @{
*/
#define SPC560P_ME_MCTL_KEY 0x5AF0U
#define SPC560P_ME_MCTL_KEY_INV 0xA50FU
#define SPC560P_ME_MCTL_MODE_MASK (15U << 28)
#define SPC560P_ME_MCTL_MODE(n) ((n) << 28)
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @brief Disables the clocks initialization in the HAL.
*/
#if !defined(SPC560P_NO_INIT) || defined(__DOXYGEN__)
#define SPC560P_NO_INIT FALSE
#endif
/**
* @brief Disables the overclock checks.
*/
#if !defined(SPC560P_ALLOW_OVERCLOCK) || defined(__DOXYGEN__)
#define SPC560P_ALLOW_OVERCLOCK FALSE
#endif
/**
* @brief FMPLL0 IDF divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL0_IDF_VALUE) || defined(__DOXYGEN__)
#define SPC560P_FMPLL0_IDF_VALUE 5
#endif
/**
* @brief FMPLL0 NDIV divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL0_NDIV_VALUE) || defined(__DOXYGEN__)
#define SPC560P_FMPLL0_NDIV_VALUE 32
#endif
/**
* @brief FMPLL0 ODF divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL0_ODF) || defined(__DOXYGEN__)
#define SPC560P_FMPLL0_ODF SPC560P_FMPLL_ODF_DIV4
#endif
/**
* @brief FMPLL1 IDF divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL1_IDF_VALUE) || defined(__DOXYGEN__)
#define SPC560P_FMPLL1_IDF_VALUE 5
#endif
/**
* @brief FMPLL1 NDIV divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL1_NDIV_VALUE) || defined(__DOXYGEN__)
#define SPC560P_FMPLL1_NDIV_VALUE 60
#endif
/**
* @brief FMPLL1 ODF divider value.
* @note The default value is calculated for XOSC=40MHz and PHI=64MHz.
*/
#if !defined(SPC560P_FMPLL1_ODF) || defined(__DOXYGEN__)
#define SPC560P_FMPLL1_ODF SPC560P_FMPLL_ODF_DIV4
#endif
/**
* @brief Active run modes in ME_ME register.
* @note Modes RESET, SAFE, DRUN, and RUN0 modes are always enabled, there
* is no need to specify them.
*/
#if !defined(SPC560P_ME_ME_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_ME_BITS 0
#endif
/**
* @brief TEST mode settings.
*/
#if !defined(SPC560P_ME_TEST_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_TEST_MC_BITS (SPC560P_ME_MC_SYSCLK_IRC | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief SAFE mode settings.
*/
#if !defined(SPC560P_ME_SAFE_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_SAFE_MC_BITS (SPC560P_ME_MC_PDO)
#endif
/**
* @brief DRUN mode settings.
*/
#if !defined(SPC560P_ME_DRUN_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_DRUN_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief RUN0 mode settings.
*/
#if !defined(SPC560P_ME_RUN0_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_RUN0_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief RUN1 mode settings.
*/
#if !defined(SPC560P_ME_RUN1_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_RUN1_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief RUN2 mode settings.
*/
#if !defined(SPC560P_ME_RUN2_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_RUN2_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief RUN3 mode settings.
*/
#if !defined(SPC560P_ME_RUN3_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_RUN3_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief HALT0 mode settings.
*/
#if !defined(SPC560P_ME_HALT0_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_HALT0_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/**
* @brief STOP0 mode settings.
*/
#if !defined(SPC560P_ME_STOP0_MC_BITS) || defined(__DOXYGEN__)
#define SPC560P_ME_STOP0_MC_BITS (SPC560P_ME_MC_SYSCLK_FMPLL0 | \
SPC560P_ME_MC_IRCON | \
SPC560P_ME_MC_XOSC0ON | \
SPC560P_ME_MC_PLL0ON | \
SPC560P_ME_MC_PLL1ON | \
SPC560P_ME_MC_CFLAON_NORMAL | \
SPC560P_ME_MC_DFLAON_NORMAL | \
SPC560P_ME_MC_MVRON)
#endif
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/* Check on the XOSC frequency.*/
#if (SPC560P_XOSC_CLK < SPC560P_XOSC_CLK_MIN) || \
(SPC560P_XOSC_CLK > SPC560P_XOSC_CLK_MAX)
#error "invalid SPC560P_XOSC_CLK value specified"
#endif
/* Check on SPC560P_FMPLL0_IDF_VALUE.*/
#if (SPC560P_FMPLL0_IDF_VALUE < 1) || (SPC560P_FMPLL0_IDF_VALUE > 15)
#error "invalid SPC560P_FMPLL0_IDF_VALUE value specified"
#endif
/* Check on SPC560P_FMPLL0_NDIV_VALUE.*/
#if (SPC560P_FMPLL0_NDIV_VALUE < 32) || (SPC560P_FMPLL0_NDIV_VALUE > 96)
#error "invalid SPC560P_FMPLL0_NDIV_VALUE value specified"
#endif
/* Check on SPC560P_FMPLL0_ODF.*/
#if (SPC560P_FMPLL0_ODF == SPC560P_FMPLL_ODF_DIV2)
#define SPC560P_FMPLL0_ODF_VALUE 2
#elif (SPC560P_FMPLL0_ODF == SPC560P_FMPLL_ODF_DIV4)
#define SPC560P_FMPLL0_ODF_VALUE 4
#elif (SPC560P_FMPLL0_ODF == SPC560P_FMPLL_ODF_DIV8)
#define SPC560P_FMPLL0_ODF_VALUE 8
#elif (SPC560P_FMPLL0_ODF == SPC560P_FMPLL_ODF_DIV16)
#define SPC560P_FMPLL0_ODF_VALUE 16
#else
#error "invalid SPC560P_FMPLL0_ODF value specified"
#endif
/**
* @brief SPC560P_FMPLL0_VCO_CLK clock point.
*/
#define SPC560P_FMPLL0_VCO_CLK \
((SPC560P_XOSC_CLK / SPC560P_FMPLL0_IDF_VALUE) * SPC560P_FMPLL0_NDIV_VALUE)
/* Check on FMPLL0 VCO output.*/
#if (SPC560P_FMPLL0_VCO_CLK < SPC560P_FMPLLVCO_MIN) || \
(SPC560P_FMPLL0_VCO_CLK > SPC560P_FMPLLVCO_MAX)
#error "SPC560P_FMPLL0_CLK outside acceptable range (SPC560P_FMPLLVCO_MIN...SPC560P_FMPLLVCO_MAX)"
#endif
/**
* @brief SPC560P_FMPLL0_CLK clock point.
*/
#define SPC560P_FMPLL0_CLK \
(SPC560P_FMPLL0_VCO_CLK / SPC560P_FMPLL0_ODF_VALUE)
/* Check on SPC560P_FMPLL0_CLK.*/
#if (SPC560P_FMPLL0_CLK > SPC560P_FMPLL0_CLK_MAX) && !SPC560P_ALLOW_OVERCLOCK
#error "SPC560P_FMPLL0_CLK outside acceptable range (0...SPC560P_FMPLL0_CLK_MAX)"
#endif
/* Check on SPC560P_FMPLL1_IDF_VALUE.*/
#if (SPC560P_FMPLL1_IDF_VALUE < 1) || (SPC560P_FMPLL1_IDF_VALUE > 15)
#error "invalid SPC560P_FMPLL1_IDF_VALUE value specified"
#endif
/* Check on SPC560P_FMPLL1_NDIV_VALUE.*/
#if (SPC560P_FMPLL1_NDIV_VALUE < 32) || (SPC560P_FMPLL1_NDIV_VALUE > 96)
#error "invalid SPC560P_FMPLL1_NDIV_VALUE value specified"
#endif
/* Check on SPC560P_FMPLL1_ODF.*/
#if (SPC560P_FMPLL1_ODF == SPC560P_FMPLL_ODF_DIV2)
#define SPC560P_FMPLL1_ODF_VALUE 2
#elif (SPC560P_FMPLL1_ODF == SPC560P_FMPLL_ODF_DIV4)
#define SPC560P_FMPLL1_ODF_VALUE 4
#elif (SPC560P_FMPLL1_ODF == SPC560P_FMPLL_ODF_DIV8)
#define SPC560P_FMPLL1_ODF_VALUE 8
#elif (SPC560P_FMPLL1_ODF == SPC560P_FMPLL_ODF_DIV16)
#define SPC560P_FMPLL1_ODF_VALUE 16
#else
#error "invalid SPC560P_FMPLL1_ODF value specified"
#endif
/**
* @brief SPC560P_FMPLL1_VCO_CLK clock point.
*/
#define SPC560P_FMPLL1_VCO_CLK \
((SPC560P_XOSC_CLK / SPC560P_FMPLL1_IDF_VALUE) * SPC560P_FMPLL1_NDIV_VALUE)
/* Check on FMPLL1 VCO output.*/
#if (SPC560P_FMPLL1_VCO_CLK < SPC560P_FMPLLVCO_MIN) || \
(SPC560P_FMPLL1_VCO_CLK > SPC560P_FMPLLVCO_MAX)
#error "SPC560P_FMPLL1_CLK outside acceptable range (SPC560P_FMPLLVCO_MIN...SPC560P_FMPLLVCO_MAX)"
#endif
/**
* @brief SPC560P_FMPLL1_CLK clock point.
*/
#define SPC560P_FMPLL1_CLK \
(SPC560P_FMPLL1_VCO_CLK / SPC560P_FMPLL1_ODF_VALUE)
/* Check on SPC560P_FMPLL1_CLK.*/
#if (SPC560P_FMPLL1_CLK > SPC560P_FMPLL1_CLK_MAX) && !SPC560P_ALLOW_OVERCLOCK
#error "SPC560P_FMPLL1_CLK outside acceptable range (0...SPC560P_FMPLL1_CLK_MAX)"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
typedef enum {
SPC560P_RUNMODE_TEST = 1,
SPC560P_RUNMODE_SAFE = 2,
SPC560P_RUNMODE_DRUN = 3,
SPC560P_RUNMODE_RUN0 = 4,
SPC560P_RUNMODE_RUN1 = 5,
SPC560P_RUNMODE_RUN2 = 6,
SPC560P_RUNMODE_RUN3 = 7,
SPC560P_RUNMODE_HALT0 = 8,
SPC560P_RUNMODE_STOP0 = 10
} spc560prunmode_t;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void hal_lld_init(void);
void spc560p_clock_init(void);
bool_t halSPC560PSetRunMode(spc560prunmode_t mode);
#ifdef __cplusplus
}
#endif
#endif /* _HAL_LLD_H_ */
/** @} */
|
