1 /***************************************************************************
2 ftdi.hpp - C++ wrapper for libftdi
4 begin : Mon Oct 13 2008
5 copyright : (C) 2008 by Marek Vavruša
6 email : opensource@intra2net.com and marek@vavrusa.com
7 ***************************************************************************/
9 Copyright (C) 2008 by Marek Vavruša
11 The software in this package is distributed under the GNU General
12 Public License version 2 (with a special exception described below).
14 A copy of GNU General Public License (GPL) is included in this distribution,
15 in the file COPYING.GPL.
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.
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.
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.
29 #ifndef __libftdi_hpp__
30 #define __libftdi_hpp__
34 #include <boost/shared_ptr.hpp>
40 /* Forward declarations*/
44 /*! \brief FTDI device context.
45 * Represents single FTDI device context.
54 /*! \brief Direction flags for flush().
62 /*! \brief Modem control flags.
70 /* Constructor, Destructor */
76 const std::string& vendor();
77 const std::string& description();
78 const std::string& serial();
80 /* Device manipulators */
82 int open(struct libusb_device *dev = 0);
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);
88 int flush(int mask = Input|Output);
89 int set_interface(enum ftdi_interface interface);
90 void set_usb_device(struct libusb_device_handle *dev);
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);
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();
107 int writeAsync(unsigned char *buf, int size);
108 void asyncComplete(int wait_for_more);
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);
120 unsigned short poll_modem_status();
124 int set_bitmode(unsigned char bitmask, unsigned char mode);
125 int set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode);
126 int DEPRECATED(bitbang_enable(unsigned char bitmask));
127 int bitbang_disable();
128 int read_pins(unsigned char *pins);
131 char* error_string();
135 int get_strings_and_reopen();
138 struct ftdi_context* context();
139 void set_context(struct ftdi_context* context);
140 void set_usb_device(struct libusb_device *dev);
144 boost::shared_ptr<Private> d;
147 /*! \brief Device EEPROM.
152 Eeprom(Context* parent);
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);
161 int read(unsigned char *eeprom);
162 int write(unsigned char *eeprom);
163 int read_location(int eeprom_addr, unsigned short *eeprom_val);
164 int write_location(int eeprom_addr, unsigned short eeprom_val);
169 boost::shared_ptr<Private> d;
172 /*! \brief Device list.
177 List(struct ftdi_device_list* devlist = 0);
180 static List* find_all(int vendor, int product);
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;
195 const_iterator begin() const;
196 const_iterator end() const;
198 reverse_iterator rbegin();
199 reverse_iterator rend();
200 const_reverse_iterator rbegin() const;
201 const_reverse_iterator rend() const;
203 ListType::size_type size() const;
207 void push_back(const Context& element);
208 void push_front(const Context& element);
210 iterator erase(iterator pos);
211 iterator erase(iterator beg, iterator end);
215 boost::shared_ptr<Private> d;