Adafruit_USBD_Device.h

/* 
 * The MIT License (MIT)
 *
 * Copyright (c) 2019 Ha Thach for Adafruit Industries
 *
 * 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.
 */

#ifndef ADAFRUIT_USBD_DEVICE_H_
#define ADAFRUIT_USBD_DEVICE_H_

#include "tusb.h"

class Adafruit_USBD_Interface
{
  protected:
    const char* _desc_str;

  public:
    Adafruit_USBD_Interface(void) { _desc_str = NULL; }

    virtual uint16_t getDescriptor(uint8_t itfnum, uint8_t* buf, uint16_t bufsize) = 0;
    void setStringDescriptor(const char* str) { _desc_str = str; }
    const char* getStringDescriptor(void) { return _desc_str; }
};

class Adafruit_USBD_Device
{
  private:
    enum { STRING_DESCRIPTOR_MAX = 8 };

    tusb_desc_device_t _desc_device;

    uint8_t  *_desc_cfg;
    uint8_t  _desc_cfg_buffer[256];
    uint16_t _desc_cfg_len;
    uint16_t _desc_cfg_maxlen;

    uint8_t  _itf_count;

    uint8_t  _epin_count;
    uint8_t  _epout_count;

    const char* _desc_str_arr[STRING_DESCRIPTOR_MAX];
    uint8_t     _desc_str_count;

  public:
    Adafruit_USBD_Device(void);

    bool addInterface(Adafruit_USBD_Interface& itf);
    void setDescriptorBuffer(uint8_t* buf, uint32_t buflen);

    void setID(uint16_t vid, uint16_t pid);
    void setVersion(uint16_t bcd);
    void setDeviceVersion(uint16_t bcd);

    void setLanguageDescriptor(uint16_t language_id);
    void setManufacturerDescriptor(const char *s);
    void setProductDescriptor(const char *s);

    bool begin(void);

    bool mounted      (void) { return tud_mounted(); }
    bool suspended    (void) { return tud_suspended(); }
    bool ready        (void) { return tud_ready(); }
    bool remoteWakeup (void) { return tud_remote_wakeup(); }

    bool detach       (void); // physical detach by disable pull-up
    bool attach       (void); // physical attach by enable pull-up

    //------------- Platform Dependent APIs -------------//
    uint8_t getSerialDescriptor(uint16_t* serial_str);

  private:
    uint16_t const* descriptor_string_cb(uint8_t index, uint16_t langid);

    friend uint8_t const * tud_descriptor_device_cb(void);
    friend uint8_t const * tud_descriptor_configuration_cb(uint8_t index);
    friend uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid);
};

extern Adafruit_USBD_Device USBDevice;

#endif /* ADAFRUIT_USBD_DEVICE_H_ */