Commit | Line | Data |
---|---|---|
cdf448f6 TJ |
1 | /*************************************************************************** |
2 | ftdi.hpp - C++ wrapper for libftdi | |
3 | ------------------- | |
4 | begin : Mon Oct 13 2008 | |
5 | copyright : (C) 2008 by Marek Vavruša | |
6 | email : opensource@intra2net.com and marek@vavrusa.com | |
7 | ***************************************************************************/ | |
3ab8f642 TJ |
8 | /* |
9 | Copyright (C) 2008 by Marek Vavruša | |
cdf448f6 | 10 | |
3ab8f642 TJ |
11 | The software in this package is distributed under the GNU General |
12 | Public License version 2 (with a special exception described below). | |
13 | ||
14 | A copy of GNU General Public License (GPL) is included in this distribution, | |
15 | in the file COPYING.GPL. | |
16 | ||
17 | As a special exception, if other files instantiate templates or use macros | |
18 | or inline functions from this file, or you compile this file and link it | |
19 | with other works to produce a work based on this file, this file | |
20 | does not by itself cause the resulting work to be covered | |
21 | by the GNU General Public License. | |
22 | ||
23 | However the source code for this file must still be made available | |
24 | in accordance with section (3) of the GNU General Public License. | |
cdf448f6 | 25 | |
3ab8f642 TJ |
26 | This exception does not invalidate any other reasons why a work based |
27 | on this file might be covered by the GNU General Public License. | |
28 | */ | |
cdf448f6 TJ |
29 | #ifndef __libftdi_hpp__ |
30 | #define __libftdi_hpp__ | |
20b1459a TJ |
31 | |
32 | #include <list> | |
33 | #include <string> | |
cfceadbc | 34 | #include <boost/shared_ptr.hpp> |
2e889fc3 | 35 | #include <ftdi.h> |
20b1459a TJ |
36 | |
37 | namespace Ftdi | |
38 | { | |
39 | ||
40 | /* Forward declarations*/ | |
41 | class List; | |
42 | class Eeprom; | |
43 | ||
44 | /*! \brief FTDI device context. | |
45 | * Represents single FTDI device context. | |
46 | */ | |
47 | class Context | |
48 | { | |
cdf448f6 TJ |
49 | /* Friends */ |
50 | friend class Eeprom; | |
51 | friend class List; | |
52 | ||
53 | public: | |
54 | /*! \brief Direction flags for flush(). | |
55 | */ | |
56 | enum Direction | |
57 | { | |
58 | Input, | |
59 | Output | |
60 | }; | |
61 | ||
62 | /*! \brief Modem control flags. | |
63 | */ | |
64 | enum ModemCtl | |
65 | { | |
66 | Dtr, | |
67 | Rts | |
68 | }; | |
69 | ||
70 | /* Constructor, Destructor */ | |
71 | Context(); | |
72 | ~Context(); | |
73 | ||
74 | /* Properties */ | |
75 | Eeprom* eeprom(); | |
76 | const std::string& vendor(); | |
77 | const std::string& description(); | |
78 | const std::string& serial(); | |
79 | ||
80 | /* Device manipulators */ | |
81 | bool is_open(); | |
82 | int open(struct usb_device *dev = 0); | |
58cce2d4 GE |
83 | int open(int vendor, int product); |
84 | int open(int vendor, int product, const std::string& description, const std::string& serial = std::string(), unsigned int index=0); | |
85 | int open(const std::string& description); | |
cdf448f6 TJ |
86 | int close(); |
87 | int reset(); | |
88 | int flush(int mask = Input|Output); | |
89 | int set_interface(enum ftdi_interface interface); | |
90 | void set_usb_device(struct usb_dev_handle *dev); | |
91 | ||
92 | /* Line manipulators */ | |
93 | int set_baud_rate(int baudrate); | |
94 | int set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity); | |
95 | int set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, enum ftdi_break_type break_type); | |
96 | ||
97 | /* I/O */ | |
98 | int read(unsigned char *buf, int size); | |
99 | int write(unsigned char *buf, int size); | |
100 | int set_read_chunk_size(unsigned int chunksize); | |
101 | int set_write_chunk_size(unsigned int chunksize); | |
102 | int read_chunk_size(); | |
103 | int write_chunk_size(); | |
104 | ||
105 | /* Async IO | |
106 | TODO: should wrap? | |
107 | int writeAsync(unsigned char *buf, int size); | |
108 | void asyncComplete(int wait_for_more); | |
109 | */ | |
110 | ||
111 | /* Flow control */ | |
112 | int set_event_char(unsigned char eventch, unsigned char enable); | |
113 | int set_error_char(unsigned char errorch, unsigned char enable); | |
114 | int set_flow_control(int flowctrl); | |
115 | int set_modem_control(int mask = Dtr|Rts); | |
116 | int set_latency(unsigned char latency); | |
117 | int set_dtr(bool state); | |
118 | int set_rts(bool state); | |
119 | ||
120 | unsigned short poll_modem_status(); | |
121 | unsigned latency(); | |
122 | ||
123 | /* BitBang mode */ | |
124 | int set_bitmode(unsigned char bitmask, unsigned char mode); | |
58cce2d4 | 125 | int set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode); |
50ea6904 | 126 | int DEPRECATED(bitbang_enable(unsigned char bitmask)); |
cdf448f6 TJ |
127 | int bitbang_disable(); |
128 | int read_pins(unsigned char *pins); | |
129 | ||
130 | /* Misc */ | |
131 | char* error_string(); | |
132 | ||
133 | protected: | |
134 | int get_strings(); | |
58cce2d4 | 135 | int get_strings_and_reopen(); |
cdf448f6 TJ |
136 | |
137 | /* Properties */ | |
138 | struct ftdi_context* context(); | |
139 | void set_context(struct ftdi_context* context); | |
140 | void set_usb_device(struct usb_device *dev); | |
141 | ||
142 | private: | |
143 | class Private; | |
cfceadbc | 144 | boost::shared_ptr<Private> d; |
20b1459a TJ |
145 | }; |
146 | ||
147 | /*! \brief Device EEPROM. | |
148 | */ | |
149 | class Eeprom | |
150 | { | |
cdf448f6 TJ |
151 | public: |
152 | Eeprom(Context* parent); | |
153 | ~Eeprom(); | |
154 | ||
155 | void init_defaults(); | |
156 | void set_size(int size); | |
157 | int size(unsigned char *eeprom, int maxsize); | |
158 | int chip_id(unsigned int *chipid); | |
159 | int build(unsigned char *output); | |
449c87a9 | 160 | |
cdf448f6 TJ |
161 | int read(unsigned char *eeprom); |
162 | int write(unsigned char *eeprom); | |
449c87a9 TJ |
163 | int read_location(int eeprom_addr, unsigned short *eeprom_val); |
164 | int write_location(int eeprom_addr, unsigned short eeprom_val); | |
cdf448f6 TJ |
165 | int erase(); |
166 | ||
167 | private: | |
168 | class Private; | |
cfceadbc | 169 | boost::shared_ptr<Private> d; |
20b1459a TJ |
170 | }; |
171 | ||
20b1459a TJ |
172 | /*! \brief Device list. |
173 | */ | |
6b22a054 | 174 | class List |
20b1459a | 175 | { |
cdf448f6 TJ |
176 | public: |
177 | List(struct ftdi_device_list* devlist = 0); | |
178 | ~List(); | |
20b1459a | 179 | |
cdf448f6 | 180 | static List* find_all(int vendor, int product); |
20b1459a | 181 | |
a14193ac TJ |
182 | /// List type storing "Context" objects |
183 | typedef std::list<Context> ListType; | |
184 | /// Iterator type for the container | |
185 | typedef ListType::iterator iterator; | |
186 | /// Const iterator type for the container | |
187 | typedef ListType::const_iterator const_iterator; | |
188 | /// Reverse iterator type for the container | |
189 | typedef ListType::reverse_iterator reverse_iterator; | |
190 | /// Const reverse iterator type for the container | |
191 | typedef ListType::const_reverse_iterator const_reverse_iterator; | |
192 | ||
193 | iterator begin(); | |
194 | iterator end(); | |
195 | const_iterator begin() const; | |
196 | const_iterator end() const; | |
197 | ||
198 | reverse_iterator rbegin(); | |
199 | reverse_iterator rend(); | |
200 | const_reverse_iterator rbegin() const; | |
201 | const_reverse_iterator rend() const; | |
202 | ||
203 | ListType::size_type size() const; | |
204 | bool empty() const; | |
6b22a054 MV |
205 | void clear(); |
206 | ||
a14193ac TJ |
207 | void push_back(const Context& element); |
208 | void push_front(const Context& element); | |
6b22a054 | 209 | |
a14193ac TJ |
210 | iterator erase(iterator pos); |
211 | iterator erase(iterator beg, iterator end); | |
6b22a054 | 212 | |
cdf448f6 TJ |
213 | private: |
214 | class Private; | |
cfceadbc | 215 | boost::shared_ptr<Private> d; |
20b1459a TJ |
216 | }; |
217 | ||
218 | } | |
219 | ||
220 | #endif |