+/***************************************************************************
+ ftdi.cpp - C++ wraper for libftdi
+ -------------------
+ begin : Mon Oct 13 2008
+ copyright : (C) 2008-2017 by Marek Vavruša / libftdi developers
+ email : opensource@intra2net.com and marek@vavrusa.com
+ ***************************************************************************/
+/*
+Copyright (C) 2008-2017 by Marek Vavruša / libftdi developers
+
+The software in this package is distributed under the GNU General
+Public License version 2 (with a special exception described below).
+
+A copy of GNU General Public License (GPL) is included in this distribution,
+in the file COPYING.GPL.
+
+As a special exception, if other files instantiate templates or use macros
+or inline functions from this file, or you compile this file and link it
+with other works to produce a work based on this file, this file
+does not by itself cause the resulting work to be covered
+by the GNU General Public License.
+
+However the source code for this file must still be made available
+in accordance with section (3) of the GNU General Public License.
+
+This exception does not invalidate any other reasons why a work based
+on this file might be covered by the GNU General Public License.
+*/
+#include <libusb.h>
#include "ftdi.hpp"
+#include "ftdi_i.h"
#include "ftdi.h"
namespace Ftdi
class Context::Private
{
- public:
- Private()
- : ftdi(0), dev(0), open(false)
- {}
-
- bool open;
-
- struct ftdi_context* ftdi;
- struct usb_device* dev;
-
- std::string vendor;
- std::string description;
- std::string serial;
+public:
+ Private()
+ : open(false), ftdi(0), dev(0)
+ {
+ ftdi = ftdi_new();
+ }
+
+ ~Private()
+ {
+ if (open)
+ ftdi_usb_close(ftdi);
+
+ ftdi_free(ftdi);
+ }
+
+ bool open;
+
+ struct ftdi_context* ftdi;
+ struct libusb_device* dev;
+
+ std::string vendor;
+ std::string description;
+ std::string serial;
};
/*! \brief Constructor.
*/
Context::Context()
- : d( new Private() )
+ : d( new Private() )
{
- d->ftdi = ftdi_new();
}
/*! \brief Destructor.
*/
Context::~Context()
{
- if(d->open)
- close();
-
- ftdi_free(d->ftdi);
- delete d;
}
bool Context::is_open()
{
- return d->open;
+ return d->open;
}
-int Context::open(int vendor, int product, const std::string& description, const std::string& serial)
+int Context::open(int vendor, int product)
{
- int ret = 0;
- if(description.empty() && serial.empty())
- ret = ftdi_usb_open(d->ftdi, vendor, product);
- else
- ret = ftdi_usb_open_desc(d->ftdi, vendor, product, description.c_str(), serial.c_str());
+ // Open device
+ int ret = ftdi_usb_open(d->ftdi, vendor, product);
+
+ if (ret < 0)
+ return ret;
+
+ return get_strings_and_reopen(false,false,false);
+}
+
+int Context::open(int vendor, int product, const std::string& description, const std::string& serial, unsigned int index)
+{
+ // translate empty strings to NULL
+ // -> do not use them to find the device (vs. require an empty string to be set in the EEPROM)
+ const char* c_description=NULL;
+ const char* c_serial=NULL;
+ if (!description.empty())
+ c_description=description.c_str();
+ if (!serial.empty())
+ c_serial=serial.c_str();
+
+ int ret = ftdi_usb_open_desc_index(d->ftdi, vendor, product, c_description, c_serial, index);
+
+ if (ret < 0)
+ return ret;
+
+ return get_strings_and_reopen(false,description.empty(),serial.empty());
+}
- d->dev = usb_device(d->ftdi->usb_dev);
+int Context::open(const std::string& description)
+{
+ int ret = ftdi_usb_open_string(d->ftdi, description.c_str());
- if((ret = ftdi_usb_open_dev(d->ftdi, d->dev)) >= 0)
- {
- d->open = true;
- get_strings();
- }
+ if (ret < 0)
+ return ret;
- return ret;
+ return get_strings_and_reopen(false,true,false);
}
-int Context::open(struct usb_device *dev)
+int Context::open(struct libusb_device *dev)
{
- int ret = 0;
-
- if(dev != 0)
- d->dev = dev;
+ if (dev != 0)
+ d->dev = dev;
- if(d->dev == 0)
- return -1;
-
- if((ret = ftdi_usb_open_dev(d->ftdi, d->dev)) >= 0)
- {
- d->open = true;
- get_strings();
- }
+ if (d->dev == 0)
+ return -1;
- return ret;
+ return get_strings_and_reopen();
}
int Context::close()
{
- d->open = false;
- return ftdi_usb_close(d->ftdi);
+ d->open = false;
+ d->dev = 0;
+ return ftdi_usb_close(d->ftdi);
}
int Context::reset()
{
- return ftdi_usb_reset(d->ftdi);
+ return ftdi_usb_reset(d->ftdi);
}
int Context::flush(int mask)
{
- int ret = 1;
- if(mask & Input)
- ret &= ftdi_usb_purge_rx_buffer(d->ftdi);
- if(mask & Output)
- ret &= ftdi_usb_purge_tx_buffer(d->ftdi);
+ int ret = 1;
- return ret;
+ if (mask & Input)
+ ret &= ftdi_usb_purge_rx_buffer(d->ftdi);
+ if (mask & Output)
+ ret &= ftdi_usb_purge_tx_buffer(d->ftdi);
+
+ return ret;
}
int Context::set_interface(enum ftdi_interface interface)
{
- return ftdi_set_interface(d->ftdi, interface);
+ return ftdi_set_interface(d->ftdi, interface);
}
-void Context::set_usb_device(struct usb_dev_handle *dev)
+void Context::set_usb_device(struct libusb_device_handle *dev)
{
- ftdi_set_usbdev(d->ftdi, dev);
- d->dev = usb_device(dev);
+ ftdi_set_usbdev(d->ftdi, dev);
+ d->dev = libusb_get_device(dev);
}
int Context::set_baud_rate(int baudrate)
{
- return ftdi_set_baudrate(d->ftdi, baudrate);
+ return ftdi_set_baudrate(d->ftdi, baudrate);
}
int Context::set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
{
- return ftdi_set_line_property(d->ftdi, bits, sbit, parity);
+ return ftdi_set_line_property(d->ftdi, bits, sbit, parity);
}
int Context::set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, enum ftdi_break_type break_type)
{
- return ftdi_set_line_property2(d->ftdi, bits, sbit, parity, break_type);
+ return ftdi_set_line_property2(d->ftdi, bits, sbit, parity, break_type);
+}
+
+int Context::get_usb_read_timeout() const
+{
+ return d->ftdi->usb_read_timeout;
+}
+
+void Context::set_usb_read_timeout(int usb_read_timeout)
+{
+ d->ftdi->usb_read_timeout = usb_read_timeout;
+}
+
+int Context::get_usb_write_timeout() const
+{
+ return d->ftdi->usb_write_timeout;
+}
+
+void Context::set_usb_write_timeout(int usb_write_timeout)
+{
+ d->ftdi->usb_write_timeout = usb_write_timeout;
}
int Context::read(unsigned char *buf, int size)
{
- return ftdi_read_data(d->ftdi, buf, size);
+ return ftdi_read_data(d->ftdi, buf, size);
}
int Context::set_read_chunk_size(unsigned int chunksize)
{
- return ftdi_read_data_set_chunksize(d->ftdi, chunksize);
+ return ftdi_read_data_set_chunksize(d->ftdi, chunksize);
}
int Context::read_chunk_size()
{
- unsigned chunk = -1;
- if(ftdi_read_data_get_chunksize(d->ftdi, &chunk) < 0)
- return -1;
-
- return chunk;
-}
+ unsigned chunk = -1;
+ if (ftdi_read_data_get_chunksize(d->ftdi, &chunk) < 0)
+ return -1;
+ return chunk;
+}
int Context::write(unsigned char *buf, int size)
{
- return ftdi_write_data(d->ftdi, buf, size);
+ return ftdi_write_data(d->ftdi, buf, size);
}
int Context::set_write_chunk_size(unsigned int chunksize)
{
- return ftdi_write_data_set_chunksize(d->ftdi, chunksize);
+ return ftdi_write_data_set_chunksize(d->ftdi, chunksize);
}
int Context::write_chunk_size()
{
- unsigned chunk = -1;
- if(ftdi_write_data_get_chunksize(d->ftdi, &chunk) < 0)
- return -1;
+ unsigned chunk = -1;
+ if (ftdi_write_data_get_chunksize(d->ftdi, &chunk) < 0)
+ return -1;
- return chunk;
+ return chunk;
}
int Context::set_flow_control(int flowctrl)
{
- return ftdi_setflowctrl(d->ftdi, flowctrl);
+ return ftdi_setflowctrl(d->ftdi, flowctrl);
}
int Context::set_modem_control(int mask)
{
- int dtr = 0, rts = 0;
-
- if(mask & Dtr)
- dtr = 1;
- if(mask & Rts)
- rts = 1;
+ int dtr = 0, rts = 0;
- return ftdi_setdtr_rts(d->ftdi, dtr, rts);
+ if (mask & Dtr)
+ dtr = 1;
+ if (mask & Rts)
+ rts = 1;
+
+ return ftdi_setdtr_rts(d->ftdi, dtr, rts);
}
int Context::set_dtr(bool state)
{
- return ftdi_setdtr(d->ftdi, state);
+ return ftdi_setdtr(d->ftdi, state);
}
int Context::set_rts(bool state)
{
- return ftdi_setrts(d->ftdi, state);
+ return ftdi_setrts(d->ftdi, state);
}
int Context::set_latency(unsigned char latency)
{
- return ftdi_set_latency_timer(d->ftdi, latency);
+ return ftdi_set_latency_timer(d->ftdi, latency);
}
unsigned Context::latency()
{
- unsigned char latency = 0;
- ftdi_get_latency_timer(d->ftdi, &latency);
- return latency;
+ unsigned char latency = 0;
+ ftdi_get_latency_timer(d->ftdi, &latency);
+ return latency;
}
unsigned short Context::poll_modem_status()
{
- unsigned short status = 0;
- ftdi_poll_modem_status(d->ftdi, &status);
- return status;
+ unsigned short status = 0;
+ ftdi_poll_modem_status(d->ftdi, &status);
+ return status;
}
-
int Context::set_event_char(unsigned char eventch, unsigned char enable)
{
- return ftdi_set_event_char(d->ftdi, eventch, enable);
+ return ftdi_set_event_char(d->ftdi, eventch, enable);
}
int Context::set_error_char(unsigned char errorch, unsigned char enable)
{
- return ftdi_set_error_char(d->ftdi, errorch, enable);
+ return ftdi_set_error_char(d->ftdi, errorch, enable);
}
-int Context::bitbang_enable(unsigned char bitmask)
+int Context::set_bitmode(unsigned char bitmask, unsigned char mode)
{
- return ftdi_enable_bitbang(d->ftdi, bitmask);
+ return ftdi_set_bitmode(d->ftdi, bitmask, mode);
}
-int Context::bitbang_disable()
+int Context::set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode)
{
- return ftdi_disable_bitbang(d->ftdi);
+ return ftdi_set_bitmode(d->ftdi, bitmask, mode);
}
-int Context::set_bitmode(unsigned char bitmask, unsigned char mode)
+int Context::bitbang_disable()
{
- return ftdi_set_bitmode(d->ftdi, bitmask, mode);
+ return ftdi_disable_bitbang(d->ftdi);
}
int Context::read_pins(unsigned char *pins)
{
- return ftdi_read_pins(d->ftdi, pins);
+ return ftdi_read_pins(d->ftdi, pins);
+}
+
+const char* Context::error_string()
+{
+ return ftdi_get_error_string(d->ftdi);
}
-char* Context::error_string()
+int Context::get_strings(bool vendor, bool description, bool serial)
{
- return ftdi_get_error_string(d->ftdi);
+ // Prepare buffers
+ char ivendor[512], idesc[512], iserial[512];
+
+ int ret = ftdi_usb_get_strings(d->ftdi, d->dev, vendor?ivendor:NULL, 512, description?idesc:NULL, 512, serial?iserial:NULL, 512);
+
+ if (ret < 0)
+ return -1;
+
+ d->vendor = ivendor;
+ d->description = idesc;
+ d->serial = iserial;
+
+ return 1;
}
-int Context::get_strings()
+int Context::get_strings_and_reopen(bool vendor, bool description, bool serial)
{
- // Prepare buffers
- char vendor[512], desc[512], serial[512];
-
- int ret = ftdi_usb_get_strings(d->ftdi, d->dev, vendor, 512, desc, 512, serial, 512);
+ int ret = 0;
- if(ret < 0)
- return -1;
-
- d->vendor = vendor;
- d->description = desc;
- d->serial = serial;
+ if(vendor || description || serial)
+ {
+ if (d->dev == 0)
+ {
+ d->dev = libusb_get_device(d->ftdi->usb_dev);
+ }
- return 1;
+ // Get device strings (closes device)
+ ret=get_strings(vendor, description, serial);
+ if (ret < 0)
+ {
+ d->open = 0;
+ return ret;
+ }
+
+ // Reattach device
+ ret = ftdi_usb_open_dev(d->ftdi, d->dev);
+ d->open = (ret >= 0);
+ }
+
+ return ret;
}
-/*! \fn vendor
- * \fn description
- * \fn serial
- * \brief Device strings properties.
+/*! \brief Device strings properties.
*/
const std::string& Context::vendor()
{
- return d->vendor;
+ if(d->vendor.empty())
+ get_strings_and_reopen(true,false,false);
+ return d->vendor;
}
+/*! \brief Device strings properties.
+ */
const std::string& Context::description()
{
- return d->description;
+ if(d->description.empty())
+ get_strings_and_reopen(false,true,false);
+ return d->description;
}
+/*! \brief Device strings properties.
+ */
const std::string& Context::serial()
{
- return d->serial;
+ if(d->serial.empty())
+ get_strings_and_reopen(false,false,true);
+ return d->serial;
}
void Context::set_context(struct ftdi_context* context)
{
- ftdi_free(d->ftdi);
- d->ftdi = context;
+ ftdi_free(d->ftdi);
+ d->ftdi = context;
}
-void Context::set_usb_device(struct usb_device *dev)
+void Context::set_usb_device(struct libusb_device *dev)
{
- d->dev = dev;
+ d->dev = dev;
}
struct ftdi_context* Context::context()
{
- return d->ftdi;
+ return d->ftdi;
}
class Eeprom::Private
{
- public:
- Private()
- : context(0)
- {}
+public:
+ Private()
+ : context(0)
+ {}
- struct ftdi_eeprom eeprom;
- struct ftdi_context* context;
+ struct ftdi_eeprom eeprom;
+ struct ftdi_context* context;
};
Eeprom::Eeprom(Context* parent)
- : d ( new Private() )
+ : d ( new Private() )
{
- d->context = parent->context();
+ d->context = parent->context();
}
Eeprom::~Eeprom()
{
- delete d;
}
-void Eeprom::init_defaults()
+int Eeprom::init_defaults(char* manufacturer, char *product, char * serial)
{
- return ftdi_eeprom_initdefaults(&d->eeprom);
+ return ftdi_eeprom_initdefaults(d->context, manufacturer, product, serial);
}
-void Eeprom::set_size(int size)
+int Eeprom::chip_id(unsigned int *chipid)
{
- return ftdi_eeprom_setsize(d->context, &d->eeprom, size);
+ return ftdi_read_chipid(d->context, chipid);
}
-int Eeprom::size(unsigned char *eeprom, int maxsize)
+int Eeprom::build(unsigned char *output)
{
- return ftdi_read_eeprom_getsize(d->context, eeprom, maxsize);
+ return ftdi_eeprom_build(d->context);
}
-int Eeprom::chip_id(unsigned int *chipid)
+int Eeprom::read(unsigned char *eeprom)
{
- return ftdi_read_chipid(d->context, chipid);
+ return ftdi_read_eeprom(d->context);
}
-int Eeprom::build(unsigned char *output)
+int Eeprom::write(unsigned char *eeprom)
{
- return ftdi_eeprom_build(&d->eeprom, output);
+ return ftdi_write_eeprom(d->context);
}
-int Eeprom::read(unsigned char *eeprom)
+int Eeprom::read_location(int eeprom_addr, unsigned short *eeprom_val)
{
- return ftdi_read_eeprom(d->context, eeprom);
+ return ftdi_read_eeprom_location(d->context, eeprom_addr, eeprom_val);
}
-int Eeprom::write(unsigned char *eeprom)
+int Eeprom::write_location(int eeprom_addr, unsigned short eeprom_val)
{
- return ftdi_write_eeprom(d->context, eeprom);
+ return ftdi_write_eeprom_location(d->context, eeprom_addr, eeprom_val);
}
int Eeprom::erase()
{
- return ftdi_erase_eeprom(d->context);
+ return ftdi_erase_eeprom(d->context);
}
class List::Private
{
- public:
- Private()
- : list(0)
- {}
+public:
+ Private(struct ftdi_device_list* _devlist)
+ : devlist(_devlist)
+ {}
+
+ ~Private()
+ {
+ if(devlist)
+ ftdi_list_free(&devlist);
+ }
- struct ftdi_device_list* list;
+ std::list<Context> list;
+ struct ftdi_device_list* devlist;
};
List::List(struct ftdi_device_list* devlist)
- : ListBase(), d( new Private() )
+ : d( new Private(devlist) )
{
- if(devlist != 0)
- {
- // Iterate list
- Context* c = 0;
- for(d->list = devlist; d->list != 0; d->list = d->list->next)
- {
- c = new Context();
- c->set_usb_device(d->list->dev);
- push_back(c);
- }
-
- // Store pointer
- d->list = devlist;
- }
+ if (devlist != 0)
+ {
+ // Iterate list
+ for (; devlist != 0; devlist = devlist->next)
+ {
+ Context c;
+ c.set_usb_device(devlist->dev);
+ c.get_strings();
+ d->list.push_back(c);
+ }
+ }
}
List::~List()
{
- // Deallocate instances
- for(iterator it = begin(); it != end(); it++)
- delete *it;
+}
+
+/**
+* Return begin iterator for accessing the contained list elements
+* @return Iterator
+*/
+List::iterator List::begin()
+{
+ return d->list.begin();
+}
+
+/**
+* Return end iterator for accessing the contained list elements
+* @return Iterator
+*/
+List::iterator List::end()
+{
+ return d->list.end();
+}
+
+/**
+* Return begin iterator for accessing the contained list elements
+* @return Const iterator
+*/
+List::const_iterator List::begin() const
+{
+ return d->list.begin();
+}
- // Clear list
- clear();
- ftdi_list_free(&d->list);
+/**
+* Return end iterator for accessing the contained list elements
+* @return Const iterator
+*/
+List::const_iterator List::end() const
+{
+ return d->list.end();
+}
+
+/**
+* Return begin reverse iterator for accessing the contained list elements
+* @return Reverse iterator
+*/
+List::reverse_iterator List::rbegin()
+{
+ return d->list.rbegin();
+}
+
+/**
+* Return end reverse iterator for accessing the contained list elements
+* @return Reverse iterator
+*/
+List::reverse_iterator List::rend()
+{
+ return d->list.rend();
+}
+
+/**
+* Return begin reverse iterator for accessing the contained list elements
+* @return Const reverse iterator
+*/
+List::const_reverse_iterator List::rbegin() const
+{
+ return d->list.rbegin();
+}
- // Delete d-ptr
- delete d;
+/**
+* Return end reverse iterator for accessing the contained list elements
+* @return Const reverse iterator
+*/
+List::const_reverse_iterator List::rend() const
+{
+ return d->list.rend();
+
+}
+
+/**
+* Get number of elements stored in the list
+* @return Number of elements
+*/
+List::ListType::size_type List::size() const
+{
+ return d->list.size();
+}
+
+/**
+* Check if list is empty
+* @return True if empty, false otherwise
+*/
+bool List::empty() const
+{
+ return d->list.empty();
+}
+
+/**
+ * Removes all elements. Invalidates all iterators.
+ * Do it in a non-throwing way and also make
+ * sure we really free the allocated memory.
+ */
+void List::clear()
+{
+ ListType().swap(d->list);
+
+ // Free device list
+ if (d->devlist)
+ {
+ ftdi_list_free(&d->devlist);
+ d->devlist = 0;
+ }
+}
+
+/**
+ * Appends a copy of the element as the new last element.
+ * @param element Value to copy and append
+*/
+void List::push_back(const Context& element)
+{
+ d->list.push_back(element);
+}
+
+/**
+ * Adds a copy of the element as the new first element.
+ * @param element Value to copy and add
+*/
+void List::push_front(const Context& element)
+{
+ d->list.push_front(element);
+}
+
+/**
+ * Erase one element pointed by iterator
+ * @param pos Element to erase
+ * @return Position of the following element (or end())
+*/
+List::iterator List::erase(iterator pos)
+{
+ return d->list.erase(pos);
+}
+
+/**
+ * Erase a range of elements
+ * @param beg Begin of range
+ * @param end End of range
+ * @return Position of the element after the erased range (or end())
+*/
+List::iterator List::erase(iterator beg, iterator end)
+{
+ return d->list.erase(beg, end);
}
-List* List::find_all(int vendor, int product)
+List* List::find_all(Context &context, int vendor, int product)
{
- struct ftdi_device_list* dlist = 0;
- struct ftdi_context ftdi;
- ftdi_init(&ftdi);
- ftdi_usb_find_all(&ftdi, &dlist, vendor, product);
- ftdi_deinit(&ftdi);
- return new List(dlist);
+ struct ftdi_device_list* dlist = 0;
+ ftdi_usb_find_all(context.context(), &dlist, vendor, product);
+ return new List(dlist);
}
}
git://developer.intra2net.com / libftdi / blobdiff