367 lines
12 KiB
C
Executable File
367 lines
12 KiB
C
Executable File
/******************************************************************************
|
|
*
|
|
* (c) Copyright 2009-2011 Xilinx, Inc. All rights reserved.
|
|
*
|
|
* This file contains confidential and proprietary information of Xilinx, Inc.
|
|
* and is protected under U.S. and international copyright and other
|
|
* intellectual property laws.
|
|
*
|
|
* DISCLAIMER
|
|
* This disclaimer is not a license and does not grant any rights to the
|
|
* materials distributed herewith. Except as otherwise provided in a valid
|
|
* license issued to you by Xilinx, and to the maximum extent permitted by
|
|
* applicable law: (1) THESE MATERIALS ARE MADE AVAILABLE "AS IS" AND WITH ALL
|
|
* FAULTS, AND XILINX HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS,
|
|
* IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
|
|
* MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE;
|
|
* and (2) Xilinx shall not be liable (whether in contract or tort, including
|
|
* negligence, or under any other theory of liability) for any loss or damage
|
|
* of any kind or nature related to, arising under or in connection with these
|
|
* materials, including for any direct, or any indirect, special, incidental,
|
|
* or consequential loss or damage (including loss of data, profits, goodwill,
|
|
* or any type of loss or damage suffered as a result of any action brought by
|
|
* a third party) even if such damage or loss was reasonably foreseeable or
|
|
* Xilinx had been advised of the possibility of the same.
|
|
*
|
|
* CRITICAL APPLICATIONS
|
|
* Xilinx products are not designed or intended to be fail-safe, or for use in
|
|
* any application requiring fail-safe performance, such as life-support or
|
|
* safety devices or systems, Class III medical devices, nuclear facilities,
|
|
* applications related to the deployment of airbags, or any other applications
|
|
* that could lead to death, personal injury, or severe property or
|
|
* environmental damage (individually and collectively, "Critical
|
|
* Applications"). Customer assumes the sole risk and liability of any use of
|
|
* Xilinx products in Critical Applications, subject only to applicable laws
|
|
* and regulations governing limitations on product liability.
|
|
*
|
|
* THIS COPYRIGHT NOTICE AND DISCLAIMER MUST BE RETAINED AS PART OF THIS FILE
|
|
* AT ALL TIMES.
|
|
*
|
|
******************************************************************************/
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* @file xil_io.h
|
|
*
|
|
* This file contains the interface for the general IO component, which
|
|
* encapsulates the Input/Output functions for processors that do not
|
|
* require any special I/O handling.
|
|
*
|
|
* <pre>
|
|
* MODIFICATION HISTORY:
|
|
*
|
|
* Ver Who Date Changes
|
|
* ----- ---- -------- -------------------------------------------------------
|
|
* 3.00a hbm 07/28/09 Initial release
|
|
* 3.00a hbm 07/21/10 Added Xil_EndianSwap32/16, Xil_Htonl/s, Xil_Ntohl/s
|
|
* 3.03a sdm 08/18/11 Added INST_SYNC and DATA_SYNC macros.
|
|
* 3.07a asa 08/31/12 Added xil_printf.h include
|
|
*
|
|
* </pre>
|
|
*
|
|
* @note
|
|
*
|
|
* This file may contain architecture-dependent items.
|
|
*
|
|
******************************************************************************/
|
|
|
|
#ifndef XIL_IO_H /* prevent circular inclusions */
|
|
#define XIL_IO_H /* by using protection macros */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/***************************** Include Files *********************************/
|
|
|
|
#include "xil_types.h"
|
|
#include "mb_interface.h"
|
|
#include "xil_printf.h"
|
|
|
|
/************************** Constant Definitions *****************************/
|
|
|
|
/**************************** Type Definitions *******************************/
|
|
|
|
/***************** Macros (Inline Functions) Definitions *********************/
|
|
|
|
#if defined __GNUC__
|
|
# define INST_SYNC mbar(0)
|
|
# define DATA_SYNC mbar(1)
|
|
#else
|
|
# define INST_SYNC
|
|
# define DATA_SYNC
|
|
#endif /* __GNUC__ */
|
|
|
|
/*
|
|
* The following macros allow optimized I/O operations for memory mapped I/O.
|
|
* It should be noted that macros cannot be used if synchronization of the I/O
|
|
* operation is needed as it will likely break some code.
|
|
*/
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an input operation for an 8-bit memory location by reading from the
|
|
* specified address and returning the value read from that address.
|
|
*
|
|
* @param Addr contains the address to perform the input operation at.
|
|
*
|
|
* @return The value read from the specified input address.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_In8(Addr) (*(volatile u8 *)(Addr))
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an input operation for a 16-bit memory location by reading from the
|
|
* specified address and returning the value read from that address.
|
|
*
|
|
* @param Addr contains the address to perform the input operation at.
|
|
*
|
|
* @return The value read from the specified input address.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_In16(Addr) (*(volatile u16 *)(Addr))
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an input operation for a 32-bit memory location by reading from the
|
|
* specified address and returning the value read from that address.
|
|
*
|
|
* @param Addr contains the address to perform the input operation at.
|
|
*
|
|
* @return The value read from the specified input address.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_In32(Addr) (*(volatile u32 *)(Addr))
|
|
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an output operation for an 8-bit memory location by writing the
|
|
* specified value to the specified address.
|
|
*
|
|
* @param Addr contains the address to perform the output operation at.
|
|
* @param value contains the value to be output at the specified address.
|
|
*
|
|
* @return None
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Out8(Addr, Value) \
|
|
(*(volatile u8 *)((Addr)) = (Value))
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an output operation for a 16-bit memory location by writing the
|
|
* specified value to the specified address.
|
|
*
|
|
* @param Addr contains the address to perform the output operation at.
|
|
* @param value contains the value to be output at the specified address.
|
|
*
|
|
* @return None
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Out16(Addr, Value) \
|
|
(*(volatile u16 *)((Addr)) = (Value))
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform an output operation for a 32-bit memory location by writing the
|
|
* specified value to the specified address.
|
|
*
|
|
* @param addr contains the address to perform the output operation at.
|
|
* @param value contains the value to be output at the specified address.
|
|
*
|
|
* @return None
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Out32(Addr, Value) \
|
|
(*(volatile u32 *)((Addr)) = (Value))
|
|
|
|
|
|
extern u16 Xil_EndianSwap16(u16 Data);
|
|
extern u32 Xil_EndianSwap32(u32 Data);
|
|
|
|
#ifndef __LITTLE_ENDIAN__
|
|
extern u16 Xil_In16LE(u32 Addr);
|
|
extern u32 Xil_In32LE(u32 Addr);
|
|
extern void Xil_Out16LE(u32 Addr, u16 Value);
|
|
extern void Xil_Out32LE(u32 Addr, u32 Value);
|
|
|
|
/**
|
|
*
|
|
* Perform an big-endian input operation for a 16-bit memory location
|
|
* by reading from the specified address and returning the value read from
|
|
* that address.
|
|
*
|
|
* @param addr contains the address to perform the input operation at.
|
|
*
|
|
* @return The value read from the specified input address with the
|
|
* proper endianness. The return value has the same endianness
|
|
* as that of the processor, i.e. if the processor is
|
|
* little-engian, the return value is the byte-swapped value read
|
|
* from the address.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_In16BE(Addr) Xil_In16(Addr)
|
|
|
|
/**
|
|
*
|
|
* Perform a big-endian input operation for a 32-bit memory location
|
|
* by reading from the specified address and returning the value read from
|
|
* that address.
|
|
*
|
|
* @param Addr contains the address to perform the input operation at.
|
|
*
|
|
* @return The value read from the specified input address with the
|
|
* proper endianness. The return value has the same endianness
|
|
* as that of the processor, i.e. if the processor is
|
|
* little-engian, the return value is the byte-swapped value read
|
|
* from the address.
|
|
*
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_In32BE(Addr) Xil_In32(Addr)
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform a big-endian output operation for a 16-bit memory location
|
|
* by writing the specified value to the specified address.
|
|
*
|
|
* @param Addr contains the address to perform the output operation at.
|
|
* @param Value contains the value to be output at the specified address.
|
|
* The value has the same endianness as that of the processor.
|
|
* If the processor is little-endian, the byte-swapped value is
|
|
* written to the address.
|
|
*
|
|
*
|
|
* @return None
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Out16BE(Addr, Value) Xil_Out16(Addr, Value)
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Perform a big-endian output operation for a 32-bit memory location
|
|
* by writing the specified value to the specified address.
|
|
*
|
|
* @param Addr contains the address to perform the output operation at.
|
|
* @param Value contains the value to be output at the specified address.
|
|
* The value has the same endianness as that of the processor.
|
|
* If the processor is little-endian, the byte-swapped value is
|
|
* written to the address.
|
|
*
|
|
* @return None
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Out32BE(Addr, Value) Xil_Out32(Addr, Value)
|
|
|
|
#define Xil_Htonl(Data) (Data)
|
|
#define Xil_Htons(Data) (Data)
|
|
#define Xil_Ntohl(Data) (Data)
|
|
#define Xil_Ntohs(Data) (Data)
|
|
|
|
#else
|
|
|
|
extern u16 Xil_In16BE(u32 Addr);
|
|
extern u32 Xil_In32BE(u32 Addr);
|
|
extern void Xil_Out16BE(u32 Addr, u16 Value);
|
|
extern void Xil_Out32BE(u32 Addr, u32 Value);
|
|
|
|
#define Xil_In16LE(Addr) Xil_In16(Addr)
|
|
#define Xil_In32LE(Addr) Xil_In32(Addr)
|
|
#define Xil_Out16LE(Addr, Value) Xil_Out16(Addr, Value)
|
|
#define Xil_Out32LE(Addr, Value) Xil_Out32(Addr, Value)
|
|
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Convert a 32-bit number from host byte order to network byte order.
|
|
*
|
|
* @param Data the 32-bit number to be converted.
|
|
*
|
|
* @return The converted 32-bit number in network byte order.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Htonl(Data) Xil_EndianSwap32(Data)
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Convert a 16-bit number from host byte order to network byte order.
|
|
*
|
|
* @param Data the 16-bit number to be converted.
|
|
*
|
|
* @return The converted 16-bit number in network byte order.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Htons(Data) Xil_EndianSwap16(Data)
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Convert a 32-bit number from network byte order to host byte order.
|
|
*
|
|
* @param Value the 32-bit number to be converted.
|
|
*
|
|
* @return The converted 32-bit number in host byte order.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Ntohl(Data) Xil_EndianSwap32(Data)
|
|
|
|
/*****************************************************************************/
|
|
/**
|
|
*
|
|
* Convert a 16-bit number from network byte order to host byte order.
|
|
*
|
|
* @param Value the 16-bit number to be converted.
|
|
*
|
|
* @return The converted 16-bit number in host byte order.
|
|
*
|
|
* @note None.
|
|
*
|
|
******************************************************************************/
|
|
#define Xil_Ntohs(Data) Xil_EndianSwap16(Data)
|
|
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* end of protection macro */
|