aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/Rx62n/hal_lld.h
blob: db3dcc40fd5bce4c4728b9cd2eb6e1336b84ee12 (plain)
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
/*
    ChibiOS/RT - Copyright (C) 2006-2013 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    RX62N/hal_lld.h
 * @brief   HAL subsystem low level driver header template.
 *
 * @addtogroup HAL
 * @{
 */

#ifndef _HAL_LLD_H_
#define _HAL_LLD_H_

#include "iodefine_gcc62n.h"

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/**
 * @brief   Defines the support for realtime counters in the HAL.
 */
#define HAL_IMPLEMENTS_COUNTERS           FALSE

#define IWDTCLK                           125000 /**< Watchdog internal clock */

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/**
 * @brief   System PLL multiplier.
 * @note    The value is hardware fixed at 8.
 */
#if defined(__DOXYGEN__)
#define RX62N_SYSPLL_MUL                  8
#endif

/**
 * @brief   System PLL divider.
 * @note    The value must be chosen between (1, 2, 4, 8).
 */
/*
#if defined(__DOXYGEN__)
#define RX62N_SYSPLL_DIV                  1
#endif
*/

/**
 * @brief   Enables or disables the SDCLK clock output.
 */
#if !defined(RX62N_SDCLK_OUTPUT_ENABLED) || defined(__DOXYGEN__)
#define RX62N_SDCLK_OUTPUT_ENABLED        FALSE
#endif

/**
 * @brief   Enables or disables the BCLK clock output.
 */
#if !defined(RX62N_BCLK_OUTPUT_ENABLED) || defined(__DOXYGEN__)
#define RX62N_BCLK_OUTPUT_ENABLED         FALSE
#endif

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/**
 * @brief   ICK mask in SCKCR register.
 */
#if (RX62N_ICLK_MUL == 1) || defined(__DOXYGEN__)
#define RX62N_SCKCR_ICK (3 << 24)
#elif RX62N_ICLK_MUL == 2
#define RX62N_SCKCR_ICK (2 << 24)
#elif RX62N_ICLK_MUL == 4
#define RX62N_SCKCR_ICK (1 << 24)
#elif RX62N_ICLK_MUL == 8
#define RX62N_SCKCR_ICK (0 << 24)
#else
#error "invalid RX62N_ICLK_MUL value (1,2,4,8), check mcuconf.h"
#endif

/**
 * @brief   BCK mask in SCKCR register.
 */
#if (RX62N_BCLK_MUL == 1) || defined(__DOXYGEN__)
#define RX62N_SCKCR_BCK (3 << 16)
#elif RX62N_BCLK_MUL == 2
#define RX62N_SCKCR_BCK (2 << 16)
#elif RX62N_BCLK_MUL == 4
#define RX62N_SCKCR_BCK (1 << 16)
#elif RX62N_BCLK_MUL == 8
#define RX62N_SCKCR_BCK (0 << 16)
#else
#error "invalid RX62N_BCLK_MUL value (1,2,4,8), check mcuconf.h"
#endif

/**
 * @brief   PCK mask in SCKCR register.
 */
#if (RX62N_PCLK_MUL == 1) || defined(__DOXYGEN__)
#define RX62N_SCKCR_PCK (3 << 8)
#elif RX62N_PCLK_MUL == 2
#define RX62N_SCKCR_PCK (2 << 8)
#elif RX62N_PCLK_MUL == 4
#define RX62N_SCKCR_PCK (1 << 8)
#elif RX62N_PCLK_MUL == 8
#define RX62N_SCKCR_PCK (0 << 8)
#else
#error "invalid RX62N_PCLK_MUL value (1,2,4,8), check mcuconf.h"
#endif

/**
 * @brief   System clock.
 */
#define  RX62N_SYSCLK     (EXTALCLK * RX62N_ICLK_MUL)
#if (RX62N_SYSCLK < 8000000) || (RX62N_SYSCLK > 100000000)
#error "System clock frequency out of the acceptable range (8..100MHz max)"
#endif

