source: rtems/c/src/lib/libbsp/arm/lpc176x/include/timer-defs.h @ 19260fb

4.115
Last change on this file since 19260fb was 19260fb, checked in by Martin Boretto <martin.boretto@…>, on Jun 9, 2014 at 2:27:18 PM

bsp/lpc176x: New BSP

  • Property mode set to 100644
File size: 17.3 KB
Line 
1/**
2 * @file timer-defs.h
3 *
4 * @ingroup lpc176x
5 *
6 * @brief API definitions of the for the timer of the lpc176x bsp.
7 */
8
9/*
10 * Copyright (c) 2014 Taller Technologies.
11 *
12 * @author  Boretto Martin    (martin.boretto@tallertechnologies.com)
13 * @author  Diaz Marcos (marcos.diaz@tallertechnologies.com)
14 * @author  Lenarduzzi Federico  (federico.lenarduzzi@tallertechnologies.com)
15 * @author  Daniel Chicco  (daniel.chicco@tallertechnologies.com)
16 *
17 * The license and distribution terms for this file may be
18 * found in the file LICENSE in this distribution or at
19 * http://www.rtems.com/license/LICENSE.
20 */
21
22#ifndef LIBBSP_ARM_LPC176X_TIMER_DEFS_H
23#define LIBBSP_ARM_LPC176X_TIMER_DEFS_H
24
25#include <bsp/common-types.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif /* __cplusplus */
30
31/* Timer 0 */
32#define LPC176X_TMR0_BASE_ADDR 0x40004000U
33
34#define LPC176X_T0IR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
35                                                0x00U ) )
36#define LPC176X_T0TCR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
37                                                 0x04U ) )
38#define LPC176X_T0TC ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
39                                                0x08U ) )
40#define LPC176X_T0PR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
41                                                0x0CU ) )
42#define LPC176X_T0PC ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
43                                                0x10U ) )
44#define LPC176X_T0MCR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
45                                                 0x14U ) )
46#define LPC176X_T0MR0 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
47                                                 0x18U ) )
48#define LPC176X_T0MR1 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
49                                                 0x1CU ) )
50#define LPC176X_T0MR2 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
51                                                 0x20U ) )
52#define LPC176X_T0MR3 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
53                                                 0x24U ) )
54#define LPC176X_T0CCR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
55                                                 0x28U ) )
56#define LPC176X_T0CR0 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
57                                                 0x2CU ) )
58#define LPC176X_T0CR1 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
59                                                 0x30U ) )
60#define LPC176X_T0CR2 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
61                                                 0x34U ) )
62#define LPC176X_T0CR3 ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
63                                                 0x38U ) )
64#define LPC176X_T0EMR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
65                                                 0x3CU ) )
66#define LPC176X_T0CTCR ( *(volatile uint32_t *) ( LPC176X_TMR0_BASE_ADDR + \
67                                                  0x70U ) )
68
69/* Timer 1 */
70#define LPC176X_TMR1_BASE_ADDR 0x40008000U
71
72#define LPC176X_T1IR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
73                                                0x00U ) )
74#define LPC176X_T1TCR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
75                                                 0x04U ) )
76#define LPC176X_T1TC ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
77                                                0x08U ) )
78#define LPC176X_T1PR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
79                                                0x0CU ) )
80#define LPC176X_T1PC ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
81                                                0x10U ) )
82#define LPC176X_T1MCR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
83                                                 0x14U ) )
84#define LPC176X_T1MR0 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
85                                                 0x18U ) )
86#define LPC176X_T1MR1 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
87                                                 0x1CU ) )
88#define LPC176X_T1MR2 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
89                                                 0x20U ) )
90#define LPC176X_T1MR3 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
91                                                 0x24U ) )
92#define LPC176X_T1CCR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
93                                                 0x28U ) )
94#define LPC176X_T1CR0 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
95                                                 0x2CU ) )
96#define LPC176X_T1CR1 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
97                                                 0x30U ) )
98#define LPC176X_T1CR2 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
99                                                 0x34U ) )
100#define LPC176X_T1CR3 ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
101                                                 0x38U ) )
102#define LPC176X_T1EMR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
103                                                 0x3CU ) )
104#define LPC176X_T1CTCR ( *(volatile uint32_t *) ( LPC176X_TMR1_BASE_ADDR + \
105                                                  0x70U ) )
106
107/* Timer 2 */
108#define LPC176X_TMR2_BASE_ADDR 0x40090000U
109
110#define LPC176X_T2IR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
111                                                0x00U ) )
112#define LPC176X_T2TCR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
113                                                 0x04U ) )
114#define LPC176X_T2TC ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
115                                                0x08U ) )
116#define LPC176X_T2PR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
117                                                0x0CU ) )
118#define LPC176X_T2PC ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
119                                                0x10U ) )
120#define LPC176X_T2MCR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
121                                                 0x14U ) )
122#define LPC176X_T2MR0 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
123                                                 0x18U ) )
124#define LPC176X_T2MR1 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
125                                                 0x1CU ) )
126#define LPC176X_T2MR2 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
127                                                 0x20U ) )
128#define LPC176X_T2MR3 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
129                                                 0x24U ) )
130#define LPC176X_T2CCR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
131                                                 0x28U ) )
132#define LPC176X_T2CR0 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
133                                                 0x2CU ) )
134#define LPC176X_T2CR1 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
135                                                 0x30U ) )
136#define LPC176X_T2CR2 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
137                                                 0x34U ) )
138#define LPC176X_T2CR3 ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
139                                                 0x38U ) )
140#define LPC176X_T2EMR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
141                                                 0x3CU ) )
142#define LPC176X_T2CTCR ( *(volatile uint32_t *) ( LPC176X_TMR2_BASE_ADDR + \
143                                                  0x70U ) )
144
145/* Timer 3 */
146#define LPC176X_TMR3_BASE_ADDR 0x40094000U
147
148#define LPC176X_T3IR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
149                                                0x00U ) )
150#define LPC176X_T3TCR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
151                                                 0x04U ) )
152#define LPC176X_T3TC ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
153                                                0x08U ) )
154#define LPC176X_T3PR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
155                                                0x0CU ) )
156#define LPC176X_T3PC ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
157                                                0x10U ) )
158#define LPC176X_T3MCR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
159                                                 0x14U ) )
160#define LPC176X_T3MR0 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
161                                                 0x18U ) )
162#define LPC176X_T3MR1 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
163                                                 0x1CU ) )
164#define LPC176X_T3MR2 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
165                                                 0x20U ) )
166#define LPC176X_T3MR3 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
167                                                 0x24U ) )
168#define LPC176X_T3CCR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
169                                                 0x28U ) )
170#define LPC176X_T3CR0 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
171                                                 0x2CU ) )
172#define LPC176X_T3CR1 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
173                                                 0x30U ) )
174#define LPC176X_T3CR2 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
175                                                 0x34U ) )
176#define LPC176X_T3CR3 ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
177                                                 0x38U ) )
178#define LPC176X_T3EMR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
179                                                 0x3CU ) )
180#define LPC176X_T3CTCR ( *(volatile uint32_t *) ( LPC176X_TMR3_BASE_ADDR + \
181                                                  0x70U ) )
182
183/**
184 * @brief Represents the timer device registers.
185 */
186typedef struct {
187  /**
188   * @brief Interrupt Register.
189   */
190  volatile uint32_t IR;
191  /**
192   * @brief Timer Control Register.
193   */
194  volatile uint32_t TCR;
195  /**
196   * @brief Timer Counter.
197   */
198  volatile uint32_t TC;
199  /**
200   * @brief Prescale Register.
201   */
202  volatile uint32_t PR;
203  /**
204   * @brief Prescale Counter.
205   */
206  volatile uint32_t PC;
207  /**
208   * @brief Match Control Register.
209   */
210  volatile uint32_t MCR;
211  /**
212   * @brief Match Register (0, 1, 2, 3)
213   */
214  volatile uint32_t MR[ 4 ];
215  /**
216   * @brief Capture Control Register.
217   */
218  volatile uint32_t CCR;
219  /**
220   * @brief Capture Register (0, 1)
221   */
222  volatile uint32_t CR[ 2 ];
223  volatile uint32_t reserved0;
224  volatile uint32_t reserved1;
225  /**
226   * @brief External Match Register.
227   */
228  volatile uint32_t EMR;
229  volatile uint32_t reserved2[ 12 ];
230  /**
231   * @brief Count Control Register.
232   */
233  volatile uint32_t CTCR;
234} lpc176x_timer_device;
235
236#define LPC176X_PIN_SELECT_TIMER 3U
237#define LPC176X_PINSEL_NO_PORT 999U
238
239#define LPC176X_TIMER_RESET ( 1U << 1U )
240#define LPC176X_TIMER_START 1U
241#define LPC176X_TIMER_MODE_COUNTER_SOURCE_CAP0 0U
242#define LPC176X_TIMER_MODE_COUNTER_SOURCE_CAP1 ( 1U << 2U )
243#define LPC176X_TIMER0_CAPTURE_PORTS { 58U, 59U }
244#define LPC176X_TIMER1_CAPTURE_PORTS { 50U, 51U }
245#define LPC176X_TIMER2_CAPTURE_PORTS { 4U, 5U }
246#define LPC176X_TIMER3_CAPTURE_PORTS { 23U, 24U }
247#define LPC176X_TIMER0_EMATCH_PORTS { 60U,   \
248                                      61U,    \
249                                      LPC176X_PINSEL_NO_PORT, \
250                                      LPC176X_PINSEL_NO_PORT }
251#define LPC176X_TIMER1_EMATCH_PORTS { 54U, \
252                                      57U,    \
253                                      LPC176X_PINSEL_NO_PORT, \
254                                      LPC176X_PINSEL_NO_PORT }
255#define LPC176X_TIMER2_EMATCH_PORTS { 6U, 7U, 8U, 9U }
256#define LPC176X_TIMER3_EMATCH_PORTS { 10U, \
257                                      11U, \
258                                      LPC176X_PINSEL_NO_PORT, \
259                                      LPC176X_PINSEL_NO_PORT }
260#define LPC176X_TIMER_DEFAULT_RESOLUTION 1U
261#define LPC176X_TIMER_MCR_MASK 7U
262#define LPC176X_TIMER_MCR_MASK_SIZE 3U
263#define LPC176X_TIMER_CCR_MASK 7U
264#define LPC176X_TIMER_CCR_MASK_SIZE 3U
265#define LPC176X_TIMER_EMR_MASK 3U
266#define LPC176X_TIMER_EMR_MASK_SIZE 2U
267#define LPC176X_TIMER_EMR_MASK_OFFSET 4U
268#define LPC176X_TIMER_CLEAR_FUNCTION 0U
269#define LPC176X_TIMER_PRESCALER_DIVISOR 1000000U
270#define LPC176X_TIMER_VECTOR_NUMBER( timernumber ) ( timernumber + 1U )
271#define LPC176X_TIMER_INTERRUPT_SOURCE_BIT( i ) ( 1U << i )
272#define LPC176X_TIMER_MATCH_FUNCTION_COUNT 8U
273#define LPC176X_TIMER_CAPTURE_FUNCTION_COUNT 8U
274
275#define LPC176X_ISR_NAME_STRING_SIZE 10U
276
277#define LPC176X_SET_MCR( mcr, match_port, function )  \
278  SET_FIELD( mcr, \
279  function, \
280  ( 0x7U << ( 3U * match_port ) ), \
281  ( 3U * match_port ) )
282#define LPC176X_SET_CCR( mcr, capture_port, function )  \
283  SET_FIELD( mcr, function, ( 0x7U << ( 3U * capture_port ) ), \
284  ( 3U * capture_port ) )
285#define LPC176X_SET_EMR( mcr, match_port, function )  \
286  SET_FIELD( mcr, function, ( 0x3U << ( 2U * match_port + 4U ) ), \
287  ( 2U * match_port + 4U ) )
288
289/**
290 * @brief Capture ports of a timer.
291 *
292 * Enumerated type to define the set of capture ports for a timer device.
293 */
294typedef enum {
295  LPC176X_CAPn_0,
296  LPC176X_CAPn_1,
297  LPC176X_CAPTURE_PORTS_COUNT
298} lpc176x_capture_port;
299
300/**
301 * @brief Match ports of a timer.
302 *
303 * Enumerated type to define the set of match ports for a timer device.
304 */
305typedef enum {
306  LPC176X_MATn_0,
307  LPC176X_MATn_1,
308  LPC176X_MATn_2,
309  LPC176X_MATn_3,
310  LPC176X_EMATCH_PORTS_COUNT
311} lpc176x_match_port;
312
313/**
314 * @brief Timer modes of a timer.
315 *
316 * Enumerated type to define the set of modes for a timer device.
317 */
318typedef enum {
319  LPC176X_TIMER_MODE_TIMER,
320  LPC176X_TIMER_MODE_COUNTER_RISING_CAP0,
321  LPC176X_TIMER_MODE_COUNTER_FALLING_CAP0,
322  LPC176X_TIMER_MODE_COUNTER_BOTH_CAP0,
323  LPC176X_TIMER_MODE_COUNTER_RISING_CAP1 = ( 1U & ( 1U << 2U ) ),
324  LPC176X_TIMER_MODE_COUNTER_FALLING_CAP1 = ( 2U & ( 1U << 2U ) ),
325  LPC176X_TIMER_MODE_COUNTER_BOTH_CAP1 = ( 3U & ( 1U << 2U ) ),
326} lpc176x_timer_mode;
327
328/**
329 * @brief The timer devices in the board.
330 *
331 * Enumerated type to define the timer device's numbers.
332 */
333typedef enum {
334  LPC176X_TIMER_0,
335  LPC176X_TIMER_1,
336  LPC176X_TIMER_2,
337  LPC176X_TIMER_3,
338  LPC176X_TIMER_COUNT
339} lpc176x_timer_number;
340
341/**
342 * @brief The index for the isr_funct_vector representing the functions
343 *        that attends each possible interrupt source for a timer.
344 *
345 * Enumerated type to define the set of  isr timer functions .
346 */
347typedef enum {
348  LPC176X_MAT0_ISR_FUNCTION,
349  LPC176X_MAT1_ISR_FUNCTION,
350  LPC176X_MAT2_ISR_FUNCTION,
351  LPC176X_MAT3_ISR_FUNCTION,
352  LPC176X_CAP0_ISR_FUNCTION,
353  LPC176X_CAP1_ISR_FUNCTION,
354  LPC176X_ISR_FUNCTIONS_COUNT
355} lpc176x_isr_function;
356
357/**
358 * @brief The possible functions at match. This options could be
359 *        used together.
360 *
361 * Enumerated type to define the set of  functions at mach for a
362 *     timer device.
363 */
364typedef enum {
365  LPC176X_TIMER_MATCH_FUNCTION_NONE = 0U,
366  LPC176X_TIMER_MATCH_FUNCTION_INTERRUPT = 1U,
367  LPC176X_TIMER_MATCH_FUNCTION_RESET = ( 1U << 1U ),
368  LPC176X_TIMER_MATCH_FUNCTION_STOP = ( 1U << 2U )
369} lpc176x_match_function;
370
371/**
372 * @brief The possible functions at capture. This options could
373 *        be used together.
374 *
375 * Enumerated type to define the set of  functions at capture for
376 *     a timer device.
377 */
378typedef enum {
379  LPC176X_TIMER_CAPTURE_FUNCTION_NONE = 0U,
380  LPC176X_TIMER_CAPTURE_FUNCTION_RISING = 1U,
381  LPC176X_TIMER_CAPTURE_FUNCTION_FALLING = ( 1U << 1U ),
382  LPC176X_TIMER_CAPTURE_FUNCTION_INTERRUPT = ( 1U << 2U )
383} lpc176x_capture_function;
384
385/**
386 * @brief The possible functions at match, for the external ports.
387 *
388 * Enumerated type to define the set of  functions at match, for external
389 *     ports, for a timer device.
390 */
391typedef enum {
392  LPC176X_TIMER_EXTMATCH_FUNCTION_NONE,
393  LPC176X_TIMER_EXTMATCH_FUNCTION_CLEAR,
394  LPC176X_TIMER_EXTMATCH_FUNCTION_SET,
395  LPC176X_TIMER_EXTMATCH_FUNCTION_TOGGLE
396} lpc176x_ext_match_function;
397
398/**
399 * @brief A function that attends an interruption for a timer.
400 *
401 * @param  tnumber Timer number.
402 * @return Pointer to the match function.
403 */
404typedef void (*lpc176x_isr_funct) ( const lpc176x_timer_number tnumber );
405
406/**
407 * @brief The vector of functions that attends each possible interrupt
408 *        source for a timer.
409 */
410typedef lpc176x_isr_funct const lpc176x_isr_funct_vector[
411    LPC176X_ISR_FUNCTIONS_COUNT ];
412
413/**
414 * @brief The Timer device representation.
415 */
416typedef struct {
417  /**
418   * @brief The address of the controlling registers for the timer.
419   */
420  lpc176x_timer_device *const device;
421  /**
422   * @brief The module for the RTEMS module starting (power and clock).
423   */
424  const lpc176x_module module;
425  /**
426   * @brief The Pins for the Capture ports of this timer.
427   */
428  const lpc176x_pin_number pinselcap[ LPC176X_CAPTURE_PORTS_COUNT ];
429  /**
430   * @brief The Pins for the external match ports of this timer.
431   */
432  const lpc176x_pin_number pinselemat[ LPC176X_EMATCH_PORTS_COUNT ];
433} lpc176x_timer;
434
435/**
436 * @brief The Timer functions.
437 */
438typedef struct {
439  /**
440   * @brief The vector of isr functions for this timer.
441   */
442  const lpc176x_isr_funct_vector *funct_vector;
443} lpc176x_timer_functions;
444
445#ifdef __cplusplus
446}
447#endif /* __cplusplus */
448
449#endif /* LIBBSP_ARM_LPC176X_TIMER_DEFS_H */
Note: See TracBrowser for help on using the repository browser.