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