[J-u-boot.git] / include / altera.h

/*
 * (C) Copyright 2002
 * Rich Ireland, Enterasys Networks, [email protected].
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <fpga.h>

#ifndef _ALTERA_H_
#define _ALTERA_H_

/*
 * For the StratixV FPGA programming via SPI, the following
 * information is coded in the 32bit cookie:
 * Bit 31 ... Bit 0
 * SPI-Bus | SPI-Dev | Config-Pin | Done-Pin
 */
#define FPGA_COOKIE(bus, dev, config, done)			\
	(((bus) << 24) | ((dev) << 16) | ((config) << 8) | (done))
#define COOKIE2SPI_BUS(c)	(((c) >> 24) & 0xff)
#define COOKIE2SPI_DEV(c)	(((c) >> 16) & 0xff)
#define COOKIE2CONFIG(c)	(((c) >> 8) & 0xff)
#define COOKIE2DONE(c)		((c) & 0xff)

enum altera_iface {
	/* insert all new types after this */
	min_altera_iface_type,
	/* serial data and external clock */
	passive_serial,
	/* parallel data */
	passive_parallel_synchronous,
	/* parallel data */
	passive_parallel_asynchronous,
	/* serial data w/ internal clock (not used) */
	passive_serial_asynchronous,
	/* jtag/tap serial (not used ) */
	altera_jtag_mode,
	/* fast passive parallel (FPP) */
	fast_passive_parallel,
	/* fast passive parallel with security (FPPS) */
	fast_passive_parallel_security,
	/* insert all new types before this */
	max_altera_iface_type,
};

enum altera_family {
	/* insert all new types after this */
	min_altera_type,
	/* ACEX1K Family */
	Altera_ACEX1K,
	/* CYCLONII Family */
	Altera_CYC2,
	/* StratixII Family */
	Altera_StratixII,
	/* StratixV Family */
	Altera_StratixV,
	/* SoCFPGA Family */
	Altera_SoCFPGA,

	/* Add new models here */

	/* insert all new types before this */
	max_altera_type,
};

typedef struct {
	/* part type */
	enum altera_family	family;
	/* interface type */
	enum altera_iface	iface;
	/* bytes of data part can accept */
	size_t			size;
	/* interface function table */
	void			*iface_fns;
	/* base interface address */
	void			*base;
	/* implementation specific cookie */
	int			cookie;
} Altera_desc;

/* Generic Altera Functions
 *********************************************************************/
extern int altera_load(Altera_desc *desc, const void *image, size_t size);
extern int altera_dump(Altera_desc *desc, const void *buf, size_t bsize);
extern int altera_info(Altera_desc *desc);

/* Board specific implementation specific function types
 *********************************************************************/
typedef int (*Altera_pre_fn)( int cookie );
typedef int (*Altera_config_fn)( int assert_config, int flush, int cookie );
typedef int (*Altera_status_fn)( int cookie );
typedef int (*Altera_done_fn)( int cookie );
typedef int (*Altera_clk_fn)( int assert_clk, int flush, int cookie );
typedef int (*Altera_data_fn)( int assert_data, int flush, int cookie );
typedef int(*Altera_write_fn)(const void *buf, size_t len, int flush, int cookie);
typedef int (*Altera_abort_fn)( int cookie );
typedef int (*Altera_post_fn)( int cookie );

typedef struct {
	Altera_pre_fn pre;
	Altera_config_fn config;
	Altera_status_fn status;
	Altera_done_fn done;
	Altera_clk_fn clk;
	Altera_data_fn data;
	Altera_write_fn write;
	Altera_abort_fn abort;
	Altera_post_fn post;
} altera_board_specific_func;

#ifdef CONFIG_FPGA_SOCFPGA
int socfpga_load(Altera_desc *desc, const void *rbf_data, size_t rbf_size);
#endif

#ifdef CONFIG_FPGA_STRATIX_V
int stratixv_load(Altera_desc *desc, const void *rbf_data, size_t rbf_size);
#endif

#endif /* _ALTERA_H_ */
Commit	Line	Data
c609719b WD	1	/*
	2	* (C) Copyright 2002
	3	* Rich Ireland, Enterasys Networks, [email protected].
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
c609719b WD	6	*/
	7
	8	#include <fpga.h>
	9
	10	#ifndef _ALTERA_H_
	11	#define _ALTERA_H_
	12
