WIZ5500.h

Go to the documentation of this file.

/* Copyright (c) 2023 Skyward Experimental Rocketry
 * Author: Davide Mor
 *
 * 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.
 */
 
#pragma once
 
#include <ActiveObject.h>
#include <drivers/spi/SPIDriver.h>
#include <miosix.h>
 
#include <functional>
#include <iomanip>
 
namespace Boardcore
{
 
struct WizIp
{
    uint8_t a, b, c, d;
 
    WizIp() = default;
 
    constexpr WizIp(uint8_t a, uint8_t b, uint8_t c, uint8_t d)
        : a{a}, b{b}, c{c}, d{d}
    {
    }
 
    constexpr explicit WizIp(uint32_t ip)
        : a{static_cast<uint8_t>((ip >> 24) & 0xFF)},
          b{static_cast<uint8_t>((ip >> 16) & 0xFF)},
          c{static_cast<uint8_t>((ip >> 8) & 0xFF)},
          d{static_cast<uint8_t>(ip & 0xFF)}
    {
    }
 
    constexpr explicit operator uint32_t() const
    {
        return a << 24 | b << 16 | c << 8 | d;
    }
};
 
struct WizMac
{
    uint8_t a, b, c, d, e, f;
};
 
class Wiz5500
{
public:
    struct PhyState
    {
        bool full_duplex;  //< True if full duplex is enabled, false if link is
                           // only half duplex.
        bool based_100mbps;  //< True if 100Mbps, false if only 10Mpbs.
        bool link_up;        //< True if link is up, false if it is down.
    };
 
    using OnIpConflictCb      = std::function<void()>;
    using OnDestUnreachableCb = std::function<void(WizIp, uint16_t)>;
 
    Wiz5500(SPIBus& bus, miosix::GpioPin cs, miosix::GpioPin intn,
            SPI::ClockDivider clock_divider);
    ~Wiz5500();
 
    void setOnIpConflict(OnIpConflictCb cb);
 
    void setOnDestUnreachable(OnDestUnreachableCb cb);
 
    bool checkVersion();
 
    PhyState getPhyState();
 
    void reset();
 
    void handleINTn();
 
    void setGatewayIp(WizIp ip);
 
    void setSubnetMask(WizIp mask);
 
    void setSourceMac(WizMac mac);
 
    void setSourceIp(WizIp ip);
 
    bool connectTcp(int sock_n, uint16_t src_port, WizIp dst_ip,
                    uint16_t dst_port, int timeout = -1);
 
    bool listenTcp(int sock_n, uint16_t src_port, WizIp& dst_ip,
                   uint16_t& dst_port, int timeout = -1);
 
    bool openUdp(int sock_n, uint16_t src_port, WizIp dst_ip, uint16_t dst_port,
                 int timeout = -1);
 
    bool send(int sock_n, const uint8_t* data, size_t len, int timeout = -1);
 
    ssize_t recv(int sock_n, uint8_t* data, size_t len, int timeout = -1);
 
    ssize_t recvfrom(int sock_n, uint8_t* data, size_t len, WizIp& dst_ip,
                     uint16_t& dst_port, int timeout = -1);
 
    void close(int sock_n, int timeout = -1);
 
private:
    static constexpr int NUM_THREAD_WAIT_INFOS = 16;
    static constexpr int NUM_SOCKETS           = 8;
 
    miosix::TimedWaitResult waitForINTn(miosix::Lock<miosix::FastMutex>& l,
                                        long long until);
    int waitForSocketIrq(miosix::Lock<miosix::FastMutex>& l, int sock_n,
                         uint8_t irq_mask, long long until);
 
    miosix::TimedWaitResult runInterruptServiceRoutine(
        miosix::Lock<miosix::FastMutex>& l, long long until);
 
    void spiRead(uint8_t block, uint16_t address, uint8_t* data, size_t len);
    void spiWrite(uint8_t block, uint16_t address, const uint8_t* data,
                  size_t len);
 
    uint8_t spiRead8(uint8_t block, uint16_t address);
    uint16_t spiRead16(uint8_t block, uint16_t address);
    WizIp spiReadIp(uint8_t block, uint16_t address);
    // Avoid stupid linter error
    // WizMac spiReadMac(uint8_t block, uint16_t address);
 
    void spiWrite8(uint8_t block, uint16_t address, uint8_t data);
    void spiWrite16(uint8_t block, uint16_t address, uint16_t data);
    void spiWriteIp(uint8_t block, uint16_t address, WizIp data);
    void spiWriteMac(uint8_t block, uint16_t address, WizMac data);
 
    // Thread currently servicing interrupts
    miosix::Thread* interrupt_service_thread = nullptr;
    // Thread currently waiting for an INTn
    miosix::Thread* intn_thread = nullptr;
 
    struct ThreadWaitInfo
    {
        int sock_n;
        uint8_t irq_mask;
        uint8_t irq;
        miosix::Thread* thread;
    };
 
    enum class SocketMode
    {
        TCP,
        UDP,
        CLOSED
    };
 
    struct SocketInfo
    {
        SocketMode mode;
        int irq_mask;
    };
 
    SocketInfo socket_infos[NUM_SOCKETS];
    ThreadWaitInfo wait_infos[NUM_THREAD_WAIT_INFOS];
 
    OnIpConflictCb on_ip_conflict;
    OnDestUnreachableCb on_dest_unreachable;
 
    miosix::GpioPin intn;
    miosix::FastMutex mutex;
    SPISlave slave;
};
 
}  // namespace Boardcore
 
namespace std
{
inline ostream& operator<<(ostream& os, const Boardcore::WizIp& ip)
{
    auto old_flags = os.flags(os.dec);
    os << (int)ip.a << "." << (int)ip.b << "." << (int)ip.c << "." << (int)ip.d;
    os.flags(old_flags);
    return os;
}
 
inline ostream& operator<<(ostream& os, const Boardcore::WizMac& mac)
{
    auto old_flags = os.flags(os.hex);
    auto old_fill  = os.fill('0');
    os << std::setw(2) << (int)mac.a << ":" << std::setw(2) << (int)mac.b << ":"
       << std::setw(2) << (int)mac.c << ":" << std::setw(2) << (int)mac.d << ":"
       << std::setw(2) << (int)mac.e << ":" << std::setw(2) << (int)mac.f;
    os.flags(old_flags);
    os.fill(old_fill);
    return os;
}
}  // namespace std