Unit PlatformRPi3
From Ultibo.org
Return to Unit Reference
Description
The RPi3 B has the Activity LED connected to the GPU, access is via a Virtual GPIO (Power LED appears to be unavailable).
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure RPi3Init;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3SecondarySwitch; assembler; nostackframe;
Description: Secondary CPU switch from HYP mode handler
| Note | None documented |
|---|
procedure RPi3SecondarySecure; assembler; nostackframe;
Description: Secondary CPU switch to secure mode handler
| Note | None documented |
|---|
procedure RPi3SecondaryHandler; assembler; nostackframe;
Description: Secondary CPU startup handler routine
| Note | None documented |
|---|
RPi3 platform functions
procedure RPi3SMPInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3BoardInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3MemoryInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3ClockInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3PowerInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3MailboxInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3InterruptInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3PeripheralInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3FramebufferInit;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3PageTableInit;
Description: Initialize the Hardware Page Tables before enabling the MMU
| Note | None documented |
|---|
procedure RPi3PowerLEDEnable;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3PowerLEDOn;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3PowerLEDOff;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3ActivityLEDEnable;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3ActivityLEDOn;
Description: To be documented
| Note | None documented |
|---|
procedure RPi3ActivityLEDOff;
Description: To be documented
| Note | None documented |
|---|
function RPi3MailboxReceive(Mailbox,Channel:LongWord):LongWord;
Description: Receive from specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits |
|---|
procedure RPi3MailboxSend(Mailbox,Channel,Data:LongWord);
Description: Send to specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits |
|---|
function RPi3MailboxCall(Mailbox,Channel,Data:LongWord; var Response:LongWord):LongWord;
Description: Perform a transaction (Send/Receive) to specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits
Data pointer must be 16 byte aligned to allow for the 4 bit channel number |
|---|
function RPi3MailboxCallEx(Mailbox,Channel,Data:LongWord; var Response:LongWord; Timeout:LongWord):LongWord;
Description: Perform a transaction (Send/Receive) to specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits
Data pointer must be 16 byte aligned to allow for the 4 bit channel number |
|---|
function RPi3MailboxPropertyCall(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord):LongWord;
Description: Perform a property tag transaction (Send/Receive) to specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits
Data pointer must be 16 byte aligned to allow for the 4 bit channel number |
|---|
function RPi3MailboxPropertyCallEx(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord; Timeout:LongWord):LongWord;
Description: Perform a property tag transaction (Send/Receive) to specified mailbox on specified channel
| Note | Data = first 28 bits, Channel = last 4 bits
Data pointer must be 16 byte aligned to allow for the 4 bit channel number |
|---|
function RPi3RequestExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Description: Request registration of the supplied handler to the specified IRQ number
| CPUID | CPU to route IRQ to |
|---|---|
| Number | IRQ number to register |
| Handler | Interrupt handler function to register |
| HandlerEx | Extended Interrupt handler function to register |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3ReleaseExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Description: Request deregistration of the supplied handler from the specified IRQ number
| CPUID | CPU to route IRQ to |
|---|---|
| Number | IRQ number to deregister |
| Handler | Interrupt handler function to deregister |
| HandlerEx | Extended Interrupt handler function to deregister |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3RequestExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Description: Request registration of the supplied handler to the specified FIQ number
| CPUID | CPU to route FIQ to |
|---|---|
| Number | FIQ number to register |
| Handler | Interrupt handler function to register |
| HandlerEx | Extended Interrupt handler function to register |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3ReleaseExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Description: Request deregistration of the supplied handler from the specified FIQ number
| CPUID | CPU to route FIQ to |
|---|---|
| Number | FIQ number to deregister |
| Handler | Interrupt handler function to deregister |
| HandlerEx | Extended Interrupt handler function to deregister |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3RegisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord;
Description: Request registration of the supplied extended handler to the specified System Call number
| 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 |
| HandlerEx | The extended handler function to be registered |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3DeregisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord;
Description: Request deregistration of the supplied extended handler from the specified System Call number
| 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 |
| HandlerEx | The extended handler function to be deregistered |
| Note | Only one of Handler or HandlerEx can be specified |
function RPi3GetInterruptEntry(Number:LongWord):TInterruptEntry;
Description: Get the interrupt entry for the specified interrupt number
| Note | None documented |
|---|
function RPi3GetLocalInterruptEntry(CPUID,Number:LongWord):TInterruptEntry; {Get the local interrupt entry for the specified interrupt number}
function
Description: To be documented
| Note | None documented |
|---|
function RPi3GetSystemCallEntry(Number:LongWord):TSystemCallEntry;
Description: Get the system call entry for the specified system call number
| Note | None documented |
|---|
function RPi3SystemRestart(Delay:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
function RPi3SystemShutdown(Delay:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
function RPi3SystemGetCommandLine:String;
Description: Get the Command Line from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3CPUGetMemory(var Address:PtrUInt; var Length:LongWord):LongWord;
Description: Get the CPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUGetState:LongWord;
Description: To be documented
| Note | None documented |
|---|
function RPi3GPUGetMemory(var Address:PtrUInt; var Length:LongWord):LongWord;
Description: Get the GPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3BoardGetModel:LongWord;
Description: Get the Board Model from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3BoardGetSerial:Int64;
Description: Get the Board Serial from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3BoardGetRevision:LongWord;
Description: Get the Board Revision from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3BoardGetMACAddress:String;
Description: Get the Board MAC Address from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FirmwareGetRevision:LongWord;
Description: Get the Firmware Revision from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3PowerGetWait(PowerId:LongWord):LongWord;
Description: Get the Power Wait from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3PowerGetState(PowerId:LongWord):LongWord;
Description: Get the Power State from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3PowerSetState(PowerId,State:LongWord; Wait:Boolean):LongWord;
Description: Set the Power State in the Mailbox property tags channel
| Note | Power Lock not required due to Mailbox Property Call serialization |
|---|
function RPi3ClockGetCount:LongWord;
Description: Gets the current system clock count (32 least significant bits of total)
| Note | On the Raspberry Pi this comes from the System Timer free running counter which runs at 1MHz and therefore overflows every 4295 seconds |
|---|
function RPi3ClockGetTotal:Int64;
Description: Gets the total system clock count
| Note | On the Raspberry Pi this comes from the System Timer free running counter which runs at 1MHz, the clock interrupt also uses this timer to increment the clock every second and therefore keep time. |
|---|
function RPi3ClockGetRate(ClockId:LongWord):LongWord;
Description: Get the Clock Rate from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3ClockSetRate(ClockId,Rate:LongWord; Turbo:Boolean):LongWord;
Description: Set the Clock Rate in the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3ClockGetState(ClockId:LongWord):LongWord;
Description: Get the Clock State from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3ClockSetState(ClockId,State:LongWord):LongWord;
Description: Set the Clock State in the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3ClockGetMinRate(ClockId:LongWord):LongWord;
Description: Get the Clock Min Rate from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3ClockGetMaxRate(ClockId:LongWord):LongWord;
Description: Get the Clock Max Rate from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3TurboGetState(TurboId:LongWord):LongWord;
Description: Get the Turbo State from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3TurboSetState(TurboId,State:LongWord):LongWord;
Description: Set the Turbo State in the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VoltageGetValue(VoltageId:LongWord):LongWord;
Description: Get the Voltage Value from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VoltageSetValue(VoltageId,Value:LongWord):LongWord;
Description: Set the Voltage Value in the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VoltageGetMinValue(VoltageId:LongWord):LongWord;
Description: Get the Voltage Min Value from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VoltageGetMaxValue(VoltageId:LongWord):LongWord;
Description: Get the Voltage Max Value from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3TemperatureGetCurrent(TemperatureId:LongWord):LongWord;
Description: Get the Temperature Current from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3TemperatureGetMaximum(TemperatureId:LongWord):LongWord;
Description: Get the Temperature Maximum Model from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUMemoryAllocate(Length,Alignment,Flags:LongWord):THandle;
Description: Allocate GPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUMemoryRelease(Handle:THandle):LongWord;
Description: Release GPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUMemoryLock(Handle:THandle):LongWord;
Description: Lock GPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUMemoryUnlock(Handle:THandle):LongWord;
Description: Unlock GPU Memory from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3GPUExecuteCode(Address:Pointer; R0,R1,R2,R3,R4,R5:LongWord):LongWord;
Description: Execute GPU Code from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3DispmanxHandleGet(Resource:THandle):THandle;
Description: Get Dispmanx Memory Handle from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3EDIDBlockGet(Block:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Description: Get EDID Block from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferAllocate(Alignment:LongWord; var Address,Length:LongWord):LongWord;
Description: Allocate Framebuffer from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferRelease:LongWord;
Description: Release Framebuffer from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetState(State:LongWord):LongWord;
Description: Set Framebuffer State (Blank Screen) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetDimensions(var Width,Height,Top,Bottom,Left,Right:LongWord):LongWord;
Description: Get Framebuffer Dimensions from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetPhysical(var Width,Height:LongWord):LongWord;
Description: Get Framebuffer Physical size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetPhysical(var Width,Height:LongWord):LongWord;
Description: Set Framebuffer Physical size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestPhysical(var Width,Height:LongWord):LongWord;
Description: Test Framebuffer Physical size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetVirtual(var Width,Height:LongWord):LongWord;
Description: Get Framebuffer Virtual size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetVirtual(var Width,Height:LongWord):LongWord;
Description: Set Framebuffer Virtual size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestVirtual(var Width,Height:LongWord):LongWord;
Description: Test Framebuffer Virtual size from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetDepth(var Depth:LongWord):LongWord;
Description: Get Framebuffer Depth (Bits per pixel) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetDepth(var Depth:LongWord):LongWord;
Description: Set Framebuffer Depth (Bits per pixel) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestDepth(var Depth:LongWord):LongWord;
Description: Test Framebuffer Depth (Bits per pixel) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetPixelOrder(var Order:LongWord):LongWord;
Description: Get Framebuffer Pixel Order (RGB) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetPixelOrder(var Order:LongWord):LongWord;
Description: Set Framebuffer Pixel Order (RGB) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestPixelOrder(var Order:LongWord):LongWord;
Description: Test Framebuffer Pixel Order (RGB) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetAlphaMode(var Mode:LongWord):LongWord;
Description: Get Framebuffer Alpha Mode from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetAlphaMode(var Mode:LongWord):LongWord;
Description: Set Framebuffer Alpha Mode from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestAlphaMode(var Mode:LongWord):LongWord;
Description: Test Framebuffer Alpha Mode from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetPitch:LongWord;
Description: Get Framebuffer Pitch (Bytes per line) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetOffset(var X,Y:LongWord):LongWord;
Description: Get Framebuffer Virtual Offset from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetOffset(var X,Y:LongWord):LongWord;
Description: Set Framebuffer Virtual Offset from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestOffset(var X,Y:LongWord):LongWord;
Description: Test Framebuffer Virtual Offset from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Description: Get Framebuffer Overscan from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Description: Set Framebuffer Overscan from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Description: Test Framebuffer Overscan from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferGetPalette(Buffer:Pointer; Length:LongWord):LongWord;
Description: Get Framebuffer Palette from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Description: Set Framebuffer Palette from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferTestPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Description: Test Framebuffer Palette from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3FramebufferSetBacklight(Brightness:LongWord):LongWord;
Description: Set Framebuffer Backlight Brightness from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3TouchGetBuffer(var Address:LongWord):LongWord;
Description: Get the Touchscreen buffer from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VirtualGPIOGetBuffer(var Address:LongWord):LongWord;
Description: Get the Virtual GPIO buffer from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3CursorSetInfo(Width,Height,HotspotX,HotspotY:LongWord; Pixels:Pointer; Length:LongWord):LongWord;
Description: Set Cursor Info (Pixels) from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3CursorSetState(Enabled:Boolean; X,Y:LongWord; Relative:Boolean):LongWord;
Description: Set Cursor State (Enable, X, Y) from the Mailbox property tags channel
| Relative | X, Y is relative to Display (Virtual) not Framebuffer (Physical) |
|---|
function RPi3DMAGetChannels:LongWord;
Description: Get the available DMA Channels from the Mailbox property tags channel
| Note | None documented |
|---|
function RPi3VirtualGPIOInputGet(Pin:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
function RPi3VirtualGPIOOutputSet(Pin,Level:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
function RPi3VirtualGPIOFunctionSelect(Pin,Mode:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
RPi3 thread functions
procedure RPi3SchedulerInit;
Description: Initialize the scheduler interrupt on the boot CPU
| Note | None documented |
|---|
procedure RPi3SchedulerStart(CPUID:LongWord);
Description: Initialize the scheduler interrupt on the specified secondary CPU
| Note | None documented |
|---|
procedure RPi3SecondaryBoot(CPUID:LongWord);
Description: To be documented
| Note | None documented |
|---|
RPi3 IRQ functions
function RPi3DispatchIRQ(CPUID:LongWord; Thread:TThreadHandle):TThreadHandle;
Description: Process any pending IRQ requests
| Note | Called by ARMv8IRQHandler in PlatformARMv8
A DataMemoryBarrier is executed before and after calling this function |
|---|
function RPi3HandleIRQ(Number,CPUID:LongWord; Thread:TThreadHandle):TThreadHandle;
Description: Call the handler function for an IRQ that was received, or halt if it doesn't exist
| Note | None documented |
|---|
RPi3 FIQ functions
function RPi3DispatchFIQ(CPUID:LongWord; Thread:TThreadHandle):TThreadHandle;
Description: Process any pending FIQ requests
| Note | Called by ARMv8FIQHandler in PlatformARMv8
A DataMemoryBarrier is executed before and after calling this function |
|---|
function RPi3HandleFIQ(Number,CPUID:LongWord; Thread:TThreadHandle):TThreadHandle;
Description: Call the handler function for an FIQ that was received, or halt if it doesn't exist
| Note | None documented |
|---|
RPi3 SWI functions
function RPi3DispatchSWI(CPUID:LongWord; Thread:TThreadHandle; Request:PSystemCallRequest):TThreadHandle;
Description: Process an SWI request
| Note | Called by ARMv8SoftwareInterruptHandler in PlatformARMv8
A DataMemoryBarrier is executed before and after calling this function |
|---|
RPi3 clock functions
procedure RPi3ClockInterrupt(Parameter:Pointer);
Description: Interrupt handler function for the clock interrupt
| Note | This schedules another clock interrupt to occur CLOCK_CYCLES_PER_TICK in the future, then updates ClockTicks and ClockSeconds and checks for timers to trigger. |
|---|
procedure RPi3ClockUpdate(Cycles:LongWord; var Last:LongWord);
Description: ?etup a clock interrupt to trigger after the specified number of clock cycles
| Cycles | Number of cycles after which the timer interrupt is to be triggered |
|---|---|
| Note | This refers to native clock cycles as specified by CLOCK_FREQUENCY |
Return to Unit Reference
