OpenLCP/protocol/enttec/dmx-usb-pro/widget.cpp

/*
  widget.cpp

  Copyright (c) 2023 Kevin Matz (kevin.matz@gmail.com)

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
#include "widget.h"

#include <chrono>

namespace ENTTEC {

Widget::Widget()
  : serial_number(0)                // SN# 0 for emulated devices
  , firmware_version(2<<8)          // emulated devices support RDM
  , tx_break_intervals(17)          // 181.4 us by default
  , tx_mab_intervals(10)            // 106.7 us by default
  , tx_rate(40)                     // 40 packets/s, by default
  , usb_mode_(USBunknown)
  , rx_update_mode_(Pro::RxNotifyAlways)
  , token_data_changed_(nullptr)
{
}


Widget::~Widget()
{
  switch (usb_mode_) {
    case USBdevice:
      Widget::halt();
      break;
    case USBhost:
      Widget::close();
      break;
    default:
      break;
  }
}


/**
 * @brief Begin operating as a USB Device
 *
 * The base class method should be called from all inheriting overrides.
 */
void Widget::init()
{
  {
    std::scoped_lock lock(mtx_metadata_);
    usb_mode_ = USBdevice;
  }
  setModeBridge();
}


/**
 * @brief Stop operating as a USB Device
 *
 * The base class method should be called from all inheriting overrides.
 */
void Widget::halt()
{
  std::scoped_lock lock(mtx_metadata_);
  usb_mode_ = USBunknown;
}


/**
 * @brief Begin operating on the USB Host
 *
 * The base class method should be called from all inheriting overrides.
 */
void Widget::open()
{
  if (getSerialNumber(500))                 // check for valid call/response from device
  {
    {
      std::scoped_lock lock(mtx_metadata_);
      usb_mode_ = USBhost;                   // note connected state
    }
    setModeBridge();
    getParameters(0, 500);                  // retrieve widget metadata
  }
}


/**
 * @brief Stop operating on the USB Host
 *
 * The base class method should be called from all inheriting overrides.
 */
void Widget::close()
{
  std::scoped_lock lock(mtx_metadata_);
  usb_mode_ = USBunknown;
}


/**
 * @brief Widget::setModeController
 */
void Widget::setModeController()
{
  sendDmx();
  std::scoped_lock lock(mtx_metadata_);
  token_data_changed_ = onDataChange([this](DMX::Universe*){sendDmx();});
}


/**
 * @brief Widget::setModeBridge
 * @param mode
 */
void Widget::setModeBridge(Pro::DMX_RX_MODE mode)
{
  {
    std::scoped_lock lock(mtx_metadata_);
    token_data_changed_ = nullptr;
    rx_update_mode_ = mode;
  }
  auto msg = std::make_shared<Pro::MsgRecieveDMXOnChange>();
  msg->mode = mode;
  sendMessage(msg);
}


/**
 * @brief Widget::serialNumber
 * @return
 */
uint32_t Widget::serialNumber() const
{
  std::scoped_lock lock(mtx_metadata_);
  return serial_number;
}


/**
 * @brief Widget::firmwareVersion
 * @return
 */
uint16_t Widget::firmwareVersion() const
{
  std::scoped_lock lock(mtx_metadata_);
  return firmware_version;
}


/**
 * @brief Widget::txBreakTime
 * @return
 */
double Widget::txBreakTime() const
{
  std::scoped_lock lock(mtx_metadata_);
  return tx_break_intervals * Pro::DMX_BREAK_INTERVAL;
}


/**
 * @brief Widget::setTxBreakTime
 * @param time
 */
void Widget::setTxBreakTime(double time)
{
  setTxBreakIntervals(time / Pro::DMX_BREAK_INTERVAL);
}


/**
 * @brief Widget::setTxBreakIntervals
 * @param count
 */
void Widget::setTxBreakIntervals(uint8_t count)
{
  count = std::max(count, Pro::DMX_BREAK_MIN);
  count = std::min(count, Pro::DMX_BREAK_MAX);
  std::scoped_lock lock(mtx_metadata_);
  tx_break_intervals = count;
}


/**
   * @brief txMabTime
   * @return
   */
double Widget::txMabTime() const
{
  std::scoped_lock lock(mtx_metadata_);
  return tx_mab_intervals * Pro::DMX_MAB_INTERVAL;
}


/**
 * @brief Widget::setTxMabTime
 * @param time
 */
void Widget::setTxMabTime(double time)
{
  setTxMabIntervals(time / Pro::DMX_MAB_INTERVAL);
}


/**
 * @brief Widget::setTxMabIntervals
 * @param count
 */
