Log backend ring buffer

Overview

This chapter describes the log backend ring buffer. All APIs provided by the component should be called explicitly by up layer. For examples, if the ring buffer is used as backend of the log component, the function LOG_InitBackendRingbuffer should be called explicitly.

Data Structures
struct	log_backend_ring_buffer_config
	ring buffer configuration structure More...

Typedefs
typedef struct log_backend_ring_buffer_config	log_backend_ring_buffer_config_t
	ring buffer configuration structure

Functions
void	LOG_InitBackendRingbuffer (log_backend_ring_buffer_config_t *config)
	Initializes the backend ringbuffer for log component. More...
void	LOG_DeinitBackendRingbuffer (void)
	De-initializes the backend ringbuffer for log component. More...

---

Data Structure Documentation

struct log_backend_ring_buffer_config

Data Fields
uint8_t *	ringBuffer
	ring buffer address
size_t	ringBufferLength
	ring buffer length

Function Documentation

void LOG_InitBackendRingbuffer

(

log_backend_ring_buffer_config_t *

config

)

This function initializes the backend ringbuffer for log component. The function should be called in application layer. The function should be called after the log component has been initialized (the function LOG_Init has been called).

Parameters

config

Ring buffer configuration for backend ring buffer.

void LOG_DeinitBackendRingbuffer

(

void

)

This function de-initializes the backend ringbuffer for log component.