uart.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. //*****************************************************************************
  2. //
  3. // uart.h - Defines and Macros for the UART.
  4. //
  5. // Copyright (c) 2005-2010 Texas Instruments Incorporated. All rights reserved.
  6. // Software License Agreement
  7. //
  8. // Texas Instruments (TI) is supplying this software for use solely and
  9. // exclusively on TI's microcontroller products. The software is owned by
  10. // TI and/or its suppliers, and is protected under applicable copyright
  11. // laws. You may not combine this software with "viral" open-source
  12. // software in order to form a larger program.
  13. //
  14. // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
  15. // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
  16. // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17. // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
  18. // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
  19. // DAMAGES, FOR ANY REASON WHATSOEVER.
  20. //
  21. // This is part of revision 6459 of the Stellaris Peripheral Driver Library.
  22. //
  23. //*****************************************************************************
  24. #ifndef __UART_H__
  25. #define __UART_H__
  26. //*****************************************************************************
  27. //
  28. // If building with a C++ compiler, make all of the definitions in this header
  29. // have a C binding.
  30. //
  31. //*****************************************************************************
  32. #ifdef __cplusplus
  33. extern "C"
  34. {
  35. #endif
  36. //*****************************************************************************
  37. //
  38. // Values that can be passed to UARTIntEnable, UARTIntDisable, and UARTIntClear
  39. // as the ulIntFlags parameter, and returned from UARTIntStatus.
  40. //
  41. //*****************************************************************************
  42. #define UART_INT_OE 0x400 // Overrun Error Interrupt Mask
  43. #define UART_INT_BE 0x200 // Break Error Interrupt Mask
  44. #define UART_INT_PE 0x100 // Parity Error Interrupt Mask
  45. #define UART_INT_FE 0x080 // Framing Error Interrupt Mask
  46. #define UART_INT_RT 0x040 // Receive Timeout Interrupt Mask
  47. #define UART_INT_TX 0x020 // Transmit Interrupt Mask
  48. #define UART_INT_RX 0x010 // Receive Interrupt Mask
  49. #define UART_INT_DSR 0x008 // DSR Modem Interrupt Mask
  50. #define UART_INT_DCD 0x004 // DCD Modem Interrupt Mask
  51. #define UART_INT_CTS 0x002 // CTS Modem Interrupt Mask
  52. #define UART_INT_RI 0x001 // RI Modem Interrupt Mask
  53. //*****************************************************************************
  54. //
  55. // Values that can be passed to UARTConfigSetExpClk as the ulConfig parameter
  56. // and returned by UARTConfigGetExpClk in the pulConfig parameter.
  57. // Additionally, the UART_CONFIG_PAR_* subset can be passed to
  58. // UARTParityModeSet as the ulParity parameter, and are returned by
  59. // UARTParityModeGet.
  60. //
  61. //*****************************************************************************
  62. #define UART_CONFIG_WLEN_MASK 0x00000060 // Mask for extracting word length
  63. #define UART_CONFIG_WLEN_8 0x00000060 // 8 bit data
  64. #define UART_CONFIG_WLEN_7 0x00000040 // 7 bit data
  65. #define UART_CONFIG_WLEN_6 0x00000020 // 6 bit data
  66. #define UART_CONFIG_WLEN_5 0x00000000 // 5 bit data
  67. #define UART_CONFIG_STOP_MASK 0x00000008 // Mask for extracting stop bits
  68. #define UART_CONFIG_STOP_ONE 0x00000000 // One stop bit
  69. #define UART_CONFIG_STOP_TWO 0x00000008 // Two stop bits
  70. #define UART_CONFIG_PAR_MASK 0x00000086 // Mask for extracting parity
  71. #define UART_CONFIG_PAR_NONE 0x00000000 // No parity
  72. #define UART_CONFIG_PAR_EVEN 0x00000006 // Even parity
  73. #define UART_CONFIG_PAR_ODD 0x00000002 // Odd parity
  74. #define UART_CONFIG_PAR_ONE 0x00000082 // Parity bit is one
  75. #define UART_CONFIG_PAR_ZERO 0x00000086 // Parity bit is zero
  76. //*****************************************************************************
  77. //
  78. // Values that can be passed to UARTFIFOLevelSet as the ulTxLevel parameter and
  79. // returned by UARTFIFOLevelGet in the pulTxLevel.
  80. //
  81. //*****************************************************************************
  82. #define UART_FIFO_TX1_8 0x00000000 // Transmit interrupt at 1/8 Full
  83. #define UART_FIFO_TX2_8 0x00000001 // Transmit interrupt at 1/4 Full
  84. #define UART_FIFO_TX4_8 0x00000002 // Transmit interrupt at 1/2 Full
  85. #define UART_FIFO_TX6_8 0x00000003 // Transmit interrupt at 3/4 Full
  86. #define UART_FIFO_TX7_8 0x00000004 // Transmit interrupt at 7/8 Full
  87. //*****************************************************************************
  88. //
  89. // Values that can be passed to UARTFIFOLevelSet as the ulRxLevel parameter and
  90. // returned by UARTFIFOLevelGet in the pulRxLevel.
  91. //
  92. //*****************************************************************************
  93. #define UART_FIFO_RX1_8 0x00000000 // Receive interrupt at 1/8 Full
  94. #define UART_FIFO_RX2_8 0x00000008 // Receive interrupt at 1/4 Full
  95. #define UART_FIFO_RX4_8 0x00000010 // Receive interrupt at 1/2 Full
  96. #define UART_FIFO_RX6_8 0x00000018 // Receive interrupt at 3/4 Full
  97. #define UART_FIFO_RX7_8 0x00000020 // Receive interrupt at 7/8 Full
  98. //*****************************************************************************
  99. //
  100. // Values that can be passed to UARTDMAEnable() and UARTDMADisable().
  101. //
  102. //*****************************************************************************
  103. #define UART_DMA_ERR_RXSTOP 0x00000004 // Stop DMA receive if UART error
  104. #define UART_DMA_TX 0x00000002 // Enable DMA for transmit
  105. #define UART_DMA_RX 0x00000001 // Enable DMA for receive
  106. //*****************************************************************************
  107. //
  108. // Values returned from UARTRxErrorGet().
  109. //
  110. //*****************************************************************************
  111. #define UART_RXERROR_OVERRUN 0x00000008
  112. #define UART_RXERROR_BREAK 0x00000004
  113. #define UART_RXERROR_PARITY 0x00000002
  114. #define UART_RXERROR_FRAMING 0x00000001
  115. //*****************************************************************************
  116. //
  117. // Values that can be passed to UARTHandshakeOutputsSet() or returned from
  118. // UARTHandshakeOutputGet().
  119. //
  120. //*****************************************************************************
  121. #define UART_OUTPUT_RTS 0x00000800
  122. #define UART_OUTPUT_DTR 0x00000400
  123. //*****************************************************************************
  124. //
  125. // Values that can be returned from UARTHandshakeInputsGet().
  126. //
  127. //*****************************************************************************
  128. #define UART_INPUT_RI 0x00000100
  129. #define UART_INPUT_DCD 0x00000004
  130. #define UART_INPUT_DSR 0x00000002
  131. #define UART_INPUT_CTS 0x00000001
  132. //*****************************************************************************
  133. //
  134. // Values that can be passed to UARTFlowControl() or returned from
  135. // UARTFlowControlGet().
  136. //
  137. //*****************************************************************************
  138. #define UART_FLOWCONTROL_TX 0x00008000
  139. #define UART_FLOWCONTROL_RX 0x00004000
  140. #define UART_FLOWCONTROL_NONE 0x00000000
  141. //*****************************************************************************
  142. //
  143. // Values that can be passed to UARTTxIntModeSet() or returned from
  144. // UARTTxIntModeGet().
  145. //
  146. //*****************************************************************************
  147. #define UART_TXINT_MODE_FIFO 0x00000000
  148. #define UART_TXINT_MODE_EOT 0x00000010
  149. //*****************************************************************************
  150. //
  151. // API Function prototypes
  152. //
  153. //*****************************************************************************
  154. extern void UARTParityModeSet(unsigned long ulBase, unsigned long ulParity);
  155. extern unsigned long UARTParityModeGet(unsigned long ulBase);
  156. extern void UARTFIFOLevelSet(unsigned long ulBase, unsigned long ulTxLevel,
  157. unsigned long ulRxLevel);
  158. extern void UARTFIFOLevelGet(unsigned long ulBase, unsigned long *pulTxLevel,
  159. unsigned long *pulRxLevel);
  160. extern void UARTConfigSetExpClk(unsigned long ulBase, unsigned long ulUARTClk,
  161. unsigned long ulBaud, unsigned long ulConfig);
  162. extern void UARTConfigGetExpClk(unsigned long ulBase, unsigned long ulUARTClk,
  163. unsigned long *pulBaud,
  164. unsigned long *pulConfig);
  165. extern void UARTEnable(unsigned long ulBase);
  166. extern void UARTDisable(unsigned long ulBase);
  167. extern void UARTFIFOEnable(unsigned long ulBase);
  168. extern void UARTFIFODisable(unsigned long ulBase);
  169. extern void UARTEnableSIR(unsigned long ulBase, tBoolean bLowPower);
  170. extern void UARTDisableSIR(unsigned long ulBase);
  171. extern tBoolean UARTCharsAvail(unsigned long ulBase);
  172. extern tBoolean UARTSpaceAvail(unsigned long ulBase);
  173. extern long UARTCharGetNonBlocking(unsigned long ulBase);
  174. extern long UARTCharGet(unsigned long ulBase);
  175. extern tBoolean UARTCharPutNonBlocking(unsigned long ulBase,
  176. unsigned char ucData);
  177. extern void UARTCharPut(unsigned long ulBase, unsigned char ucData);
  178. extern void UARTBreakCtl(unsigned long ulBase, tBoolean bBreakState);
  179. extern tBoolean UARTBusy(unsigned long ulBase);
  180. extern void UARTIntRegister(unsigned long ulBase, void(*pfnHandler)(void));
  181. extern void UARTIntUnregister(unsigned long ulBase);
  182. extern void UARTIntEnable(unsigned long ulBase, unsigned long ulIntFlags);
  183. extern void UARTIntDisable(unsigned long ulBase, unsigned long ulIntFlags);
  184. extern unsigned long UARTIntStatus(unsigned long ulBase, tBoolean bMasked);
  185. extern void UARTIntClear(unsigned long ulBase, unsigned long ulIntFlags);
  186. extern void UARTDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags);
  187. extern void UARTDMADisable(unsigned long ulBase, unsigned long ulDMAFlags);
  188. extern unsigned long UARTRxErrorGet(unsigned long ulBase);
  189. extern void UARTRxErrorClear(unsigned long ulBase);
  190. extern void UARTSmartCardEnable(unsigned long ulBase);
  191. extern void UARTSmartCardDisable(unsigned long ulBase);
  192. extern void UARTModemControlSet(unsigned long ulBase,
  193. unsigned long ulControl);
  194. extern void UARTModemControlClear(unsigned long ulBase,
  195. unsigned long ulControl);
  196. extern unsigned long UARTModemControlGet(unsigned long ulBase);
  197. extern unsigned long UARTModemStatusGet(unsigned long ulBase);
  198. extern void UARTFlowControlSet(unsigned long ulBase, unsigned long ulMode);
  199. extern unsigned long UARTFlowControlGet(unsigned long ulBase);
  200. extern void UARTTxIntModeSet(unsigned long ulBase, unsigned long ulMode);
  201. extern unsigned long UARTTxIntModeGet(unsigned long ulBase);
  202. //*****************************************************************************
  203. //
  204. // Several UART APIs have been renamed, with the original function name being
  205. // deprecated. These defines provide backward compatibility.
  206. //
  207. //*****************************************************************************
  208. #ifndef DEPRECATED
  209. #include "driverlib/sysctl.h"
  210. #define UARTConfigSet(a, b, c) \
  211. UARTConfigSetExpClk(a, SysCtlClockGet(), b, c)
  212. #define UARTConfigGet(a, b, c) \
  213. UARTConfigGetExpClk(a, SysCtlClockGet(), b, c)
  214. #define UARTCharNonBlockingGet(a) \
  215. UARTCharGetNonBlocking(a)
  216. #define UARTCharNonBlockingPut(a, b) \
  217. UARTCharPutNonBlocking(a, b)
  218. #endif
  219. //*****************************************************************************
  220. //
  221. // Mark the end of the C bindings section for C++ compilers.
  222. //
  223. //*****************************************************************************
  224. #ifdef __cplusplus
  225. }
  226. #endif
  227. #endif // __UART_H__