Start point

lib/libftdi/ftdipp/CMakeLists.txt

@@ -0,0 +1,80 @@
+# Check
+set(FTDI_BUILD_CPP False PARENT_SCOPE)
+
+option(FTDIPP "Build C++ binding library libftdi++" ON)
+
+if (FTDIPP)
+
+    if(Boost_FOUND)
+
+        # Includes
+        include_directories(BEFORE ${CMAKE_CURRENT_BINARY_DIR}
+                            ${CMAKE_CURRENT_SOURCE_DIR}
+                            ${CMAKE_SOURCE_DIR}/src)
+
+        include_directories(${Boost_INCLUDE_DIRS})
+
+        # Targets
+        set(cpp_sources   ftdi.cpp)
+        set(cpp_headers   ftdi.hpp)
+
+        set(FTDI_BUILD_CPP True PARENT_SCOPE)
+        message(STATUS "Building libftdi++")
+
+        # Shared library
+        add_library(ftdipp SHARED ${cpp_sources})
+
+        math(EXPR VERSION_FIXUP "${MAJOR_VERSION} + 1")    # Compatiblity with previous releases
+        set_target_properties(ftdipp PROPERTIES VERSION ${VERSION_FIXUP}.${MINOR_VERSION}.0 SOVERSION 2)
+
+        # Static library
+        add_library(ftdipp-static STATIC ${cpp_sources})
+        set_target_properties(ftdipp-static PROPERTIES OUTPUT_NAME "ftdipp")
+
+        # Prevent clobbering each other during the build
+        set_target_properties(ftdipp PROPERTIES CLEAN_DIRECT_OUTPUT 1)
+        set_target_properties(ftdipp-static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
+
+        # Dependencies
+        target_link_libraries(ftdipp ftdi ${LIBUSB_LIBRARIES} ${BOOST_LIBRARIES})
+
+        # Install
+        if(${UNIX})
+            install( TARGETS ftdipp
+                        LIBRARY DESTINATION lib${LIB_SUFFIX}
+                        COMPONENT sharedlibs
+                        )
+            install( TARGETS ftdipp-static
+                        ARCHIVE DESTINATION lib${LIB_SUFFIX}
+                        COMPONENT staticlibs
+                        )
+            install( FILES ${cpp_headers}
+                        DESTINATION include/${PROJECT_NAME}
+                        COMPONENT headers
+                        )
+        endif(${UNIX})
+
+        if(${WIN32})
+            install( TARGETS ftdipp
+                        DESTINATION bin
+                        COMPONENT sharedlibs
+                        )
+            install( TARGETS ftdipp-static
+                        DESTINATION bin
+                        COMPONENT staticlibs
+                        )
+            install( FILES ${cpp_headers}
+                        DESTINATION include/${PROJECT_NAME}
+                        COMPONENT headers
+                        )
+        endif(${WIN32})
+
+    else(Boost_FOUND)
+        message(STATUS "Boost not found, won't build libftdi++")
+    endif(Boost_FOUND)
+
+else(FTDIPP)
+
+    message(STATUS "Not building libftdi++")
+
+endif(FTDIPP)

lib/libftdi/ftdipp/ftdi.cpp

@@ -0,0 +1,632 @@
+/***************************************************************************
+                          ftdi.cpp  -  C++ wraper for libftdi
+                             -------------------
+    begin                : Mon Oct 13 2008
+    copyright            : (C) 2008 by Marek Vavruša
+    email                : opensource@intra2net.com and marek@vavrusa.com
+ ***************************************************************************/
+/*
+Copyright (C) 2008 by Marek Vavruša
+
+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 "ftdi.hpp"
+#include "ftdi_i.h"
+#include "ftdi.h"
+
+namespace Ftdi
+{
+
+class Context::Private
+{
+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() )
+{
+}
+
+/*! \brief Destructor.
+ */
+Context::~Context()
+{
+}
+
+bool Context::is_open()
+{
+    return d->open;
+}
+
+int Context::open(int vendor, int product)
+{
+    // Open device
+    int ret = ftdi_usb_open(d->ftdi, vendor, product);
+
+    if (ret < 0)
+       return ret;
+
+    return get_strings_and_reopen();
+}
+
+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();
+}
+
+int Context::open(const std::string& description)
+{
+    int ret = ftdi_usb_open_string(d->ftdi, description.c_str());
+
+    if (ret < 0)
+       return ret;
+
+    return get_strings_and_reopen();
+}
+
+int Context::open(struct libusb_device *dev)
+{
+    if (dev != 0)
+        d->dev = dev;
+
+    if (d->dev == 0)
+        return -1;
+
+    return get_strings_and_reopen();
+}
+
+int Context::close()
+{
+    d->open = false;
+    d->dev = 0;
+    return ftdi_usb_close(d->ftdi);
+}
+
+int Context::reset()
+{
+    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);
+
+    return ret;
+}
+
+int Context::set_interface(enum ftdi_interface interface)
+{
+    return ftdi_set_interface(d->ftdi, interface);
+}
+
+void Context::set_usb_device(struct libusb_device_handle *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);
+}
+
+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);
+}
+
+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);
+}
+
+int Context::read(unsigned char *buf, int 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);
+}
+
+int Context::read_chunk_size()
+{
+    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);
+}
+
+int Context::set_write_chunk_size(unsigned int 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;
+
+    return chunk;
+}
+
+int Context::set_flow_control(int 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;
+
+    return ftdi_setdtr_rts(d->ftdi, dtr, rts);
+}
+
+int Context::set_dtr(bool state)
+{
+    return ftdi_setdtr(d->ftdi, state);
+}
+
+int Context::set_rts(bool state)
+{
+    return ftdi_setrts(d->ftdi, state);
+}
+
+int Context::set_latency(unsigned char 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 short Context::poll_modem_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);
+}
+
+int Context::set_error_char(unsigned char errorch, unsigned char enable)
+{
+    return ftdi_set_error_char(d->ftdi, errorch, enable);
+}
+
+int Context::set_bitmode(unsigned char bitmask, unsigned char mode)
+{
+    return ftdi_set_bitmode(d->ftdi, bitmask, mode);
+}
+
+int Context::set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode)
+{
+    return ftdi_set_bitmode(d->ftdi, bitmask, mode);
+}
+
+int Context::bitbang_disable()
+{
+    return ftdi_disable_bitbang(d->ftdi);
+}
+
+int Context::read_pins(unsigned char *pins)
+{
+    return ftdi_read_pins(d->ftdi, pins);
+}
+
+char* Context::error_string()
+{
+    return ftdi_get_error_string(d->ftdi);
+}
+
+int Context::get_strings()
+{
+    // 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);
+
+    if (ret < 0)
+        return -1;
+
+    d->vendor = vendor;
+    d->description = desc;
+    d->serial = serial;
+
+    return 1;
+}
+
+int Context::get_strings_and_reopen()
+{
+    if ( d->dev == 0 )
+    {
+        d->dev = libusb_get_device(d->ftdi->usb_dev);
+    }
+
+    // Get device strings (closes device)
+    int ret=get_strings();
+    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;
+}
+
+/*! \brief Device strings properties.
+ */
+const std::string& Context::vendor()
+{
+    return d->vendor;
+}
+
+/*! \brief Device strings properties.
+ */
+const std::string& Context::description()
+{
+    return d->description;
+}
+
+/*! \brief Device strings properties.
+ */
+const std::string& Context::serial()
+{
+    return d->serial;
+}
+
+void Context::set_context(struct ftdi_context* context)
+{
+    ftdi_free(d->ftdi);
+    d->ftdi = context;
+}
+
+void Context::set_usb_device(struct libusb_device *dev)
+{
+    d->dev = dev;
+}
+
+struct ftdi_context* Context::context()
+{
+    return d->ftdi;
+}
+
+class Eeprom::Private
+{
+public:
+    Private()
+            : context(0)
+    {}
+
+    struct ftdi_eeprom eeprom;
+    struct ftdi_context* context;
+};
+
+Eeprom::Eeprom(Context* parent)
+        : d ( new Private() )
+{
+    d->context = parent->context();
+}
+
+Eeprom::~Eeprom()
+{
+}
+
+int Eeprom::init_defaults(char* manufacturer, char *product, char * serial)
+{
+    return ftdi_eeprom_initdefaults(d->context, manufacturer, product, serial);
+}
+
+int Eeprom::chip_id(unsigned int *chipid)
+{
+    return ftdi_read_chipid(d->context, chipid);
+}
+
+int Eeprom::build(unsigned char *output)
+{
+    return ftdi_eeprom_build(d->context);
+}
+
+int Eeprom::read(unsigned char *eeprom)
+{
+    return ftdi_read_eeprom(d->context);
+}
+
+int Eeprom::write(unsigned char *eeprom)
+{
+    return ftdi_write_eeprom(d->context);
+}
+
+int Eeprom::read_location(int eeprom_addr, unsigned short *eeprom_val)
+{
+    return ftdi_read_eeprom_location(d->context, eeprom_addr, eeprom_val);
+}
+
+int Eeprom::write_location(int eeprom_addr, unsigned short eeprom_val)
+{
+    return ftdi_write_eeprom_location(d->context, eeprom_addr, eeprom_val);
+}
+
+int Eeprom::erase()
+{
+    return ftdi_erase_eeprom(d->context);
+}
+
+class List::Private
+{
+public:
+    Private(struct ftdi_device_list* _devlist)
+            : devlist(_devlist)
+    {}
+
+    ~Private()
+    {
+        if(devlist)
+            ftdi_list_free(&devlist);
+    }
+
+    std::list<Context> list;
+    struct ftdi_device_list* devlist;
+};
+
+List::List(struct ftdi_device_list* devlist)
+        : d( new Private(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()
+{
+}
+
+/**
+* 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();
+}
+
+/**
+* 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();
+}
+
+/**
+* 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)
+{
+    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);
+}
+
+}

lib/libftdi/ftdipp/ftdi.hpp

@@ -0,0 +1,217 @@
+/***************************************************************************
+                          ftdi.hpp  -  C++ wrapper for libftdi
+                             -------------------
+    begin                : Mon Oct 13 2008
+    copyright            : (C) 2008 by Marek Vavruša
+    email                : opensource@intra2net.com and marek@vavrusa.com
+ ***************************************************************************/
+/*
+Copyright (C) 2008 by Marek Vavruša
+
+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.
+*/
+#ifndef __libftdi_hpp__
+#define __libftdi_hpp__
+
+#include <list>
+#include <string>
+#include <boost/shared_ptr.hpp>
+#include <ftdi.h>
+
+namespace Ftdi
+{
+
+/* Forward declarations*/
+class List;
+class Eeprom;
+
+/*! \brief FTDI device context.
+ * Represents single FTDI device context.
+ */
+class Context
+{
+    /* Friends */
+    friend class Eeprom;
+    friend class List;
+
+public:
+    /*! \brief Direction flags for flush().
+     */
+    enum Direction
+    {
+        Input,
+        Output
+    };
+
+    /*! \brief Modem control flags.
+     */
+    enum ModemCtl
+    {
+        Dtr,
+        Rts
+    };
+
+    /* Constructor, Destructor */
+    Context();
+    ~Context();
+
+    /* Properties */
+    Eeprom* eeprom();
+    const std::string& vendor();
+    const std::string& description();
+    const std::string& serial();
+
+    /* Device manipulators */
+    bool is_open();
+    int open(struct libusb_device *dev = 0);
+    int open(int vendor, int product);
+    int open(int vendor, int product, const std::string& description, const std::string& serial = std::string(), unsigned int index=0);
+    int open(const std::string& description);
+    int close();
+    int reset();
+    int flush(int mask = Input|Output);
+    int set_interface(enum ftdi_interface interface);
+    void set_usb_device(struct libusb_device_handle *dev);
+
+    /* Line manipulators */
+    int set_baud_rate(int baudrate);
+    int set_line_property(enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity);
+    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);
+
+    /* I/O */
+    int read(unsigned char *buf, int size);
+    int write(unsigned char *buf, int size);
+    int set_read_chunk_size(unsigned int chunksize);
+    int set_write_chunk_size(unsigned int chunksize);
+    int read_chunk_size();
+    int write_chunk_size();
+
+    /* Async IO
+    TODO: should wrap?
+    int writeAsync(unsigned char *buf, int size);
+    void asyncComplete(int wait_for_more);
+    */
+
+    /* Flow control */
+    int set_event_char(unsigned char eventch, unsigned char enable);
+    int set_error_char(unsigned char errorch, unsigned char enable);
+    int set_flow_control(int flowctrl);
+    int set_modem_control(int mask = Dtr|Rts);
+    int set_latency(unsigned char latency);
+    int set_dtr(bool state);
+    int set_rts(bool state);
+
+    unsigned short poll_modem_status();
+    unsigned latency();
+
+    /* BitBang mode */
+    int set_bitmode(unsigned char bitmask, unsigned char mode);
+    int set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode);
+    int bitbang_disable();
+    int read_pins(unsigned char *pins);
+
+    /* Misc */
+    char* error_string();
+
+protected:
+    int get_strings();
+    int get_strings_and_reopen();
+
+    /* Properties */
+    struct ftdi_context* context();
+    void set_context(struct ftdi_context* context);
+    void set_usb_device(struct libusb_device *dev);
+
+private:
+    class Private;
+    boost::shared_ptr<Private> d;
+};
+
+/*! \brief Device EEPROM.
+ */
+class Eeprom
+{
+public:
+    Eeprom(Context* parent);
+    ~Eeprom();
+
+    int init_defaults(char *manufacturer, char* product, char * serial);
+    int chip_id(unsigned int *chipid);
+    int build(unsigned char *output);
+
+    int read(unsigned char *eeprom);
+    int write(unsigned char *eeprom);
+    int read_location(int eeprom_addr, unsigned short *eeprom_val);
+    int write_location(int eeprom_addr, unsigned short eeprom_val);
+    int erase();
+
+private:
+    class Private;
+    boost::shared_ptr<Private> d;
+};
+
+/*! \brief Device list.
+ */
+class List
+{
+public:
+    List(struct ftdi_device_list* devlist = 0);
+    ~List();
+
+    static List* find_all(int vendor, int product);
+
+    /// List type storing "Context" objects
+    typedef std::list<Context> ListType;
+    /// Iterator type for the container
+    typedef ListType::iterator iterator;
+    /// Const iterator type for the container
+    typedef ListType::const_iterator const_iterator;
+    /// Reverse iterator type for the container
+    typedef ListType::reverse_iterator reverse_iterator;
+    /// Const reverse iterator type for the container
+    typedef ListType::const_reverse_iterator const_reverse_iterator;
+
+    iterator begin();
+    iterator end();
+    const_iterator begin() const;
+    const_iterator end() const;
+
+    reverse_iterator rbegin();
+    reverse_iterator rend();
+    const_reverse_iterator rbegin() const;
+    const_reverse_iterator rend() const;
+
+    ListType::size_type size() const;
+    bool empty() const;
+    void clear();
+
+    void push_back(const Context& element);
+    void push_front(const Context& element);
+
+    iterator erase(iterator pos);
+    iterator erase(iterator beg, iterator end);
+
+private:
+    class Private;
+    boost::shared_ptr<Private> d;
+};
+
+}
+
+#endif