mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-12-29 22:23:06 +00:00
89 lines
1.8 KiB
C
89 lines
1.8 KiB
C
/**
|
|
* @file furi_hal_uart.h
|
|
* @version 1.0
|
|
* @date 2021-11-19
|
|
*
|
|
* UART HAL api interface
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* UART channels
|
|
*/
|
|
typedef enum {
|
|
FuriHalUartIdUSART1,
|
|
FuriHalUartIdLPUART1,
|
|
} FuriHalUartId;
|
|
|
|
/**
|
|
* UART events
|
|
*/
|
|
typedef enum {
|
|
UartIrqEventRXNE,
|
|
} UartIrqEvent;
|
|
|
|
/**
|
|
* Init UART
|
|
* Configures GPIO to UART function, configures UART hardware, enables UART hardware
|
|
* @param channel UART channel
|
|
* @param baud baudrate
|
|
*/
|
|
void furi_hal_uart_init(FuriHalUartId channel, uint32_t baud);
|
|
|
|
/**
|
|
* Deinit UART
|
|
* Configures GPIO to analog, clears callback and callback context, disables UART hardware
|
|
* @param channel UART channel
|
|
*/
|
|
void furi_hal_uart_deinit(FuriHalUartId channel);
|
|
|
|
/**
|
|
* Suspend UART operation
|
|
* Disables UART hardware, settings and callbacks are preserved
|
|
* @param channel UART channel
|
|
*/
|
|
void furi_hal_uart_suspend(FuriHalUartId channel);
|
|
|
|
/**
|
|
* Resume UART operation
|
|
* Resumes UART hardware from suspended state
|
|
* @param channel UART channel
|
|
*/
|
|
void furi_hal_uart_resume(FuriHalUartId channel);
|
|
|
|
/**
|
|
* Changes UART baudrate
|
|
* @param channel UART channel
|
|
* @param baud baudrate
|
|
*/
|
|
void furi_hal_uart_set_br(FuriHalUartId channel, uint32_t baud);
|
|
|
|
/**
|
|
* Transmits data
|
|
* @param channel UART channel
|
|
* @param buffer data
|
|
* @param buffer_size data size (in bytes)
|
|
*/
|
|
void furi_hal_uart_tx(FuriHalUartId channel, uint8_t* buffer, size_t buffer_size);
|
|
|
|
/**
|
|
* Sets UART event callback
|
|
* @param channel UART channel
|
|
* @param callback callback pointer
|
|
* @param context callback context
|
|
*/
|
|
void furi_hal_uart_set_irq_cb(
|
|
FuriHalUartId channel,
|
|
void (*callback)(UartIrqEvent event, uint8_t data, void* context),
|
|
void* context);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|