IRDA: Use DMA for async TX (#608)
This commit is contained in:
@@ -1,11 +1,21 @@
|
||||
#pragma once
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef enum {
|
||||
ApiHalIrdaTxGetDataStateError, /* An error occured during transmission */
|
||||
ApiHalIrdaTxGetDataStateOk, /* New data obtained */
|
||||
ApiHalIrdaTxGetDataStateDone, /* New data obtained, and this is end of package */
|
||||
ApiHalIrdaTxGetDataStateLastDone, /* New data obtained, and this is end of package and no more data available */
|
||||
} ApiHalIrdaTxGetDataState;
|
||||
|
||||
typedef ApiHalIrdaTxGetDataState (*ApiHalIrdaTxGetDataCallback) (void* context, uint32_t* duration, bool* level);
|
||||
|
||||
/**
|
||||
* Signature of callback function for receiving continuous IRDA rx signal.
|
||||
*
|
||||
@@ -13,26 +23,26 @@ extern "C" {
|
||||
* @param level[in] - level of input IRDA rx signal
|
||||
* @param duration[in] - duration of continuous rx signal level in us
|
||||
*/
|
||||
typedef void (*ApiHalIrdaCaptureCallback)(void* ctx, bool level, uint32_t duration);
|
||||
typedef void (*ApiHalIrdaRxCaptureCallback)(void* ctx, bool level, uint32_t duration);
|
||||
|
||||
/**
|
||||
* Signature of callback function for reaching silence timeout on IRDA port.
|
||||
*
|
||||
* @param ctx[in] - context to pass to callback
|
||||
*/
|
||||
typedef void (*ApiHalIrdaTimeoutCallback)(void* ctx);
|
||||
typedef void (*ApiHalIrdaRxTimeoutCallback)(void* ctx);
|
||||
|
||||
/**
|
||||
* Initialize IRDA RX timer to receive interrupts.
|
||||
* It provides interrupts for every RX-signal edge changing
|
||||
* with its duration.
|
||||
*/
|
||||
void api_hal_irda_rx_irq_init(void);
|
||||
void api_hal_irda_async_rx_start(void);
|
||||
|
||||
/**
|
||||
* Deinitialize IRDA RX interrupt.
|
||||
*/
|
||||
void api_hal_irda_rx_irq_deinit(void);
|
||||
void api_hal_irda_async_rx_stop(void);
|
||||
|
||||
/** Setup api hal for receiving silence timeout.
|
||||
* Should be used with 'api_hal_irda_timeout_irq_set_callback()'.
|
||||
@@ -40,7 +50,7 @@ void api_hal_irda_rx_irq_deinit(void);
|
||||
* @param[in] timeout_ms - time to wait for silence on IRDA port
|
||||
* before generating IRQ.
|
||||
*/
|
||||
void api_hal_irda_rx_timeout_irq_init(uint32_t timeout_ms);
|
||||
void api_hal_irda_async_rx_set_timeout(uint32_t timeout_ms);
|
||||
|
||||
/**
|
||||
* Setup callback for previously initialized IRDA RX interrupt.
|
||||
@@ -48,7 +58,7 @@ void api_hal_irda_rx_timeout_irq_init(uint32_t timeout_ms);
|
||||
* @param[in] callback - callback to call when RX signal edge changing occurs
|
||||
* @param[in] ctx - context for callback
|
||||
*/
|
||||
void api_hal_irda_rx_irq_set_callback(ApiHalIrdaCaptureCallback callback, void *ctx);
|
||||
void api_hal_irda_async_rx_set_capture_isr_callback(ApiHalIrdaRxCaptureCallback callback, void *ctx);
|
||||
|
||||
/**
|
||||
* Setup callback for reaching silence timeout on IRDA port.
|
||||
@@ -57,27 +67,53 @@ void api_hal_irda_rx_irq_set_callback(ApiHalIrdaCaptureCallback callback, void *
|
||||
* @param[in] callback - callback for silence timeout
|
||||
* @param[in] ctx - context to pass to callback
|
||||
*/
|
||||
void api_hal_irda_rx_timeout_irq_set_callback(ApiHalIrdaTimeoutCallback callback, void *ctx);
|
||||
|
||||
/**
|
||||
* Start generating IRDA TX PWM. Provides PWM initialization on
|
||||
* defined frequency.
|
||||
*
|
||||
* @param[in] duty_cycle - duty cycle
|
||||
* @param[in] freq - PWM frequency to generate
|
||||
*/
|
||||
void api_hal_irda_pwm_set(float duty_cycle, float freq);
|
||||
|
||||
/**
|
||||
* Stop generating IRDA PWM signal.
|
||||
*/
|
||||
void api_hal_irda_pwm_stop();
|
||||
void api_hal_irda_async_rx_set_timeout_isr_callback(ApiHalIrdaRxTimeoutCallback callback, void *ctx);
|
||||
|
||||
/**
|
||||
* Check if IRDA is in use now.
|
||||
* @return false - IRDA is busy, true otherwise.
|
||||
* @return true - IRDA is busy, false otherwise.
|
||||
*/
|
||||
bool api_hal_irda_rx_irq_is_busy(void);
|
||||
bool api_hal_irda_is_busy(void);
|
||||
|
||||
/**
|
||||
* Set callback providing new data. This function has to be called
|
||||
* before api_hal_irda_async_tx_start().
|
||||
*
|
||||
* @param[in] callback - function to provide new data
|
||||
* @param[in] context - context for callback
|
||||
*/
|
||||
void api_hal_irda_async_tx_set_data_isr_callback(ApiHalIrdaTxGetDataCallback callback, void* context);
|
||||
|
||||
/**
|
||||
* Start IR asynchronous transmission. It can be stopped by 2 reasons:
|
||||
* 1) implicit call for api_hal_irda_async_tx_stop()
|
||||
* 2) callback can provide ApiHalIrdaTxGetDataStateLastDone response
|
||||
* which means no more data available for transmission.
|
||||
*
|
||||
* Any func (api_hal_irda_async_tx_stop() or
|
||||
* api_hal_irda_async_tx_wait_termination()) has to be called to wait
|
||||
* end of transmission and free resources.
|
||||
*
|
||||
* @param[in] freq - frequency for PWM
|
||||
* @param[in] duty_cycle - duty cycle for PWM
|
||||
* @return true if transmission successfully started, false otherwise.
|
||||
* If start failed no need to free resources.
|
||||
*/
|
||||
bool api_hal_irda_async_tx_start(uint32_t freq, float duty_cycle);
|
||||
|
||||
/**
|
||||
* Stop IR asynchronous transmission and free resources.
|
||||
* Transmission will stop as soon as transmission reaches end of
|
||||
* package (ApiHalIrdaTxGetDataStateDone or ApiHalIrdaTxGetDataStateLastDone).
|
||||
*/
|
||||
void api_hal_irda_async_tx_stop(void);
|
||||
|
||||
/**
|
||||
* Wait for end of IR asynchronous transmission and free resources.
|
||||
* Transmission will stop as soon as transmission reaches end of
|
||||
* transmission (ApiHalIrdaTxGetDataStateLastDone).
|
||||
*/
|
||||
void api_hal_irda_async_tx_wait_termination(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
Reference in New Issue
Block a user