Difference between revisions of "Unit PlatformRPi4"
(8 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
---- | ---- | ||
− | '''Ultibo Platform | + | '''Ultibo Platform Interface unit for Raspberry Pi 4''' |
Note: The RPi4B has the Activity LED connected to GPIO Pin 42 (Power LED is only accessible via the GPIO expander driver) | Note: The RPi4B has the Activity LED connected to GPIO Pin 42 (Power LED is only accessible via the GPIO expander driver) | ||
Line 223: | Line 223: | ||
| | | | ||
|- | |- | ||
− | |colspan="2"|<code>RPI4_FIRMWARE_FILES = 'start4.elf,fixup4.dat | + | |colspan="2"|<code>RPI4_FIRMWARE_FILES = 'start4.elf,fixup4.dat,armstub32-rpi4.bin,armstub64-rpi4.bin';</code> |
+ | |- | ||
+ | |colspan="2"|<code>RPI4_DTB_FILES = 'bcm2711-rpi-4-b.dtb,bcm2711-rpi-400.dtb,bcm2711-rpi-cm4.dtb,bcm2711-rpi-cm4s.dtb';</code> | ||
|- | |- | ||
|} | |} | ||
Line 312: | Line 314: | ||
---- | ---- | ||
− | '' | + | |
+ | '''RPi4 framebuffer''' | ||
+ | |||
+ | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;"> | ||
+ | <code>PRPi4Framebuffer = ^TRPi4Framebuffer;</code> | ||
+ | |||
+ | <code>TRPi4Framebuffer = record</code> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | |colspan="2"|''Framebuffer Properties'' | ||
+ | |- | ||
+ | | <code>Framebuffer:TFramebufferDevice;</code> | ||
+ | | style="width: 50%;"| | ||
+ | |- | ||
+ | |colspan="2"|''RPi4 Properties'' | ||
+ | |- | ||
+ | | <code>MultiDisplay:LongBool;</code> | ||
+ | | | ||
+ | |- | ||
+ | | <code>DisplayNum:LongWord;</code> | ||
+ | | | ||
+ | |- | ||
+ | | <code>DisplaySettings:TDisplaySettings;</code> | ||
+ | | | ||
+ | |- | ||
+ | |} | ||
+ | </div></div> | ||
+ | <br /> | ||
=== Public variables === | === Public variables === | ||
Line 748: | Line 778: | ||
| Data = first 28 bits, Channel = last 4 bits | | Data = first 28 bits, Channel = last 4 bits | ||
Data pointer must be 16 byte aligned to allow for the 4 bit channel number | Data pointer must be 16 byte aligned to allow for the 4 bit channel number | ||
+ | |- | ||
+ | |} | ||
+ | </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 RPi4MailboxPropertyTag(Tag:LongWord; Data:Pointer; Size:LongWord):LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Request a property tag (Get/Set) from the mailbox property channel</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Data | ||
+ | | Data does not need to include mailbox property channel header or footer. Data pointer does not need any specific alignment or caching attributes. | ||
+ | |- | ||
+ | ! Size | ||
+ | | Size must be a multiple of 4 bytes. Size must include the size of the request and response which use the same buffer. | ||
|- | |- | ||
|} | |} | ||
Line 1,091: | Line 1,136: | ||
<pre style="border: 0; padding-bottom:0px;">function RPi4BoardGetMACAddress:String;</pre> | <pre style="border: 0; padding-bottom:0px;">function RPi4BoardGetMACAddress:String;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Board MAC Address from the Mailbox property tags channel</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Board MAC Address from the Mailbox property tags channel</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Note | ||
+ | | None documented | ||
+ | |- | ||
+ | |} | ||
+ | </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 RPi4ChipGetRevision:LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Chip Revision from the revision register</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
Line 1,775: | Line 1,832: | ||
<pre style="border: 0; padding-bottom:0px;">function RPi4FramebufferTestPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;</pre> | <pre style="border: 0; padding-bottom:0px;">function RPi4FramebufferTestPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Test Framebuffer Palette from the Mailbox property tags channel</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Test Framebuffer Palette from the Mailbox property tags channel</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Note | ||
+ | | None documented | ||
+ | |- | ||
+ | |} | ||
+ | </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 RPi4FramebufferGetLayer(var Layer:LongInt):LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get Framebuffer Layer from the Mailbox property tags channel</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Note | ||
+ | | None documented | ||
+ | |- | ||
+ | |} | ||
+ | </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 RPi4FramebufferSetLayer(var Layer:LongInt):LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set Framebuffer Layer from the Mailbox property tags channel</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Note | ||
+ | | None documented | ||
+ | |- | ||
+ | |} | ||
+ | </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 RPi4FramebufferTestLayer(var Layer:LongInt):LongWord;</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Test Framebuffer Layer from the Mailbox property tags channel</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
Line 2,205: | Line 2,298: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 RPi4FramebufferDeviceSetBacklight(Framebuffer:PFramebufferDevice; Brightness:LongWord):LongWord;</pre> | <pre style="border: 0; padding-bottom:0px;">function RPi4FramebufferDeviceSetBacklight(Framebuffer:PFramebufferDevice; Brightness:LongWord):LongWord;</pre> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
Line 2,298: | Line 2,379: | ||
! Note | ! Note | ||
| None documented | | None documented | ||
+ | |- | ||
+ | |} | ||
+ | </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;">procedure RPi4BootOutput(Value:LongWord);</pre> | ||
+ | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Output characters to UART0 without dependency on any other RTL setup</div> | ||
+ | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
+ | {| class="wikitable" style="font-size: 14px; background: white;" | ||
+ | |- | ||
+ | ! Note | ||
+ | | This function is primarily intended for testing QEMU boot because it doesn't initialize the UART and won't work on real hardware. | ||
+ | Based on hexstrings() function by dwelch67 (https://github.com/dwelch67) | ||
|- | |- | ||
|} | |} |
Latest revision as of 05:08, 23 November 2022
Return to Unit Reference
Description
Ultibo Platform Interface unit for Raspberry Pi 4
Note: The RPi4B has the Activity LED connected to GPIO Pin 42 (Power LED is only accessible via the GPIO expander driver)
Detecting the GIC or legacy interrupt controller
The Raspberry Pi 4 contains a new GIC interrupt controller which includes modern features like the ability to service interrupts on all available cores, a full set of software generated processor to processor interrupts and complete FIQ handling for all interrupt sources.
The Pi 4 also retains and expands the legacy interrupt controller used on earlier Pi models with support for routing interrupts to any core and FIQ handling for all interrupt sources.
The documentation at https://www.raspberrypi.org/documentation/configuration/config-txt/boot.md states that the setting enable_gic=0 or 1 can be used to select between the legacy and GIC interrupt controllers and that the GIC (enable_gic=1) is the default.
Testing however shows this is not completely correct, if no config.txt file exists and no device tree DTB files are present then the current firmware appears to enable the legacy interrupt controller by default.
If device tree DTB files containing a compatible GIC node are available on the SD card during boot the firmware will enable the GIC, this appears to happen regardless of the setting in config.txt and a value of enable_gic=0 will be ignored in favour of the device tree setting.
If the legacy interrupt controller is enabled and Ultibo configures the GIC controller during boot it will receive no interrupts and appear to hang (four color screen).
While it might be possible to read the SD card during boot, check for a config.txt and parse it to determine the value of the enable_gic setting, to be fully functional this process would also need to parse the device tree information (if available) and check for a compatible GIC node. Even then that doesn't account for booting from USB, network or some other source and all of that would have to happen very early in the boot sequence to be usable.
To make matters worse there doesn't appear to be a documented way to detect which interrupt controller is enabled by reading a register value, the GIC even behaves as though it is working when the legacy controller is enabled but no interrupts are received.
To ensure a level of reliability regardless of what firmware and files and configuration settings are present Ultibo implements drivers for both the GIC and legacy interrupt controllers and includes a detection mechanism during early stage boot.
In simple terms the boot process configures the GIC and then installs an interrupt handler for the generic virtual timer and configures the timer to fire in 1ms before enabling interrupts. It then waits 2ms and disables interrupts, unconfigures the timer and deregisters the interrupt handler.
If the test worked the local variable GICAvailable will have been set by the handler to RPI4_GIC_AVAILABLE, if not the variable will remain at RPI4_GIC_UNAVAILABLE and the boot process will proceed to configure the legacy interrupt controller for use.
This is not an ideal mechanism and could potentially fail for other reasons (although it is carefully constructed to avoid many potential failures) but at present is the best option for allowing the boot process to succeed regardless of the firmware behavior.
Constants
RPI4_VCIO_*
RPI4_VCIO_ALIAS = BCM2838_VCIO_ALIAS;
|
The VCIO Alias (For ARM Physcial to VC IO translation) |
RPI4_VCBUS_*
RPI4_VCBUS_ALIAS = BCM2838_VCBUS_C_ALIAS;
|
The currently selected VCBUS Alias (For ARM Physcial to VC Bus translation) |
RPI4_SECURE_*
RPI4_SECURE_BOOT = $00000001;
|
If 1 then startup will attempt to switch back to secure world during boot process (Moved to ARMSecureBoot) |
RPI4_SECURE_BOOT_OFFSET = $000000D4;
|
The address of the Secure Boot marker in the ARM boot stub |
RPI4_SECURE_BOOT_MARKER = $58495052;
|
The Secure Boot marker (ASCII "RPIX") |
RPI4_SECURE_BOOT_CIRCLE = $53514946;
|
The alternate Secure Boot marker (ASCII "FIQS") (As used by Circle) |
RPI4_STARTUP_*
RPI4_STARTUP_ADDRESS = $00008000;
|
Obtain from linker |
RPI4_PAGE_DIRECTORY_*
RPI4_PAGE_DIRECTORY_BASE = $00002000;
|
Place the first level Page Directory after the interrupt vectors at 0x00001000 and before the first level Page Table at 0x00004000 |
RPI4_PAGE_DIRECTORY_SIZE = SIZE_4K;
|
ARM Cortex A72 first level Page Table is up to 4KB in size (512 64 bit (8 byte) entries) |
RPI4_PAGE_TABLE_*
RPI4_PAGE_TABLE_BASE = $00004000;
|
Place the second level Page Table after the first level Page Directory at 0x00002000 and before the code start at 0x00008000 |
RPI4_PAGE_TABLE_SIZE = SIZE_16K;
|
ARM Cortex A72 second level Page Table is exactly 16KB in size (4 x 512 64 bit (8 byte) entries) |
RPI4_VECTOR_TABLE_*
RPI4_VECTOR_TABLE_BASE = $00001000;
|
Place the Interrupt Vector Table at 0x00001000 before the code start at 0x00008000 |
RPI4_VECTOR_TABLE_SIZE = SIZE_64;
|
The Interrupt Vector Table is exactly 64 bytes (16 32 bit (4 byte) entries) |
RPI4_VECTOR_TABLE_COUNT = 8;
|
The Interrupt Vector Table contains 8 entries on an ARMv7 device |
RPI4_CPU_*
RPI4_CPU_COUNT = BCM2838_CPU_COUNT;
|
|
RPI4_CPU_BOOT = CPU_ID_0;
|
|
RPI4_CPU_MASK = CPU_AFFINITY_0 or CPU_AFFINITY_1 or CPU_AFFINITY_2 or CPU_AFFINITY_3;
|
RPI4_SWI_*
RPI4_SWI_COUNT = 256;
|
Number of available SWI entries |
RPI4_GIC_*
RPI4_GIC_UNAVAILABLE = 0;
|
|
RPI4_GIC_AVAILABLE = 1;
|
RPI4_CORE_TIMER_*
RPI4_CORE_TIMER_PRESCALER = $25ED098;
|
Divide the Crystal Clock by 54 to give a 1MHz Core Timer |
RPI4_CORE_TIMER_FREQUENCY = 1000000;
|
The Core Timer frequency from the prescaler setting above |
RPI4_GENERIC_TIMER_FREQUENCY = 1000000;
|
The ARM Generic Timer frequency from the prescaler setting above |
RPI4_CORE_TIMER_PRESCALER = $80000000;
|
Divide the Crystal Clock by 1 to give a 54MHz Core Timer |
RPI4_CORE_TIMER_FREQUENCY = 54000000;
|
The Core Timer frequency from the prescaler setting above |
RPI4_GENERIC_TIMER_FREQUENCY = 54000000;
|
The ARM Generic Timer frequency from the prescaler setting above |
RPI4_KERNEL_*
RPI4_KERNEL_NAME = 'kernel7l.img';
|
|
RPI4_KERNEL_NAME = 'kernel8.img';
|
|
RPI4_KERNEL_CONFIG = 'config.txt';
|
|
RPI4_KERNEL_COMMAND = 'cmdline.txt';
|
|
RPI4_FIRMWARE_FILES = 'start4.elf,fixup4.dat,armstub32-rpi4.bin,armstub64-rpi4.bin';
| |
RPI4_DTB_FILES = 'bcm2711-rpi-4-b.dtb,bcm2711-rpi-400.dtb,bcm2711-rpi-cm4.dtb,bcm2711-rpi-cm4s.dtb';
|
RPI4_GPIO_ACTLED_*
RPI4_GPIO_ACTLED_GPFSEL = BCM2838_GPFSEL4;
|
GPFSEL register for ACT LED |
RPI4_GPIO_ACTLED_GPSET = BCM2838_GPSET1;
|
GPSET register for ACT LED |
RPI4_GPIO_ACTLED_GPCLR = BCM2838_GPCLR1;
|
GPCLR register for ACT LED |
RPI4_GPIO_ACTLED_GPPUD = BCM2838_GPPUD2;
|
GPPUD register for ACT LED |
RPI4_GPIO_ACTLED_GPFSHIFT = 6;
|
GPFSEL register shift for ACT LED |
RPI4_GPIO_ACTLED_GPFMASK = BCM2838_GPFSEL_MASK;
|
GPFSEL register mask for ACT LED |
RPI4_GPIO_ACTLED_GPSHIFT = (42 - 32);
|
GPSET/GPCLR register shift for ACT LED |
RPI4_GPIO_ACTLED_GPMASK = BCM2838_GPSET_MASK;
|
GPSET/GPCLR register mask for ACT LED |
RPI4_GPIO_ACTLED_GPPUDSHIFT = 20;
|
GPPUD register shift for ACT LED |
RPI4_GPIO_ACTLED_GPPUDMASK = BCM2838_GPPUD_MASK;
|
GPPUD register mask for ACT LED |
RPI4_MAILBOX_TIMEOUT_*
RPI4_MAILBOX_TIMEOUT = 100;
|
Default timeout to wait for mailbox calls to complete (Milliseconds) |
RPI4_MAILBOX_TIMEOUT_EX = 1000;
|
Extended timeout to wait for mailbox calls to complete (Milliseconds) |
RPI4_LOCAL_MAILBOX_*
RPI4_LOCAL_MAILBOX_TIMEOUT = 100;
|
Default timeout to wait for local mailbox calls to complete (Milliseconds) |
RPI4_FRAMEBUFFER_*
RPI4_FRAMEBUFFER_DESCRIPTION = 'BCM2838 Framebuffer';
|
Type definitions
RPi4 framebuffer
PRPi4Framebuffer = ^TRPi4Framebuffer;
TRPi4Framebuffer = record
Framebuffer Properties | |
Framebuffer:TFramebufferDevice;
|
|
RPi4 Properties | |
MultiDisplay:LongBool;
|
|
DisplayNum:LongWord;
|
|
DisplaySettings:TDisplaySettings;
|
Public variables
RPi4 specific Ultibo variables
RPi4Initialized:Boolean;
|
RPi4CNTVOFFLow:LongWord = 0;
|
The low 32 bits of the Virtual Counter Offset register at boot time (CPU0 only) (Set by Startup) Must be initialized to remain in .data or else rewritten to zero with .bss |
RPi4CNTVOFFHigh:LongWord = 0;
|
The high 32 bits of the Virtual Counter Offset register at boot time (CPU0 only) (Set by Startup) Must be initialized to remain in .data or else rewritten to zero with .bss |
Timer register
TimerRegisters:PBCM2838SystemTimerRegisters;
|
Mailbox register
Mailbox0Registers:PBCM2838Mailbox0Registers;
|
Mailbox1Registers:PBCM2838Mailbox1Registers;
|
Interrupt device
GICDevice:PGICDevice;
|
GICAvailable:LongWord = RPI4_GIC_AVAILABLE;
|
The status of the GIC interrupt controller, determined during boot. |
System call
SystemCallEntries:array[0..RPI4_SWI_COUNT - 1] of TSystemCallEntry;
|
Watchdog register
WatchdogRegisters:PBCM2838PMWatchdogRegisters;
|
ARM local register
ARMLocalRegisters:PBCM2838ARMLocalRegisters;
|
Virtual GPIO
VirtualGPIOBuffer:TBCM2838VirtualGPIOBuffer;
|
Function declarations
Initialization functions
procedure RPi4Init;
Note | None documented |
---|
procedure RPi4SecondarySwitch;
Note | None documented |
---|
procedure RPi4SecondarySecure;
Note | None documented |
---|
procedure RPi4SecondaryHandler;
Note | None documented |
---|
RPi4 platform functions
procedure RPi4SMPInit;
Note | None documented |
---|
procedure RPi4BoardInit;
Note | None documented |
---|
procedure RPi4MemoryInit;
Note | None documented |
---|
procedure RPi4ClockInit;
Note | None documented |
---|
procedure RPi4PowerInit;
Note | None documented |
---|
procedure RPi4MailboxInit;
Note | None documented |
---|
procedure RPi4InterruptInit;
Note | None documented |
---|
procedure RPi4PeripheralInit;
Note | None documented |
---|
procedure RPi4FramebufferInit;
Note | None documented |
---|
procedure RPi4PageTableInit;
Note | None documented |
---|
procedure RPi4PageTableInitLegacy;
Note | None documented |
---|
procedure RPi4PowerLEDEnable;
Note | None documented |
---|
procedure RPi4PowerLEDOn;
Note | None documented |
---|
procedure RPi4PowerLEDOff;
Note | None documented |
---|
procedure RPi4ActivityLEDEnable;
Note | None documented |
---|
procedure RPi4ActivityLEDOn;
Note | None documented |
---|
procedure RPi4ActivityLEDOff;
Note | None documented |
---|
function RPi4MailboxReceive(Mailbox,Channel:LongWord):LongWord;
Note | Data = first 28 bits, Channel = last 4 bits |
---|
procedure RPi4MailboxSend(Mailbox,Channel,Data:LongWord);
Note | Data = first 28 bits, Channel = last 4 bits |
---|
function RPi4MailboxCall(Mailbox,Channel,Data:LongWord; var Response:LongWord):LongWord;
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 RPi4MailboxCallEx(Mailbox,Channel,Data:LongWord; var Response:LongWord; Timeout:LongWord):LongWord;
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 RPi4MailboxPropertyCall(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord):LongWord;
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 RPi4MailboxPropertyCallEx(Mailbox,Channel:LongWord; Data:Pointer; var Response:LongWord; Timeout:LongWord):LongWord;
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 RPi4MailboxPropertyTag(Tag:LongWord; Data:Pointer; Size:LongWord):LongWord;
Data | Data does not need to include mailbox property channel header or footer. Data pointer does not need any specific alignment or caching attributes. |
---|---|
Size | Size must be a multiple of 4 bytes. Size must include the size of the request and response which use the same buffer. |
function RPi4RequestExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4ReleaseExIRQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4RequestExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4ReleaseExFIQ(CPUID,Number:LongWord; Handler:TInterruptHandler; HandlerEx:TInterruptExHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4RequestIPI(CPUID,Number:LongWord; Handler:TIPIHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4ReleaseIPI(CPUID,Number:LongWord; Handler:TIPIHandler; Parameter:Pointer):LongWord;
Note | None documented |
---|
function RPi4RegisterInterrupt(Number,Mask,Priority,Flags:LongWord; Handler:TSharedInterruptHandler; Parameter:Pointer):LongWord;
Number | The interrupt number to register the hanlder for |
---|---|
Mask | The mask of CPUs to register the handler for (eg CPU_MASK_0, CPU_MASK_1) (Where Applicable) |
Priority | The priroty level of the interrupt to be registered (eg INTERRUPT_PRIORITY_MAXIMUM) (Where Applicable) |
Flags | The flags to control the registration of the interrupt (eg INTERRUPT_FLAG_SHARED) (Where Applicable) |
Handler | The shared interrupt handler to be called when the interrupt occurs |
Parameter | A pointer to be passed to the handler when the interrupt occurs (Optional) |
Return | ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure |
function RPi4DeregisterInterrupt(Number,Mask,Priority,Flags:LongWord; Handler:TSharedInterruptHandler; Parameter:Pointer):LongWord;
Number | The interrupt number to deregister the hanlder for |
---|---|
Mask | The mask of CPUs to deregister the handler for (eg CPU_MASK_0, CPU_MASK_1) (Where Applicable) |
Priority | The priroty level of the interrupt to be deregistered (eg INTERRUPT_PRIORITY_MAXIMUM) (Where Applicable) |
Flags | The flags to control the deregistration of the interrupt (eg INTERRUPT_FLAG_SHARED, INTERRUPT_FLAG_LOCAL, INTERRUPT_FLAG_FIQ) (Where Applicable) |
Handler | The shared interrupt handler to be called when the interrupt occurs |
Parameter | A pointer to be passed to the handler when the interrupt occurs (Optional) |
Return | ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure |
function RPi4RegisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord;
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 RPi4DeregisterSystemCallEx(CPUID,Number:LongWord; Handler:TSystemCallHandler; HandlerEx:TSystemCallExHandler):LongWord;
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 RPi4GetInterruptEntry(Number,Instance:LongWord; var Interrupt:TInterruptEntry):LongWord;
Note | None documented |
---|
function RPi4GetLocalInterruptEntry(CPUID,Number,Instance:LongWord; var Interrupt:TInterruptEntry):LongWord;
Note | None documented |
---|
function RPi4GetSoftwareInterruptEntry(CPUID,Number,Instance:LongWord; var Interrupt:TInterruptEntry):LongWord;
Note | None documented |
---|
function RPi4GetSystemCallEntry(Number:LongWord):TSystemCallEntry;
Note | None documented |
---|
function RPi4SystemRestart(Delay:LongWord):LongWord;
Note | None documented |
---|
function RPi4SystemShutdown(Delay:LongWord):LongWord;
Note | None documented |
---|
function RPi4SystemGetCommandLine:String;
Note | None documented |
---|
function RPi4CPUGetMemory(var Address:PtrUInt; var Length:UInt64):LongWord;
Note | None documented |
---|
function RPi4GPUGetState:LongWord;
Note | None documented |
---|
function RPi4GPUGetMemory(var Address:PtrUInt; var Length:UInt64):LongWord;
Note | None documented |
---|
function RPi4BoardGetModel:LongWord;
Note | None documented |
---|
function RPi4BoardGetSerial:Int64;
Note | None documented |
---|
function RPi4BoardGetRevision:LongWord;
Note | None documented |
---|
function RPi4BoardGetMACAddress:String;
Note | None documented |
---|
function RPi4ChipGetRevision:LongWord;
Note | None documented |
---|
function RPi4FirmwareGetRevision:LongWord;
Note | None documented |
---|
function RPi4FirmwareGetThrottled:LongWord;
Note | None documented |
---|
function RPi4PowerGetWait(PowerId:LongWord):LongWord;
Note | None documented |
---|
function RPi4PowerGetState(PowerId:LongWord):LongWord;
Note | None documented |
---|
function RPi4PowerSetState(PowerId,State:LongWord; Wait:Boolean):LongWord;
Note | Power Lock not required due to Mailbox Property Call serialization |
---|
function RPi4ClockGetCount:LongWord;
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 RPi4ClockGetTotal:Int64;
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 RPi4ClockGetRate(ClockId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ClockSetRate(ClockId,Rate:LongWord; Turbo:Boolean):LongWord;
Note | None documented |
---|
function RPi4ClockGetState(ClockId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ClockSetState(ClockId,State:LongWord):LongWord;
Note | None documented |
---|
function RPi4ClockGetMinRate(ClockId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ClockGetMaxRate(ClockId:LongWord):LongWord;
Note | None documented |
---|
function RPi4TurboGetState(TurboId:LongWord):LongWord;
Note | None documented |
---|
function RPi4TurboSetState(TurboId,State:LongWord):LongWord;
Note | None documented |
---|
function RPi4VoltageGetValue(VoltageId:LongWord):LongWord;
Note | None documented |
---|
function RPi4VoltageSetValue(VoltageId,Value:LongWord):LongWord;
Note | None documented |
---|
function RPi4VoltageGetMinValue(VoltageId:LongWord):LongWord;
Note | None documented |
---|
function RPi4VoltageGetMaxValue(VoltageId:LongWord):LongWord;
Note | None documented |
---|
function RPi4TemperatureGetCurrent(TemperatureId:LongWord):LongWord;
Note | None documented |
---|
function RPi4TemperatureGetMaximum(TemperatureId:LongWord):LongWord;
Note | None documented |
---|
function RPi4GPUMemoryAllocate(Length,Alignment,Flags:LongWord):THandle;
Note | None documented |
---|
function RPi4GPUMemoryRelease(Handle:THandle):LongWord;
Note | None documented |
---|
function RPi4GPUMemoryLock(Handle:THandle):LongWord;
Note | None documented |
---|
function RPi4GPUMemoryUnlock(Handle:THandle):LongWord;
Note | None documented |
---|
function RPi4GPUExecuteCode(Address:Pointer; R0,R1,R2,R3,R4,R5:LongWord):LongWord;
Note | None documented |
---|
function RPi4DispmanxHandleGet(Resource:THandle):THandle;
Note | None documented |
---|
function RPi4EDIDBlockGet(Block:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferAllocate(Alignment:LongWord; var Address,Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferRelease:LongWord;
Note | None documented |
---|
function RPi4FramebufferSetState(State:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetDimensions(var Width,Height,Top,Bottom,Left,Right:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetPhysical(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetPhysical(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestPhysical(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetVirtual(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetVirtual(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestVirtual(var Width,Height:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetDepth(var Depth:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetDepth(var Depth:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestDepth(var Depth:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetPixelOrder(var Order:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetPixelOrder(var Order:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestPixelOrder(var Order:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetAlphaMode(var Mode:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetAlphaMode(var Mode:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestAlphaMode(var Mode:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetPitch:LongWord;
Note | None documented |
---|
function RPi4FramebufferGetOffset(var X,Y:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetOffset(var X,Y:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestOffset(var X,Y:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestOverscan(var Top,Bottom,Left,Right:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetPalette(Buffer:Pointer;Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestPalette(Start,Count:LongWord; Buffer:Pointer; Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetLayer(var Layer:LongInt):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetLayer(var Layer:LongInt):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestLayer(var Layer:LongInt):LongWord;
Note | None documented |
---|
function RPi4FramebufferTestVsync:LongWord;
Note | None documented |
---|
function RPi4FramebufferSetVsync:LongWord;
Note | None documented |
---|
function RPi4FramebufferSetBacklight(Brightness:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetNumDisplays(var NumDisplays:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetDisplayId(DisplayNum:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferSetDisplayNum(DisplayNum:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferGetDisplaySettings(DisplayNum:LongWord; var DisplaySettings:TDisplaySettings):LongWord;
Note | None documented |
---|
function RPi4FramebufferDisplayIdToName(DisplayId:LongWord):String;
Note | None documented |
---|
function RPi4TouchGetBuffer(var Address:PtrUInt):LongWord;
Note | On current firmware versions calling TouchGetBuffer will allocate a buffer from GPU memory and render subsequent calls to TouchSetBuffer ineffective.
After an initial call to TouchSetBuffer calls to TouchGetBuffer will always return the CPU allocated buffer. |
---|
function RPi4TouchSetBuffer(Address:PtrUInt):LongWord;
Note | None documented |
---|
function RPi4VirtualGPIOGetBuffer(var Address:PtrUInt):LongWord;
Note | None documented |
---|
function RPi4VirtualGPIOSetBuffer(Address:PtrUInt):LongWord;
Note | None documented |
---|
function RPi4CursorSetDefault:LongWord;
Note | None documented |
---|
function RPi4CursorSetInfo(Width,Height,HotspotX,HotspotY:LongWord; Pixels:Pointer; Length:LongWord):LongWord;
Note | None documented |
---|
function RPi4CursorSetState(Enabled:Boolean; X,Y:LongWord; Relative:Boolean):LongWord;
Relative | X, Y is relative to Display (Virtual) not Framebuffer (Physical) |
---|
function RPi4DMAGetChannels:LongWord;
Note | None documented |
---|
function RPi4VirtualGPIOInputGet(Pin:LongWord):LongWord;
Note | None documented |
---|
function RPi4VirtualGPIOOutputSet(Pin,Level:LongWord):LongWord;
Note | None documented |
---|
function RPi4VirtualGPIOFunctionSelect(Pin,Mode:LongWord):LongWord;
Note | None documented |
---|
RPi4 thread functions
procedure RPi4SchedulerInit;
Note | None documented |
---|
procedure RPi4SchedulerStart(CPUID:LongWord);
Note | None documented |
---|
procedure RPi4SecondaryBoot(CPUID:LongWord);
Note | None documented |
---|
RPi4 SWI functions
function RPi4DispatchSWI(CPUID:LongWord; Thread:TThreadHandle; Request:PSystemCallRequest):TThreadHandle;
Note | Called by ARMv7/8SoftwareInterruptHandler in PlatformARMv7/8
A DataMemoryBarrier is executed before and after calling this function. |
---|
RPi4 clock functions
procedure RPi4ClockInterrupt(Parameter:Pointer);
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 RPi4ClockUpdate(Cycles:LongWord; var Last:LongWord);
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 |
RPi4 scheduler functions
function RPi4SchedulerInterrupt(CPUID:LongWord; Thread:TThreadHandle; Parameter:Pointer):TThreadHandle;
Note | This schedules another scheduler interrupt to occur SCHEDULER_CLOCKS_PER_INTERRUPT in the future, then checks for threads to wakeup or timeout and the next thread to schedule. |
---|
procedure RPi4SchedulerUpdate(Cycles:LongWord; var Last:LongWord);
Cycles | Number of cycles after which the scheduler interrupt is to be triggered |
---|---|
Note | This refers to native clock cycles as specified by RPI4_GENERIC_TIMER_FREQUENCY |
procedure RPi4SchedulerSystemCall(Request:PSystemCallRequest);
Note | This is registered to receive requests for the SYSTEM_CALL_CONTEXT_SWITCH and will perform a context switch from within an SWI |
---|
RPi4 framebuffer functions
function RPi4FramebufferDeviceAllocate(Framebuffer:PFramebufferDevice; Properties:PFramebufferProperties):LongWord;
Note | None documented |
---|
function RPi4FramebufferDeviceAllocateAlt(Framebuffer:PFramebufferDevice; Properties:PFramebufferProperties):LongWord;
Note | None documented |
---|
function RPi4FramebufferDeviceRelease(Framebuffer:PFramebufferDevice):LongWord;
Note | None documented |
---|
function RPi4FramebufferDeviceBlank(Framebuffer:PFramebufferDevice; Blank:Boolean):LongWord;
Note | None documented |
---|
function RPi4FramebufferDeviceCommit(Framebuffer:PFramebufferDevice; Address:PtrUInt; Size,Flags:LongWord):LongWord;
Note | None documented |
---|
function RPi4FramebufferDeviceSetBacklight(Framebuffer:PFramebufferDevice; Brightness:LongWord):LongWord;
Note | None documented |
---|
RPi4 helper functions
procedure RPi4Wait;
Note | None documented |
---|
procedure RPi4LongWait;
Note | None documented |
---|
procedure RPi4ShortWait;
Note | None documented |
---|
procedure RPi4SlowBlink;
Note | None documented |
---|
procedure RPi4FastBlink;
Note | None documented |
---|
procedure RPi4BootBlink;
Note | None documented |
---|
procedure RPi4BootOutput(Value:LongWord);
Note | This function is primarily intended for testing QEMU boot because it doesn't initialize the UART and won't work on real hardware.
Based on hexstrings() function by dwelch67 (https://github.com/dwelch67) |
---|
procedure RPi4BootConsoleStart;
Note | None documented |
---|
procedure RPi4BootConsoleWrite(const Value:String);
Note | None documented |
---|
procedure RPi4BootConsoleWriteEx(const Value:String; X,Y:LongWord);
Note | None documented |
---|
function RPi4BootConsoleGetX:LongWord;
Note | None documented |
---|
function RPi4BootConsoleGetY:LongWord;
Note | None documented |
---|
function RPi4ConvertPowerIdRequest(PowerId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertPowerStateRequest(PowerState:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertPowerStateResponse(PowerState:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertClockIdRequest(ClockId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertClockStateRequest(ClockState:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertClockStateResponse(ClockState:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertVoltageIdRequest(VoltageId:LongWord):LongWord;
Note | None documented |
---|
function RPi4ConvertTemperatureIdRequest(TemperatureId:LongWord):LongWord;
Note | None documented |
---|
Return to Unit Reference