EthernetManager.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 __ETHERNETMANAGER_H__
#define __ETHERNETMANAGER_H__

#include <cstring>
#include <sam.h>
#include "EthernetApi.h"
#include "HardwareMapping.h"
#include "IpAddress.h"
#include "Phy.h"
#include "SysUtils.h"
#include "lwip/dhcp.h"
#include "lwip/ip_addr.h"
#include "lwip/netif.h"

namespace ClearCore {

class EthernetManager {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    static EthernetManager &Instance();

    void Initialize();

    void PhyInitialize();

    uint32_t PhyShift(uint32_t phyOp, uint32_t phyReg, uint32_t contents);

    uint32_t PhyRead(uint32_t phyReg);

    uint32_t PhyWrite(uint32_t phyReg, uint32_t contents);
#endif

    volatile const bool &PhyLinkActive() {
        return m_phyLinkUp;
    }

    volatile const bool &PhyRemoteFault() {
        return m_phyRemoteFault;
    }

#ifndef HIDE_FROM_DOXYGEN

    volatile const bool &PhyInitFailed() {
        return m_phyInitFailed;
    }

    void Enable(bool enable);

    bool ReceivedFrameFlag();

    void IrqHandlerPhy();

    void IrqHandlerGmac();
#endif

    uint8_t *MacAddress();

    IpAddress LocalIp();

    void LocalIp(IpAddress ipaddr);

    IpAddress NetmaskIp();

    void NetmaskIp(IpAddress address);

    IpAddress GatewayIp();

    void GatewayIp(IpAddress address);

    IpAddress DnsIp();

    void DnsIp(IpAddress dns);

#ifndef HIDE_FROM_DOXYGEN

    netif *MacInterface() {
        return &m_macInterface;
    }
#endif

    volatile const uint16_t &RetransmissionTimeout() {
        return m_retransmissionTimeout;
    }

    void RetransmissionTimeout(uint8_t timeout) {
        m_retransmissionTimeout = timeout;
    }

    volatile const uint8_t &RetransmissionCount() {
        return m_retransmissionCount;
    }

    void RetransmissionCount(uint8_t count) {
        m_retransmissionCount = count;
    }

    bool DhcpBegin();

    void Setup();

    void Refresh();

    volatile const bool &EthernetActive() {
        return m_ethernetActive;
    }

private:
    // GMAC port/pin combinations
    uint32_t m_portPhyTxen;
    uint32_t m_pinPhyTxen;
    uint32_t m_portPhyTxd0;
    uint32_t m_pinPhyTxd0;
    uint32_t m_portPhyTxd1;
    uint32_t m_pinPhyTxd1;
    uint32_t m_portPhyRxd0;
    uint32_t m_pinPhyRxd0;
    uint32_t m_portPhyRxd1;
    uint32_t m_pinPhyRxd1;
    uint32_t m_portPhyRxer;
    uint32_t m_pinPhyRxer;
    uint32_t m_portPhyRxdv;
    uint32_t m_pinPhyRxdv;
    uint32_t m_portPhyMdio;
    uint32_t m_pinPhyMdio;
    uint32_t m_portPhyMdc;
    uint32_t m_pinPhyMdc;
    uint32_t m_portPhyTxclk;
    uint32_t m_pinPhyTxclk;
    uint32_t m_portPhyInt;
    uint32_t m_pinPhyInt;

    uint32_t m_phyExtInt;
    // PHY link up bit - updated via PHY interrupt
    bool m_phyLinkUp;
    // PHY remote fault bit -- updated via PHY interrupt
    bool m_phyRemoteFault;
    // PHY initialization failed status
    bool m_phyInitFailed;

    // received a frame flag
    bool m_recv;
    // DHCP flag
    bool m_dhcp;
    // Ethernet setup complete flag
    bool m_ethernetActive;

    // Receive Buffer Current Index
    uint8_t m_rxBuffIndex;
    // Transmit Buffer Current Index
    uint16_t m_txBuffIndex;
    // Receive Buffer Descriptor List
    GMAC_RX_DESC m_rxDesc[RX_BUFF_CNT];
    // Transmit Buffer Descriptor List
    GMAC_TX_DESC m_txDesc[TX_BUFF_CNT];
    // Receive Buffers
    uint8_t m_rxBuffer[RX_BUFF_CNT][RX_BUFFER_SIZE];
    // Transmit Buffers
    uint8_t m_txBuffer[TX_BUFF_CNT][TX_BUFFER_SIZE];

    // Blocking retransmission timeout in milliseconds
    uint16_t m_retransmissionTimeout;
    // Number of transmission attempts before giving up
    uint8_t m_retransmissionCount;

    // internal network interface
    ethInt m_ethernetInterface;

    /* Built-in lwIP types.
     */
    // lwIP's network interface
    struct netif m_macInterface;
    // DHCP configuration
    struct dhcp *m_dhcpData;

    void NetifInit();

    void ConfigureGpioPerGmac(uint32_t port, uint32_t pin);

    EthernetManager();

}; // EthernetManager

} // ClearCore namespace

#endif // !__ETHERNETMANAGER_H__