FtdiWidget.h

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This class is based on QLCFTDI class from
 *
 * Q Light Controller
 * qlcftdi.h
 *
 * Copyright (C) Heikki Junnila
 *
 * Only standard CPP conversion was changed and function name changed
 * to follow OLA coding standards.
 *
 * by Rui Barreiros
 *
 * Additional modifications to enable support for multiple outputs and
 * additional devices ids did change the original structure.
 *
 * by E.S. Rosenberg a.k.a. Keeper of the Keys 5774/2014
 */

#ifndef PLUGINS_FTDIDMX_FTDIWIDGET_H_
#define PLUGINS_FTDIDMX_FTDIWIDGET_H_

#include <ftdi.h>
#include <stdint.h>
#include <string.h>

#include <string>
#include <vector>

#include "ola/DmxBuffer.h"

namespace ola {
namespace plugin {
namespace ftdidmx {

class FtdiWidgetInfo {
 public:
  static const uint16_t FTDI_VID;
  static const uint16_t FT232_PID;
  static const uint16_t FT4232_PID;

  FtdiWidgetInfo(const std::string &name,
                 const std::string &serial,
                 unsigned int id,
                 const uint16_t vid = FTDI_VID,
                 const uint16_t pid = FT232_PID)
    : m_name(name),
      m_serial(serial),
      m_id(id),
      m_vid(vid),
      m_pid(pid) {
  }

  FtdiWidgetInfo(const FtdiWidgetInfo &info)
    : m_name(info.Name()),
      m_serial(info.Serial()),
      m_id(info.Id()),
      m_vid(info.Vid()),
      m_pid(info.Pid()) {
  }

  ~FtdiWidgetInfo() {}

  std::string Name() const { return m_name; }
  std::string Serial() const { return m_serial; }

  unsigned int Id() const { return m_id; }
  uint16_t Vid() const { return m_vid; }
  uint16_t Pid() const { return m_pid; }

  std::string Description() const {
    return m_name + " with serial number : " + m_serial + " ";
  }

  FtdiWidgetInfo& operator=(const FtdiWidgetInfo &other) {
    if (this != &other) {
      m_name = other.Name();
      m_serial = other.Serial();
      m_id = other.Id();
      m_vid = other.Vid();
      m_pid = other.Pid();
    }
    return *this;
  }

 private:
  std::string m_name;
  std::string m_serial;

  unsigned int m_id;
  uint16_t m_vid;
  uint16_t m_pid;
};

class FtdiWidget {
 public:
  FtdiWidget(const std::string &serial,
             const std::string &name,
             uint32_t id = 0,
             const uint16_t vid = FtdiWidgetInfo::FTDI_VID,
             const uint16_t pid = FtdiWidgetInfo::FT232_PID);

  virtual ~FtdiWidget();

  std::string Serial() const { return m_serial; }

  std::string Name() const { return m_name; }

  uint16_t Vid() const { return m_vid; }
  uint16_t Pid() const { return m_pid; }

  uint32_t Id() const { return m_id; }

  std::string Description() const {
    return m_name + " with serial number : " + m_serial +" ";
  }

  int GetInterfaceCount();

  static void Widgets(std::vector<FtdiWidgetInfo> *widgets);

  // From reading libftdi docs it seems they may reuse error codes, which is
  // why I chose to name this const <lib>_<function>_<error>.
  static const int libftdi_ftdi_usb_get_strings_get_serial_failed = -9;

  static bool m_missing_serial;

 private:
  std::string m_serial;
  std::string m_name;
  uint32_t m_id;
  const uint16_t m_vid;
  const uint16_t m_pid;
};

class FtdiInterface {
 public:
  FtdiInterface(const FtdiWidget * parent,
                const ftdi_interface interface);

  virtual ~FtdiInterface();

  std::string Description() const {
    return m_parent->Description();
  }

  bool SetInterface();

  bool Open();

  bool Close();

  bool IsOpen() const;

  bool Reset();

  bool SetLineProperties();

  bool SetBaudRate(int speed = 250000);

  bool SetFlowControl();

  bool ClearRts();

  bool PurgeBuffers();

  bool SetBreak(bool on);

  bool Write(const ola::DmxBuffer &data);

  bool Read(unsigned char* buff, int size);

  bool SetupOutput();

 private:
  const FtdiWidget * m_parent;
  struct ftdi_context m_handle;
  const ftdi_interface m_interface;
};  // FtdiInterface
}  // namespace ftdidmx
}  // namespace plugin
}  // namespace ola
#endif  // PLUGINS_FTDIDMX_FTDIWIDGET_H_