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         struct xilinx_fpga_op *operations; /* operations */
  44         char *name;             /* device name in bitstream */
  45 } xilinx_desc;                  /* end, typedef xilinx_desc */
  46
  47 struct xilinx_fpga_op {
  48         int (*load)(xilinx_desc *, const void *, size_t, bitstream_type);
  49         int (*loadfs)(xilinx_desc *, const void *, size_t, fpga_fs_info *);
  50         int (*dump)(xilinx_desc *, const void *, size_t);
  51         int (*info)(xilinx_desc *);
  52 };
  53
  54 /* Generic Xilinx Functions
  55  *********************************************************************/
  56 int xilinx_load(xilinx_desc *desc, const void *image, size_t size,
  57                 bitstream_type bstype);
  58 int xilinx_dump(xilinx_desc *desc, const void *buf, size_t bsize);
  59 int xilinx_info(xilinx_desc *desc);
  60 int xilinx_loadfs(xilinx_desc *desc, const void *buf, size_t bsize,
  61                   fpga_fs_info *fpga_fsinfo);
  62
  63 /* Board specific implementation specific function types
  64  *********************************************************************/
  65 typedef int (*xilinx_pgm_fn)(int assert_pgm, int flush, int cookie);
  66 typedef int (*xilinx_init_fn)(int cookie);
  67 typedef int (*xilinx_err_fn)(int cookie);
  68 typedef int (*xilinx_done_fn)(int cookie);
  69 typedef int (*xilinx_clk_fn)(int assert_clk, int flush, int cookie);
  70 typedef int (*xilinx_cs_fn)(int assert_cs, int flush, int cookie);
  71 typedef int (*xilinx_wr_fn)(int assert_write, int flush, int cookie);
  72 typedef int (*xilinx_rdata_fn)(unsigned char *data, int cookie);
  73 typedef int (*xilinx_wdata_fn)(unsigned char data, int flush, int cookie);
  74 typedef int (*xilinx_busy_fn)(int cookie);
  75 typedef int (*xilinx_abort_fn)(int cookie);
  76 typedef int (*xilinx_pre_fn)(int cookie);
  77 typedef int (*xilinx_post_fn)(int cookie);
  78 typedef int (*xilinx_bwr_fn)(void *buf, size_t len, int flush, int cookie);
  79
  80 #endif  /* _XILINX_H_ */