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

Go to the documentation of this file.

//+-------------------------------------------------------------------
//
//  
//  Copyright (C) Silicon Software GmbH, 1997-98.
//
//  File:       menable.h
//
//  Contents:   
//              
//
//
//--------------------------------------------------------------------

#ifndef __MENABLEH
#define __MENABLEH

#include <stdio.h>
#include "os_type.h"
#include "mem_siso.h"
#include "hap.h"

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 HAP;
typedef unsigned long short_info;
typedef unsigned long Idcode_struct;
//typedef unsigned long rbt_info;

typedef struct service_s {
        unsigned long version;
        unsigned long driver_version;
        int     build;
        unsigned long interrupt_count;
        long timer0;
        long timer1;
        long timer2;
        long timer3;
        unsigned long TimeCount;
        long timeout0;
        long timeout1;
        int  EventWaitSingleLoopTimeout0; 
        int  EventWaitSingleLoopTimeout1; 
        int  EventStopSingleLoopTimeout0; 
        int  EventStopSingleLoopTimeout1; 
        int  EventWCntStart0,EventWCntStop0;
        int  EventWCntStart1,EventWCntStop1;
        int   act_pic_cnt[2];
        int      err_cnt;
        char err_msg[1024];
} service;
//#include "fgrab.h"

#ifdef __cplusplus
extern "C" {
#endif


//#define COMPILE

#ifdef COMPILE
#define dlldir __declspec( dllexport)
#else
#define dlldir __declspec( dllimport)
#endif

// 
// Prototypes
//

//
// init and free
//

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*);

//
// Mapping
//

extern int map_runtime_base(microenable *board);
extern int map_rombase(microenable *board);
extern int unmap_runtime_base(microenable *board);
extern int unmap_rombase(microenable *board);

extern int map_plx_base(microenable *board);
extern int map_fpga_base(microenable *board);
extern int map_slave_base(microenable *board);
extern int eeprom_readout(microenable *board);
extern int load_my_eeprom(microenable *board, eeprom *eeprom_values);

//extern int (*reset)(microenable *board);
extern int init_abort(microenable *board);
extern int init_expansion_rom(microenable *board);
extern int init_slave_0(microenable *board);
extern int init_clk_system(microenable *board);

//
// Design prototypes
//

extern fpga_design *load_design(microenable*, char *bin_file_name);
extern int unload_design(fpga_design *design);
//extern int (*buf_expand)(fpga_design *design);
extern int prepare_design(fpga_design *design);
extern int configure_fpga(microenable *board, fpga_design *design);
extern int readback_fpga(microenable *board, fpga_design *design);

//
// Clock Functions
//

// ------------------------------------------------------------------------------ //
//   begin clock system
// ------------------------------------------------------------------------------ //
enum ClkSource  {DESIGN_CLK2, DESIGN_CLK, LOCAL_BUS_CLK, CLOCK_DISABLED};
enum ResetState {RESET_OFF, RESET_ON};
enum ClkState   {UNLOCKED,  LOCKED};

extern int ClkSelectRam0(microenable *board,int nId);
extern int ClkSelectRam1(microenable *board,int nId);

extern int load_my_eeprom(microenable *board, eeprom *eeprom_values);

//extern int (*reset)(microenable *board);
extern int init_abort(microenable *board);
extern int init_expansion_rom(microenable *board);
extern int init_slave_0(microenable *board);
extern int init_clk_system(microenable *board);

extern int set_cmc_clk(microenable *board, fpga_design *design,int sel);
extern int set_fpga_clk(microenable *board, fpga_design *design,int freq);
extern int set_fpga_clk_slow(microenable *board, fpga_design *design,int freq);
extern int set_plx_clk(microenable *board, fpga_design *design,int freq);

extern int get_plx_clk();
extern int get_fpga_clk(microenable*, fpga_design*);

extern int set_slink_source(microenable *board);
extern int set_slink_destination(microenable *board);

//
// RBT and Hap Files
//

