uart.h
Go to the documentation of this file.
1 #ifndef UART_H_
2 #define UART_H_
3 
4 //*****************************************************************************
5 //
8 //
9 //*****************************************************************************
10 
11 //*****************************************************************************
12 //
13 // If building with a C++ compiler, make all of the definitions in this header
14 // have a C binding.
15 //
16 //*****************************************************************************
17 #ifdef __cplusplus
18 extern "C"
19 {
20 #endif
21 
22 #include <stdint.h>
23 #include "register_remap.h"
24 #include <stdbool.h>
25 
26 #include <msp432.h>
27 #include "eusci.h"
28 
29 #define DEFAULT_SYNC 0x00
30 #define EUSCI_A_UART_AUTOMATICBAUDRATE_SYNC 0x55
31 
32 #define EUSCI_A_UART_NO_PARITY 0x00
33 #define EUSCI_A_UART_ODD_PARITY 0x01
34 #define EUSCI_A_UART_EVEN_PARITY 0x02
35 
36 #define EUSCI_A_UART_MSB_FIRST UCMSB
37 #define EUSCI_A_UART_LSB_FIRST 0x00
38 
39 #define EUSCI_A_UART_MODE UCMODE_0
40 #define EUSCI_A_UART_IDLE_LINE_MULTI_PROCESSOR_MODE UCMODE_1
41 #define EUSCI_A_UART_ADDRESS_BIT_MULTI_PROCESSOR_MODE UCMODE_2
42 #define EUSCI_A_UART_AUTOMATIC_BAUDRATE_DETECTION_MODE UCMODE_3
43 
44 #define EUSCI_A_UART_CLOCKSOURCE_SMCLK UCSSEL__SMCLK
45 #define EUSCI_A_UART_CLOCKSOURCE_ACLK UCSSEL__ACLK
46 
47 #define EUSCI_A_UART_ONE_STOP_BIT 0x00
48 #define EUSCI_A_UART_TWO_STOP_BITS UCSPB
49 
50 #define EUSCI_A_UART_OVERSAMPLING_BAUDRATE_GENERATION 0x01
51 #define EUSCI_A_UART_LOW_FREQUENCY_BAUDRATE_GENERATION 0x00
52 
53 #define EUSCI_A_UART_RECEIVE_INTERRUPT UCRXIE
54 #define EUSCI_A_UART_TRANSMIT_INTERRUPT UCTXIE
55 #define EUSCI_A_UART_RECEIVE_ERRONEOUSCHAR_INTERRUPT UCRXEIE
56 #define EUSCI_A_UART_BREAKCHAR_INTERRUPT UCBRKIE
57 #define EUSCI_A_UART_STARTBIT_INTERRUPT UCSTTIE
58 #define EUSCI_A_UART_TRANSMIT_COMPLETE_INTERRUPT UCTXCPTIE
59 
60 #define EUSCI_A_UART_RECEIVE_INTERRUPT_FLAG UCRXIFG
61 #define EUSCI_A_UART_TRANSMIT_INTERRUPT_FLAG UCTXIFG
62 #define EUSCI_A_UART_STARTBIT_INTERRUPT_FLAG UCSTTIFG
63 #define EUSCI_A_UART_TRANSMIT_COMPLETE_INTERRUPT_FLAG UCTXCPTIFG
64 
65 #define EUSCI_A_UART_LISTEN_ENABLE UCLISTEN
66 #define EUSCI_A_UART_FRAMING_ERROR UCFE
67 #define EUSCI_A_UART_OVERRUN_ERROR UCOE
68 #define EUSCI_A_UART_PARITY_ERROR UCPE
69 #define EUSCI_A_UART_BREAK_DETECT UCBRK
70 #define EUSCI_A_UART_RECEIVE_ERROR UCRXERR
71 #define EUSCI_A_UART_ADDRESS_RECEIVED UCADDR
72 #define EUSCI_A_UART_IDLELINE UCIDLE
73 #define EUSCI_A_UART_BUSY UCBUSY
74 
75 #define EUSCI_A_UART_DEGLITCH_TIME_2ns 0x00
76 #define EUSCI_A_UART_DEGLITCH_TIME_50ns UCGLIT0
77 #define EUSCI_A_UART_DEGLITCH_TIME_100ns UCGLIT1
78 #define EUSCI_A_UART_DEGLITCH_TIME_200ns (UCGLIT0 + UCGLIT1)
79 
80 
81 //*****************************************************************************
82 //
91 //
92 //*****************************************************************************
93 typedef struct _UART_config
94 {
95  uint_fast8_t selectClockSource;
96  uint_fast16_t clockPrescalar;
97  uint_fast8_t firstModReg;
98  uint_fast8_t secondModReg;
99  uint_fast8_t parity;
100  uint_fast16_t msborLsbFirst;
101  uint_fast16_t numberofStopBits;
102  uint_fast16_t uartMode;
103  uint_fast8_t overSampling;
104 } UART_Config;
105 
106 //*****************************************************************************
107 //
176 //
177 //*****************************************************************************
178 extern bool UART_initModule(uint32_t moduleInstance, const UART_Config *config);
179 
180 //*****************************************************************************
181 //
200 //
201 //*****************************************************************************
202 extern void UART_transmitData(uint32_t moduleInstance,
203  uint_fast8_t transmitData);
204 
205 //*****************************************************************************
206 //
225 //
226 //*****************************************************************************
227 extern uint8_t UART_receiveData(uint32_t moduleInstance);
228 
229 //*****************************************************************************
230 //
248 //
249 //*****************************************************************************
250 extern void UART_enableModule(uint32_t moduleInstance);
251 
252 //*****************************************************************************
253 //
271 //
272 //*****************************************************************************
273 extern void UART_disableModule(uint32_t moduleInstance);
274 
275 //*****************************************************************************
276 //
306 //
307 //*****************************************************************************
308 extern uint_fast8_t UART_queryStatusFlags(uint32_t moduleInstance,
309  uint_fast8_t mask);
310 
311 //*****************************************************************************
312 //
333 //
334 //*****************************************************************************
335 extern void UART_setDormant(uint32_t moduleInstance);
336 
337 //*****************************************************************************
338 //
356 //
357 //*****************************************************************************
358 extern void UART_resetDormant(uint32_t moduleInstance);
359 
360 //*****************************************************************************
361 //
379 //
380 //*****************************************************************************
381 extern void UART_transmitAddress(uint32_t moduleInstance,
382  uint_fast8_t transmitAddress);
383 
384 //*****************************************************************************
385 //
406 //
407 //*****************************************************************************
408 extern void UART_transmitBreak(uint32_t moduleInstance);
409 
410 //*****************************************************************************
411 //
428 //
429 //*****************************************************************************
430 extern uint32_t UART_getReceiveBufferAddressForDMA(uint32_t moduleInstance);
431 
432 //*****************************************************************************
433 //
450 //
451 //*****************************************************************************
452 extern uint32_t UART_getTransmitBufferAddressForDMA(uint32_t moduleInstance);
453 
454 //*****************************************************************************
455 //
479 //
480 //*****************************************************************************
481 extern void UART_selectDeglitchTime(uint32_t moduleInstance,
482  uint32_t deglitchTime);
483 
484 //*****************************************************************************
485 //
515 //
516 //*****************************************************************************
517 extern void UART_enableInterrupt(uint32_t moduleInstance, uint_fast8_t mask);
518 
519 //*****************************************************************************
520 //
549 //
550 //*****************************************************************************
551 extern void UART_disableInterrupt(uint32_t moduleInstance, uint_fast8_t mask);
552 
553 //*****************************************************************************
554 //
577 //
578 //*****************************************************************************
579 extern uint_fast8_t UART_getInterruptStatus(uint32_t moduleInstance, uint8_t mask);
580 
581 //*****************************************************************************
582 //
587 
602 //
603 //*****************************************************************************
604 extern uint_fast8_t UART_getEnabledInterruptStatus(uint32_t moduleInstance);
605 
606 //*****************************************************************************
607 //
631 //
632 //*****************************************************************************
633 extern void UART_clearInterruptFlag(uint32_t moduleInstance, uint_fast8_t mask);
634 
635 //*****************************************************************************
636 //
659 //
660 //*****************************************************************************
661 extern void UART_registerInterrupt(uint32_t moduleInstance,
662  void (*intHandler)(void));
663 
664 //*****************************************************************************
665 //
686 //
687 //*****************************************************************************
688 extern void UART_unregisterInterrupt(uint32_t moduleInstance);
689 
690 /* Backwards Compatibility Layer */
691 #define EUSCI_A_UART_transmitData UART_transmitData
692 #define EUSCI_A_UART_receiveData UART_receiveData
693 #define EUSCI_A_UART_enableInterrupt UART_enableInterrupt
694 #define EUSCI_A_UART_disableInterrupt UART_disableInterrupt
695 #define EUSCI_A_UART_getInterruptStatus UART_getInterruptStatus
696 #define EUSCI_A_UART_clearInterruptFlag UART_clearInterruptFlag
697 #define EUSCI_A_UART_enable UART_enableModule
698 #define EUSCI_A_UART_disable UART_disableModule
699 #define EUSCI_A_UART_queryStatusFlags UART_queryStatusFlags
700 #define EUSCI_A_UART_setDormant UART_setDormant
701 #define EUSCI_A_UART_resetDormant UART_resetDormant
702 #define EUSCI_A_UART_transmitAddress UART_transmitAddress
703 #define EUSCI_A_UART_transmitBreak UART_transmitBreak
704 #define EUSCI_A_UART_getReceiveBufferAddressForDMA UART_getReceiveBufferAddressForDMA
705 #define EUSCI_A_UART_getTransmitBufferAddressForDMA UART_getTransmitBufferAddressForDMA
706 #define EUSCI_A_UART_selectDeglitchTime UART_selectDeglitchTime
707 
708 //*****************************************************************************
709 //
710 // Mark the end of the C bindings section for C++ compilers.
711 //
712 //*****************************************************************************
713 #ifdef __cplusplus
714 }
715 #endif
716 
717 //*****************************************************************************
718 //
719 // Close the Doxygen group.
721 //
722 //*****************************************************************************
723 
724 #endif /* UART_H_ */
void UART_resetDormant(uint32_t moduleInstance)
Definition: uart.c:139
Configuration structure for compare mode in the UART module. See UART_initModule for parameter docume...
Definition: uart.h:93
uint_fast8_t UART_queryStatusFlags(uint32_t moduleInstance, uint_fast8_t mask)
Definition: uart.c:119
void UART_disableInterrupt(uint32_t moduleInstance, uint_fast8_t mask)
Definition: uart.c:223
void UART_selectDeglitchTime(uint32_t moduleInstance, uint32_t deglitchTime)
Definition: uart.c:183
bool UART_initModule(uint32_t moduleInstance, const UART_Config *config)
Definition: uart.c:6
void UART_transmitData(uint32_t moduleInstance, uint_fast8_t transmitData)
Definition: uart.c:87
uint_fast8_t parity
Definition: uart.h:99
void UART_unregisterInterrupt(uint32_t moduleInstance)
Definition: uart.c:333
uint_fast8_t UART_getInterruptStatus(uint32_t moduleInstance, uint8_t mask)
Definition: uart.c:248
uint_fast8_t selectClockSource
Definition: uart.h:95
uint_fast16_t numberofStopBits
Definition: uart.h:101
uint32_t UART_getReceiveBufferAddressForDMA(uint32_t moduleInstance)
Definition: uart.c:173
uint_fast16_t msborLsbFirst
Definition: uart.h:100
uint8_t UART_receiveData(uint32_t moduleInstance)
Definition: uart.c:97
uint_fast8_t overSampling
Definition: uart.h:103
uint_fast16_t uartMode
Definition: uart.h:102
void UART_enableInterrupt(uint32_t moduleInstance, uint_fast8_t mask)
Definition: uart.c:197
void UART_transmitBreak(uint32_t moduleInstance)
Definition: uart.c:153
void UART_clearInterruptFlag(uint32_t moduleInstance, uint_fast8_t mask)
Definition: uart.c:291
uint32_t UART_getTransmitBufferAddressForDMA(uint32_t moduleInstance)
Definition: uart.c:178
uint_fast8_t secondModReg
Definition: uart.h:98
struct _UART_config UART_Config
Type definition for _UART_config structure.
uint_fast16_t clockPrescalar
Definition: uart.h:96
void UART_transmitAddress(uint32_t moduleInstance, uint_fast8_t transmitAddress)
Definition: uart.c:144
uint_fast8_t UART_getEnabledInterruptStatus(uint32_t moduleInstance)
Definition: uart.c:260
void UART_setDormant(uint32_t moduleInstance)
Definition: uart.c:134
void UART_enableModule(uint32_t moduleInstance)
Definition: uart.c:107
void UART_registerInterrupt(uint32_t moduleInstance, void(*intHandler)(void))
Definition: uart.c:304
uint_fast8_t firstModReg
Definition: uart.h:97
void UART_disableModule(uint32_t moduleInstance)
Definition: uart.c:113

Copyright 2014, Texas Instruments Incorporated