void Widget::setTxMabIntervals(uint8_t count)
{
  count = std::max(count, Pro::DMX_MAB_MIN);
  count = std::min(count, Pro::DMX_MAB_MAX);
  std::scoped_lock lock(mtx_metadata_);
  tx_mab_intervals = count;
}


/**
   * @brief txRate
   * @return
   */
uint8_t Widget::txRate() const
{
  std::scoped_lock lock(mtx_metadata_);
  return tx_rate;
}


/**
 * @brief Widget::setTxRate
 * @param rate
 */
void Widget::setTxRate(uint8_t rate)
{
  std::scoped_lock lock(mtx_metadata_);
  tx_rate = std::min(rate, Pro::DMX_RATE_MAX);
}


/**
 * @brief Widget::writeFirmware
 * @param data
 * @param size
 * @return
 */
bool Widget::writeFirmware(const uint8_t *data, const size_t size)
{
  /**
   * While the API documents the message formats, there is little discussion of the
   * implimentation for updating firmware.  As such, do nothing and return false.
   */
  return false;

  // reboot the device into the fw loader
  rebootBootloader();

  auto msg = std::make_shared<Pro::MsgProgramFlashPageRequest>();
  std::future<bool> ftr;
  bool success;
  for (uint i = 0; i < size / sizeof(msg->page);)
  {
    {
      std::scoped_lock lock(mtx_metadata_);
      reply_firmwarePage_ = std::promise<bool>(); // expect a reply to this message
      ftr = reply_firmwarePage_.get_future();
    }
    std::copy(data + (i*sizeof(msg->page)), data + ((i+1)*sizeof(msg->page)), msg->page);
    sendMessage(msg);
    success = ftr.get();
    if (success)
      i++;                                  // page write was successful, do the next.
  }
  return success;
}


/**
 * @brief Widget::routeRxMessage
 * @param msg
 */
void Widget::routeRxMessage(std::shared_ptr<Pro::MessageData> msg)
{
  switch (msg->label) {
    case Pro::OpReprogramFirmware:
      {
        auto data = std::static_pointer_cast<Pro::MsgReprogramFirmware>(msg);
        rxMsgReprogramFirmware(data);
      }
      break;
    case Pro::OpProgramFlashPage:
      {
        switch (usb_mode_) {
        case USBdevice:
          {
            auto data = std::static_pointer_cast<Pro::MsgProgramFlashPageRequest>(msg);
            rxMsgProgramFlashPageRequest(data);
          }
          break;
        case USBhost:
          {
            auto data = std::static_pointer_cast<Pro::MsgProgramFlashPageReply>(msg);
            rxMsgProgramFlashPageReply(data);
          }
          break;
        default:
          break;
        }
      }
      break;
    case Pro::OpGetWidgetParameters:
      {
        switch (usb_mode_) {
        case USBdevice:
        {
          auto data = std::static_pointer_cast<Pro::MsgGetWidgetParametersRequest>(msg);
          rxMsgGetWidgetParametersRequest(data);
        }
        break;
        case USBhost:
        {
          auto data = std::static_pointer_cast<Pro::MsgGetWidgetParametersReply>(msg);
          rxMsgGetWidgetParametersReply(data);
        }
        break;
        default:
          break;
        }
      }
      break;
    case Pro::OpSetWidgetParameters:
      {
        auto data = std::static_pointer_cast<Pro::MsgSetWidgetParametersRequest>(msg);
        rxMsgSetWidgetParametersRequest(data);
      }
      break;
    case Pro::OpRecievedDmxPacket:
      {
        auto data = std::static_pointer_cast<Pro::MsgRecievedDmxPacket>(msg);
        rxMsgRecievedDmxPacket(data);
      }
      break;
    case Pro::OpOutputOnlySendDMX:
      {
        auto data = std::static_pointer_cast<Pro::MsgOutputOnlySendDMX>(msg);
        rxMsgOutputOnlySendDMX(data);
      }
      break;
    case Pro::OpSendRDMData:
      {
        auto data = std::static_pointer_cast<Pro::MsgSendRDMData>(msg);
        rxMsgSendRDMData(data);
      }
      break;
    case Pro::OpRecieveDMXOnChange:
      {
        auto data = std::static_pointer_cast<Pro::MsgRecieveDMXOnChange>(msg);
        rxMsgRecieveDMXOnChange(data);
      }
      break;
    case Pro::OpRecievedDMXChanged:
      {
        auto data = std::static_pointer_cast<Pro::MsgRecievedDMXChanged>(msg);
        rxMsgRecievedDMXChanged(data);
      }
      break;
    case Pro::OpGetWidgetSerial:
      {
        switch (usb_mode_) {
        case USBdevice:
          {
            auto data = std::static_pointer_cast<Pro::MsgGetWidgetSerialRequest>(msg);
            rxMsgGetWidgetSerialRequest(data);
          }
          break;
        case USBhost:
          {
            auto data = std::static_pointer_cast<Pro::MsgGetWidgetSerialReply>(msg);
            rxMsgGetWidgetSerialReply(data);
          }
          break;
        default:
          break;
        }
      }
      break;
    case Pro::OpSendRDMDiscovery:
      {
        auto data = std::static_pointer_cast<Pro::MsgSendRDMDiscovery>(msg);
        rxMsgSendRDMDiscovery(data);
      }
      break;
    default:
      break;
    }
}


