TianoCore EDK2 master
Loading...
Searching...
No Matches
Platform Wide Configuration

Macros

#define MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA
 
#define MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA
 
#define MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY
 
#define MIPI_SYST_PCFG_ENABLE_INLINE
 

Detailed Description

These defines enable global features in the SyS-T library.

Macro Definition Documentation

◆ MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY

#define MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY

Enable HEAP usage for handle generation

This macro tells the SyS-T library to enable the heap allocation handle creation API #MIPI_SYST_ALLOC_HANDLE. The platform must provide the macros #MIPI_SYST_HEAP_MALLOC and #MIPI_SYST_HEAP_FREE to point SyS-T to the platform malloc and free functions.

Note: In OS kernel space environments, you must use unpaged memory allocation functions.

Definition at line 422 of file mipi_syst.h.

◆ MIPI_SYST_PCFG_ENABLE_INLINE

#define MIPI_SYST_PCFG_ENABLE_INLINE

Enable 64-bit instruction addresses

Set this define if running in 64-bit code address space. Enable atomic 64-bit write operations

Set this define if your platform supports an atomic 64-bit data write operation. This results in fewer MMIO accesses.The SyS-T library defaults to 2 consecutive 32-Bit writes otherwise. Enable helper function code inlining

Set this define if speed is more important than code size on your platform. It causes several helper function to get inlined, producing faster, but also larger, code.

Definition at line 452 of file mipi_syst.h.

◆ MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA

#define MIPI_SYST_PCFG_ENABLE_PLATFORM_HANDLE_DATA

Extend SyS-T handle data state

This define extends the SyS-T handle state data structure mipi_syst_handle with platform private content. A platform typically stores data for fast trace hardware access in the handle data, for example a volatile pointer to an MMIO space.

The platform example uses mipi_syst_platform_handle as handle state extension.

Definition at line 408 of file mipi_syst.h.

◆ MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA

#define MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA

Extend Platform global SyS-T data state

This define extends the global SyS-T state data structure mipi_syst_header with platform private content. A platform typically stores data for SyS-T handle creation processing in this structure.

Note: This data is not touched by the library code itself, but typically is used by platform hook functions for handle creation and destruction. These hook function calls are not lock protected and may happen concurrently! The hook functions need to implement locking if they modify the platform state data.

The platform example uses #mipi_syst_platform_state as data state extension.

Definition at line 395 of file mipi_syst.h.