/**
 * @brief   Peripheral clock.
 */
#define  RX62N_PERCLK     (EXTALCLK * RX62N_PCLK_MUL)
#if (RX62N_PERCLK < 8000000) || (RX62N_PERCLK > 100000000)
#error "Peripheral clock frequency out of the acceptable range (8..50MHz max)"
#endif

#if (RX62N_PERCLK > RX62N_SYSCLK)
#error "Peripheral clock frequency higher than system clock frequency"
#endif

#if (EXTALCLK < 8000000) || (EXTALCLK > 14000000)
#error "External crystal frequency out of the acceptable range (8..14MHz max)"
#endif

/*
 * TODO: check SYSCLK (ICLK) when ethernet controller is used (SYSCLK > 12.5MHz)
 * TODO: check UCLK when USB is used
 * TODO: oscilation stop detection
 */

/*
Clock frequencies (from manual):
ICLK: 8..100MHz
PCLK: 8..50MHz
BCLK: 8..50MHz or 8..100MHz
BCLK_OUT: 8..25MHz or 8..50MHz
SDCLK: 8..50MHz
UCLK: 48MHz (only when EXTAL = 12MHz)
SUBCLK: 32768Hz
IWDTCLK: 125kHz
ICLK >= PCLK
ICLK >= BCLK
*/

#if defined(__DOXYGEN__)
/**
 * @name    Platform identification
 * @{
 */
#define PLATFORM_NAME           "RX62N"
/** @} */

#elif defined(RX62NXADBG) || defined(RX62NXBDBG) ||               \
      defined(RX62NXADLE) || defined(RX62NXBDLE) ||               \
      defined(RX62NXADFB) || defined(RX62NXBDFB) ||               \
      defined(RX62NXADFP) || defined(RX62NXBDFP) ||               \
      defined(RX62NXADLD) || defined(RX62NXBDLD) ||               \
      defined(__DOXYGEN__)

#else
#error "unspecified, unsupported or invalid RX62N platform"
#endif

/*===========================================================================*/
/* Platform capabilities.                                                    */
/*===========================================================================*/

#if defined(RX62NXADBG) || defined (RX62NXBDBG) || defined(__DOXYGEN__)
/**
 * @name    RX62NXXDBG capabilities (LFBGA176)
 * @{
 */

#error "unsupported RX62N platform"

/** @} */
#endif /* defined(RX62NXADBG) || defined(RX62NXBDBG) */

#if defined(RX62NXADLE) || defined (RX62NXBDLE) || defined(__DOXYGEN__)
/**
 * @name    RX62NXXDLE capabilities (TFLGA145)
 * @{
 */

#error "unsupported RX62N platform"

/** @} */
#endif /* defined(RX62NXADLE) || defined(RX62NXBDLE) */

#if defined(RX62NXADFB) || defined (RX62NXBDFB) || defined(__DOXYGEN__)
/**
 * @name    RX62NXXDLE capabilities (LQFP144)
 * @{
 */

#error "unsupported RX62N platform"

/** @} */
#endif /* defined(RX62NXADFB) || defined(RX62NXBDFB) */

#if defined(RX62NXADFP) || defined (RX62NXBDFP) || defined(__DOXYGEN__)
/**
 * @name    RX62NXXDFP capabilities (LQFP100)
 * @{
 */
/* ADC attributes.*/
#define RX62N_HAS_ADC1          TRUE

/* CAN attributes.*/
#if defined (RX62NXADFP)
#define RX62N_HAS_CAN           FALSE
#else
#define RX62N_HAS_CAN           TRUE
#endif

/* DAC attributes.*/
#define RX62N_HAS_DAC           TRUE

/* DMA attributes.*/

/* ETH attributes.*/
#define RX62N_HAS_ETH           TRUE

/* EXTI attributes.*/
//#define RX62N_EXTI_NUM_CHANNELS 18

