BaseRobeWidget.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.
 *
 * BaseRobeWidget.h
 * Read and Write to a USB Widget that implements the Robe frame format.
 * Copyright (C) 2011 Simon Newton
 */

#ifndef PLUGINS_USBPRO_BASEROBEWIDGET_H_
#define PLUGINS_USBPRO_BASEROBEWIDGET_H_

#include <stdint.h>
#include "ola/Callback.h"
#include "ola/DmxBuffer.h"
#include "ola/io/Descriptor.h"
#include "plugins/usbpro/SerialWidgetInterface.h"

namespace ola {
namespace plugin {
namespace usbpro {


/*
 * A widget that implements the Robe frame format.
 */
class BaseRobeWidget: public SerialWidgetInterface {
 public:
    explicit BaseRobeWidget(ola::io::ConnectedDescriptor *descriptor);
    virtual ~BaseRobeWidget();

    ola::io::ConnectedDescriptor *GetDescriptor() const {
      return m_descriptor;
    }

    bool SendMessage(uint8_t label,
                     const uint8_t *data,
                     unsigned int length) const;

    static const uint8_t CHANNEL_A_OUT = 0x06;
    static const uint8_t INFO_REQUEST = 0x14;
    static const uint8_t INFO_RESPONSE = 0x15;
    static const uint8_t RDM_DISCOVERY = 0x12;
    static const uint8_t RDM_DISCOVERY_RESPONSE = 0x13;
    static const uint8_t RDM_REQUEST = 0x10;
    static const uint8_t RDM_RESPONSE = 0x11;
    static const uint8_t UID_REQUEST = 0x24;
    static const uint8_t UID_RESPONSE = 0x25;
    static const uint8_t DMX_IN_REQUEST = 0x04;
    static const uint8_t DMX_IN_RESPONSE = 0x05;

 private:
    typedef enum {
      PRE_SOM,
      RECV_PACKET_TYPE,
      RECV_SIZE_LO,
      RECV_SIZE_HI,
      RECV_HEADER_CRC,
      RECV_BODY,
      RECV_CRC,
    } receive_state;

    enum {MAX_DATA_SIZE = 522};

    typedef struct {
      uint8_t som;
      uint8_t packet_type;
      uint8_t len;
      uint8_t len_hi;
      uint8_t header_crc;
    } message_header;

    ola::io::ConnectedDescriptor *m_descriptor;
    receive_state m_state;
    unsigned int m_bytes_received, m_data_size;
    uint8_t m_crc;
    message_header m_header;
    uint8_t m_recv_buffer[MAX_DATA_SIZE];

    void DescriptorReady();
    void ReceiveMessage();
    virtual void HandleMessage(uint8_t label,
                               const uint8_t *data,
                               unsigned int length) = 0;

    static const uint8_t SOM = 0xa5;
    static const unsigned int HEADER_SIZE;
};


/*
 * DispatchingRobeWidget
 */
class DispatchingRobeWidget: public BaseRobeWidget {
 public:
    typedef ola::Callback3<void,
                           uint8_t,
                           const uint8_t*,
                           unsigned int> MessageCallback;
    DispatchingRobeWidget(ola::io::ConnectedDescriptor *descriptor,
                          MessageCallback *callback = NULL)
        : BaseRobeWidget(descriptor),
          m_callback(callback) {
    }

    ~DispatchingRobeWidget() {
      Stop();
    }

    void Stop() {
      if (m_callback)
        delete m_callback;
    }

    void SetHandler(MessageCallback *callback) {
      if (m_callback)
        delete m_callback;
      m_callback = callback;
    }

 private:
    MessageCallback *m_callback;

    void HandleMessage(uint8_t label,
                       const uint8_t *data,
                       unsigned int length) {
      m_callback->Run(label, data, length);
    }
};
}  // namespace usbpro
}  // namespace plugin
}  // namespace ola
#endif  // PLUGINS_USBPRO_BASEROBEWIDGET_H_