Skip to content

File portable.h

FileList > FreeRTOS > include > portable.h

Go to the source code of this file.

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

Classes

Type Name
struct HeapRegion
struct xHeapStats

Public Types

Type Name
typedef struct HeapRegion HeapRegion_t
typedef struct xHeapStats HeapStats_t

Public Functions

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

Macros

Type Name
define portARCH_NAME NULL
define portHAS_STACK_OVERFLOW_CHECKING 0
define portNUM_CONFIGURABLE_REGIONS 1

Public Types Documentation

typedef HeapRegion_t

typedef struct HeapRegion HeapRegion_t;

typedef HeapStats_t

typedef struct xHeapStats HeapStats_t;

Public Functions Documentation

function pvPortMalloc

void * pvPortMalloc (
    size_t xSize
) 

function pxPortInitialiseStack

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

function vPortDefineHeapRegions

void vPortDefineHeapRegions (
    const HeapRegion_t *const pxHeapRegions
) 

function vPortEndScheduler

void vPortEndScheduler (
    void
) 

function vPortFree

void vPortFree (
    void * pv
) 

function vPortGetHeapStats

void vPortGetHeapStats (
    HeapStats_t * pxHeapStats
) 

function vPortInitialiseBlocks

void vPortInitialiseBlocks (
    void
) 

function xPortGetFreeHeapSize

size_t xPortGetFreeHeapSize (
    void
) 

function xPortGetMinimumEverFreeHeapSize

size_t xPortGetMinimumEverFreeHeapSize (
    void
) 

function xPortStartScheduler

BaseType_t xPortStartScheduler (
    void
) 

Macro Definition Documentation

define portARCH_NAME

#define portARCH_NAME NULL

define portHAS_STACK_OVERFLOW_CHECKING

#define portHAS_STACK_OVERFLOW_CHECKING 0

define portNUM_CONFIGURABLE_REGIONS

#define portNUM_CONFIGURABLE_REGIONS 1

The documentation for this class was generated from the following file fw/rbcx-coprocessor/lib/FreeRTOS/include/portable.h