/*****************************************************************************
* Filename:          C:\VIRTEX4\exercise5/drivers/multiply_v1_00_a/src/multiply.h
* Version:           1.00.a
* Description:       multiply Driver Header File
* Date:              Wed Oct 26 22:02:04 2011 (by Create and Import Peripheral Wizard)
*****************************************************************************/

#ifndef MULTIPLY_H
#define MULTIPLY_H

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

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

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


/**
 * User Logic Slave Space Offsets
 * -- SLV_REG0 : user logic slave module register 0
 * -- SLV_REG1 : user logic slave module register 1
 * -- SLV_REG2 : user logic slave module register 2
 */
#define MULTIPLY_USER_SLV_SPACE_OFFSET (0x00000000)
#define MULTIPLY_SLV_REG0_OFFSET (MULTIPLY_USER_SLV_SPACE_OFFSET + 0x00000000)
#define MULTIPLY_SLV_REG1_OFFSET (MULTIPLY_USER_SLV_SPACE_OFFSET + 0x00000004)
#define MULTIPLY_SLV_REG2_OFFSET (MULTIPLY_USER_SLV_SPACE_OFFSET + 0x00000008)

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


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

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

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


/**
 *
 * Write/Read 32 bit value to/from MULTIPLY user logic slave registers.
 *
 * @param   BaseAddress is the base address of the MULTIPLY device.
 * @param   RegOffset is the offset from the slave register to write to or read from.
 * @param   Value is the data written to the register.
 *
 * @return  Data is the data from the user logic slave register.
 *
 * @note
 * C-style signature:
 * 	void MULTIPLY_mWriteSlaveRegn(Xuint32 BaseAddress, unsigned RegOffset, Xuint32 Value)
 * 	Xuint32 MULTIPLY_mReadSlaveRegn(Xuint32 BaseAddress, unsigned RegOffset)
 *
 */
#define MULTIPLY_mWriteSlaveReg0(BaseAddress, RegOffset, Value) \
 	xil_io_out32((BaseAddress) + (MULTIPLY_SLV_REG0_OFFSET) + (RegOffset), (Xuint32)(Value))
#define MULTIPLY_mWriteSlaveReg1(BaseAddress, RegOffset, Value) \
 	xil_io_out32((BaseAddress) + (MULTIPLY_SLV_REG1_OFFSET) + (RegOffset), (Xuint32)(Value))
#define MULTIPLY_mWriteSlaveReg2(BaseAddress, RegOffset, Value) \
 	xil_io_out32((BaseAddress) + (MULTIPLY_SLV_REG2_OFFSET) + (RegOffset), (Xuint32)(Value))

#define MULTIPLY_mReadSlaveReg0(BaseAddress, RegOffset) \
 	xil_io_in32((BaseAddress) + (MULTIPLY_SLV_REG0_OFFSET) + (RegOffset))
#define MULTIPLY_mReadSlaveReg1(BaseAddress, RegOffset) \
 	xil_io_in32((BaseAddress) + (MULTIPLY_SLV_REG1_OFFSET) + (RegOffset))
#define MULTIPLY_mReadSlaveReg2(BaseAddress, RegOffset) \
 	xil_io_in32((BaseAddress) + (MULTIPLY_SLV_REG2_OFFSET) + (RegOffset))

/************************** 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 MULTIPLY 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 MULTIPLY_SelfTest(void * baseaddr_p);

#endif /** MULTIPLY_H */