[people/ms/u-boot.git] / include / altera.h

/*
 * (C) Copyright 2002
 * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 *
 */

#include <fpga.h>

#ifndef _ALTERA_H_
#define _ALTERA_H_

/* Altera Model definitions
 *********************************************************************/
#define CONFIG_SYS_ACEX1K		CONFIG_SYS_FPGA_DEV( 0x1 )
#define CONFIG_SYS_CYCLON2		CONFIG_SYS_FPGA_DEV( 0x2 )
#define CONFIG_SYS_STRATIX_II		CONFIG_SYS_FPGA_DEV( 0x4 )

#define CONFIG_SYS_ALTERA_ACEX1K	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_ACEX1K)
#define CONFIG_SYS_ALTERA_CYCLON2	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_CYCLON2)
#define CONFIG_SYS_ALTERA_STRATIX_II	(CONFIG_SYS_FPGA_ALTERA | CONFIG_SYS_STRATIX_II)
/* Add new models here */

/* Altera Interface definitions
 *********************************************************************/
#define CONFIG_SYS_ALTERA_IF_PS	CONFIG_SYS_FPGA_IF( 0x1 )	/* passive serial */
#define CONFIG_SYS_ALTERA_IF_FPP	CONFIG_SYS_FPGA_IF( 0x2 )	/* fast passive parallel */
/* Add new interfaces here */

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

typedef enum {			/* typedef Altera_Family */
    min_altera_type,		/* insert all new types after this */
    Altera_ACEX1K,		/* ACEX1K Family */
    Altera_CYC2,		/* CYCLONII Family */
	Altera_StratixII,	/* StratixII Familiy */
/* Add new models here */
    max_altera_type		/* insert all new types before this */
} Altera_Family;		/* end, typedef Altera_Family */

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

/* Generic Altera Functions
 *********************************************************************/
extern int altera_load( Altera_desc *desc, void *image, size_t size );
extern int altera_dump( Altera_desc *desc, 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)(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_abort_fn abort;
	Altera_post_fn post;
} altera_board_specific_func;

#endif /* _ALTERA_H_ */
Commit	Line	Data
c609719b WD	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
5da627a4 WD	30	/* Altera Model definitions
5da627a4 WD	31	*********************************************************************/
6d0f6bcf JCPV	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 )
c609719b	35
6d0f6bcf JCPV	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)
c609719b WD	39	/* Add new models here */
c609719b WD	40
5da627a4 WD	41	/* Altera Interface definitions
5da627a4 WD	42	*********************************************************************/
6d0f6bcf JCPV	43	#define CONFIG_SYS_ALTERA_IF_PS CONFIG_SYS_FPGA_IF( 0x1 ) /* passive serial */
6d0f6bcf JCPV	44	#define CONFIG_SYS_ALTERA_IF_FPP CONFIG_SYS_FPGA_IF( 0x2 ) /* fast passive parallel */
c609719b WD	45	/* Add new interfaces here */
c609719b WD	46
5da627a4 WD	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 ) */
3c735e74	54	fast_passive_parallel, /* fast passive parallel (FPP) */
3c735e74	55	fast_passive_parallel_security, /* fast passive parallel with security (FPPS) */
5da627a4 WD	56	max_altera_iface_type /* insert all new types before this */
5da627a4 WD	57	} Altera_iface; /* end, typedef Altera_iface */
c609719b	58
5da627a4 WD	59	typedef enum { /* typedef Altera_Family */
	60	min_altera_type, /* insert all new types after this */
	61	Altera_ACEX1K, /* ACEX1K Family */
f0ff4692	62	Altera_CYC2, /* CYCLONII Family */
3c735e74	63	Altera_StratixII, /* StratixII Familiy */
c609719b	64	/* Add new models here */
5da627a4 WD	65	max_altera_type /* insert all new types before this */
5da627a4 WD	66	} Altera_Family; /* end, typedef Altera_Family */
c609719b	67
5da627a4 WD	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 */
c609719b	76
5da627a4 WD	77	/* Generic Altera Functions
5da627a4 WD	78	*********************************************************************/
c609719b WD	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 );
5da627a4 WD	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 );
f0ff4692	91	typedef int (Altera_write_fn)(void buf, size_t len, int flush, int cookie);
5da627a4 WD	92	typedef int (*Altera_abort_fn)( int cookie );
5da627a4 WD	93	typedef int (*Altera_post_fn)( int cookie );
c609719b	94
3c735e74	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
5da627a4	106	#endif /* _ALTERA_H_ */