michaelh/zephyr
1
0
Fork 0
Code Releases Activity

lora: lora_send blocks until completion

Browse source 
Change the behaviour of `lora_send` to block until the transmission
completes. The current asynchronous behaviour is exposed through the
new function `lora_send_async`. This naming convention brings LoRa in
line with other asynchronous subsystems.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
This commit is contained in:
Jordan Yates 2021-06-30 12:45:37 +10:00 • committed by Christopher Friedt
commit 93b4dbcc19
5 changed files with 75 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

41
include/drivers/lora.h
View file

@ -70,6 +70,16 @@ typedef int (*lora_api_config)(const struct device *dev,
typedef int (*lora_api_send)(const struct device *dev,
uint8_t *data, uint32_t data_len);
/**
* @typedef lora_api_send_async()
* @brief Callback API for sending data asynchronously over LoRa
*
* @see lora_send_async() for argument descriptions.
*/
typedef int (*lora_api_send_async)(const struct device *dev,
uint8_t *data, uint32_t data_len,
struct k_poll_signal *async);
/**
* @typedef lora_api_recv()
* @brief Callback API for receiving data over LoRa
@ -91,8 +101,9 @@ typedef int (*lora_api_test_cw)(const struct device *dev, uint32_t frequency,
struct lora_driver_api {
lora_api_config config;
lora_api_send send;
lora_api_recv recv;
lora_api_send send;
lora_api_send_async send_async;
lora_api_recv recv;
lora_api_test_cw test_cw;
};
@ -116,7 +127,7 @@ static inline int lora_config(const struct device *dev,
/**
* @brief Send data over LoRa
*
* @note This is a non-blocking call.
* @note This blocks until transmission is complete.
*
* @param dev LoRa device
* @param data Data to be sent
@ -132,6 +143,30 @@ static inline int lora_send(const struct device *dev,
return api->send(dev, data, data_len);
}
/**
* @brief Asynchronously send data over LoRa
*
* @note This returns immediately after starting transmission, and locks
* the LoRa modem until the transmission completes.
*
* @param dev LoRa device
* @param data Data to be sent
* @param data_len Length of the data to be sent
* @param async A pointer to a valid and ready to be signaled
* struct k_poll_signal. (Note: if NULL this function will not
* notify the end of the transmission).
* @return 0 on success, negative on error
*/
static inline int lora_send_async(const struct device *dev,
uint8_t *data, uint32_t data_len,
struct k_poll_signal *async)
{
const struct lora_driver_api *api =
(const struct lora_driver_api *)dev->api;
return api->send_async(dev, data, data_len, async);
}
/**
* @brief Receive data over LoRa
*