f5b2ed67d5
* Github: treat non 0 exit code as fatal * GitHub: inject missing -e flag to bash in docker * Firmware: sync targets
77 lines
1.5 KiB
C
77 lines
1.5 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,
|
||
UartIrqEventIDLE,
|
||
//TODO: more events
|
||
} UartIrqEvent;
|
||
|
||
/**
|
||
* Init UART
|
||
* Configures GPIO to UART function, сonfigures 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);
|
||
|
||
/**
|
||
* 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 |