/**
 * @brief Widget::sendMessage
 * @param msg
 *
 * The base class method is to discard the message.
 */
void Widget::sendMessage(std::shared_ptr<Pro::MessageData> msg) const
{
  (void)msg;
}


/**
 * @brief Widget::rebootBootloader
 *
 * USB devices should override this method to do something meaningful to their state.
 */
void Widget::rebootBootloader()
{
  switch (usb_mode_) {
  case USBhost:
    {
      auto msg = std::make_shared<Pro::MsgReprogramFirmware>();
      sendMessage(msg);
    }
    break;
  default:
    break;
  }
}


/**
 * @brief Widget::getSerialNumber
 * @param timeout Milliseconds to block while waiting for the device to reply.
 * @return True if the serial number has been updated.
 */
bool Widget::getSerialNumber(int timeout)
{
  auto msg = std::make_shared<Pro::MsgGetWidgetSerialRequest>();
  std::future<bool> ftr;
  {
    std::scoped_lock lock(mtx_metadata_);
    reply_serialNumber_ = std::promise<bool>(); // expect a reply to this message
    ftr = reply_serialNumber_.get_future();
  }

  sendMessage(msg);

  switch (ftr.wait_for(std::chrono::milliseconds(timeout))) {
  case std::future_status::ready:
    return true;
  case std::future_status::timeout:
    return false;
  default:
    return false;
  }
}


/**
 * @brief Widget::getParameters
 * @param user_length
 * @param timeout Milliseconds to block while waiting for the device to reply.
 * @return True if the parameters has been updated.
 */
bool Widget::getParameters(size_t user_length, int timeout)
{
  auto msg = std::make_shared<Pro::MsgGetWidgetParametersRequest>();
  std::future<bool> ftr;
  {
    std::scoped_lock lock(mtx_metadata_);
    reply_parameters_ = std::promise<bool>();       // expect a reply to this message
    ftr = reply_parameters_.get_future();
  }

  msg->size = std::min(user_length, Pro::USER_CONFIGURATION_MAX);
  sendMessage(msg);

  switch (ftr.wait_for(std::chrono::milliseconds(timeout))) {
  case std::future_status::ready:
    return true;
  case std::future_status::timeout:
    return false;
  default:
    return false;
  }
}


/**
 * @brief Widget::setParameters
 */
void Widget::setParameters() const
{
  auto msg = std::make_shared<Pro::MsgSetWidgetParametersRequest>();
  {
    std::scoped_lock lock(mtx_metadata_);
    msg->break_time = tx_break_intervals;
    msg->mab_time = tx_mab_intervals;
    msg->rate = tx_rate;
    msg->user_data = user_configuration;
  }
  sendMessage(msg);
}


/**
 * @brief Widget::sendDmx
 * @param trimmed
 */
void Widget::sendDmx(bool trimmed) const
{
  auto msg = std::make_shared<Pro::MsgOutputOnlySendDMX>();
  msg->data = std::vector<uint8_t>();
  uint16_t l = null_start_data.size() - 1;
  if (trimmed)
    for (l = null_start_data.size() - 1; l > 0 && null_start_data[l] == 0; --l) {};
  {
    std::scoped_lock lock(mtx_data);
    std::copy(null_start_data.begin(), null_start_data.begin() + l + 1, msg->data.begin());
  }
  sendMessage(msg);
}


/**
 * @brief Widget::rxMsgReprogramFirmware
 * @param msg
 */
void Widget::rxMsgReprogramFirmware(std::shared_ptr<Pro::MsgReprogramFirmware>)
{
  rebootBootloader();
}


/**
 * @brief Widget::rxMsgProgramFlashPageRequest
 * @param msg
 */
void Widget::rxMsgProgramFlashPageRequest(std::shared_ptr<Pro::MsgProgramFlashPageRequest> msg)
{
  auto reply = std::make_shared<Pro::MsgProgramFlashPageReply>();
  reply->success = writeFwPage(msg->page);
  sendMessage(reply);
}


/**
 * @brief Widget::rxMsgProgramFlashPageReply
 * @param msg
 */
