aboutsummaryrefslogtreecommitdiff
path: root/lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h')
-rw-r--r--lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h145
1 files changed, 145 insertions, 0 deletions
diff --git a/lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h b/lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h
new file mode 100644
index 000000000..b73125262
--- /dev/null
+++ b/lib/usbhost/USB_Host_Shield_2.0/cdcftdi.h
@@ -0,0 +1,145 @@
1/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.
2
3This software may be distributed and modified under the terms of the GNU
4General Public License version 2 (GPL2) as published by the Free Software
5Foundation and appearing in the file GPL2.TXT included in the packaging of
6this file. Please note that GPL2 Section 2[b] requires that all works based
7on this software must also be made publicly available under the terms of
8the GPL2 ("Copyleft").
9
10Contact information
11-------------------
12
13Circuits At Home, LTD
14Web : http://www.circuitsathome.com
15e-mail : support@circuitsathome.com
16 */
17#if !defined(__CDCFTDI_H__)
18#define __CDCFTDI_H__
19
20#include "Usb.h"
21
22#define bmREQ_FTDI_OUT 0x40
23#define bmREQ_FTDI_IN 0xc0
24
25//#define bmREQ_FTDI_OUT USB_SETUP_HOST_TO_DEVICE|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE
26//#define bmREQ_FTDI_IN USB_SETUP_DEVICE_TO_HOST|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE
27
28#define FTDI_VID 0x0403 // FTDI VID
29#define FTDI_PID 0x6001 // FTDI PID
30
31#define FT232AM 0x0200
32#define FT232BM 0x0400
33#define FT2232 0x0500
34#define FT232R 0x0600
35
36// Commands
37#define FTDI_SIO_RESET 0 /* Reset the port */
38#define FTDI_SIO_MODEM_CTRL 1 /* Set the modem control register */
39#define FTDI_SIO_SET_FLOW_CTRL 2 /* Set flow control register */
40#define FTDI_SIO_SET_BAUD_RATE 3 /* Set baud rate */
41#define FTDI_SIO_SET_DATA 4 /* Set the data characteristics of the port */
42#define FTDI_SIO_GET_MODEM_STATUS 5 /* Retrieve current value of modem status register */
43#define FTDI_SIO_SET_EVENT_CHAR 6 /* Set the event character */
44#define FTDI_SIO_SET_ERROR_CHAR 7 /* Set the error character */
45
46#define FTDI_SIO_RESET_SIO 0
47#define FTDI_SIO_RESET_PURGE_RX 1
48#define FTDI_SIO_RESET_PURGE_TX 2
49
50#define FTDI_SIO_SET_DATA_PARITY_NONE (0x0 << 8 )
51#define FTDI_SIO_SET_DATA_PARITY_ODD (0x1 << 8 )
52#define FTDI_SIO_SET_DATA_PARITY_EVEN (0x2 << 8 )
53#define FTDI_SIO_SET_DATA_PARITY_MARK (0x3 << 8 )
54#define FTDI_SIO_SET_DATA_PARITY_SPACE (0x4 << 8 )
55#define FTDI_SIO_SET_DATA_STOP_BITS_1 (0x0 << 11)
56#define FTDI_SIO_SET_DATA_STOP_BITS_15 (0x1 << 11)
57#define FTDI_SIO_SET_DATA_STOP_BITS_2 (0x2 << 11)
58#define FTDI_SIO_SET_BREAK (0x1 << 14)
59
60#define FTDI_SIO_SET_DTR_MASK 0x1
61#define FTDI_SIO_SET_DTR_HIGH ( 1 | ( FTDI_SIO_SET_DTR_MASK << 8))
62#define FTDI_SIO_SET_DTR_LOW ( 0 | ( FTDI_SIO_SET_DTR_MASK << 8))
63#define FTDI_SIO_SET_RTS_MASK 0x2
64#define FTDI_SIO_SET_RTS_HIGH ( 2 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
65#define FTDI_SIO_SET_RTS_LOW ( 0 | ( FTDI_SIO_SET_RTS_MASK << 8 ))
66
67#define FTDI_SIO_DISABLE_FLOW_CTRL 0x0
68#define FTDI_SIO_RTS_CTS_HS (0x1 << 8)
69#define FTDI_SIO_DTR_DSR_HS (0x2 << 8)
70#define FTDI_SIO_XON_XOFF_HS (0x4 << 8)
71
72#define FTDI_SIO_CTS_MASK 0x10
73#define FTDI_SIO_DSR_MASK 0x20
74#define FTDI_SIO_RI_MASK 0x40
75#define FTDI_SIO_RLSD_MASK 0x80
76
77class FTDI;
78
79class FTDIAsyncOper {
80public:
81
82 virtual uint8_t OnInit(FTDI *pftdi) {
83 return 0;
84 };
85
86 virtual uint8_t OnRelease(FTDI *pftdi) {
87 return 0;
88 };
89};
90
91
92// Only single port chips are currently supported by the library,
93// so only three endpoints are allocated.
94#define FTDI_MAX_ENDPOINTS 3
95
96class FTDI : public USBDeviceConfig, public UsbConfigXtracter {
97 static const uint8_t epDataInIndex; // DataIn endpoint index
98 static const uint8_t epDataOutIndex; // DataOUT endpoint index
99 static const uint8_t epInterruptInIndex; // InterruptIN endpoint index
100
101 FTDIAsyncOper *pAsync;
102 USB *pUsb;
103 uint8_t bAddress;
104 uint8_t bConfNum; // configuration number
105 uint8_t bNumIface; // number of interfaces in the configuration
106 uint8_t bNumEP; // total number of EP in the configuration
107 uint32_t qNextPollTime; // next poll time
108 bool bPollEnable; // poll enable flag
109 uint16_t wFTDIType; // Type of FTDI chip
110
111 EpInfo epInfo[FTDI_MAX_ENDPOINTS];
112
113 void PrintEndpointDescriptor(const USB_ENDPOINT_DESCRIPTOR* ep_ptr);
114
115public:
116 FTDI(USB *pusb, FTDIAsyncOper *pasync);
117
118 uint8_t SetBaudRate(uint32_t baud);
119 uint8_t SetModemControl(uint16_t control);
120 uint8_t SetFlowControl(uint8_t protocol, uint8_t xon = 0x11, uint8_t xoff = 0x13);
121 uint8_t SetData(uint16_t databm);
122
123 // Methods for recieving and sending data
124 uint8_t RcvData(uint16_t *bytes_rcvd, uint8_t *dataptr);
125 uint8_t SndData(uint16_t nbytes, uint8_t *dataptr);
126
127 // USBDeviceConfig implementation
128 uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
129 uint8_t Release();
130 uint8_t Poll();
131
132 virtual uint8_t GetAddress() {
133 return bAddress;
134 };
135
136 // UsbConfigXtracter implementation
137 void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep);
138
139 virtual bool VIDPIDOK(uint16_t vid, uint16_t pid) {
140 return (vid == FTDI_VID && pid == FTDI_PID);
141 }
142
143};
144
145#endif // __CDCFTDI_H__