Loading...
Searching...
No Matches
sx1280.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2022 Inria
3 * SPDX-FileCopyrightText: 2020-2022 Université Grenoble Alpes
4 * SPDX-License-Identifier: LGPL-2.1-only
5 */
6
7#pragma once
8
22
23#include <assert.h>
24
25#include "sx1280_driver/src/sx1280_hal.h"
26#include "sx1280_driver/src/sx1280.h"
27#include "smtc_ral/src/ral.h"
28#include "smtc_ral/src/ral_defs.h"
29
30#include "net/netdev.h"
31
32#include "periph/gpio.h"
33#include "periph/spi.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
43#define SX1280_CHANNEL_DEFAULT (2403000000UL)
44#define SX1280_RADIO_TX_POWER (SX1280_PWR_MAX)
46
50typedef struct sx1280 sx1280_t;
51
55typedef struct {
56 spi_t spi;
59 gpio_t nss_pin;
60 gpio_t reset_pin;
61 gpio_t busy_pin;
62 gpio_t dio0_pin;
63 gpio_t dio1_pin;
64 sx1280_reg_mod_t regulator;
66
70struct sx1280 {
72 ral_t ral;
73 ral_params_lora_t ral_params_lora;
75 sx1280_hal_operating_mode_t mode;
76};
77
86void sx1280_setup(sx1280_t *dev, const sx1280_params_t *params, uint8_t index);
87
96
104uint32_t sx1280_get_channel(const sx1280_t *dev);
105
113uint32_t sx1280_random(const sx1280_t *dev);
120void sx1280_set_channel(sx1280_t *dev, uint32_t freq);
121
129uint32_t sx1280_get_bandwidth(const sx1280_t *dev);
130
137void sx1280_set_bandwidth(sx1280_t *dev, uint16_t bandwidth);
138
147
155
164
171void sx1280_set_coding_rate(sx1280_t *dev, uint8_t cr);
172
181
189
198
205void sx1280_set_lora_crc(sx1280_t *dev, bool crc);
206
215
223
232
239void sx1280_set_lora_preamble_length(sx1280_t *dev, uint16_t preamble);
240
249
256void sx1280_set_lora_iq_invert(sx1280_t *dev, bool iq_invert);
257
258#ifdef __cplusplus
259}
260#endif
261
POSIX.1-2008 compliant version of the assert macro.
spi_clk_t
Definition periph_cpu.h:348
Definitions low-level network driver interface.
Low-level GPIO peripheral driver interface definitions.
struct netdev netdev_t
Forward declaration for netdev struct.
Definition netdev.h:285
uint32_t sx1280_get_bandwidth(const sx1280_t *dev)
Gets the LoRa bandwidth.
uint32_t sx1280_get_channel(const sx1280_t *dev)
Gets the channel RF frequency.
bool sx1280_get_lora_iq_invert(const sx1280_t *dev)
Checks if the LoRa inverted IQ mode is enabled/disabled.
struct sx1280 sx1280_t
Definition sx1280.h:50
void sx1280_setup(sx1280_t *dev, const sx1280_params_t *params, uint8_t index)
Setup the radio device.
bool sx1280_get_lora_crc(const sx1280_t *dev)
Checks if CRC verification mode is enabled.
void sx1280_set_channel(sx1280_t *dev, uint32_t freq)
Sets the channel RF frequency.
uint32_t sx1280_random(const sx1280_t *dev)
Gets a random number.
uint8_t sx1280_get_lora_payload_length(const sx1280_t *dev)
Gets the payload length.
void sx1280_set_lora_payload_length(sx1280_t *dev, uint8_t len)
Sets the payload length.
void sx1280_set_bandwidth(sx1280_t *dev, uint16_t bandwidth)
Sets the LoRa bandwidth.
bool sx1280_get_lora_implicit_header(const sx1280_t *dev)
Gets the LoRa implicit header mode.
void sx1280_set_lora_preamble_length(sx1280_t *dev, uint16_t preamble)
Sets the LoRa preamble length.
uint8_t sx1280_get_coding_rate(const sx1280_t *dev)
Gets the LoRa coding rate.
uint8_t sx1280_get_spreading_factor(const sx1280_t *dev)
Gets the LoRa spreading factor.
void sx1280_set_lora_iq_invert(sx1280_t *dev, bool iq_invert)
Enable/disable the LoRa IQ inverted mode.
int sx1280_init(sx1280_t *dev)
Initialize the given device.
void sx1280_set_spreading_factor(sx1280_t *dev, uint8_t sf)
Sets the LoRa spreading factor.
void sx1280_set_lora_crc(sx1280_t *dev, bool crc)
Enable/Disable CRC verification mode.
void sx1280_set_lora_implicit_header(sx1280_t *dev, bool mode)
Sets LoRa implicit header mode.
void sx1280_set_coding_rate(sx1280_t *dev, uint8_t cr)
Sets the LoRa coding rate.
uint16_t sx1280_get_lora_preamble_length(const sx1280_t *dev)
Gets the LoRa preamble length.
spi_mode_t
Support SPI modes.
Definition periph_cpu.h:39
Low-level SPI peripheral driver interface definition.
Device initialization parameters.
Definition sx1280.h:55
gpio_t busy_pin
Busy pin.
Definition sx1280.h:61
sx1280_reg_mod_t regulator
Power regulator mode.
Definition sx1280.h:64
spi_t spi
SPI device.
Definition sx1280.h:56
spi_clk_t spi_clk
SPI clk.
Definition sx1280.h:58
gpio_t nss_pin
SPI NSS pin.
Definition sx1280.h:59
gpio_t dio0_pin
Dio0 pin.
Definition sx1280.h:62
gpio_t dio1_pin
Dio1 pin.
Definition sx1280.h:63
gpio_t reset_pin
Reset pin.
Definition sx1280.h:60
spi_mode_t spi_mode
SPI mode.
Definition sx1280.h:57
Device descriptor for the driver.
Definition sx1280.h:70
sx1280_params_t * params
Initialization parameters.
Definition sx1280.h:74
sx1280_hal_operating_mode_t mode
Operating Mode.
Definition sx1280.h:75
ral_params_lora_t ral_params_lora
LoRa modulation parameters.
Definition sx1280.h:73
ral_t ral
Radio abstraction.
Definition sx1280.h:72
netdev_t netdev
Netdev parent struct.
Definition sx1280.h:71