Difference between revisions of "Unit Platform"
From Ultibo.org
| Line 2,926: | Line 2,926: | ||
! '''Mode''' | ! '''Mode''' | ||
| The pull state to set for the pin (eg GPIO_PULL_UP) | | The pull state to set for the pin (eg GPIO_PULL_UP) | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | ERROR_SUCCESS if completed successfully or another error code on failure | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function GPIOFunctionGet(Pin:LongWord):LongWord; inline;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current function of a GPIO pin</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Pin''' | ||
| + | | The pin to get the function for (eg GPIO_PIN_1) | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | \\\\\\\\\\\\\\\\\\\\not in wiki | ||
| + | |||
| + | \\\\\\\\\\\\\\\\\\\\not in wiki | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function GPIOFunctionSelect(Pin,Mode:LongWord):LongWord; inline;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Change the function of a GPIO pin</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Pin''' | ||
| + | | The pin to change the function for (eg GPIO_PIN_1) | ||
| + | |- | ||
| + | ! '''Mode''' | ||
| + | | The function to set for the pin (eg GPIO_FUNCTION_OUT) | ||
|- | |- | ||
! '''Return''' | ! '''Return''' | ||
Revision as of 05:28, 30 November 2016
Return to Unit Reference
Description
To be documented
Constants
DMA data flag constants
DMA_DATA_FLAG_* DMA_DATA_FLAG_NONE = $00000000;
|
|
DMA_DATA_FLAG_STRIDE = $00000001;
|
Transfer from the source to the destination using 2D stride (If supported) |
DMA_DATA_FLAG_SOURCE_NOINCREMENT = $00000002;
|
Don't increment the source address during the DMA request (If supported) |
DMA_DATA_FLAG_DEST_NOINCREMENT = $00000004;
|
Don't increment the dest address during the DMA request (If supported) |
DMA_DATA_FLAG_SOURCE_DREQ = $00000008;
|
Use DREQ gating on the source address during the DMA request (If supported) |
DMA_DATA_FLAG_DEST_DREQ = $00000010;
|
Use DREQ gating on the dest address during the DMA request (If supported) |
DMA_DATA_FLAG_SOURCE_WIDE = $00000020;
|
Use wide reads on the source address during the DMA request (If supported) |
DMA_DATA_FLAG_DEST_WIDE = $00000040;
|
Use wide writes on the dest address during the DMA request (If supported) |
DMA_DATA_FLAG_NOREAD = $00000080;
|
Ignore the source address and zero fill the destination (If supported) |
DMA_DATA_FLAG_NOWRITE = $00000100;
|
Ignore the dest address and cache fill from the source (If supported) |
DMA_DATA_FLAG_NOCLEAN = $00000200;
|
Do not perform cache clean on the source address (If applicable) |
DMA_DATA_FLAG_NOINVALIDATE = $00000400;
|
Do not perform cache invalidate on the dest address (If applicable) |
DMA_DATA_FLAG_BULK = $00000800;
|
Perform a bulk transfer (If applicable) |
Page table flag constants
PAGE_TABLE_FLAG_* PAGE_TABLE_FLAG_NONE = $00000000;
|
|
| Reserved 0x00000001 (Previously used incorrectly for PAGE_TABLE_FLAG_NONE) | |
PAGE_TABLE_FLAG_NORMAL = $00000002;
|
Page Table Entry represents Normal memory |
PAGE_TABLE_FLAG_DEVICE = $00000004;
|
Page Table Entry represents Device memory |
PAGE_TABLE_FLAG_ORDERED = $00000008;
|
Page Table Entry represents Ordered memory |
PAGE_TABLE_FLAG_SHARED = $00000010;
|
Page Table Entry represents Shared memory |
PAGE_TABLE_FLAG_CACHEABLE = $00000020;
|
Page Table Entry represents Cacheable memory |
PAGE_TABLE_FLAG_READONLY = $00000040;
|
Page Table Entry represents Read Only memory |
PAGE_TABLE_FLAG_READWRITE = $00000080;
|
Page Table Entry represents Read Write memory |
PAGE_TABLE_FLAG_EXECUTABLE = $00000100;
|
Page Table Entry represents Executable memory |
PAGE_TABLE_FLAG_WRITEBACK = $00000200;
|
Page Table Entry is Writeback Cacheable memory |
PAGE_TABLE_FLAG_WRITETHROUGH = $00000400;
|
Page Table Entry is Writethrough Cacheable memory |
PAGE_TABLE_FLAG_WRITEALLOCATE = $00000800;
|
Page Table Entry is Writeallocate Cacheable memory |
Vector table entry constants
VECTOR_TABLE_ENTRY_* | ARM | |
VECTOR_TABLE_ENTRY_ARM_RESET = 0;
|
ARM Reset Vector |
VECTOR_TABLE_ENTRY_ARM_UNDEFINED = 1;
|
ARM Undefined Vector |
VECTOR_TABLE_ENTRY_ARM_SWI = 2;
|
ARM Software Interrupt (SWI) Vector |
VECTOR_TABLE_ENTRY_ARM_PREFETCH = 3;
|
ARM Prefetch Abort Vector |
VECTOR_TABLE_ENTRY_ARM_ABORT = 4;
|
ARM Data Abort Vector |
VECTOR_TABLE_ENTRY_ARM_RESERVED = 5;
|
ARM Reserved Vector |
VECTOR_TABLE_ENTRY_ARM_IRQ = 6;
|
ARM IRQ Vector |
VECTOR_TABLE_ENTRY_ARM_FIQ = 7;
|
ARM FIQ Vector |
| AARCH64 | |
Exception type constants
EXCEPTION_TYPE_* EXCEPTION_TYPE_DATA_ABORT = 1;
|
|
EXCEPTION_TYPE_PREFETCH_ABORT = 2;
|
|
EXCEPTION_TYPE_UNDEFINED_INSTRUCTION = 3;
|
Platform logging constants
PLATFORM_LOG_LEVEL_* PLATFORM_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;
|
Platform debugging messages |
PLATFORM_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
Platform informational messages |
PLATFORM_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
Platform error messages |
PLATFORM_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No Platform messages |
IRQ logging constants
IRQ_LOG_LEVEL_* IRQ_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;
|
IRQ debugging messages |
IRQ_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
IRQ informational messages |
IRQ_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
IRQ error messages |
IRQ_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No IRQ messages |
FIQ logging constants
FIQ_LOG_LEVEL_* FIQ_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;
|
FIQ debugging messages |
FIQ_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
FIQ informational messages |
FIQ_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
FIQ error messages |
FIQ_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No FIQ messages |
SWI logging constants
SWI_LOG_LEVEL_* DEBUG = LOG_LEVEL_DEBUG;
|
SWI debugging messages |
SWI_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
SWI informational messages |
SWI_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
SWI error messages |
SWI_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No SWI messages |
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure PlatformInit;
Description: Initialize platform specific information for the current hardware
| Note | None documented |
|---|
procedure CPUInit;
Description: Initialize the CPU including performance features etc (Where Applicable)
| Note | None documented |
|---|
procedure FPUInit;
Description: Initialize the Floating Point Processor Unit (Where Applicable)
| Note | None documented |
|---|
procedure GPUInit;
Description: Initialize the Graphics Processor Unit (Where Applicable)
| Note | None documented |
|---|
procedure MMUInit;
Description: Initialize the Memory Management Unit (Where Applicable)
| Note | None documented |
|---|
procedure SMPInit;
Description: Initialize the Symetric Multi Processor support (Where Applicable)
| Note | Secondary CPU boot is performed by SecondaryInit in Threads |
|---|
procedure CacheInit;
Description: Initialize CPU Data and Instruction Caching (Where Applicable)
| Note | None documented |
|---|
procedure BoardInit;
Description: Initialize Board specific information (Where Applicable)
| Note | None documented |
|---|
procedure MemoryInit;
Description: Initialize Memory specific information (Where Applicable)
| Note | None documented |
|---|
procedure ClockInit;
Description: Initialize the Clock handling
| Note | None documented |
|---|
procedure PowerInit;
Description: Initialize Power management (Where Applicable)
| Note | None documented |
|---|
procedure MailboxInit;
Description: Initialize Mailbox access (Where Applicable)
| Note | None documented |
|---|
procedure InterruptInit;
Description: Initialize Interrupt handling
| Note | None documented |
|---|
procedure PeripheralInit;
Description: Initialize Peripheral devices (Where Applicable)
| Note | None documented |
|---|
procedure ParseBootTags;
Description: Parse any boot tag information passed by the bootloader (Where Applicable)
| Note | None documented |
|---|
procedure ParseCommandLine;
Description: Setup argc, argv and cmdline and process known command line options (Where Applicable)
| Note | None documented |
|---|
procedure ParseEnvironment;
Description: Setup envp and process known environment options (Where Applicable)
| Note | None documented |
|---|
Boot functions
procedure BootBlink; inline;
Description: Blink the Activity LED (Where Applicable)
| Note | Intended for startup diagnostics when bootstrapping a new board |
|---|
procedure BootOutput(Value:LongWord); inline;
Description: Output boot time information (Where Applicable)
| Note | Intended for startup diagnostics when bootstrapping a new board |
|---|
LED functions
procedure PowerLEDEnable; inline;
Description: Enable the Power LED (Where Applicable)
| Note | None documented |
|---|
procedure PowerLEDOn; inline;
Description: Turn On the Power LED (Where Applicable)
| Note | None documented |
|---|
procedure PowerLEDOff; inline;
Description: Turn Off the Power LED (Where Applicable)
| Note | None documented |
|---|
procedure ActivityLEDEnable; inline;
Description: Enable the Activity LED (Where Applicable)
| Note | None documented |
|---|
procedure ActivityLEDOn; inline;
Description: Turn On the Activity LED (Where Applicable)
| Note | None documented |
|---|
procedure ActivityLEDOff; inline;
Description: Turn Off the Activity LED (Where Applicable)
| Note | None documented |
|---|
Counter functions (Timer device)
function CounterAvailable:Boolean; inline;
Description: Check if a counter is currently available
| Note | None documented |
|---|
function CounterRead:LongWord; inline;
Description: Read the current value of the default counter
| Return | The 32 bit current value of the counter or 0 on failure |
|---|
function CounterRead64:Int64; inline;
Description: Read the current value of the default counter
| Return | The 64 bit current value of the counter or 0 on failure |
|---|
function CounterWait:LongWord; inline;
Description: Wait for the current interval to expire on the default counter
| Return | ERROR_SUCCESS if the interval expired or another error code on failure |
|---|
function CounterEvent(Callback:TCounterCallback; Data:Pointer):LongWord; inline;
Description: Schedule a function to be called when the current interval expires on the default counter
| Callback | The function to be called when the interval expires |
|---|---|
| Data | A pointer to be pass to the function when the interval expires (Optional) |
| Return | ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure |
function CounterCancel:LongWord; inline;
Description: Cancel a previously scheduled event callback function on the default counter
| Return | ERROR_SUCCESS if the callback was cancelled successfully or another error code on failure |
|---|
function CounterGetRate:LongWord; inline;
Description: Get the current clock rate in Hz of the default counter
| Return | The current clock rate in Hz or 0 on failure |
|---|
function CounterSetRate(Rate:LongWord):LongWord; inline;
Description: Set the current clock rate in Hz of the default counter
| Rate | The clock rate in Hz to set |
|---|---|
| Return | ERROR_SUCCESS if the clock rate was set or another error code on failure |
function CounterGetInterval:LongWord; inline;
Description: Get the current interval in ticks of the default counter
| Return | The current interval in ticks or 0 on failure (or not set) |
|---|---|
| Note | The tick rate is determined by the clock rate |
function CounterSetInterval(Interval:LongWord):LongWord; inline;
Description: Set the current interval in ticks of the default counter
| Interval | The interval in ticks to set |
|---|---|
| Return | ERROR_SUCCESS if the interval was set or another error code on failure |
| Note | The tick rate is determined by the clock rate |
Mailbox functions
function MailboxReceive(Mailbox,Channel:LongWord):LongWord; inline;
Description: Receive from specified mailbox on specified channel
| Note | None documented |
|---|
procedure MailboxSend(Mailbox,Channel,Data:LongWord); inline;
Description: Send to specified mailbox on specified channel
| Note | None documented |
|---|
function MailboxCall(Mailbox,Channel,Data:LongWord; var Response:LongWord):LongWord; inline;
Description: Perform a transaction (Send/Receive) to specified mailbox on specified channel
| Note | None documented |
|---|
function MailboxCallEx(Mailbox,Channel,Data:LongWord; var Response:LongWord; Timeout:LongWord):LongWord; inline;
Description: Perform a transaction (Send/Receive) to specified mailbox on specified channel
| Note | None documented |
|---|
function MailboxPropertyCall(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord):LongWord; inline;
Description: Perform a property tag transaction (Send/Receive) to specified mailbox on specified channel
| Note | None documented |
|---|
function MailboxPropertyCallEx(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord; Timeout:LongWord):LongWord; inline;
Description: Perform a property tag transaction (Send/Receive) to specified mailbox on specified channel
| Note | None documented |
|---|
Random number functions
function RandomAvailable:Boolean; inline;
Description: Check if a hardware random number generator is currently available
| Note | The software random number generator from the RTL is always available |
|---|
procedure RandomSeed(Seed:LongWord); inline;
Description: To be documented
| Note | None documented |
|---|
function RandomReadLongInt(Limit:LongInt):LongInt; inline;
Description: To be documented
| Note | None documented |
|---|
function RandomReadInt64(Limit:Int64):Int64; inline;
Description: To be documented
| Note | None documented |
|---|
function RandomReadExtended:Extended; inline;
Description: To be documented
| Note | None documented |
|---|
Watchdog Timer Functions
function WatchdogAvailable:Boolean; inline;
Description: Check if a watchdog timer is currently available
| Note | None documented |
|---|
function WatchdogStart(Milliseconds:LongWord):LongWord; inline;
Description: To be documented
| Note | None documented |
|---|
function WatchdogStop:LongWord; inline;
Description: To be documented
| Note | None documented |
|---|
function WatchdogRefresh(Milliseconds:LongWord):LongWord; inline;
Description: To be documented
| Note | None documented |
|---|
Interrupt request (IRQ) functions
function RequestIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; Parameter:Pointer):LongWord; inline;
Description: Request registration of the supplied handler to the specified IRQ number
| Note | If the IRQ number is already registered then the request will fail |
|---|
function ReleaseIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; Parameter:Pointer):LongWord; inline;
Description: Request deregistration of the supplied handler from the specified IRQ number
| Note | If the IRQ number is not currently registered then the request will fail |
|---|
function RequestExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord; inline;
Description: Request registration of the supplied extended handler to the specified IRQ number
| Note | If the IRQ number is already registered then the request will fail |
|---|
function ReleaseExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord; inline;
Description: Request deregistration of the supplied extended handler from the specified IRQ number
| Note | If the IRQ number is not currently registered then the request will fail |
|---|
Fast interrupt request (FIQ) functions
function RequestFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; Parameter:Pointer):LongWord; inline;
Description: Request registration of the supplied handler to the specified FIQ number (Where Applicable)
| Note | If the FIQ number is already registered then the request will fail |
|---|
function ReleaseFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; Parameter:Pointer):LongWord; inline;
Description: Request deregistration of the supplied handler from the specified FIQ number (Where Applicable)
| Note | If the FIQ number is not currently registered then the request will fail |
|---|
function RequestExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord; inline;
Description: Request registration of the supplied extended handler to the specified FIQ number (Where Applicable)
| Note | If the FIQ number is already registered then the request will fail |
|---|
function ReleaseExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord; inline;
Description: Request deregistration of the supplied extended handler from the specified FIQ number (Where Applicable)
| Note | If the FIQ number is not currently registered then the request will fail |
|---|
System call (Software Interrupt or SWI) functions
procedure SystemCall(Number:LongWord; Param1,Param2,Param3:PtrUInt); inline;
Description: Perform a System Call function with the supplied parameters (Where Applicable)
| Number | The System Call number to be called |
|---|---|
| Param1 | The first parameter to pass to the function (Optional / Function defined) |
| Param2 | The second parameter to pass to the function (Optional / Function defined) |
| Param3 | The third parameter to pass to the function (Optional / Function defined) |
function RegisterSystemCall(Number:LongWord; Handler:TSystemCallHandler):LongWord; inline;
Description: Request registration of the supplied handler to the specified System Call number (Where Applicable)
| Number | The System Call number to be registered |
|---|---|
| Handler | The handler function to be registered |
| Note | If the System Call number is already registered then the request will fail |
function DeregisterSystemCall(Number:LongWord; Handler:TSystemCallHandler):LongWord; inline;
Description: Request deregistration of the supplied handler from the specified System Call number (Where Applicable)
| Number | The System Call number to be deregistered |
|---|---|
| Handler | The handler function to be deregistered |
| Note | If the System Call number is not currently registered then the request will fail |
function RegisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord; inline;
Description: Request registration of the supplied extended handler to the specified System Call number (Where Applicable)
| CPUID | The CPU ID to register the System Call against (or CPU_ID_ALL) |
|---|---|
| Number | The System Call number to be registered |
| Handler | The handler function to be registered (Optional) (Handler or HandlerEx must be specified, not both) |
| HandlerEx | The extended handler function to be registered (Optional) (Handler or HandlerEx must be specified, not both) |
| Note | If the System Call number is already registered then the request will fail |
function DeregisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord; inline;
Description: Request deregistration of the supplied extended handler from the specified System Call number (Where Applicable)
| CPUID | The CPU ID to deregister the System Call from (or CPU_ID_ALL) |
|---|---|
| Number | The System Call number to be deregistered |
| Handler | The handler function to be deregistered (Optional) (Handler or HandlerEx must be specified, not both) |
| HandlerEx | The extended handler function to be deregistered (Optional) (Handler or HandlerEx must be specified, not both) |
| Note | If the System Call number is not currently registered then the request will fail |
Interrupt entry functions
function GetInterruptCount:LongWord; inline;
Description: Get the number of interrupt entries for the current platform
| Note | None documented |
|---|
function GetInterruptStart:LongWord; inline;
Description: Get the starting number of interrupt entries for the current platform
| Note | None documented |
|---|
function GetInterruptEntry(Number:LongWord):TInterruptEntry; inline;
Description: Get the interrupt entry for the specified interrupt number
| Note | None documented |
|---|
Local interrupt entry functions
function GetLocalInterruptCount:LongWord; inline;
Description: Get the number of local interrupt entries for the current platform (Where Applicable)
| Note | None documented |
|---|
function GetLocalInterruptStart:LongWord; inline;
Description: Get the starting number of local interrupt entries for the current platform (Where Applicable)
| Note | None documented |
|---|
function GetLocalInterruptEntry(CPUID,Number:LongWord):TInterruptEntry; inline;
Description: Get the local interrupt entry for the specified interrupt number (Where Applicable)
| Note | None documented |
|---|
System call entry functions
function GetSystemCallCount:LongWord; inline;
Description: Get the number of system call entries for the current platform (Where Applicable)
| Note | None documented |
|---|
function GetSystemCallEntry(Number:LongWord):TSystemCallEntry; inline;
Description: Get the system call entry for the specified system call number (Where Applicable)
| Note | None documented |
|---|
System functions
function SystemRestart(Delay:LongWord):LongWord; inline;
Description: Restart the system
| Note | None documented |
|---|
function SystemShutdown(Delay:LongWord):LongWord; inline;
Description: Shutdown the system
| Note | None documented |
|---|
function SystemGetUptime:Int64; inline;
Description: Get the current system up time in 100 nanosecond ticks since 1/1/1601
| Return | The current system up time |
|---|---|
| Note | This is the same time format as Windows FILE_TIME and is intended to allow compatibility with file system functions etc |
function SystemGetCommandLine:String; inline;
Description: Get the current command line
| Note | None documented |
|---|
function SystemGetEnvironment:Pointer; inline;
Description: Get the current environment
| Note | None documented |
|---|
CPU Functions
function CPUGetArch:LongWord; inline;
Description: Get the CPU architecture for this board
| Note | None documented |
|---|
function CPUGetType:LongWord; inline;
Description: Get the CPU type for this board
| Note | None documented |
|---|
function CPUGetBoot:LongWord; inline;
Description: Get the boot CPU for this board
| Note | None documented |
|---|
function CPUGetMask:LongWord; inline;
Description: Get the CPU mask for this board
| Note | None documented |
|---|
function CPUGetCount:LongWord; inline;
Description: Get the CPU count for this board
| Note | None documented |
|---|
function CPUGetMode:LongWord; inline;
Description: Get the current CPU moded
| Note | The return value is specific to the CPU type |
|---|
function CPUGetState:LongWord; inline;
Description: Get the current CPU state
| Note | None documented |
|---|
function CPUGetCurrent:LongWord; inline;
Description: Get the current CPU ID
| Note | None documented |
|---|
function CPUGetMemory(var Address:PtrUInt; var Length:LongWord):LongWord; inline;
Description: Get the memory start and size available to the CPU
| Note | None documented |
|---|
function CPUGetPercentage(CPUID:LongWord):Double; inline;
Description: Get the last second ulitization of the specified CPU in percentage
| CPUID | The CPU to get utilization from or CPU_ID_ALL for average of all CPUs |
|---|
function CPUGetUtilization(CPUID:LongWord):LongWord; inline;
Description: Get the last second ulitization of the specified CPU
| CPUID | The CPU to get utilization from or CPU_ID_ALL for average of all CPUs |
|---|
function CPUGetModel:LongWord; inline;
Description: Get the CPU model of the current CPU
| Note | None documented |
|---|
function CPUGetRevision:LongWord; inline;
Description: Get the CPU revision of the current CPU
| Note | The return value is specific to the CPU type and model |
|---|
function CPUGetDescription:String; inline;
Description: Get the CPU description of the current CPU
| Note | None documented |
|---|
FPU functions
function FPUGetType:LongWord; inline;
Description: Get the FPU type for this board
| Note | None documented |
|---|
function FPUGetState:LongWord; inline;
Description: Get the current FPU state
| Note | None documented |
|---|
GPU functions
function GPUGetType:LongWord; inline;
Description: Get the GPU type for this board
| Note | None documented |
|---|
function GPUGetState:LongWord; inline;
Description: Get the current GPU state
| Note | None documented |
|---|
function GPUGetMemory(var Address:PtrUInt; var Length:LongWord):LongWord; inline;
Description: Get the memory start and size available to the GPU
| Note | None documented |
|---|
Cache functions
function L1CacheGetType:LongWord; inline;
Description: Get the L1 cache type for this board
| Note | None documented |
|---|
function L1DataCacheGetSize:LongWord; inline;
Description: Get the L1 data cache size for this board
| Note | If data cache is not supported, the size returned is zero. If separate data and instruction caches are not supported, the size returned is the unified size. |
|---|
function L1DataCacheGetLineSize:LongWord; inline;
Description: Get the L1 data cache line size for this board
| Note | If data cache is not supported, the size returned is zero. If separate data and instruction caches are not supported, the size returned is the unified size. |
|---|
function L1InstructionCacheGetSize:LongWord; inline;
Description: Get the L1 instruction cache size for this board
| Note | If instruction cache is not supported, the size returned is zero. If separate data and instruction caches are not supported, the size returned is the unified size. |
|---|
function L1InstructionCacheGetLineSize:LongWord; inline;
Description: Get the L1 instruction cache line size for this board
| Note | If instruction cache is not supported, the size returned is zero. If separate data and instruction caches are not supported, the size returned is the unified size. |
|---|
function L2CacheGetType:LongWord; inline;
Description: Get the L2 cache type for this board
| Note | None documented |
|---|
function L2CacheGetSize:LongWord; inline;
Description: Get the L2 cache size for this board
| Note | If L2 cache is not supported, the size returned is zero |
|---|
function L2CacheGetLineSize:LongWord; inline;
Description: Get the L2 cache line size for this board
| Note | If L2 cache is not supported, the size returned is zero |
|---|
Board functions
function BoardGetType:LongWord; inline;
Description: Get the current Board type
| Note | None documented |
|---|
function BoardGetModel:LongWord; inline;
Description: Get the current Board model
| Note | None documented |
|---|
function BoardGetSerial:Int64; inline;
Description: Get the current Board serial number
| Note | None documented |
|---|
function BoardGetRevision:LongWord; inline;
Description: Get the current Board revision number
| Note | None documented |
|---|
function BoardGetMACAddress:String; inline;
Description: Get the current Board MAC address (Where Applicable)
| Note | None documented |
|---|
Firmware functions
function FirmwareGetRevision:LongWord; inline;
Description: Get the current board Firmware Revision
| Note | None documented |
|---|
Machine functions
function MachineGetType:LongWord; inline;
Description: Get the current Machine type
| Note | None documented |
|---|
Memory functions
function MemoryGetBase:PtrUInt; inline;
Description: Get the base address of system memory
| Note | None documented |
|---|
function MemoryGetSize:LongWord; inline;
Description: Get the total size of system memory
| Note | None documented |
|---|
function MemoryGetPageSize:LongWord; inline;
Description: Get the page size of system memory
| Note | None documented |
|---|
function MemoryGetLargePageSize:LongWord; inline;
Description: Get the large page size of system memory (Where Applicable)
| Note | None documented |
|---|
Power functions
function PowerOn(PowerId:LongWord):LongWord;
Description: Power On the specified device
| Note | None documented |
|---|
function PowerOff(PowerId:LongWord):LongWord;
Description: Power Off the specified device
| Note | None documented |
|---|
function PowerGetWait(PowerId:LongWord):LongWord; inline;
Description: Get the enable wait time in Microseconds of the specified device
| Note | None documented |
|---|
function PowerGetState(PowerId:LongWord):LongWord; inline;
Description: Get the power state of the specified device
| Note | None documented |
|---|
function PowerSetState(PowerId,State:LongWord; Wait:Boolean):LongWord; inline;
Description: Set the power state of the specified device (Optionally waiting for ready)
| Note | None documented |
|---|
Clock functions
function ClockGetTime:Int64;
Description: Get the current system time in 100 nanosecond ticks since 1/1/1601
| Return | The current system time |
|---|---|
| Note | This is the same time format as Windows FILE_TIME and is intended to allow compatibility with file system functions etc. By default the time returned by this function is considered to be UTC but the actual conversion between UTC and local time is handled at a higher level. |
function ClockSetTime(const Time:Int64; RTC:Boolean):Int64;
Description: Set the current system time in 100 nanosecond ticks since 1/1/1601
| Time | The time to be set |
|---|---|
| RTC | Set the default RTC (real time clock) if available |
| Return | The system time after setting |
| Note | This is the same time format as Windows FILE_TIME and is intended to allow compatibility with file system functions etc. By default the time passed to this function is considered to be UTC but the actual conversion between UTC and local time is handled at a higher level. |
function ClockGetCount:LongWord; inline;
Description: Gets the current system clock count (32 least significant bits of total)
| Note | This will normally come from the free running system timer in the board and is useful as a form of tick count but not for time keeping because the actual rate at which this increments is dependent on the system timer clock frequency of the specific board and may not be a measure of time in its raw form. |
|---|
function ClockGetTotal:Int64; inline;
Description: Gets the total system clock count
| Note | This will normally come from the free running system timer in the board and is useful as a form of tick count but not for time keeping because the actual rate at which this increments is dependent on the system timer clock frequency of the specific board and may not be a measure of time in its raw form. |
|---|
function Clock?pdateOffset:LongWord; inline;
Description: Change the system time offset between UTC and Local
| Note | None documented |
|---|
function ClockGetRate(ClockId:LongWord):LongWord; inline;
Description: Get the clock rate in Hz of the specified Clock
| Note | None documented |
|---|
function ClockSetRate(ClockId,Rate:LongWord; Turbo:Boolean):LongWord; inline;
Description: Set the clock rate in Hz of the specified Clock
| Note | None documented |
|---|
function ClockGetState(ClockId:LongWord):LongWord; inline;
Description: Get the state of the specified Clock
| Note | None documented |
|---|
function ClockSetState(ClockId,State:LongWord):LongWord; inline;
Description: Set the state of the specified Clock
| Note | None documented |
|---|
function ClockGetMinRate(ClockId:LongWord):LongWord; inline;
Description: Get the minimum clock rate in Hz of the specified Clock
| Note | None documented |
|---|
function ClockGetMaxRate(ClockId:LongWord):LongWord; inline;
Description: Get the maximum clock rate in Hz of the specified Clock
| Note | None documented |
|---|
Turbo functions
function TurboGetState(TurboId:LongWord):LongWord; inline;
Description: Get the Turbo state (0 equals Off / 1 equals On) of the specified device
| Note | None documented |
|---|
function TurboSetState(TurboId,State:LongWord):LongWord; inline;
Description: Set the Turbo state (0 equals Off / 1 equals On) of the specified device
| Note | None documented |
|---|
Voltage functions
function VoltageGetValue(VoltageId:LongWord):LongWord; inline;
Description: Get the current voltage level of the specified device
| Note | None documented |
|---|
function VoltageSetValue(VoltageId,Value:LongWord):LongWord; inline;
Description: Set the current voltage level of the specified device
| Note | None documented |
|---|
function VoltageGetMinValue(VoltageId:LongWord):LongWord; inline;
Description: Get the minimum voltage level of the specified device
| Note | None documented |
|---|
function VoltageGetMaxValue(VoltageId:LongWord):LongWord; inline;
Description: Get the maximum voltage level of the specified device
| Note | None documented |
|---|
Temperature functions
function TemperatureGetCurrent(TemperatureId:LongWord):LongWord; inline;
Description: Get the current temperature in thousandths of a degree C of the specified device
| Note | None documented |
|---|
function TemperatureGetMaximum(TemperatureId:LongWord):LongWord; inline;
Description: Get the maximum temperature in thousandths of a degree C of the specified device
| Note | None documented |
|---|
GPU memory functions
function GPUMemoryAllocate(Length,Alignment,Flags:LongWord):THandle; inline;
Description: Allocate memory from the GPU
| Note | None documented |
|---|
function GPUMemoryRelease(Handle:THandle):LongWord; inline;
Description: Release memory allocated from the GPU
| Note | None documented |
|---|
function GPUMemoryLock(Handle:THandle):LongWord; inline;
Description: Lock memory allocated from the GPU and return an address
| Note | None documented |
|---|
function GPUMemoryUnlock(Handle:THandle):LongWord; inline;
Description: Unlock memory allocated from the GPU
| Note | None documented |
|---|
GPU misc functions
function GPUExecuteCode(Address:Pointer; R0,R1,R2,R3,R4,R5:LongWord):LongWord; inline;
Description: Execute a block of code on the GPU
| Note | None documented |
|---|
function DispmanxHandleGet(Resource:THandle):THandle; inline;
Description: Convert a Dispmanx Resouse handle to a Memory handle (Which can be passed to Lock/Unlock above)
| Note | None documented |
|---|
function EDIDBlockGet(Block:LongWord; Buffer:Pointer; Length:LongWord):LongWord; inline;
Description: Get an EDID block from HDMI
| Note | None documented |
|---|
Framebuffer functions
function FramebufferAvailable:Boolean; inline;
Description: Check if a framebuffer device is currently available
| Note | None documented |
|---|
function FramebufferAllocate(Alignment:LongWord; var Address,Length:LongWord):LongWord; inline;
Description: Allocate a new Framebuffer
| Note | None documented |
|---|
function FramebufferRelease:LongWord; inline;
Description: Release the current Framebuffer
| Note | None documented |
|---|
function FramebufferSetState(State:LongWord):LongWord; inline;
Description: Set the current Framebuffer (Display) state (0 for Off / 1 for On)
| Note | None documented |
|---|
function FramebufferGetDimensions(var Width,Height,Top,Bottom,Left,Right:LongWord):LongWord; inline;
Description: Get the default Dimensions of the Framebuffer (Physical Width, Height and Overscan Top, Bottom, Left, Right in Pixels)
| Note | None documented |
|---|
function FramebufferGetPhysical(var Width,Height:LongWord):LongWord; inline;
Description: Get the Physical Framebuffer Width and Height in Pixels
| Note | The "physical" size is the size of the allocated buffer in memory, not the resolution of the video signal sent to the display device |
|---|
function FramebufferSetPhysical(var Width,Height:LongWord):LongWord; inline;
Description: Set the Physical Framebuffer Width and Height in Pixels
| Note | None documented |
|---|
function FramebufferTestPhysical(var Width,Height:LongWord):LongWord; inline;
Description: Test the Physical Framebuffer Width and Height in Pixels
| Note | None documented |
|---|
function FramebufferGetVirtual(var Width,Height:LongWord):LongWord; inline;
Description: Get the Virtual Framebuffer Width and Height in Pixels
| Note | The "virtual" size is the portion of buffer that is sent to the display device, not the resolution the buffer itself. This may be smaller than the allocated buffer size in order to implement panning |
|---|
function FramebufferSetVirtual(var Width,Height:LongWord):LongWord; inline;
Description: Set the Virtual Framebuffer Width and Height in Pixels
| Note | None documented |
|---|
function FramebufferTestVirtual(var Width,Height:LongWord):LongWord; inline;
Description: Test the Virtual Framebuffer Width and Height in Pixels
| Note | None documented |
|---|
function FramebufferGetDepth(var Depth:LongWord):LongWord; inline;
Description: Get the Framebuffer Depth in Bits per Pixel
| Note | None documented |
|---|
function FramebufferSetDepth(var Depth:LongWord):LongWord; inline;
Description: Set the Framebuffer Depth in Bits per Pixel
| Note | None documented |
|---|
function FramebufferTestDepth(var Depth:LongWord):LongWord; inline;
Description: Test the Framebuffer Depth in Bits per Pixel
| Note | None documented |
|---|
function FramebufferGetPixelOrder(var Order:LongWord):LongWord; inline;
Description: Get the Framebuffer Pixel Order (0 = BGR / 1 = RGB)
| Note | None documented |
|---|
function FramebufferSetPixelOrder(var Order:LongWord):LongWord; inline;
Description: Set the Framebuffer Pixel Order (0 = BGR / 1 = RGB)
| Note | None documented |
|---|
function FramebufferTestPixelOrder(var Order:LongWord):LongWord; inline;
Description: Test the Framebuffer Pixel Order (0 = BGR / 1 = RGB)
| Note | None documented |
|---|
function FramebufferGetAlphaMode(var Mode:LongWord):LongWord; inline;
Description: Get the Framebuffer Alpha Mode
| Note | None documented |
|---|
function FramebufferSetAlphaMode(var Mode:LongWord):LongWord; inline;
Description: Set the Framebuffer Alpha Mode
| Note | None documented |
|---|
function FramebufferTestAlphaMode(var Mode:LongWord):LongWord; inline;
Description: Test the Framebuffer Alpha Mode
| Note | None documented |
|---|
function FramebufferGetPitch:LongWord; inline;
Description: Get the Framebuffer Pitch in Bytes per Line
| Note | None documented |
|---|
function FramebufferGetOffset(var X,Y:LongWord):LongWord; inline;
Description: Get the Framebuffer Virtual Offset in Pixels
| Note | None documented |
|---|
function FramebufferSetOffset(var X,Y:LongWord):LongWord; inline;
Description: Set the Framebuffer Virtual Offset in Pixels
| Note | None documented |
|---|
function FramebufferTestOffset(var X,Y:LongWord):LongWord; inline;
Description: Test the Framebuffer Virtual Offset in Pixels
| Note | None documented |
|---|
function FramebufferGetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord; inline;
Description: Get the Framebuffer Top, Bottom, Left and Right Overscan in Pixels
| Note | None documented |
|---|
function FramebufferSetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord; inline;
Description: Set the Framebuffer Top, Bottom, Left and Right Overscan in Pixels
| Note | None documented |
|---|
function FramebufferTestOverscan(var Top,Bottom,Left,Right:LongWord):LongWord; inline;
Description: Test the Framebuffer Top, Bottom, Left and Right Overscan in Pixels
| Note | None documented |
|---|
function FramebufferGetPalette(Buffer:Pointer; Length:LongWord):LongWord; inline;
Description: Get the Framebuffer Palette in RGBA values
| Note | None documented |
|---|
function FramebufferSetPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord; inline;
Description: Set the Framebuffer Palette in RGBA values
| Note | None documented |
|---|
function FramebufferTestPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord; inline;
Description: Test the Framebuffer Palette in RGBA values
| Note | None documented |
|---|
function FramebufferTestVsync:LongWord; inline;
Description: Test the Framebuffer Vertical Sync (Where Applicable)
| Note | None documented |
|---|
function FramebufferSetVsync:LongWord; inline;
Description: Set (Wait For) the Framebuffer Vertical Sync (Where Applicable)
| Note | None documented |
|---|
function FramebufferSetBacklight(Brightness:LongWord):LongWord; inline;
Description: Set the Framebuffer Backlight brightness (Where Applicable)
| Note | None documented |
|---|
Touch functions
function TouchGetBuffer(var Address:LongWord):LongWord; inline;
Description: Get the Touchscreen memory buffer (Where Applicable)
| Note | None documented |
|---|
Cursor functions
function CursorSetDefault:LongWord; inline;
Description: Set the default Cursor Info (Where Applicable)
| Note | None documented |
|---|
function CursorSetInfo(Width,Height,HotspotX,HotspotY:LongWord; Pixels:Pointer; Length:LongWord):LongWord; inline;
Description: Set the Cursor Info (Width and Height, Hotspot and Pixel image)
| Note | None documented |
|---|
function CursorSetState(Enabled:Boolean; X,Y:LongWord; Relative:Boolean):LongWord; inline;
Description: Set the Cursor State (Enabled, X and Y)
| Relative | X, Y is relative to Display (Virtual) not Framebuffer (Physical) |
|---|
DMA functions
function DMAAvailable:Boolean; inline;
Description: Check if DMA is currently available
| Note | None documented |
|---|
function DMATransfer(Data:PDMAData; Direction,Peripheral:LongWord):LongWord; inline;
Description: Perform a DMA transfer using the list of DMA data blocks provided
| Data | A linked list of DMA data blocks for the transfer |
|---|---|
| Direction | The direction of the DMA request (eg DMA_DIR_MEM_TO_MEM) |
| Peripheral | The peripheral ID for data request gating (eg DMA_DREQ_ID_NONE) |
function DMAFillMemory(Dest:Pointer; Size:LongWord; Value:Byte):LongWord; inline;
Description: Fill memory at the destination address using DMA
| Dest | The address to start the memory fill |
|---|---|
| Size | The size of memory to fill in bytes |
| Value | The value to fill the memory with |
function DMACopyMemory(Source,Dest:Pointer; Size:LongWord):LongWord; inline;
Description: Copy memory from the source to the destination address using DMA
| Source | The source address to start the memory copy |
|---|---|
| Dest | The destination address to start the memory copy |
| Size | The size of memory to copy in bytes |
function DMAReadPeripheral(Address,Dest:Pointer; Size,Peripheral:LongWord):LongWord; inline;
Description: Read from a periperal address to the destination address using DMA
| Address | The address of the periperhal register to read from |
|---|---|
| Source | The destination address to start writing to |
| Size | The size of the read in bytes |
| Peripheral | The peripheral ID for data request gating (eg DMA_DREQ_ID_UART_RX) |
function DMAWritePeripheral(Source,Address:Pointer; Size,Peripheral:LongWord):LongWord; inline;
Description: Write to a peripheral address from the source address using DMA
| Source | The source address to start reading from |
|---|---|
| Address | The address of the peripheral register to write to |
| Size | The size of the write in bytes |
| Peripheral | The peripheral ID for data request gating (eg DMA_DREQ_ID_UART_TX) |
function DMAAllocateBuffer(Size:LongWord):Pointer; inline;
Description: Allocate a buffer compatible with DMA memory reads or writes
| Size | The size of the buffer to allocate |
|---|
function DMAAllocateBufferEx(var Size:LongWord):Pointer; inline;
Description: Allocate a buffer compatible with DMA memory reads or writes
| Size | The size of the buffer to allocate (Updated on return to actual size) |
|---|
function DMAReleaseBuffer(Buffer:Pointer):LongWord; inline;
Description: Release a buffer allocated with DMAAllocateBuffer
| Buffer | The buffer to be released |
|---|
function DMAGetChannels:LongWord; inline;
Description: Get the currently enabled DMA channel bitmap (If supported)
| Note | None documented |
|---|
GPIO functions
function GPIOAvailable:Boolean; inline;
Description: Check if a GPIO device is available
| Reg | The memory register to read from |
|---|---|
| Value | The value of the memory register |
function GPIORead(Reg:LongWord):LongWord; inline;
Description: Perform a direct read from a GPIO register
| Reg | The memory register to read from |
|---|---|
| Value | The value of the memory register |
procedure GPIOWrite(Reg,Value:LongWord); inline;
Description: Perform a direct write to a GPIO register
| Reg | The memory register to write to |
|---|---|
| Value | The value to write to the register |
function GPIOInputGet(Pin:LongWord):LongWord; inline;
Description: Get the current state of a GPIO input pin
| Pin | The pin to get the state for (eg GPIO_PIN_1) |
|---|---|
| Return | The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure |
function GPIOInputWait(Pin,Trigger,Timeout:LongWord):LongWord; inline;
Description: Wait for the state of a GPIO input pin to change
| Pin | The pin to wait for the state to change (eg GPIO_PIN_1) |
|---|---|
| Trigger | The trigger event to wait for (eg GPIO_TRIGGER_HIGH) |
| Timeout | Number of milliseconds to wait for the change (INFINITE to wait forever) |
| Return | The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout |
function GPIOInputEvent(Pin,Trigger,Timeout:LongWord; Callback:TGPIOCallback; Data:Pointer):LongWord; inline;
Description: Schedule a function to be called when the state of a GPIO input pin changes
| Pin | The pin to schedule the state change for (eg GPIO_PIN_1) |
|---|---|
| Trigger | The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH) |
| Timeout | The number of milliseconds before the scheduled trigger expires (INFINITE to never expire) |
| Callback | The function to be called when the trigger occurs |
| Data | A pointer to be pass to the function when the trigger occurs (Optional) |
| Return | ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure |
| Note | The pin and trigger that caused the event will be passed to the callback function |
function GPIOOutput?et(Pin,Level:LongWord):LongWord; inline;
Description: Change the state of a GPIO output pin
| Pin | The pin to change the state for (eg GPIO_PIN_1) |
|---|---|
| Level | The state to change the pin to (eg GPIO_LEVEL_HIGH) |
| Return | ERROR_SUCCESS if completed successfully or another error code on failure |
function GPIOPullGet(Pin:LongWord):LongWord; inline;
Description: Get the current pull state of a GPIO pin
| Pin | The pin to get the pull state for (eg GPIO_PIN_1) |
|---|---|
| Return | The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure |
function GPIOPullSelect(Pin,Mode:LongWord):LongWord; inline;
Description: Change the pull state of a GPIO pin
| Pin | The pin to change the pull state for (eg GPIO_PIN_1) |
|---|---|
| Mode | The pull state to set for the pin (eg GPIO_PULL_UP) |
| Return | ERROR_SUCCESS if completed successfully or another error code on failure |
function GPIOFunctionGet(Pin:LongWord):LongWord; inline;
Description: Get the current function of a GPIO pin
| Pin | The pin to get the function for (eg GPIO_PIN_1) |
|---|---|
| Return | The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure |
\\\\\\\\\\\\\\\\\\\\not in wiki
\\\\\\\\\\\\\\\\\\\\not in wiki
function GPIOFunctionSelect(Pin,Mode:LongWord):LongWord; inline;
Description: Change the function of a GPIO pin
| Pin | The pin to change the function for (eg GPIO_PIN_1) |
|---|---|
| Mode | The function to set for the pin (eg GPIO_FUNCTION_OUT) |
| Return | ERROR_SUCCESS if completed successfully or another error code on failure |
Return to Unit Reference
