mirror of https://github.com/esphome/esphome.git
412 lines
13 KiB
Python
412 lines
13 KiB
Python
import re
|
|
|
|
import esphome.codegen as cg
|
|
import esphome.config_validation as cv
|
|
import esphome.final_validate as fv
|
|
from esphome.components.esp32.const import (
|
|
KEY_ESP32,
|
|
VARIANT_ESP32S2,
|
|
VARIANT_ESP32S3,
|
|
VARIANT_ESP32C2,
|
|
VARIANT_ESP32C3,
|
|
VARIANT_ESP32C6,
|
|
VARIANT_ESP32H2,
|
|
)
|
|
from esphome import pins
|
|
from esphome.const import (
|
|
CONF_CLK_PIN,
|
|
CONF_ID,
|
|
CONF_MISO_PIN,
|
|
CONF_MOSI_PIN,
|
|
CONF_SPI_ID,
|
|
CONF_CS_PIN,
|
|
CONF_NUMBER,
|
|
CONF_INVERTED,
|
|
KEY_CORE,
|
|
KEY_TARGET_PLATFORM,
|
|
KEY_VARIANT,
|
|
CONF_DATA_RATE,
|
|
PLATFORM_ESP32,
|
|
PLATFORM_ESP8266,
|
|
PLATFORM_RP2040,
|
|
CONF_ALLOW_OTHER_USES,
|
|
CONF_DATA_PINS,
|
|
)
|
|
from esphome.core import (
|
|
coroutine_with_priority,
|
|
CORE,
|
|
)
|
|
|
|
CODEOWNERS = ["@esphome/core", "@clydebarrow"]
|
|
spi_ns = cg.esphome_ns.namespace("spi")
|
|
SPIComponent = spi_ns.class_("SPIComponent", cg.Component)
|
|
QuadSPIComponent = spi_ns.class_("QuadSPIComponent", cg.Component)
|
|
SPIDevice = spi_ns.class_("SPIDevice")
|
|
SPIDataRate = spi_ns.enum("SPIDataRate")
|
|
SPIMode = spi_ns.enum("SPIMode")
|
|
|
|
SPI_DATA_RATE_OPTIONS = {
|
|
80e6: SPIDataRate.DATA_RATE_80MHZ,
|
|
40e6: SPIDataRate.DATA_RATE_40MHZ,
|
|
20e6: SPIDataRate.DATA_RATE_20MHZ,
|
|
10e6: SPIDataRate.DATA_RATE_10MHZ,
|
|
8e6: SPIDataRate.DATA_RATE_8MHZ,
|
|
5e6: SPIDataRate.DATA_RATE_5MHZ,
|
|
4e6: SPIDataRate.DATA_RATE_4MHZ,
|
|
2e6: SPIDataRate.DATA_RATE_2MHZ,
|
|
1e6: SPIDataRate.DATA_RATE_1MHZ,
|
|
2e5: SPIDataRate.DATA_RATE_200KHZ,
|
|
75e3: SPIDataRate.DATA_RATE_75KHZ,
|
|
1e3: SPIDataRate.DATA_RATE_1KHZ,
|
|
}
|
|
SPI_DATA_RATE_SCHEMA = cv.All(cv.frequency, cv.enum(SPI_DATA_RATE_OPTIONS))
|
|
|
|
SPI_MODE_OPTIONS = {
|
|
"MODE0": SPIMode.MODE0,
|
|
"MODE1": SPIMode.MODE1,
|
|
"MODE2": SPIMode.MODE2,
|
|
"MODE3": SPIMode.MODE3,
|
|
0: SPIMode.MODE0,
|
|
1: SPIMode.MODE1,
|
|
2: SPIMode.MODE2,
|
|
3: SPIMode.MODE3,
|
|
}
|
|
|
|
CONF_SPI_MODE = "spi_mode"
|
|
CONF_FORCE_SW = "force_sw"
|
|
CONF_INTERFACE = "interface"
|
|
CONF_INTERFACE_INDEX = "interface_index"
|
|
TYPE_SINGLE = "single"
|
|
TYPE_QUAD = "quad"
|
|
|
|
# RP2040 SPI pin assignments are complicated;
|
|
# refer to GPIO function select table in https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf
|
|
|
|
RP_SPI_PINSETS = [
|
|
{
|
|
CONF_MISO_PIN: [0, 4, 16, 20, -1],
|
|
CONF_CLK_PIN: [2, 6, 18, 22],
|
|
CONF_MOSI_PIN: [3, 7, 19, 23, -1],
|
|
},
|
|
{
|
|
CONF_MISO_PIN: [8, 12, 24, 28, -1],
|
|
CONF_CLK_PIN: [10, 14, 26],
|
|
CONF_MOSI_PIN: [11, 15, 27, -1],
|
|
},
|
|
]
|
|
|
|
|
|
def get_target_platform():
|
|
return (
|
|
CORE.data[KEY_CORE][KEY_TARGET_PLATFORM]
|
|
if KEY_TARGET_PLATFORM in CORE.data[KEY_CORE]
|
|
else ""
|
|
)
|
|
|
|
|
|
def get_target_variant():
|
|
return (
|
|
CORE.data[KEY_ESP32][KEY_VARIANT] if KEY_VARIANT in CORE.data[KEY_ESP32] else ""
|
|
)
|
|
|
|
|
|
# Get a list of available hardware interfaces based on target and variant.
|
|
# The returned value is a list of lists of names
|
|
def get_hw_interface_list():
|
|
target_platform = get_target_platform()
|
|
if target_platform == PLATFORM_ESP8266:
|
|
return [["spi", "hspi"]]
|
|
if target_platform == PLATFORM_ESP32:
|
|
if get_target_variant() in [
|
|
VARIANT_ESP32C2,
|
|
VARIANT_ESP32C3,
|
|
VARIANT_ESP32C6,
|
|
VARIANT_ESP32H2,
|
|
]:
|
|
return [["spi", "spi2"]]
|
|
return [["spi", "spi2"], ["spi3"]]
|
|
if target_platform == PLATFORM_RP2040:
|
|
return [["spi"], ["spi1"]]
|
|
return []
|
|
|
|
|
|
# Given an SPI name, return the index of it in the available list
|
|
def get_spi_index(name):
|
|
for i, ilist in enumerate(get_hw_interface_list()):
|
|
if name in ilist:
|
|
return i
|
|
# Should never get to here.
|
|
raise cv.Invalid(f"{name} is not an available SPI")
|
|
|
|
|
|
# Check that pins are suitable for HW spi
|
|
# \param spi the config data for the spi instance
|
|
# \param index the selected hw interface number, -1 if not yet known
|
|
# TODO verify that the pins are internal
|
|
def validate_hw_pins(spi, index=-1):
|
|
clk_pin = spi[CONF_CLK_PIN]
|
|
if clk_pin[CONF_INVERTED]:
|
|
return False
|
|
clk_pin_no = clk_pin[CONF_NUMBER]
|
|
sdo_pin_no = -1
|
|
sdi_pin_no = -1
|
|
if CONF_MOSI_PIN in spi:
|
|
sdo_pin = spi[CONF_MOSI_PIN]
|
|
if sdo_pin[CONF_INVERTED]:
|
|
return False
|
|
sdo_pin_no = sdo_pin[CONF_NUMBER]
|
|
if CONF_MISO_PIN in spi:
|
|
sdi_pin = spi[CONF_MISO_PIN]
|
|
if sdi_pin[CONF_INVERTED]:
|
|
return False
|
|
sdi_pin_no = sdi_pin[CONF_NUMBER]
|
|
|
|
target_platform = get_target_platform()
|
|
if target_platform == PLATFORM_ESP8266:
|
|
if clk_pin_no == 6:
|
|
return sdo_pin_no in (-1, 8) and sdi_pin_no in (-1, 7)
|
|
if clk_pin_no == 14:
|
|
return sdo_pin_no in (-1, 13) and sdi_pin_no in (-1, 12)
|
|
return False
|
|
|
|
if target_platform == PLATFORM_ESP32:
|
|
return clk_pin_no >= 0
|
|
|
|
if target_platform == PLATFORM_RP2040:
|
|
pin_set = (
|
|
list(filter(lambda s: clk_pin_no in s[CONF_CLK_PIN], RP_SPI_PINSETS))[0]
|
|
if index == -1
|
|
else RP_SPI_PINSETS[index]
|
|
)
|
|
if pin_set is None:
|
|
return False
|
|
if sdo_pin_no not in pin_set[CONF_MOSI_PIN]:
|
|
return False
|
|
if sdi_pin_no not in pin_set[CONF_MISO_PIN]:
|
|
return False
|
|
return True
|
|
return False
|
|
|
|
|
|
def get_hw_spi(config, available):
|
|
"""Get an available hardware spi interface suitable for this config"""
|
|
matching = list(filter(lambda idx: validate_hw_pins(config, idx), available))
|
|
if len(matching) != 0:
|
|
return matching[0]
|
|
return None
|
|
|
|
|
|
def validate_spi_config(config):
|
|
available = list(range(len(get_hw_interface_list())))
|
|
for spi in config:
|
|
# map pin number to schema
|
|
spi[CONF_CLK_PIN] = pins.gpio_output_pin_schema(spi[CONF_CLK_PIN])
|
|
interface = spi[CONF_INTERFACE]
|
|
if interface == "software":
|
|
pass
|
|
elif interface == "any":
|
|
if not validate_hw_pins(spi):
|
|
spi[CONF_INTERFACE] = "software"
|
|
elif interface == "hardware":
|
|
index = get_hw_spi(spi, available)
|
|
if index is None:
|
|
raise cv.Invalid("No suitable hardware interface available")
|
|
spi[CONF_INTERFACE_INDEX] = index
|
|
available.remove(index)
|
|
else:
|
|
# Must be a specific name
|
|
index = spi[CONF_INTERFACE_INDEX] = get_spi_index(interface)
|
|
if index not in available:
|
|
raise cv.Invalid(
|
|
f"interface '{interface}' not available here (may be already assigned)"
|
|
)
|
|
available.remove(index)
|
|
|
|
# Second time around:
|
|
# Any specific names and any 'hardware' requests will have already been filled,
|
|
# so just need to assign remaining hardware to 'any' requests.
|
|
for spi in config:
|
|
if spi[CONF_INTERFACE] == "any":
|
|
index = get_hw_spi(spi, available)
|
|
if index is not None:
|
|
spi[CONF_INTERFACE_INDEX] = index
|
|
available.remove(index)
|
|
if CONF_INTERFACE_INDEX in spi and not validate_hw_pins(
|
|
spi, spi[CONF_INTERFACE_INDEX]
|
|
):
|
|
raise cv.Invalid("Invalid pin selections for hardware SPI interface")
|
|
if CONF_DATA_PINS in spi and CONF_INTERFACE_INDEX not in spi:
|
|
raise cv.Invalid("Quad mode requires a hardware interface")
|
|
|
|
return config
|
|
|
|
|
|
# Given an SPI index, convert to a string that represents the C++ object for it.
|
|
def get_spi_interface(index):
|
|
if CORE.using_esp_idf:
|
|
return ["SPI2_HOST", "SPI3_HOST"][index]
|
|
# Arduino code follows
|
|
platform = get_target_platform()
|
|
if platform == PLATFORM_RP2040:
|
|
return ["&SPI", "&SPI1"][index]
|
|
if index == 0:
|
|
return "&SPI"
|
|
# Following code can't apply to C2, H2 or 8266 since they have only one SPI
|
|
if get_target_variant() in (VARIANT_ESP32S3, VARIANT_ESP32S2):
|
|
return "new SPIClass(FSPI)"
|
|
return "new SPIClass(HSPI)"
|
|
|
|
|
|
# Do not use a pin schema for the number, as that will trigger a pin reuse error due to duplication of the
|
|
# clock pin in the standard and quad schemas.
|
|
clk_pin_validator = cv.maybe_simple_value(
|
|
{
|
|
cv.Required(CONF_NUMBER): cv.Any(cv.int_, cv.string),
|
|
cv.Optional(CONF_ALLOW_OTHER_USES): cv.boolean,
|
|
},
|
|
key=CONF_NUMBER,
|
|
)
|
|
|
|
SPI_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(SPIComponent),
|
|
cv.Required(CONF_CLK_PIN): clk_pin_validator,
|
|
cv.Optional(CONF_MISO_PIN): pins.gpio_input_pin_schema,
|
|
cv.Optional(CONF_MOSI_PIN): pins.gpio_output_pin_schema,
|
|
cv.Optional(CONF_FORCE_SW): cv.invalid(
|
|
"force_sw is deprecated - use interface: software"
|
|
),
|
|
cv.Optional(CONF_INTERFACE, default="any"): cv.one_of(
|
|
*sum(get_hw_interface_list(), ["software", "hardware", "any"]),
|
|
lower=True,
|
|
),
|
|
}
|
|
),
|
|
cv.has_at_least_one_key(CONF_MISO_PIN, CONF_MOSI_PIN),
|
|
cv.only_on([PLATFORM_ESP32, PLATFORM_ESP8266, PLATFORM_RP2040]),
|
|
)
|
|
|
|
SPI_QUAD_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(QuadSPIComponent),
|
|
cv.Required(CONF_CLK_PIN): clk_pin_validator,
|
|
cv.Required(CONF_DATA_PINS): cv.All(
|
|
cv.ensure_list(pins.internal_gpio_output_pin_number),
|
|
cv.Length(min=4, max=4),
|
|
),
|
|
cv.Optional(CONF_INTERFACE, default="hardware"): cv.one_of(
|
|
*sum(get_hw_interface_list(), ["hardware"]),
|
|
lower=True,
|
|
),
|
|
}
|
|
),
|
|
cv.only_on([PLATFORM_ESP32]),
|
|
cv.only_with_esp_idf,
|
|
)
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
cv.ensure_list(
|
|
cv.typed_schema(
|
|
{
|
|
TYPE_SINGLE: SPI_SCHEMA,
|
|
TYPE_QUAD: SPI_QUAD_SCHEMA,
|
|
},
|
|
default_type=TYPE_SINGLE,
|
|
)
|
|
),
|
|
validate_spi_config,
|
|
)
|
|
|
|
|
|
@coroutine_with_priority(1.0)
|
|
async def to_code(configs):
|
|
cg.add_define("USE_SPI")
|
|
cg.add_global(spi_ns.using)
|
|
if CORE.using_arduino:
|
|
cg.add_library("SPI", None)
|
|
for spi in configs:
|
|
var = cg.new_Pvariable(spi[CONF_ID])
|
|
await cg.register_component(var, spi)
|
|
clk = await cg.gpio_pin_expression(spi[CONF_CLK_PIN])
|
|
cg.add(var.set_clk(clk))
|
|
if miso := spi.get(CONF_MISO_PIN):
|
|
cg.add(var.set_miso(await cg.gpio_pin_expression(miso)))
|
|
if mosi := spi.get(CONF_MOSI_PIN):
|
|
cg.add(var.set_mosi(await cg.gpio_pin_expression(mosi)))
|
|
if data_pins := spi.get(CONF_DATA_PINS):
|
|
cg.add(var.set_data_pins(data_pins))
|
|
if (index := spi.get(CONF_INTERFACE_INDEX)) is not None:
|
|
interface = get_spi_interface(index)
|
|
cg.add(var.set_interface(cg.RawExpression(interface)))
|
|
cg.add(
|
|
var.set_interface_name(
|
|
re.sub(r"\W", "", interface.replace("new SPIClass", ""))
|
|
)
|
|
)
|
|
|
|
|
|
def spi_device_schema(
|
|
cs_pin_required=True,
|
|
default_data_rate=cv.UNDEFINED,
|
|
default_mode=cv.UNDEFINED,
|
|
quad=False,
|
|
):
|
|
"""Create a schema for an SPI device.
|
|
:param cs_pin_required: If true, make the CS_PIN required in the config.
|
|
:param default_data_rate: Optional data_rate to use as default
|
|
:param default_mode Optional. The default SPI mode to use.
|
|
:param quad If set, will require an SPI component configured as quad data bits.
|
|
:return: The SPI device schema, `extend` this in your config schema.
|
|
"""
|
|
schema = {
|
|
cv.GenerateID(CONF_SPI_ID): cv.use_id(
|
|
QuadSPIComponent if quad else SPIComponent
|
|
),
|
|
cv.Optional(CONF_DATA_RATE, default=default_data_rate): SPI_DATA_RATE_SCHEMA,
|
|
cv.Optional(CONF_SPI_MODE, default=default_mode): cv.enum(
|
|
SPI_MODE_OPTIONS, upper=True
|
|
),
|
|
}
|
|
if cs_pin_required:
|
|
schema[cv.Required(CONF_CS_PIN)] = pins.gpio_output_pin_schema
|
|
else:
|
|
schema[cv.Optional(CONF_CS_PIN)] = pins.gpio_output_pin_schema
|
|
return cv.Schema(schema)
|
|
|
|
|
|
async def register_spi_device(var, config):
|
|
parent = await cg.get_variable(config[CONF_SPI_ID])
|
|
cg.add(var.set_spi_parent(parent))
|
|
if CONF_CS_PIN in config:
|
|
pin = await cg.gpio_pin_expression(config[CONF_CS_PIN])
|
|
cg.add(var.set_cs_pin(pin))
|
|
if CONF_DATA_RATE in config:
|
|
cg.add(var.set_data_rate(config[CONF_DATA_RATE]))
|
|
if CONF_SPI_MODE in config:
|
|
cg.add(var.set_mode(config[CONF_SPI_MODE]))
|
|
|
|
|
|
def final_validate_device_schema(name: str, *, require_mosi: bool, require_miso: bool):
|
|
hub_schema = {}
|
|
if require_miso:
|
|
hub_schema[
|
|
cv.Required(
|
|
CONF_MISO_PIN,
|
|
msg=f"Component {name} requires this spi bus to declare a miso_pin",
|
|
)
|
|
] = cv.valid
|
|
if require_mosi:
|
|
hub_schema[
|
|
cv.Required(
|
|
CONF_MOSI_PIN,
|
|
msg=f"Component {name} requires this spi bus to declare a mosi_pin",
|
|
)
|
|
] = cv.valid
|
|
|
|
return cv.Schema(
|
|
{cv.Required(CONF_SPI_ID): fv.id_declaration_match_schema(hub_schema)},
|
|
extra=cv.ALLOW_EXTRA,
|
|
)
|