xref: /openbmc/u-boot/include/xilinx.h (revision 1d2c0506)
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 	csu_dma,		/* csu_dma interface (zynqmp) */
25 	max_xilinx_iface_type	/* insert all new types before this */
26 } xilinx_iface;			/* end, typedef xilinx_iface */
27 
28 typedef enum {			/* typedef xilinx_family */
29 	min_xilinx_type,	/* low range check value */
30 	xilinx_spartan2,	/* Spartan-II Family */
31 	xilinx_virtexE,		/* Virtex-E Family */
32 	xilinx_virtex2,		/* Virtex2 Family */
33 	xilinx_spartan3,	/* Spartan-III Family */
34 	xilinx_zynq,		/* Zynq Family */
35 	xilinx_zynqmp,		/* ZynqMP Family */
36 	max_xilinx_type		/* insert all new types before this */
37 } xilinx_family;		/* end, typedef xilinx_family */
38 
39 typedef struct {		/* typedef xilinx_desc */
40 	xilinx_family family;	/* part type */
41 	xilinx_iface iface;	/* interface type */
42 	size_t size;		/* bytes of data part can accept */
43 	void *iface_fns;	/* interface function table */
44 	int cookie;		/* implementation specific cookie */
45 	struct xilinx_fpga_op *operations; /* operations */
46 	char *name;		/* device name in bitstream */
47 } xilinx_desc;			/* end, typedef xilinx_desc */
48 
49 struct xilinx_fpga_op {
50 	int (*load)(xilinx_desc *, const void *, size_t, bitstream_type);
51 	int (*loadfs)(xilinx_desc *, const void *, size_t, fpga_fs_info *);
52 	int (*dump)(xilinx_desc *, const void *, size_t);
53 	int (*info)(xilinx_desc *);
54 };
55 
56 /* Generic Xilinx Functions
57  *********************************************************************/
58 int xilinx_load(xilinx_desc *desc, const void *image, size_t size,
59 		bitstream_type bstype);
60 int xilinx_dump(xilinx_desc *desc, const void *buf, size_t bsize);
61 int xilinx_info(xilinx_desc *desc);
62 int xilinx_loadfs(xilinx_desc *desc, const void *buf, size_t bsize,
63 		  fpga_fs_info *fpga_fsinfo);
64 
65 /* Board specific implementation specific function types
66  *********************************************************************/
67 typedef int (*xilinx_pgm_fn)(int assert_pgm, int flush, int cookie);
68 typedef int (*xilinx_init_fn)(int cookie);
69 typedef int (*xilinx_err_fn)(int cookie);
70 typedef int (*xilinx_done_fn)(int cookie);
71 typedef int (*xilinx_clk_fn)(int assert_clk, int flush, int cookie);
72 typedef int (*xilinx_cs_fn)(int assert_cs, int flush, int cookie);
73 typedef int (*xilinx_wr_fn)(int assert_write, int flush, int cookie);
74 typedef int (*xilinx_rdata_fn)(unsigned char *data, int cookie);
75 typedef int (*xilinx_wdata_fn)(unsigned char data, int flush, int cookie);
76 typedef int (*xilinx_busy_fn)(int cookie);
77 typedef int (*xilinx_abort_fn)(int cookie);
78 typedef int (*xilinx_pre_fn)(int cookie);
79 typedef int (*xilinx_post_fn)(int cookie);
80 typedef int (*xilinx_bwr_fn)(void *buf, size_t len, int flush, int cookie);
81 
82 #endif  /* _XILINX_H_ */
83