1 #ifndef __ezusb_H 2 #define __ezusb_H 3 /* 4 * Copyright © 2001 Stephen Williams (steve@icarus.com) 5 * Copyright © 2002 David Brownell (dbrownell@users.sourceforge.net) 6 * Copyright © 2013 Federico Manzan (f.manzan@gmail.com) 7 * 8 * This source code is free software; you can redistribute it 9 * and/or modify it in source code form under the terms of the GNU 10 * General Public License as published by the Free Software 11 * Foundation; either version 2 of the License, or (at your option) 12 * any later version. 13 * 14 * This program is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 * GNU General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License 20 * along with this program; if not, write to the Free Software 21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA 22 */ 23 #if !defined(_MSC_VER) 24 #include <stdbool.h> 25 #else 26 #define __attribute__(x) 27 #if !defined(bool) 28 #define bool int 29 #endif 30 #if !defined(true) 31 #define true (1 == 1) 32 #endif 33 #if !defined(false) 34 #define false (!true) 35 #endif 36 #if defined(_PREFAST_) 37 #pragma warning(disable:28193) 38 #endif 39 #endif 40 41 #define FX_TYPE_UNDEFINED -1 42 #define FX_TYPE_AN21 0 /* Original AnchorChips parts */ 43 #define FX_TYPE_FX1 1 /* Updated Cypress versions */ 44 #define FX_TYPE_FX2 2 /* USB 2.0 versions */ 45 #define FX_TYPE_FX2LP 3 /* Updated FX2 */ 46 #define FX_TYPE_FX3 4 /* USB 3.0 versions */ 47 #define FX_TYPE_MAX 5 48 #define FX_TYPE_NAMES { "an21", "fx", "fx2", "fx2lp", "fx3" } 49 50 #define IMG_TYPE_UNDEFINED -1 51 #define IMG_TYPE_HEX 0 /* Intel HEX */ 52 #define IMG_TYPE_IIC 1 /* Cypress 8051 IIC */ 53 #define IMG_TYPE_BIX 2 /* Cypress 8051 BIX */ 54 #define IMG_TYPE_IMG 3 /* Cypress IMG format */ 55 #define IMG_TYPE_MAX 4 56 #define IMG_TYPE_NAMES { "Intel HEX", "Cypress 8051 IIC", "Cypress 8051 BIX", "Cypress IMG format" } 57 58 #ifdef __cplusplus 59 extern "C" { 60 #endif 61 62 /* 63 * Automatically identified devices (VID, PID, type, designation). 64 * TODO: Could use some validation. Also where's the FX2? 65 */ 66 typedef struct { 67 uint16_t vid; 68 uint16_t pid; 69 int type; 70 const char* designation; 71 } fx_known_device; 72 73 #define FX_KNOWN_DEVICES { \ 74 { 0x0547, 0x2122, FX_TYPE_AN21, "Cypress EZ-USB (2122S)" },\ 75 { 0x0547, 0x2125, FX_TYPE_AN21, "Cypress EZ-USB (2121S/2125S)" },\ 76 { 0x0547, 0x2126, FX_TYPE_AN21, "Cypress EZ-USB (2126S)" },\ 77 { 0x0547, 0x2131, FX_TYPE_AN21, "Cypress EZ-USB (2131Q/2131S/2135S)" },\ 78 { 0x0547, 0x2136, FX_TYPE_AN21, "Cypress EZ-USB (2136S)" },\ 79 { 0x0547, 0x2225, FX_TYPE_AN21, "Cypress EZ-USB (2225)" },\ 80 { 0x0547, 0x2226, FX_TYPE_AN21, "Cypress EZ-USB (2226)" },\ 81 { 0x0547, 0x2235, FX_TYPE_AN21, "Cypress EZ-USB (2235)" },\ 82 { 0x0547, 0x2236, FX_TYPE_AN21, "Cypress EZ-USB (2236)" },\ 83 { 0x04b4, 0x6473, FX_TYPE_FX1, "Cypress EZ-USB FX1" },\ 84 { 0x04b4, 0x8613, FX_TYPE_FX2LP, "Cypress EZ-USB FX2LP (68013A/68014A/68015A/68016A)" }, \ 85 { 0x04b4, 0x00f3, FX_TYPE_FX3, "Cypress FX3" },\ 86 } 87 88 /* 89 * This function uploads the firmware from the given file into RAM. 90 * Stage == 0 means this is a single stage load (or the first of 91 * two stages). Otherwise it's the second of two stages; the 92 * caller having preloaded the second stage loader. 93 * 94 * The target processor is reset at the end of this upload. 95 */ 96 extern int ezusb_load_ram(libusb_device_handle *device, 97 const char *path, int fx_type, int img_type, int stage); 98 99 /* 100 * This function uploads the firmware from the given file into EEPROM. 101 * This uses the right CPUCS address to terminate the EEPROM load with 102 * a reset command where FX parts behave differently than FX2 ones. 103 * The configuration byte is as provided here (zero for an21xx parts) 104 * and the EEPROM type is set so that the microcontroller will boot 105 * from it. 106 * 107 * The caller must have preloaded a second stage loader that knows 108 * how to respond to the EEPROM write request. 109 */ 110 extern int ezusb_load_eeprom(libusb_device_handle *device, 111 const char *path, int fx_type, int img_type, int config); 112 113 /* Verbosity level (default 1). Can be increased or decreased with options v/q */ 114 extern int verbose; 115 116 #ifdef __cplusplus 117 } 118 #endif 119 120 #endif 121