hierodule/hierodule__usb_8h_source.html

#ifndef __HIERODULE_USB_H

#define __HIERODULE_USB_H


#ifdef __cplusplus

extern "C"

{

#endif

#include <main.h>

#include <stddef.h>

#include <stdlib.h>


#if __has_include("usbd_cdc_if.h")

#include <usbd_cdc_if.h>

#endif


typedef struct

{

    uint8_t *RX_Buffer;

    uint32_t RX_Index;

    uint32_t RX_New;

    uint16_t RX_BufferSize;


    void (*TC_Handler)(void);


} HIERODULE_USB_Wrapper;


extern HIERODULE_USB_Wrapper Wrapper;


uint8_t HIERODULE_USB_GetNextByte(void);


void HIERODULE_USB_InitWrapper(uint16_t RX_BufferSize, void (*TC_Handler)(void) );


void HIERODULE_USB_ReleaseWrapper(void);


void HIERODULE_USB_TransmitPackage(uint8_t *TX_Buffer, uint32_t Size);


void HIERODULE_USB_Receive_Callback(uint8_t *Buf, uint32_t *Len);

#ifdef __cplusplus

}

#endif


#endif /* __HIERODULE_USB_H */


HIERODULE_USB_GetNextByte
uint8_t HIERODULE_USB_GetNextByte(void)
Fetches the next byte in the RX ring buffer.
Definition hierodule_usb.c:57

HIERODULE_USB_InitWrapper
void HIERODULE_USB_InitWrapper(uint16_t RX_BufferSize, void(*TC_Handler)(void))
Initializes the wrapper for the USB peripheral.
Definition hierodule_usb.c:78

Wrapper
HIERODULE_USB_Wrapper Wrapper
Extern declaration for the wrapper instance in the source file.
Definition hierodule_usb.c:27

HIERODULE_USB_TransmitPackage
void HIERODULE_USB_TransmitPackage(uint8_t *TX_Buffer, uint32_t Size)
Sets up the data to be transmitted.
Definition hierodule_usb.c:104

HIERODULE_USB_Receive_Callback
void HIERODULE_USB_Receive_Callback(uint8_t *Buf, uint32_t *Len)
Callback function that updates the ring buffer and invokes TC_Handler if it's not NULL.
Definition hierodule_usb.c:116

HIERODULE_USB_ReleaseWrapper
void HIERODULE_USB_ReleaseWrapper(void)
De-initializes the wrapper for the USB peripheral.
Definition hierodule_usb.c:95

HIERODULE_USB_Wrapper
Struct that keeps variables for the ring buffer and a pointer to the transmission end callback routin...
Definition hierodule_usb.h:52

HIERODULE_USB_Wrapper::RX_Buffer
uint8_t * RX_Buffer
The ring buffer where the data received is appended.
Definition hierodule_usb.h:58

HIERODULE_USB_Wrapper::RX_New
uint32_t RX_New
Number of new bytes in the ring buffer.
Definition hierodule_usb.h:66

HIERODULE_USB_Wrapper::RX_BufferSize
uint16_t RX_BufferSize
Number of elements in the ring buffer.
Definition hierodule_usb.h:70

HIERODULE_USB_Wrapper::RX_Index
uint32_t RX_Index
Index of next-byte-to-be-received in the ring buffer.
Definition hierodule_usb.h:62