1 /*
2  * (C) Copyright 2002
3  * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  *
23  */
24 
25 #include <fpga.h>
26 
27 #ifndef _ALTERA_H_
28 #define _ALTERA_H_
29 
30 /* Altera Model definitions
31  *********************************************************************/
32 #define CONFIG_SYS_ACEX1K		CONFIG_SYS_FPGA_DEV( 0x1 )
33 #define CONFIG_SYS_CYCLON2		CONFIG_SYS_FPGA_DEV( 0x2 )
34 #define CONFIG_SYS_STRATIX_II		CONFIG_SYS_FPGA_DEV( 0x4 )
35 
36 #define CONFIG_SYS_ALTERA_ACEX1K	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_ACEX1K)
37 #define CONFIG_SYS_ALTERA_CYCLON2	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_CYCLON2)
38 #define CONFIG_SYS_ALTERA_STRATIX_II	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_STRATIX_II)
39 /* Add new models here */
40 
41 /* Altera Interface definitions
42  *********************************************************************/
43 #define CONFIG_SYS_ALTERA_IF_PS	CONFIG_SYS_FPGA_IF( 0x1 )	/* passive serial */
44 #define CONFIG_SYS_ALTERA_IF_FPP	CONFIG_SYS_FPGA_IF( 0x2 )	/* fast passive parallel */
45 /* Add new interfaces here */
46 
47 typedef enum {				/* typedef Altera_iface */
48 	min_altera_iface_type,		/* insert all new types after this */
49 	passive_serial,			/* serial data and external clock */
50 	passive_parallel_synchronous,	/* parallel data */
51 	passive_parallel_asynchronous,	/* parallel data */
52 	passive_serial_asynchronous,	/* serial data w/ internal clock (not used)	*/
53 	altera_jtag_mode,		/* jtag/tap serial (not used ) */
54 	fast_passive_parallel,	/* fast passive parallel (FPP) */
55 	fast_passive_parallel_security,	/* fast passive parallel with security (FPPS) */
56 	max_altera_iface_type		/* insert all new types before this */
57 } Altera_iface;				/* end, typedef Altera_iface */
58 
59 typedef enum {			/* typedef Altera_Family */
60     min_altera_type,		/* insert all new types after this */
61     Altera_ACEX1K,		/* ACEX1K Family */
62     Altera_CYC2,		/* CYCLONII Family */
63 	Altera_StratixII,	/* StratixII Familiy */
64 /* Add new models here */
65     max_altera_type		/* insert all new types before this */
66 } Altera_Family;		/* end, typedef Altera_Family */
67 
68 typedef struct {		/* typedef Altera_desc */
69 	Altera_Family	family;	/* part type */
70 	Altera_iface	iface;	/* interface type */
71 	size_t		size;	/* bytes of data part can accept */
72 	void *		iface_fns;/* interface function table */
73 	void *		base;	/* base interface address */
74 	int		cookie;	/* implementation specific cookie */
75 } Altera_desc;			/* end, typedef Altera_desc */
76 
77 /* Generic Altera Functions
78  *********************************************************************/
79 extern int altera_load( Altera_desc *desc, void *image, size_t size );
80 extern int altera_dump( Altera_desc *desc, void *buf, size_t bsize );
81 extern int altera_info( Altera_desc *desc );
82 
83 /* Board specific implementation specific function types
84  *********************************************************************/
85 typedef int (*Altera_pre_fn)( int cookie );
86 typedef int (*Altera_config_fn)( int assert_config, int flush, int cookie );
87 typedef int (*Altera_status_fn)( int cookie );
88 typedef int (*Altera_done_fn)( int cookie );
89 typedef int (*Altera_clk_fn)( int assert_clk, int flush, int cookie );
90 typedef int (*Altera_data_fn)( int assert_data, int flush, int cookie );
91 typedef int (*Altera_write_fn)(void *buf, size_t len, int flush, int cookie);
92 typedef int (*Altera_abort_fn)( int cookie );
93 typedef int (*Altera_post_fn)( int cookie );
94 
95 typedef struct {
96 	Altera_pre_fn pre;
97 	Altera_config_fn config;
98 	Altera_status_fn status;
99 	Altera_done_fn done;
100 	Altera_clk_fn clk;
101 	Altera_data_fn data;
102 	Altera_abort_fn abort;
103 	Altera_post_fn post;
104 } altera_board_specific_func;
105 
106 #endif /* _ALTERA_H_ */
107