X-Git-Url: http://developer.intra2net.com/git/?p=libftdi;a=blobdiff_plain;f=src%2Fftdi.h;h=7addeb94a77edec6d56f11fd70b7dab982bb5346;hp=15067c73c48f1b54b15ddfb327db9b8380dd16ff;hb=ae3d154b7641b120f537c6d86871371c9d75c9e9;hpb=74387f27647e7123e233d31d36daedc6b485650a diff --git a/src/ftdi.h b/src/ftdi.h index 15067c7..7addeb9 100644 --- a/src/ftdi.h +++ b/src/ftdi.h @@ -2,8 +2,9 @@ ftdi.h - description ------------------- begin : Fri Apr 4 2003 - copyright : (C) 2003-2013 by Intra2net AG and the libftdi developers + copyright : (C) 2003-2017 by Intra2net AG and the libftdi developers email : opensource@intra2net.com + SPDX-License-Identifier: LGPL-2.1-only ***************************************************************************/ /*************************************************************************** @@ -18,7 +19,28 @@ #define __libftdi_h__ #include +#ifndef _WIN32 #include +#endif + +/* Define _FTDI_DISABLE_DEPRECATED to disable deprecated messages. */ +#ifdef _FTDI_DISABLE_DEPRECATED +#define _Ftdi_Pragma(_msg) +#else +#define _Ftdi_Pragma(_msg) _Pragma(_msg) +#endif + +/* 'interface' might be defined as a macro on Windows, so we need to + * undefine it so as not to break the current libftdi API, because + * struct ftdi_context has an 'interface' member + * As this can be problematic if you include windows.h after ftdi.h + * in your sources, we force windows.h to be included first. */ +#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE) +#include +#if defined(interface) +#undef interface +#endif +#endif /** FTDI chip type */ enum ftdi_chip_type @@ -70,7 +92,8 @@ enum ftdi_interface enum ftdi_module_detach_mode { AUTO_DETACH_SIO_MODULE = 0, - DONT_DETACH_SIO_MODULE = 1 + DONT_DETACH_SIO_MODULE = 1, + AUTO_DETACH_REATACH_SIO_MODULE = 2 }; /* Shifting commands IN MPSSE Mode*/ @@ -106,7 +129,7 @@ enum ftdi_module_detach_mode #define EN_ADAPTIVE 0x96 #define DIS_ADAPTIVE 0x97 #define CLK_BYTES_OR_HIGH 0x9c -#define CLK_BYTES_OR_LOW 0x0d +#define CLK_BYTES_OR_LOW 0x9d /*FT232H specific commands */ #define DRIVE_OPEN_COLLECTOR 0x9e /* Value Low */ @@ -159,8 +182,45 @@ enum ftdi_module_detach_mode #define SIO_RESET_SIO 0 + +/* ** WARNING ** SIO_RESET_PURGE_RX or SIO_RESET_PURGE_TX are values used + * internally by libftdi to purge the RX and/or TX FIFOs (buffers). + * APPLICATION PROGRAMS SHOULD NOT BE USING THESE VALUES. Application + * programs should use one of the ftdi_tciflush, ftdi_tcoflush, or + * ftdi_tcioflush functions which emulate the Linux serial port tcflush(3) + * function. + * + * History: + * + * The definitions for these values are with respect to the FTDI chip, not the + * CPU. That is, when the FTDI chip receives a USB control transfer request + * with the command SIO_RESET_PURGE_RX, the FTDI chip empties the FIFO + * containing data received from the CPU awaiting transfer out the serial + * port to the connected serial device (e.g., a modem). Likewise, upon + * reception of the SIO_RESET_PURGE_TX command, the FTDI chip empties the + * FIFO of data received from the attached serial device destined to be + * transmitted to the CPU. + * + * Unfortunately the coding of the previous releases of libfti assumed these + * commands had the opposite effect. This resulted in the function + * ftdi_usb_purge_tx_buffer clearing data received from the attached serial + * device. Similarly, the function ftdi_usb_purge_rx_buffer cleared the + * FTDI FIFO containing data to be transmitted to the attached serial + * device. More seriously, this latter function clear the libftid's + * internal buffer of data received from the serial device, destined + * to the application program. + */ +#ifdef __GNUC__ +#define SIO_RESET_PURGE_RX _Ftdi_Pragma("GCC warning \"SIO_RESET_PURGE_RX\" deprecated: - use tciflush() method") 1 +#define SIO_RESET_PURGE_TX _Ftdi_Pragma("GCC warning \"SIO_RESET_PURGE_RX\" deprecated: - use tcoflush() method") 2 +#else +#pragma message("WARNING: You need to implement deprecated #define for this compiler") #define SIO_RESET_PURGE_RX 1 #define SIO_RESET_PURGE_TX 2 +#endif +/* New names for the values used internally to flush (purge). */ +#define SIO_TCIFLUSH 2 +#define SIO_TCOFLUSH 1 #define SIO_DISABLE_FLOW_CTRL 0x0 #define SIO_RTS_CTS_HS (0x1 << 8) @@ -180,14 +240,18 @@ enum ftdi_module_detach_mode (taken from libusb) */ #define FTDI_URB_USERCONTEXT_COOKIE ((void *)0x1) +#ifdef _FTDI_DISABLE_DEPRECATED +#define DEPRECATED(func) func +#else #ifdef __GNUC__ -#define DEPRECATED(func) func __attribute__ ((deprecated)) +#define DEPRECATED(func) __attribute__ ((deprecated)) func #elif defined(_MSC_VER) #define DEPRECATED(func) __declspec(deprecated) func #else #pragma message("WARNING: You need to implement DEPRECATED for this compiler") #define DEPRECATED(func) func #endif +#endif struct ftdi_transfer_control { @@ -253,7 +317,7 @@ struct ftdi_context struct ftdi_eeprom *eeprom; /** String representation of last error */ - char *error_str; + const char *error_str; /** Defines behavior in case a kernel module is already attached to the device */ enum ftdi_module_detach_mode module_detach_mode; @@ -320,6 +384,8 @@ enum ftdi_eeprom_value CHANNEL_C_RS485 = 53, CHANNEL_D_RS485 = 54, RELEASE_NUMBER = 55, + EXTERNAL_OSCILLATOR= 56, + USER_DATA_ADDR = 57, }; /** @@ -338,20 +404,27 @@ struct ftdi_device_list #define POWER_SAVE_DISABLE_H 0x80 #define USE_SERIAL_NUM 0x08 -enum ftdi_cbus_func /* FIXME: Recheck value, especially the last */ +enum ftdi_cbus_func { CBUS_TXDEN = 0, CBUS_PWREN = 1, CBUS_RXLED = 2, CBUS_TXLED = 3, CBUS_TXRXLED = 4, CBUS_SLEEP = 5, CBUS_CLK48 = 6, CBUS_CLK24 = 7, CBUS_CLK12 = 8, CBUS_CLK6 = 9, - CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc, CBUS_BB = 0xd + CBUS_IOMODE = 0xa, CBUS_BB_WR = 0xb, CBUS_BB_RD = 0xc }; -enum ftdi_cbush_func /* FIXME: Recheck value, especially the last */ +enum ftdi_cbush_func { - CBUSH_TRISTATE = 0, CBUSH_RXLED = 1, CBUSH_TXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4, - CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSG_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9, - CBUSH_CLK30 = 10, CBUSH_CLK15 = 11, CBUSH_CLK7_5 = 12, CBUSH_BAT_DETECT = 13, - CBUSH_BAT_DETECT_NEG = 14, CBUSH_I2C_TXE = 15, CBUSH_I2C_RXF = 16, CBUSH_VBUS_SENSE = 17, - CBUSH_BB_WR = 18, CBUSH_BB_RD = 19, CBUSH_TIME_STAMP = 20, CBUSH_AWAKE = 21, + CBUSH_TRISTATE = 0, CBUSH_TXLED = 1, CBUSH_RXLED = 2, CBUSH_TXRXLED = 3, CBUSH_PWREN = 4, + CBUSH_SLEEP = 5, CBUSH_DRIVE_0 = 6, CBUSH_DRIVE1 = 7, CBUSH_IOMODE = 8, CBUSH_TXDEN = 9, + CBUSH_CLK30 = 10, CBUSH_CLK15 = 11, CBUSH_CLK7_5 = 12 +}; + +enum ftdi_cbusx_func +{ + CBUSX_TRISTATE = 0, CBUSX_TXLED = 1, CBUSX_RXLED = 2, CBUSX_TXRXLED = 3, CBUSX_PWREN = 4, + CBUSX_SLEEP = 5, CBUSX_DRIVE_0 = 6, CBUSX_DRIVE1 = 7, CBUSX_IOMODE = 8, CBUSX_TXDEN = 9, + CBUSX_CLK24 = 10, CBUSX_CLK12 = 11, CBUSX_CLK6 = 12, CBUSX_BAT_DETECT = 13, + CBUSX_BAT_DETECT_NEG = 14, CBUSX_I2C_TXE = 15, CBUSX_I2C_RXF = 16, CBUSX_VBUS_SENSE = 17, + CBUSX_BB_WR = 18, CBUSX_BB_RD = 19, CBUSX_TIME_STAMP = 20, CBUSX_AWAKE = 21 }; /** Invert TXD# */ @@ -452,32 +525,45 @@ extern "C" void ftdi_free(struct ftdi_context *ftdi); void ftdi_set_usbdev (struct ftdi_context *ftdi, struct libusb_device_handle *usbdev); - struct ftdi_version_info ftdi_get_library_version(); + struct ftdi_version_info ftdi_get_library_version(void); int ftdi_usb_find_all(struct ftdi_context *ftdi, struct ftdi_device_list **devlist, int vendor, int product); void ftdi_list_free(struct ftdi_device_list **devlist); void ftdi_list_free2(struct ftdi_device_list *devlist); int ftdi_usb_get_strings(struct ftdi_context *ftdi, struct libusb_device *dev, - char * manufacturer, int mnf_len, - char * description, int desc_len, - char * serial, int serial_len); - int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, char * manufacturer, - char * product, char * serial); + char *manufacturer, int mnf_len, + char *description, int desc_len, + char *serial, int serial_len); + int ftdi_usb_get_strings2(struct ftdi_context *ftdi, struct libusb_device *dev, + char *manufacturer, int mnf_len, + char *description, int desc_len, + char *serial, int serial_len); + + int ftdi_eeprom_get_strings(struct ftdi_context *ftdi, + char *manufacturer, int mnf_len, + char *product, int prod_len, + char *serial, int serial_len); + int ftdi_eeprom_set_strings(struct ftdi_context *ftdi, const char * manufacturer, + const char * product, const char * serial); int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product); int ftdi_usb_open_desc(struct ftdi_context *ftdi, int vendor, int product, const char* description, const char* serial); int ftdi_usb_open_desc_index(struct ftdi_context *ftdi, int vendor, int product, const char* description, const char* serial, unsigned int index); + int ftdi_usb_open_bus_addr(struct ftdi_context *ftdi, uint8_t bus, uint8_t addr); int ftdi_usb_open_dev(struct ftdi_context *ftdi, struct libusb_device *dev); int ftdi_usb_open_string(struct ftdi_context *ftdi, const char* description); int ftdi_usb_close(struct ftdi_context *ftdi); int ftdi_usb_reset(struct ftdi_context *ftdi); - int ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi); - int ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi); - int ftdi_usb_purge_buffers(struct ftdi_context *ftdi); + int ftdi_tciflush(struct ftdi_context *ftdi); + int ftdi_tcoflush(struct ftdi_context *ftdi); + int ftdi_tcioflush(struct ftdi_context *ftdi); + int DEPRECATED(ftdi_usb_purge_rx_buffer(struct ftdi_context *ftdi)); + int DEPRECATED(ftdi_usb_purge_tx_buffer(struct ftdi_context *ftdi)); + int DEPRECATED(ftdi_usb_purge_buffers(struct ftdi_context *ftdi)); int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate); int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits, @@ -490,7 +576,7 @@ extern "C" int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); - int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size); + int ftdi_write_data(struct ftdi_context *ftdi, const unsigned char *buf, int size); int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize); int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize); @@ -500,6 +586,7 @@ extern "C" struct ftdi_transfer_control *ftdi_read_data_submit(struct ftdi_context *ftdi, unsigned char *buf, int size); int ftdi_transfer_data_done(struct ftdi_transfer_control *tc); + void ftdi_transfer_data_cancel(struct ftdi_transfer_control *tc, struct timeval * to); int ftdi_set_bitmode(struct ftdi_context *ftdi, unsigned char bitmask, unsigned char mode); int ftdi_disable_bitbang(struct ftdi_context *ftdi); @@ -512,6 +599,7 @@ extern "C" /* flow control */ int ftdi_setflowctrl(struct ftdi_context *ftdi, int flowctrl); + int ftdi_setflowctrl_xonxoff(struct ftdi_context *ftdi, unsigned char xon, unsigned char xoff); int ftdi_setdtr_rts(struct ftdi_context *ftdi, int dtr, int rts); int ftdi_setdtr(struct ftdi_context *ftdi, int state); int ftdi_setrts(struct ftdi_context *ftdi, int state); @@ -532,6 +620,8 @@ extern "C" int ftdi_get_eeprom_buf(struct ftdi_context *ftdi, unsigned char * buf, int size); int ftdi_set_eeprom_buf(struct ftdi_context *ftdi, const unsigned char * buf, int size); + int ftdi_set_eeprom_user_data(struct ftdi_context *ftdi, const char * buf, int size); + int ftdi_read_eeprom(struct ftdi_context *ftdi); int ftdi_read_chipid(struct ftdi_context *ftdi, unsigned int *chipid); int ftdi_write_eeprom(struct ftdi_context *ftdi); @@ -540,7 +630,7 @@ extern "C" int ftdi_read_eeprom_location (struct ftdi_context *ftdi, int eeprom_addr, unsigned short *eeprom_val); int ftdi_write_eeprom_location(struct ftdi_context *ftdi, int eeprom_addr, unsigned short eeprom_val); - char *ftdi_get_error_string(struct ftdi_context *ftdi); + const char *ftdi_get_error_string(struct ftdi_context *ftdi); #ifdef __cplusplus }