Software APIs
Data Fields
usb_logging_stream Struct Reference

Data Fields

usb_logging_ctx_tctx
 Context pointer; for use within callback handler.
 
bool reliable
 Reliable delivery required?
 
bool remap
 Remapping for non-printable characters required?
 
uint8_t ep
 The USB device endpoint that we're using.
 
bool sending
 Currently sending a buffer?
 
usb_logging_buf_tsend_buf
 The oldest logging buffer filled by this stream; this is either being sent (sending == true) or shall be the next to send. More...
 
ibex_timeout_t flush_time
 Time at which the most recently-populated buffer should be sent to the host; prevent log data being retained indefinitely in the event of no further log output.
 
usb_logging_buf_twr_buf
 The current logging buffer; may be partially-filled or full (see bytes_used field), or NULL iff this stream has no pending logging data.
 

Detailed Description

Definition at line 61 of file usb_logging.c.

Field Documentation

◆ ctx

usb_logging_ctx_t* usb_logging_stream::ctx

Context pointer; for use within callback handler.

Definition at line 65 of file usb_logging.c.

◆ ep

uint8_t usb_logging_stream::ep

The USB device endpoint that we're using.

Definition at line 77 of file usb_logging.c.

◆ flush_time

ibex_timeout_t usb_logging_stream::flush_time

Time at which the most recently-populated buffer should be sent to the host; prevent log data being retained indefinitely in the event of no further log output.

Definition at line 93 of file usb_logging.c.

◆ reliable

bool usb_logging_stream::reliable

Reliable delivery required?

Definition at line 69 of file usb_logging.c.

◆ remap

bool usb_logging_stream::remap

Remapping for non-printable characters required?

Definition at line 73 of file usb_logging.c.

◆ send_buf

usb_logging_buf_t* usb_logging_stream::send_buf

The oldest logging buffer filled by this stream; this is either being sent (sending == true) or shall be the next to send.

May be NULL iff this stream has no completed buffers to send.

Definition at line 87 of file usb_logging.c.

◆ sending

bool usb_logging_stream::sending

Currently sending a buffer?

Definition at line 81 of file usb_logging.c.

◆ wr_buf

usb_logging_buf_t* usb_logging_stream::wr_buf

The current logging buffer; may be partially-filled or full (see bytes_used field), or NULL iff this stream has no pending logging data.

Definition at line 98 of file usb_logging.c.