HPM SDK
HPMicro Software Development Kit
hpm_log_engine_config Struct Reference

#include <hpm_log.h>

Data Fields

void(* transfer_start )(const char *buf, uint32_t len)
 Function pointer to start data transfer. More...
 
void(* transfer_block )(const char *buf, uint32_t len)
 Function pointer to transfer a block of data. More...
 
char * transfer_buf
 Pointer to the transfer buffer. More...
 
uint32_t max_transfer_size
 Maximum size of the transfer buffer. More...
 
char * fifo_buf
 Pointer to the FIFO buffer. More...
 
uint32_t fifo_buf_size
 Size of the FIFO buffer. More...
 

Field Documentation

◆ fifo_buf

char* hpm_log_engine_config::fifo_buf

Pointer to the FIFO buffer.

This buffer is used as a FIFO queue to store log messages before transfer.

◆ fifo_buf_size

uint32_t hpm_log_engine_config::fifo_buf_size

Size of the FIFO buffer.

This value specifies the maximum number of bytes that the FIFO buffer can hold.

◆ max_transfer_size

uint32_t hpm_log_engine_config::max_transfer_size

Maximum size of the transfer buffer.

This value specifies the maximum number of bytes that can be transferred at once.

◆ transfer_block

void(* hpm_log_engine_config::transfer_block) (const char *buf, uint32_t len)

Function pointer to transfer a block of data.

This function is called to transfer a block of data.

Parameters
bufPointer to the buffer containing the data to be transferred.
lenLength of the data in the buffer.

◆ transfer_buf

char* hpm_log_engine_config::transfer_buf

Pointer to the transfer buffer.

This buffer is used to hold the data to be transferred(if DMA is used, the buffer can use to transfer).

◆ transfer_start

void(* hpm_log_engine_config::transfer_start) (const char *buf, uint32_t len)

Function pointer to start data transfer.

This function is called to start the transfer of a buffer of data.

Parameters
bufPointer to the buffer containing the data to be transferred.
lenLength of the data in the buffer.

The documentation for this struct was generated from the following file: