| 1 | /*************************************************************************** |
| 2 | ftdi.c - description |
| 3 | ------------------- |
| 4 | begin : Fri Apr 4 2003 |
| 5 | copyright : (C) 2003-2010 by Intra2net AG |
| 6 | email : opensource@intra2net.com |
| 7 | ***************************************************************************/ |
| 8 | |
| 9 | /*************************************************************************** |
| 10 | * * |
| 11 | * This program is free software; you can redistribute it and/or modify * |
| 12 | * it under the terms of the GNU Lesser General Public License * |
| 13 | * version 2.1 as published by the Free Software Foundation; * |
| 14 | * * |
| 15 | ***************************************************************************/ |
| 16 | |
| 17 | /** |
| 18 | \mainpage libftdi API documentation |
| 19 | |
| 20 | Library to talk to FTDI chips. You find the latest versions of libftdi at |
| 21 | http://www.intra2net.com/en/developer/libftdi/ |
| 22 | |
| 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. |
| 27 | */ |
| 28 | /** \addtogroup libftdi */ |
| 29 | /* @{ */ |
| 30 | |
| 31 | #include <libusb.h> |
| 32 | #include <string.h> |
| 33 | #include <errno.h> |
| 34 | #include <stdio.h> |
| 35 | #include <stdlib.h> |
| 36 | |
| 37 | #include "ftdi.h" |
| 38 | |
| 39 | #define ftdi_error_return(code, str) do { \ |
| 40 | ftdi->error_str = str; \ |
| 41 | return code; \ |
| 42 | } while(0); |
| 43 | |
| 44 | #define ftdi_error_return_free_device_list(code, str, devs) do { \ |
| 45 | libusb_free_device_list(devs,1); \ |
| 46 | ftdi->error_str = str; \ |
| 47 | return code; \ |
| 48 | } while(0); |
| 49 | |
| 50 | |
| 51 | /** |
| 52 | Internal function to close usb device pointer. |
| 53 | Sets ftdi->usb_dev to NULL. |
| 54 | \internal |
| 55 | |
| 56 | \param ftdi pointer to ftdi_context |
| 57 | |
| 58 | \retval none |
| 59 | */ |
| 60 | static void ftdi_usb_close_internal (struct ftdi_context *ftdi) |
| 61 | { |
| 62 | if (ftdi && ftdi->usb_dev) |
| 63 | { |
| 64 | libusb_close (ftdi->usb_dev); |
| 65 | ftdi->usb_dev = NULL; |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | Initializes a ftdi_context. |
| 71 | |
| 72 | \param ftdi pointer to ftdi_context |
| 73 | |
| 74 | \retval 0: all fine |
| 75 | \retval -1: couldn't allocate read buffer |
| 76 | |
| 77 | \remark This should be called before all functions |
| 78 | */ |
| 79 | int ftdi_init(struct ftdi_context *ftdi) |
| 80 | { |
| 81 | ftdi->usb_ctx = NULL; |
| 82 | ftdi->usb_dev = NULL; |
| 83 | ftdi->usb_read_timeout = 5000; |
| 84 | ftdi->usb_write_timeout = 5000; |
| 85 | |
| 86 | ftdi->type = TYPE_BM; /* chip type */ |
| 87 | ftdi->baudrate = -1; |
| 88 | ftdi->bitbang_enabled = 0; /* 0: normal mode 1: any of the bitbang modes enabled */ |
| 89 | |
| 90 | ftdi->readbuffer = NULL; |
| 91 | ftdi->readbuffer_offset = 0; |
| 92 | ftdi->readbuffer_remaining = 0; |
| 93 | ftdi->writebuffer_chunksize = 4096; |
| 94 | ftdi->max_packet_size = 0; |
| 95 | |
| 96 | ftdi->interface = 0; |
| 97 | ftdi->index = 0; |
| 98 | ftdi->in_ep = 0x02; |
| 99 | ftdi->out_ep = 0x81; |
| 100 | ftdi->bitbang_mode = 1; /* when bitbang is enabled this holds the number of the mode */ |
| 101 | |
| 102 | ftdi->error_str = NULL; |
| 103 | |
| 104 | ftdi->eeprom = NULL; |
| 105 | |
| 106 | /* All fine. Now allocate the readbuffer */ |
| 107 | return ftdi_read_data_set_chunksize(ftdi, 4096); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | Allocate and initialize a new ftdi_context |
| 112 | |
| 113 | \return a pointer to a new ftdi_context, or NULL on failure |
| 114 | */ |
| 115 | struct ftdi_context *ftdi_new(void) |
| 116 | { |
| 117 | struct ftdi_context * ftdi = (struct ftdi_context *)malloc(sizeof(struct ftdi_context)); |
| 118 | |
| 119 | if (ftdi == NULL) |
| 120 | { |
| 121 | return NULL; |
| 122 | } |
| 123 | |
| 124 | if (ftdi_init(ftdi) != 0) |
| 125 | { |
| 126 | free(ftdi); |
| 127 | return NULL; |
| 128 | } |
| 129 | |
| 130 | return ftdi; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | Open selected channels on a chip, otherwise use first channel. |
| 135 | |
| 136 | \param ftdi pointer to ftdi_context |
| 137 | \param interface Interface to use for FT2232C/2232H/4232H chips. |
| 138 | |
| 139 | \retval 0: all fine |
| 140 | \retval -1: unknown interface |
| 141 | \retval -2: USB device unavailable |
| 142 | */ |
| 143 | int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface) |
| 144 | { |
| 145 | if (ftdi == NULL) |
| 146 | ftdi_error_return(-2, "USB device unavailable"); |
| 147 | |
| 148 | switch (interface) |
| 149 | { |
| 150 | case INTERFACE_ANY: |
| 151 | case INTERFACE_A: |
| 152 | /* ftdi_usb_open_desc cares to set the right index, depending on the found chip */ |
| 153 | break; |
| 154 | case INTERFACE_B: |
| 155 | ftdi->interface = 1; |
| 156 | ftdi->index = INTERFACE_B; |
| 157 | ftdi->in_ep = 0x04; |
| 158 | ftdi->out_ep = 0x83; |
| 159 | break; |
| 160 | case INTERFACE_C: |
| 161 | ftdi->interface = 2; |
| 162 | ftdi->index = INTERFACE_C; |
| 163 | ftdi->in_ep = 0x06; |
| 164 | ftdi->out_ep = 0x85; |
| 165 | break; |
| 166 | case INTERFACE_D: |
| 167 | ftdi->interface = 3; |
| 168 | ftdi->index = INTERFACE_D; |
| 169 | ftdi->in_ep = 0x08; |
| 170 | ftdi->out_ep = 0x87; |
| 171 | break; |
| 172 | default: |
| 173 | ftdi_error_return(-1, "Unknown interface"); |
| 174 | } |
| 175 | return 0; |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | Deinitializes a ftdi_context. |
| 180 | |
| 181 | \param ftdi pointer to ftdi_context |
| 182 | */ |
| 183 | void ftdi_deinit(struct ftdi_context *ftdi) |
| 184 | { |
| 185 | if (ftdi == NULL) |
| 186 | return; |
| 187 | |
| 188 | ftdi_usb_close_internal (ftdi); |
| 189 | |
| 190 | if (ftdi->readbuffer != NULL) |
| 191 | { |
| 192 | free(ftdi->readbuffer); |
| 193 | ftdi->readbuffer = NULL; |
| 194 | } |
| 195 | libusb_exit(ftdi->usb_ctx); |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | Deinitialize and free an ftdi_context. |
| 200 | |
| 201 | \param ftdi pointer to ftdi_context |
| 202 | */ |
| 203 | void ftdi_free(struct ftdi_context *ftdi) |
| 204 | { |
| 205 | ftdi_deinit(ftdi); |
| 206 | free(ftdi); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | Use an already open libusb device. |
| 211 | |
| 212 | \param ftdi pointer to ftdi_context |
| 213 | \param usb libusb libusb_device_handle to use |
| 214 | */ |
| 215 | void ftdi_set_usbdev (struct ftdi_context *ftdi, libusb_device_handle *usb) |
| 216 | { |
| 217 | if (ftdi == NULL) |
| 218 | return; |
| 219 | |
| 220 | ftdi->usb_dev = usb; |
| 221 | } |
| 222 | |
| 223 | |
| 224 | /** |
| 225 | Finds all ftdi devices on the usb bus. Creates a new ftdi_device_list which |
| 226 | needs to be deallocated by ftdi_list_free() after use. |
| 227 | |
| 228 | \param ftdi pointer to ftdi_context |
| 229 | \param devlist Pointer where to store list of found devices |
| 230 | \param vendor Vendor ID to search for |
| 231 | \param product Product ID to search for |
| 232 | |
| 233 | \retval >0: number of devices found |
| 234 | \retval -3: out of memory |
| 235 | \retval -4: libusb_init() failed |
| 236 | \retval -5: libusb_get_device_list() failed |
| 237 | \retval -6: libusb_get_device_descriptor() failed |
| 238 | */ |
| 239 | int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product) |
| 240 | { |
| 241 | struct ftdi_device_list **curdev; |
| 242 | libusb_device *dev; |
| 243 | libusb_device **devs; |
| 244 | int count = 0; |
| 245 | int i = 0; |
| 246 | |
| 247 | if (libusb_init(&ftdi->usb_ctx) < 0) |
| 248 | ftdi_error_return(-4, "libusb_init() failed"); |
| 249 | |
| 250 | if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0) |
| 251 | ftdi_error_return(-5, "libusb_get_device_list() failed"); |
| 252 | |
| 253 | curdev = devlist; |
| 254 | *curdev = NULL; |
| 255 | |
| 256 | while ((dev = devs[i++]) != NULL) |
| 257 | { |
| 258 | struct libusb_device_descriptor desc; |
| 259 | |
| 260 | if (libusb_get_device_descriptor(dev, &desc) < 0) |
| 261 | ftdi_error_return(-6, "libusb_get_device_descriptor() failed"); |
| 262 | |
| 263 | if (desc.idVendor == vendor && desc.idProduct == product) |
| 264 | { |
| 265 | *curdev = (struct ftdi_device_list*)malloc(sizeof(struct ftdi_device_list)); |
| 266 | if (!*curdev) |
| 267 | ftdi_error_return(-3, "out of memory"); |
| 268 | |
| 269 | (*curdev)->next = NULL; |
| 270 | (*curdev)->dev = dev; |
| 271 | |
| 272 | curdev = &(*curdev)->next; |
| 273 | count++; |
| 274 | } |
| 275 | } |
| 276 | |
| 277 | return count; |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | Frees a usb device list. |
| 282 | |
| 283 | \param devlist USB device list created by ftdi_usb_find_all() |
| 284 | */ |
| 285 | void ftdi_list_free(struct ftdi_device_list **devlist) |
| 286 | { |
| 287 | struct ftdi_device_list *curdev, *next; |
| 288 | |
| 289 | for (curdev = *devlist; curdev != NULL;) |
| 290 | { |
| 291 | next = curdev->next; |
| 292 | free(curdev); |
| 293 | curdev = next; |
| 294 | } |
| 295 | |
| 296 | *devlist = NULL; |
| 297 | } |
| 298 | |
| 299 | /** |
| 300 | Frees a usb device list. |
| 301 | |
| 302 | \param devlist USB device list created by ftdi_usb_find_all() |
| 303 | */ |
| 304 | void ftdi_list_free2(struct ftdi_device_list *devlist) |
| 305 | { |
| 306 | ftdi_list_free(&devlist); |
| 307 | } |
| 308 | |
| 309 | /** |
| 310 | Return device ID strings from the usb device. |
| 311 | |
| 312 | The parameters manufacturer, description and serial may be NULL |
| 313 | or pointer to buffers to store the fetched strings. |
| 314 | |
| 315 | \note Use this function only in combination with ftdi_usb_find_all() |
| 316 | as it closes the internal "usb_dev" after use. |
| 317 | |
| 318 | \param ftdi pointer to ftdi_context |
| 319 | \param dev libusb usb_dev to use |
| 320 | \param manufacturer Store manufacturer string here if not NULL |
| 321 | \param mnf_len Buffer size of manufacturer string |
| 322 | \param description Store product description string here if not NULL |
| 323 | \param desc_len Buffer size of product description string |
| 324 | \param serial Store serial string here if not NULL |
| 325 | \param serial_len Buffer size of serial string |
| 326 | |
| 327 | \retval 0: all fine |
| 328 | \retval -1: wrong arguments |
| 329 | \retval -4: unable to open device |
| 330 | \retval -7: get product manufacturer failed |
| 331 | \retval -8: get product description failed |
| 332 | \retval -9: get serial number failed |
| 333 | \retval -11: libusb_get_device_descriptor() failed |
| 334 | */ |
| 335 | int ftdi_usb_get_strings(struct ftdi_context * ftdi, struct libusb_device * dev, |
| 336 | char * manufacturer, int mnf_len, char * description, int desc_len, char * serial, int serial_len) |
| 337 | { |
| 338 | struct libusb_device_descriptor desc; |
| 339 | |
| 340 | if ((ftdi==NULL) || (dev==NULL)) |
| 341 | return -1; |
| 342 | |
| 343 | if (libusb_open(dev, &ftdi->usb_dev) < 0) |
| 344 | ftdi_error_return(-4, "libusb_open() failed"); |
| 345 | |
| 346 | if (libusb_get_device_descriptor(dev, &desc) < 0) |
| 347 | ftdi_error_return(-11, "libusb_get_device_descriptor() failed"); |
| 348 | |
| 349 | if (manufacturer != NULL) |
| 350 | { |
| 351 | if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iManufacturer, (unsigned char *)manufacturer, mnf_len) < 0) |
| 352 | { |
| 353 | ftdi_usb_close_internal (ftdi); |
| 354 | ftdi_error_return(-7, "libusb_get_string_descriptor_ascii() failed"); |
| 355 | } |
| 356 | } |
| 357 | |
| 358 | if (description != NULL) |
| 359 | { |
| 360 | if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)description, desc_len) < 0) |
| 361 | { |
| 362 | ftdi_usb_close_internal (ftdi); |
| 363 | ftdi_error_return(-8, "libusb_get_string_descriptor_ascii() failed"); |
| 364 | } |
| 365 | } |
| 366 | |
| 367 | if (serial != NULL) |
| 368 | { |
| 369 | if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)serial, serial_len) < 0) |
| 370 | { |
| 371 | ftdi_usb_close_internal (ftdi); |
| 372 | ftdi_error_return(-9, "libusb_get_string_descriptor_ascii() failed"); |
| 373 | } |
| 374 | } |
| 375 | |
| 376 | ftdi_usb_close_internal (ftdi); |
| 377 | |
| 378 | return 0; |
| 379 | } |
| 380 | |
| 381 | /** |
| 382 | * Internal function to determine the maximum packet size. |
| 383 | * \param ftdi pointer to ftdi_context |
| 384 | * \param dev libusb usb_dev to use |
| 385 | * \retval Maximum packet size for this device |
| 386 | */ |
| 387 | static unsigned int _ftdi_determine_max_packet_size(struct ftdi_context *ftdi, libusb_device *dev) |
| 388 | { |
| 389 | struct libusb_device_descriptor desc; |
| 390 | struct libusb_config_descriptor *config0; |
| 391 | unsigned int packet_size; |
| 392 | |
| 393 | // Sanity check |
| 394 | if (ftdi == NULL || dev == NULL) |
| 395 | return 64; |
| 396 | |
| 397 | // Determine maximum packet size. Init with default value. |
| 398 | // New hi-speed devices from FTDI use a packet size of 512 bytes |
| 399 | // but could be connected to a normal speed USB hub -> 64 bytes packet size. |
| 400 | if (ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H) |
| 401 | packet_size = 512; |
| 402 | else |
| 403 | packet_size = 64; |
| 404 | |
| 405 | if (libusb_get_device_descriptor(dev, &desc) < 0) |
| 406 | return packet_size; |
| 407 | |
| 408 | if (libusb_get_config_descriptor(dev, 0, &config0) < 0) |
| 409 | return packet_size; |
| 410 | |
| 411 | if (desc.bNumConfigurations > 0) |
| 412 | { |
| 413 | if (ftdi->interface < config0->bNumInterfaces) |
| 414 | { |
| 415 | struct libusb_interface interface = config0->interface[ftdi->interface]; |
| 416 | if (interface.num_altsetting > 0) |
| 417 | { |
| 418 | struct libusb_interface_descriptor descriptor = interface.altsetting[0]; |
| 419 | if (descriptor.bNumEndpoints > 0) |
| 420 | { |
| 421 | packet_size = descriptor.endpoint[0].wMaxPacketSize; |
| 422 | } |
| 423 | } |
| 424 | } |
| 425 | } |
| 426 | |
| 427 | libusb_free_config_descriptor (config0); |
| 428 | return packet_size; |
| 429 | } |
| 430 | |
| 431 | /** |
| 432 | Opens a ftdi device given by an usb_device. |
| 433 | |
| 434 | \param ftdi pointer to ftdi_context |
| 435 | \param dev libusb usb_dev to use |
| 436 | |
| 437 | \retval 0: all fine |
| 438 | \retval -3: unable to config device |
| 439 | \retval -4: unable to open device |
| 440 | \retval -5: unable to claim device |
| 441 | \retval -6: reset failed |
| 442 | \retval -7: set baudrate failed |
| 443 | \retval -8: ftdi context invalid |
| 444 | \retval -9: libusb_get_device_descriptor() failed |
| 445 | \retval -10: libusb_get_config_descriptor() failed |
| 446 | \retval -11: libusb_etach_kernel_driver() failed |
| 447 | \retval -12: libusb_get_configuration() failed |
| 448 | */ |
| 449 | int ftdi_usb_open_dev(struct ftdi_context *ftdi, libusb_device *dev) |
| 450 | { |
| 451 | struct libusb_device_descriptor desc; |
| 452 | struct libusb_config_descriptor *config0; |
| 453 | int cfg, cfg0, detach_errno = 0; |
| 454 | |
| 455 | if (ftdi == NULL) |
| 456 | ftdi_error_return(-8, "ftdi context invalid"); |
| 457 | |
| 458 | if (libusb_open(dev, &ftdi->usb_dev) < 0) |
| 459 | ftdi_error_return(-4, "libusb_open() failed"); |
| 460 | |
| 461 | if (libusb_get_device_descriptor(dev, &desc) < 0) |
| 462 | ftdi_error_return(-9, "libusb_get_device_descriptor() failed"); |
| 463 | |
| 464 | if (libusb_get_config_descriptor(dev, 0, &config0) < 0) |
| 465 | ftdi_error_return(-10, "libusb_get_config_descriptor() failed"); |
| 466 | cfg0 = config0->bConfigurationValue; |
| 467 | libusb_free_config_descriptor (config0); |
| 468 | |
| 469 | // Try to detach ftdi_sio kernel module. |
| 470 | // |
| 471 | // The return code is kept in a separate variable and only parsed |
| 472 | // if usb_set_configuration() or usb_claim_interface() fails as the |
| 473 | // detach operation might be denied and everything still works fine. |
| 474 | // Likely scenario is a static ftdi_sio kernel module. |
| 475 | if (libusb_detach_kernel_driver(ftdi->usb_dev, ftdi->interface) !=0) |
| 476 | detach_errno = errno; |
| 477 | |
| 478 | if (libusb_get_configuration (ftdi->usb_dev, &cfg) < 0) |
| 479 | ftdi_error_return(-12, "libusb_get_configuration () failed"); |
| 480 | // set configuration (needed especially for windows) |
| 481 | // tolerate EBUSY: one device with one configuration, but two interfaces |
| 482 | // and libftdi sessions to both interfaces (e.g. FT2232) |
| 483 | if (desc.bNumConfigurations > 0 && cfg != cfg0) |
| 484 | { |
| 485 | if (libusb_set_configuration(ftdi->usb_dev, cfg0) < 0) |
| 486 | { |
| 487 | ftdi_usb_close_internal (ftdi); |
| 488 | if(detach_errno == EPERM) |
| 489 | { |
| 490 | ftdi_error_return(-8, "inappropriate permissions on device!"); |
| 491 | } |
| 492 | else |
| 493 | { |
| 494 | ftdi_error_return(-3, "unable to set usb configuration. Make sure the default FTDI driver is not in use"); |
| 495 | } |
| 496 | } |
| 497 | } |
| 498 | |
| 499 | if (libusb_claim_interface(ftdi->usb_dev, ftdi->interface) < 0) |
| 500 | { |
| 501 | ftdi_usb_close_internal (ftdi); |
| 502 | if(detach_errno == EPERM) |
| 503 | { |
| 504 | ftdi_error_return(-8, "inappropriate permissions on device!"); |
| 505 | } |
| 506 | else |
| 507 | { |
| 508 | ftdi_error_return(-5, "unable to claim usb device. Make sure the default FTDI driver is not in use"); |
| 509 | } |
| 510 | } |
| 511 | |
| 512 | if (ftdi_usb_reset (ftdi) != 0) |
| 513 | { |
| 514 | ftdi_usb_close_internal (ftdi); |
| 515 | ftdi_error_return(-6, "ftdi_usb_reset failed"); |
| 516 | } |
| 517 | |
| 518 | // Try to guess chip type |
| 519 | // Bug in the BM type chips: bcdDevice is 0x200 for serial == 0 |
| 520 | if (desc.bcdDevice == 0x400 || (desc.bcdDevice == 0x200 |
| 521 | && desc.iSerialNumber == 0)) |
| 522 | ftdi->type = TYPE_BM; |
| 523 | else if (desc.bcdDevice == 0x200) |
| 524 | ftdi->type = TYPE_AM; |
| 525 | else if (desc.bcdDevice == 0x500) |
| 526 | ftdi->type = TYPE_2232C; |
| 527 | else if (desc.bcdDevice == 0x600) |
| 528 | ftdi->type = TYPE_R; |
| 529 | else if (desc.bcdDevice == 0x700) |
| 530 | ftdi->type = TYPE_2232H; |
| 531 | else if (desc.bcdDevice == 0x800) |
| 532 | ftdi->type = TYPE_4232H; |
| 533 | |
| 534 | // Set default interface on dual/quad type chips |
| 535 | switch(ftdi->type) |
| 536 | { |
| 537 | case TYPE_2232C: |
| 538 | case TYPE_2232H: |
| 539 | case TYPE_4232H: |
| 540 | if (!ftdi->index) |
| 541 | ftdi->index = INTERFACE_A; |
| 542 | break; |
| 543 | default: |
| 544 | break; |
| 545 | } |
| 546 | |
| 547 | // Determine maximum packet size |
| 548 | ftdi->max_packet_size = _ftdi_determine_max_packet_size(ftdi, dev); |
| 549 | |
| 550 | if (ftdi_set_baudrate (ftdi, 9600) != 0) |
| 551 | { |
| 552 | ftdi_usb_close_internal (ftdi); |
| 553 | ftdi_error_return(-7, "set baudrate failed"); |
| 554 | } |
| 555 | |
| 556 | ftdi_error_return(0, "all fine"); |
| 557 | } |
| 558 | |
| 559 | /** |
| 560 | Opens the first device with a given vendor and product ids. |
| 561 | |
| 562 | \param ftdi pointer to ftdi_context |
| 563 | \param vendor Vendor ID |
| 564 | \param product Product ID |
| 565 | |
| 566 | \retval same as ftdi_usb_open_desc() |
| 567 | */ |
| 568 | int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product) |
| 569 | { |
| 570 | return ftdi_usb_open_desc(ftdi, vendor, product, NULL, NULL); |
| 571 | } |
| 572 | |
| 573 | /** |
| 574 | Opens the first device with a given, vendor id, product id, |
| 575 | description and serial. |
| 576 | |
| 577 | \param ftdi pointer to ftdi_context |
| 578 | \param vendor Vendor ID |
| 579 | \param product Product ID |
| 580 | \param description Description to search for. Use NULL if not needed. |
| 581 | \param serial Serial to search for. Use NULL if not needed. |
| 582 | |
| 583 | \retval 0: all fine |
| 584 | \retval -3: usb device not found |
| 585 | \retval -4: unable to open device |
| 586 | \retval -5: unable to claim device |
| 587 | \retval -6: reset failed |
| 588 | \retval -7: set baudrate failed |
| 589 | \retval -8: get product description failed |
| 590 | \retval -9: get serial number failed |
| 591 | \retval -11: libusb_init() failed |
| 592 | \retval -12: libusb_get_device_list() failed |
| 593 | \retval -13: libusb_get_device_descriptor() failed |
| 594 | */ |
| 595 | int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, |
| 596 | const char* description, const char* serial) |
| 597 | { |
| 598 | return ftdi_usb_open_desc_index(ftdi,vendor,product,description,serial,0); |
| 599 | } |
| 600 | |
| 601 | /** |
| 602 | Opens the index-th device with a given, vendor id, product id, |
| 603 | description and serial. |
| 604 | |
| 605 | \param ftdi pointer to ftdi_context |
| 606 | \param vendor Vendor ID |
| 607 | \param product Product ID |
| 608 | \param description Description to search for. Use NULL if not needed. |
| 609 | \param serial Serial to search for. Use NULL if not needed. |
| 610 | \param index Number of matching device to open if there are more than one, starts with 0. |
| 611 | |
| 612 | \retval 0: all fine |
| 613 | \retval -1: usb_find_busses() failed |
| 614 | \retval -2: usb_find_devices() failed |
| 615 | \retval -3: usb device not found |
| 616 | \retval -4: unable to open device |
| 617 | \retval -5: unable to claim device |
| 618 | \retval -6: reset failed |
| 619 | \retval -7: set baudrate failed |
| 620 | \retval -8: get product description failed |
| 621 | \retval -9: get serial number failed |
| 622 | \retval -10: unable to close device |
| 623 | \retval -11: ftdi context invalid |
| 624 | */ |
| 625 | int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, |
| 626 | const char* description, const char* serial, unsigned int index) |
| 627 | { |
| 628 | libusb_device *dev; |
| 629 | libusb_device **devs; |
| 630 | char string[256]; |
| 631 | int i = 0; |
| 632 | |
| 633 | if (libusb_init(&ftdi->usb_ctx) < 0) |
| 634 | ftdi_error_return(-11, "libusb_init() failed"); |
| 635 | |
| 636 | if (ftdi == NULL) |
| 637 | ftdi_error_return(-11, "ftdi context invalid"); |
| 638 | |
| 639 | if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0) |
| 640 | ftdi_error_return(-12, "libusb_get_device_list() failed"); |
| 641 | |
| 642 | while ((dev = devs[i++]) != NULL) |
| 643 | { |
| 644 | struct libusb_device_descriptor desc; |
| 645 | int res; |
| 646 | |
| 647 | if (libusb_get_device_descriptor(dev, &desc) < 0) |
| 648 | ftdi_error_return_free_device_list(-13, "libusb_get_device_descriptor() failed", devs); |
| 649 | |
| 650 | if (desc.idVendor == vendor && desc.idProduct == product) |
| 651 | { |
| 652 | if (libusb_open(dev, &ftdi->usb_dev) < 0) |
| 653 | ftdi_error_return_free_device_list(-4, "usb_open() failed", devs); |
| 654 | |
| 655 | if (description != NULL) |
| 656 | { |
| 657 | if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iProduct, (unsigned char *)string, sizeof(string)) < 0) |
| 658 | { |
| 659 | libusb_close (ftdi->usb_dev); |
| 660 | ftdi_error_return_free_device_list(-8, "unable to fetch product description", devs); |
| 661 | } |
| 662 | if (strncmp(string, description, sizeof(string)) != 0) |
| 663 | { |
| 664 | libusb_close (ftdi->usb_dev); |
| 665 | continue; |
| 666 | } |
| 667 | } |
| 668 | if (serial != NULL) |
| 669 | { |
| 670 | if (libusb_get_string_descriptor_ascii(ftdi->usb_dev, desc.iSerialNumber, (unsigned char *)string, sizeof(string)) < 0) |
| 671 | { |
| 672 | ftdi_usb_close_internal (ftdi); |
| 673 | ftdi_error_return_free_device_list(-9, "unable to fetch serial number", devs); |
| 674 | } |
| 675 | if (strncmp(string, serial, sizeof(string)) != 0) |
| 676 | { |
| 677 | ftdi_usb_close_internal (ftdi); |
| 678 | continue; |
| 679 | } |
| 680 | } |
| 681 | |
| 682 | ftdi_usb_close_internal (ftdi); |
| 683 | |
| 684 | if (index > 0) |
| 685 | { |
| 686 | index--; |
| 687 | continue; |
| 688 | } |
| 689 | |
| 690 | res = ftdi_usb_open_dev(ftdi, dev); |
| 691 | libusb_free_device_list(devs,1); |
| 692 | return res; |
| 693 | } |
| 694 | } |
| 695 | |
| 696 | // device not found |
| 697 | ftdi_error_return_free_device_list(-3, "device not found", devs); |
| 698 | } |
| 699 | |
| 700 | /** |
| 701 | Opens the ftdi-device described by a description-string. |
| 702 | Intended to be used for parsing a device-description given as commandline argument. |
| 703 | |
| 704 | \param ftdi pointer to ftdi_context |
| 705 | \param description NULL-terminated description-string, using this format: |
| 706 | \li <tt>d:\<devicenode></tt> path of bus and device-node (e.g. "003/001") within usb device tree (usually at /proc/bus/usb/) |
| 707 | \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") |
| 708 | \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 |
| 709 | \li <tt>s:\<vendor>:\<product>:\<serial></tt> first device with given vendor id, product id and serial string |
| 710 | |
| 711 | \note The description format may be extended in later versions. |
| 712 | |
| 713 | \retval 0: all fine |
| 714 | \retval -1: libusb_init() failed |
| 715 | \retval -2: libusb_get_device_list() failed |
| 716 | \retval -3: usb device not found |
| 717 | \retval -4: unable to open device |
| 718 | \retval -5: unable to claim device |
| 719 | \retval -6: reset failed |
| 720 | \retval -7: set baudrate failed |
| 721 | \retval -8: get product description failed |
| 722 | \retval -9: get serial number failed |
| 723 | \retval -10: unable to close device |
| 724 | \retval -11: illegal description format |
| 725 | \retval -12: ftdi context invalid |
| 726 | */ |
| 727 | int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description) |
| 728 | { |
| 729 | if (ftdi == NULL) |
| 730 | ftdi_error_return(-12, "ftdi context invalid"); |
| 731 | |
| 732 | if (description[0] == 0 || description[1] != ':') |
| 733 | ftdi_error_return(-11, "illegal description format"); |
| 734 | |
| 735 | if (description[0] == 'd') |
| 736 | { |
| 737 | libusb_device *dev; |
| 738 | libusb_device **devs; |
| 739 | unsigned int bus_number, device_address; |
| 740 | int i = 0; |
| 741 | |
| 742 | if (libusb_init (&ftdi->usb_ctx) < 0) |
| 743 | ftdi_error_return(-1, "libusb_init() failed"); |
| 744 | |
| 745 | if (libusb_get_device_list(ftdi->usb_ctx, &devs) < 0) |
| 746 | ftdi_error_return(-2, "libusb_get_device_list() failed"); |
| 747 | |
| 748 | /* XXX: This doesn't handle symlinks/odd paths/etc... */ |
| 749 | if (sscanf (description + 2, "%u/%u", &bus_number, &device_address) != 2) |
| 750 | ftdi_error_return_free_device_list(-11, "illegal description format", devs); |
| 751 | |
| 752 | while ((dev = devs[i++]) != NULL) |
| 753 | { |
| 754 | int ret; |
| 755 | if (bus_number == libusb_get_bus_number (dev) |
| 756 | && device_address == libusb_get_device_address (dev)) |
| 757 | { |
| 758 | ret = ftdi_usb_open_dev(ftdi, dev); |
| 759 | libusb_free_device_list(devs,1); |
| 760 | return ret; |
| 761 | } |
| 762 | } |
| 763 | |
| 764 | // device not found |
| 765 | ftdi_error_return_free_device_list(-3, "device not found", devs); |
| 766 | } |
| 767 | else if (description[0] == 'i' || description[0] == 's') |
| 768 | { |
| 769 | unsigned int vendor; |
| 770 | unsigned int product; |
| 771 | unsigned int index=0; |
| 772 | const char *serial=NULL; |
| 773 | const char *startp, *endp; |
| 774 | |
| 775 | errno=0; |
| 776 | startp=description+2; |
| 777 | vendor=strtoul((char*)startp,(char**)&endp,0); |
| 778 | if (*endp != ':' || endp == startp || errno != 0) |
| 779 | ftdi_error_return(-11, "illegal description format"); |
| 780 | |
| 781 | startp=endp+1; |
| 782 | product=strtoul((char*)startp,(char**)&endp,0); |
| 783 | if (endp == startp || errno != 0) |
| 784 | ftdi_error_return(-11, "illegal description format"); |
| 785 | |
| 786 | if (description[0] == 'i' && *endp != 0) |
| 787 | { |
| 788 | /* optional index field in i-mode */ |
| 789 | if (*endp != ':') |
| 790 | ftdi_error_return(-11, "illegal description format"); |
| 791 | |
| 792 | startp=endp+1; |
| 793 | index=strtoul((char*)startp,(char**)&endp,0); |
| 794 | if (*endp != 0 || endp == startp || errno != 0) |
| 795 | ftdi_error_return(-11, "illegal description format"); |
| 796 | } |
| 797 | if (description[0] == 's') |
| 798 | { |
| 799 | if (*endp != ':') |
| 800 | ftdi_error_return(-11, "illegal description format"); |
| 801 | |
| 802 | /* rest of the description is the serial */ |
| 803 | serial=endp+1; |
| 804 | } |
| 805 | |
| 806 | return ftdi_usb_open_desc_index(ftdi, vendor, product, NULL, serial, index); |
| 807 | } |
| 808 | else |
| 809 | { |
| 810 | ftdi_error_return(-11, "illegal description format"); |
| 811 | } |
| 812 | } |
| 813 | |
| 814 | /** |
| 815 | Resets the ftdi device. |
| 816 | |
| 817 | \param ftdi pointer to ftdi_context |
| 818 | |
| 819 | \retval 0: all fine |
| 820 | \retval -1: FTDI reset failed |
| 821 | \retval -2: USB device unavailable |
| 822 | */ |
| 823 | int ftdi_usb_reset(struct ftdi_context *ftdi) |
| 824 | { |
| 825 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 826 | ftdi_error_return(-2, "USB device unavailable"); |
| 827 | |
| 828 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 829 | SIO_RESET_REQUEST, SIO_RESET_SIO, |
| 830 | ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 831 | ftdi_error_return(-1,"FTDI reset failed"); |
| 832 | |
| 833 | // Invalidate data in the readbuffer |
| 834 | ftdi->readbuffer_offset = 0; |
| 835 | ftdi->readbuffer_remaining = 0; |
| 836 | |
| 837 | return 0; |
| 838 | } |
| 839 | |
| 840 | /** |
| 841 | Clears the read buffer on the chip and the internal read buffer. |
| 842 | |
| 843 | \param ftdi pointer to ftdi_context |
| 844 | |
| 845 | \retval 0: all fine |
| 846 | \retval -1: read buffer purge failed |
| 847 | \retval -2: USB device unavailable |
| 848 | */ |
| 849 | int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi) |
| 850 | { |
| 851 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 852 | ftdi_error_return(-2, "USB device unavailable"); |
| 853 | |
| 854 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 855 | SIO_RESET_REQUEST, SIO_RESET_PURGE_RX, |
| 856 | ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 857 | ftdi_error_return(-1, "FTDI purge of RX buffer failed"); |
| 858 | |
| 859 | // Invalidate data in the readbuffer |
| 860 | ftdi->readbuffer_offset = 0; |
| 861 | ftdi->readbuffer_remaining = 0; |
| 862 | |
| 863 | return 0; |
| 864 | } |
| 865 | |
| 866 | /** |
| 867 | Clears the write buffer on the chip. |
| 868 | |
| 869 | \param ftdi pointer to ftdi_context |
| 870 | |
| 871 | \retval 0: all fine |
| 872 | \retval -1: write buffer purge failed |
| 873 | \retval -2: USB device unavailable |
| 874 | */ |
| 875 | int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi) |
| 876 | { |
| 877 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 878 | ftdi_error_return(-2, "USB device unavailable"); |
| 879 | |
| 880 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 881 | SIO_RESET_REQUEST, SIO_RESET_PURGE_TX, |
| 882 | ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 883 | ftdi_error_return(-1, "FTDI purge of TX buffer failed"); |
| 884 | |
| 885 | return 0; |
| 886 | } |
| 887 | |
| 888 | /** |
| 889 | Clears the buffers on the chip and the internal read buffer. |
| 890 | |
| 891 | \param ftdi pointer to ftdi_context |
| 892 | |
| 893 | \retval 0: all fine |
| 894 | \retval -1: read buffer purge failed |
| 895 | \retval -2: write buffer purge failed |
| 896 | \retval -3: USB device unavailable |
| 897 | */ |
| 898 | int ftdi_usb_purge_buffers(struct ftdi_context *ftdi) |
| 899 | { |
| 900 | int result; |
| 901 | |
| 902 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 903 | ftdi_error_return(-3, "USB device unavailable"); |
| 904 | |
| 905 | result = ftdi_usb_purge_rx_buffer(ftdi); |
| 906 | if (result < 0) |
| 907 | return -1; |
| 908 | |
| 909 | result = ftdi_usb_purge_tx_buffer(ftdi); |
| 910 | if (result < 0) |
| 911 | return -2; |
| 912 | |
| 913 | return 0; |
| 914 | } |
| 915 | |
| 916 | |
| 917 | |
| 918 | /** |
| 919 | Closes the ftdi device. Call ftdi_deinit() if you're cleaning up. |
| 920 | |
| 921 | \param ftdi pointer to ftdi_context |
| 922 | |
| 923 | \retval 0: all fine |
| 924 | \retval -1: usb_release failed |
| 925 | \retval -3: ftdi context invalid |
| 926 | */ |
| 927 | int ftdi_usb_close(struct ftdi_context *ftdi) |
| 928 | { |
| 929 | int rtn = 0; |
| 930 | |
| 931 | if (ftdi == NULL) |
| 932 | ftdi_error_return(-3, "ftdi context invalid"); |
| 933 | |
| 934 | if (ftdi->usb_dev != NULL) |
| 935 | if (libusb_release_interface(ftdi->usb_dev, ftdi->interface) < 0) |
| 936 | rtn = -1; |
| 937 | |
| 938 | ftdi_usb_close_internal (ftdi); |
| 939 | |
| 940 | return rtn; |
| 941 | } |
| 942 | |
| 943 | /** |
| 944 | ftdi_convert_baudrate returns nearest supported baud rate to that requested. |
| 945 | Function is only used internally |
| 946 | \internal |
| 947 | */ |
| 948 | static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi, |
| 949 | unsigned short *value, unsigned short *index) |
| 950 | { |
| 951 | static const char am_adjust_up[8] = {0, 0, 0, 1, 0, 3, 2, 1}; |
| 952 | static const char am_adjust_dn[8] = {0, 0, 0, 1, 0, 1, 2, 3}; |
| 953 | static const char frac_code[8] = {0, 3, 2, 4, 1, 5, 6, 7}; |
| 954 | int divisor, best_divisor, best_baud, best_baud_diff; |
| 955 | unsigned long encoded_divisor; |
| 956 | int i; |
| 957 | |
| 958 | if (baudrate <= 0) |
| 959 | { |
| 960 | // Return error |
| 961 | return -1; |
| 962 | } |
| 963 | |
| 964 | divisor = 24000000 / baudrate; |
| 965 | |
| 966 | if (ftdi->type == TYPE_AM) |
| 967 | { |
| 968 | // Round down to supported fraction (AM only) |
| 969 | divisor -= am_adjust_dn[divisor & 7]; |
| 970 | } |
| 971 | |
| 972 | // Try this divisor and the one above it (because division rounds down) |
| 973 | best_divisor = 0; |
| 974 | best_baud = 0; |
| 975 | best_baud_diff = 0; |
| 976 | for (i = 0; i < 2; i++) |
| 977 | { |
| 978 | int try_divisor = divisor + i; |
| 979 | int baud_estimate; |
| 980 | int baud_diff; |
| 981 | |
| 982 | // Round up to supported divisor value |
| 983 | if (try_divisor <= 8) |
| 984 | { |
| 985 | // Round up to minimum supported divisor |
| 986 | try_divisor = 8; |
| 987 | } |
| 988 | else if (ftdi->type != TYPE_AM && try_divisor < 12) |
| 989 | { |
| 990 | // BM doesn't support divisors 9 through 11 inclusive |
| 991 | try_divisor = 12; |
| 992 | } |
| 993 | else if (divisor < 16) |
| 994 | { |
| 995 | // AM doesn't support divisors 9 through 15 inclusive |
| 996 | try_divisor = 16; |
| 997 | } |
| 998 | else |
| 999 | { |
| 1000 | if (ftdi->type == TYPE_AM) |
| 1001 | { |
| 1002 | // Round up to supported fraction (AM only) |
| 1003 | try_divisor += am_adjust_up[try_divisor & 7]; |
| 1004 | if (try_divisor > 0x1FFF8) |
| 1005 | { |
| 1006 | // Round down to maximum supported divisor value (for AM) |
| 1007 | try_divisor = 0x1FFF8; |
| 1008 | } |
| 1009 | } |
| 1010 | else |
| 1011 | { |
| 1012 | if (try_divisor > 0x1FFFF) |
| 1013 | { |
| 1014 | // Round down to maximum supported divisor value (for BM) |
| 1015 | try_divisor = 0x1FFFF; |
| 1016 | } |
| 1017 | } |
| 1018 | } |
| 1019 | // Get estimated baud rate (to nearest integer) |
| 1020 | baud_estimate = (24000000 + (try_divisor / 2)) / try_divisor; |
| 1021 | // Get absolute difference from requested baud rate |
| 1022 | if (baud_estimate < baudrate) |
| 1023 | { |
| 1024 | baud_diff = baudrate - baud_estimate; |
| 1025 | } |
| 1026 | else |
| 1027 | { |
| 1028 | baud_diff = baud_estimate - baudrate; |
| 1029 | } |
| 1030 | if (i == 0 || baud_diff < best_baud_diff) |
| 1031 | { |
| 1032 | // Closest to requested baud rate so far |
| 1033 | best_divisor = try_divisor; |
| 1034 | best_baud = baud_estimate; |
| 1035 | best_baud_diff = baud_diff; |
| 1036 | if (baud_diff == 0) |
| 1037 | { |
| 1038 | // Spot on! No point trying |
| 1039 | break; |
| 1040 | } |
| 1041 | } |
| 1042 | } |
| 1043 | // Encode the best divisor value |
| 1044 | encoded_divisor = (best_divisor >> 3) | (frac_code[best_divisor & 7] << 14); |
| 1045 | // Deal with special cases for encoded value |
| 1046 | if (encoded_divisor == 1) |
| 1047 | { |
| 1048 | encoded_divisor = 0; // 3000000 baud |
| 1049 | } |
| 1050 | else if (encoded_divisor == 0x4001) |
| 1051 | { |
| 1052 | encoded_divisor = 1; // 2000000 baud (BM only) |
| 1053 | } |
| 1054 | // Split into "value" and "index" values |
| 1055 | *value = (unsigned short)(encoded_divisor & 0xFFFF); |
| 1056 | if (ftdi->type == TYPE_2232C || ftdi->type == TYPE_2232H || ftdi->type == TYPE_4232H) |
| 1057 | { |
| 1058 | *index = (unsigned short)(encoded_divisor >> 8); |
| 1059 | *index &= 0xFF00; |
| 1060 | *index |= ftdi->index; |
| 1061 | } |
| 1062 | else |
| 1063 | *index = (unsigned short)(encoded_divisor >> 16); |
| 1064 | |
| 1065 | // Return the nearest baud rate |
| 1066 | return best_baud; |
| 1067 | } |
| 1068 | |
| 1069 | /** |
| 1070 | Sets the chip baud rate |
| 1071 | |
| 1072 | \param ftdi pointer to ftdi_context |
| 1073 | \param baudrate baud rate to set |
| 1074 | |
| 1075 | \retval 0: all fine |
| 1076 | \retval -1: invalid baudrate |
| 1077 | \retval -2: setting baudrate failed |
| 1078 | \retval -3: USB device unavailable |
| 1079 | */ |
| 1080 | int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate) |
| 1081 | { |
| 1082 | unsigned short value, index; |
| 1083 | int actual_baudrate; |
| 1084 | |
| 1085 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1086 | ftdi_error_return(-3, "USB device unavailable"); |
| 1087 | |
| 1088 | if (ftdi->bitbang_enabled) |
| 1089 | { |
| 1090 | baudrate = baudrate*4; |
| 1091 | } |
| 1092 | |
| 1093 | actual_baudrate = ftdi_convert_baudrate(baudrate, ftdi, &value, &index); |
| 1094 | if (actual_baudrate <= 0) |
| 1095 | ftdi_error_return (-1, "Silly baudrate <= 0."); |
| 1096 | |
| 1097 | // Check within tolerance (about 5%) |
| 1098 | if ((actual_baudrate * 2 < baudrate /* Catch overflows */ ) |
| 1099 | || ((actual_baudrate < baudrate) |
| 1100 | ? (actual_baudrate * 21 < baudrate * 20) |
| 1101 | : (baudrate * 21 < actual_baudrate * 20))) |
| 1102 | ftdi_error_return (-1, "Unsupported baudrate. Note: bitbang baudrates are automatically multiplied by 4"); |
| 1103 | |
| 1104 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 1105 | SIO_SET_BAUDRATE_REQUEST, value, |
| 1106 | index, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 1107 | ftdi_error_return (-2, "Setting new baudrate failed"); |
| 1108 | |
| 1109 | ftdi->baudrate = baudrate; |
| 1110 | return 0; |
| 1111 | } |
| 1112 | |
| 1113 | /** |
| 1114 | Set (RS232) line characteristics. |
| 1115 | The break type can only be set via ftdi_set_line_property2() |
| 1116 | and defaults to "off". |
| 1117 | |
| 1118 | \param ftdi pointer to ftdi_context |
| 1119 | \param bits Number of bits |
| 1120 | \param sbit Number of stop bits |
| 1121 | \param parity Parity mode |
| 1122 | |
| 1123 | \retval 0: all fine |
| 1124 | \retval -1: Setting line property failed |
| 1125 | */ |
| 1126 | int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
| 1127 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity) |
| 1128 | { |
| 1129 | return ftdi_set_line_property2(ftdi, bits, sbit, parity, BREAK_OFF); |
| 1130 | } |
| 1131 | |
| 1132 | /** |
| 1133 | Set (RS232) line characteristics |
| 1134 | |
| 1135 | \param ftdi pointer to ftdi_context |
| 1136 | \param bits Number of bits |
| 1137 | \param sbit Number of stop bits |
| 1138 | \param parity Parity mode |
| 1139 | \param break_type Break type |
| 1140 | |
| 1141 | \retval 0: all fine |
| 1142 | \retval -1: Setting line property failed |
| 1143 | \retval -2: USB device unavailable |
| 1144 | */ |
| 1145 | int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits, |
| 1146 | enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, |
| 1147 | enum ftdi_break_type break_type) |
| 1148 | { |
| 1149 | unsigned short value = bits; |
| 1150 | |
| 1151 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1152 | ftdi_error_return(-2, "USB device unavailable"); |
| 1153 | |
| 1154 | switch (parity) |
| 1155 | { |
| 1156 | case NONE: |
| 1157 | value |= (0x00 << 8); |
| 1158 | break; |
| 1159 | case ODD: |
| 1160 | value |= (0x01 << 8); |
| 1161 | break; |
| 1162 | case EVEN: |
| 1163 | value |= (0x02 << 8); |
| 1164 | break; |
| 1165 | case MARK: |
| 1166 | value |= (0x03 << 8); |
| 1167 | break; |
| 1168 | case SPACE: |
| 1169 | value |= (0x04 << 8); |
| 1170 | break; |
| 1171 | } |
| 1172 | |
| 1173 | switch (sbit) |
| 1174 | { |
| 1175 | case STOP_BIT_1: |
| 1176 | value |= (0x00 << 11); |
| 1177 | break; |
| 1178 | case STOP_BIT_15: |
| 1179 | value |= (0x01 << 11); |
| 1180 | break; |
| 1181 | case STOP_BIT_2: |
| 1182 | value |= (0x02 << 11); |
| 1183 | break; |
| 1184 | } |
| 1185 | |
| 1186 | switch (break_type) |
| 1187 | { |
| 1188 | case BREAK_OFF: |
| 1189 | value |= (0x00 << 14); |
| 1190 | break; |
| 1191 | case BREAK_ON: |
| 1192 | value |= (0x01 << 14); |
| 1193 | break; |
| 1194 | } |
| 1195 | |
| 1196 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 1197 | SIO_SET_DATA_REQUEST, value, |
| 1198 | ftdi->index, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 1199 | ftdi_error_return (-1, "Setting new line property failed"); |
| 1200 | |
| 1201 | return 0; |
| 1202 | } |
| 1203 | |
| 1204 | /** |
| 1205 | Writes data in chunks (see ftdi_write_data_set_chunksize()) to the chip |
| 1206 | |
| 1207 | \param ftdi pointer to ftdi_context |
| 1208 | \param buf Buffer with the data |
| 1209 | \param size Size of the buffer |
| 1210 | |
| 1211 | \retval -666: USB device unavailable |
| 1212 | \retval <0: error code from usb_bulk_write() |
| 1213 | \retval >0: number of bytes written |
| 1214 | */ |
| 1215 | int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size) |
| 1216 | { |
| 1217 | int offset = 0; |
| 1218 | int actual_length; |
| 1219 | |
| 1220 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1221 | ftdi_error_return(-666, "USB device unavailable"); |
| 1222 | |
| 1223 | while (offset < size) |
| 1224 | { |
| 1225 | int write_size = ftdi->writebuffer_chunksize; |
| 1226 | |
| 1227 | if (offset+write_size > size) |
| 1228 | write_size = size-offset; |
| 1229 | |
| 1230 | if (libusb_bulk_transfer(ftdi->usb_dev, ftdi->in_ep, buf+offset, write_size, &actual_length, ftdi->usb_write_timeout) < 0) |
| 1231 | ftdi_error_return(-1, "usb bulk write failed"); |
| 1232 | |
| 1233 | offset += actual_length; |
| 1234 | } |
| 1235 | |
| 1236 | return offset; |
| 1237 | } |
| 1238 | |
| 1239 | static void ftdi_read_data_cb(struct libusb_transfer *transfer) |
| 1240 | { |
| 1241 | struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data; |
| 1242 | struct ftdi_context *ftdi = tc->ftdi; |
| 1243 | int packet_size, actual_length, num_of_chunks, chunk_remains, i, ret; |
| 1244 | |
| 1245 | packet_size = ftdi->max_packet_size; |
| 1246 | |
| 1247 | actual_length = transfer->actual_length; |
| 1248 | |
| 1249 | if (actual_length > 2) |
| 1250 | { |
| 1251 | // skip FTDI status bytes. |
| 1252 | // Maybe stored in the future to enable modem use |
| 1253 | num_of_chunks = actual_length / packet_size; |
| 1254 | chunk_remains = actual_length % packet_size; |
| 1255 | //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); |
| 1256 | |
| 1257 | ftdi->readbuffer_offset += 2; |
| 1258 | actual_length -= 2; |
| 1259 | |
| 1260 | if (actual_length > packet_size - 2) |
| 1261 | { |
| 1262 | for (i = 1; i < num_of_chunks; i++) |
| 1263 | memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i, |
| 1264 | ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i, |
| 1265 | packet_size - 2); |
| 1266 | if (chunk_remains > 2) |
| 1267 | { |
| 1268 | memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i, |
| 1269 | ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i, |
| 1270 | chunk_remains-2); |
| 1271 | actual_length -= 2*num_of_chunks; |
| 1272 | } |
| 1273 | else |
| 1274 | actual_length -= 2*(num_of_chunks-1)+chunk_remains; |
| 1275 | } |
| 1276 | |
| 1277 | if (actual_length > 0) |
| 1278 | { |
| 1279 | // data still fits in buf? |
| 1280 | if (tc->offset + actual_length <= tc->size) |
| 1281 | { |
| 1282 | memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, actual_length); |
| 1283 | //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]); |
| 1284 | tc->offset += actual_length; |
| 1285 | |
| 1286 | ftdi->readbuffer_offset = 0; |
| 1287 | ftdi->readbuffer_remaining = 0; |
| 1288 | |
| 1289 | /* Did we read exactly the right amount of bytes? */ |
| 1290 | if (tc->offset == tc->size) |
| 1291 | { |
| 1292 | //printf("read_data exact rem %d offset %d\n", |
| 1293 | //ftdi->readbuffer_remaining, offset); |
| 1294 | tc->completed = 1; |
| 1295 | return; |
| 1296 | } |
| 1297 | } |
| 1298 | else |
| 1299 | { |
| 1300 | // only copy part of the data or size <= readbuffer_chunksize |
| 1301 | int part_size = tc->size - tc->offset; |
| 1302 | memcpy (tc->buf + tc->offset, ftdi->readbuffer + ftdi->readbuffer_offset, part_size); |
| 1303 | tc->offset += part_size; |
| 1304 | |
| 1305 | ftdi->readbuffer_offset += part_size; |
| 1306 | ftdi->readbuffer_remaining = actual_length - part_size; |
| 1307 | |
| 1308 | /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n", |
| 1309 | part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */ |
| 1310 | tc->completed = 1; |
| 1311 | return; |
| 1312 | } |
| 1313 | } |
| 1314 | } |
| 1315 | ret = libusb_submit_transfer (transfer); |
| 1316 | if (ret < 0) |
| 1317 | tc->completed = 1; |
| 1318 | } |
| 1319 | |
| 1320 | |
| 1321 | static void ftdi_write_data_cb(struct libusb_transfer *transfer) |
| 1322 | { |
| 1323 | struct ftdi_transfer_control *tc = (struct ftdi_transfer_control *) transfer->user_data; |
| 1324 | struct ftdi_context *ftdi = tc->ftdi; |
| 1325 | |
| 1326 | tc->offset += transfer->actual_length; |
| 1327 | |
| 1328 | if (tc->offset == tc->size) |
| 1329 | { |
| 1330 | tc->completed = 1; |
| 1331 | } |
| 1332 | else |
| 1333 | { |
| 1334 | int write_size = ftdi->writebuffer_chunksize; |
| 1335 | int ret; |
| 1336 | |
| 1337 | if (tc->offset + write_size > tc->size) |
| 1338 | write_size = tc->size - tc->offset; |
| 1339 | |
| 1340 | transfer->length = write_size; |
| 1341 | transfer->buffer = tc->buf + tc->offset; |
| 1342 | ret = libusb_submit_transfer (transfer); |
| 1343 | if (ret < 0) |
| 1344 | tc->completed = 1; |
| 1345 | } |
| 1346 | } |
| 1347 | |
| 1348 | |
| 1349 | /** |
| 1350 | Writes data to the chip. Does not wait for completion of the transfer |
| 1351 | nor does it make sure that the transfer was successful. |
| 1352 | |
| 1353 | Use libusb 1.0 asynchronous API. |
| 1354 | |
| 1355 | \param ftdi pointer to ftdi_context |
| 1356 | \param buf Buffer with the data |
| 1357 | \param size Size of the buffer |
| 1358 | |
| 1359 | \retval NULL: Some error happens when submit transfer |
| 1360 | \retval !NULL: Pointer to a ftdi_transfer_control |
| 1361 | */ |
| 1362 | |
| 1363 | struct ftdi_transfer_control *ftdi_write_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size) |
| 1364 | { |
| 1365 | struct ftdi_transfer_control *tc; |
| 1366 | struct libusb_transfer *transfer = libusb_alloc_transfer(0); |
| 1367 | int write_size, ret; |
| 1368 | |
| 1369 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1370 | { |
| 1371 | libusb_free_transfer(transfer); |
| 1372 | return NULL; |
| 1373 | } |
| 1374 | |
| 1375 | tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc)); |
| 1376 | |
| 1377 | if (!tc || !transfer) |
| 1378 | return NULL; |
| 1379 | |
| 1380 | tc->ftdi = ftdi; |
| 1381 | tc->completed = 0; |
| 1382 | tc->buf = buf; |
| 1383 | tc->size = size; |
| 1384 | tc->offset = 0; |
| 1385 | |
| 1386 | if (size < ftdi->writebuffer_chunksize) |
| 1387 | write_size = size; |
| 1388 | else |
| 1389 | write_size = ftdi->writebuffer_chunksize; |
| 1390 | |
| 1391 | libusb_fill_bulk_transfer(transfer, ftdi->usb_dev, ftdi->in_ep, buf, |
| 1392 | write_size, ftdi_write_data_cb, tc, |
| 1393 | ftdi->usb_write_timeout); |
| 1394 | transfer->type = LIBUSB_TRANSFER_TYPE_BULK; |
| 1395 | |
| 1396 | ret = libusb_submit_transfer(transfer); |
| 1397 | if (ret < 0) |
| 1398 | { |
| 1399 | libusb_free_transfer(transfer); |
| 1400 | tc->completed = 1; |
| 1401 | tc->transfer = NULL; |
| 1402 | return NULL; |
| 1403 | } |
| 1404 | tc->transfer = transfer; |
| 1405 | |
| 1406 | return tc; |
| 1407 | } |
| 1408 | |
| 1409 | /** |
| 1410 | Reads data from the chip. Does not wait for completion of the transfer |
| 1411 | nor does it make sure that the transfer was successful. |
| 1412 | |
| 1413 | Use libusb 1.0 asynchronous API. |
| 1414 | |
| 1415 | \param ftdi pointer to ftdi_context |
| 1416 | \param buf Buffer with the data |
| 1417 | \param size Size of the buffer |
| 1418 | |
| 1419 | \retval NULL: Some error happens when submit transfer |
| 1420 | \retval !NULL: Pointer to a ftdi_transfer_control |
| 1421 | */ |
| 1422 | |
| 1423 | struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size) |
| 1424 | { |
| 1425 | struct ftdi_transfer_control *tc; |
| 1426 | struct libusb_transfer *transfer; |
| 1427 | int ret; |
| 1428 | |
| 1429 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1430 | return NULL; |
| 1431 | |
| 1432 | tc = (struct ftdi_transfer_control *) malloc (sizeof (*tc)); |
| 1433 | if (!tc) |
| 1434 | return NULL; |
| 1435 | |
| 1436 | tc->ftdi = ftdi; |
| 1437 | tc->buf = buf; |
| 1438 | tc->size = size; |
| 1439 | |
| 1440 | if (size <= ftdi->readbuffer_remaining) |
| 1441 | { |
| 1442 | memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size); |
| 1443 | |
| 1444 | // Fix offsets |
| 1445 | ftdi->readbuffer_remaining -= size; |
| 1446 | ftdi->readbuffer_offset += size; |
| 1447 | |
| 1448 | /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */ |
| 1449 | |
| 1450 | tc->completed = 1; |
| 1451 | tc->offset = size; |
| 1452 | tc->transfer = NULL; |
| 1453 | return tc; |
| 1454 | } |
| 1455 | |
| 1456 | tc->completed = 0; |
| 1457 | if (ftdi->readbuffer_remaining != 0) |
| 1458 | { |
| 1459 | memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining); |
| 1460 | |
| 1461 | tc->offset = ftdi->readbuffer_remaining; |
| 1462 | } |
| 1463 | else |
| 1464 | tc->offset = 0; |
| 1465 | |
| 1466 | transfer = libusb_alloc_transfer(0); |
| 1467 | if (!transfer) |
| 1468 | { |
| 1469 | free (tc); |
| 1470 | return NULL; |
| 1471 | } |
| 1472 | |
| 1473 | ftdi->readbuffer_remaining = 0; |
| 1474 | ftdi->readbuffer_offset = 0; |
| 1475 | |
| 1476 | 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); |
| 1477 | transfer->type = LIBUSB_TRANSFER_TYPE_BULK; |
| 1478 | |
| 1479 | ret = libusb_submit_transfer(transfer); |
| 1480 | if (ret < 0) |
| 1481 | { |
| 1482 | libusb_free_transfer(transfer); |
| 1483 | free (tc); |
| 1484 | return NULL; |
| 1485 | } |
| 1486 | tc->transfer = transfer; |
| 1487 | |
| 1488 | return tc; |
| 1489 | } |
| 1490 | |
| 1491 | /** |
| 1492 | Wait for completion of the transfer. |
| 1493 | |
| 1494 | Use libusb 1.0 asynchronous API. |
| 1495 | |
| 1496 | \param tc pointer to ftdi_transfer_control |
| 1497 | |
| 1498 | \retval < 0: Some error happens |
| 1499 | \retval >= 0: Data size transferred |
| 1500 | */ |
| 1501 | |
| 1502 | int ftdi_transfer_data_done(struct ftdi_transfer_control *tc) |
| 1503 | { |
| 1504 | int ret; |
| 1505 | |
| 1506 | while (!tc->completed) |
| 1507 | { |
| 1508 | ret = libusb_handle_events(tc->ftdi->usb_ctx); |
| 1509 | if (ret < 0) |
| 1510 | { |
| 1511 | if (ret == LIBUSB_ERROR_INTERRUPTED) |
| 1512 | continue; |
| 1513 | libusb_cancel_transfer(tc->transfer); |
| 1514 | while (!tc->completed) |
| 1515 | if (libusb_handle_events(tc->ftdi->usb_ctx) < 0) |
| 1516 | break; |
| 1517 | libusb_free_transfer(tc->transfer); |
| 1518 | free (tc); |
| 1519 | return ret; |
| 1520 | } |
| 1521 | } |
| 1522 | |
| 1523 | ret = tc->offset; |
| 1524 | /** |
| 1525 | * tc->transfer could be NULL if "(size <= ftdi->readbuffer_remaining)" |
| 1526 | * at ftdi_read_data_submit(). Therefore, we need to check it here. |
| 1527 | **/ |
| 1528 | if (tc->transfer) |
| 1529 | { |
| 1530 | if (tc->transfer->status != LIBUSB_TRANSFER_COMPLETED) |
| 1531 | ret = -1; |
| 1532 | libusb_free_transfer(tc->transfer); |
| 1533 | } |
| 1534 | free(tc); |
| 1535 | return ret; |
| 1536 | } |
| 1537 | |
| 1538 | /** |
| 1539 | Configure write buffer chunk size. |
| 1540 | Default is 4096. |
| 1541 | |
| 1542 | \param ftdi pointer to ftdi_context |
| 1543 | \param chunksize Chunk size |
| 1544 | |
| 1545 | \retval 0: all fine |
| 1546 | \retval -1: ftdi context invalid |
| 1547 | */ |
| 1548 | int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize) |
| 1549 | { |
| 1550 | if (ftdi == NULL) |
| 1551 | ftdi_error_return(-1, "ftdi context invalid"); |
| 1552 | |
| 1553 | ftdi->writebuffer_chunksize = chunksize; |
| 1554 | return 0; |
| 1555 | } |
| 1556 | |
| 1557 | /** |
| 1558 | Get write buffer chunk size. |
| 1559 | |
| 1560 | \param ftdi pointer to ftdi_context |
| 1561 | \param chunksize Pointer to store chunk size in |
| 1562 | |
| 1563 | \retval 0: all fine |
| 1564 | \retval -1: ftdi context invalid |
| 1565 | */ |
| 1566 | int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize) |
| 1567 | { |
| 1568 | if (ftdi == NULL) |
| 1569 | ftdi_error_return(-1, "ftdi context invalid"); |
| 1570 | |
| 1571 | *chunksize = ftdi->writebuffer_chunksize; |
| 1572 | return 0; |
| 1573 | } |
| 1574 | |
| 1575 | /** |
| 1576 | Reads data in chunks (see ftdi_read_data_set_chunksize()) from the chip. |
| 1577 | |
| 1578 | Automatically strips the two modem status bytes transfered during every read. |
| 1579 | |
| 1580 | \param ftdi pointer to ftdi_context |
| 1581 | \param buf Buffer to store data in |
| 1582 | \param size Size of the buffer |
| 1583 | |
| 1584 | \retval -666: USB device unavailable |
| 1585 | \retval <0: error code from libusb_bulk_transfer() |
| 1586 | \retval 0: no data was available |
| 1587 | \retval >0: number of bytes read |
| 1588 | |
| 1589 | */ |
| 1590 | int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size) |
| 1591 | { |
| 1592 | int offset = 0, ret, i, num_of_chunks, chunk_remains; |
| 1593 | int packet_size = ftdi->max_packet_size; |
| 1594 | int actual_length = 1; |
| 1595 | |
| 1596 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1597 | ftdi_error_return(-666, "USB device unavailable"); |
| 1598 | |
| 1599 | // Packet size sanity check (avoid division by zero) |
| 1600 | if (packet_size == 0) |
| 1601 | ftdi_error_return(-1, "max_packet_size is bogus (zero)"); |
| 1602 | |
| 1603 | // everything we want is still in the readbuffer? |
| 1604 | if (size <= ftdi->readbuffer_remaining) |
| 1605 | { |
| 1606 | memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, size); |
| 1607 | |
| 1608 | // Fix offsets |
| 1609 | ftdi->readbuffer_remaining -= size; |
| 1610 | ftdi->readbuffer_offset += size; |
| 1611 | |
| 1612 | /* printf("Returning bytes from buffer: %d - remaining: %d\n", size, ftdi->readbuffer_remaining); */ |
| 1613 | |
| 1614 | return size; |
| 1615 | } |
| 1616 | // something still in the readbuffer, but not enough to satisfy 'size'? |
| 1617 | if (ftdi->readbuffer_remaining != 0) |
| 1618 | { |
| 1619 | memcpy (buf, ftdi->readbuffer+ftdi->readbuffer_offset, ftdi->readbuffer_remaining); |
| 1620 | |
| 1621 | // Fix offset |
| 1622 | offset += ftdi->readbuffer_remaining; |
| 1623 | } |
| 1624 | // do the actual USB read |
| 1625 | while (offset < size && actual_length > 0) |
| 1626 | { |
| 1627 | ftdi->readbuffer_remaining = 0; |
| 1628 | ftdi->readbuffer_offset = 0; |
| 1629 | /* returns how much received */ |
| 1630 | ret = libusb_bulk_transfer (ftdi->usb_dev, ftdi->out_ep, ftdi->readbuffer, ftdi->readbuffer_chunksize, &actual_length, ftdi->usb_read_timeout); |
| 1631 | if (ret < 0) |
| 1632 | ftdi_error_return(ret, "usb bulk read failed"); |
| 1633 | |
| 1634 | if (actual_length > 2) |
| 1635 | { |
| 1636 | // skip FTDI status bytes. |
| 1637 | // Maybe stored in the future to enable modem use |
| 1638 | num_of_chunks = actual_length / packet_size; |
| 1639 | chunk_remains = actual_length % packet_size; |
| 1640 | //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); |
| 1641 | |
| 1642 | ftdi->readbuffer_offset += 2; |
| 1643 | actual_length -= 2; |
| 1644 | |
| 1645 | if (actual_length > packet_size - 2) |
| 1646 | { |
| 1647 | for (i = 1; i < num_of_chunks; i++) |
| 1648 | memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i, |
| 1649 | ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i, |
| 1650 | packet_size - 2); |
| 1651 | if (chunk_remains > 2) |
| 1652 | { |
| 1653 | memmove (ftdi->readbuffer+ftdi->readbuffer_offset+(packet_size - 2)*i, |
| 1654 | ftdi->readbuffer+ftdi->readbuffer_offset+packet_size*i, |
| 1655 | chunk_remains-2); |
| 1656 | actual_length -= 2*num_of_chunks; |
| 1657 | } |
| 1658 | else |
| 1659 | actual_length -= 2*(num_of_chunks-1)+chunk_remains; |
| 1660 | } |
| 1661 | } |
| 1662 | else if (actual_length <= 2) |
| 1663 | { |
| 1664 | // no more data to read? |
| 1665 | return offset; |
| 1666 | } |
| 1667 | if (actual_length > 0) |
| 1668 | { |
| 1669 | // data still fits in buf? |
| 1670 | if (offset+actual_length <= size) |
| 1671 | { |
| 1672 | memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, actual_length); |
| 1673 | //printf("buf[0] = %X, buf[1] = %X\n", buf[0], buf[1]); |
| 1674 | offset += actual_length; |
| 1675 | |
| 1676 | /* Did we read exactly the right amount of bytes? */ |
| 1677 | if (offset == size) |
| 1678 | //printf("read_data exact rem %d offset %d\n", |
| 1679 | //ftdi->readbuffer_remaining, offset); |
| 1680 | return offset; |
| 1681 | } |
| 1682 | else |
| 1683 | { |
| 1684 | // only copy part of the data or size <= readbuffer_chunksize |
| 1685 | int part_size = size-offset; |
| 1686 | memcpy (buf+offset, ftdi->readbuffer+ftdi->readbuffer_offset, part_size); |
| 1687 | |
| 1688 | ftdi->readbuffer_offset += part_size; |
| 1689 | ftdi->readbuffer_remaining = actual_length-part_size; |
| 1690 | offset += part_size; |
| 1691 | |
| 1692 | /* printf("Returning part: %d - size: %d - offset: %d - actual_length: %d - remaining: %d\n", |
| 1693 | part_size, size, offset, actual_length, ftdi->readbuffer_remaining); */ |
| 1694 | |
| 1695 | return offset; |
| 1696 | } |
| 1697 | } |
| 1698 | } |
| 1699 | // never reached |
| 1700 | return -127; |
| 1701 | } |
| 1702 | |
| 1703 | /** |
| 1704 | Configure read buffer chunk size. |
| 1705 | Default is 4096. |
| 1706 | |
| 1707 | Automatically reallocates the buffer. |
| 1708 | |
| 1709 | \param ftdi pointer to ftdi_context |
| 1710 | \param chunksize Chunk size |
| 1711 | |
| 1712 | \retval 0: all fine |
| 1713 | \retval -1: ftdi context invalid |
| 1714 | */ |
| 1715 | int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize) |
| 1716 | { |
| 1717 | unsigned char *new_buf; |
| 1718 | |
| 1719 | if (ftdi == NULL) |
| 1720 | ftdi_error_return(-1, "ftdi context invalid"); |
| 1721 | |
| 1722 | // Invalidate all remaining data |
| 1723 | ftdi->readbuffer_offset = 0; |
| 1724 | ftdi->readbuffer_remaining = 0; |
| 1725 | #ifdef __linux__ |
| 1726 | /* We can't set readbuffer_chunksize larger than MAX_BULK_BUFFER_LENGTH, |
| 1727 | which is defined in libusb-1.0. Otherwise, each USB read request will |
| 1728 | be divided into multiple URBs. This will cause issues on Linux kernel |
| 1729 | older than 2.6.32. */ |
| 1730 | if (chunksize > 16384) |
| 1731 | chunksize = 16384; |
| 1732 | #endif |
| 1733 | |
| 1734 | if ((new_buf = (unsigned char *)realloc(ftdi->readbuffer, chunksize)) == NULL) |
| 1735 | ftdi_error_return(-1, "out of memory for readbuffer"); |
| 1736 | |
| 1737 | ftdi->readbuffer = new_buf; |
| 1738 | ftdi->readbuffer_chunksize = chunksize; |
| 1739 | |
| 1740 | return 0; |
| 1741 | } |
| 1742 | |
| 1743 | /** |
| 1744 | Get read buffer chunk size. |
| 1745 | |
| 1746 | \param ftdi pointer to ftdi_context |
| 1747 | \param chunksize Pointer to store chunk size in |
| 1748 | |
| 1749 | \retval 0: all fine |
| 1750 | \retval -1: FTDI context invalid |
| 1751 | */ |
| 1752 | int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize) |
| 1753 | { |
| 1754 | if (ftdi == NULL) |
| 1755 | ftdi_error_return(-1, "FTDI context invalid"); |
| 1756 | |
| 1757 | *chunksize = ftdi->readbuffer_chunksize; |
| 1758 | return 0; |
| 1759 | } |
| 1760 | |
| 1761 | |
| 1762 | /** |
| 1763 | Enable bitbang mode. |
| 1764 | |
| 1765 | \deprecated use \ref ftdi_set_bitmode with mode BITMODE_BITBANG instead |
| 1766 | |
| 1767 | \param ftdi pointer to ftdi_context |
| 1768 | \param bitmask Bitmask to configure lines. |
| 1769 | HIGH/ON value configures a line as output. |
| 1770 | |
| 1771 | \retval 0: all fine |
| 1772 | \retval -1: can't enable bitbang mode |
| 1773 | \retval -2: USB device unavailable |
| 1774 | */ |
| 1775 | int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask) |
| 1776 | { |
| 1777 | unsigned short usb_val; |
| 1778 | |
| 1779 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1780 | ftdi_error_return(-2, "USB device unavailable"); |
| 1781 | |
| 1782 | usb_val = bitmask; // low byte: bitmask |
| 1783 | /* FT2232C: Set bitbang_mode to 2 to enable SPI */ |
| 1784 | usb_val |= (ftdi->bitbang_mode << 8); |
| 1785 | |
| 1786 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 1787 | SIO_SET_BITMODE_REQUEST, usb_val, ftdi->index, |
| 1788 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 1789 | ftdi_error_return(-1, "unable to enter bitbang mode. Perhaps not a BM type chip?"); |
| 1790 | |
| 1791 | ftdi->bitbang_enabled = 1; |
| 1792 | return 0; |
| 1793 | } |
| 1794 | |
| 1795 | /** |
| 1796 | Disable bitbang mode. |
| 1797 | |
| 1798 | \param ftdi pointer to ftdi_context |
| 1799 | |
| 1800 | \retval 0: all fine |
| 1801 | \retval -1: can't disable bitbang mode |
| 1802 | \retval -2: USB device unavailable |
| 1803 | */ |
| 1804 | int ftdi_disable_bitbang(struct ftdi_context *ftdi) |
| 1805 | { |
| 1806 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1807 | ftdi_error_return(-2, "USB device unavailable"); |
| 1808 | |
| 1809 | 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) |
| 1810 | ftdi_error_return(-1, "unable to leave bitbang mode. Perhaps not a BM type chip?"); |
| 1811 | |
| 1812 | ftdi->bitbang_enabled = 0; |
| 1813 | return 0; |
| 1814 | } |
| 1815 | |
| 1816 | /** |
| 1817 | Enable/disable bitbang modes. |
| 1818 | |
| 1819 | \param ftdi pointer to ftdi_context |
| 1820 | \param bitmask Bitmask to configure lines. |
| 1821 | HIGH/ON value configures a line as output. |
| 1822 | \param mode Bitbang mode: use the values defined in \ref ftdi_mpsse_mode |
| 1823 | |
| 1824 | \retval 0: all fine |
| 1825 | \retval -1: can't enable bitbang mode |
| 1826 | \retval -2: USB device unavailable |
| 1827 | */ |
| 1828 | int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode) |
| 1829 | { |
| 1830 | unsigned short usb_val; |
| 1831 | |
| 1832 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1833 | ftdi_error_return(-2, "USB device unavailable"); |
| 1834 | |
| 1835 | usb_val = bitmask; // low byte: bitmask |
| 1836 | usb_val |= (mode << 8); |
| 1837 | 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) |
| 1838 | ftdi_error_return(-1, "unable to configure bitbang mode. Perhaps not a 2232C type chip?"); |
| 1839 | |
| 1840 | ftdi->bitbang_mode = mode; |
| 1841 | ftdi->bitbang_enabled = (mode == BITMODE_RESET) ? 0 : 1; |
| 1842 | return 0; |
| 1843 | } |
| 1844 | |
| 1845 | /** |
| 1846 | Directly read pin state, circumventing the read buffer. Useful for bitbang mode. |
| 1847 | |
| 1848 | \param ftdi pointer to ftdi_context |
| 1849 | \param pins Pointer to store pins into |
| 1850 | |
| 1851 | \retval 0: all fine |
| 1852 | \retval -1: read pins failed |
| 1853 | \retval -2: USB device unavailable |
| 1854 | */ |
| 1855 | int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins) |
| 1856 | { |
| 1857 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1858 | ftdi_error_return(-2, "USB device unavailable"); |
| 1859 | |
| 1860 | 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) |
| 1861 | ftdi_error_return(-1, "read pins failed"); |
| 1862 | |
| 1863 | return 0; |
| 1864 | } |
| 1865 | |
| 1866 | /** |
| 1867 | Set latency timer |
| 1868 | |
| 1869 | The FTDI chip keeps data in the internal buffer for a specific |
| 1870 | amount of time if the buffer is not full yet to decrease |
| 1871 | load on the usb bus. |
| 1872 | |
| 1873 | \param ftdi pointer to ftdi_context |
| 1874 | \param latency Value between 1 and 255 |
| 1875 | |
| 1876 | \retval 0: all fine |
| 1877 | \retval -1: latency out of range |
| 1878 | \retval -2: unable to set latency timer |
| 1879 | \retval -3: USB device unavailable |
| 1880 | */ |
| 1881 | int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency) |
| 1882 | { |
| 1883 | unsigned short usb_val; |
| 1884 | |
| 1885 | if (latency < 1) |
| 1886 | ftdi_error_return(-1, "latency out of range. Only valid for 1-255"); |
| 1887 | |
| 1888 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1889 | ftdi_error_return(-3, "USB device unavailable"); |
| 1890 | |
| 1891 | usb_val = latency; |
| 1892 | 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) |
| 1893 | ftdi_error_return(-2, "unable to set latency timer"); |
| 1894 | |
| 1895 | return 0; |
| 1896 | } |
| 1897 | |
| 1898 | /** |
| 1899 | Get latency timer |
| 1900 | |
| 1901 | \param ftdi pointer to ftdi_context |
| 1902 | \param latency Pointer to store latency value in |
| 1903 | |
| 1904 | \retval 0: all fine |
| 1905 | \retval -1: unable to get latency timer |
| 1906 | \retval -2: USB device unavailable |
| 1907 | */ |
| 1908 | int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency) |
| 1909 | { |
| 1910 | unsigned short usb_val; |
| 1911 | |
| 1912 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1913 | ftdi_error_return(-2, "USB device unavailable"); |
| 1914 | |
| 1915 | 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) |
| 1916 | ftdi_error_return(-1, "reading latency timer failed"); |
| 1917 | |
| 1918 | *latency = (unsigned char)usb_val; |
| 1919 | return 0; |
| 1920 | } |
| 1921 | |
| 1922 | /** |
| 1923 | Poll modem status information |
| 1924 | |
| 1925 | This function allows the retrieve the two status bytes of the device. |
| 1926 | The device sends these bytes also as a header for each read access |
| 1927 | where they are discarded by ftdi_read_data(). The chip generates |
| 1928 | the two stripped status bytes in the absence of data every 40 ms. |
| 1929 | |
| 1930 | Layout of the first byte: |
| 1931 | - B0..B3 - must be 0 |
| 1932 | - B4 Clear to send (CTS) |
| 1933 | 0 = inactive |
| 1934 | 1 = active |
| 1935 | - B5 Data set ready (DTS) |
| 1936 | 0 = inactive |
| 1937 | 1 = active |
| 1938 | - B6 Ring indicator (RI) |
| 1939 | 0 = inactive |
| 1940 | 1 = active |
| 1941 | - B7 Receive line signal detect (RLSD) |
| 1942 | 0 = inactive |
| 1943 | 1 = active |
| 1944 | |
| 1945 | Layout of the second byte: |
| 1946 | - B0 Data ready (DR) |
| 1947 | - B1 Overrun error (OE) |
| 1948 | - B2 Parity error (PE) |
| 1949 | - B3 Framing error (FE) |
| 1950 | - B4 Break interrupt (BI) |
| 1951 | - B5 Transmitter holding register (THRE) |
| 1952 | - B6 Transmitter empty (TEMT) |
| 1953 | - B7 Error in RCVR FIFO |
| 1954 | |
| 1955 | \param ftdi pointer to ftdi_context |
| 1956 | \param status Pointer to store status information in. Must be two bytes. |
| 1957 | |
| 1958 | \retval 0: all fine |
| 1959 | \retval -1: unable to retrieve status information |
| 1960 | \retval -2: USB device unavailable |
| 1961 | */ |
| 1962 | int ftdi_poll_modem_status(struct ftdi_context *ftdi, unsigned short *status) |
| 1963 | { |
| 1964 | char usb_val[2]; |
| 1965 | |
| 1966 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1967 | ftdi_error_return(-2, "USB device unavailable"); |
| 1968 | |
| 1969 | 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) |
| 1970 | ftdi_error_return(-1, "getting modem status failed"); |
| 1971 | |
| 1972 | *status = (usb_val[1] << 8) | usb_val[0]; |
| 1973 | |
| 1974 | return 0; |
| 1975 | } |
| 1976 | |
| 1977 | /** |
| 1978 | Set flowcontrol for ftdi chip |
| 1979 | |
| 1980 | \param ftdi pointer to ftdi_context |
| 1981 | \param flowctrl flow control to use. should be |
| 1982 | SIO_DISABLE_FLOW_CTRL, SIO_RTS_CTS_HS, SIO_DTR_DSR_HS or SIO_XON_XOFF_HS |
| 1983 | |
| 1984 | \retval 0: all fine |
| 1985 | \retval -1: set flow control failed |
| 1986 | \retval -2: USB device unavailable |
| 1987 | */ |
| 1988 | int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl) |
| 1989 | { |
| 1990 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 1991 | ftdi_error_return(-2, "USB device unavailable"); |
| 1992 | |
| 1993 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 1994 | SIO_SET_FLOW_CTRL_REQUEST, 0, (flowctrl | ftdi->index), |
| 1995 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 1996 | ftdi_error_return(-1, "set flow control failed"); |
| 1997 | |
| 1998 | return 0; |
| 1999 | } |
| 2000 | |
| 2001 | /** |
| 2002 | Set dtr line |
| 2003 | |
| 2004 | \param ftdi pointer to ftdi_context |
| 2005 | \param state state to set line to (1 or 0) |
| 2006 | |
| 2007 | \retval 0: all fine |
| 2008 | \retval -1: set dtr failed |
| 2009 | \retval -2: USB device unavailable |
| 2010 | */ |
| 2011 | int ftdi_setdtr(struct ftdi_context *ftdi, int state) |
| 2012 | { |
| 2013 | unsigned short usb_val; |
| 2014 | |
| 2015 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2016 | ftdi_error_return(-2, "USB device unavailable"); |
| 2017 | |
| 2018 | if (state) |
| 2019 | usb_val = SIO_SET_DTR_HIGH; |
| 2020 | else |
| 2021 | usb_val = SIO_SET_DTR_LOW; |
| 2022 | |
| 2023 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 2024 | SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index, |
| 2025 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 2026 | ftdi_error_return(-1, "set dtr failed"); |
| 2027 | |
| 2028 | return 0; |
| 2029 | } |
| 2030 | |
| 2031 | /** |
| 2032 | Set rts line |
| 2033 | |
| 2034 | \param ftdi pointer to ftdi_context |
| 2035 | \param state state to set line to (1 or 0) |
| 2036 | |
| 2037 | \retval 0: all fine |
| 2038 | \retval -1: set rts failed |
| 2039 | \retval -2: USB device unavailable |
| 2040 | */ |
| 2041 | int ftdi_setrts(struct ftdi_context *ftdi, int state) |
| 2042 | { |
| 2043 | unsigned short usb_val; |
| 2044 | |
| 2045 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2046 | ftdi_error_return(-2, "USB device unavailable"); |
| 2047 | |
| 2048 | if (state) |
| 2049 | usb_val = SIO_SET_RTS_HIGH; |
| 2050 | else |
| 2051 | usb_val = SIO_SET_RTS_LOW; |
| 2052 | |
| 2053 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 2054 | SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index, |
| 2055 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 2056 | ftdi_error_return(-1, "set of rts failed"); |
| 2057 | |
| 2058 | return 0; |
| 2059 | } |
| 2060 | |
| 2061 | /** |
| 2062 | Set dtr and rts line in one pass |
| 2063 | |
| 2064 | \param ftdi pointer to ftdi_context |
| 2065 | \param dtr DTR state to set line to (1 or 0) |
| 2066 | \param rts RTS state to set line to (1 or 0) |
| 2067 | |
| 2068 | \retval 0: all fine |
| 2069 | \retval -1: set dtr/rts failed |
| 2070 | \retval -2: USB device unavailable |
| 2071 | */ |
| 2072 | int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts) |
| 2073 | { |
| 2074 | unsigned short usb_val; |
| 2075 | |
| 2076 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2077 | ftdi_error_return(-2, "USB device unavailable"); |
| 2078 | |
| 2079 | if (dtr) |
| 2080 | usb_val = SIO_SET_DTR_HIGH; |
| 2081 | else |
| 2082 | usb_val = SIO_SET_DTR_LOW; |
| 2083 | |
| 2084 | if (rts) |
| 2085 | usb_val |= SIO_SET_RTS_HIGH; |
| 2086 | else |
| 2087 | usb_val |= SIO_SET_RTS_LOW; |
| 2088 | |
| 2089 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 2090 | SIO_SET_MODEM_CTRL_REQUEST, usb_val, ftdi->index, |
| 2091 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 2092 | ftdi_error_return(-1, "set of rts/dtr failed"); |
| 2093 | |
| 2094 | return 0; |
| 2095 | } |
| 2096 | |
| 2097 | /** |
| 2098 | Set the special event character |
| 2099 | |
| 2100 | \param ftdi pointer to ftdi_context |
| 2101 | \param eventch Event character |
| 2102 | \param enable 0 to disable the event character, non-zero otherwise |
| 2103 | |
| 2104 | \retval 0: all fine |
| 2105 | \retval -1: unable to set event character |
| 2106 | \retval -2: USB device unavailable |
| 2107 | */ |
| 2108 | int ftdi_set_event_char(struct ftdi_context *ftdi, |
| 2109 | unsigned char eventch, unsigned char enable) |
| 2110 | { |
| 2111 | unsigned short usb_val; |
| 2112 | |
| 2113 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2114 | ftdi_error_return(-2, "USB device unavailable"); |
| 2115 | |
| 2116 | usb_val = eventch; |
| 2117 | if (enable) |
| 2118 | usb_val |= 1 << 8; |
| 2119 | |
| 2120 | 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) |
| 2121 | ftdi_error_return(-1, "setting event character failed"); |
| 2122 | |
| 2123 | return 0; |
| 2124 | } |
| 2125 | |
| 2126 | /** |
| 2127 | Set error character |
| 2128 | |
| 2129 | \param ftdi pointer to ftdi_context |
| 2130 | \param errorch Error character |
| 2131 | \param enable 0 to disable the error character, non-zero otherwise |
| 2132 | |
| 2133 | \retval 0: all fine |
| 2134 | \retval -1: unable to set error character |
| 2135 | \retval -2: USB device unavailable |
| 2136 | */ |
| 2137 | int ftdi_set_error_char(struct ftdi_context *ftdi, |
| 2138 | unsigned char errorch, unsigned char enable) |
| 2139 | { |
| 2140 | unsigned short usb_val; |
| 2141 | |
| 2142 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2143 | ftdi_error_return(-2, "USB device unavailable"); |
| 2144 | |
| 2145 | usb_val = errorch; |
| 2146 | if (enable) |
| 2147 | usb_val |= 1 << 8; |
| 2148 | |
| 2149 | 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) |
| 2150 | ftdi_error_return(-1, "setting error character failed"); |
| 2151 | |
| 2152 | return 0; |
| 2153 | } |
| 2154 | |
| 2155 | /** |
| 2156 | Set the eeprom size |
| 2157 | |
| 2158 | \param ftdi pointer to ftdi_context |
| 2159 | \param eeprom Pointer to ftdi_eeprom |
| 2160 | \param size |
| 2161 | |
| 2162 | */ |
| 2163 | void ftdi_eeprom_setsize(struct ftdi_context *ftdi, struct ftdi_eeprom *eeprom, int size) |
| 2164 | { |
| 2165 | if (ftdi == NULL) |
| 2166 | return; |
| 2167 | |
| 2168 | ftdi->eeprom = eeprom; |
| 2169 | ftdi->eeprom->size=size; |
| 2170 | } |
| 2171 | |
| 2172 | /** |
| 2173 | Init eeprom with default values. |
| 2174 | |
| 2175 | \param eeprom Pointer to ftdi_eeprom |
| 2176 | */ |
| 2177 | void ftdi_eeprom_initdefaults(struct ftdi_context *ftdi) |
| 2178 | { |
| 2179 | int i; |
| 2180 | struct ftdi_eeprom *eeprom; |
| 2181 | |
| 2182 | if (ftdi == NULL) |
| 2183 | return; |
| 2184 | |
| 2185 | if (ftdi->eeprom == NULL) |
| 2186 | return; |
| 2187 | |
| 2188 | eeprom = ftdi->eeprom; |
| 2189 | memset(eeprom, 0, sizeof(struct ftdi_eeprom)); |
| 2190 | |
| 2191 | eeprom->vendor_id = 0x0403; |
| 2192 | eeprom->use_serial = USE_SERIAL_NUM; |
| 2193 | if((ftdi->type= TYPE_AM) || (ftdi->type= TYPE_BM) ||(ftdi->type= TYPE_R)) |
| 2194 | eeprom->product_id = 0x6001; |
| 2195 | else |
| 2196 | eeprom->product_id = 0x6010; |
| 2197 | switch (ftdi->type) |
| 2198 | { |
| 2199 | case TYPE_2232H: |
| 2200 | eeprom->release = 0x200; |
| 2201 | break; |
| 2202 | default: |
| 2203 | eeprom->release = 0; |
| 2204 | } |
| 2205 | eeprom->usb_version = 0x0200; |
| 2206 | eeprom->max_power = 100; |
| 2207 | |
| 2208 | eeprom->manufacturer = NULL; |
| 2209 | eeprom->product = NULL; |
| 2210 | eeprom->serial = NULL; |
| 2211 | |
| 2212 | if(ftdi->type == TYPE_R) |
| 2213 | eeprom->size = 0x80; |
| 2214 | else |
| 2215 | eeprom->size = -1; |
| 2216 | } |
| 2217 | |
| 2218 | /** |
| 2219 | Frees allocated memory in eeprom. |
| 2220 | |
| 2221 | \param eeprom Pointer to ftdi_eeprom |
| 2222 | */ |
| 2223 | void ftdi_eeprom_free(struct ftdi_context *ftdi) |
| 2224 | { |
| 2225 | if (!ftdi) |
| 2226 | return; |
| 2227 | if (ftdi->eeprom) |
| 2228 | { |
| 2229 | struct ftdi_eeprom *eeprom = ftdi->eeprom; |
| 2230 | |
| 2231 | if (eeprom->manufacturer != 0) { |
| 2232 | free(eeprom->manufacturer); |
| 2233 | eeprom->manufacturer = 0; |
| 2234 | } |
| 2235 | if (eeprom->product != 0) { |
| 2236 | free(eeprom->product); |
| 2237 | eeprom->product = 0; |
| 2238 | } |
| 2239 | if (eeprom->serial != 0) { |
| 2240 | free(eeprom->serial); |
| 2241 | eeprom->serial = 0; |
| 2242 | } |
| 2243 | } |
| 2244 | } |
| 2245 | |
| 2246 | /** |
| 2247 | Build binary output from ftdi_eeprom structure. |
| 2248 | Output is suitable for ftdi_write_eeprom(). |
| 2249 | |
| 2250 | \note This function doesn't handle FT2232x devices. Only FT232x. |
| 2251 | \param eeprom Pointer to ftdi_eeprom |
| 2252 | \param output Buffer of 128 bytes to store eeprom image to |
| 2253 | |
| 2254 | \retval >0: free eeprom size |
| 2255 | \retval -1: eeprom size (128 bytes) exceeded by custom strings |
| 2256 | \retval -2: Invalid eeprom pointer |
| 2257 | \retval -3: Invalid cbus function setting |
| 2258 | \retval -4: Chip doesn't support invert |
| 2259 | \retval -5: Chip doesn't support high current drive |
| 2260 | */ |
| 2261 | int ftdi_eeprom_build(struct ftdi_context *ftdi, unsigned char *output) |
| 2262 | { |
| 2263 | unsigned char i, j; |
| 2264 | unsigned short checksum, value; |
| 2265 | unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0; |
| 2266 | int size_check; |
| 2267 | const int cbus_max[5] = {13, 13, 13, 13, 9}; |
| 2268 | struct ftdi_eeprom *eeprom; |
| 2269 | |
| 2270 | if (ftdi == NULL) |
| 2271 | ftdi_error_return(-2,"No context"); |
| 2272 | if (ftdi->eeprom == NULL) |
| 2273 | ftdi_error_return(-2,"No eeprom structure"); |
| 2274 | |
| 2275 | eeprom= ftdi->eeprom; |
| 2276 | |
| 2277 | if (eeprom->manufacturer != NULL) |
| 2278 | manufacturer_size = strlen(eeprom->manufacturer); |
| 2279 | if (eeprom->product != NULL) |
| 2280 | product_size = strlen(eeprom->product); |
| 2281 | if (eeprom->serial != NULL) |
| 2282 | serial_size = strlen(eeprom->serial); |
| 2283 | |
| 2284 | // highest allowed cbus value |
| 2285 | for (i = 0; i < 5; i++) |
| 2286 | { |
| 2287 | if ((eeprom->cbus_function[i] > cbus_max[i]) || |
| 2288 | (eeprom->cbus_function[i] && ftdi->type != TYPE_R)) return -3; |
| 2289 | } |
| 2290 | if (ftdi->type != TYPE_R) |
| 2291 | { |
| 2292 | if (eeprom->invert) return -4; |
| 2293 | if (eeprom->high_current_a) return -5; |
| 2294 | } |
| 2295 | |
| 2296 | size_check = 0x80; |
| 2297 | switch(ftdi->type) |
| 2298 | { |
| 2299 | case TYPE_2232H: |
| 2300 | case TYPE_4232H: |
| 2301 | size_check -= 4; |
| 2302 | case TYPE_R: |
| 2303 | size_check -= 4; |
| 2304 | case TYPE_2232C: |
| 2305 | size_check -= 4; |
| 2306 | case TYPE_AM: |
| 2307 | case TYPE_BM: |
| 2308 | size_check -= 0x14*2; |
| 2309 | } |
| 2310 | |
| 2311 | size_check -= manufacturer_size*2; |
| 2312 | size_check -= product_size*2; |
| 2313 | size_check -= serial_size*2; |
| 2314 | |
| 2315 | /* Space for the string type and pointer bytes */ |
| 2316 | size_check -= -6; |
| 2317 | |
| 2318 | // eeprom size exceeded? |
| 2319 | if (size_check < 0) |
| 2320 | return (-1); |
| 2321 | |
| 2322 | // empty eeprom |
| 2323 | memset (output, 0, eeprom->size); |
| 2324 | |
| 2325 | // Addr 00: High current IO |
| 2326 | output[0x00] = eeprom->high_current_a ? HIGH_CURRENT_DRIVE : 0; |
| 2327 | // Addr 01: IN endpoint size (for R type devices, different for FT2232) |
| 2328 | if (ftdi->type == TYPE_R) { |
| 2329 | output[0x01] = 0x40; |
| 2330 | } |
| 2331 | // Addr 02: Vendor ID |
| 2332 | output[0x02] = eeprom->vendor_id; |
| 2333 | output[0x03] = eeprom->vendor_id >> 8; |
| 2334 | |
| 2335 | // Addr 04: Product ID |
| 2336 | output[0x04] = eeprom->product_id; |
| 2337 | output[0x05] = eeprom->product_id >> 8; |
| 2338 | |
| 2339 | // Addr 06: Device release number (0400h for BM features) |
| 2340 | output[0x06] = 0x00; |
| 2341 | switch (eeprom->release) { |
| 2342 | case TYPE_AM: |
| 2343 | output[0x07] = 0x02; |
| 2344 | break; |
| 2345 | case TYPE_BM: |
| 2346 | output[0x07] = 0x04; |
| 2347 | break; |
| 2348 | case TYPE_2232C: |
| 2349 | output[0x07] = 0x05; |
| 2350 | break; |
| 2351 | case TYPE_R: |
| 2352 | output[0x07] = 0x06; |
| 2353 | break; |
| 2354 | default: |
| 2355 | output[0x07] = 0x00; |
| 2356 | } |
| 2357 | |
| 2358 | // Addr 08: Config descriptor |
| 2359 | // Bit 7: always 1 |
| 2360 | // Bit 6: 1 if this device is self powered, 0 if bus powered |
| 2361 | // Bit 5: 1 if this device uses remote wakeup |
| 2362 | // Bit 4: 1 if this device is battery powered |
| 2363 | j = 0x80; |
| 2364 | if (eeprom->self_powered == 1) |
| 2365 | j |= 0x40; |
| 2366 | if (eeprom->remote_wakeup == 1) |
| 2367 | j |= 0x20; |
| 2368 | output[0x08] = j; |
| 2369 | |
| 2370 | // Addr 09: Max power consumption: max power = value * 2 mA |
| 2371 | output[0x09] = eeprom->max_power; |
| 2372 | |
| 2373 | // Addr 0A: Chip configuration |
| 2374 | // Bit 7: 0 - reserved |
| 2375 | // Bit 6: 0 - reserved |
| 2376 | // Bit 5: 0 - reserved |
| 2377 | // Bit 4: 1 - Change USB version |
| 2378 | // Bit 3: 1 - Use the serial number string |
| 2379 | // Bit 2: 1 - Enable suspend pull downs for lower power |
| 2380 | // Bit 1: 1 - Out EndPoint is Isochronous |
| 2381 | // Bit 0: 1 - In EndPoint is Isochronous |
| 2382 | // |
| 2383 | j = 0; |
| 2384 | if (eeprom->in_is_isochronous == 1) |
| 2385 | j = j | 1; |
| 2386 | if (eeprom->out_is_isochronous == 1) |
| 2387 | j = j | 2; |
| 2388 | if (eeprom->suspend_pull_downs == 1) |
| 2389 | j = j | 4; |
| 2390 | if (eeprom->use_serial == 1) |
| 2391 | j = j | 8; |
| 2392 | if (eeprom->change_usb_version == 1) |
| 2393 | j = j | 16; |
| 2394 | output[0x0A] = j; |
| 2395 | |
| 2396 | // Addr 0B: Invert data lines |
| 2397 | output[0x0B] = eeprom->invert & 0xff; |
| 2398 | |
| 2399 | // Addr 0C: USB version low byte when 0x0A bit 4 is set |
| 2400 | // Addr 0D: USB version high byte when 0x0A bit 4 is set |
| 2401 | if (eeprom->change_usb_version == 1) |
| 2402 | { |
| 2403 | output[0x0C] = eeprom->usb_version; |
| 2404 | output[0x0D] = eeprom->usb_version >> 8; |
| 2405 | } |
| 2406 | |
| 2407 | |
| 2408 | // Addr 0E: Offset of the manufacturer string + 0x80, calculated later |
| 2409 | // Addr 0F: Length of manufacturer string |
| 2410 | output[0x0F] = manufacturer_size*2 + 2; |
| 2411 | |
| 2412 | // Addr 10: Offset of the product string + 0x80, calculated later |
| 2413 | // Addr 11: Length of product string |
| 2414 | output[0x11] = product_size*2 + 2; |
| 2415 | |
| 2416 | // Addr 12: Offset of the serial string + 0x80, calculated later |
| 2417 | // Addr 13: Length of serial string |
| 2418 | output[0x13] = serial_size*2 + 2; |
| 2419 | |
| 2420 | // Addr 14: CBUS function: CBUS0, CBUS1 |
| 2421 | // Addr 15: CBUS function: CBUS2, CBUS3 |
| 2422 | // Addr 16: CBUS function: CBUS5 |
| 2423 | output[0x14] = eeprom->cbus_function[0] | (eeprom->cbus_function[1] << 4); |
| 2424 | output[0x15] = eeprom->cbus_function[2] | (eeprom->cbus_function[3] << 4); |
| 2425 | output[0x16] = eeprom->cbus_function[4]; |
| 2426 | // Addr 17: Unknown |
| 2427 | |
| 2428 | // Dynamic content |
| 2429 | // In images produced by FTDI's FT_Prog for FT232R strings start at 0x18 |
| 2430 | // Space till 0x18 should be considered as reserved. |
| 2431 | if (ftdi->type >= TYPE_R) { |
| 2432 | i = 0x18; |
| 2433 | } else { |
| 2434 | i = 0x14; |
| 2435 | } |
| 2436 | if (eeprom->size >= 256) i = 0x80; |
| 2437 | |
| 2438 | |
| 2439 | // Output manufacturer |
| 2440 | output[0x0E] = i | 0x80; // calculate offset |
| 2441 | output[i++] = manufacturer_size*2 + 2; |
| 2442 | output[i++] = 0x03; // type: string |
| 2443 | for (j = 0; j < manufacturer_size; j++) |
| 2444 | { |
| 2445 | output[i] = eeprom->manufacturer[j], i++; |
| 2446 | output[i] = 0x00, i++; |
| 2447 | } |
| 2448 | |
| 2449 | // Output product name |
| 2450 | output[0x10] = i | 0x80; // calculate offset |
| 2451 | output[i] = product_size*2 + 2, i++; |
| 2452 | output[i] = 0x03, i++; |
| 2453 | for (j = 0; j < product_size; j++) |
| 2454 | { |
| 2455 | output[i] = eeprom->product[j], i++; |
| 2456 | output[i] = 0x00, i++; |
| 2457 | } |
| 2458 | |
| 2459 | // Output serial |
| 2460 | output[0x12] = i | 0x80; // calculate offset |
| 2461 | output[i] = serial_size*2 + 2, i++; |
| 2462 | output[i] = 0x03, i++; |
| 2463 | for (j = 0; j < serial_size; j++) |
| 2464 | { |
| 2465 | output[i] = eeprom->serial[j], i++; |
| 2466 | output[i] = 0x00, i++; |
| 2467 | } |
| 2468 | |
| 2469 | // calculate checksum |
| 2470 | checksum = 0xAAAA; |
| 2471 | |
| 2472 | for (i = 0; i < eeprom->size/2-1; i++) |
| 2473 | { |
| 2474 | value = output[i*2]; |
| 2475 | value += output[(i*2)+1] << 8; |
| 2476 | |
| 2477 | checksum = value^checksum; |
| 2478 | checksum = (checksum << 1) | (checksum >> 15); |
| 2479 | } |
| 2480 | |
| 2481 | output[eeprom->size-2] = checksum; |
| 2482 | output[eeprom->size-1] = checksum >> 8; |
| 2483 | |
| 2484 | return size_check; |
| 2485 | } |
| 2486 | |
| 2487 | /** |
| 2488 | Decode binary EEPROM image into an ftdi_eeprom structure. |
| 2489 | |
| 2490 | \param eeprom Pointer to ftdi_eeprom which will be filled in. |
| 2491 | \param buf Buffer of \a size bytes of raw eeprom data |
| 2492 | \param size size size of eeprom data in bytes |
| 2493 | |
| 2494 | \retval 0: all fine |
| 2495 | \retval -1: something went wrong |
| 2496 | |
| 2497 | FIXME: How to pass size? How to handle size field in ftdi_eeprom? |
| 2498 | FIXME: Strings are malloc'ed here and should be freed somewhere |
| 2499 | */ |
| 2500 | int ftdi_eeprom_decode(struct ftdi_context *ftdi, unsigned char *buf, int size, int verbose) |
| 2501 | { |
| 2502 | unsigned char i, j; |
| 2503 | unsigned short checksum, eeprom_checksum, value; |
| 2504 | unsigned char manufacturer_size = 0, product_size = 0, serial_size = 0; |
| 2505 | int eeprom_size; |
| 2506 | struct ftdi_eeprom *eeprom; |
| 2507 | |
| 2508 | if (ftdi == NULL) |
| 2509 | ftdi_error_return(-1,"No context"); |
| 2510 | if (ftdi->eeprom == NULL) |
| 2511 | ftdi_error_return(-1,"No eeprom"); |
| 2512 | |
| 2513 | eeprom_size = ftdi->eeprom->size; |
| 2514 | if(ftdi->type == TYPE_R) |
| 2515 | eeprom_size = 0x80; |
| 2516 | eeprom = ftdi->eeprom; |
| 2517 | |
| 2518 | // Addr 00: Channel A setting |
| 2519 | |
| 2520 | eeprom->channel_a_type = buf[0x00] & 0x7; |
| 2521 | eeprom->channel_a_driver = buf[0x00] & DRIVER_VCP; |
| 2522 | eeprom->high_current_a = buf[0x00] & HIGH_CURRENT_DRIVE; |
| 2523 | |
| 2524 | // Addr 01: Channel B setting |
| 2525 | |
| 2526 | eeprom->channel_b_type = buf[0x01] & 0x7; |
| 2527 | eeprom->channel_b_driver = buf[0x01] & DRIVER_VCP; |
| 2528 | eeprom->high_current_b = buf[0x01] & HIGH_CURRENT_DRIVE; |
| 2529 | |
| 2530 | eeprom->suspend_dbus7 = buf[0x01] & SUSPEND_DBUS7; |
| 2531 | |
| 2532 | // Addr 02: Vendor ID |
| 2533 | eeprom->vendor_id = buf[0x02] + (buf[0x03] << 8); |
| 2534 | |
| 2535 | // Addr 04: Product ID |
| 2536 | eeprom->product_id = buf[0x04] + (buf[0x05] << 8); |
| 2537 | |
| 2538 | eeprom->release = buf[0x06] + (buf[0x07]<<8); |
| 2539 | |
| 2540 | // Addr 08: Config descriptor |
| 2541 | // Bit 7: always 1 |
| 2542 | // Bit 6: 1 if this device is self powered, 0 if bus powered |
| 2543 | // Bit 5: 1 if this device uses remote wakeup |
| 2544 | // Bit 4: 1 if this device is battery powered |
| 2545 | eeprom->self_powered = buf[0x08] & 0x40; |
| 2546 | eeprom->remote_wakeup = buf[0x08] & 0x20;; |
| 2547 | |
| 2548 | // Addr 09: Max power consumption: max power = value * 2 mA |
| 2549 | eeprom->max_power = buf[0x09]; |
| 2550 | |
| 2551 | // Addr 0A: Chip configuration |
| 2552 | // Bit 7: 0 - reserved |
| 2553 | // Bit 6: 0 - reserved |
| 2554 | // Bit 5: 0 - reserved |
| 2555 | // Bit 4: 1 - Change USB version |
| 2556 | // Not seen on FT2232(D) |
| 2557 | // Bit 3: 1 - Use the serial number string |
| 2558 | // Bit 2: 1 - Enable suspend pull downs for lower power |
| 2559 | // Bit 1: 1 - Out EndPoint is Isochronous |
| 2560 | // Bit 0: 1 - In EndPoint is Isochronous |
| 2561 | // |
| 2562 | eeprom->in_is_isochronous = buf[0x0A]&0x01; |
| 2563 | eeprom->out_is_isochronous = buf[0x0A]&0x02; |
| 2564 | eeprom->suspend_pull_downs = buf[0x0A]&0x04; |
| 2565 | eeprom->use_serial = buf[0x0A] & USE_SERIAL_NUM; |
| 2566 | eeprom->change_usb_version = buf[0x0A]&0x10; |
| 2567 | |
| 2568 | |
| 2569 | // Addr 0C: USB version low byte when 0x0A bit 4 is set |
| 2570 | // Addr 0D: USB version high byte when 0x0A bit 4 is set |
| 2571 | if ((eeprom->change_usb_version == 1) || ftdi->type == TYPE_2232C) |
| 2572 | { |
| 2573 | eeprom->usb_version = buf[0x0C] + (buf[0x0D] << 8); |
| 2574 | } |
| 2575 | |
| 2576 | // Addr 0E: Offset of the manufacturer string + 0x80, calculated later |
| 2577 | // Addr 0F: Length of manufacturer string |
| 2578 | manufacturer_size = buf[0x0F]/2; |
| 2579 | if (manufacturer_size > 0) |
| 2580 | { |
| 2581 | eeprom->manufacturer = malloc(manufacturer_size); |
| 2582 | if (eeprom->manufacturer) |
| 2583 | { |
| 2584 | // Decode manufacturer |
| 2585 | i = buf[0x0E] & (eeprom_size -1); // offset |
| 2586 | for (j=0;j<manufacturer_size-1;j++) |
| 2587 | { |
| 2588 | eeprom->manufacturer[j] = buf[2*j+i+2]; |
| 2589 | } |
| 2590 | eeprom->manufacturer[j] = '\0'; |
| 2591 | } |
| 2592 | } |
| 2593 | else eeprom->manufacturer = NULL; |
| 2594 | |
| 2595 | // Addr 10: Offset of the product string + 0x80, calculated later |
| 2596 | // Addr 11: Length of product string |
| 2597 | product_size = buf[0x11]/2; |
| 2598 | if (product_size > 0) |
| 2599 | { |
| 2600 | eeprom->product = malloc(product_size); |
| 2601 | if(eeprom->product) |
| 2602 | { |
| 2603 | // Decode product name |
| 2604 | i = buf[0x10] & (eeprom_size -1); // offset |
| 2605 | for (j=0;j<product_size-1;j++) |
| 2606 | { |
| 2607 | eeprom->product[j] = buf[2*j+i+2]; |
| 2608 | } |
| 2609 | eeprom->product[j] = '\0'; |
| 2610 | } |
| 2611 | } |
| 2612 | else eeprom->product = NULL; |
| 2613 | |
| 2614 | // Addr 12: Offset of the serial string + 0x80, calculated later |
| 2615 | // Addr 13: Length of serial string |
| 2616 | serial_size = buf[0x13]/2; |
| 2617 | if (serial_size > 0) |
| 2618 | { |
| 2619 | eeprom->serial = malloc(serial_size); |
| 2620 | if(eeprom->serial) |
| 2621 | { |
| 2622 | // Decode serial |
| 2623 | i = buf[0x12] & (eeprom_size -1); // offset |
| 2624 | for (j=0;j<serial_size-1;j++) |
| 2625 | { |
| 2626 | eeprom->serial[j] = buf[2*j+i+2]; |
| 2627 | } |
| 2628 | eeprom->serial[j] = '\0'; |
| 2629 | } |
| 2630 | } |
| 2631 | else eeprom->serial = NULL; |
| 2632 | |
| 2633 | // verify checksum |
| 2634 | checksum = 0xAAAA; |
| 2635 | |
| 2636 | for (i = 0; i < eeprom_size/2-1; i++) |
| 2637 | { |
| 2638 | value = buf[i*2]; |
| 2639 | value += buf[(i*2)+1] << 8; |
| 2640 | |
| 2641 | checksum = value^checksum; |
| 2642 | checksum = (checksum << 1) | (checksum >> 15); |
| 2643 | } |
| 2644 | |
| 2645 | eeprom_checksum = buf[eeprom_size-2] + (buf[eeprom_size-1] << 8); |
| 2646 | |
| 2647 | if (eeprom_checksum != checksum) |
| 2648 | { |
| 2649 | fprintf(stderr, "Checksum Error: %04x %04x\n", checksum, eeprom_checksum); |
| 2650 | ftdi_error_return(-1,"EEPROM checksum error"); |
| 2651 | } |
| 2652 | |
| 2653 | else if ((ftdi->type == TYPE_AM) || (ftdi->type == TYPE_BM)) |
| 2654 | { |
| 2655 | eeprom->chip = buf[14]; |
| 2656 | } |
| 2657 | else if(ftdi->type == TYPE_2232C) |
| 2658 | { |
| 2659 | eeprom->chip = buf[14]; |
| 2660 | } |
| 2661 | else if(ftdi->type == TYPE_R) |
| 2662 | { |
| 2663 | // Addr 0B: Invert data lines |
| 2664 | // Works only on FT232R, not FT245R, but no way to distinguish |
| 2665 | eeprom->invert = buf[0x0B]; |
| 2666 | // Addr 14: CBUS function: CBUS0, CBUS1 |
| 2667 | // Addr 15: CBUS function: CBUS2, CBUS3 |
| 2668 | // Addr 16: CBUS function: CBUS5 |
| 2669 | eeprom->cbus_function[0] = buf[0x14] & 0x0f; |
| 2670 | eeprom->cbus_function[1] = (buf[0x14] >> 4) & 0x0f; |
| 2671 | eeprom->cbus_function[2] = buf[0x15] & 0x0f; |
| 2672 | eeprom->cbus_function[3] = (buf[0x15] >> 4) & 0x0f; |
| 2673 | eeprom->cbus_function[4] = buf[0x16] & 0x0f; |
| 2674 | } |
| 2675 | else if ((ftdi->type == TYPE_2232H) ||(ftdi->type == TYPE_4232H)) |
| 2676 | { |
| 2677 | eeprom->group0_drive = buf[0x0c] & DRIVE_16MA; |
| 2678 | eeprom->group0_schmitt = buf[0x0c] & IS_SCHMITT; |
| 2679 | eeprom->group0_slew = buf[0x0c] & SLOW_SLEW; |
| 2680 | eeprom->group1_drive = (buf[0x0c] >> 4) & 0x3; |
| 2681 | eeprom->group1_schmitt = (buf[0x0c] >> 4) & IS_SCHMITT; |
| 2682 | eeprom->group1_slew = (buf[0x0c] >> 4) & SLOW_SLEW; |
| 2683 | eeprom->group2_drive = buf[0x0d] & DRIVE_16MA; |
| 2684 | eeprom->group2_schmitt = buf[0x0d] & IS_SCHMITT; |
| 2685 | eeprom->group2_slew = buf[0x0d] & SLOW_SLEW; |
| 2686 | eeprom->group3_drive = (buf[0x0d] >> 4) & DRIVE_16MA; |
| 2687 | eeprom->group3_schmitt = (buf[0x0d] >> 4) & IS_SCHMITT; |
| 2688 | eeprom->group3_slew = (buf[0x0d] >> 4) & SLOW_SLEW; |
| 2689 | } |
| 2690 | |
| 2691 | if(verbose) |
| 2692 | { |
| 2693 | char *channel_mode[] = {"UART","245","CPU", "unknown", "OPTO"}; |
| 2694 | fprintf(stdout, "VID: 0x%04x\n",eeprom->vendor_id); |
| 2695 | fprintf(stdout, "PID: 0x%04x\n",eeprom->product_id); |
| 2696 | fprintf(stdout, "Release: 0x%04x\n",eeprom->release); |
| 2697 | |
| 2698 | if(eeprom->self_powered) |
| 2699 | fprintf(stdout, "Self-Powered%s", (eeprom->remote_wakeup)?", USB Remote Wake Up\n":"\n"); |
| 2700 | else |
| 2701 | fprintf(stdout, "Bus Powered: %3d mA%s", eeprom->max_power*2, |
| 2702 | (eeprom->remote_wakeup)?" USB Remote Wake Up\n":"\n"); |
| 2703 | if(eeprom->manufacturer) |
| 2704 | fprintf(stdout, "Manufacturer: %s\n",eeprom->manufacturer); |
| 2705 | if(eeprom->product) |
| 2706 | fprintf(stdout, "Product: %s\n",eeprom->product); |
| 2707 | if(eeprom->serial) |
| 2708 | fprintf(stdout, "Serial: %s\n",eeprom->serial); |
| 2709 | fprintf(stdout, "Checksum : %04x\n", checksum); |
| 2710 | if(eeprom->suspend_dbus7) |
| 2711 | fprintf(stdout, "Suspend on DBUS7\n"); |
| 2712 | if(eeprom->suspend_pull_downs) |
| 2713 | fprintf(stdout, "Pull IO pins low during suspend\n"); |
| 2714 | if(eeprom->remote_wakeup) |
| 2715 | fprintf(stdout, "Enable Remote Wake Up\n"); |
| 2716 | if (ftdi->type >= TYPE_2232C) |
| 2717 | fprintf(stdout,"Channel A has Mode %s%s%s\n", |
| 2718 | channel_mode[eeprom->channel_a_type], |
| 2719 | (eeprom->channel_a_driver)?" VCP":"", |
| 2720 | (eeprom->high_current_a)?" High Currenr IO":""); |
| 2721 | if (ftdi->type == TYPE_2232C) |
| 2722 | fprintf(stdout,"Channel B has Mode %s%s%s\n", |
| 2723 | channel_mode[eeprom->channel_b_type], |
| 2724 | (eeprom->channel_b_driver)?" VCP":"", |
| 2725 | (eeprom->high_current_b)?" High Currenr IO":""); |
| 2726 | if ((ftdi->type == TYPE_2232H) || (ftdi->type == TYPE_4232H)) |
| 2727 | { |
| 2728 | fprintf(stdout,"%s has %d mA drive%s%s\n", |
| 2729 | (ftdi->type == TYPE_2232H)?"AL":"A", |
| 2730 | (eeprom->group0_drive+1) *4, |
| 2731 | (eeprom->group0_schmitt)?" Schmitt Input":"", |
| 2732 | (eeprom->group0_slew)?" Slow Slew":""); |
| 2733 | fprintf(stdout,"%s has %d mA drive%s%s\n", |
| 2734 | (ftdi->type == TYPE_2232H)?"AH":"B", |
| 2735 | (eeprom->group1_drive+1) *4, |
| 2736 | (eeprom->group1_schmitt)?" Schmitt Input":"", |
| 2737 | (eeprom->group1_slew)?" Slow Slew":""); |
| 2738 | fprintf(stdout,"%s has %d mA drive%s%s\n", |
| 2739 | (ftdi->type == TYPE_2232H)?"BL":"C", |
| 2740 | (eeprom->group2_drive+1) *4, |
| 2741 | (eeprom->group2_schmitt)?" Schmitt Input":"", |
| 2742 | (eeprom->group2_slew)?" Slow Slew":""); |
| 2743 | fprintf(stdout,"%s has %d mA drive%s%s\n", |
| 2744 | (ftdi->type == TYPE_2232H)?"BH":"D", |
| 2745 | (eeprom->group3_drive+1) *4, |
| 2746 | (eeprom->group3_schmitt)?" Schmitt Input":"", |
| 2747 | (eeprom->group3_slew)?" Slow Slew":""); |
| 2748 | } |
| 2749 | |
| 2750 | } |
| 2751 | |
| 2752 | return 0; |
| 2753 | } |
| 2754 | |
| 2755 | /** |
| 2756 | Read eeprom location |
| 2757 | |
| 2758 | \param ftdi pointer to ftdi_context |
| 2759 | \param eeprom_addr Address of eeprom location to be read |
| 2760 | \param eeprom_val Pointer to store read eeprom location |
| 2761 | |
| 2762 | \retval 0: all fine |
| 2763 | \retval -1: read failed |
| 2764 | \retval -2: USB device unavailable |
| 2765 | */ |
| 2766 | int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val) |
| 2767 | { |
| 2768 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2769 | ftdi_error_return(-2, "USB device unavailable"); |
| 2770 | |
| 2771 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, eeprom_addr, (unsigned char *)eeprom_val, 2, ftdi->usb_read_timeout) != 2) |
| 2772 | ftdi_error_return(-1, "reading eeprom failed"); |
| 2773 | |
| 2774 | return 0; |
| 2775 | } |
| 2776 | |
| 2777 | /** |
| 2778 | Read eeprom |
| 2779 | |
| 2780 | \param ftdi pointer to ftdi_context |
| 2781 | \param eeprom Pointer to store eeprom into |
| 2782 | |
| 2783 | \retval 0: all fine |
| 2784 | \retval -1: read failed |
| 2785 | \retval -2: USB device unavailable |
| 2786 | */ |
| 2787 | int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom) |
| 2788 | { |
| 2789 | int i; |
| 2790 | |
| 2791 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2792 | ftdi_error_return(-2, "USB device unavailable"); |
| 2793 | |
| 2794 | for (i = 0; i < FTDI_MAX_EEPROM_SIZE/2; i++) |
| 2795 | { |
| 2796 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_IN_REQTYPE, SIO_READ_EEPROM_REQUEST, 0, i, eeprom+(i*2), 2, ftdi->usb_read_timeout) != 2) |
| 2797 | ftdi_error_return(-1, "reading eeprom failed"); |
| 2798 | } |
| 2799 | |
| 2800 | if (ftdi->type == TYPE_R) |
| 2801 | ftdi->eeprom->size = 0xa0; |
| 2802 | /* Guesses size of eeprom by comparing halves |
| 2803 | - will not work with blank eeprom */ |
| 2804 | else if (strrchr((const char *)eeprom, 0xff) == ((const char *)eeprom +FTDI_MAX_EEPROM_SIZE -1)) |
| 2805 | ftdi->eeprom->size = -1; |
| 2806 | else if(memcmp(eeprom,&eeprom[0x80],0x80) == 0) |
| 2807 | ftdi->eeprom->size = 0x80; |
| 2808 | else if(memcmp(eeprom,&eeprom[0x40],0x40) == 0) |
| 2809 | ftdi->eeprom->size = 0x40; |
| 2810 | else |
| 2811 | ftdi->eeprom->size = 0x100; |
| 2812 | return 0; |
| 2813 | } |
| 2814 | |
| 2815 | /* |
| 2816 | ftdi_read_chipid_shift does the bitshift operation needed for the FTDIChip-ID |
| 2817 | Function is only used internally |
| 2818 | \internal |
| 2819 | */ |
| 2820 | static unsigned char ftdi_read_chipid_shift(unsigned char value) |
| 2821 | { |
| 2822 | return ((value & 1) << 1) | |
| 2823 | ((value & 2) << 5) | |
| 2824 | ((value & 4) >> 2) | |
| 2825 | ((value & 8) << 4) | |
| 2826 | ((value & 16) >> 1) | |
| 2827 | ((value & 32) >> 1) | |
| 2828 | ((value & 64) >> 4) | |
| 2829 | ((value & 128) >> 2); |
| 2830 | } |
| 2831 | |
| 2832 | /** |
| 2833 | Read the FTDIChip-ID from R-type devices |
| 2834 | |
| 2835 | \param ftdi pointer to ftdi_context |
| 2836 | \param chipid Pointer to store FTDIChip-ID |
| 2837 | |
| 2838 | \retval 0: all fine |
| 2839 | \retval -1: read failed |
| 2840 | \retval -2: USB device unavailable |
| 2841 | */ |
| 2842 | int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid) |
| 2843 | { |
| 2844 | unsigned int a = 0, b = 0; |
| 2845 | |
| 2846 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2847 | ftdi_error_return(-2, "USB device unavailable"); |
| 2848 | |
| 2849 | 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) |
| 2850 | { |
| 2851 | a = a << 8 | a >> 8; |
| 2852 | 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) |
| 2853 | { |
| 2854 | b = b << 8 | b >> 8; |
| 2855 | a = (a << 16) | (b & 0xFFFF); |
| 2856 | a = ftdi_read_chipid_shift(a) | ftdi_read_chipid_shift(a>>8)<<8 |
| 2857 | | ftdi_read_chipid_shift(a>>16)<<16 | ftdi_read_chipid_shift(a>>24)<<24; |
| 2858 | *chipid = a ^ 0xa5f0f7d1; |
| 2859 | return 0; |
| 2860 | } |
| 2861 | } |
| 2862 | |
| 2863 | ftdi_error_return(-1, "read of FTDIChip-ID failed"); |
| 2864 | } |
| 2865 | |
| 2866 | /** |
| 2867 | Write eeprom location |
| 2868 | |
| 2869 | \param ftdi pointer to ftdi_context |
| 2870 | \param eeprom_addr Address of eeprom location to be written |
| 2871 | \param eeprom_val Value to be written |
| 2872 | |
| 2873 | \retval 0: all fine |
| 2874 | \retval -1: read failed |
| 2875 | \retval -2: USB device unavailable |
| 2876 | */ |
| 2877 | int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val) |
| 2878 | { |
| 2879 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2880 | ftdi_error_return(-2, "USB device unavailable"); |
| 2881 | |
| 2882 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 2883 | SIO_WRITE_EEPROM_REQUEST, eeprom_val, eeprom_addr, |
| 2884 | NULL, 0, ftdi->usb_write_timeout) != 0) |
| 2885 | ftdi_error_return(-1, "unable to write eeprom"); |
| 2886 | |
| 2887 | return 0; |
| 2888 | } |
| 2889 | |
| 2890 | /** |
| 2891 | Write eeprom |
| 2892 | |
| 2893 | \param ftdi pointer to ftdi_context |
| 2894 | \param eeprom Pointer to read eeprom from |
| 2895 | |
| 2896 | \retval 0: all fine |
| 2897 | \retval -1: read failed |
| 2898 | \retval -2: USB device unavailable |
| 2899 | */ |
| 2900 | int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom) |
| 2901 | { |
| 2902 | unsigned short usb_val, status; |
| 2903 | int i, ret; |
| 2904 | |
| 2905 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2906 | ftdi_error_return(-2, "USB device unavailable"); |
| 2907 | |
| 2908 | /* These commands were traced while running MProg */ |
| 2909 | if ((ret = ftdi_usb_reset(ftdi)) != 0) |
| 2910 | return ret; |
| 2911 | if ((ret = ftdi_poll_modem_status(ftdi, &status)) != 0) |
| 2912 | return ret; |
| 2913 | if ((ret = ftdi_set_latency_timer(ftdi, 0x77)) != 0) |
| 2914 | return ret; |
| 2915 | |
| 2916 | for (i = 0; i < ftdi->eeprom->size/2; i++) |
| 2917 | { |
| 2918 | usb_val = eeprom[i*2]; |
| 2919 | usb_val += eeprom[(i*2)+1] << 8; |
| 2920 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, |
| 2921 | SIO_WRITE_EEPROM_REQUEST, usb_val, i, |
| 2922 | NULL, 0, ftdi->usb_write_timeout) < 0) |
| 2923 | ftdi_error_return(-1, "unable to write eeprom"); |
| 2924 | } |
| 2925 | |
| 2926 | return 0; |
| 2927 | } |
| 2928 | |
| 2929 | /** |
| 2930 | Erase eeprom |
| 2931 | |
| 2932 | This is not supported on FT232R/FT245R according to the MProg manual from FTDI. |
| 2933 | |
| 2934 | \param ftdi pointer to ftdi_context |
| 2935 | |
| 2936 | \retval 0: all fine |
| 2937 | \retval -1: erase failed |
| 2938 | \retval -2: USB device unavailable |
| 2939 | */ |
| 2940 | int ftdi_erase_eeprom(struct ftdi_context *ftdi) |
| 2941 | { |
| 2942 | if (ftdi == NULL || ftdi->usb_dev == NULL) |
| 2943 | ftdi_error_return(-2, "USB device unavailable"); |
| 2944 | |
| 2945 | if (libusb_control_transfer(ftdi->usb_dev, FTDI_DEVICE_OUT_REQTYPE, SIO_ERASE_EEPROM_REQUEST, 0, 0, NULL, 0, ftdi->usb_write_timeout) < 0) |
| 2946 | ftdi_error_return(-1, "unable to erase eeprom"); |
| 2947 | |
| 2948 | return 0; |
| 2949 | } |
| 2950 | |
| 2951 | /** |
| 2952 | Get string representation for last error code |
| 2953 | |
| 2954 | \param ftdi pointer to ftdi_context |
| 2955 | |
| 2956 | \retval Pointer to error string |
| 2957 | */ |
| 2958 | char *ftdi_get_error_string (struct ftdi_context *ftdi) |
| 2959 | { |
| 2960 | if (ftdi == NULL) |
| 2961 | return ""; |
| 2962 | |
| 2963 | return ftdi->error_str; |
| 2964 | } |
| 2965 | |
| 2966 | /* @} end of doxygen libftdi group */ |