UART: Start adding UART code
[keystone-rtos/ibl.git] / src / hw / uart / c66x_uart / evmc66x_uart.h
1 /******************************************************************************
2  * Copyright (c) 2011 Texas Instruments Incorporated - http://www.ti.com
3  * 
4  *  Redistribution and use in source and binary forms, with or without 
5  *  modification, are permitted provided that the following conditions 
6  *  are met:
7  *
8  *    Redistributions of source code must retain the above copyright 
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  *    Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the 
13  *    documentation and/or other materials provided with the   
14  *    distribution.
15  *
16  *    Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
24  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
25  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
26  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
29  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
30  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  * 
32  *****************************************************************************/
33  
34 /****************************************************************************** 
35  *
36  * File Name:   evmc66x_i2c_uart.h
37  *
38  * Description: This contains UART specific structure, typedefs, function
39  *              prototypes.
40  *
41  ******************************************************************************/
42 #ifndef _EVM66X_I2C_UART_H_
43 #define _EVM66X_I2C_UART_H_
45 /************************
46  * Defines and Macros
47  ************************/
48 // Mask to enable DLL and DLM
49 #define DLAB            (0x80)                  // Way to swap mem banks
51 // for 19200 baudrate for crystal clock 14.7456 MHz
52 #define DLL_VAL         (0x30)
53 #define DLM_VAL         (0x00)
55 // Macros to be used for setting baudrate
56 #define BAUD_RATE_9600          (0x0060)
57 #define BAUD_RATE_19200         (0x0030)
58 #define BAUD_RATE_56000         (0x0010)
59 #define BAUD_RATE_115200        (0x0008)
61 #define hUartRegs    ((CSL_UartRegs*) CSL_UART_REGS)
64 /************************
65  * Function declarations
66 ************************/
67 void UartInit(void);
68 void UartSetBaudRate(uint16_t uiBaudRate);
69 uint16_t UartReadBaudRate(void);
70 uint8_t UartReadData(void);
71 void UartWriteData(uint8_t uchByte);
72 Bool UartIsDataReady(void);
73 #endif // _EVM66X_I2C_UART_H_