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