KAL

Overview

Defines the kernel adaptation layer (KAL), which provides compatible interfaces across different types of OpenHarmony devices.

Since:

1.0

Version:

1.0

Summary

Files

Data Structures

Macros

Enumerations

Functions

Details

Enumeration Type Documentation

KalErrCode

enum [KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36)

Description:

Enumerates return values of the KAL function.

KalTimerType

enum [KalTimerType](KAL.md#gacde4b0c553c297f66311b87c4bbbb27d)

Description:

Enumerates timer types.

Function Documentation

KalDelayUs()

void KalDelayUs (unsigned int us)

Description:

Delays a thread.

The delay unit is microsecond. The actual delay precision can reach only the tick level.

Parameters:

KalGetMemInfo()

[KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36) KalGetMemInfo ([MemInfo](MemInfo.md) * pmemInfo)

Description:

Obtains memory information.

Parameters:

Returns:

Returns an enumerated value defined by KalErrCode, where KAL_OK indicates a success.

KalMsToTick()

unsigned int KalMsToTick (unsigned int millisec)

Description:

Converts milliseconds into system ticks.

Parameters:

Returns:

Returns the system ticks generated.

KalThreadGetInfo()

unsigned int KalThreadGetInfo (unsigned int threadId, [ThreadInfo](ThreadInfo.md) * info )

Description:

Obtains thread information.

Parameters:

Returns:

Returns 0 if the thread information is obtained; returns a negative value otherwise.

KalTickToMs()

unsigned int KalTickToMs (unsigned int ticks)

Description:

Converts system ticks into milliseconds.

Parameters:

Returns:

Returns the milliseconds generated.

KalTimerChange()

[KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36) KalTimerChange (KalTimerId timerId, unsigned int ticks )

Description:

Changes the duration of a timer.

The timer duration can be changed only before the timer is started.

Parameters:

Returns:

Returns an enumerated value defined by KalErrCode, where KAL_OK indicates a success.

KalTimerCreate()

KalTimerId KalTimerCreate (KalTimerProc func, [KalTimerType](KAL.md#gacde4b0c553c297f66311b87c4bbbb27d) type, void * arg, unsigned int ticks )

Description:

Creates a timer.

Parameters:

Returns:

Returns the timer ID; returns NULL in the case of an error.

KalTimerDelete()

[KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36) KalTimerDelete (KalTimerId timerId)

Description:

Deletes a timer.

Parameters:

Returns:

Returns an enumerated value defined by KalErrCode, where KAL_OK indicates a success.

KalTimerIsRunning()

unsigned int KalTimerIsRunning (KalTimerId timerId)

Description:

Checks whether a timer is running.

Parameters:

Returns:

Returns 1 if the timer is running; returns 0 if the timer is not running or the input parameter is incorrect.

KalTimerStart()

[KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36) KalTimerStart (KalTimerId timerId)

Description:

Starts a timer.

Parameters:

Returns:

Returns an enumerated value defined by KalErrCode, where KAL_OK indicates a success.

KalTimerStop()

[KalErrCode](KAL.md#ga595e811b5dcad5dc834be507d6839c36) KalTimerStop (KalTimerId timerId)

Description:

Stops a timer.

Parameters:

Returns:

Returns an enumerated value defined by KalErrCode, where KAL_OK indicates a success.

Variable Documentation

bottomOfStack

unsigned int ThreadInfo::bottomOfStack

Description:

Thread stack bottom

currUsed

unsigned int ThreadInfo::currUsed

Description:

Current stack space usage

eventMask

unsigned int ThreadInfo::eventMask

Description:

Thread event mask

eventStru

unsigned int ThreadInfo::eventStru[3]

Description:

Thread event

free

unsigned int MemInfo::free

Description:

Available space of the memory pool, in bytes

freeLmp

unsigned int MemInfo::freeLmp

Description:

Available space of the small memory pool, in bytes

freeNodeNum

unsigned int MemInfo::freeNodeNum

Description:

Number of available nodes in the memory pool

id

unsigned int ThreadInfo::id

Description:

Thread ID

mallocFailCount

unsigned int MemInfo::mallocFailCount

Description:

Number of memory allocation failures

maxFreeNodeSize

unsigned int MemInfo::maxFreeNodeSize

Description:

Size of the largest available node in the memory pool, in bytes

mepc

unsigned int ThreadInfo::mepc

Description:

Current thread MEPC

mstatus

unsigned int ThreadInfo::mstatus

Description:

Current thread status

name

char ThreadInfo::name[[KAL_TASK_NAME_LEN](KAL.md#ga5c36b53bd6e8cbdbcd79f702eda94fdc)]

Description:

Thread name

overflowFlag

unsigned int ThreadInfo::overflowFlag

Description:

Thread stack overflow flag

peakUsed

unsigned int ThreadInfo::peakUsed

Description:

Peak stack space usage

peekSize

unsigned int MemInfo::peekSize

Description:

Peak memory usage of the memory pool

priority

unsigned short ThreadInfo::priority

Description:

Thread priority

ra

unsigned int ThreadInfo::ra

Description:

Current thread RA

sp

unsigned int ThreadInfo::sp

Description:

Thread stack pointer

stackSize

unsigned int ThreadInfo::stackSize

Description:

Thread stack size

status

unsigned short ThreadInfo::status

Description:

Thread status

taskMutex

void* ThreadInfo::taskMutex

Description:

Thread mutex

taskSem

void* ThreadInfo::taskSem

Description:

Thread semaphore

topOfStack

unsigned int ThreadInfo::topOfStack

Description:

Thread stack top

total

unsigned int MemInfo::total

Description:

Total space of the memory pool, in bytes

totalLmp

unsigned int MemInfo::totalLmp

Description:

Total space of the small memory pool, in bytes

tp

unsigned int ThreadInfo::tp

Description:

Current thread TP

used

unsigned int MemInfo::used

Description:

Used space of the memory pool, in bytes

usedLmp

unsigned int MemInfo::usedLmp

Description:

Used space of the small memory pool, in bytes

usedNodeNum

unsigned int MemInfo::usedNodeNum

Description:

Number of used nodes in the memory pool