extern HAP *read_hap(microenable*,char *file_name);
extern unsigned long *GetAccessPointer(microenable *board);
extern unsigned long *GetAccessPointerNC(microenable *board);
extern int FreeAccessPointer();
extern unsigned long *GetRuntimeBase(microenable *board);
extern unsigned long *GetServiceBase(microenable *pBoard);

extern int LoadRbt(char *name,rbt_info **ri);
extern int LoadBit(char *name,rbt_info **ri);
extern int FreeRbt(rbt_info *ri);
extern int WriteHapFileByName(char *name,rbt_info *ri);

extern HapTagMaster* ReadDesignInfoFile (char *name);
extern char* GetDesignName();

extern int CreateMultiHap(char *name);
extern int ScanHapfile(char *filename,hapfile_index *index);
extern int AddHapData(char *cpHapName,int nTag, HapData *data);
extern HAP ReadMultiHap(microenable *board,char *file_name);
extern char *Tag2String(unsigned long tag);

//
// Dma Functions
//

extern int WriteDmaData(unsigned long* ptr,long len,microenable *board);
extern int ReadDmaData(unsigned long* ptr,long len,microenable *board);
extern int WriteDmaDataExt(unsigned long* ptr,long len,int chan,long offset,int inc,microenable *board);
extern int ReadDmaDataExt(unsigned long* ptr,long len,int chan,long offset,int inc,microenable *board);
extern int WriteDmaDataExtCut(unsigned long* ptr,long len,int chan,long offset,int inc,int maxline,int row_len,int eff_row_len,microenable *board);
extern 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);
extern int WriteDmaDataExtCutline(unsigned long* ptr,long len,int chan,long offset,int inc,int maxline,int row_len,int eff_row_len,microenable *board);
extern int WriteDmaDemandData(unsigned long* ptr,long len,int chan,long offset,int inc,microenable *board);
extern int ReadDmaDemandData(unsigned long* ptr,long len,int chan,long offset,int inc,microenable *board);
extern int DmaJpeg(unsigned long* ptr_write,long write_len, unsigned long* read_write,long read_len,microenable *board);

extern int DmaVirtReadExtAsync(microenable*,int,int,int,dma_mem*,int,int,int,int);
extern int DmaVirtWriteExtAsync(microenable*,int,int,int,dma_mem*,int,int,int,int);
extern int DmaVirtWaitForBuffer(microenable *board,int chan,int subbufnum,dma_mem *mem,int timeout);
extern int DmaVirtTestSubbufRdy(microenable *board,int chan,int subbufnum,dma_mem *mem);
extern int DmaVirtTestBufStatus(microenable *board,int chan,dma_mem* mem);
extern int DmaVirtStopTransfer(microenable *board,int nChan,int nMode);
extern int DmaVirtStartRingbuf(microenable *pBoard,int nChan,int nDmaLength,int nOffset,dma_mem *pMem);
extern int DmaVirtStopRingbuf (microenable *pBoard,int nChan);

//
// Erweiterte DMA Funktionen
//

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

//
// Error Handling 
//

extern void Me_ClearErrMsg(microenable *board);
extern void Me_SetErrMsg(microenable *board,char *);
extern char *Me_GetErrMsg(microenable *board);
extern int  Me_GetErrCode(microenable *board);

//
// Interrupt
//

extern int SleepUntilInterrupt(microenable *board);
extern int SetTimeout(microenable *board,int nr);

// Das Locken von Speicher , Testfuctions

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

extern dma_mem* MMSetVirtualBuffer(microenable *board, int size,int nr);
extern int              MMFreeVirtualBuffer(microenable *board,dma_mem*);
extern dma_mem* MMSetPhysicalLineBuffer( microenable *board, int size,int nr,unsigned long,int,int);

// -----------------------------------------------------------
// Ausl~sen eines lokalen Interrupts

extern int activate_linto(microenable *board);
extern int deactivate_linto(microenable *board);

// -------------------------------------------------------------------------
// Readback Funktionen
//

