mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-12-18 08:43:10 +00:00
89a6c09a7a
* Documentation: add Doxyfile, prepare sources for doxygen. * Update ReadMe and remove obsolete CLA * Add contribution guide * Contributing: update text * Correct spelling
49 lines
1.1 KiB
C
49 lines
1.1 KiB
C
/**
|
|
* @file furi-hal-vcp.h
|
|
* VCP HAL API
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Init VCP HAL Allocates ring buffer and initializes state
|
|
*/
|
|
void furi_hal_vcp_init();
|
|
|
|
/** Recieve data from VCP Waits till some data arrives, never returns 0
|
|
*
|
|
* @param buffer pointer to buffer
|
|
* @param size buffer size
|
|
*
|
|
* @return items copied in buffer, 0 if channel closed
|
|
*/
|
|
size_t furi_hal_vcp_rx(uint8_t* buffer, size_t size);
|
|
|
|
/** Recieve data from VCP with timeout Waits till some data arrives during
|
|
* timeout
|
|
*
|
|
* @param buffer pointer to buffer
|
|
* @param size buffer size
|
|
* @param timeout rx timeout in ms
|
|
*
|
|
* @return items copied in buffer, 0 if channel closed or timeout occurs
|
|
*/
|
|
size_t furi_hal_vcp_rx_with_timeout(uint8_t* buffer, size_t size, uint32_t timeout);
|
|
|
|
/** Transmit data to VCP
|
|
*
|
|
* @param buffer pointer to buffer
|
|
* @param size buffer size
|
|
*/
|
|
void furi_hal_vcp_tx(const uint8_t* buffer, size_t size);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|