libftdi 0.20

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

ftdi.hpp
Go to the documentation of this file.
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 ***************************************************************************/
8 /*
9 Copyright (C) 2008 by Marek Vavruša
10
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.
25
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 */
29 #ifndef __libftdi_hpp__
30 #define __libftdi_hpp__
31
32 #include <list>
33 #include <string>
34 #include <boost/shared_ptr.hpp>
35 #include <ftdi.h>
36
37 namespace Ftdi
38 {
39
40 /* Forward declarations*/
41 class List;
42 class Eeprom;
43
47 class Context
48 {
49 /* Friends */
50 friend class Eeprom;
51 friend class List;
52
53 public:
56 enum Direction
57 {
58 Input,
59 Output
60 };
61
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);
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);
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);
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);
129
130 /* Misc */
131 char* error_string();
132
133 protected:
134 int get_strings();
135 int get_strings_and_reopen();
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;
144 boost::shared_ptr<Private> d;
145 };
146
149 class Eeprom
150 {
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);
160
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);
165 int erase();
166
167 private:
168 class Private;
169 boost::shared_ptr<Private> d;
170 };
171
174 class List
175 {
176 public:
177 List(struct ftdi_device_list* devlist = 0);
178 ~List();
179
180 static List* find_all(int vendor, int product);
181
183 typedef std::list<Context> ListType;
185 typedef ListType::iterator iterator;
187 typedef ListType::const_iterator const_iterator;
189 typedef ListType::reverse_iterator reverse_iterator;
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;
205 void clear();
206
207 void push_back(const Context& element);
208 void push_front(const Context& element);
209
210 iterator erase(iterator pos);
211 iterator erase(iterator beg, iterator end);
212
213 private:
214 class Private;
215 boost::shared_ptr<Private> d;
216 };
217
218 }
219
220 #endif
Ftdi::List::empty
bool empty() const
Definition: ftdi.cpp:569
Ftdi::Context::set_modem_control
int set_modem_control(int mask=Dtr|Rts)
Definition: ftdi.cpp:223
ftdi_device_list
list of usb devices created by ftdi_usb_find_all()
Definition: ftdi.h:249
usb_dev_handle
Definition: ftdi.c:1270
Ftdi::List::end
iterator end()
Definition: ftdi.cpp:496
Ftdi::Context::error_string
char * error_string()
Definition: ftdi.cpp:299
Ftdi::Context::Output
Definition: ftdi.hpp:59
Ftdi::Context::write
int write(unsigned char *buf, int size)
Definition: ftdi.cpp:199
Ftdi::Context
FTDI device context. Represents single FTDI device context.
Definition: ftdi.hpp:47
Ftdi::Context::read_chunk_size
int read_chunk_size()
Definition: ftdi.cpp:190
Ftdi::Context::description
const std::string & description()
Device strings properties.
Definition: ftdi.cpp:347
Ftdi::List::rbegin
reverse_iterator rbegin()
Definition: ftdi.cpp:523
ftdi_interface
ftdi_interface
Definition: ftdi.h:50
Ftdi::List::push_front
void push_front(const Context &element)
Definition: ftdi.cpp:604
Ftdi::Context::read
int read(unsigned char *buf, int size)
Definition: ftdi.cpp:180
Ftdi::Context::Dtr
Definition: ftdi.hpp:66
Ftdi::Context::DEPRECATED
int DEPRECATED(bitbang_enable(unsigned char bitmask))
Ftdi::Context::Direction
Direction
Direction flags for flush().
Definition: ftdi.hpp:56
Ftdi::List::iterator
ListType::iterator iterator
Iterator type for the container.
Definition: ftdi.hpp:185
Ftdi::Context::reset
int reset()
Definition: ftdi.cpp:137
Ftdi::Context::vendor
const std::string & vendor()
Device strings properties.
Definition: ftdi.cpp:340
Ftdi::Eeprom::~Eeprom
~Eeprom()
Definition: ftdi.cpp:392
ftdi_context
Main context structure for all libftdi functions.
Definition: ftdi.h:188
Ftdi::Eeprom::read_location
int read_location(int eeprom_addr, unsigned short *eeprom_val)
Definition: ftdi.cpp:431
Ftdi::List::ListType
std::list< Context > ListType
List type storing &quot;Context&quot; objects.
Definition: ftdi.hpp:183
Ftdi::Context::~Context
~Context()
Destructor.
Definition: ftdi.cpp:71
Ftdi::Context::bitbang_disable
int bitbang_disable()
Definition: ftdi.cpp:279
Ftdi::Context::eeprom
Eeprom * eeprom()
Ftdi::Context::flush
int flush(int mask=Input|Output)
Definition: ftdi.cpp:142
Ftdi::Context::open
int open(struct usb_device *dev=0)
Definition: ftdi.cpp:120
Ftdi::List::begin
iterator begin()
Definition: ftdi.cpp:487
Ftdi::Context::write_chunk_size
int write_chunk_size()
Definition: ftdi.cpp:209
Ftdi::Context::set_latency
int set_latency(unsigned char latency)
Definition: ftdi.cpp:245
Ftdi::Context::serial
const std::string & serial()
Device strings properties.
Definition: ftdi.cpp:354
Ftdi::List::find_all
static List * find_all(int vendor, int product)
Definition: ftdi.cpp:630
Ftdi::Context::ModemCtl
ModemCtl
Modem control flags.
Definition: ftdi.hpp:64
Ftdi::Context::Input
Definition: ftdi.hpp:58
Ftdi::Eeprom::erase
int erase()
Definition: ftdi.cpp:441
Ftdi::List::Private
Definition: ftdi.cpp:446
ftdi_bits_type
ftdi_bits_type
Definition: ftdi.h:31
Ftdi::Context::set_interface
int set_interface(enum ftdi_interface interface)
Definition: ftdi.cpp:154
Ftdi::Context::set_read_chunk_size
int set_read_chunk_size(unsigned int chunksize)
Definition: ftdi.cpp:185
Ftdi::Eeprom
Device EEPROM.
Definition: ftdi.hpp:149
Ftdi::Context::set_rts
int set_rts(bool state)
Definition: ftdi.cpp:240
Ftdi::Context::latency
unsigned latency()
Definition: ftdi.cpp:250
Ftdi::Context::close
int close()
Definition: ftdi.cpp:131
Ftdi::Context::poll_modem_status
unsigned short poll_modem_status()
Definition: ftdi.cpp:257
Ftdi::Context::set_write_chunk_size
int set_write_chunk_size(unsigned int chunksize)
Definition: ftdi.cpp:204
Ftdi::List::reverse_iterator
ListType::reverse_iterator reverse_iterator
Reverse iterator type for the container.
Definition: ftdi.hpp:189
ftdi.h
Ftdi::List::rend
reverse_iterator rend()
Definition: ftdi.cpp:532
Ftdi::List::push_back
void push_back(const Context &element)
Definition: ftdi.cpp:595
Ftdi::List::List
List(struct ftdi_device_list *devlist=0)
Definition: ftdi.cpp:463
Ftdi::Context::set_flow_control
int set_flow_control(int flowctrl)
Definition: ftdi.cpp:218
Ftdi::Context::set_usb_device
void set_usb_device(struct usb_dev_handle *dev)
Definition: ftdi.cpp:159
Ftdi::List::erase
iterator erase(iterator pos)
Definition: ftdi.cpp:614
Ftdi::Eeprom::size
int size(unsigned char *eeprom, int maxsize)
Definition: ftdi.cpp:406
Ftdi::Eeprom::build
int build(unsigned char *output)
Definition: ftdi.cpp:416
Ftdi::Eeprom::init_defaults
void init_defaults()
Definition: ftdi.cpp:396
ftdi_break_type
ftdi_break_type
Definition: ftdi.h:33
Ftdi::Eeprom::chip_id
int chip_id(unsigned int *chipid)
Definition: ftdi.cpp:411
Ftdi::Context::set_bitmode
int set_bitmode(unsigned char bitmask, unsigned char mode)
Definition: ftdi.cpp:284
Ftdi::List::~List
~List()
Definition: ftdi.cpp:479
Ftdi::Context::set_error_char
int set_error_char(unsigned char errorch, unsigned char enable)
Definition: ftdi.cpp:269
ftdi_parity_type
ftdi_parity_type
Definition: ftdi.h:27
Ftdi::Context::get_strings
int get_strings()
Definition: ftdi.cpp:304
Ftdi::Eeprom::Private
Definition: ftdi.cpp:375
Ftdi::Context::Context
Context()
Constructor.
Definition: ftdi.cpp:64
Ftdi::List::clear
void clear()
Definition: ftdi.cpp:579
ftdi_stopbits_type
ftdi_stopbits_type
Definition: ftdi.h:29
Ftdi::Context::set_dtr
int set_dtr(bool state)
Definition: ftdi.cpp:235
Ftdi::List
Device list.
Definition: ftdi.hpp:174
Ftdi::Context::set_line_property
int set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
Definition: ftdi.cpp:170
Ftdi::Context::get_strings_and_reopen
int get_strings_and_reopen()
Definition: ftdi.cpp:321
Ftdi::List::const_iterator
ListType::const_iterator const_iterator
Const iterator type for the container.
Definition: ftdi.hpp:187
Ftdi::Context::context
struct ftdi_context * context()
Definition: ftdi.cpp:370
Ftdi::Context::Rts
Definition: ftdi.hpp:67
Ftdi::Eeprom::Eeprom
Eeprom(Context *parent)
Definition: ftdi.cpp:386
Ftdi::Eeprom::read
int read(unsigned char *eeprom)
Definition: ftdi.cpp:421
Ftdi::Context::set_baud_rate
int set_baud_rate(int baudrate)
Definition: ftdi.cpp:165
Ftdi::List::size
ListType::size_type size() const
Definition: ftdi.cpp:560
Ftdi::Eeprom::write
int write(unsigned char *eeprom)
Definition: ftdi.cpp:426
ftdi_mpsse_mode
ftdi_mpsse_mode
Definition: ftdi.h:36
Ftdi::List::const_reverse_iterator
ListType::const_reverse_iterator const_reverse_iterator
Const reverse iterator type for the container.
Definition: ftdi.hpp:191
Ftdi::Context::set_event_char
int set_event_char(unsigned char eventch, unsigned char enable)
Definition: ftdi.cpp:264
Ftdi::Eeprom::set_size
void set_size(int size)
Definition: ftdi.cpp:401
Ftdi::Context::is_open
bool is_open()
Definition: ftdi.cpp:75
Ftdi::Context::read_pins
int read_pins(unsigned char *pins)
Definition: ftdi.cpp:294
Ftdi::Context::set_context
void set_context(struct ftdi_context *context)
Definition: ftdi.cpp:359
Ftdi::Eeprom::write_location
int write_location(int eeprom_addr, unsigned short eeprom_val)
Definition: ftdi.cpp:436