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