clsim_lib.h

Go to the documentation of this file.

#ifndef _CLSIM_H_
#define _CLSIM_H_

#ifdef __cplusplus

extern "C" {

#endif

#ifdef DOXYGEN_SHOW_UNDOC

#endif

#define PDV_CLS_DEFAULT_HGAP    300
#define PDV_CLS_DEFAULT_VGAP    400
#define PDV_CLS_DEFAULT_FREQ    20.0

EDTAPI void pdv_cls_dump_state(PdvDev *pdv_p);

/********************************
 * Prints board geometry only to stdout.
 ********************************/

EDTAPI void pdv_cls_dump_geometry(PdvDev *pdv_p);

/****************************************
 * Initializes simulator values based on PdvDependent 
 * structure in \c pdv_p - normally filled in by clsiminit 
 * Assumes bitfile already loaded.
 ****************************************/

EDTAPI int pdv_cls_set_dep(PdvDev *pdv_p);

/****************************************
 * Checks for inconsistencies
 ****************************************/

EDTAPI int pdv_cls_dep_sanity_check(PdvDev *pdv_p);

/********************************************
 * Sets the width and height of the simulator frame 

 * taps is used to determine how many clocks per line
 * depth is currently always 8, but that may change in the future

 * There are two ways to set the total width and height including blanking:
 * If hblank is non-zero, the total line width is clocks + hblank 
 * otherwise it is the value passed in in totalwidth.
 * Likewise, if vblank is non-zero, the number of lines between frame valids is
 * height + vblank, otherwise it's the value passed in in totalheight
 ***********************************************/

EDTAPI void pdv_cls_set_size(PdvDev *pdv_p,
                int taps,
                int depth ,
                int width,
                int height,
                int hblank,
                int totalwidth,
                int vblank,
                int totalheight);

/* Set the values for fvalid, line valid, and read valid timing */
/* Defaults (if start and end are 0) are start = 0 and end = width/taps */

EDTAPI void pdv_cls_set_line_timing(PdvDev *pdv_p,
                int width,
                int taps,
                int Hfvstart,
                int Hfvend,
                int Hlvstart,
                int Hlvend,
                int Hrvstart,
                int Hrvend);

/************************************************
 *
 * Set individual control bits for simulator 
 *
 ************************************************/

EDTAPI void pdv_cls_set_linescan(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_lvcont(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_rven(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_uartloop(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_smallok(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_intlven(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_firstfc(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_datacnt(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_led(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_trigsrc(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_trigpol(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_trigframe(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_set_trigline(PdvDev *pdv_p, int state);

EDTAPI void pdv_cls_sim_start(PdvDev *pdv_p);

EDTAPI void pdv_cls_sim_stop(PdvDev *pdv_p);

EDTAPI void pdv_cls_init_serial(PdvDev *pdv_p);

EDTAPI void pdv_cls_set_height(PdvDev *pdv_p, int rasterlines, int vblank);
EDTAPI void pdv_cls_set_width(PdvDev *pdv_p, int width, int hblank);

EDTAPI void pdv_cls_set_clock(EdtDev *edt_p, double freq) ;

EDTAPI void pdv_cls_set_fill(PdvDev *pdv_p, u_char left, u_char right);

EDTAPI void pdv_cls_set_readvalid(PdvDev *pdv_p, 
                u_short HrvStart, u_short HrvEnd);

EDTAPI void pdv_cls_set_rven(PdvDev *pdv_p, int enable);

EDTAPI void pdv_cls_set_intlven(PdvDev *pdv_p, int enable);

EDTAPI void pdv_cls_set_led(PdvDev *pdv_p, int power_state);


EDTAPI void pdv_cls_setup_interleave(PdvDev *pdv_p,
                short tap0start, short tap0delta, 
                short tap1start, short tap1delta,
                short tap2start, short tap2delta,
                short tap3start, short tap3delta);

/*******************************
 * These compute the gap values based on the difference between
 * active clocks (hblank) or lines(vblank) and the total clocks or lines
 *******************************/

EDTAPI int pdv_cls_get_vgap(PdvDev *pdv_p);
EDTAPI int pdv_cls_get_hgap(PdvDev *pdv_p);

/* These are used by clsiminit if no value for blanking is specified */

#define PDV_CLS_DEFAULT_HGAP    300
#define PDV_CLS_DEFAULT_VGAP    400

/* Returns the computed frame time in milliseconds */

EDTAPI double pdv_cls_frame_time(PdvDev *pdv_p);

#ifdef DOXYGEN_SHOW_UNDOC
 /* end group cls */
#endif

#ifdef __cplusplus

}

#endif

#endif /* _CLSIM_H_ */

---