Initial SPI Slave implementation and examples (#2234)

* Initial SPI Slave implementation and examples

* Update style and info

libraries/SPISlave/src/SPISlave.cpp

@@ -0,0 +1,103 @@
+/*
+  SPISlave library for esp8266
+
+  Copyright (c) 2015 Hristo Gochkov. All rights reserved.
+  This file is part of the esp8266 core for Arduino environment.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+#include "SPISlave.h"
+extern "C" {
+#include "hspi_slave.h"
+}
+
+void SPISlaveClass::_data_rx(uint8_t * data, uint8_t len)
+{
+    if(_data_cb) {
+        _data_cb(data, len);
+    }
+}
+void SPISlaveClass::_status_rx(uint32_t data)
+{
+    if(_status_cb) {
+        _status_cb(data);
+    }
+}
+void SPISlaveClass::_data_tx(void)
+{
+    if(_data_sent_cb) {
+        _data_sent_cb();
+    }
+}
+void SPISlaveClass::_status_tx(void)
+{
+    if(_status_sent_cb) {
+        _status_sent_cb();
+    }
+}
+void SPISlaveClass::_s_data_rx(void *arg, uint8_t * data, uint8_t len)
+{
+    reinterpret_cast<SPISlaveClass*>(arg)->_data_rx(data,len);
+}
+void SPISlaveClass::_s_status_rx(void *arg, uint32_t data)
+{
+    reinterpret_cast<SPISlaveClass*>(arg)->_status_rx(data);
+}
+void SPISlaveClass::_s_data_tx(void *arg)
+{
+    reinterpret_cast<SPISlaveClass*>(arg)->_data_tx();
+}
+void SPISlaveClass::_s_status_tx(void *arg)
+{
+    reinterpret_cast<SPISlaveClass*>(arg)->_status_tx();
+}
+
+void SPISlaveClass::begin()
+{
+    hspi_slave_onData(&_s_data_rx);
+    hspi_slave_onDataSent(&_s_data_tx);
+    hspi_slave_onStatus(&_s_status_rx);
+    hspi_slave_onStatusSent(&_s_status_tx);
+    hspi_slave_begin(4, this);
+}
+void SPISlaveClass::setData(uint8_t * data, size_t len)
+{
+    if(len > 32) {
+        len = 32;
+    }
+    hspi_slave_setData(data, len);
+}
+void SPISlaveClass::setStatus(uint32_t status)
+{
+    hspi_slave_setStatus(status);
+}
+void SPISlaveClass::onData(SpiSlaveDataHandler cb)
+{
+    _data_cb = cb;
+}
+void SPISlaveClass::onDataSent(SpiSlaveSentHandler cb)
+{
+    _data_sent_cb = cb;
+}
+void SPISlaveClass::onStatus(SpiSlaveStatusHandler cb)
+{
+    _status_cb = cb;
+}
+void SPISlaveClass::onStatusSent(SpiSlaveSentHandler cb)
+{
+    _status_sent_cb = cb;
+}
+
+SPISlaveClass SPISlave;

libraries/SPISlave/src/SPISlave.h

@@ -0,0 +1,69 @@
+/*
+  SPISlave library for esp8266
+
+  Copyright (c) 2015 Hristo Gochkov. All rights reserved.
+  This file is part of the esp8266 core for Arduino environment.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+#ifndef _SPISLAVE_H_INCLUDED
+#define _SPISLAVE_H_INCLUDED
+
+#include "Arduino.h"
+#include <functional>
+
+typedef std::function<void(uint8_t *data, size_t len)> SpiSlaveDataHandler;
+typedef std::function<void(uint32_t status)> SpiSlaveStatusHandler;
+typedef std::function<void(void)> SpiSlaveSentHandler;
+
+class SPISlaveClass
+{
+protected:
+    SpiSlaveDataHandler _data_cb;
+    SpiSlaveStatusHandler _status_cb;
+    SpiSlaveSentHandler _data_sent_cb;
+    SpiSlaveSentHandler _status_sent_cb;
+    void _data_rx(uint8_t * data, uint8_t len);
+    void _status_rx(uint32_t data);
+    void _data_tx(void);
+    void _status_tx(void);
+    static void _s_data_rx(void *arg, uint8_t * data, uint8_t len);
+    static void _s_status_rx(void *arg, uint32_t data);
+    static void _s_data_tx(void *arg);
+    static void _s_status_tx(void *arg);
+public:
+    SPISlaveClass()
+        : _data_cb(NULL)
+        , _status_cb(NULL)
+        , _data_sent_cb(NULL)
+        , _status_sent_cb(NULL)
+    {}
+    ~SPISlaveClass() {}
+    void begin();
+    void setData(uint8_t * data, size_t len);
+    void setData(const char * data)
+    {
+        setData((uint8_t *)data, strlen(data));
+    }
+    void setStatus(uint32_t status);
+    void onData(SpiSlaveDataHandler cb);
+    void onDataSent(SpiSlaveSentHandler cb);
+    void onStatus(SpiSlaveStatusHandler cb);
+    void onStatusSent(SpiSlaveSentHandler cb);
+};
+
+extern SPISlaveClass SPISlave;
+
+#endif

libraries/SPISlave/src/hspi_slave.c

@@ -0,0 +1,143 @@
+/*
+  SPISlave library for esp8266
+
+  Copyright (c) 2015 Hristo Gochkov. All rights reserved.
+  This file is part of the esp8266 core for Arduino environment.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+#include "hspi_slave.h"
+#include "esp8266_peri.h"
+#include "ets_sys.h"
+
+static void (*_hspi_slave_rx_data_cb)(void * arg, uint8_t * data, uint8_t len) = NULL;
+static void (*_hspi_slave_tx_data_cb)(void * arg) = NULL;
+static void (*_hspi_slave_rx_status_cb)(void * arg, uint32_t data) = NULL;
+static void (*_hspi_slave_tx_status_cb)(void * arg) = NULL;
+static uint8_t _hspi_slave_buffer[33];
+
+void ICACHE_RAM_ATTR _hspi_slave_isr_handler(void *arg)
+{
+    uint32_t status;
+    uint32_t istatus;
+
+    istatus = SPIIR;
+
+    if(istatus & (1 << SPII1)) { //SPI1 ISR
+        status = SPI1S;
+        SPI1S &= ~(0x3E0);//disable interrupts
+        SPI1S |= SPISSRES;//reset
+        SPI1S &= ~(0x1F);//clear interrupts
+        SPI1S |= (0x3E0);//enable interrupts
+
+        if((status & SPISRBIS) != 0 && (_hspi_slave_tx_data_cb)) {
+            _hspi_slave_tx_data_cb(arg);
+        }
+        if((status & SPISRSIS) != 0 && (_hspi_slave_tx_status_cb)) {
+            _hspi_slave_tx_status_cb(arg);
+        }
+        if((status & SPISWSIS) != 0 && (_hspi_slave_rx_status_cb)) {
+            uint32_t s = SPI1WS;
+            _hspi_slave_rx_status_cb(arg, s);
+        }
+        if((status & SPISWBIS) != 0 && (_hspi_slave_rx_data_cb)) {
+            uint8_t i;
+            uint32_t data;
+            uint8_t buffer[33];
+            _hspi_slave_buffer[32] = 0;
+            for(i=0; i<8; i++) {
+                data=SPI1W(i);
+                _hspi_slave_buffer[i<<2] = data & 0xff;
+                _hspi_slave_buffer[(i<<2)+1] = (data >> 8) & 0xff;
+                _hspi_slave_buffer[(i<<2)+2] = (data >> 16) & 0xff;
+                _hspi_slave_buffer[(i<<2)+3] = (data >> 24) & 0xff;
+            }
+            _hspi_slave_rx_data_cb(arg, &_hspi_slave_buffer[0], 32);
+        }
+    } else if(istatus & (1 << SPII0)) { //SPI0 ISR
+        SPI0S &= ~(0x3ff);//clear SPI ISR
+    } else if(istatus & (1 << SPII2)) {} //I2S ISR
+}
+
+void hspi_slave_begin(uint8_t status_len, void * arg)
+{
+    status_len &= 7;
+    if(status_len > 4) {
+        status_len == 4;    //max 32 bits
+    }
+    if(status_len == 0) {
+        status_len == 1;    //min 8 bits
+    }
+
+    pinMode(SS, SPECIAL);
+    pinMode(SCK, SPECIAL);
+    pinMode(MISO, SPECIAL);
+    pinMode(MOSI, SPECIAL);
+
+    SPI1S = SPISE | SPISBE | 0x3E0;
+    SPI1U = SPIUMISOH | SPIUCOMMAND | SPIUSSE;
+    SPI1CLK = 0;
+    SPI1U2 = (7 << SPILCOMMAND);
+    SPI1S1 = (((status_len * 8) - 1) << SPIS1LSTA) | (0xff << SPIS1LBUF) | (7 << SPIS1LWBA) | (7 << SPIS1LRBA) | SPIS1RSTA;
+    SPI1P = (1 << 19);
+    SPI1CMD = SPIBUSY;
+
+    ETS_SPI_INTR_ATTACH(_hspi_slave_isr_handler,arg);
+    ETS_SPI_INTR_ENABLE();
+}
+
+void hspi_slave_setStatus(uint32_t status)
+{
+    SPI1WS = status;
+}
+
+void hspi_slave_setData(uint8_t *data, uint8_t len)
+{
+    uint8_t i;
+    uint32_t out = 0;
+    uint8_t bi = 0;
+    uint8_t wi = 8;
+
+    for(i=0; i<32; i++) {
+        out |= (i<len)?(data[i] << (bi * 8)):0;
+        bi++;
+        bi &= 3;
+        if(!bi) {
+            SPI1W(wi) = out;
+            out = 0;
+            wi++;
+        }
+    }
+}
+
+void hspi_slave_onData(void (*rxd_cb)(void *, uint8_t *, uint8_t))
+{
+    _hspi_slave_rx_data_cb = rxd_cb;
+}
+
+void hspi_slave_onDataSent(void (*txd_cb)(void *))
+{
+    _hspi_slave_tx_data_cb = txd_cb;
+}
+
+void hspi_slave_onStatus(void (*rxs_cb)(void *, uint32_t))
+{
+    _hspi_slave_rx_status_cb = rxs_cb;
+}
+
+void hspi_slave_onStatusSent(void (*txs_cb)(void *))
+{
+    _hspi_slave_tx_status_cb = txs_cb;
+}

libraries/SPISlave/src/hspi_slave.h

@@ -0,0 +1,41 @@
+/*
+  SPISlave library for esp8266
+
+  Copyright (c) 2015 Hristo Gochkov. All rights reserved.
+  This file is part of the esp8266 core for Arduino environment.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+#ifndef _HSPISLAVE_H_INCLUDED
+#define _HSPISLAVE_H_INCLUDED
+
+#include "Arduino.h"
+
+//Start SPI SLave
+void hspi_slave_begin(uint8_t status_len, void * arg);
+
+//set the status register so the master can read it
+void hspi_slave_setStatus(uint32_t status);
+
+//set the data registers (max 32 bytes at a time)
+void hspi_slave_setData(uint8_t *data, uint8_t len);
+
+//set the callbacks
+void hspi_slave_onData(void (*rxd_cb)(void *, uint8_t *, uint8_t));
+void hspi_slave_onDataSent(void (*txd_cb)(void *));
+void hspi_slave_onStatus(void (*rxs_cb)(void *, uint32_t));
+void hspi_slave_onStatusSent(void (*txs_cb)(void *));
+
+#endif