Skip to content

Commit

Permalink
Update bc_usb_cdc header
Browse files Browse the repository at this point in the history
  • Loading branch information
Pavel Hübner committed Nov 27, 2017
1 parent 202479c commit 4f2e504
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion bcl/inc/bc_usb_cdc.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,29 @@

#include <bc_common.h>

//! @addtogroup bc_usb_cdc bc_usb_cdc
//! @brief USB CDC communication library
//! @{

//! @brief Initialize USB CDC library

void bc_usb_cdc_init(void);
void bc_usb_cdc_start(void);

//! @brief Write buffer to USB CDC (non-blocking call)
//! @param[in] buffer Pointer to buffer to be written
//! @param[in] length Number of bytes to be written
//! @return true On success
//! @return false On failure

bool bc_usb_cdc_write(const void *buffer, size_t length);

//! @brief Read buffer from USB CDC (non-blocking call)
//! @param[out] buffer Pointer to buffer to be read
//! @param[in] length Number of bytes to be read
//! @return Number of bytes read

size_t bc_usb_cdc_read(void *buffer, size_t length);

//! @}

#endif // _BC_USB_CDC_H

0 comments on commit 4f2e504

Please sign in to comment.