SPI.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * SPI.h
 *
 *  Created on: Mar 2, 2016
 *      Author: harry-boe
 *
 */

#pragma once

#include "SPIBase.h"
#include "SPISettings.h"
#include <spi_arch.h>

class SPIClass : public SPIBase
{
public:
    SPIClass();
    SPIClass(const SPIClass&) = delete;
    SPIClass& operator=(const SPIClass&) = delete;

    bool setup(SpiBus id, SpiPins pins = {});

    bool setup(SpiPins pins)
    {
        return setup(SpiBus::DEFAULT, pins);
    }

    bool begin() override;
    void end() override;

    uint8_t read8() override;
    uint32_t transfer32(uint32_t val, uint8_t bits = 32) override;

    using SPIBase::transfer;
    void transfer(uint8_t* buffer, size_t numberBytes) override;

    bool loopback(bool enable) override;

#ifdef ARCH_HOST

    using IoCallback = void (*)(uint16_t c, uint8_t bits, bool read);

    void setDebugIoCallback(IoCallback callback);
#endif

protected:
    void prepare(SPISettings& settings) override;

private:
#ifndef ARCH_ESP8266
    SpiBus busId{SpiBus::DEFAULT};
#endif
#if defined(ARCH_RP2040) || defined(ARCH_HOST)
    uint16_t cr0val{0};
#endif
    bool lsbFirst{false};
};

extern SPIClass SPI;