ftdi_eeprom: Change handling the EEPROM size
[libftdi] / ftdi_eeprom / main.c
... / ...
CommitLineData
1/***************************************************************************
2 main.c - description
3 -------------------
4 begin : Mon Apr 7 12:05:22 CEST 2003
5 copyright : (C) 2003-2011 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License version 2 as *
13 * published by the Free Software Foundation. *
14 * *
15 ***************************************************************************/
16
17/*
18 TODO:
19 - Remove 128 bytes limit
20 - Merge Uwe's eeprom tool. Current features:
21 - Init eeprom defaults based upon eeprom type
22 - Read -> Already there
23 - Write -> Already there
24 - Erase -> Already there
25 - Decode on stdout
26 - Ability to find device by PID/VID, product name or serial
27
28 TODO nice-to-have:
29 - Out-of-the-box compatibility with FTDI's eeprom tool configuration files
30 */
31
32#ifdef HAVE_CONFIG_H
33#include <config.h>
34#endif
35
36#include <stdlib.h>
37#include <stdio.h>
38#include <string.h>
39
40#include <confuse.h>
41#include <ftdi.h>
42#include <ftdi_eeprom_version.h>
43
44static int str_to_cbus(char *str, int max_allowed)
45{
46 #define MAX_OPTION 14
47 const char* options[MAX_OPTION] = {
48 "TXDEN", "PWREN", "RXLED", "TXLED", "TXRXLED", "SLEEP",
49 "CLK48", "CLK24", "CLK12", "CLK6",
50 "IO_MODE", "BITBANG_WR", "BITBANG_RD", "SPECIAL"};
51 int i;
52 max_allowed += 1;
53 if (max_allowed > MAX_OPTION) max_allowed = MAX_OPTION;
54 for (i=0; i<max_allowed; i++) {
55 if (!(strcmp(options[i], str))) {
56 return i;
57 }
58 }
59 printf("WARNING: Invalid cbus option '%s'\n", str);
60 return 0;
61}
62
63/**
64 * @brief Set eeprom value
65 *
66 * \param ftdi pointer to ftdi_context
67 * \param value_name Enum of the value to set
68 * \param value Value to set
69 *
70 * Function will abort the program on error
71 **/
72static void eeprom_set_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
73{
74 if (ftdi_set_eeprom_value(ftdi, value_name, value) < 0)
75 {
76 printf("Unable to set eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
77 exit (-1);
78 }
79}
80
81/**
82 * @brief Get eeprom value
83 *
84 * \param ftdi pointer to ftdi_context
85 * \param value_name Enum of the value to get
86 * \param value Value to get
87 *
88 * Function will abort the program on error
89 **/
90static void eeprom_get_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
91{
92 if (ftdi_get_eeprom_value(ftdi, value_name, value) < 0)
93 {
94 printf("Unable to get eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
95 exit (-1);
96 }
97}
98
99int main(int argc, char *argv[])
100{
101 /*
102 configuration options
103 */
104 cfg_opt_t opts[] =
105 {
106 CFG_INT("vendor_id", 0, 0),
107 CFG_INT("product_id", 0, 0),
108 CFG_BOOL("self_powered", cfg_true, 0),
109 CFG_BOOL("remote_wakeup", cfg_true, 0),
110 CFG_STR_LIST("chip_type", "{BM,R,other}", 0),
111 CFG_BOOL("in_is_isochronous", cfg_false, 0),
112 CFG_BOOL("out_is_isochronous", cfg_false, 0),
113 CFG_BOOL("suspend_pull_downs", cfg_false, 0),
114 CFG_BOOL("use_serial", cfg_false, 0),
115 CFG_BOOL("change_usb_version", cfg_false, 0),
116 CFG_INT("usb_version", 0, 0),
117 CFG_INT("default_pid", 0x6001, 0),
118 CFG_INT("max_power", 0, 0),
119 CFG_STR("manufacturer", "Acme Inc.", 0),
120 CFG_STR("product", "USB Serial Converter", 0),
121 CFG_STR("serial", "08-15", 0),
122 CFG_STR("filename", "", 0),
123 CFG_BOOL("flash_raw", cfg_false, 0),
124 CFG_BOOL("high_current", cfg_false, 0),
125 CFG_STR_LIST("cbus0", "{TXDEN,PWREN,RXLED,TXLED,TXRXLED,SLEEP,CLK48,CLK24,CLK12,CLK6,IO_MODE,BITBANG_WR,BITBANG_RD,SPECIAL}", 0),
126 CFG_STR_LIST("cbus1", "{TXDEN,PWREN,RXLED,TXLED,TXRXLED,SLEEP,CLK48,CLK24,CLK12,CLK6,IO_MODE,BITBANG_WR,BITBANG_RD,SPECIAL}", 0),
127 CFG_STR_LIST("cbus2", "{TXDEN,PWREN,RXLED,TXLED,TXRXLED,SLEEP,CLK48,CLK24,CLK12,CLK6,IO_MODE,BITBANG_WR,BITBANG_RD,SPECIAL}", 0),
128 CFG_STR_LIST("cbus3", "{TXDEN,PWREN,RXLED,TXLED,TXRXLED,SLEEP,CLK48,CLK24,CLK12,CLK6,IO_MODE,BITBANG_WR,BITBANG_RD,SPECIAL}", 0),
129 CFG_STR_LIST("cbus4", "{TXDEN,PWRON,RXLED,TXLED,TX_RX_LED,SLEEP,CLK48,CLK24,CLK12,CLK6}", 0),
130 CFG_BOOL("invert_txd", cfg_false, 0),
131 CFG_BOOL("invert_rxd", cfg_false, 0),
132 CFG_BOOL("invert_rts", cfg_false, 0),
133 CFG_BOOL("invert_cts", cfg_false, 0),
134 CFG_BOOL("invert_dtr", cfg_false, 0),
135 CFG_BOOL("invert_dsr", cfg_false, 0),
136 CFG_BOOL("invert_dcd", cfg_false, 0),
137 CFG_BOOL("invert_ri", cfg_false, 0),
138 CFG_END()
139 };
140 cfg_t *cfg;
141
142 /*
143 normal variables
144 */
145 int _read = 0, _erase = 0, _flash = 0;
146
147 int my_eeprom_size = 0;
148 unsigned char eeprom_buf[FTDI_MAX_EEPROM_SIZE];
149 char *filename;
150 int size_check;
151 int i, argc_filename;
152 FILE *fp;
153
154 struct ftdi_context *ftdi = NULL;
155
156 printf("\nFTDI eeprom generator v%s\n", EEPROM_VERSION_STRING);
157 printf ("(c) Intra2net AG and the libftdi developers <opensource@intra2net.com>\n");
158
159 if (argc != 2 && argc != 3)
160 {
161 printf("Syntax: %s [commands] config-file\n", argv[0]);
162 printf("Valid commands:\n");
163 printf("--read-eeprom Read eeprom and write to -filename- from config-file\n");
164 printf("--erase-eeprom Erase eeprom\n");
165 printf("--flash-eeprom Flash eeprom\n");
166 exit (-1);
167 }
168
169 if (argc == 3)
170 {
171 if (strcmp(argv[1], "--read-eeprom") == 0)
172 _read = 1;
173 if (strcmp(argv[1], "--erase-eeprom") == 0)
174 _erase = 1;
175 if (strcmp(argv[1], "--flash-eeprom") == 0)
176 _flash = 1;
177
178 argc_filename = 2;
179 }
180 else
181 {
182 argc_filename = 1;
183 }
184
185 if ((fp = fopen(argv[argc_filename], "r")) == NULL)
186 {
187 printf ("Can't open configuration file\n");
188 exit (-1);
189 }
190 fclose (fp);
191
192 cfg = cfg_init(opts, 0);
193 cfg_parse(cfg, argv[argc_filename]);
194 filename = cfg_getstr(cfg, "filename");
195
196 if (cfg_getbool(cfg, "self_powered") && cfg_getint(cfg, "max_power") > 0)
197 printf("Hint: Self powered devices should have a max_power setting of 0.\n");
198
199 if ((ftdi = ftdi_new()) == 0)
200 {
201 fprintf(stderr, "Failed to allocate ftdi structure :%s \n",
202 ftdi_get_error_string(ftdi));
203 return EXIT_FAILURE;
204 }
205
206 ftdi_eeprom_initdefaults (ftdi, cfg_getstr(cfg, "manufacturer"),
207 cfg_getstr(cfg, "product"),
208 cfg_getstr(cfg, "serial"));
209
210 eeprom_set_value(ftdi, VENDOR_ID, cfg_getint(cfg, "vendor_id"));
211 eeprom_set_value(ftdi, PRODUCT_ID, cfg_getint(cfg, "product_id"));
212
213 // TODO: Support all chip types
214 char *type = cfg_getstr(cfg, "chip_type");
215 if (!strcmp(type, "BM")) {
216 ftdi->type = TYPE_BM;
217 } else if (!strcmp(type, "R")) {
218 ftdi->type = TYPE_R;
219 } else {
220 ftdi->type = TYPE_AM;
221 }
222
223 eeprom_set_value(ftdi, SELF_POWERED, cfg_getbool(cfg, "self_powered"));
224 eeprom_set_value(ftdi, REMOTE_WAKEUP, cfg_getbool(cfg, "remote_wakeup"));
225 eeprom_set_value(ftdi, MAX_POWER, cfg_getint(cfg, "max_power"));
226
227 eeprom_set_value(ftdi, IN_IS_ISOCHRONOUS, cfg_getbool(cfg, "in_is_isochronous"));
228 eeprom_set_value(ftdi, OUT_IS_ISOCHRONOUS, cfg_getbool(cfg, "out_is_isochronous"));
229 eeprom_set_value(ftdi, SUSPEND_PULL_DOWNS, cfg_getbool(cfg, "suspend_pull_downs"));
230
231 eeprom_set_value(ftdi, USE_SERIAL, cfg_getbool(cfg, "use_serial"));
232 eeprom_set_value(ftdi, USE_USB_VERSION, cfg_getbool(cfg, "change_usb_version"));
233 eeprom_set_value(ftdi, USB_VERSION, cfg_getint(cfg, "usb_version"));
234
235
236 eeprom_set_value(ftdi, HIGH_CURRENT, cfg_getbool(cfg, "high_current"));
237 eeprom_set_value(ftdi, CBUS_FUNCTION_0, str_to_cbus(cfg_getstr(cfg, "cbus0"), 13));
238 eeprom_set_value(ftdi, CBUS_FUNCTION_1, str_to_cbus(cfg_getstr(cfg, "cbus1"), 13));
239 eeprom_set_value(ftdi, CBUS_FUNCTION_2, str_to_cbus(cfg_getstr(cfg, "cbus2"), 13));
240 eeprom_set_value(ftdi, CBUS_FUNCTION_3, str_to_cbus(cfg_getstr(cfg, "cbus3"), 13));
241 eeprom_set_value(ftdi, CBUS_FUNCTION_4, str_to_cbus(cfg_getstr(cfg, "cbus4"), 9));
242 int invert = 0;
243 if (cfg_getbool(cfg, "invert_rxd")) invert |= INVERT_RXD;
244 if (cfg_getbool(cfg, "invert_txd")) invert |= INVERT_TXD;
245 if (cfg_getbool(cfg, "invert_rts")) invert |= INVERT_RTS;
246 if (cfg_getbool(cfg, "invert_cts")) invert |= INVERT_CTS;
247 if (cfg_getbool(cfg, "invert_dtr")) invert |= INVERT_DTR;
248 if (cfg_getbool(cfg, "invert_dsr")) invert |= INVERT_DSR;
249 if (cfg_getbool(cfg, "invert_dcd")) invert |= INVERT_DCD;
250 if (cfg_getbool(cfg, "invert_ri")) invert |= INVERT_RI;
251 eeprom_set_value(ftdi, INVERT, invert);
252
253 if (_read > 0 || _erase > 0 || _flash > 0)
254 {
255 int vendor_id = 0, product_id = 0;
256 eeprom_get_value(ftdi, VENDOR_ID, &vendor_id);
257 eeprom_get_value(ftdi, PRODUCT_ID, &product_id);
258
259 i = ftdi_usb_open(ftdi, vendor_id, product_id);
260
261 if (i == 0)
262 {
263 printf("FTDI read eeprom: %d\n", ftdi_read_eeprom(ftdi));
264 eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
265 // TODO: Do we know the eeprom size already?
266 printf("EEPROM size: %d\n", my_eeprom_size);
267 }
268 else
269 {
270 int default_pid = cfg_getint(cfg, "default_pid");
271 printf("Unable to find FTDI devices under given vendor/product id: 0x%X/0x%X\n", vendor_id, product_id);
272 printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
273 printf("Retrying with default FTDI pid=%#04x.\n", default_pid);
274
275 i = ftdi_usb_open(ftdi, 0x0403, default_pid);
276 if (i != 0)
277 {
278 printf("Error: %s\n", ftdi->error_str);
279 exit (-1);
280 }
281 }
282 }
283
284 if (_read > 0)
285 {
286
287 ftdi_eeprom_decode(ftdi, 0);
288 /* Debug output */
289 /*
290 const char* chip_types[] = {"other", "BM", "R"};
291 printf("vendor_id = \"%04x\"\n", eeprom->vendor_id);
292 printf("product_id = \"%04x\"\n", eeprom->product_id);
293 printf("chip_type = \"%s\"\n",
294 (eeprom->chip_type > 0x06) || (eeprom->chip_type & 0x01) ? "unknown":
295 chip_types[eeprom->chip_type>>1]);
296 printf("self_powered = \"%s\"\n", eeprom->self_powered?"true":"false");
297 printf("remote_wakeup = \"%s\"\n", eeprom->remote_wakeup?"true":"false");
298 printf("max_power = \"%d\"\n", eeprom->max_power);
299 printf("in_is_isochronous = \"%s\"\n", eeprom->in_is_isochronous?"true":"false");
300 printf("out_is_isochronous = \"%s\"\n", eeprom->out_is_isochronous?"true":"false");
301 printf("suspend_pull_downs = \"%s\"\n", eeprom->suspend_pull_downs?"true":"false");
302 printf("use_serial = \"%s\"\n", eeprom->use_serial?"true":"false");
303 printf("change_usb_version = \"%s\"\n", eeprom->change_usb_version?"true":"false");
304 printf("usb_version = \"%d\"\n", eeprom->usb_version);
305 printf("manufacturer = \"%s\"\n", eeprom->manufacturer);
306 printf("product = \"%s\"\n", eeprom->product);
307 printf("serial = \"%s\"\n", eeprom->serial);
308 */
309
310 if (filename != NULL && strlen(filename) > 0)
311 {
312 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
313
314 FILE *fp = fopen (filename, "wb");
315 fwrite (eeprom_buf, 1, my_eeprom_size, fp);
316 fclose (fp);
317 }
318 else
319 {
320 printf("Warning: Not writing eeprom, you must supply a valid filename\n");
321 }
322
323 goto cleanup;
324 }
325
326 if (_erase > 0)
327 {
328 printf("FTDI erase eeprom: %d\n", ftdi_erase_eeprom(ftdi));
329 }
330
331 size_check = ftdi_eeprom_build(ftdi);
332
333 if (size_check == -1)
334 {
335 printf ("Sorry, the eeprom can only contain 128 bytes (100 bytes for your strings).\n");
336 printf ("You need to short your string by: %d bytes\n", size_check);
337 goto cleanup;
338 } else if (size_check < 0) {
339 printf ("ftdi_eeprom_build(): error: %d\n", size_check);
340 }
341 else
342 {
343 printf ("Used eeprom space: %d bytes\n", my_eeprom_size-size_check);
344 }
345
346 if (_flash > 0)
347 {
348 if (cfg_getbool(cfg, "flash_raw"))
349 {
350 if (filename != NULL && strlen(filename) > 0)
351 {
352 FILE *fp = fopen(filename, "rb");
353 fread(eeprom_buf, 1, my_eeprom_size, fp);
354 fclose(fp);
355
356 ftdi_set_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
357 }
358 }
359 printf ("FTDI write eeprom: %d\n", ftdi_write_eeprom(ftdi));
360 }
361
362 // Write to file?
363 if (filename != NULL && strlen(filename) > 0 && !cfg_getbool(cfg, "flash_raw"))
364 {
365 fp = fopen(filename, "w");
366 if (fp == NULL)
367 {
368 printf ("Can't write eeprom file.\n");
369 exit (-1);
370 }
371 else
372 printf ("Writing to file: %s\n", filename);
373
374 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
375
376 fwrite(eeprom_buf, my_eeprom_size, 1, fp);
377 fclose(fp);
378 }
379
380cleanup:
381 if (_read > 0 || _erase > 0 || _flash > 0)
382 {
383 printf("FTDI close: %d\n", ftdi_usb_close(ftdi));
384 }
385
386 ftdi_deinit (ftdi);
387
388 cfg_free(cfg);
389
390 printf("\n");
391 return 0;
392}