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