/home/kopmann/git-mirror/fdhwlib/fdhwlib/menable/menable.h File Reference

Go to the source code of this file.

Classes

• struct service_s

Typedefs

• typedef unsigned long microenable
• typedef unsigned long fpga_design
• typedef unsigned long eeprom
• typedef unsigned long readback_array
• typedef unsigned long xc_array
• typedef unsigned long short_info
• typedef unsigned long Idcode_struct
• typedef struct service_s service
• typedef int infofunc (int, int, int, void *, void **)
• typedef infofunc * pinfofunc

Enumerations

• enum ClkSource { DESIGN_CLK2, DESIGN_CLK, LOCAL_BUS_CLK, CLOCK_DISABLED }
• enum ResetState { RESET_OFF, RESET_ON }
• enum ClkState { UNLOCKED, LOCKED }

Functions

• microenable * initialize_microenable ()
• microenable * initialize_multienable (int nr)
• microenable * reinitialize_microenable ()
• microenable * reinitialize_multienable (int nr)
• int free_microenable (microenable *board)
• int init_microlib (char *)
• int map_runtime_base (microenable *board)
• int map_rombase (microenable *board)
• int unmap_runtime_base (microenable *board)
• int unmap_rombase (microenable *board)
• int map_plx_base (microenable *board)
• int map_fpga_base (microenable *board)
• int map_slave_base (microenable *board)
• int eeprom_readout (microenable *board)
• int load_my_eeprom (microenable *board, eeprom *eeprom_values)
• int init_abort (microenable *board)
• int init_expansion_rom (microenable *board)
• int init_slave_0 (microenable *board)
• int init_clk_system (microenable *board)
• fpga_design * load_design (microenable *, char *bin_file_name)
• int unload_design (fpga_design *design)
• int prepare_design (fpga_design *design)
• int configure_fpga (microenable *board, fpga_design *design)
• int readback_fpga (microenable *board, fpga_design *design)
• int ClkSelectRam0 (microenable *board, int nId)
• int ClkSelectRam1 (microenable *board, int nId)
• int set_cmc_clk (microenable *board, fpga_design *design, int sel)
• int set_fpga_clk (microenable *board, fpga_design *design, int freq)
• int set_fpga_clk_slow (microenable *board, fpga_design *design, int freq)
• int set_plx_clk (microenable *board, fpga_design *design, int freq)
• int get_plx_clk ()
• int get_fpga_clk (microenable *, fpga_design *)
• int set_slink_source (microenable *board)
• int set_slink_destination (microenable *board)
• HAP * read_hap (microenable *, char *file_name)
• unsigned long * GetAccessPointer (microenable *board)
• unsigned long * GetAccessPointerNC (microenable *board)
• int FreeAccessPointer ()
• unsigned long * GetRuntimeBase (microenable *board)
• unsigned long * GetServiceBase (microenable *pBoard)
• int LoadRbt (char *name, rbt_info **ri)
• int LoadBit (char *name, rbt_info **ri)
• int FreeRbt (rbt_info *ri)
• int WriteHapFileByName (char *name, rbt_info *ri)
• HapTagMaster * ReadDesignInfoFile (char *name)
• char * GetDesignName ()
• int CreateMultiHap (char *name)
• int ScanHapfile (char *filename, hapfile_index *index)
• int AddHapData (char *cpHapName, int nTag, HapData *data)
• HAP ReadMultiHap (microenable *board, char *file_name)
• char * Tag2String (unsigned long tag)
• int WriteDmaData (unsigned long *ptr, long len, microenable *board)
• int ReadDmaData (unsigned long *ptr, long len, microenable *board)
• int WriteDmaDataExt (unsigned long *ptr, long len, int chan, long offset, int inc, microenable *board)
• int ReadDmaDataExt (unsigned long *ptr, long len, int chan, long offset, int inc, microenable *board)
• int WriteDmaDataExtCut (unsigned long *ptr, long len, int chan, long offset, int inc, int maxline, int row_len, int eff_row_len, microenable *board)
• int DmaJpegExt (unsigned long *ptr_write, long write_len, unsigned long *ptr_read, long read_len, int maxline, int row_len, int eff_row_len, microenable *board)
• int WriteDmaDataExtCutline (unsigned long *ptr, long len, int chan, long offset, int inc, int maxline, int row_len, int eff_row_len, microenable *board)
• int WriteDmaDemandData (unsigned long *ptr, long len, int chan, long offset, int inc, microenable *board)
• int ReadDmaDemandData (unsigned long *ptr, long len, int chan, long offset, int inc, microenable *board)
• int DmaJpeg (unsigned long *ptr_write, long write_len, unsigned long *read_write, long read_len, microenable *board)
• int DmaVirtReadExtAsync (microenable *, int, int, int, dma_mem *, int, int, int, int)
• int DmaVirtWriteExtAsync (microenable *, int, int, int, dma_mem *, int, int, int, int)
• int DmaVirtWaitForBuffer (microenable *board, int chan, int subbufnum, dma_mem *mem, int timeout)
• int DmaVirtTestSubbufRdy (microenable *board, int chan, int subbufnum, dma_mem *mem)
• int DmaVirtTestBufStatus (microenable *board, int chan, dma_mem *mem)
• int DmaVirtStopTransfer (microenable *board, int nChan, int nMode)
• int DmaVirtStartRingbuf (microenable *pBoard, int nChan, int nDmaLength, int nOffset, dma_mem *pMem)
• int DmaVirtStopRingbuf (microenable *pBoard, int nChan)
• unsigned long GetDmaLength (microenable *board, dma_mem *pMem, int nSubbufNr)
• void Me_ClearErrMsg (microenable *board)
• void Me_SetErrMsg (microenable *board, char *)
• char * Me_GetErrMsg (microenable *board)
• int Me_GetErrCode (microenable *board)
• int SleepUntilInterrupt (microenable *board)
• int SetTimeout (microenable *board, int nr)
• int MMLock (unsigned long *ptr_write, long write_len, unsigned long *ptr_read, long read_len, microenable *board)
• int MMUnlock (microenable *board)
• dma_mem * MMSetVirtualBuffer (microenable *board, int size, int nr)
• int MMFreeVirtualBuffer (microenable *board, dma_mem *)
• dma_mem * MMSetPhysicalLineBuffer (microenable *board, int size, int nr, unsigned long, int, int)
• int activate_linto (microenable *board)
• int deactivate_linto (microenable *board)
• int InitReadback (const char *BaseName, unsigned int ChipType)
• unsigned int GetRegisterState (fpga_design *rdb_design, const char *Name, unsigned int from, unsigned int to)
• unsigned int GetPinState (fpga_design *rdb_design, const char *Name)
• int fpga2id (char *fpga)
• int package2id (char *package)
• int pn2id (char *pn)
• int id2fpga (char *fpga, int id)
• int id2package (char *package, int id)
• int id2pn (char *pn, int id)
• int get_next_serial (FILE *fserial)
• void get_info (FILE *fserial, short_info *info)
• void write_info (short_info *info, eeprom *my_eeprom, int serial)
• void write_eeprom_defaults (eeprom *my_eeprom)
• unsigned long nr_fpga (unsigned long pn)
• unsigned long nr_ram_blocks (unsigned long pn)
• unsigned long ram_type (unsigned long pn)
• unsigned long get_actual_date ()
• int get_dd_info (microenable *board, unsigned long *ptr)
• void printf_dd_info (unsigned long *ptr)
• char * GetActVersion ()
• char * FPGAtype2String (int FpgaID)
• int String2FPGAtype (char *fpga)
• int DetermineFPGAvendor (int FpgaID, char *VendorString)
• int DetermineFPGAfamily (int FpgaID, char *FPGAfamilyString)
• int DetermineFPGAinfo (int FpgaID, fpga_design *des)
• unsigned long DetermineFPGAidcode (int FpgaID)
• void EvaluateIdcode (unsigned long idcode, Idcode_struct *info)
• int TestFPGAbitstreamKompatibility (int FpgaID1, int FpgaID2)
• char * FPGAtype2RBTstring (int FpgaID)
• int RBTstring2FPGAtype (char *string)
• int GetRamSize (microenable *board)
• int GetFPGAtype (microenable *board)
• int GetSerialNumber (microenable *board)
• int GetBusNumber (microenable *board)
• int GetBoardVersion (microenable *board)
• int GetBoardRevision (microenable *board)
• int MeGetFpgaType (microenable *board)
• int CancelAllIo (microenable *board)
• int GetFPGAPackage (microenable *board)
• int GetFPGASpeedgrade (microenable *board)
• int GetNrOfFPGAs (microenable *board)
• int GetRamSpeed (microenable *board)
• int GetRamType (microenable *board)
• int GetInterruptNr (microenable *board)
• int check_dd_version (microenable *board, int *build, int *version)
• int GetTemperatureFPGA (microenable *board)
• int IsPowerInterrupt (microenable *board)
• int GetNrOfRegister (fpga_design *design)
• char * GetRegisterName (fpga_design *design, int nr)
• hap_register * GetRegisterByNumber (fpga_design *design, int nr)
• hap_register * GetRegisterByName (fpga_design *design, char *name)
• int RegisterWrite (microenable *pBoard, hap_register *hreg, unsigned long value)
• unsigned long RegisterRead (microenable *pBoard, hap_register *hreg)
• void setInterruptEvent (microenable *pBoard, void *event)

