106 lines
3.2 KiB
C
106 lines
3.2 KiB
C
/*
|
|
* Copyright (c) 2022, sakumisu
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#ifndef USBH_FTDI_H
|
|
#define USBH_FTDI_H
|
|
|
|
/* Requests */
|
|
#define SIO_RESET_REQUEST 0x00 /* Reset the port */
|
|
#define SIO_SET_MODEM_CTRL_REQUEST 0x01 /* Set the modem control register */
|
|
#define SIO_SET_FLOW_CTRL_REQUEST 0x02 /* Set flow control register */
|
|
#define SIO_SET_BAUDRATE_REQUEST 0x03 /* Set baud rate */
|
|
#define SIO_SET_DATA_REQUEST 0x04 /* Set the data characteristics of the port */
|
|
#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_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_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))
|
|
#define SIO_SET_RTS_MASK 0x2
|
|
#define SIO_SET_RTS_HIGH (2 | (SIO_SET_RTS_MASK << 8))
|
|
#define SIO_SET_RTS_LOW (0 | (SIO_SET_RTS_MASK << 8))
|
|
|
|
#define SIO_RTS_CTS_HS (0x1 << 8)
|
|
|
|
struct usbh_ftdi {
|
|
struct usbh_hubport *hport;
|
|
struct usb_endpoint_descriptor *bulkin; /* Bulk IN endpoint */
|
|
struct usb_endpoint_descriptor *bulkout; /* Bulk OUT endpoint */
|
|
struct usbh_urb bulkout_urb;
|
|
struct usbh_urb bulkin_urb;
|
|
|
|
uint8_t intf;
|
|
uint8_t minor;
|
|
uint8_t modem_status[2];
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
int usbh_ftdi_reset(struct usbh_ftdi *ftdi_class);
|
|
/**
|
|
* @brief set modem
|
|
*
|
|
* @param [in] value SIO_SET_DTR_HIGH or SIO_SET_DTR_LOW or SIO_SET_RTS_HIGH or SIO_SET_RTS_LOW
|
|
*/
|
|
int usbh_ftdi_set_modem(struct usbh_ftdi *ftdi_class, uint16_t value);
|
|
/**
|
|
* @brief set baudrate
|
|
*
|
|
* @param [in] baudrate less than 3M
|
|
*/
|
|
int usbh_ftdi_set_baudrate(struct usbh_ftdi *ftdi_class, uint32_t baudrate);
|
|
/**
|
|
* @brief set data
|
|
*
|
|
* @param [in] databits BITS_7=7, BITS_8=8
|
|
* @param [in] parity NONE=0, ODD=1, EVEN=2, MARK=3, SPACE=4
|
|
* @param [in] stopbits STOP_BIT_1=0, STOP_BIT_15=1, STOP_BIT_2=2
|
|
* @param [in] isbreak BREAK_OFF=0, BREAK_ON=1
|
|
*/
|
|
int usbh_ftdi_set_data(struct usbh_ftdi *ftdi_class, uint8_t databits,
|
|
uint8_t parity,
|
|
uint8_t stopbits,
|
|
uint8_t isbreak);
|
|
int usbh_ftdi_set_flow_ctrl(struct usbh_ftdi *ftdi_class, uint16_t value);
|
|
|
|
/**
|
|
* @brief start a bulk in transfer
|
|
*
|
|
* @param [in] buffer buffer[0] and buffer[1] is modem status
|
|
* @param [in] buflen should be 64 or 512
|
|
*/
|
|
int usbh_ftdi_bulk_in_transfer(struct usbh_ftdi *ftdi_class, uint8_t *buffer, uint32_t buflen, uint32_t timeout);
|
|
/**
|
|
* @brief start a bulk out transfer
|
|
*
|
|
* @param [in] buffer
|
|
* @param [in] buflen
|
|
*/
|
|
int usbh_ftdi_bulk_out_transfer(struct usbh_ftdi *ftdi_class, uint8_t *buffer, uint32_t buflen, uint32_t timeout);
|
|
|
|
void usbh_ftdi_run(struct usbh_ftdi *ftdi_class);
|
|
void usbh_ftdi_stop(struct usbh_ftdi *ftdi_class);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* USBH_FTDI_H */
|