void Widget::rxMsgProgramFlashPageReply(std::shared_ptr<Pro::MsgProgramFlashPageReply> msg)
{
  reply_firmwarePage_.set_value(msg->success);
}


/**
 * @brief Widget::rxMsgGetWidgetParametersRequest
 * @param msg
 */
void Widget::rxMsgGetWidgetParametersRequest(std::shared_ptr<Pro::MsgGetWidgetParametersRequest> msg)
{
  auto reply = std::make_shared<Pro::MsgGetWidgetParametersReply>();
  {
    std::scoped_lock lock(mtx_metadata_);
    reply->break_time = tx_break_intervals;
    reply->mab_time = tx_mab_intervals;
    reply->rate = tx_rate;
    reply->user_data = std::vector<uint8_t>(user_configuration);
  }
  reply->user_data.resize(msg->size, 0);

  sendMessage(reply);
}


/**
 * @brief Widget::rxMsgGetWidgetParametersReply
 * @param msg
 *
 * No sanity checking is performed on the values in the reply.
 */
void Widget::rxMsgGetWidgetParametersReply(std::shared_ptr<Pro::MsgGetWidgetParametersReply> msg)
{
  std::scoped_lock lock(mtx_metadata_);
  firmware_version = msg->version;
  tx_break_intervals = msg->break_time;
  tx_mab_intervals = msg->mab_time;
  tx_rate = msg->rate;
  user_configuration = std::vector<uint8_t>(msg->user_data);
}


/**
 * @brief Widget::rxMsgSetWidgetParametersRequest
 * @param msg
 */
void Widget::rxMsgSetWidgetParametersRequest(std::shared_ptr<Pro::MsgSetWidgetParametersRequest> msg)
{
  std::scoped_lock lock(mtx_metadata_);
  setTxBreakIntervals(msg->break_time);
  setTxMabIntervals(msg->mab_time);
  setTxRate(msg->rate);
  user_configuration = std::vector<uint8_t>(msg->user_data);
}


/**
 * @brief Widget::rxMsgRecievedDmxPacket
 * @param msg
 */
void Widget::rxMsgRecievedDmxPacket(std::shared_ptr<Pro::MsgRecievedDmxPacket> msg)
{
  switch (msg->data[0]) {
  case DMX::E111_NULL_START:
    setData(msg->data);
    break;
  default:
    setAltData(msg->data);
    break;
  }
}


/**
 * @brief Widget::rxMsgOutputOnlySendDMX
 * @param msg
 */
void Widget::rxMsgOutputOnlySendDMX(std::shared_ptr<Pro::MsgOutputOnlySendDMX> msg)
{
  switch (msg->data[0]) {
  case DMX::E111_NULL_START:
    setData(msg->data);
    break;
  default:
    break;
  }
}


/**
 * @brief Widget::rxMsgSendRDMData
 * @param msg
 */
void Widget::rxMsgSendRDMData(std::shared_ptr<Pro::MsgSendRDMData> msg)
{
  (void)msg;
}


/**
 * @brief Widget::rxMsgRecieveDMXOnChange
 * @param msg
 */
void Widget::rxMsgRecieveDMXOnChange(std::shared_ptr<Pro::MsgRecieveDMXOnChange> msg)
{
  setData(std::vector<uint8_t>(DMX::E111_LAST_SLOT+1, 0));      // clear dimmer data
  std::scoped_lock lock(mtx_metadata_);
  rx_update_mode_ = msg->mode;
}


/**
 * @brief Widget::rxMsgRecievedDMXChanged
 * @param msg
 */
void Widget::rxMsgRecievedDMXChanged(std::shared_ptr<Pro::MsgRecievedDMXChanged> msg)
{
  (void)msg;
}


/**
 * @brief Widget::rxMsgGetWidgetSerialRequest
 * @param msg
 */
void Widget::rxMsgGetWidgetSerialRequest(std::shared_ptr<Pro::MsgGetWidgetSerialRequest>)
{
  auto reply = std::make_shared<Pro::MsgGetWidgetSerialReply>();
  {
    std::scoped_lock lock(mtx_metadata_);
    reply->serial = serial_number;
  }
  sendMessage(reply);
}


/**
 * @brief Widget::rxMsgGetWidgetSerialReply
 * @param msg
 */
void Widget::rxMsgGetWidgetSerialReply(std::shared_ptr<Pro::MsgGetWidgetSerialReply> msg)
{
  std::scoped_lock lock(mtx_metadata_);
  serial_number = msg->serial;
}


/**
 * @brief Widget::rxMsgSendRDMDiscovery
 * @param msg
 */
void Widget::rxMsgSendRDMDiscovery(std::shared_ptr<Pro::MsgSendRDMDiscovery> msg)
{
  (void)msg;
}


} // namespace ENTTEC