AXP517Tcpc.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include "AXP517Core.hpp"
 
class AXP517Tcpc
{
public:
    explicit AXP517Tcpc(AXP517Core &core) : _core(core) {}
 
    enum Alert : uint16_t {
        AlertCcStatus        = (1u << 0),  
        AlertPowerStatus     = (1u << 1),  
        AlertRxStatus        = (1u << 2),  
        AlertRxHardReset     = (1u << 3),  
        AlertTxFailed        = (1u << 4),  
        AlertTxDiscarded     = (1u << 5),  
        AlertTxSuccess       = (1u << 6),  
        AlertVbusAlarmHi     = (1u << 7),  
        AlertVbusAlarmLo     = (1u << 8),  
        AlertFault           = (1u << 9),  
        AlertRxBufOverflow   = (1u << 10), 
        AlertVbusDisconnect  = (1u << 11), 
        AlertExtendedStatus  = (1u << 13), 
        AlertExtended        = (1u << 14), 
    };
 
    enum class TransmitType : uint8_t {
        SOP = 0,                
        SOP_PRIME = 1,          
        SOP_DPRIME = 2,         
        SOP_DBG_PRIME = 3,      
        SOP_DBG_DPRIME = 4,     
        HARD_RESET = 5,         
        CABLE_RESET = 6,        
        BIST_CARRIER_MODE2 = 7, 
    };
 
    enum class RetryCount : uint8_t {
        R0 = 0, 
        R1 = 1, 
        R2 = 2, 
        R3 = 3, 
    };
 
    enum class CcStatus : uint8_t {
        OPEN = 0, 
        RP_DEF,   
        RP_1_5,   
        RP_3_0,   
    };
 
    struct RxFifoMsg {
        uint8_t byteCount = 0;   
        uint8_t frameType = 0;   
        uint16_t headerLE = 0;   
        uint8_t payload[28] = {0}; 
        uint8_t payloadLen = 0;  
    };
 
    bool init();
 
    bool checkVendorId();
 
    bool readAlert(uint16_t &out);
 
    bool clearAlert(uint16_t maskRw1c);
 
    bool clearAllAlerts()
    {
        return clearAlert(0xFFFF);
    }
 
    bool readFaultStatus(uint8_t &out);
 
    bool clearFaultStatus(uint8_t maskRw1c);
 
    bool clearPmicIrqStatus();
 
    bool writeMessageHeaderInfo(uint8_t v);
 
    bool writeReceiveDetect(uint8_t v);
 
    bool clearTx();
 
    bool setSinkMessageHeaderAndRx();
 
    bool setPolarityFromCc();
 
    bool getCc(CcStatus &cc1, CcStatus &cc2);
 
    bool isAttached();
 
    bool getPowerStatus(uint8_t &status);
 
    bool isVbusPresent();
 
    bool readVbusMv(uint16_t &mv);
 
    bool rxReadMessage(RxFifoMsg &out);
 
    bool txSend(TransmitType type, RetryCount retry, uint16_t headerLE,
                const uint8_t *payload, uint8_t payloadLen);
 
    bool readReg(uint8_t reg, uint8_t &out)
    {
        return r8(reg, out);
    }
 
    bool writeReg(uint8_t reg, uint8_t v)
    {
        return w8(reg, v);
    }
 
    uint32_t millis()
    {
        return _core.millis();
    }
 
    void delayMs(uint32_t ms)
    {
        _core.delayMs(ms);
    }
 
    void pinMode(uint8_t pin, uint8_t mode)
    {
        _core.pinMode(pin, mode);
    }
 
    uint8_t digitalRead(uint8_t pin)
    {
        return _core.digitalRead(pin);
    }
 
private:
    bool r8(uint8_t reg, uint8_t &out);
 
    bool w8(uint8_t reg, uint8_t v);
 
    bool readNoInc(uint8_t reg, uint8_t *buf, uint8_t len);
 
    bool writeNoInc(uint8_t reg, const uint8_t *buf, uint8_t len);
 
private:
    AXP517Core &_core; 
};