/* GPIO attributes.*/
#define RX62N_HAS_PORT0         TRUE
#define RX62N_HAS_PORT0_OD      TRUE /* Open Drain */
#define RX62N_HAS_PORT1         TRUE
#define RX62N_HAS_PORT1_OD      TRUE /* Open Drain */
#define RX62N_HAS_PORT2         TRUE
#define RX62N_HAS_PORT2_OD      TRUE /* Open Drain */
#define RX62N_HAS_PORT3         TRUE
#define RX62N_HAS_PORT3_OD      TRUE /* Open Drain (P30 to P34) */
#define RX62N_HAS_PORT4         TRUE
#define RX62N_HAS_PORT5         TRUE
#define RX62N_HAS_PORT6         FALSE
#undef PORT6
#define RX62N_HAS_PORT7         FALSE
#undef PORT7
#define RX62N_HAS_PORT8         FALSE
#undef PORT8
#define RX62N_HAS_PORT9         FALSE
#undef PORT9
#define RX62N_HAS_PORTA         TRUE
#define RX62N_HAS_PORTA_PU      TRUE /* pull-up */
#define RX62N_HAS_PORTB         TRUE
#define RX62N_HAS_PORTB_PU      TRUE /* pull-up */
#define RX62N_HAS_PORTC         TRUE
#define RX62N_HAS_PORTC_OD      TRUE /* Open Drain */
#define RX62N_HAS_PORTC_PU      TRUE /* Pull-up */
#define RX62N_HAS_PORTD         TRUE
#define RX62N_HAS_PORTD_PU      TRUE /* pull-up */
#define RX62N_HAS_PORTE         TRUE
#define RX62N_HAS_PORTE_PU      TRUE /* pull-up */
#define RX62N_HAS_PORTF         FALSE
#undef PORTF
#define RX62N_HAS_PORTG         FALSE
#undef PORTG

/* I2C attributes.*/
#define RX62N_HAS_I2C1          TRUE
#define RX62N_HAS_I2C2          TRUE

/* SDIO attributes.*/
//#define RX62N_HAS_SDIO          FALSE

/* SPI attributes.*/
#define RX62N_HAS_SPI1          TRUE
#define RX62N_HAS_SPI2          TRUE

/* TIM attributes.*/
#define RX62N_HAS_TIM1          TRUE
#define RX62N_HAS_TIM2          TRUE
#define RX62N_HAS_TIM3          TRUE
#define RX62N_HAS_TIM4          TRUE
#define RX62N_HAS_TIM5          TRUE
#define RX62N_HAS_TIM6          TRUE
#define RX62N_HAS_TIM7          TRUE
#define RX62N_HAS_TIM8          TRUE
#define RX62N_HAS_TIM9          TRUE
#define RX62N_HAS_TIM10         TRUE
#define RX62N_HAS_TIM11         TRUE
#define RX62N_HAS_TIM12         TRUE

/* USART attributes.*/
#define RX62N_HAS_USART1        TRUE
#define RX62N_HAS_USART2        TRUE
#define RX62N_HAS_USART3        TRUE
#define RX62N_HAS_USART4        TRUE
#define RX62N_HAS_USART6        TRUE
#define RX62N_HAS_USART7        TRUE

/* USB attributes.*/
/*#define RX62N_HAS_USB           TRUE*/
/*#define RX62N_HAS_OTG1          TRUE*/

/** @} */
#endif /* defined(RX62NXADFP) || defined(RX62NXBDFP) */

#if defined(RX62NXADLD) || defined (RX62NXBDLD) || defined(__DOXYGEN__)
/**
 * @name    RX62NXXDLD capabilities (TFLGA85)
 * @{
 */

#error "unsupported RX62N platform"

/** @} */
#endif /* defined(RX62NXADLD) || defined(RX62NXBDLD) */

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void hal_lld_init(void);
  void rx62n_clock_init(void);
#ifdef __cplusplus
}
#endif

#endif /* _HAL_LLD_H_ */

/** @} */