extern int   InitReadback( const char* BaseName,unsigned int        ChipType);
extern unsigned int  GetRegisterState( fpga_design* rdb_design,const char* Name, unsigned int from,unsigned int to );
extern unsigned int  GetPinState( fpga_design* rdb_design,const char* Name );


// -------------------------------------------------------------------
//
// Info Strukturen
//

extern int      fpga2id(char *fpga);
extern int      package2id(char *package);
extern int      pn2id(char *pn);
extern int      id2fpga(char *fpga, int id);
extern int      id2package(char *package, int id);
extern int      id2pn(char *pn, int id);
extern int      get_next_serial(FILE *fserial);
extern void get_info(FILE *fserial, short_info *info);
extern void     write_info(short_info *info, eeprom *my_eeprom, int serial);
extern void write_eeprom_defaults(eeprom *my_eeprom);
extern unsigned long nr_fpga(unsigned long pn);
extern unsigned long nr_ram_blocks(unsigned long pn);
extern unsigned long ram_type(unsigned long pn);
extern unsigned long get_actual_date();
extern int       get_dd_info(microenable *board,unsigned long *ptr);
extern void      printf_dd_info(unsigned long *ptr);
extern char* GetActVersion();
extern char* FPGAtype2String(int FpgaID);
extern int       String2FPGAtype(char *fpga);
extern int   id2fpga(char *fpga, int id); 
extern int   fpga2id(char *fpga);
extern int   DetermineFPGAvendor(int FpgaID, char *VendorString);
extern int   DetermineFPGAfamily(int FpgaID, char *FPGAfamilyString);
extern int           DetermineFPGAinfo(int FpgaID, fpga_design *des);
extern unsigned long DetermineFPGAidcode(int FpgaID);
extern void          EvaluateIdcode(unsigned long idcode, Idcode_struct *info);
extern int               TestFPGAbitstreamKompatibility(int FpgaID1, int FpgaID2);
extern char*         FPGAtype2RBTstring(int FpgaID);
extern int           RBTstring2FPGAtype(char *string);
extern int           GetRamSize(microenable *board);
extern int           GetFPGAtype(microenable *board);
extern int           GetSerialNumber(microenable *board);
extern int           GetBusNumber(microenable *board);
extern int                       GetBoardVersion(microenable *board);
extern int                       GetBoardRevision(microenable *board);

extern int                       MeGetFpgaType(microenable *board);
extern int                       CancelAllIo(microenable *board);

extern int                       GetFPGAPackage(microenable *board);
extern int                       GetFPGASpeedgrade(microenable *board);
extern int                       GetNrOfFPGAs(microenable *board);
extern int                       GetRamSpeed(microenable *board);
extern int                       GetRamType(microenable *board);
extern int                       GetInterruptNr(microenable *board);

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

extern int                       GetTemperatureFPGA   (microenable *board );
extern int                       IsPowerInterrupt   (microenable *board );

// Register Schnittstelle

extern int                              GetNrOfRegister         (fpga_design* design);
extern char*                    GetRegisterName         (fpga_design* design,int nr);
extern hap_register*    GetRegisterByNumber     (fpga_design* design,int nr);
extern hap_register*    GetRegisterByName       (fpga_design* design,char *name);
extern int                          RegisterWrite               (microenable *pBoard,hap_register *hreg,unsigned long value);
extern unsigned long    RegisterRead            (microenable *pBoard,hap_register *hreg);

extern void setInterruptEvent(microenable *pBoard,void *event);

#define DLL_TYP                                         0x100
#define GET_FOR_MANUFACTOR_STRING       0x200
#define GETCAMERASTRING                         0x300
#define SETDLLPARAM                                     0x400

#define GET_NR_OF_GENFUNCS                      0x500
#define GET_GENFUNCNAME                         0x600
#define GET_NR_OF_PORTS                         0x700
#define GET_NR_OF_CAMS                          0x750
#define GET_VERSION                                     0x800

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

#ifdef __cplusplus
}
#endif

#endif