Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
lora.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Manivannan Sadhasivam
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_DRIVERS_LORA_H_
13#define ZEPHYR_INCLUDE_DRIVERS_LORA_H_
14
25#include <stdint.h>
26#include <zephyr/kernel.h>
27#include <zephyr/device.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
46
64
75 CR_4_5 = 1,
76 CR_4_6 = 2,
77 CR_4_7 = 3,
78 CR_4_8 = 4,
79};
80
127
140typedef void (*lora_recv_cb)(const struct device *dev, uint8_t *data, uint16_t size,
141 int16_t rssi, int8_t snr, void *user_data);
142
149typedef int (*lora_api_config)(const struct device *dev,
150 struct lora_modem_config *config);
151
158typedef int (*lora_api_send)(const struct device *dev,
159 uint8_t *data, uint32_t data_len);
160
167typedef int (*lora_api_send_async)(const struct device *dev,
168 uint8_t *data, uint32_t data_len,
169 struct k_poll_signal *async);
170
177typedef int (*lora_api_recv)(const struct device *dev, uint8_t *data,
178 uint8_t size,
179 k_timeout_t timeout, int16_t *rssi, int8_t *snr);
180
188typedef int (*lora_api_recv_async)(const struct device *dev, lora_recv_cb cb,
189 void *user_data);
190
197typedef int (*lora_api_test_cw)(const struct device *dev, uint32_t frequency,
198 int8_t tx_power, uint16_t duration);
199
200__subsystem struct lora_driver_api {
201 lora_api_config config;
202 lora_api_send send;
203 lora_api_send_async send_async;
204 lora_api_recv recv;
205 lora_api_recv_async recv_async;
206 lora_api_test_cw test_cw;
207};
208
219static inline int lora_config(const struct device *dev,
220 struct lora_modem_config *config)
221{
222 const struct lora_driver_api *api =
223 (const struct lora_driver_api *)dev->api;
224
225 return api->config(dev, config);
226}
227
238static inline int lora_send(const struct device *dev,
239 uint8_t *data, uint32_t data_len)
240{
241 const struct lora_driver_api *api =
242 (const struct lora_driver_api *)dev->api;
243
244 return api->send(dev, data, data_len);
245}
246
261static inline int lora_send_async(const struct device *dev,
262 uint8_t *data, uint32_t data_len,
263 struct k_poll_signal *async)
264{
265 const struct lora_driver_api *api =
266 (const struct lora_driver_api *)dev->api;
267
268 return api->send_async(dev, data, data_len, async);
269}
270
285static inline int lora_recv(const struct device *dev, uint8_t *data,
286 uint8_t size,
287 k_timeout_t timeout, int16_t *rssi, int8_t *snr)
288{
289 const struct lora_driver_api *api =
290 (const struct lora_driver_api *)dev->api;
291
292 return api->recv(dev, data, size, timeout, rssi, snr);
293}
294
310static inline int lora_recv_async(const struct device *dev, lora_recv_cb cb,
311 void *user_data)
312{
313 const struct lora_driver_api *api =
314 (const struct lora_driver_api *)dev->api;
315
316 return api->recv_async(dev, cb, user_data);
317}
318
331static inline int lora_test_cw(const struct device *dev, uint32_t frequency,
332 int8_t tx_power, uint16_t duration)
333{
334 const struct lora_driver_api *api =
335 (const struct lora_driver_api *)dev->api;
336
337 if (api->test_cw == NULL) {
338 return -ENOSYS;
339 }
340
341 return api->test_cw(dev, frequency, tx_power, duration);
342}
343
344#ifdef __cplusplus
345}
346#endif
347
352#endif /* ZEPHYR_INCLUDE_DRIVERS_LORA_H_ */
static int lora_test_cw(const struct device *dev, uint32_t frequency, int8_t tx_power, uint16_t duration)
Transmit an unmodulated continuous wave at a given frequency.
Definition lora.h:331
static int lora_recv(const struct device *dev, uint8_t *data, uint8_t size, k_timeout_t timeout, int16_t *rssi, int8_t *snr)
Receive data over LoRa.
Definition lora.h:285
lora_datarate
LoRa data-rate.
Definition lora.h:55
static int lora_send_async(const struct device *dev, uint8_t *data, uint32_t data_len, struct k_poll_signal *async)
Asynchronously send data over LoRa.
Definition lora.h:261
lora_coding_rate
LoRa coding rate.
Definition lora.h:74
lora_signal_bandwidth
LoRa signal bandwidth.
Definition lora.h:41
static int lora_config(const struct device *dev, struct lora_modem_config *config)
Configure the LoRa modem.
Definition lora.h:219
static int lora_send(const struct device *dev, uint8_t *data, uint32_t data_len)
Send data over LoRa.
Definition lora.h:238
static int lora_recv_async(const struct device *dev, lora_recv_cb cb, void *user_data)
Receive data asynchronously over LoRa.
Definition lora.h:310
@ SF_12
Spreading factor 12 (slowest, longest range)
Definition lora.h:62
@ SF_8
Spreading factor 8.
Definition lora.h:58
@ SF_11
Spreading factor 11.
Definition lora.h:61
@ SF_10
Spreading factor 10.
Definition lora.h:60
@ SF_9
Spreading factor 9.
Definition lora.h:59
@ SF_6
Spreading factor 6 (fastest, shortest range)
Definition lora.h:56
@ SF_7
Spreading factor 7.
Definition lora.h:57
@ CR_4_5
Coding rate 4/5 (4 information bits, 1 error correction bit)
Definition lora.h:75
@ CR_4_6
Coding rate 4/6 (4 information bits, 2 error correction bits)
Definition lora.h:76
@ CR_4_8
Coding rate 4/8 (4 information bits, 4 error correction bits)
Definition lora.h:78
@ CR_4_7
Coding rate 4/7 (4 information bits, 3 error correction bits)
Definition lora.h:77
@ BW_250_KHZ
250 kHz
Definition lora.h:43
@ BW_125_KHZ
125 kHz
Definition lora.h:42
@ BW_500_KHZ
500 kHz
Definition lora.h:44
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
Public kernel APIs.
ssize_t send(int sock, const void *buf, size_t len, int flags)
ssize_t recv(int sock, void *buf, size_t max_len, int flags)
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
__INT16_TYPE__ int16_t
Definition stdint.h:73
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
void * data
Address of the device instance private data.
Definition device.h:520
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
Definition kernel.h:6149
Kernel timeout type.
Definition clock.h:65
Structure containing the configuration of a LoRa modem.
Definition lora.h:85
uint32_t frequency
Frequency in Hz to use for transceiving.
Definition lora.h:87
enum lora_signal_bandwidth bandwidth
The bandwidth to use for transceiving.
Definition lora.h:90
bool tx
Set to true for transmission, false for receiving.
Definition lora.h:105
int8_t tx_power
TX-power in dBm to use for transmission.
Definition lora.h:102
bool iq_inverted
Invert the In-Phase and Quadrature (IQ) signals.
Definition lora.h:114
enum lora_coding_rate coding_rate
The coding rate to use for transceiving.
Definition lora.h:96
uint16_t preamble_len
Length of the preamble.
Definition lora.h:99
enum lora_datarate datarate
The data-rate to use for transceiving.
Definition lora.h:93
bool public_network
Sets the sync-byte to use:
Definition lora.h:125