be668cb02c9f2e7b4fa5c3208e42e1645a22fef7
[pulsecounter.git] / Hal / Hal.c
1 /*
2  * ============ Hardware Abstraction Layer for MSP-EXP430G2 LaunchPad ============
3  */
4
5 #include "Hal.h"
6 #include "Em_Message.h"
7
8 #include <msp430.h>
9
10
11 /* -------- INTERNAL FEATURES -------- */
12
13 #define GREEN_LED_CONFIG()                (P1DIR |= BIT6)
14 #define GREEN_LED_ON()                    (P1OUT |= BIT6)
15 #define GREEN_LED_OFF()                   (P1OUT &= ~BIT6)
16 #define GREEN_LED_READ()                  (P1OUT & BIT6)
17 #define GREEN_LED_TOGGLE()                (P1OUT ^= BIT6)
18
19 #define RED_LED_CONFIG()                  (P1DIR |= BIT0)
20 #define RED_LED_ON()                      (P1OUT |= BIT0)
21 #define RED_LED_OFF()                     (P1OUT &= ~BIT0)
22 #define RED_LED_READ()                    (P1OUT & BIT0)
23 #define RED_LED_TOGGLE()                  (P1OUT ^= BIT0)
24
25 #define GPIO_CONFIG(mask)           (P1DIR &= ~mask, P1REN |= mask, P1OUT |= mask, P1IES |= mask);
26 #define GPIO_ENABLE(mask)           (P1IFG &= ~mask, P1IE |= mask)
27 #define GPIO_DISABLE(mask)          (P1IE &= ~mask, P1IFG &= ~mask)
28 #define GPIO_FIRED(mask)            (P1IFG & mask)
29 #define GPIO_LOW(mask)              (!(P1IN & mask))
30 #define GPIO_DEBOUNCE_MSECS         100
31
32 #define DEBUG1_CONFIG()             (P2DIR |= BIT3)
33 #define DEBUG1_ON()                 (P2OUT |= BIT3)
34 #define DEBUG1_OFF()                (P2OUT &= ~BIT3)
35
36 #define DEBUG2_CONFIG()             (P2DIR |= BIT4)
37 #define DEBUG2_ON()                 (P2OUT |= BIT4)
38 #define DEBUG2_OFF()                (P2OUT &= ~BIT4)
39
40 #define EAP_RX_BUF                  UCA0RXBUF
41 #define EAP_TX_BUF                  UCA0TXBUF
42
43 #define EAP_RX_VECTOR               USCIAB0RX_VECTOR
44 #define EAP_TX_VECTOR               USCIAB0TX_VECTOR
45 #define EAP_TX_ACK_VECTOR           PORT2_VECTOR
46
47 #define EAP_RX_ENABLE()             (P1SEL |= BIT1, P1SEL2 |= BIT1)
48 #define EAP_RX_DISABLE()            (P1SEL &= ~BIT1, P1SEL2 &= ~BIT1)
49 #define EAP_TX_ENABLE()             (P1SEL |= BIT2, P1SEL2 |= BIT2)
50 #define EAP_TX_DISABLE()            (P1SEL &= ~BIT2, P1SEL2 &= ~BIT2)
51
52 #define EAP_RX_ACK_CONFIG()         (P2DIR |= BIT0)
53 #define EAP_RX_ACK_SET()            (P2OUT |= BIT0)
54 #define EAP_RX_ACK_CLR()            (P2OUT &= ~BIT0)
55
56 #define EAP_TX_ACK_CONFIG()         (P2DIR &= ~BIT1, P2IES |= BIT1, P2IFG &= ~BIT1, P2IE |= BIT1)
57 #define EAP_TX_ACK_TST()            (P2IFG & BIT1)
58 #define EAP_TX_ACK_CLR()            (P2IFG &= ~BIT1)
59
60 #define EAP_RX_INT_CLR()            (IFG2 &= ~UCA0RXIFG)
61 #define EAP_RX_INT_ENABLE()         (IE2 |= UCA0RXIE)
62 #define EAP_TX_INT_CLR()            (IFG2 &= ~UCA0TXIFG)
63 #define EAP_TX_INT_DISABLE()        (IE2 &= ~UCA0TXIE)
64 #define EAP_TX_INT_ENABLE()         (IE2 |= UCA0TXIE)
65
66 #define MCLK_TICKS_PER_MS           1000L
67 #define ACLK_TICKS_PER_SECOND       12000L
68 #define UART_WATCHDOG_PERIOD        (ACLK_TICKS_PER_SECOND * 250) / 1000
69
70 #define UART_WATCH_DISABLE()        (TA1CCTL1 = 0)                                              // Turn off CCR1 Interrupt
71 #define UART_WATCH_ENABLE()         (TA1CCR1 = TA1R + UART_WATCHDOG_PERIOD, TA1CCTL1 = CCIE)    // Set CCR1, and Enable CCR1 Interrupt
72
73 #ifdef __GNUC__
74 #define DINT()                      __disable_interrupt()
75 #define EINT()                      __enable_interrupt()
76 #define INTERRUPT
77 #define SLEEP()                     _BIS_SR(LPM3_bits + GIE)
78 #define WAKEUP()                    _BIC_SR_IRQ(LPM3_bits)
79 #endif
80
81 #ifdef __TI_COMPILER_VERSION__
82 #define DINT()                      (_disable_interrupt())
83 #define EINT()                      (_enable_interrupt())
84 #define INTERRUPT interrupt
85 #define SLEEP()                     (__bis_SR_register(LPM3_bits + GIE))
86 #define WAKEUP()                    (__bic_SR_register_on_exit(LPM3_bits))
87 #endif
88
89 #define NUM_HANDLERS 5
90
91 #define EVENT3_HANDLER_ID      0
92 #define EVENT4_HANDLER_ID      1
93 #define EVENT5_HANDLER_ID      2
94 #define TICK_HANDLER_ID        3
95 #define DISPATCH_HANDLER_ID    4
96
97 static void gpioHandler(uint8_t id);
98 static void postEvent(uint8_t handlerId);
99
100 static Hal_Handler appGpioHandler;
101 static volatile uint16_t handlerEvents = 0;
102 static uint16_t clockTick = 0;
103 static Hal_Handler handlerTab[NUM_HANDLERS];
104
105
106 /* -------- APP-HAL INTERFACE -------- */
107
108 void Hal_gpioEnable(Hal_Handler handler) {
109     uint8_t id;
110     uint16_t mask;
111
112     for (id = 0, mask = BIT3; id < 3; id++, mask <<= 1) {
113         handlerTab[id] = gpioHandler;
114         appGpioHandler = handler;
115         (P1DIR &= ~mask, P1REN |= mask, P1OUT |= mask, P1IES |= mask);
116         Hal_delay(100);
117         (P1IFG &= ~mask, P1IE |= mask);
118     }
119 }
120
121 void Hal_connected(void) {
122 }
123
124 void Hal_debugOn(uint8_t line) {
125     switch (line) {
126     case 1:
127         DEBUG1_ON();
128         break;
129     case 2:
130         DEBUG2_ON();
131     }
132 }
133
134 void Hal_debugOff(uint8_t line) {
135     switch (line) {
136     case 1:
137         DEBUG1_OFF();
138         break;
139     case 2:
140         DEBUG2_OFF();
141     }
142 }
143
144 void Hal_debugPulse(uint8_t line) {
145     switch (line) {
146     case 1:
147         DEBUG1_ON();
148         DEBUG1_OFF();
149         break;
150     case 2:
151         DEBUG2_ON();
152         DEBUG2_OFF();
153     }
154 }
155
156 void Hal_delay(uint16_t msecs) {
157     while (msecs--) {
158         __delay_cycles(MCLK_TICKS_PER_MS);
159     }
160 }
161
162 void Hal_disconnected(void) {
163 }
164
165 void Hal_init(void) {
166
167     /* setup clocks */
168
169     WDTCTL = WDTPW + WDTHOLD;
170     BCSCTL2 = SELM_0 + DIVM_0 + DIVS_0;
171     if (CALBC1_1MHZ != 0xFF) {
172         DCOCTL = 0x00;
173         BCSCTL1 = CALBC1_1MHZ;      /* Set DCO to 1MHz */
174         DCOCTL = CALDCO_1MHZ;
175     }
176     BCSCTL1 |= XT2OFF + DIVA_0;
177     BCSCTL3 = XT2S_0 + LFXT1S_2 + XCAP_1;
178
179     /* setup LEDs */
180
181     GREEN_LED_CONFIG();
182     GREEN_LED_OFF();
183     RED_LED_CONFIG();
184     RED_LED_OFF();
185
186     /* setup debug pins */
187
188     DEBUG1_CONFIG(); DEBUG1_OFF();
189     DEBUG2_CONFIG(); DEBUG2_OFF();
190
191     DEBUG1_ON(); DEBUG1_OFF();
192
193     /* setup TimerA1 */
194     TA1CTL = TASSEL_1 + MC_2;           // ACLK, Continuous mode
195     UART_WATCH_DISABLE();
196
197     /* setup UART */
198
199     UCA0CTL1 |= UCSWRST;
200
201     EAP_RX_ENABLE();
202     EAP_TX_ENABLE();
203
204     EAP_RX_ACK_CONFIG();
205     EAP_RX_ACK_SET();
206
207     EAP_TX_ACK_CONFIG();
208
209     // suspend the MCM
210     EAP_RX_ACK_CLR();
211
212     UCA0CTL1 = UCSSEL_2 + UCSWRST;
213     UCA0MCTL = UCBRF_0 + UCBRS_6;
214     UCA0BR0 = 8;
215     UCA0CTL1 &= ~UCSWRST;
216
217     handlerTab[DISPATCH_HANDLER_ID] = Em_Message_dispatch;
218 }
219
220 void Hal_idleLoop(void) {
221
222     EINT();
223     for (;;) {
224
225         // atomically read/clear all handlerEvents
226         DINT();
227         uint16_t events = handlerEvents;
228         handlerEvents = 0;
229
230         if (events) {   // dispatch all current events
231             EINT();
232             uint16_t mask;
233             uint8_t id;
234             for (id = 0, mask = 0x1; id < NUM_HANDLERS; id++, mask <<= 1) {
235                 if ((events & mask) && handlerTab[id]) {
236                     handlerTab[id](id);
237                 }
238             }
239         }
240         else {          // await more events
241             SLEEP();
242         }
243     }
244 }
245
246 void Hal_greenLedOn(void) {
247     GREEN_LED_ON();
248 }
249
250 void Hal_greenLedOff(void) {
251     GREEN_LED_OFF();
252 }
253
254 bool Hal_greenLedRead(void) {
255     return GREEN_LED_READ();
256 }
257
258 void Hal_greenLedToggle(void) {
259     GREEN_LED_TOGGLE();
260 }
261
262 void Hal_redLedOn(void) {
263     RED_LED_ON();
264 }
265
266 void Hal_redLedOff(void) {
267     RED_LED_OFF();
268 }
269
270 bool Hal_redLedRead(void) {
271     return RED_LED_READ();
272 }
273
274 void Hal_redLedToggle(void) {
275     RED_LED_TOGGLE();
276 }
277
278 void Hal_tickStart(uint16_t msecs, Hal_Handler handler) {
279     handlerTab[TICK_HANDLER_ID] = handler;
280     clockTick = (ACLK_TICKS_PER_SECOND * msecs) / 1000;
281     TA1CCR0 = TA1R + clockTick;                 // Set the CCR0 interrupt for msecs from now.
282     TA1CCTL0 = CCIE;                            // Enable the CCR0 interrupt
283 }
284
285 void Hal_tickStop(void) {
286     handlerTab[TICK_HANDLER_ID] = 0;
287     TA1CCR0 = 0;
288     TA1CCTL0 = 0;
289 }
290
291 /* -------- SRT-HAL INTERFACE -------- */
292
293 uint8_t Em_Hal_lock(void) {
294         uint8_t key = _get_interrupt_state();
295     #ifdef __GNUC__
296         __disable_interrupt();
297     #endif
298     #ifdef __TI_COMPILER_VERSION__
299         _disable_interrupt();
300     #endif
301         return key;
302 }
303
304 void Em_Hal_reset(void) {
305     uint8_t key = Em_Hal_lock();
306     EAP_RX_ACK_CLR();    // suspend the MCM
307     Hal_delay(100);
308     EAP_RX_ACK_SET();    // reset the MCM
309     Hal_delay(500);
310     EAP_RX_INT_CLR();
311     EAP_TX_INT_CLR();
312     EAP_TX_ACK_CLR();
313     EAP_RX_INT_ENABLE();
314     Em_Hal_unlock(key);
315 }
316
317 void Em_Hal_startSend() {
318     EAP_TX_BUF = Em_Message_startTx();
319 }
320
321 void Em_Hal_unlock(uint8_t key) {
322         _set_interrupt_state(key);
323 }
324
325 void Em_Hal_watchOff(void) {
326     UART_WATCH_DISABLE();
327 }
328
329 void Em_Hal_watchOn(void) {
330     UART_WATCH_ENABLE();
331 }
332
333
334 /* -------- INTERNAL FUNCTIONS -------- */
335
336 static void gpioHandler(uint8_t id) {
337     uint16_t mask = BIT3 << id;
338
339     Hal_delay(GPIO_DEBOUNCE_MSECS);
340     if (GPIO_LOW(mask) && appGpioHandler)
341         appGpioHandler(id);
342     GPIO_ENABLE(mask);
343 }
344
345 static void postEvent(uint8_t handlerId) {
346     uint8_t key = Em_Hal_lock();
347     handlerEvents |= 1 << handlerId;
348     Em_Hal_unlock(key);
349 }
350
351 /* -------- INTERRUPT SERVICE ROUTINES -------- */
352
353 #ifdef __GNUC__
354     __attribute__((interrupt(PORT1_VECTOR)))
355 #endif
356 #ifdef __TI_COMPILER_VERSION__
357     #pragma vector=PORT1_VECTOR
358 #endif
359 INTERRUPT void gpioIsr(void) {
360     uint8_t id;
361     uint16_t mask;
362
363     for (id = 0, mask = BIT3; id < 3; id++, mask <<= 1)
364         if (GPIO_FIRED(mask)) {
365             postEvent(id);
366             GPIO_DISABLE(mask);
367         }
368     WAKEUP();
369 }
370
371 #ifdef __GNUC__
372     __attribute__((interrupt(EAP_RX_VECTOR)))
373 #endif
374 #ifdef __TI_COMPILER_VERSION__
375     #pragma vector=EAP_RX_VECTOR
376 #endif
377 INTERRUPT void rxIsr(void) {
378     uint8_t b = EAP_RX_BUF;
379     Em_Message_startRx();
380     EAP_RX_ACK_CLR();
381     EAP_RX_ACK_SET();
382     if (Em_Message_addByte(b)) {
383         postEvent(DISPATCH_HANDLER_ID);
384     }
385     WAKEUP();
386 }
387
388 #ifdef __GNUC__
389     __attribute__((interrupt(TIMER1_A0_VECTOR)))
390 #endif
391 #ifdef __TI_COMPILER_VERSION__
392     #pragma vector=TIMER1_A0_VECTOR
393 #endif
394 INTERRUPT void timerIsr(void) {
395     TA1CCR0 += clockTick;
396     postEvent(TICK_HANDLER_ID);
397     WAKEUP();
398 }
399
400 #ifdef __GNUC__
401     __attribute__((interrupt(EAP_TX_ACK_VECTOR)))
402 #endif
403 #ifdef __TI_COMPILER_VERSION__
404     #pragma vector=EAP_TX_ACK_VECTOR
405 #endif
406 INTERRUPT void txAckIsr(void) {
407     if (EAP_TX_ACK_TST()) {
408         uint8_t b;
409         if (Em_Message_getByte(&b)) {
410             EAP_TX_BUF = b;
411         }
412         EAP_TX_ACK_CLR();
413     }
414     WAKEUP();
415 }
416
417 #ifdef __GNUC__
418     __attribute__((interrupt(TIMER1_A1_VECTOR)))
419 #endif
420 #ifdef __TI_COMPILER_VERSION__
421     #pragma vector=TIMER1_A1_VECTOR
422 #endif
423 INTERRUPT void uartWatchdogIsr(void) {
424     switch (TA1IV) {
425     case  2:  // CCR1
426         UART_WATCH_DISABLE();
427         Em_Message_restart();
428         WAKEUP();
429         break;
430     }
431 }