xref: /openbmc/u-boot/include/xilinx.h (revision 8ee59472)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2002
4  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
5  */
6 
7 #include <fpga.h>
8 
9 #ifndef _XILINX_H_
10 #define _XILINX_H_
11 
12 /* Xilinx types
13  *********************************************************************/
14 typedef enum {			/* typedef xilinx_iface */
15 	min_xilinx_iface_type,	/* low range check value */
16 	slave_serial,		/* serial data and external clock */
17 	master_serial,		/* serial data w/ internal clock (not used) */
18 	slave_parallel,		/* parallel data w/ external latch */
19 	jtag_mode,		/* jtag/tap serial (not used ) */
20 	master_selectmap,	/* master SelectMap (virtex2)           */
21 	slave_selectmap,	/* slave SelectMap (virtex2)            */
22 	devcfg,			/* devcfg interface (zynq) */
23 	csu_dma,		/* csu_dma interface (zynqmp) */
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 	xilinx_zynqmp,		/* ZynqMP Family */
35 	max_xilinx_type		/* insert all new types before this */
36 } xilinx_family;		/* end, typedef xilinx_family */
37 
38 typedef struct {		/* typedef xilinx_desc */
39 	xilinx_family family;	/* part type */
40 	xilinx_iface iface;	/* interface type */
41 	size_t size;		/* bytes of data part can accept */
42 	void *iface_fns;	/* interface function table */
43 	int cookie;		/* implementation specific cookie */
44 	struct xilinx_fpga_op *operations; /* operations */
45 	char *name;		/* device name in bitstream */
46 } xilinx_desc;			/* end, typedef xilinx_desc */
47 
48 struct xilinx_fpga_op {
49 	int (*load)(xilinx_desc *, const void *, size_t, bitstream_type);
50 	int (*loadfs)(xilinx_desc *, const void *, size_t, fpga_fs_info *);
51 	int (*dump)(xilinx_desc *, const void *, size_t);
52 	int (*info)(xilinx_desc *);
53 };
54 
55 /* Generic Xilinx Functions
56  *********************************************************************/
57 int xilinx_load(xilinx_desc *desc, const void *image, size_t size,
58 		bitstream_type bstype);
59 int xilinx_dump(xilinx_desc *desc, const void *buf, size_t bsize);
60 int xilinx_info(xilinx_desc *desc);
61 int xilinx_loadfs(xilinx_desc *desc, const void *buf, size_t bsize,
62 		  fpga_fs_info *fpga_fsinfo);
63 
64 /* Board specific implementation specific function types
65  *********************************************************************/
66 typedef int (*xilinx_pgm_fn)(int assert_pgm, int flush, int cookie);
67 typedef int (*xilinx_init_fn)(int cookie);
68 typedef int (*xilinx_err_fn)(int cookie);
69 typedef int (*xilinx_done_fn)(int cookie);
70 typedef int (*xilinx_clk_fn)(int assert_clk, int flush, int cookie);
71 typedef int (*xilinx_cs_fn)(int assert_cs, int flush, int cookie);
72 typedef int (*xilinx_wr_fn)(int assert_write, int flush, int cookie);
73 typedef int (*xilinx_rdata_fn)(unsigned char *data, int cookie);
74 typedef int (*xilinx_wdata_fn)(unsigned char data, int flush, int cookie);
75 typedef int (*xilinx_busy_fn)(int cookie);
76 typedef int (*xilinx_abort_fn)(int cookie);
77 typedef int (*xilinx_pre_fn)(int cookie);
78 typedef int (*xilinx_post_fn)(int cookie);
79 typedef int (*xilinx_bwr_fn)(void *buf, size_t len, int flush, int cookie);
80 
81 #endif  /* _XILINX_H_ */
82