/****************************************************************************** * * Copyright (C) 2010 - 2014 Xilinx, Inc. All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * Use of the Software is limited solely to applications: * (a) running on a Xilinx device, or * (b) that interact with a Xilinx device through a bus or interconnect. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * * Except as contained in this notice, the name of the Xilinx shall not be used * in advertising or otherwise to promote the sale, use or other dealings in * this Software without prior written authorization from Xilinx. * ******************************************************************************/ /****************************************************************************/ /** * @file xuartps_low_echo_example.c * * This file contains a design example using the hardware interface. * * First, certain character sequence is output onto the terminal. Then any * characters typed in are echoed back, for letters, cases are switched. * An 'ESC' character terminates the execution of the example. * * This example requires an external SchmartModule to be connected to the * appropriate pins for the device through a daughter board. The test uses * the default settings of the device: * . baud rate of 9600 * . 8 bits data * . 1 stop bit * . no parity * * @note * The test hangs if communication channel from the user terminal to the device * is broken. * * MODIFICATION HISTORY: *
* Ver Who Date Changes * ----- ------ -------- ----------------------------------------------------- * 1.00a drg/jz 01/13/10 First release *****************************************************************************/ /***************************** Include Files *******************************/ #include "xparameters.h" #include "xstatus.h" #include "xil_types.h" #include "xil_assert.h" #include "xuartps_hw.h" /************************** Constant Definitions ***************************/ /* * The following constants map to the XPAR parameters created in the * xparameters.h file. They are defined here such that a user can easily * change all the needed parameters in one place. */ #define UART_BASEADDR XPAR_XUARTPS_0_BASEADDR #define UART_CLOCK_HZ XPAR_XUARTPS_0_CLOCK_HZ /* * The following constant controls the length of the buffers to be sent * and received with the device. This constant must be 32 bytes or less so the * entire buffer will fit into the TX and RX FIFOs of the device. */ #define TEST_BUFFER_SIZE 16 #define CHAR_ESC 0x1b /* 'ESC' character is used as terminator */ /**************************** Type Definitions *****************************/ /***************** Macros (Inline Functions) Definitions *******************/ /************************** Function Prototypes ****************************/ int UartPsEchoExample(u32 UartBaseAddress); /************************** Variable Definitions ***************************/ /* * The following buffers are used in this example to send and receive data * with the UART. */ u8 SendBuffer[TEST_BUFFER_SIZE]; /* Buffer for Transmitting Data */ /***************************************************************************/ /** * * Main function to call the Uart Echo example. * * @param None * * @return XST_SUCCESS if successful, XST_FAILURE if unsuccessful * * @note None * ****************************************************************************/ int main(void) { int Status; /* * Run the Uart Echo example , specify the Base Address that is * generated in xparameters.h */ Status = UartPsEchoExample(UART_BASEADDR); if (Status != XST_SUCCESS) { return XST_FAILURE; } return XST_SUCCESS; } /**************************************************************************/ /** * * This function does a minimal test on the UART device using the hardware * interface. * * @param UartBaseAddress is the base address of the device * * @return XST_SUCCESS if successful, XST_FAILURE if unsuccessful * * @note None. * **************************************************************************/ int UartPsEchoExample(u32 UartBaseAddress) { int Index; u32 Running; u8 RecvChar; u32 CntrlRegister; CntrlRegister = XUartPs_ReadReg(UartBaseAddress, XUARTPS_CR_OFFSET); /* * Enable TX and RX for the device */ XUartPs_WriteReg(UartBaseAddress, XUARTPS_CR_OFFSET, ((CntrlRegister & ~XUARTPS_CR_EN_DIS_MASK) | XUARTPS_CR_TX_EN | XUARTPS_CR_RX_EN)); /* * Initialize the send buffer bytes with a pattern to send and the * the receive buffer bytes to zero */ for (Index = 0; Index < TEST_BUFFER_SIZE; Index++) { SendBuffer[Index] = Index + '0'; } /* * Send the entire transmit buffer. */ for (Index = 0; Index < TEST_BUFFER_SIZE; Index++) { /* * Wait until there is space in TX FIFO */ while (XUartPs_IsTransmitFull(UartBaseAddress)); /* * Write the byte into the TX FIFO */ XUartPs_WriteReg(UartBaseAddress, XUARTPS_FIFO_OFFSET, SendBuffer[Index]); } Running = TRUE; while (Running) { /* * Wait until there is data */ while (!XUartPs_IsReceiveData(UartBaseAddress)); RecvChar = XUartPs_ReadReg(UartBaseAddress, XUARTPS_FIFO_OFFSET); /* Change the capitalization */ if (('a' <= RecvChar) && ('z' >= RecvChar)) { /* Convert the Capital letter to a small. */ RecvChar = RecvChar - 'a' + 'A'; } else if (('A' <= RecvChar) && ('Z' >= RecvChar)) { /* Convert the small letter to a Capital. */ RecvChar = RecvChar - 'A' + 'a'; } else if (CHAR_ESC == RecvChar) { Running = FALSE; } /* Echo the character back */ XUartPs_WriteReg(UartBaseAddress, XUARTPS_FIFO_OFFSET, RecvChar); } return XST_SUCCESS; }