xbrd_init.h File Reference

Defines the creation and initialization methods for the transition board interface. More...

#include "GNAT/xbrd_hw.h"
#include "GNAT/info.h"

Functions
unsigned int	xbrd_SizeOf (void)
	Hides the private implemenation of the xbrd registers. Allows user to allocate memory.
int	xbrd_Open (xbrdHandle gx, unsigned int physAddr)
	Initializes a xbrd handle.
int	xbrd_Init (xbrdHandle gx)
	Initializes transition board hardware.
int	xbrd_Close (xbrdHandle gx)
	shuts down the device attached to handle
int	xbrd_GetLogicalAddr (xbrdHandle gx, unsigned int *addr)
	returns the logical address attached to handle
int	xbrd_GetPhysAddr (xbrdHandle gx, unsigned int *addr)
	returns the physical address attached to handle
int	xbrd_PrintDriverInfo (xbrdHandle gx)
	prints XBRD driver info to stdout
int	xbrd_GetDriverInfo (DriverInfo *di)
	fills in driver info struct

---

Detailed Description

Defines the creation and initialization methods for the transition board interface.

Author:

Curt Brune -- curt@slac.stanford.edu

---

Function Documentation

int xbrd_Close

(

xbrdHandle

gx

)

shuts down the device attached to handle

Parameters:

gx

xbrd device handle

Returns:

OK if close successful

See also:

gOpen()

References G_OK, _xbrd::m_baseAddr, _xbrd::m_localAddr, _xbrd::m_physAddr, and XBRD_ERR_BAD_HANDLE.

int xbrd_GetDriverInfo

(

DriverInfo *

di

)

fills in driver info struct

Parameters:

di

pointer to storage to hold driver info

Returns:

G_OK on successs

References _driverInfo::compiler, _driverInfo::driverBuildDate, _driverInfo::driverDesc, _driverInfo::driverName, _driverInfo::driverVersion, _driverInfo::drvMajRevision, _driverInfo::drvMinRevision, _driverInfo::drvPatchLevel, G_OK, and GERR_BAD_PARAM.

Referenced by xbrd_PrintDriverInfo().

int xbrd_GetLogicalAddr	(	xbrdHandle	gx,
		unsigned int *	addr
	)

returns the logical address attached to handle

Parameters:

	gx	xbrd device handle
	addr	pointer to storage for holding logical address

Returns:

G_OK on successs

See also:

gOpen()

References G_OK, _xbrd::m_localAddr, XBRD_ERR_BAD_HANDLE, and XBRD_ERR_BAD_PARAM.

int xbrd_GetPhysAddr	(	xbrdHandle	gx,
		unsigned int *	addr
	)

returns the physical address attached to handle

Parameters:

	gx	xbrd device handle
	addr	pointer to storage for holding physical address

Returns:

G_OK on successs

See also:

gOpen()

References G_OK, _xbrd::m_physAddr, XBRD_ERR_BAD_HANDLE, and XBRD_ERR_BAD_PARAM.

int xbrd_Init

(

xbrdHandle

gx

)

Initializes transition board hardware.

Parameters:

gx

xbrd handle

Returns:

G_OK on success See source code for laundry list of initiailizations.

References _LOG, G_OK, GX_VERIFY_HANDLE, XBRD_ERR_BOARD_VERSION, and xbrd_Version().

int xbrd_Open	(	xbrdHandle	gx,
		unsigned int	physAddr
	)

Initializes a xbrd handle.

Parameters:

	gx	xbrd handle previously allocated
	physAddr	physical address of transition board

Returns:

OK for success

See also:

xbrd_Close()

References __xbrd_Open(), _CHECK, G_OK, and XBRD_ERR_BAD_HANDLE.

int xbrd_PrintDriverInfo

(

xbrdHandle

gx

)

prints XBRD driver info to stdout

Parameters:

gx

xbrd device handle

Returns:

G_OK on successs

References _driverInfo::compiler, _driverInfo::driverBuildDate, _driverInfo::driverDesc, _driverInfo::driverName, _driverInfo::driverVersion, _driverInfo::drvMajRevision, _driverInfo::drvMinRevision, _driverInfo::drvPatchLevel, G_OK, _xbrd::m_localAddr, _xbrd::m_physAddr, xbrd_GetDriverInfo(), xbrd_HWver(), and xbrd_SWver().

unsigned int xbrd_SizeOf

(

void

)

Hides the private implemenation of the xbrd registers. Allows user to allocate memory.

Returns:

the size of struct _xbrd

See also:

xbrd_Open()