UsbManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * 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 __USBMANAGER_H__
#define __USBMANAGER_H__

#include <stdint.h>
#include <stdio.h>
#include <sam.h>

// extern "C" {
//     #include "cdcdf_acm.h"
// }

#ifdef __cplusplus
extern "C" {
#endif
#include "hpl_usb.h"
#include "cdcdf_acm.h"
#include "cdcdf_acm_desc.h"
#include "hal_usb_device.h"
#include "hri_mclk_e53.h"
#include "hri_gclk_e53.h"
#include "hal_gpio.h"
#include "hri_port_e53.h"
#ifdef __cplusplus
}
#endif
namespace ClearCore {

#ifndef USB_SERIAL_BUFFER_SIZE
#define USB_SERIAL_BUFFER_SIZE 64
#endif

// List of all UsbStatusReg items. Will be used to generate bitfield, enums, and
// masks. Ensures that the three are kept up to date with each other.
#define USB_STATUS_REG_LIST(Func)                                      \
    Func(UnhandledSetupReq)                                            \
    Func(UnhandledDescReq)                                             \
    Func(UnhandledStringReq)                                           \
    Func(UnhandledFeatureReq)                                          \
    Func(FailedStandardSetup)                                          \
    Func(FailedClassSetup)                                             \
    Func(FailedDescriptor)                                             \
    Func(FailedTransferIn)                                             \
    Func(FailedTransferOut)                                            \
    Func(TimeoutRead)                                                  \
    Func(TimeoutWrite)                                                 \
    Func(TimeoutSync)                                                  \
    Func(RamAccessError)                                               \
    Func(FrameNumberCrcError)                                          \
    Func(ReadBufferOverflow)                                           \


// Used to populate the bit fields in a union
#ifdef STRUCTIFY
#undef STRUCTIFY
#endif
#define STRUCTIFY(item) \
uint32_t item  : 1;

// Used to populate the items in a macro
#ifdef ENUMIFY
#undef ENUMIFY
#endif
#define ENUMIFY(item) \
    item,

// Used to generate masks from a previously defined enum.
#ifdef MASKIFY
#undef MASKIFY
#endif
#define MASKIFY(item) \
    const uint32_t   item##Mask = 1UL << item ;

#define MIN(a, b) (((a) < (b)) ? (a) : (b))


#ifndef HIDE_FROM_DOXYGEN

union UsbStatusRegister {
    uint32_t reg;
    struct {
        USB_STATUS_REG_LIST(STRUCTIFY)
    } bit;
};
#endif

#ifndef HIDE_FROM_DOXYGEN

typedef enum {
    USB_STATUS_REG_LIST(ENUMIFY)
    USB_STATUS_REG_FIELD_LAST_ITEM
} UsbStatusRegFields;

#define UNUSED(expr) (void)(expr)

#endif

USB_STATUS_REG_LIST(MASKIFY)



class UsbManager {
    friend class SysManager;
public:
#ifndef HIDE_FROM_DOXYGEN

    static UsbManager &Instance();
#endif

    bool Speed(uint32_t bitsPerSecond);

    uint32_t Speed();

    bool PortIsOpen();

    void PortOpen();
    void PortClose();

    void FlushInput();

    void WaitForWriteFinish();

    int32_t AvailableForRead();

    int32_t AvailableForWrite();

    int16_t CharGet();

    int16_t CharPeek();

    bool SendChar(uint8_t charToSend);

    operator bool();

    const volatile usb_cdc_control_signal_t &LineState() {
        return m_lineState;
    }

    UsbManager();

private:

    void Refresh();

    void RxProc();

    void TxPump();
    static bool CBLineStateChanged(usb_cdc_control_signal_t state);
    static bool TxComplete(const uint8_t ep,
                           const enum usb_xfer_code rc,
                           const uint32_t count);
    static bool RxComplete(const uint8_t ep,
                           const enum usb_xfer_code rc,
                           const uint32_t count);

    void cdc_device_acm_init(void);


    // Serial Buffers
    __attribute__((__aligned__(4))) uint8_t m_bufferIn[USB_SERIAL_BUFFER_SIZE];
    __attribute__((__aligned__(4))) uint8_t m_bufferOut[USB_SERIAL_BUFFER_SIZE];

    __attribute__((__aligned__(4))) uint8_t m_usbReadBuf[USB_SERIAL_BUFFER_SIZE];
    __attribute__((__aligned__(4))) uint8_t m_usbWriteBuf[USB_SERIAL_BUFFER_SIZE];
    // Indices for head and tails of the ring buffers
    volatile uint32_t m_inHead, m_inTail;
    volatile uint32_t m_outHead, m_outTail;

    volatile bool m_sendActive;
    volatile bool m_readActive;
    usb_cdc_control_signal_t m_lineState;
    uint8_t *m_readBufPtr;
    uint32_t m_readBufAvail;

    bool m_portOpen;

    bool Initialize();
    void Reset();
    void RxCopyToRingBuf();
    bool Connected();

}; // UsbManager

} // ClearCore namespace
#endif //__USBMANAGER_H__