ff9c4c53 SR	13	/*
	14	* For the StratixV FPGA programming via SPI, the following
	15	* information is coded in the 32bit cookie:
	16	* Bit 31 ... Bit 0
	17	* SPI-Bus \| SPI-Dev \| Config-Pin \| Done-Pin
	18	*/
	19	#define FPGA_COOKIE(bus, dev, config, done) \
	20	(((bus) << 24) \| ((dev) << 16) \| ((config) << 8) \| (done))
	21	#define COOKIE2SPI_BUS(c) (((c) >> 24) & 0xff)
	22	#define COOKIE2SPI_DEV(c) (((c) >> 16) & 0xff)
	23	#define COOKIE2CONFIG(c) (((c) >> 8) & 0xff)
	24	#define COOKIE2DONE(c) ((c) & 0xff)
	25
d44ef7ff MV	26	enum altera_iface {
	27	/* insert all new types after this */
	28	min_altera_iface_type,
	29	/* serial data and external clock */
	30	passive_serial,
	31	/* parallel data */
	32	passive_parallel_synchronous,
	33	/* parallel data */
	34	passive_parallel_asynchronous,
	35	/* serial data w/ internal clock (not used) */
	36	passive_serial_asynchronous,
	37	/* jtag/tap serial (not used ) */
	38	altera_jtag_mode,
	39	/* fast passive parallel (FPP) */
	40	fast_passive_parallel,
	41	/* fast passive parallel with security (FPPS) */
	42	fast_passive_parallel_security,
	43	/* insert all new types before this */
	44	max_altera_iface_type,
	45	};
	46
	47	enum altera_family {
	48	/* insert all new types after this */
	49	min_altera_type,
	50	/* ACEX1K Family */
	51	Altera_ACEX1K,
	52	/* CYCLONII Family */
	53	Altera_CYC2,
	54	/* StratixII Family */
	55	Altera_StratixII,
ff9c4c53 SR	56	/* StratixV Family */
ff9c4c53 SR	57	Altera_StratixV,
230fe9b2 PM	58	/* SoCFPGA Family */
230fe9b2 PM	59	Altera_SoCFPGA,
d44ef7ff MV	60
	61	/* Add new models here */
	62
	63	/* insert all new types before this */
	64	max_altera_type,
	65	};
	66
	67	typedef struct {
	68	/* part type */
	69	enum altera_family family;
	70	/* interface type */
	71	enum altera_iface iface;
	72	/* bytes of data part can accept */
	73	size_t size;
	74	/* interface function table */
	75	void *iface_fns;
	76	/* base interface address */
	77	void *base;
	78	/* implementation specific cookie */
	79	int cookie;
	80	} Altera_desc;
c609719b	81
5da627a4 WD	82	/* Generic Altera Functions
5da627a4 WD	83	*********************************************************************/
e6a857da WD	84	extern int altera_load(Altera_desc desc, const void image, size_t size);
	85	extern int altera_dump(Altera_desc desc, const void buf, size_t bsize);
	86	extern int altera_info(Altera_desc *desc);
5da627a4 WD	87
	88	/* Board specific implementation specific function types
	89	*********************************************************************/
	90	typedef int (*Altera_pre_fn)( int cookie );
	91	typedef int (*Altera_config_fn)( int assert_config, int flush, int cookie );
	92	typedef int (*Altera_status_fn)( int cookie );
	93	typedef int (*Altera_done_fn)( int cookie );
	94	typedef int (*Altera_clk_fn)( int assert_clk, int flush, int cookie );
	95	typedef int (*Altera_data_fn)( int assert_data, int flush, int cookie );
e6a857da	96	typedef int(Altera_write_fn)(const void buf, size_t len, int flush, int cookie);
5da627a4 WD	97	typedef int (*Altera_abort_fn)( int cookie );
5da627a4 WD	98	typedef int (*Altera_post_fn)( int cookie );
c609719b	99
3c735e74	100	typedef struct {
	101	Altera_pre_fn pre;
	102	Altera_config_fn config;
	103	Altera_status_fn status;
	104	Altera_done_fn done;
	105	Altera_clk_fn clk;
	106	Altera_data_fn data;
ff9c4c53	107	Altera_write_fn write;
3c735e74	108	Altera_abort_fn abort;
	109	Altera_post_fn post;
	110	} altera_board_specific_func;
	111
230fe9b2 PM	112	#ifdef CONFIG_FPGA_SOCFPGA
	113	int socfpga_load(Altera_desc desc, const void rbf_data, size_t rbf_size);
	114	#endif
	115
ff9c4c53 SR	116	#ifdef CONFIG_FPGA_STRATIX_V
	117	int stratixv_load(Altera_desc desc, const void rbf_data, size_t rbf_size);
	118	#endif
	119
5da627a4	120	#endif /* _ALTERA_H_ */