/*
   * (C) Copyright 2002
   * Rich Ireland, Enterasys Networks, rireland@enterasys.com.
   *

   * SPDX-License-Identifier:	GPL-2.0+

   */
  
  #include <fpga.h>
  
  #ifndef _ALTERA_H_
  #define _ALTERA_H_

  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, 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_abort_fn abort;
  	Altera_post_fn post;
  } altera_board_specific_func;

  #endif /* _ALTERA_H_ */