Skip to content

A Hardware Hacking Tool with Web-Based CLI That Speaks Every Protocol

add slave mode for spi

Geobb6122fd87df
diff --git a/platformio.ini b/platformio.ini
index c32e2291..d3fdff14 100644
--- a/platformio.ini
+++ b/platformio.ini
@@ -19,7 +19,9 @@ lib_deps =
bblanchon/ArduinoJson@^7.3.0
paulstoffregen/OneWire@^2.3.8
esp32ping
+ hideakitai/ESP32SPISlave@^0.6.8
build_flags =
+ -D CONFIG_TINYUSB_ENABLED=1
-D CONFIG_TINYUSB_CDC_ENABLED=1
-D CONFIG_TINYUSB_HID_ENABLED=1
-D ARDUINO_USB_MODE=1
@@ -73,6 +75,7 @@ lib_deps =
bblanchon/ArduinoJson@^7.3.0
paulstoffregen/OneWire@^2.3.8
esp32ping
+ hideakitai/ESP32SPISlave@^0.6.8
build_flags =
-DDEVICE_M5STICK
diff --git a/src/Config/tusb_config.h b/src/Config/tusb_config.h
new file mode 100644
index 00000000..791ff9e7
--- /dev/null
+++ b/src/Config/tusb_config.h
@@ -0,0 +1,68 @@
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// -----------------------------------------------------------------------------
+// TinyUSB Configuration for ESP32-S3 + Cardputer
+// -----------------------------------------------------------------------------
+
+// ----------------------------
+// USB Root Settings
+// ----------------------------
+
+#define CFG_TUSB_MCU OPT_MCU_ESP32S3
+#define CFG_TUSB_RHPORT0_MODE OPT_MODE_DEVICE
+#define CFG_TUSB_OS OPT_OS_NONE
+
+// ----------------------------
+// USB Buffer Size
+// ----------------------------
+#define CFG_TUD_ENDPOINT0_SIZE 64
+
+// ----------------------------
+// Class Driver Enable Flags
+// ----------------------------
+
+#ifndef CFG_TUD_CDC
+#define CFG_TUD_CDC 1
+#endif
+
+#ifndef CFG_TUD_MSC
+#define CFG_TUD_MSC 1
+#endif
+
+#ifndef CFG_TUD_HID
+#define CFG_TUD_HID 1
+#endif
+
+#ifndef CFG_TUD_AUDIO
+#define CFG_TUD_AUDIO 1
+#endif
+
+// -----------------------------------------------------------------------------
+// AUDIO Configuration (UAC)
+// -----------------------------------------------------------------------------
+
+// Taille totale du descripteur audio (mic + speaker)
+// Peut être ajusté si besoin (macros dispos dans `audio.h`)
+#define TUD_AUDIO_MIC_ONE_CH_DESC_LEN 0x4D
+#define TUD_AUDIO_SPEAKER_ONE_CH_DESC_LEN 0x4D
+
+#define CFG_TUD_AUDIO_FUNC_1_DESC_LEN (TUD_AUDIO_MIC_ONE_CH_DESC_LEN + TUD_AUDIO_SPEAKER_ONE_CH_DESC_LEN)
+
+
+// Nombre d'interfaces audio (2 = micro + speaker)
+#define CFG_TUD_AUDIO_FUNC_1_N_AS_INT 2
+
+// Buffer contrôle (requêtes SET_CUR, etc.)
+#define CFG_TUD_AUDIO_FUNC_1_CTRL_BUF_SZ 64
+
+// Taille maximale des paquets audio IN/OUT
+#define CFG_TUD_AUDIO_EP_SZ_IN 192
+#define CFG_TUD_AUDIO_EP_SZ_OUT 192
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/src/Controllers/SpiController.cpp b/src/Controllers/SpiController.cpp
index 42102cd1..56353a2d 100644
--- a/src/Controllers/SpiController.cpp
+++ b/src/Controllers/SpiController.cpp
@@ -18,6 +18,10 @@ void SpiController::handleCommand(const TerminalCommand& cmd) {
handleSdCard();
}
+ else if(cmd.getRoot() == "slave") {
+ handleSlave();
+ }
+
else if (cmd.getRoot() == "flash") {
if (cmd.getSubcommand() == "probe") {
handleFlashProbe();
@@ -335,20 +339,50 @@ void SpiController::handleFlashErase(const TerminalCommand& cmd) {
}
/*
-Help
+Slave
*/
-void SpiController::handleHelp() {
+void SpiController::handleSlave() {
+#ifdef DEVICE_M5STICK
+ terminalView.println("SPI Slave: Not supported on M5Stick devices due to shared SPI bus.");
+ return;
+#endif
+ spiService.end(); // Stop master mode if active
+
+ int sclk = state.getSpiCLKPin();
+ int miso = state.getSpiMISOPin();
+ int mosi = state.getSpiMOSIPin();
+ int cs = state.getSpiCSPin();
+
+ terminalView.println("SPI Slave: In progress... Press [ENTER] to stop.");
+ spiService.startSlave(sclk, miso, mosi, cs);
+
terminalView.println("");
- terminalView.println("Unknown SPI command. Usage:");
- terminalView.println(" sniff");
- terminalView.println(" sdcard");
- terminalView.println(" flash probe");
- terminalView.println(" flash read <addr> <len>");
- terminalView.println(" flash write <addr> <data>");
- terminalView.println(" flash erase");
- terminalView.println(" config");
- terminalView.println(" raw instructions, e.g: [0x9F r:3]");
+ terminalView.println(" [INFO]");
+ terminalView.println(" SPI Slave mode listens passively on the SPI bus.");
+ terminalView.println(" Any command sent by a SPI master will be captured and logged");
+ terminalView.println(" Data is only captured when CS (chip select) is active.");
terminalView.println("");
+
+ while (true) {
+ char c = terminalInput.readChar();
+ if (c == '\n' || c == '\r') break;
+
+ // Read slave data from master
+ auto packets = spiService.getSlaveData();
+ for (const auto& packet : packets) {
+ std::stringstream ss;
+ ss << "[MOSI] ";
+ for (uint8_t b : packet) {
+ ss << std::hex << std::uppercase << std::setw(2) << std::setfill('0') << (int)b << " ";
+ }
+ terminalView.println(ss.str());
+ }
+ delay(1);
+ }
+
+ spiService.stopSlave(sclk, miso, mosi, cs);
+ spiService.configure(mosi, miso, sclk, cs, state.getI2cFrequency()); // Reconfigure master
+ terminalView.println("SPI Slave: Cancelled by user.");
}
/*
@@ -371,7 +405,7 @@ void SpiController::handleSdCard() {
return;
}
- terminalView.println("SD Card: Mounted successfully.\n");
+ terminalView.println("SD Card: Mounted successfully. Loading...\n");
// Root content
auto elements = sdService.listElements("/");
@@ -392,6 +426,24 @@ void SpiController::handleSdCard() {
sdService.close();
}
+/*
+Help
+*/
+void SpiController::handleHelp() {
+ terminalView.println("");
+ terminalView.println("Unknown SPI command. Usage:");
+ terminalView.println(" sniff");
+ terminalView.println(" sdcard");
+ terminalView.println(" slave");
+ terminalView.println(" flash probe");
+ terminalView.println(" flash read <addr> <len>");
+ terminalView.println(" flash write <addr> <data>");
+ terminalView.println(" flash erase");
+ terminalView.println(" config");
+ terminalView.println(" raw instructions, e.g: [0x9F r:3]");
+ terminalView.println("");
+}
+
/*
Config
*/
diff --git a/src/Controllers/SpiController.h b/src/Controllers/SpiController.h
index 4b24489d..48e23e1c 100644
--- a/src/Controllers/SpiController.h
+++ b/src/Controllers/SpiController.h
@@ -57,6 +57,9 @@ private:
// SD operations
void handleSdCard();
+ // Slave mode
+ void handleSlave();
+
// Configure SPI bus parameters
void handleConfig();
diff --git a/src/Controllers/UartController.cpp b/src/Controllers/UartController.cpp
index bfdc356e..0c137a10 100644
--- a/src/Controllers/UartController.cpp
+++ b/src/Controllers/UartController.cpp
@@ -180,7 +180,7 @@ Scan
void UartController::handleScan() {
terminalView.println("UART Scan: in progress... Press [ENTER] to cancel");
terminalView.println("");
- terminalView.println("[INFOS]");
+ terminalView.println("[INFO]");
terminalView.println(" The UART scanner attempts to detect the correct baudrate");
terminalView.println(" by iteratively switching speeds, sending predefined probes");
terminalView.println("");
diff --git a/src/Controllers/UsbM5StickService.cpp b/src/Controllers/UsbM5StickController.cpp
similarity index 100%
rename from src/Controllers/UsbM5StickService.cpp
rename to src/Controllers/UsbM5StickController.cpp
diff --git a/src/Controllers/UtilityController.cpp b/src/Controllers/UtilityController.cpp
index 37ecb9a8..4ac669d6 100644
--- a/src/Controllers/UtilityController.cpp
+++ b/src/Controllers/UtilityController.cpp
@@ -231,6 +231,7 @@ void UtilityController::handleHelp() {
terminalView.println(" 6. SPI:");
terminalView.println(" sniff - View traffic");
terminalView.println(" sdcard - SD operations");
+ terminalView.println(" slave - Emulate SPI slave");
terminalView.println(" flash probe - Identify chip");
terminalView.println(" flash read <ad> <ln> - Read content");
terminalView.println(" flash write <ad> <d> - Write to flash");
diff --git a/src/Services/SdService.cpp b/src/Services/SdService.cpp
index ba8477ba..bce73e64 100644
--- a/src/Services/SdService.cpp
+++ b/src/Services/SdService.cpp
@@ -17,6 +17,7 @@ bool SdService::configure(uint8_t clkPin, uint8_t misoPin, uint8_t mosiPin, uint
void SdService::close() {
SD.end();
+ sdCardSPI.end();
sdCardMounted = false;
}
diff --git a/src/Services/SpiService.cpp b/src/Services/SpiService.cpp
index d102a2a4..79ae7c8a 100644
--- a/src/Services/SpiService.cpp
+++ b/src/Services/SpiService.cpp
@@ -1,4 +1,5 @@
#include "Services/SpiService.h"
+#include <ESP32SPISlave.h>
void SpiService::configure(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t cs, uint32_t frequency) {
csPin = cs;
@@ -8,6 +9,10 @@ void SpiService::configure(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t cs,
digitalWrite(cs, HIGH);
}
+void SpiService::end() {
+ SPI.end();
+}
+
void SpiService::beginTransaction() {
SPI.beginTransaction(SPISettings(spiFrequency, MSBFIRST, SPI_MODE0));
digitalWrite(csPin, LOW);
@@ -222,3 +227,72 @@ std::string SpiService::executeByteCode(const std::vector<ByteCode>& bytecodes)
return result;
}
+
+// #### SPI SLAVE ######
+
+static ESP32SPISlave spiSlave;
+static constexpr size_t SLAVE_BUFFER_SIZE = 8;
+static std::atomic<bool> slave{false};
+
+static uint8_t slave_tx_buf[SLAVE_BUFFER_SIZE] = {0};
+static uint8_t slave_rx_buf[SLAVE_BUFFER_SIZE] = {0};
+
+static std::deque<std::vector<uint8_t>> slaveBuffer;
+static std::mutex slaveBufferMutex;
+
+void IRAM_ATTR slaveTransactionCallback(spi_slave_transaction_t* trans, void* arg) {
+ // Copy to vector
+ size_t length_bytes = (trans->trans_len + 7) / 8; // trans_len in bits
+ std::vector<uint8_t> received(slave_rx_buf, slave_rx_buf + length_bytes);
+
+ {
+ // Push thread safe
+ std::lock_guard<std::mutex> lock(slaveBufferMutex);
+ slaveBuffer.push_back(std::move(received));
+
+ // Limit
+ if (slaveBuffer.size() > 100) slaveBuffer.pop_front();
+ }
+
+ // Relaunch
+ if (slave) {
+ spiSlave.queue(slave_tx_buf, slave_rx_buf, SLAVE_BUFFER_SIZE);
+ spiSlave.trigger();
+ }
+}
+
+void SpiService::startSlave(int sclk, int miso, int mosi, int cs) {
+ if (slave) return;
+ slave = true;
+
+ if (!slaveConfigured) {
+ spiSlave.setDataMode(SPI_MODE0);
+ spiSlave.setQueueSize(1);
+ spiSlave.setUserPostTransCbAndArg(slaveTransactionCallback, nullptr);
+ spiSlave.begin(FSPI, sclk, miso, mosi, cs);
+ slaveConfigured = true;
+ }
+
+ // First launch then it loops until slave is true
+ spiSlave.queue(slave_tx_buf, slave_rx_buf, SLAVE_BUFFER_SIZE);
+ spiSlave.trigger();
+}
+
+void SpiService::stopSlave(int sclk, int miso, int mosi, int cs) {
+ slave = false;
+ slaveBuffer.clear();
+ memset(slave_rx_buf, 0, SLAVE_BUFFER_SIZE);
+ memset(slave_tx_buf, 0, SLAVE_BUFFER_SIZE);
+ //Calling spiSlave.end() and then reallocate it cause crashes
+}
+
+bool SpiService::isSlave() const {
+ return slave;
+}
+
+std::vector<std::vector<uint8_t>> SpiService::getSlaveData() {
+ std::lock_guard<std::mutex> lock(slaveBufferMutex);
+ std::vector<std::vector<uint8_t>> data(slaveBuffer.begin(), slaveBuffer.end());
+ slaveBuffer.clear();
+ return data;
+}
diff --git a/src/Services/SpiService.h b/src/Services/SpiService.h
index 49e8155f..c229a259 100644
--- a/src/Services/SpiService.h
+++ b/src/Services/SpiService.h
@@ -5,16 +5,21 @@
#include <SPI.h>
#include <Data/FlashDatabase.h>
#include <Models/ByteCode.h>
+#include <atomic>
+#include <M5Unified.h>
+#include <deque>
+#include <mutex>
class SpiService {
public:
void configure(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t cs, uint32_t frequency = 1000000);
+ void end();
void beginTransaction();
void endTransaction();
+ // Flash
uint8_t transfer(uint8_t data);
-
std::string readFlashID();
void readFlashIdRaw(uint8_t* buffer);
void readFlashData(uint32_t address, uint8_t* buffer, size_t length);
@@ -29,8 +34,16 @@ public:
// Write patch, we save a sector data, modify data, erase sector, write modified data to sector
void writeFlashPatch(uint32_t address, const std::vector<uint8_t>& data, uint32_t freq);
+ // Slave
+ void startSlave(int sclk, int miso, int mosi, int cs);
+ void stopSlave(int sclk, int miso, int mosi, int cs);
+ bool isSlave() const;
+ std::vector<std::vector<uint8_t>> getSlaveData();
+
+ // Instructions
std::string executeByteCode(const std::vector<ByteCode>& bytecodes);
private:
uint8_t csPin;
uint32_t spiFrequency = 1000000;
+ bool slaveConfigured = false;
};