//////////////////////////////////////////////////////////////////////////////
// Filename:          F:\EDK\ip\MyProcessorIPLib/drivers/ip_v1_00_a/src/ip.h
// Version:           1.00.a
// Description:       ip Driver Header File
// Date:              Sat Apr 19 11:21:45 2008 (by Create and Import Peripheral Wizard)
//////////////////////////////////////////////////////////////////////////////

#ifndef IP_H
#define IP_H

/***************************** Include Files *******************************/

#include "xbasic_types.h"
#include "xstatus.h"
#include "xio.h"

/************************** Constant Definitions ***************************/


/**
 * User Logic Slave Space Offsets
 * -- SLAVE_REG0 : user logic slave module register 0
 */
#define IP_USER_SLAVE_SPACE_OFFSET (0x00000000)
#define IP_SLAVE_REG0_OFFSET (IP_USER_SLAVE_SPACE_OFFSET + 0x00000000)

/**
 * IPIF Reset/Mir Space Register Offsets
 * -- RST : software reset register
 * -- MIR : module identification register
 */
#define IP_IPIF_RST_SPACE_OFFSET (0x00000100)
#define IP_RST_OFFSET (IP_IPIF_RST_SPACE_OFFSET + 0x00000000)
#define IP_MIR_OFFSET (IP_IPIF_RST_SPACE_OFFSET + 0x00000000)

/**
 * IPIF Reset/Mir Masks
 * -- IPIF_MAVN_MASK   : module major version number
 * -- IPIF_MIVN_MASK   : module minor version number
 * -- IPIF_MIVL_MASK   : module minor version letter
 * -- IPIF_BID_MASK    : module block id
 * -- IPIF_BTP_MASK    : module block type
 * -- IPIF_RESET       : software reset
 */
#define IPIF_MAVN_MASK (0xF0000000UL)
#define IPIF_MIVN_MASK (0x0FE00000UL)
#define IPIF_MIVL_MASK (0x001F0000UL)
#define IPIF_BID_MASK (0x0000FF00UL)
#define IPIF_BTP_MASK (0x000000FFUL)
#define IPIF_RESET (0x0000000A)

/**************************** Type Definitions *****************************/


/***************** Macros (Inline Functions) Definitions *******************/

/**
 *
 * Write a value to a IP register. A 32 bit write is performed.
 * If the component is implemented in a smaller width, only the least
 * significant data is written.
 *
 * @param   BaseAddress is the base address of the IP device.
 * @param   RegOffset is the register offset from the base to write to.
 * @param   Data is the data written to the register.
 *
 * @return  None.
 *
 * @note
 * C-style signature:
 * 	void IP_mWriteReg(Xuint32 BaseAddress, unsigned RegOffset, Xuint32 Data)
 *
 */
#define IP_mWriteReg(BaseAddress, RegOffset, Data) \
 	XIo_Out32((BaseAddress) + (RegOffset), (Xuint32)(Data))

/**
 *
 * Read a value from a IP register. A 32 bit read is performed.
 * If the component is implemented in a smaller width, only the least
 * significant data is read from the register. The most significant data
 * will be read as 0.
 *
 * @param   BaseAddress is the base address of the IP device.
 * @param   RegOffset is the register offset from the base to write to.
 *
 * @return  Data is the data from the register.
 *
 * @note
 * C-style signature:
 * 	Xuint32 IP_mReadReg(Xuint32 BaseAddress, unsigned RegOffset)
 *
 */
#define IP_mReadReg(BaseAddress, RegOffset) \
 	XIo_In32((BaseAddress) + (RegOffset))


/**
 *
 * Write/Read value to/from IP user logic slave registers.
 *
 * @param   BaseAddress is the base address of the IP device.
 * @param   Value is the data written to the register.
 *
 * @return  Data is the data from the user logic slave register.
 *
 * @note
 * C-style signature:
 * 	Xuint32 IP_mReadSlaveRegn(Xuint32 BaseAddress)
 *
 */
#define IP_mWriteSlaveReg0(BaseAddress, Value) \
 	XIo_Out32((BaseAddress) + (IP_SLAVE_REG0_OFFSET), (Xuint32)(Value))

#define IP_mReadSlaveReg0(BaseAddress) \
 	XIo_In32((BaseAddress) + (IP_SLAVE_REG0_OFFSET))

/**
 *
 * Reset IP via software.
 *
 * @param   BaseAddress is the base address of the IP device.
 *
 * @return  None.
 *
 * @note
 * C-style signature:
 * 	void IP_mReset(Xuint32 BaseAddress)
 *
 */
#define IP_mReset(BaseAddress) \
 	XIo_Out32((BaseAddress)+(IP_RST_OFFSET), IPIF_RESET)

/**
 *
 * Read module identification information from IP device.
 *
 * @param   BaseAddress is the base address of the IP device.
 *
 * @return  None.
 *
 * @note
 * C-style signature:
 * 	Xuint32 IP_mReadMIR(Xuint32 BaseAddress)
 *
 */
#define IP_mReadMIR(BaseAddress) \
 	XIo_In32((BaseAddress)+(IP_MIR_OFFSET))

/************************** Function Prototypes ****************************/


/**
 *
 * Run a self-test on the driver/device. Note this may be a destructive test if
 * resets of the device are performed.
 *
 * If the hardware system is not built correctly, this function may never
 * return to the caller.
 *
 * @param   baseaddr_p is the base address of the IP instance to be worked on.
 *
 * @return
 *
 *    - XST_SUCCESS   if all self-test code passed
 *    - XST_FAILURE   if any self-test code failed
 *
 * @note    Caching must be turned off for this function to work.
 * @note    Self test may fail if data memory and device are not on the same bus.
 *
 */
XStatus IP_SelfTest(void * baseaddr_p);

#endif // IP_H