f7b801c4aed7174759f08fc616f26a4ade4f54d9
[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 BUTTON_CONFIG()             (P1DIR &= ~BIT3, P1REN |= BIT3, P1OUT |= BIT3, P1IES |= BIT3);
26 #define BUTTON_ENABLE()             (P1IFG &= ~BIT3, P1IE |= BIT3)
27 #define BUTTON_DISABLE()            (P1IE &= ~BIT3, P1IFG &= ~BIT3)
28 #define BUTTON_FIRED()              (P1IFG & BIT3)
29 #define BUTTON_PRESSED()            (!(P1IN & BIT3))
30 #define BUTTON_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 BUTTON_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 buttonHandler(uint8_t id);
98 static void postEvent(uint8_t handlerId);
99
100 static Hal_Handler appButtonHandler;
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_buttonEnable(Hal_Handler handler) {
109     handlerTab[BUTTON_HANDLER_ID] = buttonHandler;
110     appButtonHandler = handler;
111     BUTTON_CONFIG();
112     Hal_delay(100);
113     BUTTON_ENABLE();
114 }
115
116 void Hal_connected(void) {
117 }
118
119 void Hal_debugOn(uint8_t line) {
120     switch (line) {
121     case 1:
122         DEBUG1_ON();
123         break;
124     case 2:
125         DEBUG2_ON();
126     }
127 }
128
129 void Hal_debugOff(uint8_t line) {
130     switch (line) {
131     case 1:
132         DEBUG1_OFF();
133         break;
134     case 2:
135         DEBUG2_OFF();
136     }
137 }
138
139 void Hal_debugPulse(uint8_t line) {
140     switch (line) {
141     case 1:
142         DEBUG1_ON();
143         DEBUG1_OFF();
144         break;
145     case 2:
146         DEBUG2_ON();
147         DEBUG2_OFF();
148     }
149 }
150
151 void Hal_delay(uint16_t msecs) {
152     while (msecs--) {
153         __delay_cycles(MCLK_TICKS_PER_MS);
154     }
155 }
156
157 void Hal_disconnected(void) {
158 }
159
160 void Hal_init(void) {
161
162     /* setup clocks */
163
164     WDTCTL = WDTPW + WDTHOLD;
165     BCSCTL2 = SELM_0 + DIVM_0 + DIVS_0;
166     if (CALBC1_1MHZ != 0xFF) {
167         DCOCTL = 0x00;
168         BCSCTL1 = CALBC1_1MHZ;      /* Set DCO to 1MHz */
169         DCOCTL = CALDCO_1MHZ;
170     }
171     BCSCTL1 |= XT2OFF + DIVA_0;
172     BCSCTL3 = XT2S_0 + LFXT1S_2 + XCAP_1;
173
174     /* setup LEDs */
175
176     GREEN_LED_CONFIG();
177     GREEN_LED_OFF();
178     RED_LED_CONFIG();
179     RED_LED_OFF();
180
181     /* setup debug pins */
182
183     DEBUG1_CONFIG(); DEBUG1_OFF();
184     DEBUG2_CONFIG(); DEBUG2_OFF();
185
186     DEBUG1_ON(); DEBUG1_OFF();
187
188     /* setup TimerA1 */
189     TA1CTL = TASSEL_1 + MC_2;           // ACLK, Continuous mode
190     UART_WATCH_DISABLE();
191
192     /* setup UART */
193
194     UCA0CTL1 |= UCSWRST;
195
196     EAP_RX_ENABLE();
197     EAP_TX_ENABLE();
198
199     EAP_RX_ACK_CONFIG();
200     EAP_RX_ACK_SET();
201
202     EAP_TX_ACK_CONFIG();
203
204     // suspend the MCM
205     EAP_RX_ACK_CLR();
206
207     UCA0CTL1 = UCSSEL_2 + UCSWRST;
208     UCA0MCTL = UCBRF_0 + UCBRS_6;
209     UCA0BR0 = 8;
210     UCA0CTL1 &= ~UCSWRST;
211
212     handlerTab[DISPATCH_HANDLER_ID] = Em_Message_dispatch;
213 }
214
215 void Hal_idleLoop(void) {
216
217     EINT();
218     for (;;) {
219
220         // atomically read/clear all handlerEvents
221         DINT();
222         uint16_t events = handlerEvents;
223         handlerEvents = 0;
224
225         if (events) {   // dispatch all current events
226             EINT();
227             uint16_t mask;
228             uint8_t id;
229             for (id = 0, mask = 0x1; id < NUM_HANDLERS; id++, mask <<= 1) {
230                 if ((events & mask) && handlerTab[id]) {
231                     handlerTab[id](id);
232                 }
233             }
234         }
235         else {          // await more events
236             SLEEP();
237         }
238     }
239 }
240
241 void Hal_greenLedOn(void) {
242     GREEN_LED_ON();
243 }
244
245 void Hal_greenLedOff(void) {
246     GREEN_LED_OFF();
247 }
248
249 bool Hal_greenLedRead(void) {
250     return GREEN_LED_READ();
251 }
252
253 void Hal_greenLedToggle(void) {
254     GREEN_LED_TOGGLE();
255 }
256
257 void Hal_redLedOn(void) {
258     RED_LED_ON();
259 }
260
261 void Hal_redLedOff(void) {
262     RED_LED_OFF();
263 }
264
265 bool Hal_redLedRead(void) {
266     return RED_LED_READ();
267 }
268
269 void Hal_redLedToggle(void) {
270     RED_LED_TOGGLE();
271 }
272
273 void Hal_tickStart(uint16_t msecs, Hal_Handler handler) {
274     handlerTab[TICK_HANDLER_ID] = handler;
275     clockTick = (ACLK_TICKS_PER_SECOND * msecs) / 1000;
276     TA1CCR0 = TA1R + clockTick;                 // Set the CCR0 interrupt for msecs from now.
277     TA1CCTL0 = CCIE;                            // Enable the CCR0 interrupt
278 }
279
280 void Hal_tickStop(void) {
281     handlerTab[TICK_HANDLER_ID] = 0;
282     TA1CCR0 = 0;
283     TA1CCTL0 = 0;
284 }
285
286 /* -------- SRT-HAL INTERFACE -------- */
287
288 uint8_t Em_Hal_lock(void) {
289         uint8_t key = _get_interrupt_state();
290     #ifdef __GNUC__
291         __disable_interrupt();
292     #endif
293     #ifdef __TI_COMPILER_VERSION__
294         _disable_interrupt();
295     #endif
296         return key;
297 }
298
299 void Em_Hal_reset(void) {
300     uint8_t key = Em_Hal_lock();
301     EAP_RX_ACK_CLR();    // suspend the MCM
302     Hal_delay(100);
303     EAP_RX_ACK_SET();    // reset the MCM
304     Hal_delay(500);
305     EAP_RX_INT_CLR();
306     EAP_TX_INT_CLR();
307     EAP_TX_ACK_CLR();
308     EAP_RX_INT_ENABLE();
309     Em_Hal_unlock(key);
310 }
311
312 void Em_Hal_startSend() {
313     EAP_TX_BUF = Em_Message_startTx();
314 }
315
316 void Em_Hal_unlock(uint8_t key) {
317         _set_interrupt_state(key);
318 }
319
320 void Em_Hal_watchOff(void) {
321     UART_WATCH_DISABLE();
322 }
323
324 void Em_Hal_watchOn(void) {
325     UART_WATCH_ENABLE();
326 }
327
328
329 /* -------- INTERNAL FUNCTIONS -------- */
330
331 static void buttonHandler(uint8_t id) {
332     Hal_delay(BUTTON_DEBOUNCE_MSECS);
333     if (BUTTON_PRESSED() && appButtonHandler) {
334         appButtonHandler(id);
335     }
336     BUTTON_ENABLE();
337 }
338
339 static void postEvent(uint8_t handlerId) {
340     uint8_t key = Em_Hal_lock();
341     handlerEvents |= 1 << handlerId;
342     Em_Hal_unlock(key);
343 }
344
345 /* -------- INTERRUPT SERVICE ROUTINES -------- */
346
347 #ifdef __GNUC__
348     __attribute__((interrupt(PORT1_VECTOR)))
349 #endif
350 #ifdef __TI_COMPILER_VERSION__
351     #pragma vector=PORT1_VECTOR
352 #endif
353 INTERRUPT void buttonIsr(void) {
354     if (BUTTON_FIRED())
355         postEvent(BUTTON_HANDLER_ID);
356     BUTTON_DISABLE();
357     WAKEUP();
358 }
359
360 #ifdef __GNUC__
361     __attribute__((interrupt(EAP_RX_VECTOR)))
362 #endif
363 #ifdef __TI_COMPILER_VERSION__
364     #pragma vector=EAP_RX_VECTOR
365 #endif
366 INTERRUPT void rxIsr(void) {
367     uint8_t b = EAP_RX_BUF;
368     Em_Message_startRx();
369     EAP_RX_ACK_CLR();
370     EAP_RX_ACK_SET();
371     if (Em_Message_addByte(b)) {
372         postEvent(DISPATCH_HANDLER_ID);
373     }
374     WAKEUP();
375 }
376
377 #ifdef __GNUC__
378     __attribute__((interrupt(TIMER1_A0_VECTOR)))
379 #endif
380 #ifdef __TI_COMPILER_VERSION__
381     #pragma vector=TIMER1_A0_VECTOR
382 #endif
383 INTERRUPT void timerIsr(void) {
384     TA1CCR0 += clockTick;
385     postEvent(TICK_HANDLER_ID);
386     WAKEUP();
387 }
388
389 #ifdef __GNUC__
390     __attribute__((interrupt(EAP_TX_ACK_VECTOR)))
391 #endif
392 #ifdef __TI_COMPILER_VERSION__
393     #pragma vector=EAP_TX_ACK_VECTOR
394 #endif
395 INTERRUPT void txAckIsr(void) {
396     if (EAP_TX_ACK_TST()) {
397         uint8_t b;
398         if (Em_Message_getByte(&b)) {
399             EAP_TX_BUF = b;
400         }
401         EAP_TX_ACK_CLR();
402     }
403     WAKEUP();
404 }
405
406 #ifdef __GNUC__
407     __attribute__((interrupt(TIMER1_A1_VECTOR)))
408 #endif
409 #ifdef __TI_COMPILER_VERSION__
410     #pragma vector=TIMER1_A1_VECTOR
411 #endif
412 INTERRUPT void uartWatchdogIsr(void) {
413     switch (TA1IV) {
414     case  2:  // CCR1
415         UART_WATCH_DISABLE();
416         Em_Message_restart();
417         WAKEUP();
418         break;
419     }
420 }