9d27ef8901
* FuriHal: SPI refactoring, flexible bus reconfigration on fly, same desiag as i2c. * Lib: update CC1101 driver documentation * FuriHal: update spi symbol names to match naming convention.
102 lines
2.5 KiB
C
102 lines
2.5 KiB
C
#pragma once
|
|
|
|
#include <furi-hal-spi-config.h>
|
|
#include <stdbool.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Initialize SPI HAL */
|
|
void furi_hal_spi_init();
|
|
|
|
/** Initialize SPI Bus
|
|
*
|
|
* @param handle pointer to FuriHalSpiBus instance
|
|
*/
|
|
void furi_hal_spi_bus_init(FuriHalSpiBus* bus);
|
|
|
|
/** Deinitialize SPI Bus
|
|
*
|
|
* @param handle pointer to FuriHalSpiBus instance
|
|
*/
|
|
void furi_hal_spi_bus_deinit(FuriHalSpiBus* bus);
|
|
|
|
/** Initialize SPI Bus Handle
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
*/
|
|
void furi_hal_spi_bus_handle_init(FuriHalSpiBusHandle* handle);
|
|
|
|
/** Deinitialize SPI Bus Handle
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
*/
|
|
void furi_hal_spi_bus_handle_deinit(FuriHalSpiBusHandle* handle);
|
|
|
|
/** Acquire SPI bus
|
|
*
|
|
* @warning blocking, calls `furi_crash` on programming error, CS transition is up to handler event routine
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
*/
|
|
void furi_hal_spi_acquire(FuriHalSpiBusHandle* handle);
|
|
|
|
/** Release SPI bus
|
|
*
|
|
* @warning calls `furi_crash` on programming error, CS transition is up to handler event routine
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
*/
|
|
void furi_hal_spi_release(FuriHalSpiBusHandle* handle);
|
|
|
|
/** SPI Receive
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
* @param buffer receive buffer
|
|
* @param size transaction size (buffer size)
|
|
* @param timeout operation timeout in ms
|
|
*
|
|
* @return true on sucess
|
|
*/
|
|
bool furi_hal_spi_bus_rx(
|
|
FuriHalSpiBusHandle* handle,
|
|
uint8_t* buffer,
|
|
size_t size,
|
|
uint32_t timeout);
|
|
|
|
/** SPI Transmit
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
* @param buffer transmit buffer
|
|
* @param size transaction size (buffer size)
|
|
* @param timeout operation timeout in ms
|
|
*
|
|
* @return true on success
|
|
*/
|
|
bool furi_hal_spi_bus_tx(
|
|
FuriHalSpiBusHandle* handle,
|
|
uint8_t* buffer,
|
|
size_t size,
|
|
uint32_t timeout);
|
|
|
|
/** SPI Transmit and Receive
|
|
*
|
|
* @param handle pointer to FuriHalSpiBusHandle instance
|
|
* @param tx_buffer pointer to tx buffer
|
|
* @param rx_buffer pointer to rx buffer
|
|
* @param size transaction size (buffer size)
|
|
* @param timeout operation timeout in ms
|
|
*
|
|
* @return true on success
|
|
*/
|
|
bool furi_hal_spi_bus_trx(
|
|
FuriHalSpiBusHandle* handle,
|
|
uint8_t* tx_buffer,
|
|
uint8_t* rx_buffer,
|
|
size_t size,
|
|
uint32_t timeout);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif |