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