23e4a8b64e
The new sx1276 pin configuration helpers can be used by the sx126x
driver as well. Move them to sx126xx_common.{c,h} to facilitate reuse.
Signed-off-by: Andreas Sandberg <andreas@sandberg.pp.se>
559 lines
13 KiB
C
559 lines
13 KiB
C
/*
|
|
* Copyright (c) 2019 Manivannan Sadhasivam
|
|
* Copyright (c) 2020 Grinn
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#define DT_DRV_COMPAT semtech_sx1276
|
|
|
|
#include <drivers/gpio.h>
|
|
#include <drivers/lora.h>
|
|
#include <drivers/spi.h>
|
|
#include <zephyr.h>
|
|
#include "sx12xx_common.h"
|
|
|
|
/* LoRaMac-node specific includes */
|
|
#include <sx1276/sx1276.h>
|
|
|
|
#define LOG_LEVEL CONFIG_LORA_LOG_LEVEL
|
|
#include <logging/log.h>
|
|
LOG_MODULE_REGISTER(sx1276);
|
|
|
|
#define GPIO_RESET_PIN DT_INST_GPIO_PIN(0, reset_gpios)
|
|
#define GPIO_CS_PIN DT_INST_SPI_DEV_CS_GPIOS_PIN(0)
|
|
#define GPIO_CS_FLAGS DT_INST_SPI_DEV_CS_GPIOS_FLAGS(0)
|
|
|
|
#define GPIO_ANTENNA_ENABLE_PIN \
|
|
DT_INST_GPIO_PIN(0, antenna_enable_gpios)
|
|
#define GPIO_RFI_ENABLE_PIN \
|
|
DT_INST_GPIO_PIN(0, rfi_enable_gpios)
|
|
#define GPIO_RFO_ENABLE_PIN \
|
|
DT_INST_GPIO_PIN(0, rfo_enable_gpios)
|
|
#define GPIO_PA_BOOST_ENABLE_PIN \
|
|
DT_INST_GPIO_PIN(0, pa_boost_enable_gpios)
|
|
|
|
#define GPIO_TCXO_POWER_PIN DT_INST_GPIO_PIN(0, tcxo_power_gpios)
|
|
|
|
#if DT_INST_NODE_HAS_PROP(0, tcxo_power_startup_delay_ms)
|
|
#define TCXO_POWER_STARTUP_DELAY_MS \
|
|
DT_INST_PROP(0, tcxo_power_startup_delay_ms)
|
|
#else
|
|
#define TCXO_POWER_STARTUP_DELAY_MS 0
|
|
#endif
|
|
|
|
/*
|
|
* Those macros must be in sync with 'power-amplifier-output' dts property.
|
|
*/
|
|
#define SX1276_PA_RFO 0
|
|
#define SX1276_PA_BOOST 1
|
|
|
|
#if DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios) && \
|
|
DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
#define SX1276_PA_OUTPUT(power) \
|
|
((power) > 14 ? SX1276_PA_BOOST : SX1276_PA_RFO)
|
|
#elif DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios)
|
|
#define SX1276_PA_OUTPUT(power) SX1276_PA_RFO
|
|
#elif DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
#define SX1276_PA_OUTPUT(power) SX1276_PA_BOOST
|
|
#elif DT_INST_NODE_HAS_PROP(0, power_amplifier_output)
|
|
#define SX1276_PA_OUTPUT(power) \
|
|
DT_ENUM_IDX(DT_DRV_INST(0), power_amplifier_output)
|
|
#else
|
|
BUILD_ASSERT(0, "None of rfo-enable-gpios, pa-boost-enable-gpios and "
|
|
"power-amplifier-output has been specified. "
|
|
"Look at semtech,sx1276.yaml to fix that.");
|
|
#endif
|
|
|
|
#define SX1276_REG_PA_CONFIG 0x09
|
|
#define SX1276_REG_PA_DAC 0x4d
|
|
#define SX1276_REG_VERSION 0x42
|
|
|
|
#define SX1276_PA_CONFIG_MAX_POWER_SHIFT 4
|
|
|
|
extern DioIrqHandler *DioIrq[];
|
|
|
|
struct sx1276_dio {
|
|
const char *port;
|
|
gpio_pin_t pin;
|
|
gpio_dt_flags_t flags;
|
|
};
|
|
|
|
/* Helper macro that UTIL_LISTIFY can use and produces an element with comma */
|
|
#define SX1276_DIO_GPIO_ELEM(idx, inst) \
|
|
{ \
|
|
DT_INST_GPIO_LABEL_BY_IDX(inst, dio_gpios, idx), \
|
|
DT_INST_GPIO_PIN_BY_IDX(inst, dio_gpios, idx), \
|
|
DT_INST_GPIO_FLAGS_BY_IDX(inst, dio_gpios, idx), \
|
|
},
|
|
|
|
#define SX1276_DIO_GPIO_INIT(n) \
|
|
UTIL_LISTIFY(DT_INST_PROP_LEN(n, dio_gpios), SX1276_DIO_GPIO_ELEM, n)
|
|
|
|
static const struct sx1276_dio sx1276_dios[] = { SX1276_DIO_GPIO_INIT(0) };
|
|
|
|
#define SX1276_MAX_DIO ARRAY_SIZE(sx1276_dios)
|
|
|
|
static struct sx1276_data {
|
|
struct device *reset;
|
|
#if DT_INST_NODE_HAS_PROP(0, antenna_enable_gpios)
|
|
struct device *antenna_enable;
|
|
#endif
|
|
#if DT_INST_NODE_HAS_PROP(0, rfi_enable_gpios)
|
|
struct device *rfi_enable;
|
|
#endif
|
|
#if DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios)
|
|
struct device *rfo_enable;
|
|
#endif
|
|
#if DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
struct device *pa_boost_enable;
|
|
#endif
|
|
#if DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios) && \
|
|
DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
uint8_t tx_power;
|
|
#endif
|
|
#if DT_INST_NODE_HAS_PROP(0, tcxo_power_gpios)
|
|
struct device *tcxo_power;
|
|
bool tcxo_power_enabled;
|
|
#endif
|
|
struct device *spi;
|
|
struct spi_config spi_cfg;
|
|
struct device *dio_dev[SX1276_MAX_DIO];
|
|
struct k_work dio_work[SX1276_MAX_DIO];
|
|
} dev_data;
|
|
|
|
static int8_t clamp_int8(int8_t x, int8_t min, int8_t max)
|
|
{
|
|
if (x < min) {
|
|
return min;
|
|
} else if (x > max) {
|
|
return max;
|
|
} else {
|
|
return x;
|
|
}
|
|
}
|
|
|
|
bool SX1276CheckRfFrequency(uint32_t frequency)
|
|
{
|
|
/* TODO */
|
|
return true;
|
|
}
|
|
|
|
static inline void sx1276_antenna_enable(int val)
|
|
{
|
|
#if DT_INST_NODE_HAS_PROP(0, antenna_enable_gpios)
|
|
gpio_pin_set(dev_data.antenna_enable, GPIO_ANTENNA_ENABLE_PIN, val);
|
|
#endif
|
|
}
|
|
|
|
static inline void sx1276_rfi_enable(int val)
|
|
{
|
|
#if DT_INST_NODE_HAS_PROP(0, rfi_enable_gpios)
|
|
gpio_pin_set(dev_data.rfi_enable, GPIO_RFI_ENABLE_PIN, val);
|
|
#endif
|
|
}
|
|
|
|
static inline void sx1276_rfo_enable(int val)
|
|
{
|
|
#if DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios)
|
|
gpio_pin_set(dev_data.rfo_enable, GPIO_RFO_ENABLE_PIN, val);
|
|
#endif
|
|
}
|
|
|
|
static inline void sx1276_pa_boost_enable(int val)
|
|
{
|
|
#if DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
gpio_pin_set(dev_data.pa_boost_enable,
|
|
GPIO_PA_BOOST_ENABLE_PIN, val);
|
|
#endif
|
|
}
|
|
|
|
void SX1276SetAntSwLowPower(bool low_power)
|
|
{
|
|
if (low_power) {
|
|
/* force inactive (low power) state of all antenna paths */
|
|
sx1276_rfi_enable(0);
|
|
sx1276_rfo_enable(0);
|
|
sx1276_pa_boost_enable(0);
|
|
|
|
sx1276_antenna_enable(0);
|
|
} else {
|
|
sx1276_antenna_enable(1);
|
|
|
|
/* rely on SX1276SetAntSw() to configure proper antenna path */
|
|
}
|
|
}
|
|
|
|
void SX1276SetBoardTcxo(uint8_t state)
|
|
{
|
|
#if DT_INST_NODE_HAS_PROP(0, tcxo_power_gpios)
|
|
bool enable = state;
|
|
|
|
if (enable == dev_data.tcxo_power_enabled) {
|
|
return;
|
|
}
|
|
|
|
if (enable) {
|
|
gpio_pin_set(dev_data.tcxo_power, GPIO_TCXO_POWER_PIN, 1);
|
|
|
|
if (TCXO_POWER_STARTUP_DELAY_MS > 0) {
|
|
k_sleep(K_MSEC(TCXO_POWER_STARTUP_DELAY_MS));
|
|
}
|
|
} else {
|
|
gpio_pin_set(dev_data.tcxo_power, GPIO_TCXO_POWER_PIN, 0);
|
|
}
|
|
|
|
dev_data.tcxo_power_enabled = enable;
|
|
#endif
|
|
}
|
|
|
|
void SX1276SetAntSw(uint8_t opMode)
|
|
{
|
|
switch (opMode) {
|
|
case RFLR_OPMODE_TRANSMITTER:
|
|
sx1276_rfi_enable(0);
|
|
|
|
if (SX1276_PA_OUTPUT(dev_data.tx_power) == SX1276_PA_BOOST) {
|
|
sx1276_rfo_enable(0);
|
|
sx1276_pa_boost_enable(1);
|
|
} else {
|
|
sx1276_pa_boost_enable(0);
|
|
sx1276_rfo_enable(1);
|
|
}
|
|
break;
|
|
default:
|
|
sx1276_rfo_enable(0);
|
|
sx1276_pa_boost_enable(0);
|
|
sx1276_rfi_enable(1);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void SX1276Reset(void)
|
|
{
|
|
SX1276SetBoardTcxo(true);
|
|
|
|
gpio_pin_set(dev_data.reset, GPIO_RESET_PIN, 1);
|
|
|
|
k_sleep(K_MSEC(1));
|
|
|
|
gpio_pin_set(dev_data.reset, GPIO_RESET_PIN, 0);
|
|
|
|
k_sleep(K_MSEC(6));
|
|
}
|
|
|
|
static void sx1276_dio_work_handle(struct k_work *work)
|
|
{
|
|
int dio = work - dev_data.dio_work;
|
|
|
|
(*DioIrq[dio])(NULL);
|
|
}
|
|
|
|
static void sx1276_irq_callback(struct device *dev,
|
|
struct gpio_callback *cb, uint32_t pins)
|
|
{
|
|
unsigned int i, pin;
|
|
|
|
pin = find_lsb_set(pins) - 1;
|
|
|
|
for (i = 0; i < SX1276_MAX_DIO; i++) {
|
|
if (dev == dev_data.dio_dev[i] &&
|
|
pin == sx1276_dios[i].pin) {
|
|
k_work_submit(&dev_data.dio_work[i]);
|
|
}
|
|
}
|
|
}
|
|
|
|
void SX1276IoIrqInit(DioIrqHandler **irqHandlers)
|
|
{
|
|
unsigned int i;
|
|
static struct gpio_callback callbacks[SX1276_MAX_DIO];
|
|
|
|
/* Setup DIO gpios */
|
|
for (i = 0; i < SX1276_MAX_DIO; i++) {
|
|
if (!irqHandlers[i]) {
|
|
continue;
|
|
}
|
|
|
|
dev_data.dio_dev[i] = device_get_binding(sx1276_dios[i].port);
|
|
if (dev_data.dio_dev[i] == NULL) {
|
|
LOG_ERR("Cannot get pointer to %s device",
|
|
sx1276_dios[i].port);
|
|
return;
|
|
}
|
|
|
|
k_work_init(&dev_data.dio_work[i], sx1276_dio_work_handle);
|
|
|
|
gpio_pin_configure(dev_data.dio_dev[i], sx1276_dios[i].pin,
|
|
GPIO_INPUT | GPIO_INT_DEBOUNCE
|
|
| sx1276_dios[i].flags);
|
|
|
|
gpio_init_callback(&callbacks[i],
|
|
sx1276_irq_callback,
|
|
BIT(sx1276_dios[i].pin));
|
|
|
|
if (gpio_add_callback(dev_data.dio_dev[i], &callbacks[i]) < 0) {
|
|
LOG_ERR("Could not set gpio callback.");
|
|
return;
|
|
}
|
|
gpio_pin_interrupt_configure(dev_data.dio_dev[i],
|
|
sx1276_dios[i].pin,
|
|
GPIO_INT_EDGE_TO_ACTIVE);
|
|
}
|
|
|
|
}
|
|
|
|
static int sx1276_transceive(uint8_t reg, bool write, void *data, size_t length)
|
|
{
|
|
const struct spi_buf buf[2] = {
|
|
{
|
|
.buf = ®,
|
|
.len = sizeof(reg)
|
|
},
|
|
{
|
|
.buf = data,
|
|
.len = length
|
|
}
|
|
};
|
|
struct spi_buf_set tx = {
|
|
.buffers = buf,
|
|
.count = ARRAY_SIZE(buf),
|
|
};
|
|
|
|
if (!write) {
|
|
const struct spi_buf_set rx = {
|
|
.buffers = buf,
|
|
.count = ARRAY_SIZE(buf)
|
|
};
|
|
|
|
return spi_transceive(dev_data.spi, &dev_data.spi_cfg,
|
|
&tx, &rx);
|
|
}
|
|
|
|
return spi_write(dev_data.spi, &dev_data.spi_cfg, &tx);
|
|
}
|
|
|
|
int sx1276_read(uint8_t reg_addr, uint8_t *data, uint8_t len)
|
|
{
|
|
return sx1276_transceive(reg_addr, false, data, len);
|
|
}
|
|
|
|
int sx1276_write(uint8_t reg_addr, uint8_t *data, uint8_t len)
|
|
{
|
|
return sx1276_transceive(reg_addr | BIT(7), true, data, len);
|
|
}
|
|
|
|
void SX1276WriteBuffer(uint16_t addr, uint8_t *buffer, uint8_t size)
|
|
{
|
|
int ret;
|
|
|
|
ret = sx1276_write(addr, buffer, size);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to write address: 0x%x", addr);
|
|
}
|
|
}
|
|
|
|
void SX1276ReadBuffer(uint16_t addr, uint8_t *buffer, uint8_t size)
|
|
{
|
|
int ret;
|
|
|
|
ret = sx1276_read(addr, buffer, size);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to read address: 0x%x", addr);
|
|
}
|
|
}
|
|
|
|
void SX1276SetRfTxPower(int8_t power)
|
|
{
|
|
int ret;
|
|
uint8_t pa_config = 0;
|
|
uint8_t pa_dac = 0;
|
|
|
|
ret = sx1276_read(SX1276_REG_PA_DAC, &pa_dac, 1);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to read PA dac");
|
|
return;
|
|
}
|
|
|
|
pa_dac &= RF_PADAC_20DBM_MASK;
|
|
|
|
if (SX1276_PA_OUTPUT(power) == SX1276_PA_BOOST) {
|
|
power = clamp_int8(power, 2, 20);
|
|
|
|
pa_config |= RF_PACONFIG_PASELECT_PABOOST;
|
|
if (power > 17) {
|
|
pa_dac |= RF_PADAC_20DBM_ON;
|
|
pa_config |= (power - 5) & 0x0F;
|
|
} else {
|
|
pa_dac |= RF_PADAC_20DBM_OFF;
|
|
pa_config |= (power - 2) & 0x0F;
|
|
}
|
|
} else {
|
|
power = clamp_int8(power, -4, 15);
|
|
|
|
pa_dac |= RF_PADAC_20DBM_OFF;
|
|
if (power > 0) {
|
|
/* Set the power range to 0 -- 10.8+0.6*7 dBm. */
|
|
pa_config |= 7 << SX1276_PA_CONFIG_MAX_POWER_SHIFT;
|
|
pa_config |= (power & 0x0F);
|
|
} else {
|
|
/* Set the power range to -4.2 -- 10.8+0.6*0 dBm */
|
|
pa_config |= ((power + 4) & 0x0F);
|
|
}
|
|
}
|
|
|
|
#if DT_INST_NODE_HAS_PROP(0, rfo_enable_gpios) && \
|
|
DT_INST_NODE_HAS_PROP(0, pa_boost_enable_gpios)
|
|
dev_data.tx_power = power;
|
|
#endif
|
|
|
|
ret = sx1276_write(SX1276_REG_PA_CONFIG, &pa_config, 1);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to write PA config");
|
|
return;
|
|
}
|
|
|
|
ret = sx1276_write(SX1276_REG_PA_DAC, &pa_dac, 1);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to write PA dac");
|
|
return;
|
|
}
|
|
}
|
|
|
|
/* Initialize Radio driver callbacks */
|
|
const struct Radio_s Radio = {
|
|
.Init = SX1276Init,
|
|
.GetStatus = SX1276GetStatus,
|
|
.SetModem = SX1276SetModem,
|
|
.SetChannel = SX1276SetChannel,
|
|
.IsChannelFree = SX1276IsChannelFree,
|
|
.Random = SX1276Random,
|
|
.SetRxConfig = SX1276SetRxConfig,
|
|
.SetTxConfig = SX1276SetTxConfig,
|
|
.Send = SX1276Send,
|
|
.Sleep = SX1276SetSleep,
|
|
.Standby = SX1276SetStby,
|
|
.Rx = SX1276SetRx,
|
|
.Write = SX1276Write,
|
|
.Read = SX1276Read,
|
|
.WriteBuffer = SX1276WriteBuffer,
|
|
.ReadBuffer = SX1276ReadBuffer,
|
|
.SetMaxPayloadLength = SX1276SetMaxPayloadLength,
|
|
.IrqProcess = NULL,
|
|
.RxBoosted = NULL,
|
|
.SetRxDutyCycle = NULL,
|
|
.SetTxContinuousWave = SX1276SetTxContinuousWave,
|
|
};
|
|
|
|
static int sx1276_antenna_configure(void)
|
|
{
|
|
int ret;
|
|
|
|
ret = sx12xx_configure_pin(antenna_enable, GPIO_OUTPUT_INACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
ret = sx12xx_configure_pin(rfi_enable, GPIO_OUTPUT_INACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
ret = sx12xx_configure_pin(rfo_enable, GPIO_OUTPUT_INACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
ret = sx12xx_configure_pin(pa_boost_enable, GPIO_OUTPUT_INACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int sx1276_lora_init(struct device *dev)
|
|
{
|
|
#if DT_INST_SPI_DEV_HAS_CS_GPIOS(0)
|
|
static struct spi_cs_control spi_cs;
|
|
#endif
|
|
int ret;
|
|
uint8_t regval;
|
|
|
|
dev_data.spi = device_get_binding(DT_INST_BUS_LABEL(0));
|
|
if (!dev_data.spi) {
|
|
LOG_ERR("Cannot get pointer to %s device",
|
|
DT_INST_BUS_LABEL(0));
|
|
return -EINVAL;
|
|
}
|
|
|
|
dev_data.spi_cfg.operation = SPI_WORD_SET(8) | SPI_TRANSFER_MSB;
|
|
dev_data.spi_cfg.frequency = DT_INST_PROP(0, spi_max_frequency);
|
|
dev_data.spi_cfg.slave = DT_INST_REG_ADDR(0);
|
|
|
|
#if DT_INST_SPI_DEV_HAS_CS_GPIOS(0)
|
|
spi_cs.gpio_dev = device_get_binding(
|
|
DT_INST_SPI_DEV_CS_GPIOS_LABEL(0));
|
|
if (!spi_cs.gpio_dev) {
|
|
LOG_ERR("Cannot get pointer to %s device",
|
|
DT_INST_SPI_DEV_CS_GPIOS_LABEL(0));
|
|
return -EIO;
|
|
}
|
|
|
|
spi_cs.gpio_pin = GPIO_CS_PIN;
|
|
spi_cs.gpio_dt_flags = GPIO_CS_FLAGS;
|
|
spi_cs.delay = 0U;
|
|
|
|
dev_data.spi_cfg.cs = &spi_cs;
|
|
#endif
|
|
|
|
ret = sx12xx_configure_pin(tcxo_power, GPIO_OUTPUT_INACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
/* Setup Reset gpio and perform soft reset */
|
|
ret = sx12xx_configure_pin(reset, GPIO_OUTPUT_ACTIVE);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
|
|
k_sleep(K_MSEC(100));
|
|
gpio_pin_set(dev_data.reset, GPIO_RESET_PIN, 0);
|
|
k_sleep(K_MSEC(100));
|
|
|
|
ret = sx1276_read(SX1276_REG_VERSION, ®val, 1);
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to read version info");
|
|
return -EIO;
|
|
}
|
|
|
|
ret = sx1276_antenna_configure();
|
|
if (ret < 0) {
|
|
LOG_ERR("Unable to configure antenna");
|
|
return -EIO;
|
|
}
|
|
|
|
LOG_INF("SX1276 Version:%02x found", regval);
|
|
|
|
ret = sx12xx_init(dev);
|
|
if (ret < 0) {
|
|
LOG_ERR("Failed to initialize SX12xx common");
|
|
return ret;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static const struct lora_driver_api sx1276_lora_api = {
|
|
.config = sx12xx_lora_config,
|
|
.send = sx12xx_lora_send,
|
|
.recv = sx12xx_lora_recv,
|
|
.test_cw = sx12xx_lora_test_cw,
|
|
};
|
|
|
|
DEVICE_AND_API_INIT(sx1276_lora, DT_INST_LABEL(0),
|
|
&sx1276_lora_init, NULL,
|
|
NULL, POST_KERNEL, CONFIG_LORA_INIT_PRIORITY,
|
|
&sx1276_lora_api);
|