portable.h File Reference

#include "deprecated_definitions.h"
#include "portmacro.h"
#include "mpu_wrappers.h"

Include dependency graph for portable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	HeapRegion
struct	xHeapStats

Macros
#define	portUSING_MPU_WRAPPERS   0
#define	portNUM_CONFIGURABLE_REGIONS   1
#define	portHAS_STACK_OVERFLOW_CHECKING   0
#define	portARCH_NAME   NULL
#define	configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0
#define	pvPortMallocStack   pvPortMalloc
#define	vPortFreeStack   vPortFree

Typedefs
typedef struct HeapRegion	HeapRegion_t
typedef struct xHeapStats	HeapStats_t

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 *	pvPortCalloc (size_t xNum, 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

configSTACK_ALLOCATION_FROM_SEPARATE_HEAP

#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0

Definition at line 90 of file portable.h.

portARCH_NAME

#define portARCH_NAME   NULL

Definition at line 85 of file portable.h.

portHAS_STACK_OVERFLOW_CHECKING

#define portHAS_STACK_OVERFLOW_CHECKING   0

Definition at line 81 of file portable.h.

portNUM_CONFIGURABLE_REGIONS

#define portNUM_CONFIGURABLE_REGIONS   1

Definition at line 77 of file portable.h.

portUSING_MPU_WRAPPERS

#define portUSING_MPU_WRAPPERS   0

Definition at line 73 of file portable.h.

pvPortMallocStack

#define pvPortMallocStack   pvPortMalloc

Definition at line 189 of file portable.h.

vPortFreeStack

#define vPortFreeStack   vPortFree

Definition at line 190 of file portable.h.

Typedef Documentation

HeapRegion_t

typedef struct HeapRegion HeapRegion_t

HeapStats_t

typedef struct xHeapStats HeapStats_t

Function Documentation

pvPortCalloc()

void * pvPortCalloc	(	size_t	xNum,
		size_t	xSize )

Definition at line 378 of file heap_4.c.

References heapMULTIPLY_WILL_OVERFLOW, NULL, and pvPortMalloc().

pvPortMalloc()

void * pvPortMalloc

(

size_t

xSize

)

References PRIVILEGED_FUNCTION.

Referenced by osThreadEnumerate(), and pvPortCalloc().

pxPortInitialiseStack()

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

References PRIVILEGED_FUNCTION.

vPortDefineHeapRegions()

void vPortDefineHeapRegions

(

const HeapRegion_t *const

pxHeapRegions

)

References PRIVILEGED_FUNCTION.

Referenced by osKernelInitialize().

vPortEndScheduler()

void vPortEndScheduler

(

void

)

Definition at line 423 of file port.c.

References configASSERT.

Referenced by vTaskEndScheduler().

vPortFree()

void vPortFree

(

void *

pv

)

Definition at line 307 of file heap_4.c.

References configASSERT, heapBLOCK_IS_ALLOCATED, heapFREE_BLOCK, mtCOVERAGE_TEST_MARKER, NULL, prvInsertBlockIntoFreeList(), A_BLOCK_LINK::pxNextFreeBlock, traceFREE, vTaskSuspendAll(), A_BLOCK_LINK::xBlockSize, and xTaskResumeAll().

Referenced by osThreadEnumerate(), vEventGroupDelete(), vQueueDelete(), and vStreamBufferDelete().

vPortGetHeapStats()

void vPortGetHeapStats

(

HeapStats_t *

pxHeapStats

)

Definition at line 505 of file heap_4.c.

References NULL, portMAX_DELAY, A_BLOCK_LINK::pxNextFreeBlock, taskENTER_CRITICAL, taskEXIT_CRITICAL, vTaskSuspendAll(), xHeapStats::xAvailableHeapSpaceInBytes, A_BLOCK_LINK::xBlockSize, xHeapStats::xMinimumEverFreeBytesRemaining, xHeapStats::xNumberOfFreeBlocks, xHeapStats::xNumberOfSuccessfulAllocations, xHeapStats::xNumberOfSuccessfulFrees, xHeapStats::xSizeOfLargestFreeBlockInBytes, xHeapStats::xSizeOfSmallestFreeBlockInBytes, and xTaskResumeAll().

vPortInitialiseBlocks()

void vPortInitialiseBlocks

(

void

)

Definition at line 372 of file heap_4.c.

xPortGetFreeHeapSize()

size_t xPortGetFreeHeapSize

(

void

)

Definition at line 360 of file heap_4.c.

xPortGetMinimumEverFreeHeapSize()

size_t xPortGetMinimumEverFreeHeapSize

(

void

)

Definition at line 366 of file heap_4.c.

xPortStartScheduler()

BaseType_t xPortStartScheduler

(

void

)

Definition at line 297 of file port.c.

References configASSERT, configMAX_SYSCALL_INTERRUPT_PRIORITY, portASPEN_AND_LSPEN_BITS, portCORTEX_M7_r0p0_ID, portCORTEX_M7_r0p1_ID, portCPUID, portFIRST_USER_INTERRUPT_NUMBER, portFPCCR, portMAX_8_BIT_VALUE, portMAX_PRIGROUP_BITS, portNVIC_IP_REGISTERS_OFFSET_16, portNVIC_PENDSV_PRI, portNVIC_SHPR3_REG, portNVIC_SYSTICK_PRI, portPRIGROUP_SHIFT, portPRIORITY_GROUP_MASK, portTOP_BIT_OF_BYTE, prvPortStartFirstTask(), prvTaskExitError(), vPortEnableVFP(), vPortSetupTimerInterrupt(), and vTaskSwitchContext().

Referenced by vTaskStartScheduler().