mirror of
https://github.com/esphome/esphome.git
synced 2025-02-24 05:48:14 +00:00
821c1a8bbd
* making SPI CS optional * CS pin should be declared as optional or required in CONFIG_SCHEMA * changed SPI_DEVICE_SCHEMA to a function, like i2c * added spi_device_schema() to pcd8544, lint fixes * updated max31856 with new spi_device_schema() * cleanup imports Co-authored-by: Ilya Goldberg <iggie@mac.com>
236 lines
8.2 KiB
C++
236 lines
8.2 KiB
C++
#include "spi.h"
|
|
#include "esphome/core/log.h"
|
|
#include "esphome/core/helpers.h"
|
|
#include "esphome/core/application.h"
|
|
|
|
namespace esphome {
|
|
namespace spi {
|
|
|
|
static const char *TAG = "spi";
|
|
|
|
void ICACHE_RAM_ATTR HOT SPIComponent::disable() {
|
|
if (this->hw_spi_ != nullptr) {
|
|
this->hw_spi_->endTransaction();
|
|
}
|
|
if (this->active_cs_) {
|
|
ESP_LOGVV(TAG, "Disabling SPI Chip on pin %u...", this->active_cs_->get_pin());
|
|
this->active_cs_->digital_write(true);
|
|
this->active_cs_ = nullptr;
|
|
}
|
|
}
|
|
void SPIComponent::setup() {
|
|
ESP_LOGCONFIG(TAG, "Setting up SPI bus...");
|
|
this->clk_->setup();
|
|
this->clk_->digital_write(true);
|
|
|
|
bool use_hw_spi = true;
|
|
if (this->clk_->is_inverted())
|
|
use_hw_spi = false;
|
|
const bool has_miso = this->miso_ != nullptr;
|
|
const bool has_mosi = this->mosi_ != nullptr;
|
|
if (has_miso && this->miso_->is_inverted())
|
|
use_hw_spi = false;
|
|
if (has_mosi && this->mosi_->is_inverted())
|
|
use_hw_spi = false;
|
|
int8_t clk_pin = this->clk_->get_pin();
|
|
int8_t miso_pin = has_miso ? this->miso_->get_pin() : -1;
|
|
int8_t mosi_pin = has_mosi ? this->mosi_->get_pin() : -1;
|
|
#ifdef ARDUINO_ARCH_ESP8266
|
|
if (clk_pin == 6 && miso_pin == 7 && mosi_pin == 8) {
|
|
// pass
|
|
} else if (clk_pin == 14 && miso_pin == 12 && mosi_pin == 13) {
|
|
// pass
|
|
} else {
|
|
use_hw_spi = false;
|
|
}
|
|
|
|
if (use_hw_spi) {
|
|
this->hw_spi_ = &SPI;
|
|
this->hw_spi_->pins(clk_pin, miso_pin, mosi_pin, 0);
|
|
this->hw_spi_->begin();
|
|
return;
|
|
}
|
|
#endif
|
|
#ifdef ARDUINO_ARCH_ESP32
|
|
static uint8_t spi_bus_num = 0;
|
|
if (spi_bus_num >= 2) {
|
|
use_hw_spi = false;
|
|
}
|
|
|
|
if (use_hw_spi) {
|
|
if (spi_bus_num == 0) {
|
|
this->hw_spi_ = &SPI;
|
|
} else {
|
|
this->hw_spi_ = new SPIClass(VSPI);
|
|
}
|
|
spi_bus_num++;
|
|
this->hw_spi_->begin(clk_pin, miso_pin, mosi_pin);
|
|
return;
|
|
}
|
|
#endif
|
|
|
|
if (this->miso_ != nullptr) {
|
|
this->miso_->setup();
|
|
}
|
|
if (this->mosi_ != nullptr) {
|
|
this->mosi_->setup();
|
|
this->mosi_->digital_write(false);
|
|
}
|
|
}
|
|
void SPIComponent::dump_config() {
|
|
ESP_LOGCONFIG(TAG, "SPI bus:");
|
|
LOG_PIN(" CLK Pin: ", this->clk_);
|
|
LOG_PIN(" MISO Pin: ", this->miso_);
|
|
LOG_PIN(" MOSI Pin: ", this->mosi_);
|
|
ESP_LOGCONFIG(TAG, " Using HW SPI: %s", YESNO(this->hw_spi_ != nullptr));
|
|
}
|
|
float SPIComponent::get_setup_priority() const { return setup_priority::BUS; }
|
|
|
|
void SPIComponent::debug_tx(uint8_t value) {
|
|
ESP_LOGVV(TAG, " TX 0b" BYTE_TO_BINARY_PATTERN " (0x%02X)", BYTE_TO_BINARY(value), value);
|
|
}
|
|
void SPIComponent::debug_rx(uint8_t value) {
|
|
ESP_LOGVV(TAG, " RX 0b" BYTE_TO_BINARY_PATTERN " (0x%02X)", BYTE_TO_BINARY(value), value);
|
|
}
|
|
void SPIComponent::debug_enable(uint8_t pin) { ESP_LOGVV(TAG, "Enabling SPI Chip on pin %u...", pin); }
|
|
|
|
void SPIComponent::cycle_clock_(bool value) {
|
|
uint32_t start = ESP.getCycleCount();
|
|
while (start - ESP.getCycleCount() < this->wait_cycle_)
|
|
;
|
|
this->clk_->digital_write(value);
|
|
start += this->wait_cycle_;
|
|
while (start - ESP.getCycleCount() < this->wait_cycle_)
|
|
;
|
|
}
|
|
|
|
// NOLINTNEXTLINE
|
|
#pragma GCC optimize("unroll-loops")
|
|
// NOLINTNEXTLINE
|
|
#pragma GCC optimize("O2")
|
|
|
|
template<SPIBitOrder BIT_ORDER, SPIClockPolarity CLOCK_POLARITY, SPIClockPhase CLOCK_PHASE, bool READ, bool WRITE>
|
|
uint8_t HOT SPIComponent::transfer_(uint8_t data) {
|
|
// Clock starts out at idle level
|
|
this->clk_->digital_write(CLOCK_POLARITY);
|
|
uint8_t out_data = 0;
|
|
|
|
for (uint8_t i = 0; i < 8; i++) {
|
|
uint8_t shift;
|
|
if (BIT_ORDER == BIT_ORDER_MSB_FIRST)
|
|
shift = 7 - i;
|
|
else
|
|
shift = i;
|
|
|
|
if (CLOCK_PHASE == CLOCK_PHASE_LEADING) {
|
|
// sampling on leading edge
|
|
if (WRITE) {
|
|
this->mosi_->digital_write(data & (1 << shift));
|
|
}
|
|
|
|
// SAMPLE!
|
|
this->cycle_clock_(!CLOCK_POLARITY);
|
|
|
|
if (READ) {
|
|
out_data |= uint8_t(this->miso_->digital_read()) << shift;
|
|
}
|
|
|
|
this->cycle_clock_(CLOCK_POLARITY);
|
|
} else {
|
|
// sampling on trailing edge
|
|
this->cycle_clock_(!CLOCK_POLARITY);
|
|
|
|
if (WRITE) {
|
|
this->mosi_->digital_write(data & (1 << shift));
|
|
}
|
|
|
|
// SAMPLE!
|
|
this->cycle_clock_(CLOCK_POLARITY);
|
|
|
|
if (READ) {
|
|
out_data |= uint8_t(this->miso_->digital_read()) << shift;
|
|
}
|
|
}
|
|
}
|
|
|
|
#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
|
|
if (WRITE) {
|
|
SPIComponent::debug_tx(data);
|
|
}
|
|
if (READ) {
|
|
SPIComponent::debug_rx(out_data);
|
|
}
|
|
#endif
|
|
|
|
App.feed_wdt();
|
|
|
|
return out_data;
|
|
}
|
|
|
|
// Generate with (py3):
|
|
//
|
|
// from itertools import product
|
|
// bit_orders = ['BIT_ORDER_LSB_FIRST', 'BIT_ORDER_MSB_FIRST']
|
|
// clock_pols = ['CLOCK_POLARITY_LOW', 'CLOCK_POLARITY_HIGH']
|
|
// clock_phases = ['CLOCK_PHASE_LEADING', 'CLOCK_PHASE_TRAILING']
|
|
// reads = [False, True]
|
|
// writes = [False, True]
|
|
// cpp_bool = {False: 'false', True: 'true'}
|
|
// for b, cpol, cph, r, w in product(bit_orders, clock_pols, clock_phases, reads, writes):
|
|
// if not r and not w:
|
|
// continue
|
|
// print(f"template uint8_t SPIComponent::transfer_<{b}, {cpol}, {cph}, {cpp_bool[r]}, {cpp_bool[w]}>(uint8_t
|
|
// data);")
|
|
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_LSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_LEADING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_LOW, CLOCK_PHASE_TRAILING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_LEADING, true, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, false, true>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, true, false>(
|
|
uint8_t data);
|
|
template uint8_t SPIComponent::transfer_<BIT_ORDER_MSB_FIRST, CLOCK_POLARITY_HIGH, CLOCK_PHASE_TRAILING, true, true>(
|
|
uint8_t data);
|
|
|
|
} // namespace spi
|
|
} // namespace esphome
|