---

Typedef Documentation

typedef unsigned long eeprom

Definition at line 24 of file menable.h.

typedef unsigned long fpga_design

Definition at line 23 of file menable.h.

typedef unsigned long Idcode_struct

Definition at line 29 of file menable.h.

typedef int infofunc(int, int, int, void *, void **)

Definition at line 323 of file menable.h.

typedef unsigned long microenable

Definition at line 22 of file menable.h.

typedef infofunc* pinfofunc

Definition at line 324 of file menable.h.

typedef unsigned long readback_array

Definition at line 25 of file menable.h.

typedef struct service_s service

typedef unsigned long short_info

Definition at line 28 of file menable.h.

typedef unsigned long xc_array

Definition at line 26 of file menable.h.

---

Enumeration Type Documentation

enum ClkSource

Enumerator:

DESIGN_CLK2
DESIGN_CLK
LOCAL_BUS_CLK
CLOCK_DISABLED

Definition at line 123 of file menable.h.

{DESIGN_CLK2, DESIGN_CLK, LOCAL_BUS_CLK, CLOCK_DISABLED};

enum ClkState

Enumerator:

UNLOCKED
LOCKED

Definition at line 125 of file menable.h.

{UNLOCKED,  LOCKED};

enum ResetState

Enumerator:

RESET_OFF
RESET_ON

