portable.h File Reference

Data Structures
struct	HeapRegion_t
struct	HeapStats_t

Macros
#define	portNUM_CONFIGURABLE_REGIONS
#define	portHAS_STACK_OVERFLOW_CHECKING
#define	portARCH_NAME

Functions
StackType_t *	pxPortInitialiseStack (StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters) PRIVILEGED_FUNCTION
void	vPortDefineHeapRegions (const HeapRegion_t *const pxHeapRegions) PRIVILEGED_FUNCTION
void	vPortGetHeapStats (HeapStats_t *pxHeapStats)
void *	pvPortMalloc (size_t xSize) PRIVILEGED_FUNCTION
void	vPortFree (void *pv) PRIVILEGED_FUNCTION
void	vPortInitialiseBlocks (void) PRIVILEGED_FUNCTION
size_t	xPortGetFreeHeapSize (void) PRIVILEGED_FUNCTION
size_t	xPortGetMinimumEverFreeHeapSize (void) PRIVILEGED_FUNCTION
BaseType_t	xPortStartScheduler (void) PRIVILEGED_FUNCTION
void	vPortEndScheduler (void) PRIVILEGED_FUNCTION

Macro Definition Documentation

#define portARCH_NAME

#define portHAS_STACK_OVERFLOW_CHECKING

#define portNUM_CONFIGURABLE_REGIONS

Function Documentation

void* pvPortMalloc

(

size_t

xSize

)

References configADJUSTED_HEAP_SIZE, configASSERT, heapMINIMUM_BLOCK_SIZE, heapSTRUCT_SIZE, mtCOVERAGE_TEST_MARKER, pdFALSE, pdTRUE, portBYTE_ALIGNMENT, portPOINTER_SIZE_TYPE, prvHeapInit(), prvInsertBlockIntoFreeList, BlockLink_t::pxNextFreeBlock, traceMALLOC, ucHeap, vTaskSuspendAll(), xBlockAllocatedBit, BlockLink_t::xBlockSize, xFreeBytesRemaining, xHeapStructSize, xNextFreeByte, xStart, and xTaskResumeAll().

StackType_t* pxPortInitialiseStack	(	StackType_t *	pxTopOfStack,
		TaskFunction_t	pxCode,
		void *	pvParameters
	)

References portGAP8_ADDITIONAL_EXTENSIONS, portGAP9_ADDITIONAL_EXTENSIONS, and portINITIAL_MSTATUS.

void vPortDefineHeapRegions

(

const HeapRegion_t *const

pxHeapRegions

)

References configASSERT, heapBITS_PER_BYTE, portBYTE_ALIGNMENT, HeapRegion_t::pucStartAddress, pxEnd, BlockLink_t::pxNextFreeBlock, BlockLink_t::xBlockSize, xHeapStructSize, and HeapRegion_t::xSizeInBytes.

void vPortEndScheduler

(

void

)

Referenced by vTaskEndScheduler().

void vPortFree

(

void *

pv

)

References configASSERT, heapSTRUCT_SIZE, mtCOVERAGE_TEST_MARKER, prvInsertBlockIntoFreeList, BlockLink_t::pxNextFreeBlock, traceFREE, vTaskSuspendAll(), BlockLink_t::xBlockSize, xHeapStructSize, and xTaskResumeAll().

void vPortGetHeapStats

(

HeapStats_t *

pxHeapStats

)

References portMAX_DELAY, BlockLink_t::pxNextFreeBlock, taskENTER_CRITICAL, taskEXIT_CRITICAL, vTaskSuspendAll(), HeapStats_t::xAvailableHeapSpaceInBytes, BlockLink_t::xBlockSize, xFreeBytesRemaining, xMinimumEverFreeBytesRemaining, HeapStats_t::xMinimumEverFreeBytesRemaining, HeapStats_t::xNumberOfFreeBlocks, xNumberOfSuccessfulAllocations, HeapStats_t::xNumberOfSuccessfulAllocations, xNumberOfSuccessfulFrees, HeapStats_t::xNumberOfSuccessfulFrees, HeapStats_t::xSizeOfLargestFreeBlockInBytes, HeapStats_t::xSizeOfSmallestFreeBlockInBytes, and xTaskResumeAll().

void vPortInitialiseBlocks

(

void

)

References xNextFreeByte.

size_t xPortGetFreeHeapSize

(

void

)

References configADJUSTED_HEAP_SIZE, xFreeBytesRemaining, and xNextFreeByte.

size_t xPortGetMinimumEverFreeHeapSize

(

void

)

References xMinimumEverFreeBytesRemaining.

BaseType_t xPortStartScheduler

(

void

)

Referenced by vTaskStartScheduler().