Start ChangeLog for next version
[libftdi] / src / ftdi.c
CommitLineData
a3da1d95
GE
1/***************************************************************************
2 ftdi.c - description
3 -------------------
4 begin : Fri Apr 4 2003
79646368 5 copyright : (C) 2003-2017 by Intra2net AG and the libftdi developers
5fdb1cb1 6 email : opensource@intra2net.com
a3da1d95
GE
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 Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
14 * *
15 ***************************************************************************/
d9f0cce7 16
b5ec1820
TJ
17/**
18 \mainpage libftdi API documentation
19
ad397a4b 20 Library to talk to FTDI chips. You find the latest versions of libftdi at
79646368 21 https://www.intra2net.com/en/developer/libftdi/
b5ec1820 22
ad397a4b
TJ
23 The library is easy to use. Have a look at this short example:
24 \include simple.c
25
26 More examples can be found in the "examples" directory.
b5ec1820
TJ
27*/
28/** \addtogroup libftdi */
29/* @{ */
30
579b006f 31#include <libusb.h>
a8f46ddc 32#include <string.h>
d2f10023 33#include <errno.h>
b56d5a64 34#include <stdio.h>
579b006f 35#include <stdlib.h>
0e302db6 36
b790d38e 37#include "ftdi_i.h"
98452d97 38#include "ftdi.h"
0220adfa 39#include "ftdi_version_i.h"
a3da1d95 40
21abaf2e 41#define ftdi_error_return(code, str) do { \
b0a50459
PS
42 if ( ftdi ) \
43 ftdi->error_str = str; \
44 else \
45 fprintf(stderr, str); \
21abaf2e 46 return code; \
d2f10023 47 } while(0);
c3d95b87 48
99650502
UB
49#define ftdi_error_return_free_device_list(code, str, devs) do { \
50 libusb_free_device_list(devs,1); \
51 ftdi->error_str = str; \
52 return code; \
53 } while(0);
54
418aaa72 55
f3f81007
TJ
56/**
57 Internal function to close usb device pointer.
58 Sets ftdi->usb_dev to NULL.
59 \internal
60
61 \param ftdi pointer to ftdi_context
62
579b006f 63 \retval none
f3f81007 64*/
579b006f 65static void ftdi_usb_close_internal (struct ftdi_context *ftdi)
dff4fdb0 66{
22a1b5c1 67 if (ftdi && ftdi->usb_dev)
dff4fdb0 68 {
56ac0383
TJ
69 libusb_close (ftdi->usb_dev);
70 ftdi->usb_dev = NULL;
44f41f11
UB
71 if(ftdi->eeprom)
72 ftdi->eeprom->initialized_for_connected_device = 0;
dff4fdb0 73 }
dff4fdb0 74}
c3d95b87 75
1941414d
TJ
76/**
77 Initializes a ftdi_context.
4837f98a 78
1941414d 79 \param ftdi pointer to ftdi_context
4837f98a 80
1941414d
TJ
81 \retval 0: all fine
82 \retval -1: couldn't allocate read buffer
a35aa9bd 83 \retval -2: couldn't allocate struct buffer
3a284749 84 \retval -3: libusb_init() failed
1941414d
TJ
85
86 \remark This should be called before all functions
948f9ada 87*/
a8f46ddc
TJ
88int ftdi_init(struct ftdi_context *ftdi)
89{
3b3a9614 90 struct ftdi_eeprom* eeprom;
02212d8e 91 ftdi->usb_ctx = NULL;
98452d97 92 ftdi->usb_dev = NULL;
545820ce
TJ
93 ftdi->usb_read_timeout = 5000;
94 ftdi->usb_write_timeout = 5000;
a3da1d95 95
53ad271d 96 ftdi->type = TYPE_BM; /* chip type */
a3da1d95 97 ftdi->baudrate = -1;
418aaa72 98 ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */
a3da1d95 99
948f9ada
TJ
100 ftdi->readbuffer = NULL;
101 ftdi->readbuffer_offset = 0;
102 ftdi->readbuffer_remaining = 0;
103 ftdi->writebuffer_chunksize = 4096;
e2f12a4f 104 ftdi->max_packet_size = 0;
3a284749
TJ
105 ftdi->error_str = NULL;
106 ftdi->module_detach_mode = AUTO_DETACH_SIO_MODULE;
107
108 if (libusb_init(&ftdi->usb_ctx) < 0)
109 ftdi_error_return(-3, "libusb_init() failed");
948f9ada 110
ac0af8ec 111 ftdi_set_interface(ftdi, INTERFACE_ANY);
418aaa72 112 ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */
53ad271d 113
3b3a9614 114 eeprom = (struct ftdi_eeprom *)malloc(sizeof(struct ftdi_eeprom));
a35aa9bd
UB
115 if (eeprom == 0)
116 ftdi_error_return(-2, "Can't malloc struct ftdi_eeprom");
b4d19dea 117 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
a35aa9bd 118 ftdi->eeprom = eeprom;
c201f80f 119
1c733d33
TJ
120 /* All fine. Now allocate the readbuffer */
121 return ftdi_read_data_set_chunksize(ftdi, 4096);
948f9ada 122}
4837f98a 123
1941414d 124/**
cef378aa
TJ
125 Allocate and initialize a new ftdi_context
126
127 \return a pointer to a new ftdi_context, or NULL on failure
128*/
672ac008 129struct ftdi_context *ftdi_new(void)
cef378aa
TJ
130{
131 struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context));
132
22d12cda
TJ
133 if (ftdi == NULL)
134 {
cef378aa
TJ
135 return NULL;
136 }
137
22d12cda
TJ
138 if (ftdi_init(ftdi) != 0)
139 {
cef378aa 140 free(ftdi);
cdf448f6 141 return NULL;
cef378aa
TJ
142 }
143
144 return ftdi;
145}
146
147/**
1941414d
TJ
148 Open selected channels on a chip, otherwise use first channel.
149
150 \param ftdi pointer to ftdi_context
f9d69895 151 \param interface Interface to use for FT2232C/2232H/4232H chips.
1941414d
TJ
152
153 \retval 0: all fine
154 \retval -1: unknown interface
22a1b5c1 155 \retval -2: USB device unavailable
1c5fa36b 156 \retval -3: Device already open, interface can't be set in that state
c4446c36 157*/
0ce2f5fa 158int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface)
c4446c36 159{
1971c26d 160 if (ftdi == NULL)
22a1b5c1
TJ
161 ftdi_error_return(-2, "USB device unavailable");
162
1c5fa36b
TJ
163 if (ftdi->usb_dev != NULL)
164 {
165 int check_interface = interface;
166 if (check_interface == INTERFACE_ANY)
167 check_interface = INTERFACE_A;
168
169 if (ftdi->index != check_interface)
170 ftdi_error_return(-3, "Interface can not be changed on an already open device");
171 }
172
22d12cda
TJ
173 switch (interface)
174 {
175 case INTERFACE_ANY:
176 case INTERFACE_A:
ac0af8ec
VY
177 ftdi->interface = 0;
178 ftdi->index = INTERFACE_A;
179 ftdi->in_ep = 0x02;
180 ftdi->out_ep = 0x81;
22d12cda
TJ
181 break;
182 case INTERFACE_B:
183 ftdi->interface = 1;
184 ftdi->index = INTERFACE_B;
185 ftdi->in_ep = 0x04;
186 ftdi->out_ep = 0x83;
187 break;
f9d69895
AH
188 case INTERFACE_C:
189 ftdi->interface = 2;
190 ftdi->index = INTERFACE_C;
191 ftdi->in_ep = 0x06;
192 ftdi->out_ep = 0x85;
193 break;
194 case INTERFACE_D:
195 ftdi->interface = 3;
196 ftdi->index = INTERFACE_D;
197 ftdi->in_ep = 0x08;
198 ftdi->out_ep = 0x87;
199 break;
22d12cda
TJ
200 default:
201 ftdi_error_return(-1, "Unknown interface");
c4446c36
TJ
202 }
203 return 0;
204}
948f9ada 205
1941414d
TJ
206/**
207 Deinitializes a ftdi_context.
4837f98a 208
1941414d 209 \param ftdi pointer to ftdi_context
4837f98a 210*/
a8f46ddc
TJ
211void ftdi_deinit(struct ftdi_context *ftdi)
212{
22a1b5c1
TJ
213 if (ftdi == NULL)
214 return;
215
f3f81007 216 ftdi_usb_close_internal (ftdi);
dff4fdb0 217
22d12cda
TJ
218 if (ftdi->readbuffer != NULL)
219 {
d9f0cce7
TJ
220 free(ftdi->readbuffer);
221 ftdi->readbuffer = NULL;
948f9ada 222 }
a35aa9bd
UB
223
224 if (ftdi->eeprom != NULL)
225 {
74e8e79d
UB
226 if (ftdi->eeprom->manufacturer != 0)
227 {
228 free(ftdi->eeprom->manufacturer);
229 ftdi->eeprom->manufacturer = 0;
230 }
231 if (ftdi->eeprom->product != 0)
232 {
233 free(ftdi->eeprom->product);
234 ftdi->eeprom->product = 0;
235 }
236 if (ftdi->eeprom->serial != 0)
237 {
238 free(ftdi->eeprom->serial);
239 ftdi->eeprom->serial = 0;
240 }
a35aa9bd
UB
241 free(ftdi->eeprom);
242 ftdi->eeprom = NULL;
243 }
3a284749
TJ
244
245 if (ftdi->usb_ctx)
246 {
247 libusb_exit(ftdi->usb_ctx);
248 ftdi->usb_ctx = NULL;
249 }
a3da1d95
GE
250}
251
1941414d 252/**
cef378aa
TJ
253 Deinitialize and free an ftdi_context.
254
255 \param ftdi pointer to ftdi_context
256*/
257void ftdi_free(struct ftdi_context *ftdi)
258{
259 ftdi_deinit(ftdi);
260 free(ftdi);
261}
262
263/**
1941414d
TJ
264 Use an already open libusb device.
265
266 \param ftdi pointer to ftdi_context
579b006f 267 \param usb libusb libusb_device_handle to use
4837f98a 268*/
579b006f 269void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb)
a8f46ddc 270{
22a1b5c1
TJ
271 if (ftdi == NULL)
272 return;
273
98452d97
TJ
274 ftdi->usb_dev = usb;
275}
276
0220adfa
TJ
277/**
278 * @brief Get libftdi library version
279 *
280 * @return ftdi_version_info Library version information
281 **/
bd6941fd 282struct ftdi_version_info ftdi_get_library_version(void)
0220adfa
TJ
283{
284 struct ftdi_version_info ver;
285
286 ver.major = FTDI_MAJOR_VERSION;
287 ver.minor = FTDI_MINOR_VERSION;
288 ver.micro = FTDI_MICRO_VERSION;
289 ver.version_str = FTDI_VERSION_STRING;
290 ver.snapshot_str = FTDI_SNAPSHOT_VERSION;
291
292 return ver;
293}
98452d97 294
1941414d 295/**
7879216a
UB
296 Finds all ftdi devices with given VID:PID on the usb bus. Creates a new
297 ftdi_device_list which needs to be deallocated by ftdi_list_free() after
298 use. With VID:PID 0:0, search for the default devices
809d711d 299 (0x403:0x6001, 0x403:0x6010, 0x403:0x6011, 0x403:0x6014, 0x403:0x6015)
1941414d
TJ
300
301 \param ftdi pointer to ftdi_context
302 \param devlist Pointer where to store list of found devices
303 \param vendor Vendor ID to search for
304 \param product Product ID to search for
edb82cbf 305
1941414d 306 \retval >0: number of devices found
1941414d 307 \retval -3: out of memory
579b006f
JZ
308 \retval -5: libusb_get_device_list() failed
309 \retval -6: libusb_get_device_descriptor() failed
edb82cbf 310*/
d2f10023 311int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product)
edb82cbf
TJ
312{
313 struct ftdi_device_list **curdev;
579b006f
JZ
314 libusb_device *dev;
315 libusb_device **devs;
edb82cbf 316 int count = 0;
579b006f
JZ
317 int i = 0;
318
02212d8e 319 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
579b006f 320 ftdi_error_return(-5, "libusb_get_device_list() failed");
edb82cbf
TJ
321
322 curdev = devlist;
6db32169 323 *curdev = NULL;
579b006f
JZ
324
325 while ((dev = devs[i++]) != NULL)
22d12cda 326 {
579b006f 327 struct libusb_device_descriptor desc;
d2f10023 328
579b006f 329 if (libusb_get_device_descriptor(dev, &desc) < 0)
77377af7 330 ftdi_error_return_free_device_list(-6, "libusb_get_device_descriptor() failed", devs);
edb82cbf 331
8de26dde 332 if (((vendor || product) &&
74387f27 333 desc.idVendor == vendor && desc.idProduct == product) ||
8de26dde 334 (!(vendor || product) &&
74387f27 335 (desc.idVendor == 0x403) && (desc.idProduct == 0x6001 || desc.idProduct == 0x6010
809d711d
TJ
336 || desc.idProduct == 0x6011 || desc.idProduct == 0x6014
337 || desc.idProduct == 0x6015)))
579b006f
JZ
338 {
339 *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list));
340 if (!*curdev)
77377af7 341 ftdi_error_return_free_device_list(-3, "out of memory", devs);
56ac0383 342
579b006f
JZ
343 (*curdev)->next = NULL;
344 (*curdev)->dev = dev;
0c33162c 345 libusb_ref_device(dev);
579b006f
JZ
346 curdev = &(*curdev)->next;
347 count++;
edb82cbf
TJ
348 }
349 }
77377af7 350 libusb_free_device_list(devs,1);
edb82cbf
TJ
351 return count;
352}
353
1941414d
TJ
354/**
355 Frees a usb device list.
edb82cbf 356
1941414d 357 \param devlist USB device list created by ftdi_usb_find_all()
edb82cbf 358*/
d2f10023 359void ftdi_list_free(struct ftdi_device_list **devlist)
edb82cbf 360{
6db32169
TJ
361 struct ftdi_device_list *curdev, *next;
362
22d12cda
TJ
363 for (curdev = *devlist; curdev != NULL;)
364 {
6db32169 365 next = curdev->next;
0c33162c 366 libusb_unref_device(curdev->dev);
6db32169
TJ
367 free(curdev);
368 curdev = next;
edb82cbf
TJ
369 }
370
6db32169 371 *devlist = NULL;
edb82cbf
TJ
372}
373
1941414d 374/**
cef378aa
TJ
375 Frees a usb device list.
376
377 \param devlist USB device list created by ftdi_usb_find_all()
378*/
379void ftdi_list_free2(struct ftdi_device_list *devlist)
380{
381 ftdi_list_free(&devlist);
382}
383
384/**
474786c0
TJ
385 Return device ID strings from the usb device.
386
387 The parameters manufacturer, description and serial may be NULL
388 or pointer to buffers to store the fetched strings.
389
898c34dd
TJ
390 \note Use this function only in combination with ftdi_usb_find_all()
391 as it closes the internal "usb_dev" after use.
392
474786c0
TJ
393 \param ftdi pointer to ftdi_context
394 \param dev libusb usb_dev to use
395 \param manufacturer Store manufacturer string here if not NULL
396 \param mnf_len Buffer size of manufacturer string
397 \param description Store product description string here if not NULL
398 \param desc_len Buffer size of product description string
399 \param serial Store serial string here if not NULL
400 \param serial_len Buffer size of serial string
401
402 \retval 0: all fine
403 \retval -1: wrong arguments
404 \retval -4: unable to open device
405 \retval -7: get product manufacturer failed
406 \retval -8: get product description failed
407 \retval -9: get serial number failed
579b006f 408 \retval -11: libusb_get_device_descriptor() failed
474786c0 409*/
15079e78
FH
410int ftdi_usb_get_strings(struct ftdi_context *ftdi,
411 struct libusb_device *dev,
412 char *manufacturer, int mnf_len,
413 char *description, int desc_len,
414 char *serial, int serial_len)
474786c0 415{
15079e78 416 int ret;
579b006f 417
474786c0
TJ
418 if ((ftdi==NULL) || (dev==NULL))
419 return -1;
420
bc384123 421 if (ftdi->usb_dev == NULL && libusb_open(dev, &ftdi->usb_dev) < 0)
15079e78
FH
422 ftdi_error_return(-4, "libusb_open() failed");
423
424 // ftdi->usb_dev will not be NULL when entering ftdi_usb_get_strings2(), so
425 // it won't be closed either. This allows us to close it whether we actually
426 // called libusb_open() up above or not. This matches the expected behavior
427 // (and note) for ftdi_usb_get_strings().
428 ret = ftdi_usb_get_strings2(ftdi, dev,
429 manufacturer, mnf_len,
430 description, desc_len,
431 serial, serial_len);
432
433 // only close it if it was successful, as all other return codes close
434 // before returning already.
435 if (ret == 0)
436 ftdi_usb_close_internal(ftdi);
437
438 return ret;
439}
440
441/**
442 Return device ID strings from the usb device.
443
444 The parameters manufacturer, description and serial may be NULL
445 or pointer to buffers to store the fetched strings.
446
447 \note The old function ftdi_usb_get_strings() always closes the device.
448 This version only closes the device if it was opened by it.
449
450 \param ftdi pointer to ftdi_context
451 \param dev libusb usb_dev to use
452 \param manufacturer Store manufacturer string here if not NULL
453 \param mnf_len Buffer size of manufacturer string
454 \param description Store product description string here if not NULL
455 \param desc_len Buffer size of product description string
456 \param serial Store serial string here if not NULL
457 \param serial_len Buffer size of serial string
458
459 \retval 0: all fine
460 \retval -1: wrong arguments
461 \retval -4: unable to open device
462 \retval -7: get product manufacturer failed
463 \retval -8: get product description failed
464 \retval -9: get serial number failed
465 \retval -11: libusb_get_device_descriptor() failed
466*/
467int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev,
468 char *manufacturer, int mnf_len,
469 char *description, int desc_len,
470 char *serial, int serial_len)
471{
472 struct libusb_device_descriptor desc;
c45d2630 473 char need_open;
15079e78
FH
474
475 if ((ftdi==NULL) || (dev==NULL))
476 return -1;
477
c45d2630 478 need_open = (ftdi->usb_dev == NULL);
15079e78
FH
479 if (need_open && libusb_open(dev, &ftdi->usb_dev) < 0)
480 ftdi_error_return(-4, "libusb_open() failed");
579b006f
JZ
481
482 if (libusb_get_device_descriptor(dev, &desc) < 0)
483 ftdi_error_return(-11, "libusb_get_device_descriptor() failed");
474786c0 484
22d12cda
TJ
485 if (manufacturer != NULL)
486 {
579b006f 487 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0)
22d12cda 488 {
f3f81007 489 ftdi_usb_close_internal (ftdi);
579b006f 490 ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed");
474786c0
TJ
491 }
492 }
493
22d12cda
TJ
494 if (description != NULL)
495 {
579b006f 496 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0)
22d12cda 497 {
f3f81007 498 ftdi_usb_close_internal (ftdi);
579b006f 499 ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed");
474786c0
TJ
500 }
501 }
502
22d12cda
TJ
503 if (serial != NULL)
504 {
579b006f 505 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0)
22d12cda 506 {
f3f81007 507 ftdi_usb_close_internal (ftdi);
579b006f 508 ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed");
474786c0
TJ
509 }
510 }
511
15079e78
FH
512 if (need_open)
513 ftdi_usb_close_internal (ftdi);
474786c0
TJ
514
515 return 0;
516}
517
518/**
e2f12a4f
TJ
519 * Internal function to determine the maximum packet size.
520 * \param ftdi pointer to ftdi_context
521 * \param dev libusb usb_dev to use
522 * \retval Maximum packet size for this device
523 */
579b006f 524static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev)
e2f12a4f 525{
579b006f
JZ
526 struct libusb_device_descriptor desc;
527 struct libusb_config_descriptor *config0;
e2f12a4f
TJ
528 unsigned int packet_size;
529
22a1b5c1
TJ
530 // Sanity check
531 if (ftdi == NULL || dev == NULL)
532 return 64;
533
e2f12a4f
TJ
534 // Determine maximum packet size. Init with default value.
535 // New hi-speed devices from FTDI use a packet size of 512 bytes
536 // but could be connected to a normal speed USB hub -> 64 bytes packet size.
6ae693b2 537 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
e2f12a4f
TJ
538 packet_size = 512;
539 else
540 packet_size = 64;
541
579b006f
JZ
542 if (libusb_get_device_descriptor(dev, &desc) < 0)
543 return packet_size;
544
545 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
546 return packet_size;
e2f12a4f 547
579b006f
JZ
548 if (desc.bNumConfigurations > 0)
549 {
550 if (ftdi->interface < config0->bNumInterfaces)
e2f12a4f 551 {
579b006f 552 struct libusb_interface interface = config0->interface[ftdi->interface];
e2f12a4f
TJ
553 if (interface.num_altsetting > 0)
554 {
579b006f 555 struct libusb_interface_descriptor descriptor = interface.altsetting[0];
e2f12a4f
TJ
556 if (descriptor.bNumEndpoints > 0)
557 {
558 packet_size = descriptor.endpoint[0].wMaxPacketSize;
559 }
560 }
561 }
562 }
563
579b006f 564 libusb_free_config_descriptor (config0);
e2f12a4f
TJ
565 return packet_size;
566}
567
568/**
418aaa72 569 Opens a ftdi device given by an usb_device.
7b18bef6 570
1941414d
TJ
571 \param ftdi pointer to ftdi_context
572 \param dev libusb usb_dev to use
573
574 \retval 0: all fine
23b1798d 575 \retval -3: unable to config device
1941414d
TJ
576 \retval -4: unable to open device
577 \retval -5: unable to claim device
578 \retval -6: reset failed
579 \retval -7: set baudrate failed
22a1b5c1 580 \retval -8: ftdi context invalid
579b006f
JZ
581 \retval -9: libusb_get_device_descriptor() failed
582 \retval -10: libusb_get_config_descriptor() failed
e375e6cb 583 \retval -11: libusb_detach_kernel_driver() failed
579b006f 584 \retval -12: libusb_get_configuration() failed
7b18bef6 585*/
579b006f 586int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev)
7b18bef6 587{
579b006f
JZ
588 struct libusb_device_descriptor desc;
589 struct libusb_config_descriptor *config0;
43aee24f 590 int cfg, cfg0, detach_errno = 0;
579b006f 591
22a1b5c1
TJ
592 if (ftdi == NULL)
593 ftdi_error_return(-8, "ftdi context invalid");
594
579b006f
JZ
595 if (libusb_open(dev, &ftdi->usb_dev) < 0)
596 ftdi_error_return(-4, "libusb_open() failed");
597
598 if (libusb_get_device_descriptor(dev, &desc) < 0)
599 ftdi_error_return(-9, "libusb_get_device_descriptor() failed");
600
601 if (libusb_get_config_descriptor(dev, 0, &config0) < 0)
602 ftdi_error_return(-10, "libusb_get_config_descriptor() failed");
603 cfg0 = config0->bConfigurationValue;
604 libusb_free_config_descriptor (config0);
d2f10023 605
22592e17 606 // Try to detach ftdi_sio kernel module.
22592e17
TJ
607 //
608 // The return code is kept in a separate variable and only parsed
609 // if usb_set_configuration() or usb_claim_interface() fails as the
610 // detach operation might be denied and everything still works fine.
611 // Likely scenario is a static ftdi_sio kernel module.
a3d86bdb
TJ
612 if (ftdi->module_detach_mode == AUTO_DETACH_SIO_MODULE)
613 {
614 if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0)
615 detach_errno = errno;
616 }
d2f10023 617
579b006f
JZ
618 if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0)
619 ftdi_error_return(-12, "libusb_get_configuration () failed");
b57aedfd
GE
620 // set configuration (needed especially for windows)
621 // tolerate EBUSY: one device with one configuration, but two interfaces
622 // and libftdi sessions to both interfaces (e.g. FT2232)
579b006f 623 if (desc.bNumConfigurations > 0 && cfg != cfg0)
b57aedfd 624 {
579b006f 625 if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0)
22d12cda 626 {
a56ba2bd 627 ftdi_usb_close_internal (ftdi);
56ac0383 628 if (detach_errno == EPERM)
43aee24f
UB
629 {
630 ftdi_error_return(-8, "inappropriate permissions on device!");
631 }
632 else
633 {
c16b162d 634 ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use");
43aee24f 635 }
23b1798d
TJ
636 }
637 }
638
579b006f 639 if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0)
22d12cda 640 {
f3f81007 641 ftdi_usb_close_internal (ftdi);
56ac0383 642 if (detach_errno == EPERM)
43aee24f
UB
643 {
644 ftdi_error_return(-8, "inappropriate permissions on device!");
645 }
646 else
647 {
c16b162d 648 ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use");
43aee24f 649 }
7b18bef6
TJ
650 }
651
22d12cda
TJ
652 if (ftdi_usb_reset (ftdi) != 0)
653 {
f3f81007 654 ftdi_usb_close_internal (ftdi);
7b18bef6
TJ
655 ftdi_error_return(-6, "ftdi_usb_reset failed");
656 }
657
7b18bef6
TJ
658 // Try to guess chip type
659 // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0
579b006f 660 if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200
56ac0383 661 && desc.iSerialNumber == 0))
7b18bef6 662 ftdi->type = TYPE_BM;
579b006f 663 else if (desc.bcdDevice == 0x200)
7b18bef6 664 ftdi->type = TYPE_AM;
579b006f 665 else if (desc.bcdDevice == 0x500)
7b18bef6 666 ftdi->type = TYPE_2232C;
579b006f 667 else if (desc.bcdDevice == 0x600)
cb6250fa 668 ftdi->type = TYPE_R;
579b006f 669 else if (desc.bcdDevice == 0x700)
0beb9686 670 ftdi->type = TYPE_2232H;
579b006f 671 else if (desc.bcdDevice == 0x800)
0beb9686 672 ftdi->type = TYPE_4232H;
c7e4c09e
UB
673 else if (desc.bcdDevice == 0x900)
674 ftdi->type = TYPE_232H;
2f80efc2
NP
675 else if (desc.bcdDevice == 0x1000)
676 ftdi->type = TYPE_230X;
7b18bef6 677
e2f12a4f
TJ
678 // Determine maximum packet size
679 ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev);
680
ef6f4838
TE
681 if (ftdi_set_baudrate (ftdi, 9600) != 0)
682 {
683 ftdi_usb_close_internal (ftdi);
684 ftdi_error_return(-7, "set baudrate failed");
685 }
686
7b18bef6
TJ
687 ftdi_error_return(0, "all fine");
688}
689
1941414d
TJ
690/**
691 Opens the first device with a given vendor and product ids.
692
693 \param ftdi pointer to ftdi_context
694 \param vendor Vendor ID
695 \param product Product ID
696
9bec2387 697 \retval same as ftdi_usb_open_desc()
1941414d 698*/
edb82cbf
TJ
699int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product)
700{
701 return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL);
702}
703
1941414d
TJ
704/**
705 Opens the first device with a given, vendor id, product id,
706 description and serial.
707
708 \param ftdi pointer to ftdi_context
709 \param vendor Vendor ID
710 \param product Product ID
711 \param description Description to search for. Use NULL if not needed.
712 \param serial Serial to search for. Use NULL if not needed.
713
714 \retval 0: all fine
1941414d
TJ
715 \retval -3: usb device not found
716 \retval -4: unable to open device
717 \retval -5: unable to claim device
718 \retval -6: reset failed
719 \retval -7: set baudrate failed
720 \retval -8: get product description failed
721 \retval -9: get serial number failed
579b006f
JZ
722 \retval -12: libusb_get_device_list() failed
723 \retval -13: libusb_get_device_descriptor() failed
a3da1d95 724*/
04e1ea0a 725int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product,
a8f46ddc
TJ
726 const char* description, const char* serial)
727{
5ebbdab9
GE
728 return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0);
729}
730
731/**
732 Opens the index-th device with a given, vendor id, product id,
733 description and serial.
734
735 \param ftdi pointer to ftdi_context
736 \param vendor Vendor ID
737 \param product Product ID
738 \param description Description to search for. Use NULL if not needed.
739 \param serial Serial to search for. Use NULL if not needed.
740 \param index Number of matching device to open if there are more than one, starts with 0.
741
742 \retval 0: all fine
743 \retval -1: usb_find_busses() failed
744 \retval -2: usb_find_devices() failed
745 \retval -3: usb device not found
746 \retval -4: unable to open device
747 \retval -5: unable to claim device
748 \retval -6: reset failed
749 \retval -7: set baudrate failed
750 \retval -8: get product description failed
751 \retval -9: get serial number failed
752 \retval -10: unable to close device
22a1b5c1 753 \retval -11: ftdi context invalid
4fe1a3f0 754 \retval -12: libusb_get_device_list() failed
5ebbdab9
GE
755*/
756int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product,
56ac0383 757 const char* description, const char* serial, unsigned int index)
5ebbdab9 758{
579b006f
JZ
759 libusb_device *dev;
760 libusb_device **devs;
c3d95b87 761 char string[256];
579b006f 762 int i = 0;
98452d97 763
22a1b5c1
TJ
764 if (ftdi == NULL)
765 ftdi_error_return(-11, "ftdi context invalid");
766
02212d8e 767 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
99650502
UB
768 ftdi_error_return(-12, "libusb_get_device_list() failed");
769
579b006f 770 while ((dev = devs[i++]) != NULL)
22d12cda 771 {
579b006f 772 struct libusb_device_descriptor desc;
99650502 773 int res;
579b006f
JZ
774
775 if (libusb_get_device_descriptor(dev, &desc) < 0)
99650502 776 ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs);
579b006f
JZ
777
778 if (desc.idVendor == vendor && desc.idProduct == product)
22d12cda 779 {
579b006f 780 if (libusb_open(dev, &ftdi->usb_dev) < 0)
99650502 781 ftdi_error_return_free_device_list(-4, "usb_open() failed", devs);
c3d95b87 782
579b006f
JZ
783 if (description != NULL)
784 {
785 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0)
22d12cda 786 {
d4afae5f 787 ftdi_usb_close_internal (ftdi);
99650502 788 ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs);
a8f46ddc 789 }
579b006f 790 if (strncmp(string, description, sizeof(string)) != 0)
22d12cda 791 {
d4afae5f 792 ftdi_usb_close_internal (ftdi);
579b006f 793 continue;
a8f46ddc 794 }
579b006f
JZ
795 }
796 if (serial != NULL)
797 {
798 if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0)
799 {
800 ftdi_usb_close_internal (ftdi);
99650502 801 ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs);
579b006f
JZ
802 }
803 if (strncmp(string, serial, sizeof(string)) != 0)
804 {
805 ftdi_usb_close_internal (ftdi);
806 continue;
807 }
808 }
98452d97 809
579b006f 810 ftdi_usb_close_internal (ftdi);
d2f10023 811
56ac0383
TJ
812 if (index > 0)
813 {
814 index--;
815 continue;
816 }
5ebbdab9 817
99650502
UB
818 res = ftdi_usb_open_dev(ftdi, dev);
819 libusb_free_device_list(devs,1);
814e69f5
MD
820 return res;
821 }
822 }
823
824 // device not found
825 ftdi_error_return_free_device_list(-3, "device not found", devs);
826}
827
828/**
30ea3095 829 Opens the device at a given USB bus and device address.
814e69f5
MD
830
831 \param ftdi pointer to ftdi_context
832 \param bus Bus number
30ea3095 833 \param addr Device address
814e69f5
MD
834
835 \retval 0: all fine
836 \retval -1: usb_find_busses() failed
837 \retval -2: usb_find_devices() failed
838 \retval -3: usb device not found
839 \retval -4: unable to open device
840 \retval -5: unable to claim device
841 \retval -6: reset failed
842 \retval -7: set baudrate failed
843 \retval -8: get product description failed
844 \retval -9: get serial number failed
845 \retval -10: unable to close device
846 \retval -11: ftdi context invalid
4fe1a3f0 847 \retval -12: libusb_get_device_list() failed
814e69f5 848*/
30ea3095 849int ftdi_usb_open_bus_addr(struct ftdi_context *ftdi, uint8_t bus, uint8_t addr)
814e69f5
MD
850{
851 libusb_device *dev;
852 libusb_device **devs;
853 int i = 0;
854
855 if (ftdi == NULL)
856 ftdi_error_return(-11, "ftdi context invalid");
857
858 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
859 ftdi_error_return(-12, "libusb_get_device_list() failed");
860
861 while ((dev = devs[i++]) != NULL)
862 {
30ea3095 863 if (libusb_get_bus_number(dev) == bus && libusb_get_device_address(dev) == addr)
814e69f5
MD
864 {
865 int res;
866 res = ftdi_usb_open_dev(ftdi, dev);
867 libusb_free_device_list(devs,1);
99650502 868 return res;
98452d97 869 }
98452d97 870 }
a3da1d95 871
98452d97 872 // device not found
99650502 873 ftdi_error_return_free_device_list(-3, "device not found", devs);
a3da1d95
GE
874}
875
1941414d 876/**
5ebbdab9
GE
877 Opens the ftdi-device described by a description-string.
878 Intended to be used for parsing a device-description given as commandline argument.
879
880 \param ftdi pointer to ftdi_context
881 \param description NULL-terminated description-string, using this format:
882 \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/)
883 \li <tt>i:\<vendor>:\<product></tt> first device with given vendor and product id, ids can be decimal, octal (preceded by "0") or hex (preceded by "0x")
884 \li <tt>i:\<vendor>:\<product>:\<index></tt> as above with index being the number of the device (starting with 0) if there are more than one
885 \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string
886
887 \note The description format may be extended in later versions.
888
889 \retval 0: all fine
579b006f 890 \retval -2: libusb_get_device_list() failed
5ebbdab9
GE
891 \retval -3: usb device not found
892 \retval -4: unable to open device
893 \retval -5: unable to claim device
894 \retval -6: reset failed
895 \retval -7: set baudrate failed
896 \retval -8: get product description failed
897 \retval -9: get serial number failed
898 \retval -10: unable to close device
899 \retval -11: illegal description format
22a1b5c1 900 \retval -12: ftdi context invalid
5ebbdab9
GE
901*/
902int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description)
903{
22a1b5c1
TJ
904 if (ftdi == NULL)
905 ftdi_error_return(-12, "ftdi context invalid");
906
5ebbdab9
GE
907 if (description[0] == 0 || description[1] != ':')
908 ftdi_error_return(-11, "illegal description format");
909
910 if (description[0] == 'd')
911 {
579b006f
JZ
912 libusb_device *dev;
913 libusb_device **devs;
56ac0383
TJ
914 unsigned int bus_number, device_address;
915 int i = 0;
579b006f 916
56ac0383
TJ
917 if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0)
918 ftdi_error_return(-2, "libusb_get_device_list() failed");
5ebbdab9 919
579b006f
JZ
920 /* XXX: This doesn't handle symlinks/odd paths/etc... */
921 if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2)
56ac0383 922 ftdi_error_return_free_device_list(-11, "illegal description format", devs);
5ebbdab9 923
56ac0383 924 while ((dev = devs[i++]) != NULL)
5ebbdab9 925 {
99650502 926 int ret;
56ac0383
TJ
927 if (bus_number == libusb_get_bus_number (dev)
928 && device_address == libusb_get_device_address (dev))
99650502
UB
929 {
930 ret = ftdi_usb_open_dev(ftdi, dev);
931 libusb_free_device_list(devs,1);
932 return ret;
933 }
5ebbdab9
GE
934 }
935
936 // device not found
99650502 937 ftdi_error_return_free_device_list(-3, "device not found", devs);
5ebbdab9
GE
938 }
939 else if (description[0] == 'i' || description[0] == 's')
940 {
941 unsigned int vendor;
942 unsigned int product;
943 unsigned int index=0;
0e6cf62b 944 const char *serial=NULL;
5ebbdab9
GE
945 const char *startp, *endp;
946
947 errno=0;
948 startp=description+2;
949 vendor=strtoul((char*)startp,(char**)&endp,0);
950 if (*endp != ':' || endp == startp || errno != 0)
951 ftdi_error_return(-11, "illegal description format");
952
953 startp=endp+1;
954 product=strtoul((char*)startp,(char**)&endp,0);
955 if (endp == startp || errno != 0)
956 ftdi_error_return(-11, "illegal description format");
957
958 if (description[0] == 'i' && *endp != 0)
959 {
960 /* optional index field in i-mode */
961 if (*endp != ':')
962 ftdi_error_return(-11, "illegal description format");
963
964 startp=endp+1;
965 index=strtoul((char*)startp,(char**)&endp,0);
966 if (*endp != 0 || endp == startp || errno != 0)
967 ftdi_error_return(-11, "illegal description format");
968 }
969 if (description[0] == 's')
970 {
971 if (*endp != ':')
972 ftdi_error_return(-11, "illegal description format");
973
974 /* rest of the description is the serial */
975 serial=endp+1;
976 }
977
978 return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index);
979 }
980 else
981 {
982 ftdi_error_return(-11, "illegal description format");
983 }
984}
985
986/**
1941414d 987 Resets the ftdi device.
a3da1d95 988
1941414d
TJ
989 \param ftdi pointer to ftdi_context
990
991 \retval 0: all fine
992 \retval -1: FTDI reset failed
22a1b5c1 993 \retval -2: USB device unavailable
4837f98a 994*/
edb82cbf 995int ftdi_usb_reset(struct ftdi_context *ftdi)
a8f46ddc 996{
22a1b5c1
TJ
997 if (ftdi == NULL || ftdi->usb_dev == NULL)
998 ftdi_error_return(-2, "USB device unavailable");
999
579b006f
JZ
1000 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1001 SIO_RESET_REQUEST, SIO_RESET_SIO,
1002 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
22d12cda 1003 ftdi_error_return(-1,"FTDI reset failed");
c3d95b87 1004
545820ce 1005 // Invalidate data in the readbuffer
bfcee05b
TJ
1006 ftdi->readbuffer_offset = 0;
1007 ftdi->readbuffer_remaining = 0;
1008
a3da1d95
GE
1009 return 0;
1010}
1011
1941414d 1012/**
1189b11a 1013 Clears the read buffer on the chip and the internal read buffer.
1941414d
TJ
1014
1015 \param ftdi pointer to ftdi_context
4837f98a 1016
1941414d 1017 \retval 0: all fine
1189b11a 1018 \retval -1: read buffer purge failed
22a1b5c1 1019 \retval -2: USB device unavailable
4837f98a 1020*/
1189b11a 1021int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)
a8f46ddc 1022{
22a1b5c1
TJ
1023 if (ftdi == NULL || ftdi->usb_dev == NULL)
1024 ftdi_error_return(-2, "USB device unavailable");
1025
579b006f
JZ
1026 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1027 SIO_RESET_REQUEST, SIO_RESET_PURGE_RX,
1028 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87
TJ
1029 ftdi_error_return(-1, "FTDI purge of RX buffer failed");
1030
545820ce 1031 // Invalidate data in the readbuffer
bfcee05b
TJ
1032 ftdi->readbuffer_offset = 0;
1033 ftdi->readbuffer_remaining = 0;
a60be878 1034
1189b11a
TJ
1035 return 0;
1036}
1037
1038/**
1039 Clears the write buffer on the chip.
1040
1041 \param ftdi pointer to ftdi_context
1042
1043 \retval 0: all fine
1044 \retval -1: write buffer purge failed
22a1b5c1 1045 \retval -2: USB device unavailable
1189b11a
TJ
1046*/
1047int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)
1048{
22a1b5c1
TJ
1049 if (ftdi == NULL || ftdi->usb_dev == NULL)
1050 ftdi_error_return(-2, "USB device unavailable");
1051
579b006f
JZ
1052 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1053 SIO_RESET_REQUEST, SIO_RESET_PURGE_TX,
1054 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1189b11a
TJ
1055 ftdi_error_return(-1, "FTDI purge of TX buffer failed");
1056
1057 return 0;
1058}
1059
1060/**
1061 Clears the buffers on the chip and the internal read buffer.
1062
1063 \param ftdi pointer to ftdi_context
1064
1065 \retval 0: all fine
1066 \retval -1: read buffer purge failed
1067 \retval -2: write buffer purge failed
22a1b5c1 1068 \retval -3: USB device unavailable
1189b11a
TJ
1069*/
1070int ftdi_usb_purge_buffers(struct ftdi_context *ftdi)
1071{
1072 int result;
1073
22a1b5c1
TJ
1074 if (ftdi == NULL || ftdi->usb_dev == NULL)
1075 ftdi_error_return(-3, "USB device unavailable");
1076
1189b11a 1077 result = ftdi_usb_purge_rx_buffer(ftdi);
5a2b51cb 1078 if (result < 0)
1189b11a
TJ
1079 return -1;
1080
1081 result = ftdi_usb_purge_tx_buffer(ftdi);
5a2b51cb 1082 if (result < 0)
1189b11a 1083 return -2;
545820ce 1084
a60be878
TJ
1085 return 0;
1086}
a3da1d95 1087
f3f81007
TJ
1088
1089
1941414d
TJ
1090/**
1091 Closes the ftdi device. Call ftdi_deinit() if you're cleaning up.
1092
1093 \param ftdi pointer to ftdi_context
1094
1095 \retval 0: all fine
1096 \retval -1: usb_release failed
22a1b5c1 1097 \retval -3: ftdi context invalid
a3da1d95 1098*/
a8f46ddc
TJ
1099int ftdi_usb_close(struct ftdi_context *ftdi)
1100{
a3da1d95
GE
1101 int rtn = 0;
1102
22a1b5c1
TJ
1103 if (ftdi == NULL)
1104 ftdi_error_return(-3, "ftdi context invalid");
1105
dff4fdb0 1106 if (ftdi->usb_dev != NULL)
579b006f 1107 if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0)
dff4fdb0 1108 rtn = -1;
98452d97 1109
579b006f 1110 ftdi_usb_close_internal (ftdi);
98452d97 1111
a3da1d95
GE
1112 return rtn;
1113}
1114
74387f27 1115/* ftdi_to_clkbits_AM For the AM device, convert a requested baudrate
f15786e4 1116 to encoded divisor and the achievable baudrate
53ad271d 1117 Function is only used internally
b5ec1820 1118 \internal
f15786e4
UB
1119
1120 See AN120
1121 clk/1 -> 0
1122 clk/1.5 -> 1
1123 clk/2 -> 2
1124 From /2, 0.125/ 0.25 and 0.5 steps may be taken
1125 The fractional part has frac_code encoding
53ad271d 1126*/
f15786e4
UB
1127static int ftdi_to_clkbits_AM(int baudrate, unsigned long *encoded_divisor)
1128
a8f46ddc 1129{
f15786e4 1130 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
53ad271d
TJ
1131 static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1};
1132 static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3};
53ad271d 1133 int divisor, best_divisor, best_baud, best_baud_diff;
f15786e4 1134 int i;
32e2d8b0 1135 divisor = 24000000 / baudrate;
53ad271d 1136
f15786e4
UB
1137 // Round down to supported fraction (AM only)
1138 divisor -= am_adjust_dn[divisor & 7];
53ad271d
TJ
1139
1140 // Try this divisor and the one above it (because division rounds down)
1141 best_divisor = 0;
1142 best_baud = 0;
1143 best_baud_diff = 0;
22d12cda
TJ
1144 for (i = 0; i < 2; i++)
1145 {
53ad271d
TJ
1146 int try_divisor = divisor + i;
1147 int baud_estimate;
1148 int baud_diff;
1149
1150 // Round up to supported divisor value
22d12cda
TJ
1151 if (try_divisor <= 8)
1152 {
53ad271d
TJ
1153 // Round up to minimum supported divisor
1154 try_divisor = 8;
22d12cda 1155 }
22d12cda
TJ
1156 else if (divisor < 16)
1157 {
53ad271d
TJ
1158 // AM doesn't support divisors 9 through 15 inclusive
1159 try_divisor = 16;
22d12cda
TJ
1160 }
1161 else
1162 {
f15786e4
UB
1163 // Round up to supported fraction (AM only)
1164 try_divisor += am_adjust_up[try_divisor & 7];
1165 if (try_divisor > 0x1FFF8)
22d12cda 1166 {
f15786e4
UB
1167 // Round down to maximum supported divisor value (for AM)
1168 try_divisor = 0x1FFF8;
53ad271d
TJ
1169 }
1170 }
1171 // Get estimated baud rate (to nearest integer)
1172 baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor;
1173 // Get absolute difference from requested baud rate
22d12cda
TJ
1174 if (baud_estimate < baudrate)
1175 {
53ad271d 1176 baud_diff = baudrate - baud_estimate;
22d12cda
TJ
1177 }
1178 else
1179 {
53ad271d
TJ
1180 baud_diff = baud_estimate - baudrate;
1181 }
22d12cda
TJ
1182 if (i == 0 || baud_diff < best_baud_diff)
1183 {
53ad271d
TJ
1184 // Closest to requested baud rate so far
1185 best_divisor = try_divisor;
1186 best_baud = baud_estimate;
1187 best_baud_diff = baud_diff;
22d12cda
TJ
1188 if (baud_diff == 0)
1189 {
53ad271d
TJ
1190 // Spot on! No point trying
1191 break;
1192 }
1193 }
1194 }
1195 // Encode the best divisor value
f15786e4 1196 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14);
53ad271d 1197 // Deal with special cases for encoded value
f15786e4 1198 if (*encoded_divisor == 1)
22d12cda 1199 {
f15786e4 1200 *encoded_divisor = 0; // 3000000 baud
22d12cda 1201 }
f15786e4
UB
1202 else if (*encoded_divisor == 0x4001)
1203 {
1204 *encoded_divisor = 1; // 2000000 baud (BM only)
1205 }
1206 return best_baud;
1207}
1208
1209/* ftdi_to_clkbits Convert a requested baudrate for a given system clock and predivisor
1210 to encoded divisor and the achievable baudrate
1211 Function is only used internally
1212 \internal
1213
1214 See AN120
1215 clk/1 -> 0
1216 clk/1.5 -> 1
1217 clk/2 -> 2
1218 From /2, 0.125 steps may be taken.
1219 The fractional part has frac_code encoding
9956d428
UB
1220
1221 value[13:0] of value is the divisor
1222 index[9] mean 12 MHz Base(120 MHz/10) rate versus 3 MHz (48 MHz/16) else
1223
1224 H Type have all features above with
1225 {index[8],value[15:14]} is the encoded subdivisor
1226
74387f27 1227 FT232R, FT2232 and FT232BM have no option for 12 MHz and with
9956d428
UB
1228 {index[0],value[15:14]} is the encoded subdivisor
1229
1230 AM Type chips have only four fractional subdivisors at value[15:14]
1231 for subdivisors 0, 0.5, 0.25, 0.125
f15786e4
UB
1232*/
1233static int ftdi_to_clkbits(int baudrate, unsigned int clk, int clk_div, unsigned long *encoded_divisor)
1234{
1235 static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7};
1236 int best_baud = 0;
1237 int divisor, best_divisor;
1238 if (baudrate >= clk/clk_div)
1239 {
1240 *encoded_divisor = 0;
1241 best_baud = clk/clk_div;
1242 }
1243 else if (baudrate >= clk/(clk_div + clk_div/2))
1244 {
1245 *encoded_divisor = 1;
1246 best_baud = clk/(clk_div + clk_div/2);
1247 }
1248 else if (baudrate >= clk/(2*clk_div))
1249 {
1250 *encoded_divisor = 2;
1251 best_baud = clk/(2*clk_div);
1252 }
1253 else
1254 {
1255 /* We divide by 16 to have 3 fractional bits and one bit for rounding */
1256 divisor = clk*16/clk_div / baudrate;
1257 if (divisor & 1) /* Decide if to round up or down*/
1258 best_divisor = divisor /2 +1;
1259 else
1260 best_divisor = divisor/2;
1261 if(best_divisor > 0x20000)
1262 best_divisor = 0x1ffff;
aae08071
UB
1263 best_baud = clk*16/clk_div/best_divisor;
1264 if (best_baud & 1) /* Decide if to round up or down*/
1265 best_baud = best_baud /2 +1;
1266 else
1267 best_baud = best_baud /2;
f15786e4
UB
1268 *encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 0x7] << 14);
1269 }
1270 return best_baud;
74387f27 1271}
f15786e4
UB
1272/**
1273 ftdi_convert_baudrate returns nearest supported baud rate to that requested.
1274 Function is only used internally
1275 \internal
1276*/
1277static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi,
1278 unsigned short *value, unsigned short *index)
1279{
1280 int best_baud;
1281 unsigned long encoded_divisor;
1282
1283 if (baudrate <= 0)
1284 {
1285 // Return error
1286 return -1;
1287 }
1288
1289#define H_CLK 120000000
1290#define C_CLK 48000000
6ae693b2 1291 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H) || (ftdi->type == TYPE_232H))
f15786e4
UB
1292 {
1293 if(baudrate*10 > H_CLK /0x3fff)
1294 {
1295 /* On H Devices, use 12 000 000 Baudrate when possible
74387f27 1296 We have a 14 bit divisor, a 1 bit divisor switch (10 or 16)
f15786e4
UB
1297 three fractional bits and a 120 MHz clock
1298 Assume AN_120 "Sub-integer divisors between 0 and 2 are not allowed" holds for
1299 DIV/10 CLK too, so /1, /1.5 and /2 can be handled the same*/
1300 best_baud = ftdi_to_clkbits(baudrate, H_CLK, 10, &encoded_divisor);
1301 encoded_divisor |= 0x20000; /* switch on CLK/10*/
1302 }
1303 else
1304 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1305 }
913ca54f 1306 else if ((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C) || (ftdi->type == TYPE_R) || (ftdi->type == TYPE_230X))
f15786e4
UB
1307 {
1308 best_baud = ftdi_to_clkbits(baudrate, C_CLK, 16, &encoded_divisor);
1309 }
1310 else
22d12cda 1311 {
f15786e4 1312 best_baud = ftdi_to_clkbits_AM(baudrate, &encoded_divisor);
53ad271d
TJ
1313 }
1314 // Split into "value" and "index" values
1315 *value = (unsigned short)(encoded_divisor & 0xFFFF);
6ae693b2 1316 if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H || ftdi->type == TYPE_232H)
22d12cda 1317 {
0126d22e
TJ
1318 *index = (unsigned short)(encoded_divisor >> 8);
1319 *index &= 0xFF00;
a9c57c05 1320 *index |= ftdi->index;
0126d22e
TJ
1321 }
1322 else
1323 *index = (unsigned short)(encoded_divisor >> 16);
c3d95b87 1324
53ad271d
TJ
1325 // Return the nearest baud rate
1326 return best_baud;
1327}
1328
1941414d 1329/**
ac6944cc
TJ
1330 * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test
1331 * Do not use, it's only for the unit test framework
1332 **/
1333int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi,
74387f27 1334 unsigned short *value, unsigned short *index)
ac6944cc
TJ
1335{
1336 return ftdi_convert_baudrate(baudrate, ftdi, value, index);
1337}
1338
1339/**
9bec2387 1340 Sets the chip baud rate
1941414d
TJ
1341
1342 \param ftdi pointer to ftdi_context
9bec2387 1343 \param baudrate baud rate to set
1941414d
TJ
1344
1345 \retval 0: all fine
1346 \retval -1: invalid baudrate
1347 \retval -2: setting baudrate failed
22a1b5c1 1348 \retval -3: USB device unavailable
a3da1d95 1349*/
a8f46ddc
TJ
1350int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate)
1351{
53ad271d
TJ
1352 unsigned short value, index;
1353 int actual_baudrate;
a3da1d95 1354
22a1b5c1
TJ
1355 if (ftdi == NULL || ftdi->usb_dev == NULL)
1356 ftdi_error_return(-3, "USB device unavailable");
1357
22d12cda
TJ
1358 if (ftdi->bitbang_enabled)
1359 {
a3da1d95
GE
1360 baudrate = baudrate*4;
1361 }
1362
25707904 1363 actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index);
c3d95b87
TJ
1364 if (actual_baudrate <= 0)
1365 ftdi_error_return (-1, "Silly baudrate <= 0.");
a3da1d95 1366
53ad271d
TJ
1367 // Check within tolerance (about 5%)
1368 if ((actual_baudrate * 2 < baudrate /* Catch overflows */ )
1369 || ((actual_baudrate < baudrate)
1370 ? (actual_baudrate * 21 < baudrate * 20)
c3d95b87
TJ
1371 : (baudrate * 21 < actual_baudrate * 20)))
1372 ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4");
545820ce 1373
579b006f
JZ
1374 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1375 SIO_SET_BAUDRATE_REQUEST, value,
1376 index, NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87 1377 ftdi_error_return (-2, "Setting new baudrate failed");
a3da1d95
GE
1378
1379 ftdi->baudrate = baudrate;
1380 return 0;
1381}
1382
1941414d 1383/**
6c32e222
TJ
1384 Set (RS232) line characteristics.
1385 The break type can only be set via ftdi_set_line_property2()
1386 and defaults to "off".
4837f98a 1387
1941414d
TJ
1388 \param ftdi pointer to ftdi_context
1389 \param bits Number of bits
1390 \param sbit Number of stop bits
1391 \param parity Parity mode
1392
1393 \retval 0: all fine
1394 \retval -1: Setting line property failed
2f73e59f
TJ
1395*/
1396int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
d2f10023 1397 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
2f73e59f 1398{
6c32e222
TJ
1399 return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF);
1400}
1401
1402/**
1403 Set (RS232) line characteristics
1404
1405 \param ftdi pointer to ftdi_context
1406 \param bits Number of bits
1407 \param sbit Number of stop bits
1408 \param parity Parity mode
1409 \param break_type Break type
1410
1411 \retval 0: all fine
1412 \retval -1: Setting line property failed
22a1b5c1 1413 \retval -2: USB device unavailable
6c32e222
TJ
1414*/
1415int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
22d12cda
TJ
1416 enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
1417 enum ftdi_break_type break_type)
6c32e222 1418{
2f73e59f
TJ
1419 unsigned short value = bits;
1420
22a1b5c1
TJ
1421 if (ftdi == NULL || ftdi->usb_dev == NULL)
1422 ftdi_error_return(-2, "USB device unavailable");
1423
22d12cda
TJ
1424 switch (parity)
1425 {
1426 case NONE:
1427 value |= (0x00 << 8);
1428 break;
1429 case ODD:
1430 value |= (0x01 << 8);
1431 break;
1432 case EVEN:
1433 value |= (0x02 << 8);
1434 break;
1435 case MARK:
1436 value |= (0x03 << 8);
1437 break;
1438 case SPACE:
1439 value |= (0x04 << 8);
1440 break;
2f73e59f 1441 }
d2f10023 1442
22d12cda
TJ
1443 switch (sbit)
1444 {
1445 case STOP_BIT_1:
1446 value |= (0x00 << 11);
1447 break;
1448 case STOP_BIT_15:
1449 value |= (0x01 << 11);
1450 break;
1451 case STOP_BIT_2:
1452 value |= (0x02 << 11);
1453 break;
2f73e59f 1454 }
d2f10023 1455
22d12cda
TJ
1456 switch (break_type)
1457 {
1458 case BREAK_OFF:
1459 value |= (0x00 << 14);
1460 break;
1461 case BREAK_ON:
1462 value |= (0x01 << 14);
1463 break;
6c32e222
TJ
1464 }
1465
579b006f
JZ
1466 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
1467 SIO_SET_DATA_REQUEST, value,
1468 ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
2f73e59f 1469 ftdi_error_return (-1, "Setting new line property failed");
d2f10023 1470
2f73e59f
TJ
1471 return 0;
1472}
a3da1d95 1473
1941414d
TJ
1474/**
1475 Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip
1476
1477 \param ftdi pointer to ftdi_context
1478 \param buf Buffer with the data
1479 \param size Size of the buffer
1480
22a1b5c1 1481 \retval -666: USB device unavailable
1941414d
TJ
1482 \retval <0: error code from usb_bulk_write()
1483 \retval >0: number of bytes written
1484*/
276750c1 1485int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size)
a8f46ddc 1486{
a3da1d95 1487 int offset = 0;
579b006f 1488 int actual_length;
c3d95b87 1489
22a1b5c1
TJ
1490 if (ftdi == NULL || ftdi->usb_dev == NULL)
1491 ftdi_error_return(-666, "USB device unavailable");
1492
22d12cda
TJ
1493 while (offset < size)
1494 {
948f9ada 1495 int write_size = ftdi->writebuffer_chunksize;
a3da1d95
GE
1496
1497 if (offset+write_size > size)
1498 write_size = size-offset;
1499
276750c1 1500 if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, (unsigned char *)buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0)
579b006f 1501 ftdi_error_return(-1, "usb bulk write failed");
a3da1d95 1502
579b006f 1503 offset += actual_length;
a3da1d95
GE
1504 }
1505
579b006f 1506 return offset;
a3da1d95
GE
1507}
1508
32e2d8b0 1509static void LIBUSB_CALL ftdi_read_data_cb(struct libusb_transfer *transfer)
22d12cda 1510{
579b006f
JZ
1511 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1512 struct ftdi_context *ftdi = tc->ftdi;
1513 int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret;
4c9e3812 1514
b1139150 1515 packet_size = ftdi->max_packet_size;
579b006f
JZ
1516
1517 actual_length = transfer->actual_length;
1518
1519 if (actual_length > 2)
1520 {
1521 // skip FTDI status bytes.
1522 // Maybe stored in the future to enable modem use
1523 num_of_chunks = actual_length / packet_size;
1524 chunk_remains = actual_length % packet_size;
1525 //printf("actual_length = %X, num_of_chunks = %X, chunk_remains = %X, readbuffer_offset = %X\n", actual_length, num_of_chunks, chunk_remains, ftdi->readbuffer_offset);
1526
1527 ftdi->readbuffer_offset += 2;
1528 actual_length -= 2;
1529
1530 if (actual_length > packet_size - 2)
1531 {
1532 for (i = 1; i < num_of_chunks; i++)
56ac0383
TJ
1533 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1534 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1535 packet_size - 2);
579b006f
JZ
1536 if (chunk_remains > 2)
1537 {
1538 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1539 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1540 chunk_remains-2);
1541 actual_length -= 2*num_of_chunks;
1542 }
1543 else
56ac0383 1544 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
579b006f
JZ
1545 }
1546
1547 if (actual_length > 0)
1548 {
1549 // data still fits in buf?
1550 if (tc->offset + actual_length <= tc->size)
1551 {
1552 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length);
1553 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
1554 tc->offset += actual_length;
1555
1556 ftdi->readbuffer_offset = 0;
1557 ftdi->readbuffer_remaining = 0;
1558
1559 /* Did we read exactly the right amount of bytes? */
1560 if (tc->offset == tc->size)
1561 {
1562 //printf("read_data exact rem %d offset %d\n",
1563 //ftdi->readbuffer_remaining, offset);
1564 tc->completed = 1;
1565 return;
1566 }
1567 }
1568 else
1569 {
1570 // only copy part of the data or size <= readbuffer_chunksize
1571 int part_size = tc->size - tc->offset;
1572 memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size);
1573 tc->offset += part_size;
1574
1575 ftdi->readbuffer_offset += part_size;
1576 ftdi->readbuffer_remaining = actual_length - part_size;
1577
1578 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
1579 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
1580 tc->completed = 1;
1581 return;
1582 }
1583 }
1584 }
1b1bf7e4
EH
1585
1586 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1587 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1588 else
1589 {
1590 ret = libusb_submit_transfer (transfer);
1591 if (ret < 0)
1592 tc->completed = 1;
1593 }
579b006f
JZ
1594}
1595
1596
32e2d8b0 1597static void LIBUSB_CALL ftdi_write_data_cb(struct libusb_transfer *transfer)
7cc9950e 1598{
579b006f
JZ
1599 struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data;
1600 struct ftdi_context *ftdi = tc->ftdi;
56ac0383 1601
90ef163e 1602 tc->offset += transfer->actual_length;
56ac0383 1603
579b006f 1604 if (tc->offset == tc->size)
22d12cda 1605 {
579b006f 1606 tc->completed = 1;
7cc9950e 1607 }
579b006f
JZ
1608 else
1609 {
1610 int write_size = ftdi->writebuffer_chunksize;
1611 int ret;
7cc9950e 1612
579b006f
JZ
1613 if (tc->offset + write_size > tc->size)
1614 write_size = tc->size - tc->offset;
1615
1616 transfer->length = write_size;
1617 transfer->buffer = tc->buf + tc->offset;
1b1bf7e4
EH
1618
1619 if (transfer->status == LIBUSB_TRANSFER_CANCELLED)
1620 tc->completed = LIBUSB_TRANSFER_CANCELLED;
1621 else
1622 {
1623 ret = libusb_submit_transfer (transfer);
1624 if (ret < 0)
1625 tc->completed = 1;
1626 }
579b006f 1627 }
7cc9950e
GE
1628}
1629
579b006f 1630
84f85aaa 1631/**
579b006f
JZ
1632 Writes data to the chip. Does not wait for completion of the transfer
1633 nor does it make sure that the transfer was successful.
1634
249888c8 1635 Use libusb 1.0 asynchronous API.
84f85aaa
GE
1636
1637 \param ftdi pointer to ftdi_context
579b006f
JZ
1638 \param buf Buffer with the data
1639 \param size Size of the buffer
84f85aaa 1640
579b006f
JZ
1641 \retval NULL: Some error happens when submit transfer
1642 \retval !NULL: Pointer to a ftdi_transfer_control
c201f80f 1643*/
579b006f
JZ
1644
1645struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
7cc9950e 1646{
579b006f 1647 struct ftdi_transfer_control *tc;
5e77e870 1648 struct libusb_transfer *transfer;
579b006f 1649 int write_size, ret;
22d12cda 1650
22a1b5c1 1651 if (ftdi == NULL || ftdi->usb_dev == NULL)
22a1b5c1 1652 return NULL;
22a1b5c1 1653
579b006f 1654 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
5e77e870
TJ
1655 if (!tc)
1656 return NULL;
22d12cda 1657
5e77e870
TJ
1658 transfer = libusb_alloc_transfer(0);
1659 if (!transfer)
1660 {
1661 free(tc);
579b006f 1662 return NULL;
5e77e870 1663 }
22d12cda 1664
579b006f
JZ
1665 tc->ftdi = ftdi;
1666 tc->completed = 0;
1667 tc->buf = buf;
1668 tc->size = size;
1669 tc->offset = 0;
7cc9950e 1670
9e44fc94 1671 if (size < (int)ftdi->writebuffer_chunksize)
56ac0383 1672 write_size = size;
579b006f 1673 else
56ac0383 1674 write_size = ftdi->writebuffer_chunksize;
22d12cda 1675
90ef163e
YSL
1676 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf,
1677 write_size, ftdi_write_data_cb, tc,
1678 ftdi->usb_write_timeout);
579b006f 1679 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
7cc9950e 1680
579b006f
JZ
1681 ret = libusb_submit_transfer(transfer);
1682 if (ret < 0)
1683 {
1684 libusb_free_transfer(transfer);
5e77e870 1685 free(tc);
579b006f 1686 return NULL;
7cc9950e 1687 }
579b006f
JZ
1688 tc->transfer = transfer;
1689
1690 return tc;
7cc9950e
GE
1691}
1692
1693/**
579b006f
JZ
1694 Reads data from the chip. Does not wait for completion of the transfer
1695 nor does it make sure that the transfer was successful.
1696
249888c8 1697 Use libusb 1.0 asynchronous API.
7cc9950e
GE
1698
1699 \param ftdi pointer to ftdi_context
579b006f
JZ
1700 \param buf Buffer with the data
1701 \param size Size of the buffer
4c9e3812 1702
579b006f
JZ
1703 \retval NULL: Some error happens when submit transfer
1704 \retval !NULL: Pointer to a ftdi_transfer_control
4c9e3812 1705*/
579b006f
JZ
1706
1707struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size)
4c9e3812 1708{
579b006f
JZ
1709 struct ftdi_transfer_control *tc;
1710 struct libusb_transfer *transfer;
1711 int ret;
22d12cda 1712
22a1b5c1
TJ
1713 if (ftdi == NULL || ftdi->usb_dev == NULL)
1714 return NULL;
1715
579b006f
JZ
1716 tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc));
1717 if (!tc)
1718 return NULL;
1719
1720 tc->ftdi = ftdi;
1721 tc->buf = buf;
1722 tc->size = size;
1723
9e44fc94 1724 if (size <= (int)ftdi->readbuffer_remaining)
7cc9950e 1725 {
579b006f 1726 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
7cc9950e 1727
579b006f
JZ
1728 // Fix offsets
1729 ftdi->readbuffer_remaining -= size;
1730 ftdi->readbuffer_offset += size;
7cc9950e 1731
579b006f 1732 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
22d12cda 1733
579b006f
JZ
1734 tc->completed = 1;
1735 tc->offset = size;
1736 tc->transfer = NULL;
1737 return tc;
1738 }
4c9e3812 1739
579b006f
JZ
1740 tc->completed = 0;
1741 if (ftdi->readbuffer_remaining != 0)
1742 {
1743 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
22d12cda 1744
579b006f
JZ
1745 tc->offset = ftdi->readbuffer_remaining;
1746 }
1747 else
1748 tc->offset = 0;
22d12cda 1749
579b006f
JZ
1750 transfer = libusb_alloc_transfer(0);
1751 if (!transfer)
1752 {
1753 free (tc);
1754 return NULL;
1755 }
22d12cda 1756
579b006f
JZ
1757 ftdi->readbuffer_remaining = 0;
1758 ftdi->readbuffer_offset = 0;
1759
1760 libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, ftdi_read_data_cb, tc, ftdi->usb_read_timeout);
1761 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1762
1763 ret = libusb_submit_transfer(transfer);
1764 if (ret < 0)
1765 {
1766 libusb_free_transfer(transfer);
1767 free (tc);
1768 return NULL;
22d12cda 1769 }
579b006f
JZ
1770 tc->transfer = transfer;
1771
1772 return tc;
4c9e3812
GE
1773}
1774
1775/**
579b006f 1776 Wait for completion of the transfer.
4c9e3812 1777
249888c8 1778 Use libusb 1.0 asynchronous API.
4c9e3812 1779
579b006f 1780 \param tc pointer to ftdi_transfer_control
4c9e3812 1781
579b006f
JZ
1782 \retval < 0: Some error happens
1783 \retval >= 0: Data size transferred
4c9e3812 1784*/
579b006f
JZ
1785
1786int ftdi_transfer_data_done(struct ftdi_transfer_control *tc)
4c9e3812
GE
1787{
1788 int ret;
1b1bf7e4 1789 struct timeval to = { 0, 0 };
579b006f 1790 while (!tc->completed)
22d12cda 1791 {
1b1bf7e4
EH
1792 ret = libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1793 &to, &tc->completed);
4c9e3812 1794 if (ret < 0)
579b006f
JZ
1795 {
1796 if (ret == LIBUSB_ERROR_INTERRUPTED)
1797 continue;
1798 libusb_cancel_transfer(tc->transfer);
1799 while (!tc->completed)
1b1bf7e4
EH
1800 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx,
1801 &to, &tc->completed) < 0)
579b006f
JZ
1802 break;
1803 libusb_free_transfer(tc->transfer);
1804 free (tc);
579b006f
JZ
1805 return ret;
1806 }
4c9e3812
GE
1807 }
1808
90ef163e
YSL
1809 ret = tc->offset;
1810 /**
1811 * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)"
ef15fab5 1812 * at ftdi_read_data_submit(). Therefore, we need to check it here.
90ef163e 1813 **/
ef15fab5
TJ
1814 if (tc->transfer)
1815 {
1816 if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED)
1817 ret = -1;
1818 libusb_free_transfer(tc->transfer);
90ef163e 1819 }
579b006f
JZ
1820 free(tc);
1821 return ret;
4c9e3812 1822}
579b006f 1823
1941414d 1824/**
1b1bf7e4
EH
1825 Cancel transfer and wait for completion.
1826
1827 Use libusb 1.0 asynchronous API.
1828
1829 \param tc pointer to ftdi_transfer_control
1830 \param to pointer to timeout value or NULL for infinite
1831*/
1832
1833void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc,
1834 struct timeval * to)
1835{
1836 struct timeval tv = { 0, 0 };
1837
1838 if (!tc->completed && tc->transfer != NULL)
1839 {
1840 if (to == NULL)
1841 to = &tv;
1842
1843 libusb_cancel_transfer(tc->transfer);
1844 while (!tc->completed)
1845 {
1846 if (libusb_handle_events_timeout_completed(tc->ftdi->usb_ctx, to, &tc->completed) < 0)
1847 break;
1848 }
1849 }
1850
1851 if (tc->transfer)
1852 libusb_free_transfer(tc->transfer);
1853
1854 free (tc);
1855}
1856
1857/**
1941414d
TJ
1858 Configure write buffer chunk size.
1859 Default is 4096.
1860
1861 \param ftdi pointer to ftdi_context
1862 \param chunksize Chunk size
a3da1d95 1863
1941414d 1864 \retval 0: all fine
22a1b5c1 1865 \retval -1: ftdi context invalid
1941414d 1866*/
a8f46ddc
TJ
1867int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
1868{
22a1b5c1
TJ
1869 if (ftdi == NULL)
1870 ftdi_error_return(-1, "ftdi context invalid");
1871
948f9ada
TJ
1872 ftdi->writebuffer_chunksize = chunksize;
1873 return 0;
1874}
1875
1941414d
TJ
1876/**
1877 Get write buffer chunk size.
1878
1879 \param ftdi pointer to ftdi_context
1880 \param chunksize Pointer to store chunk size in
948f9ada 1881
1941414d 1882 \retval 0: all fine
22a1b5c1 1883 \retval -1: ftdi context invalid
1941414d 1884*/
a8f46ddc
TJ
1885int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
1886{
22a1b5c1
TJ
1887 if (ftdi == NULL)
1888 ftdi_error_return(-1, "ftdi context invalid");
1889
948f9ada
TJ
1890 *chunksize = ftdi->writebuffer_chunksize;
1891 return 0;
1892}
cbabb7d3 1893
1941414d
TJ
1894/**
1895 Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip.
1896
1897 Automatically strips the two modem status bytes transfered during every read.
948f9ada 1898
1941414d
TJ
1899 \param ftdi pointer to ftdi_context
1900 \param buf Buffer to store data in
1901 \param size Size of the buffer
1902
22a1b5c1 1903 \retval -666: USB device unavailable
579b006f 1904 \retval <0: error code from libusb_bulk_transfer()
d77b0e94 1905 \retval 0: no data was available
1941414d
TJ
1906 \retval >0: number of bytes read
1907
1941414d 1908*/
a8f46ddc
TJ
1909int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size)
1910{
579b006f 1911 int offset = 0, ret, i, num_of_chunks, chunk_remains;
e2f12a4f 1912 int packet_size = ftdi->max_packet_size;
579b006f 1913 int actual_length = 1;
f2f00cb5 1914
22a1b5c1
TJ
1915 if (ftdi == NULL || ftdi->usb_dev == NULL)
1916 ftdi_error_return(-666, "USB device unavailable");
1917
e2f12a4f
TJ
1918 // Packet size sanity check (avoid division by zero)
1919 if (packet_size == 0)
1920 ftdi_error_return(-1, "max_packet_size is bogus (zero)");
d9f0cce7 1921
948f9ada 1922 // everything we want is still in the readbuffer?
9e44fc94 1923 if (size <= (int)ftdi->readbuffer_remaining)
22d12cda 1924 {
d9f0cce7
TJ
1925 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size);
1926
1927 // Fix offsets
1928 ftdi->readbuffer_remaining -= size;
1929 ftdi->readbuffer_offset += size;
1930
545820ce 1931 /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */
d9f0cce7
TJ
1932
1933 return size;
979a145c 1934 }
948f9ada 1935 // something still in the readbuffer, but not enough to satisfy 'size'?
22d12cda
TJ
1936 if (ftdi->readbuffer_remaining != 0)
1937 {
d9f0cce7 1938 memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining);
979a145c 1939
d9f0cce7
TJ
1940 // Fix offset
1941 offset += ftdi->readbuffer_remaining;
948f9ada 1942 }
948f9ada 1943 // do the actual USB read
579b006f 1944 while (offset < size && actual_length > 0)
22d12cda 1945 {
d9f0cce7
TJ
1946 ftdi->readbuffer_remaining = 0;
1947 ftdi->readbuffer_offset = 0;
98452d97 1948 /* returns how much received */
579b006f 1949 ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout);
c3d95b87
TJ
1950 if (ret < 0)
1951 ftdi_error_return(ret, "usb bulk read failed");
98452d97 1952
579b006f 1953 if (actual_length > 2)
22d12cda 1954 {
d9f0cce7
TJ
1955 // skip FTDI status bytes.
1956 // Maybe stored in the future to enable modem use
579b006f
JZ
1957 num_of_chunks = actual_length / packet_size;
1958 chunk_remains = actual_length % packet_size;
1959 //printf("actual_length = %X, num_of_chunks = %X, chunk_remains = %X, readbuffer_offset = %X\n", actual_length, num_of_chunks, chunk_remains, ftdi->readbuffer_offset);
1c733d33 1960
d9f0cce7 1961 ftdi->readbuffer_offset += 2;
579b006f 1962 actual_length -= 2;
1c733d33 1963
579b006f 1964 if (actual_length > packet_size - 2)
22d12cda 1965 {
1c733d33 1966 for (i = 1; i < num_of_chunks; i++)
f2f00cb5
DC
1967 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1968 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1969 packet_size - 2);
22d12cda
TJ
1970 if (chunk_remains > 2)
1971 {
f2f00cb5
DC
1972 memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i,
1973 ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i,
1c733d33 1974 chunk_remains-2);
579b006f 1975 actual_length -= 2*num_of_chunks;
22d12cda
TJ
1976 }
1977 else
579b006f 1978 actual_length -= 2*(num_of_chunks-1)+chunk_remains;
1c733d33 1979 }
22d12cda 1980 }
579b006f 1981 else if (actual_length <= 2)
22d12cda 1982 {
d9f0cce7
TJ
1983 // no more data to read?
1984 return offset;
1985 }
579b006f 1986 if (actual_length > 0)
22d12cda 1987 {
d9f0cce7 1988 // data still fits in buf?
579b006f 1989 if (offset+actual_length <= size)
22d12cda 1990 {
579b006f 1991 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length);
545820ce 1992 //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]);
579b006f 1993 offset += actual_length;
d9f0cce7 1994
53ad271d 1995 /* Did we read exactly the right amount of bytes? */
d9f0cce7 1996 if (offset == size)
c4446c36
TJ
1997 //printf("read_data exact rem %d offset %d\n",
1998 //ftdi->readbuffer_remaining, offset);
d9f0cce7 1999 return offset;
22d12cda
TJ
2000 }
2001 else
2002 {
d9f0cce7
TJ
2003 // only copy part of the data or size <= readbuffer_chunksize
2004 int part_size = size-offset;
2005 memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size);
98452d97 2006
d9f0cce7 2007 ftdi->readbuffer_offset += part_size;
579b006f 2008 ftdi->readbuffer_remaining = actual_length-part_size;
d9f0cce7
TJ
2009 offset += part_size;
2010
579b006f
JZ
2011 /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n",
2012 part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */
d9f0cce7
TJ
2013
2014 return offset;
2015 }
2016 }
cbabb7d3 2017 }
948f9ada 2018 // never reached
29c4af7f 2019 return -127;
a3da1d95
GE
2020}
2021
1941414d
TJ
2022/**
2023 Configure read buffer chunk size.
2024 Default is 4096.
2025
2026 Automatically reallocates the buffer.
a3da1d95 2027
1941414d
TJ
2028 \param ftdi pointer to ftdi_context
2029 \param chunksize Chunk size
2030
2031 \retval 0: all fine
22a1b5c1 2032 \retval -1: ftdi context invalid
1941414d 2033*/
a8f46ddc
TJ
2034int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize)
2035{
29c4af7f
TJ
2036 unsigned char *new_buf;
2037
22a1b5c1
TJ
2038 if (ftdi == NULL)
2039 ftdi_error_return(-1, "ftdi context invalid");
2040
948f9ada
TJ
2041 // Invalidate all remaining data
2042 ftdi->readbuffer_offset = 0;
2043 ftdi->readbuffer_remaining = 0;
8de6eea4
JZ
2044#ifdef __linux__
2045 /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH,
2046 which is defined in libusb-1.0. Otherwise, each USB read request will
2e685a1f 2047 be divided into multiple URBs. This will cause issues on Linux kernel
8de6eea4
JZ
2048 older than 2.6.32. */
2049 if (chunksize > 16384)
2050 chunksize = 16384;
2051#endif
948f9ada 2052
c3d95b87
TJ
2053 if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL)
2054 ftdi_error_return(-1, "out of memory for readbuffer");
d9f0cce7 2055
948f9ada
TJ
2056 ftdi->readbuffer = new_buf;
2057 ftdi->readbuffer_chunksize = chunksize;
2058
2059 return 0;
2060}
2061
1941414d
TJ
2062/**
2063 Get read buffer chunk size.
948f9ada 2064
1941414d
TJ
2065 \param ftdi pointer to ftdi_context
2066 \param chunksize Pointer to store chunk size in
2067
2068 \retval 0: all fine
22a1b5c1 2069 \retval -1: FTDI context invalid
1941414d 2070*/
a8f46ddc
TJ
2071int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize)
2072{
22a1b5c1
TJ
2073 if (ftdi == NULL)
2074 ftdi_error_return(-1, "FTDI context invalid");
2075
948f9ada
TJ
2076 *chunksize = ftdi->readbuffer_chunksize;
2077 return 0;
2078}
2079
1941414d 2080/**
2d790e37 2081 Enable/disable bitbang modes.
1941414d
TJ
2082
2083 \param ftdi pointer to ftdi_context
2084 \param bitmask Bitmask to configure lines.
2085 HIGH/ON value configures a line as output.
2d790e37 2086 \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode
1941414d
TJ
2087
2088 \retval 0: all fine
2089 \retval -1: can't enable bitbang mode
22a1b5c1 2090 \retval -2: USB device unavailable
1941414d 2091*/
2d790e37 2092int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode)
a8f46ddc 2093{
a3da1d95
GE
2094 unsigned short usb_val;
2095
22a1b5c1
TJ
2096 if (ftdi == NULL || ftdi->usb_dev == NULL)
2097 ftdi_error_return(-2, "USB device unavailable");
2098
d9f0cce7 2099 usb_val = bitmask; // low byte: bitmask
2d790e37
TJ
2100 usb_val |= (mode << 8);
2101 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
2102 ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a BM/2232C type chip?");
c3d95b87 2103
2d790e37
TJ
2104 ftdi->bitbang_mode = mode;
2105 ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1;
a3da1d95
GE
2106 return 0;
2107}
2108
1941414d
TJ
2109/**
2110 Disable bitbang mode.
a3da1d95 2111
1941414d
TJ
2112 \param ftdi pointer to ftdi_context
2113
2114 \retval 0: all fine
2115 \retval -1: can't disable bitbang mode
22a1b5c1 2116 \retval -2: USB device unavailable
1941414d 2117*/
a8f46ddc
TJ
2118int ftdi_disable_bitbang(struct ftdi_context *ftdi)
2119{
22a1b5c1
TJ
2120 if (ftdi == NULL || ftdi->usb_dev == NULL)
2121 ftdi_error_return(-2, "USB device unavailable");
2122
579b006f 2123 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_BITMODE_REQUEST, 0, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87 2124 ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?");
a3da1d95
GE
2125
2126 ftdi->bitbang_enabled = 0;
2127 return 0;
2128}
2129
c4446c36 2130
1941414d 2131/**
418aaa72 2132 Directly read pin state, circumventing the read buffer. Useful for bitbang mode.
1941414d
TJ
2133
2134 \param ftdi pointer to ftdi_context
2135 \param pins Pointer to store pins into
2136
2137 \retval 0: all fine
2138 \retval -1: read pins failed
22a1b5c1 2139 \retval -2: USB device unavailable
1941414d 2140*/
a8f46ddc
TJ
2141int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins)
2142{
22a1b5c1
TJ
2143 if (ftdi == NULL || ftdi->usb_dev == NULL)
2144 ftdi_error_return(-2, "USB device unavailable");
2145
579b006f 2146 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_PINS_REQUEST, 0, ftdi->index, (unsigned char *)pins, 1, ftdi->usb_read_timeout) != 1)
c3d95b87 2147 ftdi_error_return(-1, "read pins failed");
a3da1d95 2148
a3da1d95
GE
2149 return 0;
2150}
2151
1941414d
TJ
2152/**
2153 Set latency timer
2154
2155 The FTDI chip keeps data in the internal buffer for a specific
2156 amount of time if the buffer is not full yet to decrease
2157 load on the usb bus.
a3da1d95 2158
1941414d
TJ
2159 \param ftdi pointer to ftdi_context
2160 \param latency Value between 1 and 255
2161
2162 \retval 0: all fine
2163 \retval -1: latency out of range
2164 \retval -2: unable to set latency timer
22a1b5c1 2165 \retval -3: USB device unavailable
1941414d 2166*/
a8f46ddc
TJ
2167int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency)
2168{
a3da1d95
GE
2169 unsigned short usb_val;
2170
c3d95b87
TJ
2171 if (latency < 1)
2172 ftdi_error_return(-1, "latency out of range. Only valid for 1-255");
a3da1d95 2173
22a1b5c1
TJ
2174 if (ftdi == NULL || ftdi->usb_dev == NULL)
2175 ftdi_error_return(-3, "USB device unavailable");
2176
d79d2e68 2177 usb_val = latency;
579b006f 2178 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_LATENCY_TIMER_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87
TJ
2179 ftdi_error_return(-2, "unable to set latency timer");
2180
a3da1d95
GE
2181 return 0;
2182}
2183
1941414d
TJ
2184/**
2185 Get latency timer
a3da1d95 2186
1941414d
TJ
2187 \param ftdi pointer to ftdi_context
2188 \param latency Pointer to store latency value in
2189
2190 \retval 0: all fine
2191 \retval -1: unable to get latency timer
22a1b5c1 2192 \retval -2: USB device unavailable
1941414d 2193*/
a8f46ddc
TJ
2194int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency)
2195{
a3da1d95 2196 unsigned short usb_val;
22a1b5c1
TJ
2197
2198 if (ftdi == NULL || ftdi->usb_dev == NULL)
2199 ftdi_error_return(-2, "USB device unavailable");
2200
579b006f 2201 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_GET_LATENCY_TIMER_REQUEST, 0, ftdi->index, (unsigned char *)&usb_val, 1, ftdi->usb_read_timeout) != 1)
c3d95b87 2202 ftdi_error_return(-1, "reading latency timer failed");
a3da1d95
GE
2203
2204 *latency = (unsigned char)usb_val;
2205 return 0;
2206}
2207
1941414d 2208/**
1189b11a
TJ
2209 Poll modem status information
2210
2211 This function allows the retrieve the two status bytes of the device.
2212 The device sends these bytes also as a header for each read access
2213 where they are discarded by ftdi_read_data(). The chip generates
2214 the two stripped status bytes in the absence of data every 40 ms.
2215
2216 Layout of the first byte:
2217 - B0..B3 - must be 0
2218 - B4 Clear to send (CTS)
2219 0 = inactive
2220 1 = active
2221 - B5 Data set ready (DTS)
2222 0 = inactive
2223 1 = active
2224 - B6 Ring indicator (RI)
2225 0 = inactive
2226 1 = active
2227 - B7 Receive line signal detect (RLSD)
2228 0 = inactive
2229 1 = active
2230
2231 Layout of the second byte:
2232 - B0 Data ready (DR)
2233 - B1 Overrun error (OE)
2234 - B2 Parity error (PE)
2235 - B3 Framing error (FE)
2236 - B4 Break interrupt (BI)
2237 - B5 Transmitter holding register (THRE)
2238 - B6 Transmitter empty (TEMT)
2239 - B7 Error in RCVR FIFO
2240
2241 \param ftdi pointer to ftdi_context
2242 \param status Pointer to store status information in. Must be two bytes.
2243
2244 \retval 0: all fine
2245 \retval -1: unable to retrieve status information
22a1b5c1 2246 \retval -2: USB device unavailable
1189b11a
TJ
2247*/
2248int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status)
2249{
2250 char usb_val[2];
2251
22a1b5c1
TJ
2252 if (ftdi == NULL || ftdi->usb_dev == NULL)
2253 ftdi_error_return(-2, "USB device unavailable");
2254
579b006f 2255 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_POLL_MODEM_STATUS_REQUEST, 0, ftdi->index, (unsigned char *)usb_val, 2, ftdi->usb_read_timeout) != 2)
1189b11a
TJ
2256 ftdi_error_return(-1, "getting modem status failed");
2257
dc09eaa8 2258 *status = (usb_val[1] << 8) | (usb_val[0] & 0xFF);
1189b11a
TJ
2259
2260 return 0;
2261}
2262
a7fb8440
TJ
2263/**
2264 Set flowcontrol for ftdi chip
2265
fdb93a5e
PJ
2266 Note: Do not use this function to enable XON/XOFF mode, use ftdi_setflowctrl_xonxoff() instead.
2267
a7fb8440 2268 \param ftdi pointer to ftdi_context
22d12cda 2269 \param flowctrl flow control to use. should be
fdb93a5e 2270 SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS
a7fb8440
TJ
2271
2272 \retval 0: all fine
2273 \retval -1: set flow control failed
22a1b5c1 2274 \retval -2: USB device unavailable
a7fb8440
TJ
2275*/
2276int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl)
2277{
22a1b5c1
TJ
2278 if (ftdi == NULL || ftdi->usb_dev == NULL)
2279 ftdi_error_return(-2, "USB device unavailable");
2280
579b006f
JZ
2281 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2282 SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index),
2283 NULL, 0, ftdi->usb_write_timeout) < 0)
a7fb8440
TJ
2284 ftdi_error_return(-1, "set flow control failed");
2285
2286 return 0;
2287}
2288
2289/**
fdb93a5e
PJ
2290 Set XON/XOFF flowcontrol for ftdi chip
2291
2292 \param ftdi pointer to ftdi_context
2293 \param xon character code used to resume transmission
2294 \param xoff character code used to pause transmission
2295
2296 \retval 0: all fine
2297 \retval -1: set flow control failed
2298 \retval -2: USB device unavailable
2299*/
2300int ftdi_setflowctrl_xonxoff(struct ftdi_context *ftdi, unsigned char xon, unsigned char xoff)
2301{
2302 if (ftdi == NULL || ftdi->usb_dev == NULL)
2303 ftdi_error_return(-2, "USB device unavailable");
2304
2305 uint16_t xonxoff = xon | (xoff << 8);
2306 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2307 SIO_SET_FLOW_CTRL_REQUEST, xonxoff, (SIO_XON_XOFF_HS | ftdi->index),
2308 NULL, 0, ftdi->usb_write_timeout) < 0)
2309 ftdi_error_return(-1, "set flow control failed");
2310
2311 return 0;
2312}
2313
2314/**
a7fb8440
TJ
2315 Set dtr line
2316
2317 \param ftdi pointer to ftdi_context
2318 \param state state to set line to (1 or 0)
2319
2320 \retval 0: all fine
2321 \retval -1: set dtr failed
22a1b5c1 2322 \retval -2: USB device unavailable
a7fb8440
TJ
2323*/
2324int ftdi_setdtr(struct ftdi_context *ftdi, int state)
2325{
2326 unsigned short usb_val;
2327
22a1b5c1
TJ
2328 if (ftdi == NULL || ftdi->usb_dev == NULL)
2329 ftdi_error_return(-2, "USB device unavailable");
2330
a7fb8440
TJ
2331 if (state)
2332 usb_val = SIO_SET_DTR_HIGH;
2333 else
2334 usb_val = SIO_SET_DTR_LOW;
2335
579b006f
JZ
2336 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2337 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2338 NULL, 0, ftdi->usb_write_timeout) < 0)
a7fb8440
TJ
2339 ftdi_error_return(-1, "set dtr failed");
2340
2341 return 0;
2342}
2343
2344/**
2345 Set rts line
2346
2347 \param ftdi pointer to ftdi_context
2348 \param state state to set line to (1 or 0)
2349
2350 \retval 0: all fine
22a1b5c1
TJ
2351 \retval -1: set rts failed
2352 \retval -2: USB device unavailable
a7fb8440
TJ
2353*/
2354int ftdi_setrts(struct ftdi_context *ftdi, int state)
2355{
2356 unsigned short usb_val;
2357
22a1b5c1
TJ
2358 if (ftdi == NULL || ftdi->usb_dev == NULL)
2359 ftdi_error_return(-2, "USB device unavailable");
2360
a7fb8440
TJ
2361 if (state)
2362 usb_val = SIO_SET_RTS_HIGH;
2363 else
2364 usb_val = SIO_SET_RTS_LOW;
2365
579b006f
JZ
2366 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2367 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2368 NULL, 0, ftdi->usb_write_timeout) < 0)
a7fb8440
TJ
2369 ftdi_error_return(-1, "set of rts failed");
2370
2371 return 0;
2372}
2373
1189b11a 2374/**
22a1b5c1 2375 Set dtr and rts line in one pass
9ecfef2a 2376
22a1b5c1
TJ
2377 \param ftdi pointer to ftdi_context
2378 \param dtr DTR state to set line to (1 or 0)
2379 \param rts RTS state to set line to (1 or 0)
9ecfef2a 2380
22a1b5c1
TJ
2381 \retval 0: all fine
2382 \retval -1: set dtr/rts failed
2383 \retval -2: USB device unavailable
9ecfef2a
TJ
2384 */
2385int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts)
2386{
2387 unsigned short usb_val;
2388
22a1b5c1
TJ
2389 if (ftdi == NULL || ftdi->usb_dev == NULL)
2390 ftdi_error_return(-2, "USB device unavailable");
2391
9ecfef2a 2392 if (dtr)
22d12cda 2393 usb_val = SIO_SET_DTR_HIGH;
9ecfef2a 2394 else
22d12cda 2395 usb_val = SIO_SET_DTR_LOW;
9ecfef2a
TJ
2396
2397 if (rts)
22d12cda 2398 usb_val |= SIO_SET_RTS_HIGH;
9ecfef2a 2399 else
22d12cda 2400 usb_val |= SIO_SET_RTS_LOW;
9ecfef2a 2401
579b006f
JZ
2402 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
2403 SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index,
2404 NULL, 0, ftdi->usb_write_timeout) < 0)
22d12cda 2405 ftdi_error_return(-1, "set of rts/dtr failed");
9ecfef2a
TJ
2406
2407 return 0;
2408}
2409
2410/**
1189b11a
TJ
2411 Set the special event character
2412
2413 \param ftdi pointer to ftdi_context
2414 \param eventch Event character
2415 \param enable 0 to disable the event character, non-zero otherwise
2416
2417 \retval 0: all fine
2418 \retval -1: unable to set event character
22a1b5c1 2419 \retval -2: USB device unavailable
1189b11a
TJ
2420*/
2421int ftdi_set_event_char(struct ftdi_context *ftdi,
22d12cda 2422 unsigned char eventch, unsigned char enable)
1189b11a
TJ
2423{
2424 unsigned short usb_val;
2425
22a1b5c1
TJ
2426 if (ftdi == NULL || ftdi->usb_dev == NULL)
2427 ftdi_error_return(-2, "USB device unavailable");
2428
1189b11a
TJ
2429 usb_val = eventch;
2430 if (enable)
2431 usb_val |= 1 << 8;
2432
579b006f 2433 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_EVENT_CHAR_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1189b11a
TJ
2434 ftdi_error_return(-1, "setting event character failed");
2435
2436 return 0;
2437}
2438
2439/**
2440 Set error character
2441
2442 \param ftdi pointer to ftdi_context
2443 \param errorch Error character
2444 \param enable 0 to disable the error character, non-zero otherwise
2445
2446 \retval 0: all fine
2447 \retval -1: unable to set error character
22a1b5c1 2448 \retval -2: USB device unavailable
1189b11a
TJ
2449*/
2450int ftdi_set_error_char(struct ftdi_context *ftdi,
22d12cda 2451 unsigned char errorch, unsigned char enable)
1189b11a
TJ
2452{
2453 unsigned short usb_val;
2454
22a1b5c1
TJ
2455 if (ftdi == NULL || ftdi->usb_dev == NULL)
2456 ftdi_error_return(-2, "USB device unavailable");
2457
1189b11a
TJ
2458 usb_val = errorch;
2459 if (enable)
2460 usb_val |= 1 << 8;
2461
579b006f 2462 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_SET_ERROR_CHAR_REQUEST, usb_val, ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0)
1189b11a
TJ
2463 ftdi_error_return(-1, "setting error character failed");
2464
2465 return 0;
2466}
2467
2468/**
44f41f11 2469 Init eeprom with default values for the connected device
a35aa9bd 2470 \param ftdi pointer to ftdi_context
f14f84d3
UB
2471 \param manufacturer String to use as Manufacturer
2472 \param product String to use as Product description
2473 \param serial String to use as Serial number description
4e74064b 2474
f14f84d3
UB
2475 \retval 0: all fine
2476 \retval -1: No struct ftdi_context
2477 \retval -2: No struct ftdi_eeprom
44f41f11 2478 \retval -3: No connected device or device not yet opened
1941414d 2479*/
f14f84d3 2480int ftdi_eeprom_initdefaults(struct ftdi_context *ftdi, char * manufacturer,
56ac0383 2481 char * product, char * serial)
a8f46ddc 2482{
c0a96aed 2483 struct ftdi_eeprom *eeprom;
f505134f 2484
c0a96aed 2485 if (ftdi == NULL)
f14f84d3 2486 ftdi_error_return(-1, "No struct ftdi_context");
c0a96aed
UB
2487
2488 if (ftdi->eeprom == NULL)
56ac0383 2489 ftdi_error_return(-2,"No struct ftdi_eeprom");
22a1b5c1 2490
c0a96aed 2491 eeprom = ftdi->eeprom;
a02587d5 2492 memset(eeprom, 0, sizeof(struct ftdi_eeprom));
c0a96aed 2493
44f41f11
UB
2494 if (ftdi->usb_dev == NULL)
2495 ftdi_error_return(-3, "No connected device or device not yet opened");
2496
f396dbad 2497 eeprom->vendor_id = 0x0403;
d4b5af27 2498 eeprom->use_serial = 1;
56ac0383
TJ
2499 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM) ||
2500 (ftdi->type == TYPE_R))
a02587d5 2501 eeprom->product_id = 0x6001;
c7e4c09e
UB
2502 else if (ftdi->type == TYPE_4232H)
2503 eeprom->product_id = 0x6011;
2504 else if (ftdi->type == TYPE_232H)
2505 eeprom->product_id = 0x6014;
2f80efc2
NP
2506 else if (ftdi->type == TYPE_230X)
2507 eeprom->product_id = 0x6015;
a02587d5
UB
2508 else
2509 eeprom->product_id = 0x6010;
2f80efc2 2510
b1859923
UB
2511 if (ftdi->type == TYPE_AM)
2512 eeprom->usb_version = 0x0101;
2513 else
2514 eeprom->usb_version = 0x0200;
a886436a 2515 eeprom->max_power = 100;
d9f0cce7 2516
74e8e79d
UB
2517 if (eeprom->manufacturer)
2518 free (eeprom->manufacturer);
b8aa7b35 2519 eeprom->manufacturer = NULL;
74e8e79d
UB
2520 if (manufacturer)
2521 {
c45d2630 2522 eeprom->manufacturer = (char *)malloc(strlen(manufacturer)+1);
74e8e79d
UB
2523 if (eeprom->manufacturer)
2524 strcpy(eeprom->manufacturer, manufacturer);
2525 }
2526
2527 if (eeprom->product)
2528 free (eeprom->product);
b8aa7b35 2529 eeprom->product = NULL;
10771971 2530 if(product)
74e8e79d 2531 {
c45d2630 2532 eeprom->product = (char *)malloc(strlen(product)+1);
74e8e79d
UB
2533 if (eeprom->product)
2534 strcpy(eeprom->product, product);
2535 }
6a6fcd89
UB
2536 else
2537 {
2538 const char* default_product;
2539 switch(ftdi->type)
2540 {
74387f27
TJ
2541 case TYPE_AM: default_product = "AM"; break;
2542 case TYPE_BM: default_product = "BM"; break;
2543 case TYPE_2232C: default_product = "Dual RS232"; break;
2544 case TYPE_R: default_product = "FT232R USB UART"; break;
2545 case TYPE_2232H: default_product = "Dual RS232-HS"; break;
2546 case TYPE_4232H: default_product = "FT4232H"; break;
2547 case TYPE_232H: default_product = "Single-RS232-HS"; break;
2548 case TYPE_230X: default_product = "FT230X Basic UART"; break;
2549 default:
2550 ftdi_error_return(-3, "Unknown chip type");
6a6fcd89 2551 }
c45d2630 2552 eeprom->product = (char *)malloc(strlen(default_product) +1);
6a6fcd89
UB
2553 if (eeprom->product)
2554 strcpy(eeprom->product, default_product);
2555 }
74e8e79d
UB
2556
2557 if (eeprom->serial)
2558 free (eeprom->serial);
b8aa7b35 2559 eeprom->serial = NULL;
74e8e79d
UB
2560 if (serial)
2561 {
c45d2630 2562 eeprom->serial = (char *)malloc(strlen(serial)+1);
74e8e79d
UB
2563 if (eeprom->serial)
2564 strcpy(eeprom->serial, serial);
2565 }
2566
56ac0383 2567 if (ftdi->type == TYPE_R)
a4980043 2568 {
a886436a 2569 eeprom->max_power = 90;
a02587d5 2570 eeprom->size = 0x80;
a4980043
UB
2571 eeprom->cbus_function[0] = CBUS_TXLED;
2572 eeprom->cbus_function[1] = CBUS_RXLED;
2573 eeprom->cbus_function[2] = CBUS_TXDEN;
2574 eeprom->cbus_function[3] = CBUS_PWREN;
2575 eeprom->cbus_function[4] = CBUS_SLEEP;
2576 }
2f80efc2
NP
2577 else if (ftdi->type == TYPE_230X)
2578 {
2579 eeprom->max_power = 90;
2580 eeprom->size = 0x100;
add00ad6
RH
2581 eeprom->cbus_function[0] = CBUSX_TXDEN;
2582 eeprom->cbus_function[1] = CBUSX_RXLED;
2583 eeprom->cbus_function[2] = CBUSX_TXLED;
2584 eeprom->cbus_function[3] = CBUSX_SLEEP;
2f80efc2 2585 }
a02587d5 2586 else
263d3ba0
UB
2587 {
2588 if(ftdi->type == TYPE_232H)
2589 {
2590 int i;
2591 for (i=0; i<10; i++)
2592 eeprom->cbus_function[i] = CBUSH_TRISTATE;
2593 }
a02587d5 2594 eeprom->size = -1;
263d3ba0 2595 }
68e78641
JS
2596 switch (ftdi->type)
2597 {
2598 case TYPE_AM:
2599 eeprom->release_number = 0x0200;
2600 break;
2601 case TYPE_BM:
2602 eeprom->release_number = 0x0400;
2603 break;
2604 case TYPE_2232C:
2605 eeprom->release_number = 0x0500;
2606 break;
2607 case TYPE_R:
2608 eeprom->release_number = 0x0600;
2609 break;
2610 case TYPE_2232H:
2611 eeprom->release_number = 0x0700;
2612 break;
2613 case TYPE_4232H:
2614 eeprom->release_number = 0x0800;
2615 break;
2616 case TYPE_232H:
2617 eeprom->release_number = 0x0900;
2618 break;
2f80efc2
NP
2619 case TYPE_230X:
2620 eeprom->release_number = 0x1000;
2621 break;
68e78641
JS
2622 default:
2623 eeprom->release_number = 0x00;
2624 }
f14f84d3 2625 return 0;
b8aa7b35 2626}
878f0c6a
NP
2627
2628int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer,
74387f27 2629 char * product, char * serial)
878f0c6a
NP
2630{
2631 struct ftdi_eeprom *eeprom;
2632
2633 if (ftdi == NULL)
2634 ftdi_error_return(-1, "No struct ftdi_context");
2635
2636 if (ftdi->eeprom == NULL)
2637 ftdi_error_return(-2,"No struct ftdi_eeprom");
2638
2639 eeprom = ftdi->eeprom;
2640
2641 if (ftdi->usb_dev == NULL)
2642 ftdi_error_return(-3, "No connected device or device not yet opened");
2643
74387f27
TJ
2644 if (manufacturer)
2645 {
878f0c6a
NP
2646 if (eeprom->manufacturer)
2647 free (eeprom->manufacturer);
c45d2630 2648 eeprom->manufacturer = (char *)malloc(strlen(manufacturer)+1);
878f0c6a
NP
2649 if (eeprom->manufacturer)
2650 strcpy(eeprom->manufacturer, manufacturer);
2651 }
2652
74387f27
TJ
2653 if(product)
2654 {
878f0c6a
NP
2655 if (eeprom->product)
2656 free (eeprom->product);
c45d2630 2657 eeprom->product = (char *)malloc(strlen(product)+1);
878f0c6a
NP
2658 if (eeprom->product)
2659 strcpy(eeprom->product, product);
2660 }
2661
74387f27
TJ
2662 if (serial)
2663 {
878f0c6a
NP
2664 if (eeprom->serial)
2665 free (eeprom->serial);
c45d2630 2666 eeprom->serial = (char *)malloc(strlen(serial)+1);
74387f27
TJ
2667 if (eeprom->serial)
2668 {
878f0c6a
NP
2669 strcpy(eeprom->serial, serial);
2670 eeprom->use_serial = 1;
2671 }
2672 }
2673 return 0;
2674}
2675
934173a3
TJ
2676/**
2677 Return device ID strings from the eeprom. Device needs to be connected.
2678
2679 The parameters manufacturer, description and serial may be NULL
2680 or pointer to buffers to store the fetched strings.
2681
2682 \param ftdi pointer to ftdi_context
2683 \param manufacturer Store manufacturer string here if not NULL
2684 \param mnf_len Buffer size of manufacturer string
2685 \param product Store product description string here if not NULL
2686 \param prod_len Buffer size of product description string
2687 \param serial Store serial string here if not NULL
2688 \param serial_len Buffer size of serial string
2689
2690 \retval 0: all fine
2691 \retval -1: ftdi context invalid
2692 \retval -2: ftdi eeprom buffer invalid
934173a3 2693*/
c9eeb2f1
AM
2694int ftdi_eeprom_get_strings(struct ftdi_context *ftdi,
2695 char *manufacturer, int mnf_len,
2696 char *product, int prod_len,
2697 char *serial, int serial_len)
2698{
2699 struct ftdi_eeprom *eeprom;
2700
2701 if (ftdi == NULL)
2702 ftdi_error_return(-1, "No struct ftdi_context");
c9eeb2f1 2703 if (ftdi->eeprom == NULL)
4effe148 2704 ftdi_error_return(-2, "No struct ftdi_eeprom");
c9eeb2f1
AM
2705
2706 eeprom = ftdi->eeprom;
2707
c9eeb2f1
AM
2708 if (manufacturer)
2709 {
2710 strncpy(manufacturer, eeprom->manufacturer, mnf_len);
2711 if (mnf_len > 0)
2712 manufacturer[mnf_len - 1] = '\0';
2713 }
2714
2715 if (product)
2716 {
2717 strncpy(product, eeprom->product, prod_len);
2718 if (prod_len > 0)
2719 product[prod_len - 1] = '\0';
2720 }
2721
2722 if (serial)
2723 {
2724 strncpy(serial, eeprom->serial, serial_len);
2725 if (serial_len > 0)
2726 serial[serial_len - 1] = '\0';
2727 }
2728
2729 return 0;
2730}
878f0c6a 2731
add00ad6 2732/*FTD2XX doesn't check for values not fitting in the ACBUS Signal options*/
263d3ba0
UB
2733void set_ft232h_cbus(struct ftdi_eeprom *eeprom, unsigned char * output)
2734{
2735 int i;
74387f27 2736 for(i=0; i<5; i++)
263d3ba0
UB
2737 {
2738 int mode_low, mode_high;
2739 if (eeprom->cbus_function[2*i]> CBUSH_CLK7_5)
2740 mode_low = CBUSH_TRISTATE;
2741 else
2742 mode_low = eeprom->cbus_function[2*i];
2743 if (eeprom->cbus_function[2*i+1]> CBUSH_CLK7_5)
2744 mode_high = CBUSH_TRISTATE;
2745 else
f37a1524 2746 mode_high = eeprom->cbus_function[2*i+1];
b8aa7b35 2747
f37a1524 2748 output[0x18+i] = (mode_high <<4) | mode_low;
263d3ba0
UB
2749 }
2750}
c8f69686
UB
2751/* Return the bits for the encoded EEPROM Structure of a requested Mode
2752 *
2753 */
2754static unsigned char type2bit(unsigned char type, enum ftdi_chip_type chip)
2755{
2756 switch (chip)
2757 {
74387f27
TJ
2758 case TYPE_2232H:
2759 case TYPE_2232C:
c8f69686 2760 {
74387f27
TJ
2761 switch (type)
2762 {
2763 case CHANNEL_IS_UART: return 0;
2764 case CHANNEL_IS_FIFO: return 0x01;
2765 case CHANNEL_IS_OPTO: return 0x02;
2766 case CHANNEL_IS_CPU : return 0x04;
2767 default: return 0;
2768 }
c8f69686 2769 }
74387f27 2770 case TYPE_232H:
c8f69686 2771 {
74387f27
TJ
2772 switch (type)
2773 {
2774 case CHANNEL_IS_UART : return 0;
2775 case CHANNEL_IS_FIFO : return 0x01;
2776 case CHANNEL_IS_OPTO : return 0x02;
2777 case CHANNEL_IS_CPU : return 0x04;
2778 case CHANNEL_IS_FT1284 : return 0x08;
2779 default: return 0;
2780 }
c8f69686 2781 }
6f9f969d
RF
2782 case TYPE_R:
2783 {
2784 switch (type)
2785 {
2786 case CHANNEL_IS_UART : return 0;
2787 case CHANNEL_IS_FIFO : return 0x01;
2788 default: return 0;
2789 }
2790 }
74387f27
TJ
2791 case TYPE_230X: /* FT230X is only UART */
2792 default: return 0;
c8f69686
UB
2793 }
2794 return 0;
74387f27 2795}
c8f69686 2796
1941414d 2797/**
a35aa9bd 2798 Build binary buffer from ftdi_eeprom structure.
22a1b5c1 2799 Output is suitable for ftdi_write_eeprom().
b8aa7b35 2800
a35aa9bd 2801 \param ftdi pointer to ftdi_context
1941414d 2802
516ebfb1 2803 \retval >=0: size of eeprom user area in bytes
22a1b5c1 2804 \retval -1: eeprom size (128 bytes) exceeded by custom strings
2c1e2bde
TJ
2805 \retval -2: Invalid eeprom or ftdi pointer
2806 \retval -3: Invalid cbus function setting (FIXME: Not in the code?)
2807 \retval -4: Chip doesn't support invert (FIXME: Not in the code?)
2808 \retval -5: Chip doesn't support high current drive (FIXME: Not in the code?)
2b9a3c82 2809 \retval -6: No connected EEPROM or EEPROM Type unknown
b8aa7b35 2810*/
a35aa9bd 2811int ftdi_eeprom_build(struct ftdi_context *ftdi)
a8f46ddc 2812{
e2bbd9af 2813 unsigned char i, j, eeprom_size_mask;
b8aa7b35
TJ
2814 unsigned short checksum, value;
2815 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
6e962b9a 2816 int user_area_size, free_start, free_end;
c0a96aed 2817 struct ftdi_eeprom *eeprom;
a35aa9bd 2818 unsigned char * output;
b8aa7b35 2819
c0a96aed 2820 if (ftdi == NULL)
cc9c9d58 2821 ftdi_error_return(-2,"No context");
c0a96aed 2822 if (ftdi->eeprom == NULL)
cc9c9d58 2823 ftdi_error_return(-2,"No eeprom structure");
c0a96aed
UB
2824
2825 eeprom= ftdi->eeprom;
a35aa9bd 2826 output = eeprom->buf;
22a1b5c1 2827
56ac0383 2828 if (eeprom->chip == -1)
2c1e2bde 2829 ftdi_error_return(-6,"No connected EEPROM or EEPROM type unknown");
2b9a3c82 2830
74387f27
TJ
2831 if (eeprom->size == -1)
2832 {
2f80efc2
NP
2833 if ((eeprom->chip == 0x56) || (eeprom->chip == 0x66))
2834 eeprom->size = 0x100;
2835 else
2836 eeprom->size = 0x80;
2837 }
f75bf139 2838
b8aa7b35 2839 if (eeprom->manufacturer != NULL)
d9f0cce7 2840 manufacturer_size = strlen(eeprom->manufacturer);
b8aa7b35 2841 if (eeprom->product != NULL)
d9f0cce7 2842 product_size = strlen(eeprom->product);
b8aa7b35 2843 if (eeprom->serial != NULL)
d9f0cce7 2844 serial_size = strlen(eeprom->serial);
b8aa7b35 2845
814710ba
TJ
2846 // eeprom size check
2847 switch (ftdi->type)
2848 {
2849 case TYPE_AM:
2850 case TYPE_BM:
6e962b9a 2851 case TYPE_R:
814710ba
TJ
2852 user_area_size = 96; // base size for strings (total of 48 characters)
2853 break;
2854 case TYPE_2232C:
56ac0383
TJ
2855 user_area_size = 90; // two extra config bytes and 4 bytes PnP stuff
2856 break;
2f80efc2 2857 case TYPE_230X:
56ac0383
TJ
2858 user_area_size = 88; // four extra config bytes + 4 bytes PnP stuff
2859 break;
814710ba
TJ
2860 case TYPE_2232H: // six extra config bytes + 4 bytes PnP stuff
2861 case TYPE_4232H:
56ac0383 2862 user_area_size = 86;
118c4561 2863 break;
c1c3d564
UB
2864 case TYPE_232H:
2865 user_area_size = 80;
2866 break;
2c1e2bde
TJ
2867 default:
2868 user_area_size = 0;
56ac0383 2869 break;
665cda04
UB
2870 }
2871 user_area_size -= (manufacturer_size + product_size + serial_size) * 2;
814710ba 2872
516ebfb1
TJ
2873 if (user_area_size < 0)
2874 ftdi_error_return(-1,"eeprom size exceeded");
b8aa7b35
TJ
2875
2876 // empty eeprom
74387f27
TJ
2877 if (ftdi->type == TYPE_230X)
2878 {
2f80efc2
NP
2879 /* FT230X have a reserved section in the middle of the MTP,
2880 which cannot be written to, but must be included in the checksum */
2881 memset(ftdi->eeprom->buf, 0, 0x80);
2882 memset((ftdi->eeprom->buf + 0xa0), 0, (FTDI_MAX_EEPROM_SIZE - 0xa0));
74387f27
TJ
2883 }
2884 else
2885 {
2f80efc2
NP
2886 memset(ftdi->eeprom->buf, 0, FTDI_MAX_EEPROM_SIZE);
2887 }
b8aa7b35 2888
93738c79
UB
2889 // Bytes and Bits set for all Types
2890
b8aa7b35
TJ
2891 // Addr 02: Vendor ID
2892 output[0x02] = eeprom->vendor_id;
2893 output[0x03] = eeprom->vendor_id >> 8;
2894
2895 // Addr 04: Product ID
2896 output[0x04] = eeprom->product_id;
2897 output[0x05] = eeprom->product_id >> 8;
2898
2899 // Addr 06: Device release number (0400h for BM features)
68e78641
JS
2900 output[0x06] = eeprom->release_number;
2901 output[0x07] = eeprom->release_number >> 8;
b8aa7b35
TJ
2902
2903 // Addr 08: Config descriptor
8fae3e8e
TJ
2904 // Bit 7: always 1
2905 // Bit 6: 1 if this device is self powered, 0 if bus powered
2906 // Bit 5: 1 if this device uses remote wakeup
37186e34 2907 // Bit 4-0: reserved - 0
5a1dcd55 2908 j = 0x80;
afb90824 2909 if (eeprom->self_powered)
5a1dcd55 2910 j |= 0x40;
afb90824 2911 if (eeprom->remote_wakeup)
5a1dcd55 2912 j |= 0x20;
b8aa7b35
TJ
2913 output[0x08] = j;
2914
2915 // Addr 09: Max power consumption: max power = value * 2 mA
a7c32c59 2916 output[0x09] = eeprom->max_power / MAX_POWER_MILLIAMP_PER_UNIT;
d9f0cce7 2917
2f80efc2 2918 if ((ftdi->type != TYPE_AM) && (ftdi->type != TYPE_230X))
93738c79
UB
2919 {
2920 // Addr 0A: Chip configuration
2921 // Bit 7: 0 - reserved
2922 // Bit 6: 0 - reserved
2923 // Bit 5: 0 - reserved
56ac0383 2924 // Bit 4: 1 - Change USB version
93738c79
UB
2925 // Bit 3: 1 - Use the serial number string
2926 // Bit 2: 1 - Enable suspend pull downs for lower power
2927 // Bit 1: 1 - Out EndPoint is Isochronous
2928 // Bit 0: 1 - In EndPoint is Isochronous
2929 //
2930 j = 0;
afb90824 2931 if (eeprom->in_is_isochronous)
93738c79 2932 j = j | 1;
afb90824 2933 if (eeprom->out_is_isochronous)
93738c79
UB
2934 j = j | 2;
2935 output[0x0A] = j;
2936 }
f505134f 2937
b8aa7b35 2938 // Dynamic content
93738c79
UB
2939 // Strings start at 0x94 (TYPE_AM, TYPE_BM)
2940 // 0x96 (TYPE_2232C), 0x98 (TYPE_R) and 0x9a (TYPE_x232H)
c7e4c09e 2941 // 0xa0 (TYPE_232H)
93738c79 2942 i = 0;
56ac0383
TJ
2943 switch (ftdi->type)
2944 {
2945 case TYPE_2232H:
2946 case TYPE_4232H:
2947 i += 2;
2948 case TYPE_R:
2949 i += 2;
2950 case TYPE_2232C:
2951 i += 2;
2952 case TYPE_AM:
2953 case TYPE_BM:
2954 i += 0x94;
2f80efc2 2955 break;
fa3032f0 2956 case TYPE_232H:
2f80efc2
NP
2957 case TYPE_230X:
2958 i = 0xa0;
2959 break;
f505134f 2960 }
93738c79 2961 /* Wrap around 0x80 for 128 byte EEPROMS (Internale and 93x46) */
e2bbd9af 2962 eeprom_size_mask = eeprom->size -1;
6e962b9a 2963 free_end = i & eeprom_size_mask;
c201f80f 2964
93738c79
UB
2965 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
2966 // Addr 0F: Length of manufacturer string
22d12cda 2967 // Output manufacturer
93738c79 2968 output[0x0E] = i; // calculate offset
e2bbd9af
TJ
2969 output[i & eeprom_size_mask] = manufacturer_size*2 + 2, i++;
2970 output[i & eeprom_size_mask] = 0x03, i++; // type: string
22d12cda
TJ
2971 for (j = 0; j < manufacturer_size; j++)
2972 {
e2bbd9af
TJ
2973 output[i & eeprom_size_mask] = eeprom->manufacturer[j], i++;
2974 output[i & eeprom_size_mask] = 0x00, i++;
b8aa7b35 2975 }
93738c79 2976 output[0x0F] = manufacturer_size*2 + 2;
b8aa7b35 2977
93738c79
UB
2978 // Addr 10: Offset of the product string + 0x80, calculated later
2979 // Addr 11: Length of product string
c201f80f 2980 output[0x10] = i | 0x80; // calculate offset
e2bbd9af
TJ
2981 output[i & eeprom_size_mask] = product_size*2 + 2, i++;
2982 output[i & eeprom_size_mask] = 0x03, i++;
22d12cda
TJ
2983 for (j = 0; j < product_size; j++)
2984 {
e2bbd9af
TJ
2985 output[i & eeprom_size_mask] = eeprom->product[j], i++;
2986 output[i & eeprom_size_mask] = 0x00, i++;
b8aa7b35 2987 }
93738c79 2988 output[0x11] = product_size*2 + 2;
37186e34 2989
93738c79
UB
2990 // Addr 12: Offset of the serial string + 0x80, calculated later
2991 // Addr 13: Length of serial string
c201f80f 2992 output[0x12] = i | 0x80; // calculate offset
e2bbd9af
TJ
2993 output[i & eeprom_size_mask] = serial_size*2 + 2, i++;
2994 output[i & eeprom_size_mask] = 0x03, i++;
22d12cda
TJ
2995 for (j = 0; j < serial_size; j++)
2996 {
e2bbd9af
TJ
2997 output[i & eeprom_size_mask] = eeprom->serial[j], i++;
2998 output[i & eeprom_size_mask] = 0x00, i++;
b8aa7b35 2999 }
c2700d6d
TJ
3000
3001 // Legacy port name and PnP fields for FT2232 and newer chips
3002 if (ftdi->type > TYPE_BM)
3003 {
3004 output[i & eeprom_size_mask] = 0x02; /* as seen when written with FTD2XX */
3005 i++;
3006 output[i & eeprom_size_mask] = 0x03; /* as seen when written with FTD2XX */
3007 i++;
3008 output[i & eeprom_size_mask] = eeprom->is_not_pnp; /* as seen when written with FTD2XX */
3009 i++;
3010 }
802a949e 3011
93738c79 3012 output[0x13] = serial_size*2 + 2;
b8aa7b35 3013
56ac0383 3014 if (ftdi->type > TYPE_AM) /* use_serial not used in AM devices */
bf2f6ef7 3015 {
d4b5af27 3016 if (eeprom->use_serial)
bf2f6ef7
UB
3017 output[0x0A] |= USE_SERIAL_NUM;
3018 else
3019 output[0x0A] &= ~USE_SERIAL_NUM;
3020 }
3802140c
UB
3021
3022 /* Bytes and Bits specific to (some) types
3023 Write linear, as this allows easier fixing*/
56ac0383
TJ
3024 switch (ftdi->type)
3025 {
3026 case TYPE_AM:
3027 break;
3028 case TYPE_BM:
3029 output[0x0C] = eeprom->usb_version & 0xff;
3030 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
3986243d 3031 if (eeprom->use_usb_version)
56ac0383
TJ
3032 output[0x0A] |= USE_USB_VERSION_BIT;
3033 else
3034 output[0x0A] &= ~USE_USB_VERSION_BIT;
caec1294 3035
56ac0383
TJ
3036 break;
3037 case TYPE_2232C:
3802140c 3038
c8f69686 3039 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232C);
56ac0383
TJ
3040 if ( eeprom->channel_a_driver == DRIVER_VCP)
3041 output[0x00] |= DRIVER_VCP;
3042 else
3043 output[0x00] &= ~DRIVER_VCP;
4e74064b 3044
56ac0383
TJ
3045 if ( eeprom->high_current_a == HIGH_CURRENT_DRIVE)
3046 output[0x00] |= HIGH_CURRENT_DRIVE;
3047 else
3048 output[0x00] &= ~HIGH_CURRENT_DRIVE;
3802140c 3049
c8f69686 3050 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232C);
56ac0383
TJ
3051 if ( eeprom->channel_b_driver == DRIVER_VCP)
3052 output[0x01] |= DRIVER_VCP;
3053 else
3054 output[0x01] &= ~DRIVER_VCP;
4e74064b 3055
56ac0383
TJ
3056 if ( eeprom->high_current_b == HIGH_CURRENT_DRIVE)
3057 output[0x01] |= HIGH_CURRENT_DRIVE;
3058 else
3059 output[0x01] &= ~HIGH_CURRENT_DRIVE;
3802140c 3060
afb90824 3061 if (eeprom->in_is_isochronous)
56ac0383
TJ
3062 output[0x0A] |= 0x1;
3063 else
3064 output[0x0A] &= ~0x1;
afb90824 3065 if (eeprom->out_is_isochronous)
56ac0383
TJ
3066 output[0x0A] |= 0x2;
3067 else
3068 output[0x0A] &= ~0x2;
afb90824 3069 if (eeprom->suspend_pull_downs)
56ac0383
TJ
3070 output[0x0A] |= 0x4;
3071 else
3072 output[0x0A] &= ~0x4;
3986243d 3073 if (eeprom->use_usb_version)
56ac0383
TJ
3074 output[0x0A] |= USE_USB_VERSION_BIT;
3075 else
3076 output[0x0A] &= ~USE_USB_VERSION_BIT;
4e74064b 3077
56ac0383
TJ
3078 output[0x0C] = eeprom->usb_version & 0xff;
3079 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
3080 output[0x14] = eeprom->chip;
3081 break;
3082 case TYPE_R:
6f9f969d 3083 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_R);
56ac0383
TJ
3084 if (eeprom->high_current == HIGH_CURRENT_DRIVE_R)
3085 output[0x00] |= HIGH_CURRENT_DRIVE_R;
08518f8e
RA
3086 if (eeprom->external_oscillator)
3087 output[0x00] |= 0x02;
56ac0383 3088 output[0x01] = 0x40; /* Hard coded Endpoint Size*/
4e74064b 3089
afb90824 3090 if (eeprom->suspend_pull_downs)
56ac0383
TJ
3091 output[0x0A] |= 0x4;
3092 else
3093 output[0x0A] &= ~0x4;
3094 output[0x0B] = eeprom->invert;
3095 output[0x0C] = eeprom->usb_version & 0xff;
3096 output[0x0D] = (eeprom->usb_version>>8) & 0xff;
4e74064b 3097
add00ad6 3098 if (eeprom->cbus_function[0] > CBUS_BB_RD)
56ac0383
TJ
3099 output[0x14] = CBUS_TXLED;
3100 else
3101 output[0x14] = eeprom->cbus_function[0];
4e74064b 3102
add00ad6 3103 if (eeprom->cbus_function[1] > CBUS_BB_RD)
56ac0383
TJ
3104 output[0x14] |= CBUS_RXLED<<4;
3105 else
3106 output[0x14] |= eeprom->cbus_function[1]<<4;
4e74064b 3107
add00ad6 3108 if (eeprom->cbus_function[2] > CBUS_BB_RD)
56ac0383
TJ
3109 output[0x15] = CBUS_TXDEN;
3110 else
3111 output[0x15] = eeprom->cbus_function[2];
4e74064b 3112
add00ad6 3113 if (eeprom->cbus_function[3] > CBUS_BB_RD)
56ac0383
TJ
3114 output[0x15] |= CBUS_PWREN<<4;
3115 else
3116 output[0x15] |= eeprom->cbus_function[3]<<4;
4e74064b 3117
56ac0383
TJ
3118 if (eeprom->cbus_function[4] > CBUS_CLK6)
3119 output[0x16] = CBUS_SLEEP;
3120 else
3121 output[0x16] = eeprom->cbus_function[4];
3122 break;
3123 case TYPE_2232H:
c8f69686 3124 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_2232H);
56ac0383
TJ
3125 if ( eeprom->channel_a_driver == DRIVER_VCP)
3126 output[0x00] |= DRIVER_VCP;
3127 else
3128 output[0x00] &= ~DRIVER_VCP;
6e6a1c3f 3129
c8f69686 3130 output[0x01] = type2bit(eeprom->channel_b_type, TYPE_2232H);
56ac0383
TJ
3131 if ( eeprom->channel_b_driver == DRIVER_VCP)
3132 output[0x01] |= DRIVER_VCP;
3133 else
3134 output[0x01] &= ~DRIVER_VCP;
3135 if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
3136 output[0x01] |= SUSPEND_DBUS7_BIT;
3137 else
3138 output[0x01] &= ~SUSPEND_DBUS7_BIT;
3139
afb90824 3140 if (eeprom->suspend_pull_downs)
56ac0383
TJ
3141 output[0x0A] |= 0x4;
3142 else
3143 output[0x0A] &= ~0x4;
3144
3145 if (eeprom->group0_drive > DRIVE_16MA)
3146 output[0x0c] |= DRIVE_16MA;
3147 else
3148 output[0x0c] |= eeprom->group0_drive;
3149 if (eeprom->group0_schmitt == IS_SCHMITT)
3150 output[0x0c] |= IS_SCHMITT;
3151 if (eeprom->group0_slew == SLOW_SLEW)
3152 output[0x0c] |= SLOW_SLEW;
3153
3154 if (eeprom->group1_drive > DRIVE_16MA)
3155 output[0x0c] |= DRIVE_16MA<<4;
3156 else
3157 output[0x0c] |= eeprom->group1_drive<<4;
3158 if (eeprom->group1_schmitt == IS_SCHMITT)
3159 output[0x0c] |= IS_SCHMITT<<4;
3160 if (eeprom->group1_slew == SLOW_SLEW)
3161 output[0x0c] |= SLOW_SLEW<<4;
3162
3163 if (eeprom->group2_drive > DRIVE_16MA)
3164 output[0x0d] |= DRIVE_16MA;
3165 else
3166 output[0x0d] |= eeprom->group2_drive;
3167 if (eeprom->group2_schmitt == IS_SCHMITT)
3168 output[0x0d] |= IS_SCHMITT;
3169 if (eeprom->group2_slew == SLOW_SLEW)
3170 output[0x0d] |= SLOW_SLEW;
3171
3172 if (eeprom->group3_drive > DRIVE_16MA)
3173 output[0x0d] |= DRIVE_16MA<<4;
3174 else
3175 output[0x0d] |= eeprom->group3_drive<<4;
3176 if (eeprom->group3_schmitt == IS_SCHMITT)
3177 output[0x0d] |= IS_SCHMITT<<4;
3178 if (eeprom->group3_slew == SLOW_SLEW)
3179 output[0x0d] |= SLOW_SLEW<<4;
3802140c 3180
56ac0383 3181 output[0x18] = eeprom->chip;
3802140c 3182
56ac0383
TJ
3183 break;
3184 case TYPE_4232H:
be4bae37
AL
3185 if (eeprom->channel_a_driver == DRIVER_VCP)
3186 output[0x00] |= DRIVER_VCP;
3187 else
3188 output[0x00] &= ~DRIVER_VCP;
3189 if (eeprom->channel_b_driver == DRIVER_VCP)
3190 output[0x01] |= DRIVER_VCP;
3191 else
3192 output[0x01] &= ~DRIVER_VCP;
3193 if (eeprom->channel_c_driver == DRIVER_VCP)
3194 output[0x00] |= (DRIVER_VCP << 4);
3195 else
3196 output[0x00] &= ~(DRIVER_VCP << 4);
3197 if (eeprom->channel_d_driver == DRIVER_VCP)
3198 output[0x01] |= (DRIVER_VCP << 4);
3199 else
3200 output[0x01] &= ~(DRIVER_VCP << 4);
3201
afb90824 3202 if (eeprom->suspend_pull_downs)
be4bae37
AL
3203 output[0x0a] |= 0x4;
3204 else
3205 output[0x0a] &= ~0x4;
3206
3207 if (eeprom->channel_a_rs485enable)
3208 output[0x0b] |= CHANNEL_IS_RS485 << 0;
3209 else
3210 output[0x0b] &= ~(CHANNEL_IS_RS485 << 0);
3211 if (eeprom->channel_b_rs485enable)
3212 output[0x0b] |= CHANNEL_IS_RS485 << 1;
3213 else
3214 output[0x0b] &= ~(CHANNEL_IS_RS485 << 1);
3215 if (eeprom->channel_c_rs485enable)
3216 output[0x0b] |= CHANNEL_IS_RS485 << 2;
3217 else
3218 output[0x0b] &= ~(CHANNEL_IS_RS485 << 2);
3219 if (eeprom->channel_d_rs485enable)
3220 output[0x0b] |= CHANNEL_IS_RS485 << 3;
3221 else
3222 output[0x0b] &= ~(CHANNEL_IS_RS485 << 3);
3223
3224 if (eeprom->group0_drive > DRIVE_16MA)
3225 output[0x0c] |= DRIVE_16MA;
3226 else
3227 output[0x0c] |= eeprom->group0_drive;
3228 if (eeprom->group0_schmitt == IS_SCHMITT)
3229 output[0x0c] |= IS_SCHMITT;
3230 if (eeprom->group0_slew == SLOW_SLEW)
3231 output[0x0c] |= SLOW_SLEW;
3232
3233 if (eeprom->group1_drive > DRIVE_16MA)
3234 output[0x0c] |= DRIVE_16MA<<4;
3235 else
3236 output[0x0c] |= eeprom->group1_drive<<4;
3237 if (eeprom->group1_schmitt == IS_SCHMITT)
3238 output[0x0c] |= IS_SCHMITT<<4;
3239 if (eeprom->group1_slew == SLOW_SLEW)
3240 output[0x0c] |= SLOW_SLEW<<4;
3241
3242 if (eeprom->group2_drive > DRIVE_16MA)
3243 output[0x0d] |= DRIVE_16MA;
3244 else
3245 output[0x0d] |= eeprom->group2_drive;
3246 if (eeprom->group2_schmitt == IS_SCHMITT)
3247 output[0x0d] |= IS_SCHMITT;
3248 if (eeprom->group2_slew == SLOW_SLEW)
3249 output[0x0d] |= SLOW_SLEW;
3250
3251 if (eeprom->group3_drive > DRIVE_16MA)
3252 output[0x0d] |= DRIVE_16MA<<4;
3253 else
3254 output[0x0d] |= eeprom->group3_drive<<4;
3255 if (eeprom->group3_schmitt == IS_SCHMITT)
3256 output[0x0d] |= IS_SCHMITT<<4;
3257 if (eeprom->group3_slew == SLOW_SLEW)
3258 output[0x0d] |= SLOW_SLEW<<4;
3259
c7e4c09e 3260 output[0x18] = eeprom->chip;
be4bae37 3261
c7e4c09e
UB
3262 break;
3263 case TYPE_232H:
c8f69686 3264 output[0x00] = type2bit(eeprom->channel_a_type, TYPE_232H);
ac4a82a5
UB
3265 if ( eeprom->channel_a_driver == DRIVER_VCP)
3266 output[0x00] |= DRIVER_VCPH;
3267 else
3268 output[0x00] &= ~DRIVER_VCPH;
837a71d6
UB
3269 if (eeprom->powersave)
3270 output[0x01] |= POWER_SAVE_DISABLE_H;
3271 else
3272 output[0x01] &= ~POWER_SAVE_DISABLE_H;
a7e05353
DM
3273
3274 if (eeprom->suspend_pull_downs)
3275 output[0x0a] |= 0x4;
3276 else
3277 output[0x0a] &= ~0x4;
3278
18199b76
UB
3279 if (eeprom->clock_polarity)
3280 output[0x01] |= FT1284_CLK_IDLE_STATE;
3281 else
3282 output[0x01] &= ~FT1284_CLK_IDLE_STATE;
3283 if (eeprom->data_order)
3284 output[0x01] |= FT1284_DATA_LSB;
3285 else
3286 output[0x01] &= ~FT1284_DATA_LSB;
3287 if (eeprom->flow_control)
3288 output[0x01] |= FT1284_FLOW_CONTROL;
3289 else
3290 output[0x01] &= ~FT1284_FLOW_CONTROL;
91d7a201
UB
3291 if (eeprom->group0_drive > DRIVE_16MA)
3292 output[0x0c] |= DRIVE_16MA;
3293 else
3294 output[0x0c] |= eeprom->group0_drive;
3295 if (eeprom->group0_schmitt == IS_SCHMITT)
3296 output[0x0c] |= IS_SCHMITT;
3297 if (eeprom->group0_slew == SLOW_SLEW)
3298 output[0x0c] |= SLOW_SLEW;
3299
3300 if (eeprom->group1_drive > DRIVE_16MA)
3301 output[0x0d] |= DRIVE_16MA;
3302 else
3303 output[0x0d] |= eeprom->group1_drive;
3304 if (eeprom->group1_schmitt == IS_SCHMITT)
3305 output[0x0d] |= IS_SCHMITT;
3306 if (eeprom->group1_slew == SLOW_SLEW)
3307 output[0x0d] |= SLOW_SLEW;
3308
263d3ba0
UB
3309 set_ft232h_cbus(eeprom, output);
3310
c7e4c09e
UB
3311 output[0x1e] = eeprom->chip;
3312 fprintf(stderr,"FIXME: Build FT232H specific EEPROM settings\n");
3313 break;
2f80efc2
NP
3314 case TYPE_230X:
3315 output[0x00] = 0x80; /* Actually, leave the default value */
e659737a
UB
3316 /*FIXME: Make DBUS & CBUS Control configurable*/
3317 output[0x0c] = 0; /* DBUS drive 4mA, CBUS drive 4 mA like factory default */
74387f27
TJ
3318 for (j = 0; j <= 6; j++)
3319 {
2f80efc2
NP
3320 output[0x1a + j] = eeprom->cbus_function[j];
3321 }
347d87e5 3322 output[0x0b] = eeprom->invert;
2f80efc2 3323 break;
3802140c
UB
3324 }
3325
6e962b9a
SET
3326 /* First address without use */
3327 free_start = 0;
3328 switch (ftdi->type)
3329 {
3330 case TYPE_230X:
3331 free_start += 2;
3332 case TYPE_232H:
3333 free_start += 6;
3334 case TYPE_2232H:
3335 case TYPE_4232H:
3336 free_start += 2;
3337 case TYPE_R:
3338 free_start += 2;
3339 case TYPE_2232C:
3340 free_start++;
3341 case TYPE_AM:
3342 case TYPE_BM:
3343 free_start += 0x14;
3344 }
3345
3346 /* Arbitrary user data */
3347 if (eeprom->user_data && eeprom->user_data_size >= 0)
3348 {
3349 if (eeprom->user_data_addr < free_start)
3350 fprintf(stderr,"Warning, user data starts inside the generated data!\n");
3351 if (eeprom->user_data_addr + eeprom->user_data_size >= free_end)
3352 fprintf(stderr,"Warning, user data overlaps the strings area!\n");
3353 if (eeprom->user_data_addr + eeprom->user_data_size > eeprom->size)
3354 ftdi_error_return(-1,"eeprom size exceeded");
3355 memcpy(output + eeprom->user_data_addr, eeprom->user_data, eeprom->user_data_size);
3356 }
3357
cbf65673 3358 // calculate checksum
b8aa7b35 3359 checksum = 0xAAAA;
d9f0cce7 3360
22d12cda
TJ
3361 for (i = 0; i < eeprom->size/2-1; i++)
3362 {
74387f27
TJ
3363 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3364 {
2f80efc2
NP
3365 /* FT230X has a user section in the MTP which is not part of the checksum */
3366 i = 0x40;
3367 }
519bbce1
UB
3368 if ((ftdi->type == TYPE_230X) && (i >= 0x40) && (i < 0x50)) {
3369 uint16_t data;
3370 if (ftdi_read_eeprom_location(ftdi, i, &data)) {
3371 fprintf(stderr, "Reading Factory Configuration Data failed\n");
3372 i = 0x50;
3373 }
3374 value = data;
3375 }
3376 else {
3377 value = output[i*2];
3378 value += output[(i*2)+1] << 8;
3379 }
d9f0cce7
TJ
3380 checksum = value^checksum;
3381 checksum = (checksum << 1) | (checksum >> 15);
b8aa7b35
TJ
3382 }
3383
c201f80f
TJ
3384 output[eeprom->size-2] = checksum;
3385 output[eeprom->size-1] = checksum >> 8;
b8aa7b35 3386
68e78641 3387 eeprom->initialized_for_connected_device = 1;
516ebfb1 3388 return user_area_size;
b8aa7b35 3389}
74387f27 3390/* Decode the encoded EEPROM field for the FTDI Mode into a value for the abstracted
c8f69686
UB
3391 * EEPROM structure
3392 *
3393 * FTD2XX doesn't allow to set multiple bits in the interface mode bitfield, and so do we
3394 */
3395static unsigned char bit2type(unsigned char bits)
0fc2170c
UB
3396{
3397 switch (bits)
3398 {
74387f27
TJ
3399 case 0: return CHANNEL_IS_UART;
3400 case 1: return CHANNEL_IS_FIFO;
3401 case 2: return CHANNEL_IS_OPTO;
3402 case 4: return CHANNEL_IS_CPU;
3403 case 8: return CHANNEL_IS_FT1284;
3404 default:
3405 fprintf(stderr," Unexpected value %d for Hardware Interface type\n",
3406 bits);
0fc2170c
UB
3407 }
3408 return 0;
3409}
1ad9e4cc
TJ
3410/* Decode 230X / 232R type chips invert bits
3411 * Prints directly to stdout.
3412*/
3413static void print_inverted_bits(int invert)
3414{
c45d2630 3415 const char *r_bits[] = {"TXD","RXD","RTS","CTS","DTR","DSR","DCD","RI"};
1ad9e4cc
TJ
3416 int i;
3417
3418 fprintf(stdout,"Inverted bits:");
3419 for (i=0; i<8; i++)
3420 if ((invert & (1<<i)) == (1<<i))
3421 fprintf(stdout," %s",r_bits[i]);
3422
3423 fprintf(stdout,"\n");
3424}
4af1d1bb
MK
3425/**
3426 Decode binary EEPROM image into an ftdi_eeprom structure.
3427
e659737a
UB
3428 For FT-X devices use AN_201 FT-X MTP memory Configuration to decode.
3429
a35aa9bd
UB
3430 \param ftdi pointer to ftdi_context
3431 \param verbose Decode EEPROM on stdout
56ac0383 3432
4af1d1bb
MK
3433 \retval 0: all fine
3434 \retval -1: something went wrong
3435
3436 FIXME: How to pass size? How to handle size field in ftdi_eeprom?
3437 FIXME: Strings are malloc'ed here and should be freed somewhere
3438*/
a35aa9bd 3439int ftdi_eeprom_decode(struct ftdi_context *ftdi, int verbose)
b56d5a64 3440{
3fca5ea9 3441 int i, j;
b56d5a64
MK
3442 unsigned short checksum, eeprom_checksum, value;
3443 unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0;
f2cd9fd5 3444 int eeprom_size;
c0a96aed 3445 struct ftdi_eeprom *eeprom;
3bc0387e 3446 unsigned char *buf = NULL;
22a1b5c1 3447
c0a96aed 3448 if (ftdi == NULL)
cc9c9d58 3449 ftdi_error_return(-1,"No context");
c0a96aed 3450 if (ftdi->eeprom == NULL)
6cd4f922 3451 ftdi_error_return(-1,"No eeprom structure");
56ac0383 3452
c0a96aed 3453 eeprom = ftdi->eeprom;
a35aa9bd 3454 eeprom_size = eeprom->size;
3bc0387e 3455 buf = ftdi->eeprom->buf;
b56d5a64 3456
b56d5a64
MK
3457 // Addr 02: Vendor ID
3458 eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8);
3459
3460 // Addr 04: Product ID
3461 eeprom->product_id = buf[0x04] + (buf[0x05] << 8);
22d12cda 3462
68e78641
JS
3463 // Addr 06: Device release number
3464 eeprom->release_number = buf[0x06] + (buf[0x07]<<8);
b56d5a64
MK
3465
3466 // Addr 08: Config descriptor
3467 // Bit 7: always 1
3468 // Bit 6: 1 if this device is self powered, 0 if bus powered
3469 // Bit 5: 1 if this device uses remote wakeup
f6ef2983 3470 eeprom->self_powered = buf[0x08] & 0x40;
814710ba 3471 eeprom->remote_wakeup = buf[0x08] & 0x20;
b56d5a64
MK
3472
3473 // Addr 09: Max power consumption: max power = value * 2 mA
a7c32c59 3474 eeprom->max_power = MAX_POWER_MILLIAMP_PER_UNIT * buf[0x09];
b56d5a64
MK
3475
3476 // Addr 0A: Chip configuration
3477 // Bit 7: 0 - reserved
3478 // Bit 6: 0 - reserved
3479 // Bit 5: 0 - reserved
caec1294 3480 // Bit 4: 1 - Change USB version on BM and 2232C
b56d5a64
MK
3481 // Bit 3: 1 - Use the serial number string
3482 // Bit 2: 1 - Enable suspend pull downs for lower power
3483 // Bit 1: 1 - Out EndPoint is Isochronous
3484 // Bit 0: 1 - In EndPoint is Isochronous
3485 //
8d3fe5c9
UB
3486 eeprom->in_is_isochronous = buf[0x0A]&0x01;
3487 eeprom->out_is_isochronous = buf[0x0A]&0x02;
3488 eeprom->suspend_pull_downs = buf[0x0A]&0x04;
3986243d
TS
3489 eeprom->use_serial = !!(buf[0x0A] & USE_SERIAL_NUM);
3490 eeprom->use_usb_version = !!(buf[0x0A] & USE_USB_VERSION_BIT);
b56d5a64 3491
b1859923 3492 // Addr 0C: USB version low byte when 0x0A
56ac0383 3493 // Addr 0D: USB version high byte when 0x0A
b1859923 3494 eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8);
b56d5a64
MK
3495
3496 // Addr 0E: Offset of the manufacturer string + 0x80, calculated later
3497 // Addr 0F: Length of manufacturer string
3498 manufacturer_size = buf[0x0F]/2;
56ac0383 3499 if (eeprom->manufacturer)
74e8e79d 3500 free(eeprom->manufacturer);
56ac0383 3501 if (manufacturer_size > 0)
acc1fa05 3502 {
c45d2630 3503 eeprom->manufacturer = (char *)malloc(manufacturer_size);
acc1fa05
UB
3504 if (eeprom->manufacturer)
3505 {
3506 // Decode manufacturer
84ec032f 3507 i = buf[0x0E] & (eeprom_size -1); // offset
74387f27 3508 for (j=0; j<manufacturer_size-1; j++)
acc1fa05
UB
3509 {
3510 eeprom->manufacturer[j] = buf[2*j+i+2];
3511 }
3512 eeprom->manufacturer[j] = '\0';
3513 }
3514 }
b56d5a64
MK
3515 else eeprom->manufacturer = NULL;
3516
3517 // Addr 10: Offset of the product string + 0x80, calculated later
3518 // Addr 11: Length of product string
56ac0383 3519 if (eeprom->product)
74e8e79d 3520 free(eeprom->product);
b56d5a64 3521 product_size = buf[0x11]/2;
acc1fa05
UB
3522 if (product_size > 0)
3523 {
c45d2630 3524 eeprom->product = (char *)malloc(product_size);
56ac0383 3525 if (eeprom->product)
acc1fa05
UB
3526 {
3527 // Decode product name
84ec032f 3528 i = buf[0x10] & (eeprom_size -1); // offset
74387f27 3529 for (j=0; j<product_size-1; j++)
acc1fa05
UB
3530 {
3531 eeprom->product[j] = buf[2*j+i+2];
3532 }
3533 eeprom->product[j] = '\0';
3534 }
3535 }
b56d5a64
MK
3536 else eeprom->product = NULL;
3537
3538 // Addr 12: Offset of the serial string + 0x80, calculated later
3539 // Addr 13: Length of serial string
56ac0383 3540 if (eeprom->serial)
74e8e79d 3541 free(eeprom->serial);
b56d5a64 3542 serial_size = buf[0x13]/2;
acc1fa05
UB
3543 if (serial_size > 0)
3544 {
c45d2630 3545 eeprom->serial = (char *)malloc(serial_size);
56ac0383 3546 if (eeprom->serial)
acc1fa05
UB
3547 {
3548 // Decode serial
84ec032f 3549 i = buf[0x12] & (eeprom_size -1); // offset
74387f27 3550 for (j=0; j<serial_size-1; j++)
acc1fa05
UB
3551 {
3552 eeprom->serial[j] = buf[2*j+i+2];
3553 }
3554 eeprom->serial[j] = '\0';
3555 }
3556 }
b56d5a64
MK
3557 else eeprom->serial = NULL;
3558
b56d5a64
MK
3559 // verify checksum
3560 checksum = 0xAAAA;
3561
22d12cda
TJ
3562 for (i = 0; i < eeprom_size/2-1; i++)
3563 {
74387f27
TJ
3564 if ((ftdi->type == TYPE_230X) && (i == 0x12))
3565 {
2f80efc2
NP
3566 /* FT230X has a user section in the MTP which is not part of the checksum */
3567 i = 0x40;
3568 }
b56d5a64
MK
3569 value = buf[i*2];
3570 value += buf[(i*2)+1] << 8;
3571
3572 checksum = value^checksum;
3573 checksum = (checksum << 1) | (checksum >> 15);
3574 }
3575
3576 eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8);
3577
22d12cda
TJ
3578 if (eeprom_checksum != checksum)
3579 {
3580 fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum);
cc9c9d58 3581 ftdi_error_return(-1,"EEPROM checksum error");
4af1d1bb
MK
3582 }
3583
eb498cff 3584 eeprom->channel_a_type = 0;
aa099f46 3585 if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM))
f6ef2983 3586 {
6cd4f922 3587 eeprom->chip = -1;
f6ef2983 3588 }
56ac0383 3589 else if (ftdi->type == TYPE_2232C)
f6ef2983 3590 {
0fc2170c 3591 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
2cde7c52
UB
3592 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
3593 eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE;
3594 eeprom->channel_b_type = buf[0x01] & 0x7;
3595 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3596 eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE;
6cd4f922 3597 eeprom->chip = buf[0x14];
065edc58 3598 }
56ac0383 3599 else if (ftdi->type == TYPE_R)
564b2716 3600 {
2cde7c52 3601 /* TYPE_R flags D2XX, not VCP as all others*/
be4bae37 3602 eeprom->channel_a_driver = ~buf[0x00] & DRIVER_VCP;
2cde7c52 3603 eeprom->high_current = buf[0x00] & HIGH_CURRENT_DRIVE_R;
08518f8e 3604 eeprom->external_oscillator = buf[0x00] & 0x02;
56ac0383
TJ
3605 if ( (buf[0x01]&0x40) != 0x40)
3606 fprintf(stderr,
3607 "TYPE_R EEPROM byte[0x01] Bit 6 unexpected Endpoint size."
3608 " If this happened with the\n"
3609 " EEPROM programmed by FTDI tools, please report "
3610 "to libftdi@developer.intra2net.com\n");
2cde7c52 3611
6cd4f922 3612 eeprom->chip = buf[0x16];
cecb9cb2
UB
3613 // Addr 0B: Invert data lines
3614 // Works only on FT232R, not FT245R, but no way to distinguish
07851949
UB
3615 eeprom->invert = buf[0x0B];
3616 // Addr 14: CBUS function: CBUS0, CBUS1
3617 // Addr 15: CBUS function: CBUS2, CBUS3
3618 // Addr 16: CBUS function: CBUS5
3619 eeprom->cbus_function[0] = buf[0x14] & 0x0f;
3620 eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f;
3621 eeprom->cbus_function[2] = buf[0x15] & 0x0f;
3622 eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f;
3623 eeprom->cbus_function[4] = buf[0x16] & 0x0f;
564b2716 3624 }
be4bae37 3625 else if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
db099ec5 3626 {
2cde7c52 3627 eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP;
2cde7c52
UB
3628 eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP;
3629
56ac0383 3630 if (ftdi->type == TYPE_2232H)
be4bae37
AL
3631 {
3632 eeprom->channel_a_type = bit2type(buf[0x00] & 0x7);
3633 eeprom->channel_b_type = bit2type(buf[0x01] & 0x7);
ec0dcd3f 3634 eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7_BIT;
be4bae37
AL
3635 }
3636 else
3637 {
3638 eeprom->channel_c_driver = (buf[0x00] >> 4) & DRIVER_VCP;
3639 eeprom->channel_d_driver = (buf[0x01] >> 4) & DRIVER_VCP;
3640 eeprom->channel_a_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 0);
3641 eeprom->channel_b_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 1);
3642 eeprom->channel_c_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 2);
3643 eeprom->channel_d_rs485enable = buf[0x0b] & (CHANNEL_IS_RS485 << 3);
3644 }
2cde7c52 3645
6cd4f922 3646 eeprom->chip = buf[0x18];
db099ec5
UB
3647 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3648 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3649 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3650 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3;
3651 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3652 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
3653 eeprom->group2_drive = buf[0x0d] & DRIVE_16MA;
3654 eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT;
3655 eeprom->group2_slew = buf[0x0d] & SLOW_SLEW;
3656 eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA;
3657 eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT;
3658 eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW;
947d9552 3659 }
c7e4c09e
UB
3660 else if (ftdi->type == TYPE_232H)
3661 {
ac4a82a5
UB
3662 eeprom->channel_a_type = buf[0x00] & 0xf;
3663 eeprom->channel_a_driver = (buf[0x00] & DRIVER_VCPH)?DRIVER_VCP:0;
18199b76
UB
3664 eeprom->clock_polarity = buf[0x01] & FT1284_CLK_IDLE_STATE;
3665 eeprom->data_order = buf[0x01] & FT1284_DATA_LSB;
3666 eeprom->flow_control = buf[0x01] & FT1284_FLOW_CONTROL;
837a71d6 3667 eeprom->powersave = buf[0x01] & POWER_SAVE_DISABLE_H;
91d7a201
UB
3668 eeprom->group0_drive = buf[0x0c] & DRIVE_16MA;
3669 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3670 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3671 eeprom->group1_drive = buf[0x0d] & DRIVE_16MA;
3672 eeprom->group1_schmitt = buf[0x0d] & IS_SCHMITT;
3673 eeprom->group1_slew = buf[0x0d] & SLOW_SLEW;
3674
263d3ba0
UB
3675 for(i=0; i<5; i++)
3676 {
3677 eeprom->cbus_function[2*i ] = buf[0x18+i] & 0x0f;
3678 eeprom->cbus_function[2*i+1] = (buf[0x18+i] >> 4) & 0x0f;
3679 }
c7e4c09e
UB
3680 eeprom->chip = buf[0x1e];
3681 /*FIXME: Decipher more values*/
3682 }
2f80efc2
NP
3683 else if (ftdi->type == TYPE_230X)
3684 {
74387f27
TJ
3685 for(i=0; i<4; i++)
3686 {
2f80efc2
NP
3687 eeprom->cbus_function[i] = buf[0x1a + i] & 0xFF;
3688 }
3689 eeprom->group0_drive = buf[0x0c] & 0x03;
3690 eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT;
3691 eeprom->group0_slew = buf[0x0c] & SLOW_SLEW;
3692 eeprom->group1_drive = (buf[0x0c] >> 4) & 0x03;
3693 eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT;
3694 eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW;
34b79ac7 3695
347d87e5 3696 eeprom->invert = buf[0xb];
2f80efc2 3697 }
56ac0383
TJ
3698
3699 if (verbose)
f6ef2983 3700 {
c45d2630 3701 const char *channel_mode[] = {"UART", "FIFO", "CPU", "OPTO", "FT1284"};
f6ef2983
UB
3702 fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id);
3703 fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id);
68e78641 3704 fprintf(stdout, "Release: 0x%04x\n",eeprom->release_number);
f6ef2983 3705
56ac0383 3706 if (eeprom->self_powered)
f6ef2983
UB
3707 fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n");
3708 else
a7c32c59 3709 fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power,
f6ef2983 3710 (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n");
56ac0383 3711 if (eeprom->manufacturer)
f6ef2983 3712 fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer);
56ac0383 3713 if (eeprom->product)
f6ef2983 3714 fprintf(stdout, "Product: %s\n",eeprom->product);
56ac0383 3715 if (eeprom->serial)
f6ef2983 3716 fprintf(stdout, "Serial: %s\n",eeprom->serial);
e107f509 3717 fprintf(stdout, "Checksum : %04x\n", checksum);
08518f8e 3718 if (ftdi->type == TYPE_R) {
6cd4f922 3719 fprintf(stdout, "Internal EEPROM\n");
08518f8e
RA
3720 fprintf(stdout,"Oscillator: %s\n", eeprom->external_oscillator?"External":"Internal");
3721 }
6cd4f922
UB
3722 else if (eeprom->chip >= 0x46)
3723 fprintf(stdout, "Attached EEPROM: 93x%02x\n", eeprom->chip);
56ac0383
TJ
3724 if (eeprom->suspend_dbus7)
3725 fprintf(stdout, "Suspend on DBUS7\n");
3726 if (eeprom->suspend_pull_downs)
fb9bfdd1 3727 fprintf(stdout, "Pull IO pins low during suspend\n");
837a71d6
UB
3728 if(eeprom->powersave)
3729 {
3730 if(ftdi->type >= TYPE_232H)
3731 fprintf(stdout,"Enter low power state on ACBUS7\n");
74387f27 3732 }
56ac0383 3733 if (eeprom->remote_wakeup)
fb9bfdd1 3734 fprintf(stdout, "Enable Remote Wake Up\n");
802a949e 3735 fprintf(stdout, "PNP: %d\n",(eeprom->is_not_pnp)?0:1);
db099ec5 3736 if (ftdi->type >= TYPE_2232C)
56ac0383 3737 fprintf(stdout,"Channel A has Mode %s%s%s\n",
e107f509 3738 channel_mode[eeprom->channel_a_type],
2cde7c52
UB
3739 (eeprom->channel_a_driver)?" VCP":"",
3740 (eeprom->high_current_a)?" High Current IO":"");
f45f4237 3741 if (ftdi->type == TYPE_232H)
18199b76
UB
3742 {
3743 fprintf(stdout,"FT1284 Mode Clock is idle %s, %s first, %sFlow Control\n",
3744 (eeprom->clock_polarity)?"HIGH":"LOW",
3745 (eeprom->data_order)?"LSB":"MSB",
3746 (eeprom->flow_control)?"":"No ");
74387f27 3747 }
f45f4237 3748 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
56ac0383 3749 fprintf(stdout,"Channel B has Mode %s%s%s\n",
e107f509 3750 channel_mode[eeprom->channel_b_type],
2cde7c52
UB
3751 (eeprom->channel_b_driver)?" VCP":"",
3752 (eeprom->high_current_b)?" High Current IO":"");
caec1294 3753 if (((ftdi->type == TYPE_BM) || (ftdi->type == TYPE_2232C)) &&
3986243d 3754 eeprom->use_usb_version)
caec1294
UB
3755 fprintf(stdout,"Use explicit USB Version %04x\n",eeprom->usb_version);
3756
56ac0383 3757 if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H))
db099ec5
UB
3758 {
3759 fprintf(stdout,"%s has %d mA drive%s%s\n",
3760 (ftdi->type == TYPE_2232H)?"AL":"A",
3761 (eeprom->group0_drive+1) *4,
3762 (eeprom->group0_schmitt)?" Schmitt Input":"",
3763 (eeprom->group0_slew)?" Slow Slew":"");
3764 fprintf(stdout,"%s has %d mA drive%s%s\n",
3765 (ftdi->type == TYPE_2232H)?"AH":"B",
3766 (eeprom->group1_drive+1) *4,
3767 (eeprom->group1_schmitt)?" Schmitt Input":"",
3768 (eeprom->group1_slew)?" Slow Slew":"");
3769 fprintf(stdout,"%s has %d mA drive%s%s\n",
3770 (ftdi->type == TYPE_2232H)?"BL":"C",
3771 (eeprom->group2_drive+1) *4,
3772 (eeprom->group2_schmitt)?" Schmitt Input":"",
3773 (eeprom->group2_slew)?" Slow Slew":"");
3774 fprintf(stdout,"%s has %d mA drive%s%s\n",
3775 (ftdi->type == TYPE_2232H)?"BH":"D",
3776 (eeprom->group3_drive+1) *4,
3777 (eeprom->group3_schmitt)?" Schmitt Input":"",
3778 (eeprom->group3_slew)?" Slow Slew":"");
3779 }
91d7a201
UB
3780 else if (ftdi->type == TYPE_232H)
3781 {
c45d2630 3782 const char *cbush_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
74387f27
TJ
3783 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3784 "CLK30","CLK15","CLK7_5"
3785 };
91d7a201
UB
3786 fprintf(stdout,"ACBUS has %d mA drive%s%s\n",
3787 (eeprom->group0_drive+1) *4,
3788 (eeprom->group0_schmitt)?" Schmitt Input":"",
3789 (eeprom->group0_slew)?" Slow Slew":"");
3790 fprintf(stdout,"ADBUS has %d mA drive%s%s\n",
3791 (eeprom->group1_drive+1) *4,
3792 (eeprom->group1_schmitt)?" Schmitt Input":"",
3793 (eeprom->group1_slew)?" Slow Slew":"");
263d3ba0
UB
3794 for (i=0; i<10; i++)
3795 {
3796 if (eeprom->cbus_function[i]<= CBUSH_CLK7_5 )
3797 fprintf(stdout,"C%d Function: %s\n", i,
3798 cbush_mux[eeprom->cbus_function[i]]);
3799 }
91d7a201 3800 }
2f80efc2
NP
3801 else if (ftdi->type == TYPE_230X)
3802 {
c45d2630 3803 const char *cbusx_mux[] = {"TRISTATE","TXLED","RXLED", "TXRXLED","PWREN",
74387f27
TJ
3804 "SLEEP","DRIVE_0","DRIVE_1","IOMODE","TXDEN",
3805 "CLK24","CLK12","CLK6","BAT_DETECT","BAT_DETECT#",
3806 "I2C_TXE#", "I2C_RXF#", "VBUS_SENSE", "BB_WR#",
3807 "BBRD#", "TIME_STAMP", "AWAKE#",
3808 };
f45f4237 3809 fprintf(stdout,"DBUS has %d mA drive%s%s\n",
2f80efc2
NP
3810 (eeprom->group0_drive+1) *4,
3811 (eeprom->group0_schmitt)?" Schmitt Input":"",
3812 (eeprom->group0_slew)?" Slow Slew":"");
3813 fprintf(stdout,"CBUS has %d mA drive%s%s\n",
3814 (eeprom->group1_drive+1) *4,
3815 (eeprom->group1_schmitt)?" Schmitt Input":"",
3816 (eeprom->group1_slew)?" Slow Slew":"");
3817 for (i=0; i<4; i++)
3818 {
add00ad6
RH
3819 if (eeprom->cbus_function[i]<= CBUSX_AWAKE)
3820 fprintf(stdout,"CBUS%d Function: %s\n", i, cbusx_mux[eeprom->cbus_function[i]]);
2f80efc2 3821 }
1ad9e4cc
TJ
3822
3823 if (eeprom->invert)
3824 print_inverted_bits(eeprom->invert);
2f80efc2 3825 }
91d7a201 3826
a4980043
UB
3827 if (ftdi->type == TYPE_R)
3828 {
c45d2630 3829 const char *cbus_mux[] = {"TXDEN","PWREN","RXLED", "TXLED","TX+RXLED",
13f00d3c 3830 "SLEEP","CLK48","CLK24","CLK12","CLK6",
56ac0383
TJ
3831 "IOMODE","BB_WR","BB_RD"
3832 };
c45d2630 3833 const char *cbus_BB[] = {"RXF","TXE","RD", "WR"};
56ac0383
TJ
3834
3835 if (eeprom->invert)
1ad9e4cc 3836 print_inverted_bits(eeprom->invert);
13ea50d2 3837
56ac0383 3838 for (i=0; i<5; i++)
a4980043 3839 {
add00ad6 3840 if (eeprom->cbus_function[i]<=CBUS_BB_RD)
a4980043
UB
3841 fprintf(stdout,"C%d Function: %s\n", i,
3842 cbus_mux[eeprom->cbus_function[i]]);
3843 else
17431287 3844 {
598b2334
UB
3845 if (i < 4)
3846 /* Running MPROG show that C0..3 have fixed function Synchronous
3847 Bit Bang mode */
3848 fprintf(stdout,"C%d BB Function: %s\n", i,
3849 cbus_BB[i]);
3850 else
3851 fprintf(stdout, "Unknown CBUS mode. Might be special mode?\n");
17431287 3852 }
a4980043
UB
3853 }
3854 }
f6ef2983 3855 }
4af1d1bb 3856 return 0;
b56d5a64
MK
3857}
3858
1941414d 3859/**
44ef02bd
UB
3860 Get a value from the decoded EEPROM structure
3861
735e81ea
TJ
3862 \param ftdi pointer to ftdi_context
3863 \param value_name Enum of the value to query
3864 \param value Pointer to store read value
44ef02bd 3865
735e81ea
TJ
3866 \retval 0: all fine
3867 \retval -1: Value doesn't exist
44ef02bd
UB
3868*/
3869int ftdi_get_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int* value)
3870{
3871 switch (value_name)
3872 {
56ac0383
TJ
3873 case VENDOR_ID:
3874 *value = ftdi->eeprom->vendor_id;
3875 break;
3876 case PRODUCT_ID:
3877 *value = ftdi->eeprom->product_id;
3878 break;
68e78641
JS
3879 case RELEASE_NUMBER:
3880 *value = ftdi->eeprom->release_number;
3881 break;
56ac0383
TJ
3882 case SELF_POWERED:
3883 *value = ftdi->eeprom->self_powered;
3884 break;
3885 case REMOTE_WAKEUP:
3886 *value = ftdi->eeprom->remote_wakeup;
3887 break;
3888 case IS_NOT_PNP:
3889 *value = ftdi->eeprom->is_not_pnp;
3890 break;
3891 case SUSPEND_DBUS7:
3892 *value = ftdi->eeprom->suspend_dbus7;
3893 break;
3894 case IN_IS_ISOCHRONOUS:
3895 *value = ftdi->eeprom->in_is_isochronous;
3896 break;
cffed9f5
UB
3897 case OUT_IS_ISOCHRONOUS:
3898 *value = ftdi->eeprom->out_is_isochronous;
3899 break;
56ac0383
TJ
3900 case SUSPEND_PULL_DOWNS:
3901 *value = ftdi->eeprom->suspend_pull_downs;
3902 break;
3903 case USE_SERIAL:
3904 *value = ftdi->eeprom->use_serial;
3905 break;
3906 case USB_VERSION:
3907 *value = ftdi->eeprom->usb_version;
3908 break;
cffed9f5
UB
3909 case USE_USB_VERSION:
3910 *value = ftdi->eeprom->use_usb_version;
3911 break;
56ac0383
TJ
3912 case MAX_POWER:
3913 *value = ftdi->eeprom->max_power;
3914 break;
3915 case CHANNEL_A_TYPE:
3916 *value = ftdi->eeprom->channel_a_type;
3917 break;
3918 case CHANNEL_B_TYPE:
3919 *value = ftdi->eeprom->channel_b_type;
3920 break;
3921 case CHANNEL_A_DRIVER:
3922 *value = ftdi->eeprom->channel_a_driver;
3923 break;
3924 case CHANNEL_B_DRIVER:
3925 *value = ftdi->eeprom->channel_b_driver;
3926 break;
be4bae37
AL
3927 case CHANNEL_C_DRIVER:
3928 *value = ftdi->eeprom->channel_c_driver;
3929 break;
3930 case CHANNEL_D_DRIVER:
3931 *value = ftdi->eeprom->channel_d_driver;
3932 break;
3933 case CHANNEL_A_RS485:
3934 *value = ftdi->eeprom->channel_a_rs485enable;
3935 break;
3936 case CHANNEL_B_RS485:
3937 *value = ftdi->eeprom->channel_b_rs485enable;
3938 break;
3939 case CHANNEL_C_RS485:
3940 *value = ftdi->eeprom->channel_c_rs485enable;
3941 break;
3942 case CHANNEL_D_RS485:
3943 *value = ftdi->eeprom->channel_d_rs485enable;
3944 break;
56ac0383
TJ
3945 case CBUS_FUNCTION_0:
3946 *value = ftdi->eeprom->cbus_function[0];
3947 break;
3948 case CBUS_FUNCTION_1:
3949 *value = ftdi->eeprom->cbus_function[1];
3950 break;
3951 case CBUS_FUNCTION_2:
3952 *value = ftdi->eeprom->cbus_function[2];
3953 break;
3954 case CBUS_FUNCTION_3:
3955 *value = ftdi->eeprom->cbus_function[3];
3956 break;
3957 case CBUS_FUNCTION_4:
3958 *value = ftdi->eeprom->cbus_function[4];
3959 break;
263d3ba0
UB
3960 case CBUS_FUNCTION_5:
3961 *value = ftdi->eeprom->cbus_function[5];
3962 break;
3963 case CBUS_FUNCTION_6:
3964 *value = ftdi->eeprom->cbus_function[6];
3965 break;
3966 case CBUS_FUNCTION_7:
3967 *value = ftdi->eeprom->cbus_function[7];
3968 break;
3969 case CBUS_FUNCTION_8:
3970 *value = ftdi->eeprom->cbus_function[8];
3971 break;
3972 case CBUS_FUNCTION_9:
1162549f 3973 *value = ftdi->eeprom->cbus_function[9];
263d3ba0 3974 break;
56ac0383
TJ
3975 case HIGH_CURRENT:
3976 *value = ftdi->eeprom->high_current;
3977 break;
3978 case HIGH_CURRENT_A:
3979 *value = ftdi->eeprom->high_current_a;
3980 break;
3981 case HIGH_CURRENT_B:
3982 *value = ftdi->eeprom->high_current_b;
3983 break;
3984 case INVERT:
3985 *value = ftdi->eeprom->invert;
3986 break;
3987 case GROUP0_DRIVE:
3988 *value = ftdi->eeprom->group0_drive;
3989 break;
3990 case GROUP0_SCHMITT:
3991 *value = ftdi->eeprom->group0_schmitt;
3992 break;
3993 case GROUP0_SLEW:
3994 *value = ftdi->eeprom->group0_slew;
3995 break;
3996 case GROUP1_DRIVE:
3997 *value = ftdi->eeprom->group1_drive;
3998 break;
3999 case GROUP1_SCHMITT:
4000 *value = ftdi->eeprom->group1_schmitt;
4001 break;
4002 case GROUP1_SLEW:
4003 *value = ftdi->eeprom->group1_slew;
4004 break;
4005 case GROUP2_DRIVE:
4006 *value = ftdi->eeprom->group2_drive;
4007 break;
4008 case GROUP2_SCHMITT:
4009 *value = ftdi->eeprom->group2_schmitt;
4010 break;
4011 case GROUP2_SLEW:
4012 *value = ftdi->eeprom->group2_slew;
4013 break;
4014 case GROUP3_DRIVE:
4015 *value = ftdi->eeprom->group3_drive;
4016 break;
4017 case GROUP3_SCHMITT:
4018 *value = ftdi->eeprom->group3_schmitt;
4019 break;
4020 case GROUP3_SLEW:
4021 *value = ftdi->eeprom->group3_slew;
4022 break;
74387f27 4023 case POWER_SAVE:
837a71d6
UB
4024 *value = ftdi->eeprom->powersave;
4025 break;
74387f27 4026 case CLOCK_POLARITY:
18199b76
UB
4027 *value = ftdi->eeprom->clock_polarity;
4028 break;
74387f27 4029 case DATA_ORDER:
18199b76
UB
4030 *value = ftdi->eeprom->data_order;
4031 break;
74387f27 4032 case FLOW_CONTROL:
18199b76
UB
4033 *value = ftdi->eeprom->flow_control;
4034 break;
74387f27 4035 case CHIP_TYPE:
56ac0383
TJ
4036 *value = ftdi->eeprom->chip;
4037 break;
4038 case CHIP_SIZE:
4039 *value = ftdi->eeprom->size;
4040 break;
08518f8e
RA
4041 case EXTERNAL_OSCILLATOR:
4042 *value = ftdi->eeprom->external_oscillator;
4043 break;
56ac0383
TJ
4044 default:
4045 ftdi_error_return(-1, "Request for unknown EEPROM value");
44ef02bd
UB
4046 }
4047 return 0;
4048}
4049
4050/**
4051 Set a value in the decoded EEPROM Structure
4052 No parameter checking is performed
4053
735e81ea 4054 \param ftdi pointer to ftdi_context
545f9df9 4055 \param value_name Enum of the value to set
735e81ea 4056 \param value to set
44ef02bd 4057
735e81ea
TJ
4058 \retval 0: all fine
4059 \retval -1: Value doesn't exist
4060 \retval -2: Value not user settable
44ef02bd
UB
4061*/
4062int ftdi_set_eeprom_value(struct ftdi_context *ftdi, enum ftdi_eeprom_value value_name, int value)
4063{
4064 switch (value_name)
4065 {
56ac0383
TJ
4066 case VENDOR_ID:
4067 ftdi->eeprom->vendor_id = value;
4068 break;
4069 case PRODUCT_ID:
4070 ftdi->eeprom->product_id = value;
4071 break;
68e78641
JS
4072 case RELEASE_NUMBER:
4073 ftdi->eeprom->release_number = value;
4074 break;
56ac0383
TJ
4075 case SELF_POWERED:
4076 ftdi->eeprom->self_powered = value;
4077 break;
4078 case REMOTE_WAKEUP:
4079 ftdi->eeprom->remote_wakeup = value;
4080 break;
4081 case IS_NOT_PNP:
4082 ftdi->eeprom->is_not_pnp = value;
4083 break;
4084 case SUSPEND_DBUS7:
4085 ftdi->eeprom->suspend_dbus7 = value;
4086 break;
4087 case IN_IS_ISOCHRONOUS:
4088 ftdi->eeprom->in_is_isochronous = value;
4089 break;
cffed9f5
UB
4090 case OUT_IS_ISOCHRONOUS:
4091 ftdi->eeprom->out_is_isochronous = value;
4092 break;
56ac0383
TJ
4093 case SUSPEND_PULL_DOWNS:
4094 ftdi->eeprom->suspend_pull_downs = value;
4095 break;
4096 case USE_SERIAL:
4097 ftdi->eeprom->use_serial = value;
4098 break;
4099 case USB_VERSION:
4100 ftdi->eeprom->usb_version = value;
4101 break;
cffed9f5
UB
4102 case USE_USB_VERSION:
4103 ftdi->eeprom->use_usb_version = value;
4104 break;
56ac0383
TJ
4105 case MAX_POWER:
4106 ftdi->eeprom->max_power = value;
4107 break;
4108 case CHANNEL_A_TYPE:
4109 ftdi->eeprom->channel_a_type = value;
4110 break;
4111 case CHANNEL_B_TYPE:
4112 ftdi->eeprom->channel_b_type = value;
4113 break;
4114 case CHANNEL_A_DRIVER:
4115 ftdi->eeprom->channel_a_driver = value;
4116 break;
4117 case CHANNEL_B_DRIVER:
4118 ftdi->eeprom->channel_b_driver = value;
4119 break;
be4bae37
AL
4120 case CHANNEL_C_DRIVER:
4121 ftdi->eeprom->channel_c_driver = value;
4122 break;
4123 case CHANNEL_D_DRIVER:
4124 ftdi->eeprom->channel_d_driver = value;
4125 break;
4126 case CHANNEL_A_RS485:
4127 ftdi->eeprom->channel_a_rs485enable = value;
4128 break;
4129 case CHANNEL_B_RS485:
4130 ftdi->eeprom->channel_b_rs485enable = value;
4131 break;
4132 case CHANNEL_C_RS485:
4133 ftdi->eeprom->channel_c_rs485enable = value;
4134 break;
4135 case CHANNEL_D_RS485:
4136 ftdi->eeprom->channel_d_rs485enable = value;
4137 break;
56ac0383
TJ
4138 case CBUS_FUNCTION_0:
4139 ftdi->eeprom->cbus_function[0] = value;
4140 break;
4141 case CBUS_FUNCTION_1:
4142 ftdi->eeprom->cbus_function[1] = value;
4143 break;
4144 case CBUS_FUNCTION_2:
4145 ftdi->eeprom->cbus_function[2] = value;
4146 break;
4147 case CBUS_FUNCTION_3:
4148 ftdi->eeprom->cbus_function[3] = value;
4149 break;
4150 case CBUS_FUNCTION_4:
4151 ftdi->eeprom->cbus_function[4] = value;
4152 break;
263d3ba0
UB
4153 case CBUS_FUNCTION_5:
4154 ftdi->eeprom->cbus_function[5] = value;
4155 break;
4156 case CBUS_FUNCTION_6:
4157 ftdi->eeprom->cbus_function[6] = value;
4158 break;
4159 case CBUS_FUNCTION_7:
4160 ftdi->eeprom->cbus_function[7] = value;
4161 break;
4162 case CBUS_FUNCTION_8:
4163 ftdi->eeprom->cbus_function[8] = value;
4164 break;
4165 case CBUS_FUNCTION_9:
4166 ftdi->eeprom->cbus_function[9] = value;
4167 break;
56ac0383
TJ
4168 case HIGH_CURRENT:
4169 ftdi->eeprom->high_current = value;
4170 break;
4171 case HIGH_CURRENT_A:
4172 ftdi->eeprom->high_current_a = value;
4173 break;
4174 case HIGH_CURRENT_B:
4175 ftdi->eeprom->high_current_b = value;
4176 break;
4177 case INVERT:
4178 ftdi->eeprom->invert = value;
4179 break;
4180 case GROUP0_DRIVE:
4181 ftdi->eeprom->group0_drive = value;
4182 break;
4183 case GROUP0_SCHMITT:
4184 ftdi->eeprom->group0_schmitt = value;
4185 break;
4186 case GROUP0_SLEW:
4187 ftdi->eeprom->group0_slew = value;
4188 break;
4189 case GROUP1_DRIVE:
4190 ftdi->eeprom->group1_drive = value;
4191 break;
4192 case GROUP1_SCHMITT:
4193 ftdi->eeprom->group1_schmitt = value;
4194 break;
4195 case GROUP1_SLEW:
4196 ftdi->eeprom->group1_slew = value;
4197 break;
4198 case GROUP2_DRIVE:
4199 ftdi->eeprom->group2_drive = value;
4200 break;
4201 case GROUP2_SCHMITT:
4202 ftdi->eeprom->group2_schmitt = value;
4203 break;
4204 case GROUP2_SLEW:
4205 ftdi->eeprom->group2_slew = value;
4206 break;
4207 case GROUP3_DRIVE:
4208 ftdi->eeprom->group3_drive = value;
4209 break;
4210 case GROUP3_SCHMITT:
4211 ftdi->eeprom->group3_schmitt = value;
4212 break;
4213 case GROUP3_SLEW:
4214 ftdi->eeprom->group3_slew = value;
4215 break;
4216 case CHIP_TYPE:
4217 ftdi->eeprom->chip = value;
4218 break;
74387f27 4219 case POWER_SAVE:
837a71d6
UB
4220 ftdi->eeprom->powersave = value;
4221 break;
74387f27 4222 case CLOCK_POLARITY:
18199b76
UB
4223 ftdi->eeprom->clock_polarity = value;
4224 break;
74387f27 4225 case DATA_ORDER:
18199b76
UB
4226 ftdi->eeprom->data_order = value;
4227 break;
74387f27 4228 case FLOW_CONTROL:
18199b76
UB
4229 ftdi->eeprom->flow_control = value;
4230 break;
56ac0383
TJ
4231 case CHIP_SIZE:
4232 ftdi_error_return(-2, "EEPROM Value can't be changed");
34b79ac7 4233 break;
08518f8e
RA
4234 case EXTERNAL_OSCILLATOR:
4235 ftdi->eeprom->external_oscillator = value;
4236 break;
6e962b9a
SET
4237 case USER_DATA_ADDR:
4238 ftdi->eeprom->user_data_addr = value;
4239 break;
34b79ac7 4240
56ac0383
TJ
4241 default :
4242 ftdi_error_return(-1, "Request to unknown EEPROM value");
44ef02bd 4243 }
45a3ebd5 4244 ftdi->eeprom->initialized_for_connected_device = 0;
44ef02bd
UB
4245 return 0;
4246}
4247
4248/** Get the read-only buffer to the binary EEPROM content
4249
4250 \param ftdi pointer to ftdi_context
735e81ea 4251 \param buf buffer to receive EEPROM content
44ef02bd
UB
4252 \param size Size of receiving buffer
4253
4254 \retval 0: All fine
4255 \retval -1: struct ftdi_contxt or ftdi_eeprom missing
200bd3ed 4256 \retval -2: Not enough room to store eeprom
44ef02bd 4257*/
56ac0383
TJ
4258int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size)
4259{
4260 if (!ftdi || !(ftdi->eeprom))
4261 ftdi_error_return(-1, "No appropriate structure");
b95e4654 4262
200bd3ed
TJ
4263 if (!buf || size < ftdi->eeprom->size)
4264 ftdi_error_return(-1, "Not enough room to store eeprom");
4265
b95e4654
TJ
4266 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4267 if (size > FTDI_MAX_EEPROM_SIZE)
4268 size = FTDI_MAX_EEPROM_SIZE;
4269
56ac0383 4270 memcpy(buf, ftdi->eeprom->buf, size);
b95e4654 4271
56ac0383
TJ
4272 return 0;
4273}
44ef02bd 4274
672fd368
UB
4275/** Set the EEPROM content from the user-supplied prefilled buffer
4276
4277 \param ftdi pointer to ftdi_context
4278 \param buf buffer to read EEPROM content
4279 \param size Size of buffer
4280
4281 \retval 0: All fine
6e962b9a 4282 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
672fd368
UB
4283*/
4284int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size)
4285{
4286 if (!ftdi || !(ftdi->eeprom) || !buf)
4287 ftdi_error_return(-1, "No appropriate structure");
4288
4289 // Only copy up to FTDI_MAX_EEPROM_SIZE bytes
4290 if (size > FTDI_MAX_EEPROM_SIZE)
4291 size = FTDI_MAX_EEPROM_SIZE;
4292
4293 memcpy(ftdi->eeprom->buf, buf, size);
4294
4295 return 0;
4296}
4297
6e962b9a
SET
4298/** Set the EEPROM user data content from the user-supplied prefilled buffer
4299
4300 \param ftdi pointer to ftdi_context
4301 \param buf buffer to read EEPROM user data content
4302 \param size Size of buffer
4303
4304 \retval 0: All fine
4305 \retval -1: struct ftdi_context or ftdi_eeprom or buf missing
4306*/
4307int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size)
4308{
4309 if (!ftdi || !(ftdi->eeprom) || !buf)
4310 ftdi_error_return(-1, "No appropriate structure");
4311
4312 ftdi->eeprom->user_data_size = size;
4313 ftdi->eeprom->user_data = buf;
4314 return 0;
4315}
4316
44ef02bd 4317/**
c1c70e13
OS
4318 Read eeprom location
4319
4320 \param ftdi pointer to ftdi_context
4321 \param eeprom_addr Address of eeprom location to be read
4322 \param eeprom_val Pointer to store read eeprom location
4323
4324 \retval 0: all fine
4325 \retval -1: read failed
22a1b5c1 4326 \retval -2: USB device unavailable
c1c70e13
OS
4327*/
4328int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val)
4329{
1a3cb7f8
YY
4330 unsigned char buf[2];
4331
22a1b5c1
TJ
4332 if (ftdi == NULL || ftdi->usb_dev == NULL)
4333 ftdi_error_return(-2, "USB device unavailable");
4334
1a3cb7f8 4335 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, buf, 2, ftdi->usb_read_timeout) != 2)
c1c70e13
OS
4336 ftdi_error_return(-1, "reading eeprom failed");
4337
1a3cb7f8
YY
4338 *eeprom_val = (0xff & buf[0]) | (buf[1] << 8);
4339
c1c70e13
OS
4340 return 0;
4341}
4342
4343/**
1941414d
TJ
4344 Read eeprom
4345
4346 \param ftdi pointer to ftdi_context
b8aa7b35 4347
1941414d
TJ
4348 \retval 0: all fine
4349 \retval -1: read failed
22a1b5c1 4350 \retval -2: USB device unavailable
1941414d 4351*/
a35aa9bd 4352int ftdi_read_eeprom(struct ftdi_context *ftdi)
a8f46ddc 4353{
a3da1d95 4354 int i;
a35aa9bd 4355 unsigned char *buf;
a3da1d95 4356
22a1b5c1
TJ
4357 if (ftdi == NULL || ftdi->usb_dev == NULL)
4358 ftdi_error_return(-2, "USB device unavailable");
a35aa9bd 4359 buf = ftdi->eeprom->buf;
22a1b5c1 4360
2d543486 4361 for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++)
22d12cda 4362 {
a35aa9bd 4363 if (libusb_control_transfer(
56ac0383
TJ
4364 ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE,SIO_READ_EEPROM_REQUEST, 0, i,
4365 buf+(i*2), 2, ftdi->usb_read_timeout) != 2)
c3d95b87 4366 ftdi_error_return(-1, "reading eeprom failed");
a3da1d95
GE
4367 }
4368
2d543486 4369 if (ftdi->type == TYPE_R)
a35aa9bd 4370 ftdi->eeprom->size = 0x80;
56ac0383 4371 /* Guesses size of eeprom by comparing halves
2d543486 4372 - will not work with blank eeprom */
a35aa9bd 4373 else if (strrchr((const char *)buf, 0xff) == ((const char *)buf +FTDI_MAX_EEPROM_SIZE -1))
2d543486 4374 ftdi->eeprom->size = -1;
56ac0383 4375 else if (memcmp(buf,&buf[0x80],0x80) == 0)
2d543486 4376 ftdi->eeprom->size = 0x80;
56ac0383 4377 else if (memcmp(buf,&buf[0x40],0x40) == 0)
2d543486
UB
4378 ftdi->eeprom->size = 0x40;
4379 else
4380 ftdi->eeprom->size = 0x100;
a3da1d95
GE
4381 return 0;
4382}
4383
cb6250fa
TJ
4384/*
4385 ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID
4386 Function is only used internally
4387 \internal
4388*/
4389static unsigned char ftdi_read_chipid_shift(unsigned char value)
4390{
4391 return ((value & 1) << 1) |
22d12cda
TJ
4392 ((value & 2) << 5) |
4393 ((value & 4) >> 2) |
4394 ((value & 8) << 4) |
4395 ((value & 16) >> 1) |
4396 ((value & 32) >> 1) |
4397 ((value & 64) >> 4) |
4398 ((value & 128) >> 2);
cb6250fa
TJ
4399}
4400
4401/**
4402 Read the FTDIChip-ID from R-type devices
4403
4404 \param ftdi pointer to ftdi_context
4405 \param chipid Pointer to store FTDIChip-ID
4406
4407 \retval 0: all fine
4408 \retval -1: read failed
22a1b5c1 4409 \retval -2: USB device unavailable
cb6250fa
TJ
4410*/
4411int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid)
4412{
c7eb3112 4413 unsigned int a = 0, b = 0;
cb6250fa 4414
22a1b5c1
TJ
4415 if (ftdi == NULL || ftdi->usb_dev == NULL)
4416 ftdi_error_return(-2, "USB device unavailable");
4417
579b006f 4418 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, 0x43, (unsigned char *)&a, 2, ftdi->usb_read_timeout) == 2)
cb6250fa
TJ
4419 {
4420 a = a << 8 | a >> 8;
579b006f 4421 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, 0x44, (unsigned char *)&b, 2, ftdi->usb_read_timeout) == 2)
cb6250fa
TJ
4422 {
4423 b = b << 8 | b >> 8;
5230676f 4424 a = (a << 16) | (b & 0xFFFF);
912d50ca
TJ
4425 a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8
4426 | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24;
cb6250fa 4427 *chipid = a ^ 0xa5f0f7d1;
c7eb3112 4428 return 0;
cb6250fa
TJ
4429 }
4430 }
4431
c7eb3112 4432 ftdi_error_return(-1, "read of FTDIChip-ID failed");
cb6250fa
TJ
4433}
4434
1941414d 4435/**
c1c70e13
OS
4436 Write eeprom location
4437
4438 \param ftdi pointer to ftdi_context
4439 \param eeprom_addr Address of eeprom location to be written
4440 \param eeprom_val Value to be written
4441
4442 \retval 0: all fine
a661e3e4 4443 \retval -1: write failed
22a1b5c1 4444 \retval -2: USB device unavailable
a661e3e4
UB
4445 \retval -3: Invalid access to checksum protected area below 0x80
4446 \retval -4: Device can't access unprotected area
4447 \retval -5: Reading chip type failed
c1c70e13 4448*/
56ac0383 4449int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr,
a661e3e4 4450 unsigned short eeprom_val)
c1c70e13 4451{
a661e3e4
UB
4452 int chip_type_location;
4453 unsigned short chip_type;
4454
22a1b5c1
TJ
4455 if (ftdi == NULL || ftdi->usb_dev == NULL)
4456 ftdi_error_return(-2, "USB device unavailable");
4457
56ac0383 4458 if (eeprom_addr <0x80)
a661e3e4
UB
4459 ftdi_error_return(-2, "Invalid access to checksum protected area below 0x80");
4460
4461
4462 switch (ftdi->type)
4463 {
56ac0383
TJ
4464 case TYPE_BM:
4465 case TYPE_2232C:
4466 chip_type_location = 0x14;
4467 break;
4468 case TYPE_2232H:
4469 case TYPE_4232H:
4470 chip_type_location = 0x18;
4471 break;
c7e4c09e
UB
4472 case TYPE_232H:
4473 chip_type_location = 0x1e;
4474 break;
56ac0383
TJ
4475 default:
4476 ftdi_error_return(-4, "Device can't access unprotected area");
a661e3e4
UB
4477 }
4478
56ac0383 4479 if (ftdi_read_eeprom_location( ftdi, chip_type_location>>1, &chip_type))
a00c0a85 4480 ftdi_error_return(-5, "Reading failed");
56ac0383
TJ
4481 fprintf(stderr," loc 0x%04x val 0x%04x\n", chip_type_location,chip_type);
4482 if ((chip_type & 0xff) != 0x66)
a661e3e4
UB
4483 {
4484 ftdi_error_return(-6, "EEPROM is not of 93x66");
4485 }
4486
579b006f 4487 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
56ac0383
TJ
4488 SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr,
4489 NULL, 0, ftdi->usb_write_timeout) != 0)
c1c70e13
OS
4490 ftdi_error_return(-1, "unable to write eeprom");
4491
4492 return 0;
4493}
4494
4495/**
1941414d 4496 Write eeprom
a3da1d95 4497
1941414d 4498 \param ftdi pointer to ftdi_context
56ac0383 4499
1941414d
TJ
4500 \retval 0: all fine
4501 \retval -1: read failed
22a1b5c1 4502 \retval -2: USB device unavailable
44f41f11 4503 \retval -3: EEPROM not initialized for the connected device;
1941414d 4504*/
a35aa9bd 4505int ftdi_write_eeprom(struct ftdi_context *ftdi)
a8f46ddc 4506{
ba5329be 4507 unsigned short usb_val, status;
e30da501 4508 int i, ret;
a35aa9bd 4509 unsigned char *eeprom;
a3da1d95 4510
22a1b5c1
TJ
4511 if (ftdi == NULL || ftdi->usb_dev == NULL)
4512 ftdi_error_return(-2, "USB device unavailable");
44f41f11
UB
4513
4514 if(ftdi->eeprom->initialized_for_connected_device == 0)
4515 ftdi_error_return(-3, "EEPROM not initialized for the connected device");
4516
a35aa9bd 4517 eeprom = ftdi->eeprom->buf;
22a1b5c1 4518
ba5329be 4519 /* These commands were traced while running MProg */
e30da501
TJ
4520 if ((ret = ftdi_usb_reset(ftdi)) != 0)
4521 return ret;
4522 if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0)
4523 return ret;
4524 if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0)
4525 return ret;
ba5329be 4526
c0a96aed 4527 for (i = 0; i < ftdi->eeprom->size/2; i++)
22d12cda 4528 {
2f80efc2 4529 /* Do not try to write to reserved area */
74387f27
TJ
4530 if ((ftdi->type == TYPE_230X) && (i == 0x40))
4531 {
2f80efc2
NP
4532 i = 0x50;
4533 }
d9f0cce7
TJ
4534 usb_val = eeprom[i*2];
4535 usb_val += eeprom[(i*2)+1] << 8;
579b006f
JZ
4536 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
4537 SIO_WRITE_EEPROM_REQUEST, usb_val, i,
4538 NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87 4539 ftdi_error_return(-1, "unable to write eeprom");
a3da1d95
GE
4540 }
4541
4542 return 0;
4543}
4544
1941414d
TJ
4545/**
4546 Erase eeprom
a3da1d95 4547
a5e1bd8c
MK
4548 This is not supported on FT232R/FT245R according to the MProg manual from FTDI.
4549
1941414d
TJ
4550 \param ftdi pointer to ftdi_context
4551
4552 \retval 0: all fine
4553 \retval -1: erase failed
22a1b5c1 4554 \retval -2: USB device unavailable
99404ad5
UB
4555 \retval -3: Writing magic failed
4556 \retval -4: Read EEPROM failed
4557 \retval -5: Unexpected EEPROM value
1941414d 4558*/
99404ad5 4559#define MAGIC 0x55aa
a8f46ddc
TJ
4560int ftdi_erase_eeprom(struct ftdi_context *ftdi)
4561{
99404ad5 4562 unsigned short eeprom_value;
22a1b5c1
TJ
4563 if (ftdi == NULL || ftdi->usb_dev == NULL)
4564 ftdi_error_return(-2, "USB device unavailable");
4565
519bbce1 4566 if ((ftdi->type == TYPE_R) || (ftdi->type == TYPE_230X))
99404ad5
UB
4567 {
4568 ftdi->eeprom->chip = 0;
4569 return 0;
4570 }
4571
56ac0383 4572 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
99404ad5 4573 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
c3d95b87 4574 ftdi_error_return(-1, "unable to erase eeprom");
a3da1d95 4575
56ac0383 4576
99404ad5
UB
4577 /* detect chip type by writing 0x55AA as magic at word position 0xc0
4578 Chip is 93x46 if magic is read at word position 0x00, as wraparound happens around 0x40
4579 Chip is 93x56 if magic is read at word position 0x40, as wraparound happens around 0x80
4580 Chip is 93x66 if magic is only read at word position 0xc0*/
10186c1f 4581 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE,
56ac0383
TJ
4582 SIO_WRITE_EEPROM_REQUEST, MAGIC, 0xc0,
4583 NULL, 0, ftdi->usb_write_timeout) != 0)
99404ad5 4584 ftdi_error_return(-3, "Writing magic failed");
56ac0383 4585 if (ftdi_read_eeprom_location( ftdi, 0x00, &eeprom_value))
a00c0a85 4586 ftdi_error_return(-4, "Reading failed");
56ac0383 4587 if (eeprom_value == MAGIC)
99404ad5
UB
4588 {
4589 ftdi->eeprom->chip = 0x46;
4590 }
56ac0383 4591 else
99404ad5 4592 {
56ac0383 4593 if (ftdi_read_eeprom_location( ftdi, 0x40, &eeprom_value))
a00c0a85 4594 ftdi_error_return(-4, "Reading failed");
56ac0383 4595 if (eeprom_value == MAGIC)
99404ad5 4596 ftdi->eeprom->chip = 0x56;
56ac0383 4597 else
99404ad5 4598 {
56ac0383 4599 if (ftdi_read_eeprom_location( ftdi, 0xc0, &eeprom_value))
a00c0a85 4600 ftdi_error_return(-4, "Reading failed");
56ac0383 4601 if (eeprom_value == MAGIC)
99404ad5
UB
4602 ftdi->eeprom->chip = 0x66;
4603 else
4604 {
4605 ftdi->eeprom->chip = -1;
4606 }
4607 }
4608 }
56ac0383 4609 if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST,
99404ad5
UB
4610 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0)
4611 ftdi_error_return(-1, "unable to erase eeprom");
a3da1d95
GE
4612 return 0;
4613}
c3d95b87 4614
1941414d
TJ
4615/**
4616 Get string representation for last error code
c3d95b87 4617
1941414d
TJ
4618 \param ftdi pointer to ftdi_context
4619
4620 \retval Pointer to error string
4621*/
c45d2630 4622const char *ftdi_get_error_string (struct ftdi_context *ftdi)
c3d95b87 4623{
22a1b5c1
TJ
4624 if (ftdi == NULL)
4625 return "";
4626
c3d95b87
TJ
4627 return ftdi->error_str;
4628}
a01d31e2 4629
b5ec1820 4630/* @} end of doxygen libftdi group */