Definition at line 124 of file menable.h.

{RESET_OFF, RESET_ON};

---

Function Documentation

int activate_linto

(

microenable *

board

)

int AddHapData	(	char *	cpHapName,
		int	nTag,
		HapData *	data
	)

int CancelAllIo

(

microenable *

board

)

int check_dd_version	(	microenable *	board,
		int *	build,
		int *	version
	)

int ClkSelectRam0	(	microenable *	board,
		int	nId
	)

int ClkSelectRam1	(	microenable *	board,
		int	nId
	)

int configure_fpga	(	microenable *	board,
		fpga_design *	design
	)

int CreateMultiHap

(

char *

name

)

int deactivate_linto

(

microenable *

board

)

int DetermineFPGAfamily	(	int	FpgaID,
		char *	FPGAfamilyString
	)

unsigned long DetermineFPGAidcode

(

int

FpgaID

)

int DetermineFPGAinfo	(	int	FpgaID,
		fpga_design *	des
	)

int DetermineFPGAvendor	(	int	FpgaID,
		char *	VendorString
	)

int DmaJpeg	(	unsigned long *	ptr_write,
		long	write_len,
		unsigned long *	read_write,
		long	read_len,
		microenable *	board
	)

int DmaJpegExt	(	unsigned long *	ptr_write,
		long	write_len,
		unsigned long *	ptr_read,
		long	read_len,
		int	maxline,
		int	row_len,
		int	eff_row_len,
		microenable *	board
	)

int DmaVirtReadExtAsync	(	microenable *	,
		int	,
		int	,
		int	,
		dma_mem *	,
		int	,
		int	,
		int	,
		int
	)

int DmaVirtStartRingbuf	(	microenable *	pBoard,
		int	nChan,
		int	nDmaLength,
		int	nOffset,
		dma_mem *	pMem
	)

int DmaVirtStopRingbuf	(	microenable *	pBoard,
		int	nChan
	)

int DmaVirtStopTransfer	(	microenable *	board,
		int	nChan,
		int	nMode
	)

