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