//////////////////////////////////////////////////////////////////////////////
// Filename:          E:\bwy86\My_offices\lab/drivers/lcd_ip_v1_00_a/src/lcd_ip.h
// Version:           1.00.a
// Description:       lcd_ip Driver Header File
// Date:              Tue Nov 18 16:07:13 2008 (by Create and Import Peripheral Wizard)
//////////////////////////////////////////////////////////////////////////////

#ifndef LCD_IP_H
#define LCD_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 LCD_IP_USER_SLAVE_SPACE_OFFSET (0x00000000)
#define LCD_IP_SLAVE_REG0_OFFSET (LCD_IP_USER_SLAVE_SPACE_OFFSET + 0x00000000)

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


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

/**
 *
 * Write a value to a LCD_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 LCD_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 LCD_IP_mWriteReg(Xuint32 BaseAddress, unsigned RegOffset, Xuint32 Data)
 *
 */
#define LCD_IP_mWriteReg(BaseAddress, RegOffset, Data) \
 	XIo_Out32((BaseAddress) + (RegOffset), (Xuint32)(Data))

/**
 *
 * Read a value from a LCD_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 LCD_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 LCD_IP_mReadReg(Xuint32 BaseAddress, unsigned RegOffset)
 *
 */
#define LCD_IP_mReadReg(BaseAddress, RegOffset) \
 	XIo_In32((BaseAddress) + (RegOffset))


/**
 *
 * Write/Read value to/from LCD_IP user logic slave registers.
 *
 * @param   BaseAddress is the base address of the LCD_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 LCD_IP_mReadSlaveRegn(Xuint32 BaseAddress)
 *
 */
#define LCD_IP_mWriteSlaveReg0(BaseAddress, Value) \
 	XIo_Out32((BaseAddress) + (LCD_IP_SLAVE_REG0_OFFSET), (Xuint32)(Value))

#define LCD_IP_mReadSlaveReg0(BaseAddress) \
 	XIo_In32((BaseAddress) + (LCD_IP_SLAVE_REG0_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 LCD_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 LCD_IP_SelfTest(void * baseaddr_p);

#endif // LCD_IP_H