int DmaVirtTestBufStatus	(	microenable *	board,
		int	chan,
		dma_mem *	mem
	)

int DmaVirtTestSubbufRdy	(	microenable *	board,
		int	chan,
		int	subbufnum,
		dma_mem *	mem
	)

int DmaVirtWaitForBuffer	(	microenable *	board,
		int	chan,
		int	subbufnum,
		dma_mem *	mem,
		int	timeout
	)

int DmaVirtWriteExtAsync	(	microenable *	,
		int	,
		int	,
		int	,
		dma_mem *	,
		int	,
		int	,
		int	,
		int
	)

int eeprom_readout

(

microenable *

board

)

void EvaluateIdcode	(	unsigned long	idcode,
		Idcode_struct *	info
	)

int fpga2id

(

char *

fpga

)

char* FPGAtype2RBTstring

(

int

FpgaID

)

char* FPGAtype2String

(

int

FpgaID

)

int free_microenable

(

microenable *

board

)

int FreeAccessPointer

(

)

int FreeRbt

(

rbt_info *

ri

)

unsigned long get_actual_date

(

)

int get_dd_info	(	microenable *	board,
		unsigned long *	ptr
	)

int get_fpga_clk	(	microenable *	,
		fpga_design *
	)

void get_info	(	FILE *	fserial,
		short_info *	info
	)

int get_next_serial

(

FILE *

fserial

)

int get_plx_clk

(

)

unsigned long* GetAccessPointer

(

microenable *

board

)

unsigned long* GetAccessPointerNC

(

microenable *

board

)

char* GetActVersion

(

)

int GetBoardRevision

(

microenable *

board

)

int GetBoardVersion

(

microenable *

board

)

int GetBusNumber

(

microenable *

board

)

char* GetDesignName

(

)

unsigned long GetDmaLength	(	microenable *	board,
		dma_mem *	pMem,
		int	nSubbufNr
	)

int GetFPGAPackage

(

microenable *

board

)

int GetFPGASpeedgrade

(

microenable *

board

)

int GetFPGAtype

(

microenable *

board

)

int GetInterruptNr

(

microenable *

board

)

int GetNrOfFPGAs

(

microenable *

board

)

int GetNrOfRegister

(

fpga_design *

design

)

unsigned int GetPinState	(	fpga_design *	rdb_design,
		const char *	Name
	)

int GetRamSize

(

microenable *

board

)

int GetRamSpeed

(

microenable *

board

)

int GetRamType

(

microenable *

board

)

hap_register* GetRegisterByName	(	fpga_design *	design,
		char *	name
	)

hap_register* GetRegisterByNumber	(	fpga_design *	design,
		int	nr
	)

char* GetRegisterName	(	fpga_design *	design,
		int	nr
	)

unsigned int GetRegisterState	(	fpga_design *	rdb_design,
		const char *	Name,
		unsigned int	from,
		unsigned int	to
	)

unsigned long* GetRuntimeBase

(

microenable *

board

)

int GetSerialNumber

(

microenable *

board

)

unsigned long* GetServiceBase

(

microenable *

pBoard

)

int GetTemperatureFPGA

(

microenable *

board

)

int id2fpga	(	char *	fpga,
		int	id
	)

int id2package	(	char *	package,
		int	id
	)

int id2pn	(	char *	pn,
		int	id
	)

int init_abort

(

microenable *

board

)

int init_clk_system

(

microenable *

board

)

int init_expansion_rom

(

microenable *

board

)

int init_microlib

(

char *

)

int init_slave_0

(

microenable *

board

)

microenable* initialize_microenable

(

)

microenable* initialize_multienable

(

int

nr

)

int InitReadback	(	const char *	BaseName,
		unsigned int	ChipType
	)

int IsPowerInterrupt

(

microenable *

board

)

fpga_design* load_design	(	microenable *	,
		char *	bin_file_name
	)

int load_my_eeprom	(	microenable *	board,
		eeprom *	eeprom_values
	)

int LoadBit	(	char *	name,
		rbt_info **	ri
	)

int LoadRbt	(	char *	name,
		rbt_info **	ri
	)

int map_fpga_base

(

microenable *

board

)

int map_plx_base

(

microenable *

board

)

int map_rombase

