1 /***************************************************************************
4 begin : Mon Apr 7 12:05:22 CEST 2003
5 copyright : (C) 2003-2014 by Intra2net AG and the libftdi developers
6 email : opensource@intra2net.com
7 ***************************************************************************/
9 /***************************************************************************
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. *
15 ***************************************************************************/
19 - Merge Uwe's eeprom tool. Current features:
20 - Init eeprom defaults based upon eeprom type
21 - Read -> Already there
22 - Write -> Already there
23 - Erase -> Already there
25 - Ability to find device by PID/VID, product name or serial
28 - Out-of-the-box compatibility with FTDI's eeprom tool configuration files
43 #include <ftdi_eeprom_version.h>
45 static int parse_cbus(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
47 static const char* options[] =
49 "TXDEN", "PWREN", "RXLED", "TXLED", "TXRXLED", "SLEEP", "CLK48",
50 "CLK24", "CLK12", "CLK6", "IOMODE", "BB_WR", "BB_RD"
54 for (i=0; i<sizeof(options)/sizeof(*options); i++)
56 if (!(strcmp(options[i], value)))
63 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
67 static int parse_cbush(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
69 static const char* options[] =
71 "TRISTATE", "TXLED", "RXLED", "TXRXLED", "PWREN", "SLEEP",
72 "DRIVE_0", "DRIVE1", "IOMODE", "TXDEN", "CLK30", "CLK15", "CLK7_5"
76 for (i=0; i<sizeof(options)/sizeof(*options); i++)
78 if (!(strcmp(options[i], value)))
85 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
89 static int parse_cbusx(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
91 static const char* options[] =
93 "TRISTATE", "TXLED", "RXLED", "TXRXLED", "PWREN", "SLEEP",
94 "DRIVE_0", "DRIVE1", "IOMODE", "TXDEN", "CLK24", "CLK12",
95 "CLK6", "BAT_DETECT", "BAT_DETECT_NEG", "I2C_TXE", "I2C_RXF", "VBUS_SENSE",
96 "BB_WR", "BB_RD", "TIME_STAMP", "AWAKE"
100 for (i=0; i<sizeof(options)/sizeof(*options); i++)
102 if (!(strcmp(options[i], value)))
109 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
113 static int parse_chtype(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
121 { "UART", CHANNEL_IS_UART },
122 { "FIFO", CHANNEL_IS_FIFO },
123 { "OPTO", CHANNEL_IS_OPTO },
124 { "CPU", CHANNEL_IS_CPU },
125 { "FT1284", CHANNEL_IS_FT1284}
129 for (i=0; i<sizeof(options)/sizeof(*options); i++)
131 if (!(strcmp(options[i].key, value)))
133 *(int *)result = options[i].opt;
138 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
143 * @brief Set eeprom value
145 * \param ftdi pointer to ftdi_context
146 * \param value_name Enum of the value to set
147 * \param value Value to set
149 * Function will abort the program on error
151 static void eeprom_set_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
153 if (ftdi_set_eeprom_value(ftdi, value_name, value) < 0)
155 printf("Unable to set eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
161 * @brief Get eeprom value
163 * \param ftdi pointer to ftdi_context
164 * \param value_name Enum of the value to get
165 * \param value Value to get
167 * Function will abort the program on error
169 static void eeprom_get_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
171 if (ftdi_get_eeprom_value(ftdi, value_name, value) < 0)
173 printf("Unable to get eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
178 static void usage(const char *program)
180 fprintf(stderr, "Syntax: %s [...options...] <config-file>\n", program);
181 fprintf(stderr, "Valid Options:\n");
182 fprintf(stderr, "--device <description> Specify device to open by description string. One of:\n");
183 fprintf(stderr, " d:<devicenode>\n");
184 fprintf(stderr, " i:<vendor>:<product>\n");
185 fprintf(stderr, " i:<vendor>:<product>:<index>\n");
186 fprintf(stderr, " s:<vendor>:<product>:<serial>\n");
187 fprintf(stderr, "--read-eeprom Read eeprom and write to -filename- from config-file\n");
188 fprintf(stderr, "--erase-eeprom Erase eeprom\n");
189 fprintf(stderr, "--flash-eeprom Flash eeprom\n");
192 int main(int argc, char *argv[])
195 configuration options
199 CFG_INT("vendor_id", 0, 0),
200 CFG_INT("product_id", 0, 0),
201 CFG_BOOL("self_powered", cfg_true, 0),
202 CFG_BOOL("remote_wakeup", cfg_true, 0),
203 CFG_BOOL("in_is_isochronous", cfg_false, 0),
204 CFG_BOOL("out_is_isochronous", cfg_false, 0),
205 CFG_BOOL("suspend_pull_downs", cfg_false, 0),
206 CFG_BOOL("use_serial", cfg_false, 0),
207 CFG_BOOL("change_usb_version", cfg_false, 0),
208 CFG_INT("usb_version", 0, 0),
209 CFG_INT("default_pid", 0x6001, 0),
210 CFG_INT("max_power", 0, 0),
211 CFG_STR("manufacturer", "Acme Inc.", 0),
212 CFG_STR("product", "USB Serial Converter", 0),
213 CFG_STR("serial", "08-15", 0),
214 CFG_INT("eeprom_type", 0x00, 0),
215 CFG_STR("filename", "", 0),
216 CFG_BOOL("flash_raw", cfg_false, 0),
217 CFG_BOOL("high_current", cfg_false, 0),
218 CFG_INT_CB("cbus0", -1, 0, parse_cbus),
219 CFG_INT_CB("cbus1", -1, 0, parse_cbus),
220 CFG_INT_CB("cbus2", -1, 0, parse_cbus),
221 CFG_INT_CB("cbus3", -1, 0, parse_cbus),
222 CFG_INT_CB("cbus4", -1, 0, parse_cbus),
223 CFG_INT_CB("cbush0", -1, 0, parse_cbush),
224 CFG_INT_CB("cbush1", -1, 0, parse_cbush),
225 CFG_INT_CB("cbush2", -1, 0, parse_cbush),
226 CFG_INT_CB("cbush3", -1, 0, parse_cbush),
227 CFG_INT_CB("cbush4", -1, 0, parse_cbush),
228 CFG_INT_CB("cbush5", -1, 0, parse_cbush),
229 CFG_INT_CB("cbush6", -1, 0, parse_cbush),
230 CFG_INT_CB("cbush7", -1, 0, parse_cbush),
231 CFG_INT_CB("cbush8", -1, 0, parse_cbush),
232 CFG_INT_CB("cbush9", -1, 0, parse_cbush),
233 CFG_INT_CB("cbusx0", -1, 0, parse_cbusx),
234 CFG_INT_CB("cbusx1", -1, 0, parse_cbusx),
235 CFG_INT_CB("cbusx2", -1, 0, parse_cbusx),
236 CFG_INT_CB("cbusx3", -1, 0, parse_cbusx),
237 CFG_BOOL("invert_txd", cfg_false, 0),
238 CFG_BOOL("invert_rxd", cfg_false, 0),
239 CFG_BOOL("invert_rts", cfg_false, 0),
240 CFG_BOOL("invert_cts", cfg_false, 0),
241 CFG_BOOL("invert_dtr", cfg_false, 0),
242 CFG_BOOL("invert_dsr", cfg_false, 0),
243 CFG_BOOL("invert_dcd", cfg_false, 0),
244 CFG_BOOL("invert_ri", cfg_false, 0),
245 CFG_INT_CB("cha_type", -1, 0, parse_chtype),
246 CFG_INT_CB("chb_type", -1, 0, parse_chtype),
247 CFG_BOOL("cha_vcp", cfg_true, 0),
248 CFG_BOOL("chb_vcp", cfg_true, 0),
249 CFG_BOOL("chc_vcp", cfg_true, 0),
250 CFG_BOOL("chd_vcp", cfg_true, 0),
251 CFG_BOOL("cha_rs485", cfg_false, 0),
252 CFG_BOOL("chb_rs485", cfg_false, 0),
253 CFG_BOOL("chc_rs485", cfg_false, 0),
254 CFG_BOOL("chd_rs485", cfg_false, 0),
267 const char *cfg_filename = NULL;
268 const char *device_description = NULL;
270 const int max_eeprom_size = 256;
271 int my_eeprom_size = 0;
272 unsigned char *eeprom_buf = NULL;
278 struct ftdi_context *ftdi = NULL;
280 printf("\nFTDI eeprom generator v%s\n", EEPROM_VERSION_STRING);
281 printf ("(c) Intra2net AG and the libftdi developers <opensource@intra2net.com>\n");
283 for (i = 1; i < argc; i++) {
286 cfg_filename = argv[i];
288 else if (!strcmp(argv[i], "--device"))
295 device_description = argv[++i];
297 else if (!strcmp(argv[i], "--read-eeprom"))
299 command = COMMAND_READ;
301 else if (!strcmp(argv[i], "--erase-eeprom"))
303 command = COMMAND_ERASE;
305 else if (!strcmp(argv[i], "--flash-eeprom"))
307 command = COMMAND_FLASH;
322 if ((fp = fopen(cfg_filename, "r")) == NULL)
324 printf ("Can't open configuration file\n");
329 cfg = cfg_init(opts, 0);
330 cfg_parse(cfg, cfg_filename);
331 filename = cfg_getstr(cfg, "filename");
333 if (cfg_getbool(cfg, "self_powered") && cfg_getint(cfg, "max_power") > 0)
334 printf("Hint: Self powered devices should have a max_power setting of 0.\n");
336 if ((ftdi = ftdi_new()) == 0)
338 fprintf(stderr, "Failed to allocate ftdi structure :%s \n",
339 ftdi_get_error_string(ftdi));
343 if (device_description != NULL)
345 i = ftdi_usb_open_string(ftdi, device_description);
349 printf("Unable to find FTDI device with description: %s\n",
351 printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
355 else if (command > 0)
357 int vendor_id = cfg_getint(cfg, "vendor_id");
358 int product_id = cfg_getint(cfg, "product_id");
360 i = ftdi_usb_open(ftdi, vendor_id, product_id);
364 int default_pid = cfg_getint(cfg, "default_pid");
365 printf("Unable to find FTDI devices under given vendor/product id: 0x%X/0x%X\n", vendor_id, product_id);
366 printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
367 printf("Retrying with default FTDI pid=%#04x.\n", default_pid);
369 i = ftdi_usb_open(ftdi, 0x0403, default_pid);
372 printf("Error: %s\n", ftdi->error_str);
377 ftdi_eeprom_initdefaults (ftdi, cfg_getstr(cfg, "manufacturer"),
378 cfg_getstr(cfg, "product"),
379 cfg_getstr(cfg, "serial"));
381 printf("FTDI read eeprom: %d\n", ftdi_read_eeprom(ftdi));
382 eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
383 printf("EEPROM size: %d\n", my_eeprom_size);
385 if (command == COMMAND_READ)
387 ftdi_eeprom_decode(ftdi, 0 /* debug: 1 */);
389 eeprom_buf = malloc(my_eeprom_size);
390 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
392 if (eeprom_buf == NULL)
394 fprintf(stderr, "Malloc failed, aborting\n");
397 if (filename != NULL && strlen(filename) > 0)
399 FILE *fp = fopen (filename, "wb");
403 fwrite(eeprom_buf, 1, my_eeprom_size, fp);
407 fprintf(stderr, "Could not open output file %s: %s\n", filename, strerror(errno));
411 printf("Warning: Not writing eeprom, you must supply a valid filename\n");
417 eeprom_set_value(ftdi, VENDOR_ID, cfg_getint(cfg, "vendor_id"));
418 eeprom_set_value(ftdi, PRODUCT_ID, cfg_getint(cfg, "product_id"));
420 eeprom_set_value(ftdi, SELF_POWERED, cfg_getbool(cfg, "self_powered"));
421 eeprom_set_value(ftdi, REMOTE_WAKEUP, cfg_getbool(cfg, "remote_wakeup"));
422 eeprom_set_value(ftdi, MAX_POWER, cfg_getint(cfg, "max_power"));
424 eeprom_set_value(ftdi, IN_IS_ISOCHRONOUS, cfg_getbool(cfg, "in_is_isochronous"));
425 eeprom_set_value(ftdi, OUT_IS_ISOCHRONOUS, cfg_getbool(cfg, "out_is_isochronous"));
426 eeprom_set_value(ftdi, SUSPEND_PULL_DOWNS, cfg_getbool(cfg, "suspend_pull_downs"));
428 eeprom_set_value(ftdi, USE_SERIAL, cfg_getbool(cfg, "use_serial"));
429 eeprom_set_value(ftdi, USE_USB_VERSION, cfg_getbool(cfg, "change_usb_version"));
430 eeprom_set_value(ftdi, USB_VERSION, cfg_getint(cfg, "usb_version"));
431 eeprom_set_value(ftdi, CHIP_TYPE, cfg_getint(cfg, "eeprom_type"));
433 eeprom_set_value(ftdi, HIGH_CURRENT, cfg_getbool(cfg, "high_current"));
435 if (ftdi->type == TYPE_R)
437 if (cfg_getint(cfg, "cbus0") != -1)
438 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbus0"));
439 if (cfg_getint(cfg, "cbus1") != -1)
440 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbus1"));
441 if (cfg_getint(cfg, "cbus2") != -1)
442 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbus2"));
443 if (cfg_getint(cfg, "cbus3") != -1)
444 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbus3"));
445 if (cfg_getint(cfg, "cbus4") != -1)
446 eeprom_set_value(ftdi, CBUS_FUNCTION_4, cfg_getint(cfg, "cbus4"));
448 else if (ftdi->type == TYPE_232H)
450 if (cfg_getint(cfg, "cbush0") != -1)
451 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbush0"));
452 if (cfg_getint(cfg, "cbush1") != -1)
453 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbush1"));
454 if (cfg_getint(cfg, "cbush2") != -1)
455 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbush2"));
456 if (cfg_getint(cfg, "cbush3") != -1)
457 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbush3"));
458 if (cfg_getint(cfg, "cbush4") != -1)
459 eeprom_set_value(ftdi, CBUS_FUNCTION_4, cfg_getint(cfg, "cbush4"));
460 if (cfg_getint(cfg, "cbush5") != -1)
461 eeprom_set_value(ftdi, CBUS_FUNCTION_5, cfg_getint(cfg, "cbush5"));
462 if (cfg_getint(cfg, "cbush6") != -1)
463 eeprom_set_value(ftdi, CBUS_FUNCTION_6, cfg_getint(cfg, "cbush6"));
464 if (cfg_getint(cfg, "cbush7") != -1)
465 eeprom_set_value(ftdi, CBUS_FUNCTION_7, cfg_getint(cfg, "cbush7"));
466 if (cfg_getint(cfg, "cbush8") != -1)
467 eeprom_set_value(ftdi, CBUS_FUNCTION_8, cfg_getint(cfg, "cbush8"));
468 if (cfg_getint(cfg, "cbush9") != -1)
469 eeprom_set_value(ftdi, CBUS_FUNCTION_9, cfg_getint(cfg, "cbush9"));
471 else if (ftdi->type == TYPE_230X)
473 if (cfg_getint(cfg, "cbusx0") != -1)
474 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbusx0"));
475 if (cfg_getint(cfg, "cbusx1") != -1)
476 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbusx1"));
477 if (cfg_getint(cfg, "cbusx2") != -1)
478 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbusx2"));
479 if (cfg_getint(cfg, "cbusx3") != -1)
480 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbusx3"));
484 if (cfg_getbool(cfg, "invert_rxd")) invert |= INVERT_RXD;
485 if (cfg_getbool(cfg, "invert_txd")) invert |= INVERT_TXD;
486 if (cfg_getbool(cfg, "invert_rts")) invert |= INVERT_RTS;
487 if (cfg_getbool(cfg, "invert_cts")) invert |= INVERT_CTS;
488 if (cfg_getbool(cfg, "invert_dtr")) invert |= INVERT_DTR;
489 if (cfg_getbool(cfg, "invert_dsr")) invert |= INVERT_DSR;
490 if (cfg_getbool(cfg, "invert_dcd")) invert |= INVERT_DCD;
491 if (cfg_getbool(cfg, "invert_ri")) invert |= INVERT_RI;
492 eeprom_set_value(ftdi, INVERT, invert);
494 if (cfg_getint(cfg, "cha_type") != -1)
495 eeprom_set_value(ftdi, CHANNEL_A_TYPE, cfg_getint(cfg, "cha_type"));
496 if (cfg_getint(cfg, "chb_type") != -1)
497 eeprom_set_value(ftdi, CHANNEL_B_TYPE, cfg_getint(cfg, "chb_type"));
499 eeprom_set_value(ftdi, CHANNEL_A_DRIVER,
500 cfg_getbool(cfg, "cha_vcp") ? DRIVER_VCP : 0);
501 eeprom_set_value(ftdi, CHANNEL_B_DRIVER,
502 cfg_getbool(cfg, "chb_vcp") ? DRIVER_VCP : 0);
503 eeprom_set_value(ftdi, CHANNEL_C_DRIVER,
504 cfg_getbool(cfg, "chc_vcp") ? DRIVER_VCP : 0);
505 eeprom_set_value(ftdi, CHANNEL_D_DRIVER,
506 cfg_getbool(cfg, "chd_vcp") ? DRIVER_VCP : 0);
508 eeprom_set_value(ftdi, CHANNEL_A_RS485, cfg_getbool(cfg, "cha_rs485"));
509 eeprom_set_value(ftdi, CHANNEL_B_RS485, cfg_getbool(cfg, "chb_rs485"));
510 eeprom_set_value(ftdi, CHANNEL_C_RS485, cfg_getbool(cfg, "chc_rs485"));
511 eeprom_set_value(ftdi, CHANNEL_D_RS485, cfg_getbool(cfg, "chd_rs485"));
513 if (command == COMMAND_ERASE)
515 printf("FTDI erase eeprom: %d\n", ftdi_erase_eeprom(ftdi));
518 size_check = ftdi_eeprom_build(ftdi);
519 eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
521 if (size_check == -1)
523 printf ("Sorry, the eeprom can only contain 128 bytes.\n");
526 else if (size_check < 0)
528 printf ("ftdi_eeprom_build(): error: %d\n", size_check);
533 printf ("Used eeprom space: %d bytes\n", my_eeprom_size-size_check);
536 if (command == COMMAND_FLASH)
538 if (cfg_getbool(cfg, "flash_raw"))
540 if (filename != NULL && strlen(filename) > 0)
542 eeprom_buf = malloc(max_eeprom_size);
543 FILE *fp = fopen(filename, "rb");
546 printf ("Can't open eeprom file %s.\n", filename);
549 my_eeprom_size = fread(eeprom_buf, 1, max_eeprom_size, fp);
551 if (my_eeprom_size < 128)
553 printf ("Can't read eeprom file %s.\n", filename);
557 ftdi_set_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
560 printf ("FTDI write eeprom: %d\n", ftdi_write_eeprom(ftdi));
561 libusb_reset_device(ftdi->usb_dev);
565 if (filename != NULL && strlen(filename) > 0 && !cfg_getbool(cfg, "flash_raw"))
567 fp = fopen(filename, "w");
570 printf ("Can't write eeprom file.\n");
574 printf ("Writing to file: %s\n", filename);
576 if (eeprom_buf == NULL)
577 eeprom_buf = malloc(my_eeprom_size);
578 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
580 fwrite(eeprom_buf, my_eeprom_size, 1, fp);
589 printf("FTDI close: %d\n", ftdi_usb_close(ftdi));