include/xilinx.h

   1 /*
   2  * (C) Copyright 2002
   3  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <fpga.h>
   9
  10 #ifndef _XILINX_H_
  11 #define _XILINX_H_
  12
  13 /* Xilinx types
  14  *********************************************************************/
  15 typedef enum {                  /* typedef Xilinx_iface */
  16         min_xilinx_iface_type,  /* low range check value */
  17         slave_serial,           /* serial data and external clock */
  18         master_serial,          /* serial data w/ internal clock (not used) */
  19         slave_parallel,         /* parallel data w/ external latch */
  20         jtag_mode,              /* jtag/tap serial (not used ) */
  21         master_selectmap,       /* master SelectMap (virtex2)           */
  22         slave_selectmap,        /* slave SelectMap (virtex2)            */
  23         devcfg,                 /* devcfg interface (zynq) */
  24         max_xilinx_iface_type   /* insert all new types before this */
  25 } Xilinx_iface;                 /* end, typedef Xilinx_iface */
  26
  27 typedef enum {                  /* typedef Xilinx_Family */
  28         min_xilinx_type,        /* low range check value */
  29         Xilinx_Spartan2,        /* Spartan-II Family */
  30         Xilinx_VirtexE,         /* Virtex-E Family */
  31         Xilinx_Virtex2,         /* Virtex2 Family */
  32         Xilinx_Spartan3,        /* Spartan-III Family */
  33         xilinx_zynq,            /* Zynq Family */
  34         max_xilinx_type         /* insert all new types before this */
  35 } Xilinx_Family;                /* end, typedef Xilinx_Family */
  36
  37 typedef struct {                /* typedef Xilinx_desc */
  38         Xilinx_Family family;   /* part type */
  39         Xilinx_iface iface;     /* interface type */
  40         size_t size;            /* bytes of data part can accept */
  41         void *iface_fns;        /* interface function table */
  42         int cookie;             /* implementation specific cookie */
  43         char *name;             /* device name in bitstream */
  44 } Xilinx_desc;                  /* end, typedef Xilinx_desc */
  45
  46 /* Generic Xilinx Functions
  47  *********************************************************************/
  48 extern int xilinx_load(Xilinx_desc *desc, const void *image, size_t size);
  49 extern int xilinx_dump(Xilinx_desc *desc, const void *buf, size_t bsize);
  50 extern int xilinx_info(Xilinx_desc *desc);
  51
  52 /* Board specific implementation specific function types
  53  *********************************************************************/
  54 typedef int (*Xilinx_pgm_fn)( int assert_pgm, int flush, int cookie );
  55 typedef int (*Xilinx_init_fn)( int cookie );
  56 typedef int (*Xilinx_err_fn)( int cookie );
  57 typedef int (*Xilinx_done_fn)( int cookie );
  58 typedef int (*Xilinx_clk_fn)( int assert_clk, int flush, int cookie );
  59 typedef int (*Xilinx_cs_fn)( int assert_cs, int flush, int cookie );
  60 typedef int (*Xilinx_wr_fn)( int assert_write, int flush, int cookie );
  61 typedef int (*Xilinx_rdata_fn)( unsigned char *data, int cookie );
  62 typedef int (*Xilinx_wdata_fn)( unsigned char data, int flush, int cookie );
  63 typedef int (*Xilinx_busy_fn)( int cookie );
  64 typedef int (*Xilinx_abort_fn)( int cookie );
  65 typedef int (*Xilinx_pre_fn)( int cookie );
  66 typedef int (*Xilinx_post_fn)( int cookie );
  67 typedef int (*Xilinx_bwr_fn)( void *buf, size_t len, int flush, int cookie );
  68
  69 #endif  /* _XILINX_H_ */