(

microenable *

board

)

int map_runtime_base

(

microenable *

board

)

int map_slave_base

(

microenable *

board

)

void Me_ClearErrMsg

(

microenable *

board

)

int Me_GetErrCode

(

microenable *

board

)

char* Me_GetErrMsg

(

microenable *

board

)

void Me_SetErrMsg	(	microenable *	board,
		char *
	)

int MeGetFpgaType

(

microenable *

board

)

int MMFreeVirtualBuffer	(	microenable *	board,
		dma_mem *
	)

int MMLock	(	unsigned long *	ptr_write,
		long	write_len,
		unsigned long *	ptr_read,
		long	read_len,
		microenable *	board
	)

dma_mem* MMSetPhysicalLineBuffer	(	microenable *	board,
		int	size,
		int	nr,
		unsigned	long,
		int	,
		int
	)

dma_mem* MMSetVirtualBuffer	(	microenable *	board,
		int	size,
		int	nr
	)

int MMUnlock

(

microenable *

board

)

unsigned long nr_fpga

(

unsigned long

pn

)

unsigned long nr_ram_blocks

(

unsigned long

pn

)

int package2id

(

char *

package

)

int pn2id

(

char *

pn

)

int prepare_design

(

fpga_design *

design

)

void printf_dd_info

(

unsigned long *

ptr

)

unsigned long ram_type

(

unsigned long

pn

)

int RBTstring2FPGAtype

(

char *

string

)

HAP* read_hap	(	microenable *	,
		char *	file_name
	)

int readback_fpga	(	microenable *	board,
		fpga_design *	design
	)

HapTagMaster* ReadDesignInfoFile

(

char *

name

)

int ReadDmaData	(	unsigned long *	ptr,
		long	len,
		microenable *	board
	)

int ReadDmaDataExt	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		microenable *	board
	)

int ReadDmaDemandData	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		microenable *	board
	)

HAP ReadMultiHap	(	microenable *	board,
		char *	file_name
	)

unsigned long RegisterRead	(	microenable *	pBoard,
		hap_register *	hreg
	)

int RegisterWrite	(	microenable *	pBoard,
		hap_register *	hreg,
		unsigned long	value
	)

microenable* reinitialize_microenable

(

)

microenable* reinitialize_multienable

(

int

nr

)

int ScanHapfile	(	char *	filename,
		hapfile_index *	index
	)

int set_cmc_clk	(	microenable *	board,
		fpga_design *	design,
		int	sel
	)

int set_fpga_clk	(	microenable *	board,
		fpga_design *	design,
		int	freq
	)

int set_fpga_clk_slow	(	microenable *	board,
		fpga_design *	design,
		int	freq
	)

int set_plx_clk	(	microenable *	board,
		fpga_design *	design,
		int	freq
	)

int set_slink_destination

(

microenable *

board

)

int set_slink_source

(

microenable *

board

)

void setInterruptEvent	(	microenable *	pBoard,
		void *	event
	)

int SetTimeout	(	microenable *	board,
		int	nr
	)

int SleepUntilInterrupt

(

microenable *

board

)

int String2FPGAtype

(

char *

fpga

)

char* Tag2String

(

unsigned long

tag

)

int TestFPGAbitstreamKompatibility	(	int	FpgaID1,
		int	FpgaID2
	)

int unload_design

(

fpga_design *

design

)

int unmap_rombase

(

microenable *

board

)

int unmap_runtime_base

(

microenable *

board

)

void write_eeprom_defaults

(

eeprom *

my_eeprom

)

void write_info	(	short_info *	info,
		eeprom *	my_eeprom,
		int	serial
	)

int WriteDmaData	(	unsigned long *	ptr,
		long	len,
		microenable *	board
	)

int WriteDmaDataExt	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		microenable *	board
	)

int WriteDmaDataExtCut	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		int	maxline,
		int	row_len,
		int	eff_row_len,
		microenable *	board
	)

int WriteDmaDataExtCutline	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		int	maxline,
		int	row_len,
		int	eff_row_len,
		microenable *	board
	)

int WriteDmaDemandData	(	unsigned long *	ptr,
		long	len,
		int	chan,
		long	offset,
		int	inc,
		microenable *	board
	)

int WriteHapFileByName	(	char *	name,
		rbt_info *	ri
	)