/libftdi/libftdi-0.18/ftdipp/ftdi.cpp
C++ | 640 lines | 420 code | 110 blank | 110 comment | 24 complexity | f4f029f65823dc9fd0e558abf20e4936 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.0
- /***************************************************************************
- ftdi.cpp - C++ wraper for libftdi
- -------------------
- begin : Mon Oct 13 2008
- copyright : (C) 2008 by Marek Vavrua
- email : opensource@intra2net.com and marek@vavrusa.com
- ***************************************************************************/
- /*
- Copyright (C) 2008 by Marek Vavrua
- 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.h"
- namespace Ftdi
- {
- class Context::Private
- {
- public:
- Private()
- : ftdi(0), dev(0), open(false)
- {
- ftdi = ftdi_new();
- }
- ~Private()
- {
- if (open)
- ftdi_usb_close(ftdi);
- ftdi_free(ftdi);
- }
- bool open;
- struct ftdi_context* ftdi;
- struct usb_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 usb_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;
- 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 usb_dev_handle *dev)
- {
- ftdi_set_usbdev(d->ftdi, dev);
- d->dev = usb_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::bitbang_enable(unsigned char bitmask)
- {
- return ftdi_set_bitmode(d->ftdi, bitmask, BITMODE_BITBANG);
- }
- int Context::bitbang_disable()
- {
- return ftdi_disable_bitbang(d->ftdi);
- }
- int Context::set_bitmode(unsigned char bitmask, unsigned char mode)
- {
- return set_bitmode(bitmask, mode);
- }
- int Context::set_bitmode(unsigned char bitmask, enum ftdi_mpsse_mode mode)
- {
- return ftdi_set_bitmode(d->ftdi, bitmask, mode);
- }
- 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()
- {
- // 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 usb_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()
- {
- }
- void Eeprom::init_defaults()
- {
- return ftdi_eeprom_initdefaults(&d->eeprom);
- }
- void Eeprom::set_size(int size)
- {
- return ftdi_eeprom_setsize(d->context, &d->eeprom, size);
- }
- int Eeprom::size(unsigned char *eeprom, int maxsize)
- {
- return ftdi_read_eeprom_getsize(d->context, eeprom, maxsize);
- }
- 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->eeprom, output);
- }
- int Eeprom::read(unsigned char *eeprom)
- {
- return ftdi_read_eeprom(d->context, eeprom);
- }
- int Eeprom::write(unsigned char *eeprom)
- {
- return ftdi_write_eeprom(d->context, eeprom);
- }
- 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);
- }
- }