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
42 #include <ftdi_eeprom_version.h>
44 static int parse_cbus(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
46 static const char* options[] =
48 "TXDEN", "PWREN", "RXLED", "TXLED", "TXRXLED", "SLEEP", "CLK48",
49 "CLK24", "CLK12", "CLK6", "IOMODE", "BB_WR", "BB_RD"
53 for (i=0; i<sizeof(options)/sizeof(*options); i++)
55 if (!(strcmp(options[i], value)))
62 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
66 static int parse_cbush(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
68 static const char* options[] =
70 "TRISTATE", "TXLED", "RXLED", "TXRXLED", "PWREN", "SLEEP",
71 "DRIVE_0", "DRIVE1", "IOMODE", "TXDEN", "CLK30", "CLK15", "CLK7_5"
75 for (i=0; i<sizeof(options)/sizeof(*options); i++)
77 if (!(strcmp(options[i], value)))
84 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
88 static int parse_cbusx(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
90 static const char* options[] =
92 "TRISTATE", "TXLED", "RXLED", "TXRXLED", "PWREN", "SLEEP",
93 "DRIVE_0", "DRIVE1", "IOMODE", "TXDEN", "CLK24", "CLK12",
94 "CLK6", "BAT_DETECT", "BAT_DETECT_NEG", "I2C_TXE", "I2C_RXF", "VBUS_SENSE",
95 "BB_WR", "BB_RD", "TIME_STAMP", "AWAKE"
99 for (i=0; i<sizeof(options)/sizeof(*options); i++)
101 if (!(strcmp(options[i], value)))
108 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
112 static int parse_chtype(cfg_t *cfg, cfg_opt_t *opt, const char *value, void *result)
120 { "UART", CHANNEL_IS_UART },
121 { "FIFO", CHANNEL_IS_FIFO },
122 { "OPTO", CHANNEL_IS_OPTO },
123 { "CPU", CHANNEL_IS_CPU },
124 { "FT1284", CHANNEL_IS_FT1284}
128 for (i=0; i<sizeof(options)/sizeof(*options); i++)
130 if (!(strcmp(options[i].key, value)))
132 *(int *)result = options[i].opt;
137 cfg_error(cfg, "Invalid %s option '%s'", cfg_opt_name(opt), value);
142 * @brief Set eeprom value
144 * \param ftdi pointer to ftdi_context
145 * \param value_name Enum of the value to set
146 * \param value Value to set
148 * Function will abort the program on error
150 static void eeprom_set_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
152 if (ftdi_set_eeprom_value(ftdi, value_name, value) < 0)
154 printf("Unable to set eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
160 * @brief Get eeprom value
162 * \param ftdi pointer to ftdi_context
163 * \param value_name Enum of the value to get
164 * \param value Value to get
166 * Function will abort the program on error
168 static void eeprom_get_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int *value)
170 if (ftdi_get_eeprom_value(ftdi, value_name, value) < 0)
172 printf("Unable to get eeprom value %d: %s. Aborting\n", value_name, ftdi_get_error_string(ftdi));
177 static void usage(const char *program)
179 fprintf(stderr, "Syntax: %s [...options...] <config-file>\n", program);
180 fprintf(stderr, "Valid Options:\n");
181 fprintf(stderr, "--device <description> Specify device to open by description string. One of:\n");
182 fprintf(stderr, " d:<devicenode>\n");
183 fprintf(stderr, " i:<vendor>:<product>\n");
184 fprintf(stderr, " i:<vendor>:<product>:<index>\n");
185 fprintf(stderr, " s:<vendor>:<product>:<serial>\n");
186 fprintf(stderr, "--read-eeprom Read eeprom and write to -filename- from config-file\n");
187 fprintf(stderr, "--erase-eeprom Erase eeprom\n");
188 fprintf(stderr, "--flash-eeprom Flash eeprom\n");
191 int main(int argc, char *argv[])
194 configuration options
198 CFG_INT("vendor_id", 0, 0),
199 CFG_INT("product_id", 0, 0),
200 CFG_BOOL("self_powered", cfg_true, 0),
201 CFG_BOOL("remote_wakeup", cfg_true, 0),
202 CFG_BOOL("in_is_isochronous", cfg_false, 0),
203 CFG_BOOL("out_is_isochronous", cfg_false, 0),
204 CFG_BOOL("suspend_pull_downs", cfg_false, 0),
205 CFG_BOOL("use_serial", cfg_false, 0),
206 CFG_BOOL("change_usb_version", cfg_false, 0),
207 CFG_INT("usb_version", 0, 0),
208 CFG_INT("default_pid", 0x6001, 0),
209 CFG_INT("max_power", 0, 0),
210 CFG_STR("manufacturer", "Acme Inc.", 0),
211 CFG_STR("product", "USB Serial Converter", 0),
212 CFG_STR("serial", "08-15", 0),
213 CFG_INT("eeprom_type", 0x00, 0),
214 CFG_STR("filename", "", 0),
215 CFG_BOOL("flash_raw", cfg_false, 0),
216 CFG_BOOL("high_current", cfg_false, 0),
217 CFG_INT_CB("cbus0", -1, 0, parse_cbus),
218 CFG_INT_CB("cbus1", -1, 0, parse_cbus),
219 CFG_INT_CB("cbus2", -1, 0, parse_cbus),
220 CFG_INT_CB("cbus3", -1, 0, parse_cbus),
221 CFG_INT_CB("cbus4", -1, 0, parse_cbus),
222 CFG_INT_CB("cbush0", -1, 0, parse_cbush),
223 CFG_INT_CB("cbush1", -1, 0, parse_cbush),
224 CFG_INT_CB("cbush2", -1, 0, parse_cbush),
225 CFG_INT_CB("cbush3", -1, 0, parse_cbush),
226 CFG_INT_CB("cbush4", -1, 0, parse_cbush),
227 CFG_INT_CB("cbush5", -1, 0, parse_cbush),
228 CFG_INT_CB("cbush6", -1, 0, parse_cbush),
229 CFG_INT_CB("cbush7", -1, 0, parse_cbush),
230 CFG_INT_CB("cbush8", -1, 0, parse_cbush),
231 CFG_INT_CB("cbush9", -1, 0, parse_cbush),
232 CFG_INT_CB("cbusx0", -1, 0, parse_cbusx),
233 CFG_INT_CB("cbusx1", -1, 0, parse_cbusx),
234 CFG_INT_CB("cbusx2", -1, 0, parse_cbusx),
235 CFG_INT_CB("cbusx3", -1, 0, parse_cbusx),
236 CFG_BOOL("invert_txd", cfg_false, 0),
237 CFG_BOOL("invert_rxd", cfg_false, 0),
238 CFG_BOOL("invert_rts", cfg_false, 0),
239 CFG_BOOL("invert_cts", cfg_false, 0),
240 CFG_BOOL("invert_dtr", cfg_false, 0),
241 CFG_BOOL("invert_dsr", cfg_false, 0),
242 CFG_BOOL("invert_dcd", cfg_false, 0),
243 CFG_BOOL("invert_ri", cfg_false, 0),
244 CFG_INT_CB("cha_type", -1, 0, parse_chtype),
245 CFG_INT_CB("chb_type", -1, 0, parse_chtype),
246 CFG_BOOL("cha_vcp", cfg_true, 0),
247 CFG_BOOL("chb_vcp", cfg_true, 0),
248 CFG_BOOL("chc_vcp", cfg_true, 0),
249 CFG_BOOL("chd_vcp", cfg_true, 0),
250 CFG_BOOL("cha_rs485", cfg_false, 0),
251 CFG_BOOL("chb_rs485", cfg_false, 0),
252 CFG_BOOL("chc_rs485", cfg_false, 0),
253 CFG_BOOL("chd_rs485", cfg_false, 0),
266 const char *cfg_filename = NULL;
267 const char *device_description = NULL;
269 const int max_eeprom_size = 256;
270 int my_eeprom_size = 0;
271 unsigned char *eeprom_buf = NULL;
277 struct ftdi_context *ftdi = NULL;
279 printf("\nFTDI eeprom generator v%s\n", EEPROM_VERSION_STRING);
280 printf ("(c) Intra2net AG and the libftdi developers <opensource@intra2net.com>\n");
282 for (i = 1; i < argc; i++) {
285 cfg_filename = argv[i];
287 else if (!strcmp(argv[i], "--device"))
294 device_description = argv[++i];
296 else if (!strcmp(argv[i], "--read-eeprom"))
298 command = COMMAND_READ;
300 else if (!strcmp(argv[i], "--erase-eeprom"))
302 command = COMMAND_ERASE;
304 else if (!strcmp(argv[i], "--flash-eeprom"))
306 command = COMMAND_FLASH;
321 if ((fp = fopen(cfg_filename, "r")) == NULL)
323 printf ("Can't open configuration file\n");
328 cfg = cfg_init(opts, 0);
329 cfg_parse(cfg, cfg_filename);
330 filename = cfg_getstr(cfg, "filename");
332 if (cfg_getbool(cfg, "self_powered") && cfg_getint(cfg, "max_power") > 0)
333 printf("Hint: Self powered devices should have a max_power setting of 0.\n");
335 if ((ftdi = ftdi_new()) == 0)
337 fprintf(stderr, "Failed to allocate ftdi structure :%s \n",
338 ftdi_get_error_string(ftdi));
342 if (device_description != NULL)
344 i = ftdi_usb_open_string(ftdi, device_description);
348 printf("Unable to find FTDI device with description: %s\n",
350 printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
354 else if (command > 0)
356 int vendor_id = cfg_getint(cfg, "vendor_id");
357 int product_id = cfg_getint(cfg, "product_id");
359 i = ftdi_usb_open(ftdi, vendor_id, product_id);
363 int default_pid = cfg_getint(cfg, "default_pid");
364 printf("Unable to find FTDI devices under given vendor/product id: 0x%X/0x%X\n", vendor_id, product_id);
365 printf("Error code: %d (%s)\n", i, ftdi_get_error_string(ftdi));
366 printf("Retrying with default FTDI pid=%#04x.\n", default_pid);
368 i = ftdi_usb_open(ftdi, 0x0403, default_pid);
371 printf("Error: %s\n", ftdi->error_str);
376 ftdi_eeprom_initdefaults (ftdi, cfg_getstr(cfg, "manufacturer"),
377 cfg_getstr(cfg, "product"),
378 cfg_getstr(cfg, "serial"));
380 printf("FTDI read eeprom: %d\n", ftdi_read_eeprom(ftdi));
381 eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
382 printf("EEPROM size: %d\n", my_eeprom_size);
384 if (command == COMMAND_READ)
386 ftdi_eeprom_decode(ftdi, 0 /* debug: 1 */);
388 eeprom_buf = malloc(my_eeprom_size);
389 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
391 if (eeprom_buf == NULL)
393 fprintf(stderr, "Malloc failed, aborting\n");
396 if (filename != NULL && strlen(filename) > 0)
399 FILE *fp = fopen (filename, "wb");
400 fwrite (eeprom_buf, 1, my_eeprom_size, fp);
405 printf("Warning: Not writing eeprom, you must supply a valid filename\n");
411 eeprom_set_value(ftdi, VENDOR_ID, cfg_getint(cfg, "vendor_id"));
412 eeprom_set_value(ftdi, PRODUCT_ID, cfg_getint(cfg, "product_id"));
414 eeprom_set_value(ftdi, SELF_POWERED, cfg_getbool(cfg, "self_powered"));
415 eeprom_set_value(ftdi, REMOTE_WAKEUP, cfg_getbool(cfg, "remote_wakeup"));
416 eeprom_set_value(ftdi, MAX_POWER, cfg_getint(cfg, "max_power"));
418 eeprom_set_value(ftdi, IN_IS_ISOCHRONOUS, cfg_getbool(cfg, "in_is_isochronous"));
419 eeprom_set_value(ftdi, OUT_IS_ISOCHRONOUS, cfg_getbool(cfg, "out_is_isochronous"));
420 eeprom_set_value(ftdi, SUSPEND_PULL_DOWNS, cfg_getbool(cfg, "suspend_pull_downs"));
422 eeprom_set_value(ftdi, USE_SERIAL, cfg_getbool(cfg, "use_serial"));
423 eeprom_set_value(ftdi, USE_USB_VERSION, cfg_getbool(cfg, "change_usb_version"));
424 eeprom_set_value(ftdi, USB_VERSION, cfg_getint(cfg, "usb_version"));
425 eeprom_set_value(ftdi, CHIP_TYPE, cfg_getint(cfg, "eeprom_type"));
427 eeprom_set_value(ftdi, HIGH_CURRENT, cfg_getbool(cfg, "high_current"));
429 if (ftdi->type == TYPE_R)
431 if (cfg_getint(cfg, "cbus0") != -1)
432 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbus0"));
433 if (cfg_getint(cfg, "cbus1") != -1)
434 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbus1"));
435 if (cfg_getint(cfg, "cbus2") != -1)
436 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbus2"));
437 if (cfg_getint(cfg, "cbus3") != -1)
438 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbus3"));
439 if (cfg_getint(cfg, "cbus4") != -1)
440 eeprom_set_value(ftdi, CBUS_FUNCTION_4, cfg_getint(cfg, "cbus4"));
442 else if (ftdi->type == TYPE_232H)
444 if (cfg_getint(cfg, "cbush0") != -1)
445 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbush0"));
446 if (cfg_getint(cfg, "cbush1") != -1)
447 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbush1"));
448 if (cfg_getint(cfg, "cbush2") != -1)
449 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbush2"));
450 if (cfg_getint(cfg, "cbush3") != -1)
451 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbush3"));
452 if (cfg_getint(cfg, "cbush4") != -1)
453 eeprom_set_value(ftdi, CBUS_FUNCTION_4, cfg_getint(cfg, "cbush4"));
454 if (cfg_getint(cfg, "cbush5") != -1)
455 eeprom_set_value(ftdi, CBUS_FUNCTION_5, cfg_getint(cfg, "cbush5"));
456 if (cfg_getint(cfg, "cbush6") != -1)
457 eeprom_set_value(ftdi, CBUS_FUNCTION_6, cfg_getint(cfg, "cbush6"));
458 if (cfg_getint(cfg, "cbush7") != -1)
459 eeprom_set_value(ftdi, CBUS_FUNCTION_7, cfg_getint(cfg, "cbush7"));
460 if (cfg_getint(cfg, "cbush8") != -1)
461 eeprom_set_value(ftdi, CBUS_FUNCTION_8, cfg_getint(cfg, "cbush8"));
462 if (cfg_getint(cfg, "cbush9") != -1)
463 eeprom_set_value(ftdi, CBUS_FUNCTION_9, cfg_getint(cfg, "cbush9"));
465 else if (ftdi->type == TYPE_230X)
467 if (cfg_getint(cfg, "cbusx0") != -1)
468 eeprom_set_value(ftdi, CBUS_FUNCTION_0, cfg_getint(cfg, "cbusx0"));
469 if (cfg_getint(cfg, "cbusx1") != -1)
470 eeprom_set_value(ftdi, CBUS_FUNCTION_1, cfg_getint(cfg, "cbusx1"));
471 if (cfg_getint(cfg, "cbusx2") != -1)
472 eeprom_set_value(ftdi, CBUS_FUNCTION_2, cfg_getint(cfg, "cbusx2"));
473 if (cfg_getint(cfg, "cbusx3") != -1)
474 eeprom_set_value(ftdi, CBUS_FUNCTION_3, cfg_getint(cfg, "cbusx3"));
478 if (cfg_getbool(cfg, "invert_rxd")) invert |= INVERT_RXD;
479 if (cfg_getbool(cfg, "invert_txd")) invert |= INVERT_TXD;
480 if (cfg_getbool(cfg, "invert_rts")) invert |= INVERT_RTS;
481 if (cfg_getbool(cfg, "invert_cts")) invert |= INVERT_CTS;
482 if (cfg_getbool(cfg, "invert_dtr")) invert |= INVERT_DTR;
483 if (cfg_getbool(cfg, "invert_dsr")) invert |= INVERT_DSR;
484 if (cfg_getbool(cfg, "invert_dcd")) invert |= INVERT_DCD;
485 if (cfg_getbool(cfg, "invert_ri")) invert |= INVERT_RI;
486 eeprom_set_value(ftdi, INVERT, invert);
488 if (cfg_getint(cfg, "cha_type") != -1)
489 eeprom_set_value(ftdi, CHANNEL_A_TYPE, cfg_getint(cfg, "cha_type"));
490 if (cfg_getint(cfg, "chb_type") != -1)
491 eeprom_set_value(ftdi, CHANNEL_B_TYPE, cfg_getint(cfg, "chb_type"));
493 eeprom_set_value(ftdi, CHANNEL_A_DRIVER,
494 cfg_getbool(cfg, "cha_vcp") ? DRIVER_VCP : 0);
495 eeprom_set_value(ftdi, CHANNEL_B_DRIVER,
496 cfg_getbool(cfg, "chb_vcp") ? DRIVER_VCP : 0);
497 eeprom_set_value(ftdi, CHANNEL_C_DRIVER,
498 cfg_getbool(cfg, "chc_vcp") ? DRIVER_VCP : 0);
499 eeprom_set_value(ftdi, CHANNEL_D_DRIVER,
500 cfg_getbool(cfg, "chd_vcp") ? DRIVER_VCP : 0);
502 eeprom_set_value(ftdi, CHANNEL_A_RS485, cfg_getbool(cfg, "cha_rs485"));
503 eeprom_set_value(ftdi, CHANNEL_B_RS485, cfg_getbool(cfg, "chb_rs485"));
504 eeprom_set_value(ftdi, CHANNEL_C_RS485, cfg_getbool(cfg, "chc_rs485"));
505 eeprom_set_value(ftdi, CHANNEL_D_RS485, cfg_getbool(cfg, "chd_rs485"));
507 if (command == COMMAND_ERASE)
509 printf("FTDI erase eeprom: %d\n", ftdi_erase_eeprom(ftdi));
512 size_check = ftdi_eeprom_build(ftdi);
513 eeprom_get_value(ftdi, CHIP_SIZE, &my_eeprom_size);
515 if (size_check == -1)
517 printf ("Sorry, the eeprom can only contain 128 bytes.\n");
520 else if (size_check < 0)
522 printf ("ftdi_eeprom_build(): error: %d\n", size_check);
527 printf ("Used eeprom space: %d bytes\n", my_eeprom_size-size_check);
530 if (command == COMMAND_FLASH)
532 if (cfg_getbool(cfg, "flash_raw"))
534 if (filename != NULL && strlen(filename) > 0)
536 eeprom_buf = malloc(max_eeprom_size);
537 FILE *fp = fopen(filename, "rb");
540 printf ("Can't open eeprom file %s.\n", filename);
543 my_eeprom_size = fread(eeprom_buf, 1, max_eeprom_size, fp);
545 if (my_eeprom_size < 128)
547 printf ("Can't read eeprom file %s.\n", filename);
551 ftdi_set_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
554 printf ("FTDI write eeprom: %d\n", ftdi_write_eeprom(ftdi));
555 libusb_reset_device(ftdi->usb_dev);
559 if (filename != NULL && strlen(filename) > 0 && !cfg_getbool(cfg, "flash_raw"))
561 fp = fopen(filename, "w");
564 printf ("Can't write eeprom file.\n");
568 printf ("Writing to file: %s\n", filename);
570 if (eeprom_buf == NULL)
571 eeprom_buf = malloc(my_eeprom_size);
572 ftdi_get_eeprom_buf(ftdi, eeprom_buf, my_eeprom_size);
574 fwrite(eeprom_buf, my_eeprom_size, 1, fp);
583 printf("FTDI close: %d\n", ftdi_usb_close(ftdi));