Updated ChangeLog and AUTHORS
[libftdi] / src / ftdi.h
index ab785d9..f629821 100644 (file)
@@ -22,7 +22,7 @@
 #define FTDI_DEFAULT_EEPROM_SIZE 128
 
 /** FTDI chip type */
-enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3 };
+enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2, TYPE_R=3, TYPE_2232H=4, TYPE_4232H=5 };
 /** Parity mode for ftdi_set_line_property() */
 enum ftdi_parity_type { NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4 };
 /** Number of stop bits for ftdi_set_line_property() */
@@ -33,7 +33,8 @@ enum ftdi_bits_type { BITS_7=7, BITS_8=8 };
 enum ftdi_break_type { BREAK_OFF=0, BREAK_ON=1 };
 
 /** MPSSE bitbang modes */
-enum ftdi_mpsse_mode {
+enum ftdi_mpsse_mode
+{
     BITMODE_RESET  = 0x00,
     BITMODE_BITBANG= 0x01,
     BITMODE_MPSSE  = 0x02,
@@ -45,10 +46,13 @@ enum ftdi_mpsse_mode {
 };
 
 /** Port interface for FT2232C */
-enum ftdi_interface {
+enum ftdi_interface
+{
     INTERFACE_ANY = 0,
     INTERFACE_A   = 1,
-    INTERFACE_B   = 2
+    INTERFACE_B   = 2,
+    INTERFACE_C   = 3,
+    INTERFACE_D   = 4
 };
 
 /* Shifting commands IN MPSSE Mode*/
@@ -77,7 +81,7 @@ enum ftdi_interface {
 #define DIV_VALUE(rate) (rate > 6000000)?0:((6000000/rate -1) > 0xffff)? 0xffff: (6000000/rate -1)
 
 /* Commands in MPSSE and Host Emulation Mode */
-#define SEND_IMMEDIATE 0x87 
+#define SEND_IMMEDIATE 0x87
 #define WAIT_ON_HIGH   0x88
 #define WAIT_ON_LOW    0x89
 
@@ -100,29 +104,36 @@ enum ftdi_interface {
 #define SIO_SET_BAUD_RATE  3 /* Set baud rate */
 #define SIO_SET_DATA       4 /* Set the data characteristics of the port */
 
-#define SIO_RESET_REQUEST_TYPE 0x40
-#define SIO_RESET_REQUEST SIO_RESET
+#define FTDI_DEVICE_OUT_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_OUT)
+#define FTDI_DEVICE_IN_REQTYPE (USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_ENDPOINT_IN)
+
+/* Requests */
+#define SIO_RESET_REQUEST             SIO_RESET
+#define SIO_SET_BAUDRATE_REQUEST      SIO_SET_BAUD_RATE
+#define SIO_SET_DATA_REQUEST          SIO_SET_DATA
+#define SIO_SET_FLOW_CTRL_REQUEST     SIO_SET_FLOW_CTRL
+#define SIO_SET_MODEM_CTRL_REQUEST    SIO_MODEM_CTRL
+#define SIO_POLL_MODEM_STATUS_REQUEST 0x05
+#define SIO_SET_EVENT_CHAR_REQUEST    0x06
+#define SIO_SET_ERROR_CHAR_REQUEST    0x07
+#define SIO_SET_LATENCY_TIMER_REQUEST 0x09
+#define SIO_GET_LATENCY_TIMER_REQUEST 0x0A
+#define SIO_SET_BITMODE_REQUEST       0x0B
+#define SIO_READ_PINS_REQUEST         0x0C
+#define SIO_READ_EEPROM_REQUEST       0x90
+#define SIO_WRITE_EEPROM_REQUEST      0x91
+#define SIO_ERASE_EEPROM_REQUEST      0x92
+
+
 #define SIO_RESET_SIO 0
 #define SIO_RESET_PURGE_RX 1
 #define SIO_RESET_PURGE_TX 2
 
-#define SIO_SET_BAUDRATE_REQUEST_TYPE 0x40
-#define SIO_SET_BAUDRATE_REQUEST SIO_SET_BAUD_RATE
-
-#define SIO_SET_DATA_REQUEST_TYPE 0x40
-#define SIO_SET_DATA_REQUEST SIO_SET_DATA
-
-#define SIO_SET_FLOW_CTRL_REQUEST SIO_SET_FLOW_CTRL
-#define SIO_SET_FLOW_CTRL_REQUEST_TYPE 0x40
-
-#define SIO_DISABLE_FLOW_CTRL 0x0 
+#define SIO_DISABLE_FLOW_CTRL 0x0
 #define SIO_RTS_CTS_HS (0x1 << 8)
 #define SIO_DTR_DSR_HS (0x2 << 8)
 #define SIO_XON_XOFF_HS (0x4 << 8)
 
-#define SIO_SET_MODEM_CTRL_REQUEST_TYPE 0x40
-#define SIO_SET_MODEM_CTRL_REQUEST SIO_MODEM_CTRL
-
 #define SIO_SET_DTR_MASK 0x1
 #define SIO_SET_DTR_HIGH ( 1 | ( SIO_SET_DTR_MASK  << 8))
 #define SIO_SET_DTR_LOW  ( 0 | ( SIO_SET_DTR_MASK  << 8))
@@ -141,7 +152,8 @@ enum ftdi_interface {
 
     Do not access directly if possible.
 */
-struct ftdi_context {
+struct ftdi_context
+{
     /* USB specific */
     /** libusb's usb_dev_handle */
     struct usb_dev_handle *usb_dev;
@@ -196,7 +208,8 @@ struct ftdi_context {
 /**
     \brief list of usb devices created by ftdi_usb_find_all()
 */
-struct ftdi_device_list {
+struct ftdi_device_list
+{
     /** pointer to next entry */
     struct ftdi_device_list *next;
     /** pointer to libusb's usb_device */
@@ -206,7 +219,8 @@ struct ftdi_device_list {
 /**
     \brief FTDI eeprom structure
 */
-struct ftdi_eeprom {
+struct ftdi_eeprom
+{
     /** vendor id */
     int vendor_id;
     /** product id */
@@ -214,7 +228,7 @@ struct ftdi_eeprom {
 
     /** self powered */
     int self_powered;
-    /** remote wakepu */
+    /** remote wakeup */
     int remote_wakeup;
     /** chip type */
     int BM_type_chip;
@@ -242,17 +256,18 @@ struct ftdi_eeprom {
     /** serial number */
     char *serial;
 
-  /** eeprom size in bytes. This doesn't get stored in the eeprom
-      but is the only way to pass it to ftdi_eeprom_build. */
-  int size;
+    /** eeprom size in bytes. This doesn't get stored in the eeprom
+        but is the only way to pass it to ftdi_eeprom_build. */
+    int size;
 };
 
 #ifdef __cplusplus
-extern "C" {
+extern "C"
+{
 #endif
 
     int ftdi_init(struct ftdi_context *ftdi);
-    struct ftdi_context *ftdi_new();
+    struct ftdi_context *ftdi_new(void);
     int ftdi_set_interface(struct ftdi_context *ftdi, enum ftdi_interface interface);
 
     void ftdi_deinit(struct ftdi_context *ftdi);
@@ -283,8 +298,8 @@ extern "C" {
     int ftdi_set_line_property(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
     int ftdi_set_line_property2(struct ftdi_context *ftdi, enum ftdi_bits_type bits,
-                               enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
-                               enum ftdi_break_type break_type);
+                                enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity,
+                                enum ftdi_break_type break_type);
 
     int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
     int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
@@ -321,8 +336,8 @@ extern "C" {
 
     /* init and build eeprom from ftdi_eeprom structure */
     void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
-    int  ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
-    void ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output);
+    int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
+    int ftdi_eeprom_decode(struct ftdi_eeprom *eeprom, unsigned char *output, int size);
 
     /* "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
        the checksum of the eeprom is valided */
@@ -333,7 +348,7 @@ extern "C" {
     int ftdi_erase_eeprom(struct ftdi_context *ftdi);
 
     char *ftdi_get_error_string(struct ftdi_context *ftdi);
-
 #ifdef __cplusplus
 }
 #endif