Rev 1 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | ingob | 1 | /******************** (C) COPYRIGHT 2006 STMicroelectronics ******************** |
| 2 | * File Name : 91x_uart.h |
||
| 3 | * Author : MCD Application Team |
||
| 4 | * Date First Issued : 05/18/2006 : Version 1.0 |
||
| 5 | * Description : This file contains all the functions prototypes for the |
||
| 6 | * UART software library. |
||
| 7 | ******************************************************************************** |
||
| 8 | * History: |
||
| 9 | * 05/22/2007 : Version 1.2 |
||
| 10 | * 05/24/2006 : Version 1.1 |
||
| 11 | * 05/18/2006 : Version 1.0 |
||
| 12 | ******************************************************************************** |
||
| 13 | * THE PRESENT SOFTWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS |
||
| 14 | * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. |
||
| 15 | * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, |
||
| 16 | * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE |
||
| 17 | * CONTENT OF SUCH SOFTWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING |
||
| 18 | * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. |
||
| 19 | *******************************************************************************/ |
||
| 20 | |||
| 21 | /* Define to prevent recursive inclusion -------------------------------------*/ |
||
| 22 | #ifndef __91x_UART_H |
||
| 23 | #define __91x_UART_H |
||
| 24 | |||
| 25 | /* Includes ------------------------------------------------------------------*/ |
||
| 26 | #include <91x_map.h> |
||
| 27 | |||
| 28 | /* Exported types ------------------------------------------------------------*/ |
||
| 29 | /* UART FIFO Level enumeration */ |
||
| 30 | typedef enum |
||
| 31 | { |
||
| 32 | UART_FIFOLevel_1_8 = 0x0000, /* FIFO size 16 bytes, FIFO level 2 bytes */ |
||
| 33 | UART_FIFOLevel_1_4 = 0x0001, /* FIFO size 16 bytes, FIFO level 4 bytes */ |
||
| 34 | UART_FIFOLevel_1_2 = 0x0002, /* FIFO size 16 bytes, FIFO level 8 bytes */ |
||
| 35 | UART_FIFOLevel_3_4 = 0x0003, /* FIFO size 16 bytes, FIFO level 12 bytes */ |
||
| 36 | UART_FIFOLevel_7_8 = 0x0004 /* FIFO size 16 bytes, FIFO level 14 bytes */ |
||
| 37 | }UART_FIFOLevel; |
||
| 38 | |||
| 39 | /* UART Init Structure definition */ |
||
| 40 | typedef struct |
||
| 41 | { |
||
| 42 | u16 UART_WordLength; |
||
| 43 | u16 UART_StopBits; |
||
| 44 | u16 UART_Parity; |
||
| 45 | u32 UART_BaudRate; |
||
| 46 | u16 UART_HardwareFlowControl; |
||
| 47 | u16 UART_Mode; |
||
| 48 | u16 UART_FIFO; |
||
| 49 | UART_FIFOLevel UART_TxFIFOLevel; |
||
| 50 | UART_FIFOLevel UART_RxFIFOLevel; |
||
| 51 | }UART_InitTypeDef; |
||
| 52 | |||
| 53 | |||
| 54 | /* UART RTS enumeration */ |
||
| 55 | typedef enum |
||
| 56 | { |
||
| 57 | LowLevel = 0, |
||
| 58 | HighLevel |
||
| 59 | }UART_LevelTypeDef; |
||
| 60 | |||
| 61 | /* Exported constants --------------------------------------------------------*/ |
||
| 62 | /* UART Data Length */ |
||
| 63 | #define UART_WordLength_5D 0x0000 /* 5 bits Data */ |
||
| 64 | #define UART_WordLength_6D 0x0020 /* 6 bits Data */ |
||
| 65 | #define UART_WordLength_7D 0x0040 /* 7 bits Data */ |
||
| 66 | #define UART_WordLength_8D 0x0060 /* 8 bits Data */ |
||
| 67 | |||
| 68 | /* UART Stop Bits */ |
||
| 69 | #define UART_StopBits_1 0xFFF7 /* Disable two stop bit is transmitted |
||
| 70 | at the end of frame */ |
||
| 71 | #define UART_StopBits_2 0x0008 /* Enable Two stop bits are transmitted |
||
| 72 | at the end of frame */ |
||
| 73 | /* UART Parity */ |
||
| 74 | #define UART_Parity_No 0x0000 /* Parity Disable */ |
||
| 75 | #define UART_Parity_Even 0x0006 /* Even Parity */ |
||
| 76 | #define UART_Parity_Odd 0x0002 /* Odd Parity */ |
||
| 77 | #define UART_Parity_OddStick 0x0082 /* 1 is transmitted as bit parity */ |
||
| 78 | #define UART_Parity_EvenStick 0x0086 /* 0 is transmitted as bit parity */ |
||
| 79 | |||
| 80 | /* UART Hardware Flow Control */ |
||
| 81 | #define UART_HardwareFlowControl_None 0x0000 /* HFC Disable */ |
||
| 82 | #define UART_HardwareFlowControl_RTS 0x4000 /* RTS Enable */ |
||
| 83 | #define UART_HardwareFlowControl_CTS 0x8000 /* CTS Enable */ |
||
| 84 | #define UART_HardwareFlowControl_RTS_CTS 0xC000 /* CTS and RTS Enable */ |
||
| 85 | |||
| 86 | /* UART Mode */ |
||
| 87 | #define UART_Mode_Rx 0x0200 /* UART Rx Enabled */ |
||
| 88 | #define UART_Mode_Tx 0x0100 /* UART Tx Enbled */ |
||
| 89 | #define UART_Mode_Tx_Rx 0x0300 /* UART Tx and Rx Enabled */ |
||
| 90 | |||
| 91 | /* UART FIFO */ |
||
| 92 | #define UART_FIFO_Disable 0xFFEF /* FIFOs Disable */ |
||
| 93 | #define UART_FIFO_Enable 0x0010 /* FIFOs Enable */ |
||
| 94 | |||
| 95 | /* UART Interrupt definition */ |
||
| 96 | #define UART_IT_OverrunError 0x0400 /* Overrun Error interrupt mask */ |
||
| 97 | #define UART_IT_BreakError 0x0200 /* Break Error interrupt mask */ |
||
| 98 | #define UART_IT_ParityError 0x0100 /* Parity Error interrupt mask */ |
||
| 99 | #define UART_IT_FrameError 0x0080 /* Frame Error interrupt mask */ |
||
| 100 | #define UART_IT_ReceiveTimeOut 0x0040 /* Receive Time Out interrupt mask */ |
||
| 101 | #define UART_IT_Transmit 0x0020 /* Transmit interrupt mask */ |
||
| 102 | #define UART_IT_Receive 0x0010 /* Receive interrupt mask */ |
||
| 103 | #define UART_IT_DSR 0x0008 /* DSR interrupt mask */ |
||
| 104 | #define UART_IT_DCD 0x0004 /* DCD interrupt mask */ |
||
| 105 | #define UART_IT_CTS 0x0002 /* CTS interrupt mask */ |
||
| 106 | #define UART_IT_RI 0x0001 /* RI interrupt mask */ |
||
| 107 | |||
| 108 | /* UART DMA On Error */ |
||
| 109 | #define UART_DMAOnError_Enable 0xFFFB /* DMA receive request enabled |
||
| 110 | when the UART error interrupt |
||
| 111 | is asserted. */ |
||
| 112 | #define UART_DMAOnError_Disable 0x0004 /* DMA receive request disabled |
||
| 113 | when the UART error interrupt |
||
| 114 | is asserted. */ |
||
| 115 | /* UART DMA Request */ |
||
| 116 | #define UART_DMAReq_Tx 0x02 /* Transmit DMA Enable */ |
||
| 117 | #define UART_DMAReq_Rx 0x01 /* Receive DMA Enable */ |
||
| 118 | |||
| 119 | /* UART FLAG */ |
||
| 120 | #define UART_FLAG_OverrunError 0x23 /* Overrun error flag */ |
||
| 121 | #define UART_FLAG_Break 0x22 /* break error flag */ |
||
| 122 | #define UART_FLAG_ParityError 0x21 /* parity error flag */ |
||
| 123 | #define UART_FLAG_FrameError 0x20 /* frame error flag */ |
||
| 124 | #define UART_FLAG_RI 0x48 /* RI flag */ |
||
| 125 | #define UART_FLAG_TxFIFOEmpty 0x47 /* Transmit FIFO Empty flag */ |
||
| 126 | #define UART_FLAG_RxFIFOFull 0x46 /* Receive FIFO Full flag */ |
||
| 127 | #define UART_FLAG_TxFIFOFull 0x45 /* Transmit FIFO Full flag */ |
||
| 128 | #define UART_FLAG_RxFIFOEmpty 0x44 /* Receive FIFO Empty flag */ |
||
| 129 | #define UART_FLAG_Busy 0x43 /* UART Busy flag */ |
||
| 130 | #define UART_FLAG_DCD 0x42 /* DCD flag */ |
||
| 131 | #define UART_FLAG_DSR 0x41 /* DSR flag */ |
||
| 132 | #define UART_FLAG_CTS 0x40 /* CTS flag */ |
||
| 133 | #define UART_RawIT_OverrunError 0x6A /* Overrun Error Raw IT flag */ |
||
| 134 | #define UART_RawIT_BreakError 0x69 /* Break Error Raw IT flag */ |
||
| 135 | #define UART_RawIT_ParityError 0x68 /* Parity Error Raw IT flag */ |
||
| 136 | #define UART_RawIT_FrameError 0x67 /* Frame Error Raw IT flag */ |
||
| 137 | #define UART_RawIT_ReceiveTimeOut 0x66 /* ReceiveTimeOut Raw IT flag */ |
||
| 138 | #define UART_RawIT_Transmit 0x65 /* Transmit Raw IT flag */ |
||
| 139 | #define UART_RawIT_Receive 0x64 /* Receive Raw IT flag */ |
||
| 140 | #define UART_RawIT_DSR 0x63 /* DSR Raw IT flag */ |
||
| 141 | #define UART_RawIT_DCD 0x62 /* DCD Raw IT flag */ |
||
| 142 | #define UART_RawIT_CTS 0x61 /* CTS Raw IT flag */ |
||
| 143 | #define UART_RawIT_RI 0x60 /* RI Raw IT flag */ |
||
| 144 | |||
| 145 | /*IrDAx select*/ |
||
| 146 | #define IrDA0 0x01 /*IrDA0 select*/ |
||
| 147 | #define IrDA1 0x02 /*IrDA0 select*/ |
||
| 148 | #define IrDA2 0x03 /*IrDA0 select*/ |
||
| 149 | |||
| 150 | /* Exported macro ------------------------------------------------------------*/ |
||
| 151 | /* Exported functions ------------------------------------------------------- */ |
||
| 152 | void UART_DeInit(UART_TypeDef* UARTx); |
||
| 153 | void UART_Init(UART_TypeDef* UARTx, UART_InitTypeDef* UART_InitStruct); |
||
| 154 | void UART_StructInit(UART_InitTypeDef* UART_InitStruct); |
||
| 155 | void UART_Cmd(UART_TypeDef* UARTx, FunctionalState NewState); |
||
| 156 | void UART_ITConfig(UART_TypeDef* UARTx, u16 UART_IT, FunctionalState NewState); |
||
| 157 | void UART_DMAConfig(UART_TypeDef* UARTx, u16 UART_DMAOnError); |
||
| 158 | void UART_DMACmd(UART_TypeDef* UARTx, u8 UART_DMAReq, FunctionalState NewState); |
||
| 159 | void UART_LoopBackConfig(UART_TypeDef* UARTx, FunctionalState NewState); |
||
| 160 | FlagStatus UART_GetFlagStatus(UART_TypeDef* UARTx, u16 UART_FLAG); |
||
| 161 | void UART_ClearFlag(UART_TypeDef* UARTx); |
||
| 162 | void UART_ClearITPendingBit(UART_TypeDef* UARTx, u16 UART_IT); |
||
| 163 | void UART_IrDALowPowerConfig(u8 IrDAx, FunctionalState NewState); |
||
| 164 | void UART_IrDACmd(u8 IrDAx, FunctionalState NewState); |
||
| 165 | void UART_IrDASetCounter(u8 IrDAx, u32 IrDA_Counter); |
||
| 166 | void UART_SendData(UART_TypeDef* UARTx, u8 Data); |
||
| 167 | u8 UART_ReceiveData(UART_TypeDef* UARTx); |
||
| 168 | void UART_SendBreak(UART_TypeDef* UARTx); |
||
| 169 | void UART_DTRConfig(UART_LevelTypeDef LevelState); |
||
| 170 | void UART_RTSConfig(UART_LevelTypeDef LevelState); |
||
| 171 | ITStatus UART_GetITStatus(UART_TypeDef* UARTx, u16 UART_IT); |
||
| 172 | |||
| 173 | #endif /* __91x_UART_H */ |
||
| 174 | |||
| 175 | /******************* (C) COPYRIGHT 2006 STMicroelectronics *****END OF FILE****/ |