Unit PlatformARM

Return to Unit Reference

Description

---

Ultibo Platform interface unit for ARM

To be documented

Constants

---

[Expand]

ARM mode constants ARM_MODE_*

Bits 4..0 in the ARM program status register
See: A2.2 Processor Modes of the ARM Architecture Reference Manual and also A2.5.7 The mode bits
See also: B1.3.1 ARM processor modes of the ARM Architecture Reference Manual (ARMv7-A and ARMv7-R edition)
ARM_MODE_USR = $10;	Normal User Mode
ARM_MODE_FIQ = $11;	FIQ Processing Fast Interrupts Mode
ARM_MODE_IRQ = $12;	IRQ Processing Standard Interrupts Mode
ARM_MODE_SVC = $13;	Supervisor Processing Software Interrupts Mode
ARM_MODE_MON = $16;	Secure Monitor Mode (For Secure / Non Secure Switching)
ARM_MODE_MON = $16;	Secure Monitor Mode (For Secure / Non Secure Switching)
ARM_MODE_ABT = $17;	Abort Processing memory Faults Mode
ARM_MODE_HYP = $1A;	Hypervisor Mode
ARM_MODE_UND = $1B;	Undefined Processing Undefined Instructions Mode
ARM_MODE_SYS = $1F;	System Running Priviledged Operating System Tasks Mode
ARM_MODE_BITS = $0000001F;	Mask of the mode bits in the program status register

[Expand]

ARM interrupt disable constants ARM_I_*

Bits 7 and 6 in the ARM program status register
See: A2.5.6 "The interrupt disable bits" of the ARM Architecture Reference Manual
ARM_I_BIT = $00000080;	IRQs disabled when set to 1
ARM_F_BIT = $00000040;	FIQs disabled when set to 1

[Expand]

ARM thumb and jazelle constants ARM_*_BIT

Bits 24 and 5 in the ARM program status register
See: A2.5.8 "The T and J bits" of the ARM Architecture Reference Manual
ARM_T_BIT = $00000020;	Thumb mode enabled when set to 1
ARM_J_BIT = $01000000;	Jazelle mode enabled when set to 1

[Expand]

ARM abort constants ARM_A_*

Bit 8 in the ARM program status register
ARM_A_BIT = $00000100;	Data Abort masked when set to 1

[Expand]

ARM boot tag constants ATAG_*

ATAG_NONE = $00000000;
ATAG_CORE = $54410001;
ATAG_MEM = $54410002;
ATAG_VIDEOTEXT = $54410003;
ATAG_RAMDISK = $54410004;
ATAG_INITRD2 = $54410005;
ATAG_SERIAL = $54410006;
ATAG_REVISION = $54410007;
ATAG_VIDEOLFB = $54410008;
ATAG_CMDLINE = $54410009;
ARMTAGS_INITIAL = $FFFFFFFF;

[Expand]

ARM machine type constants ARM_MACHINE_*

ARM_MACHINE_VERSATILE_PB = $00000183;
ARM_MACHINE_BCM2708 = $00000C42;
ARM_MACHINE_BCM2709 = $00000C42;	BCM2709 uses the same Machine Type as BCM2708
ARM_MACHINE_BCM2710 = $00000C42;	BCM2710 uses the same Machine Type as BCM2708

Type definitions

---

To be documented

Public variables

---

ARM specific variables

ARMInitialized:Boolean;

ARMBootMode:LongWord = 0;

The ARM Mode that the processor was in at boot time (Set by Startup). Must be initialized to remain in .data or else rewritten to zero with .bss

ARMBootVectors:LongWord = 0;

The Vector Base Address that was current at boot time (Set by Startup). Must be initialized to remain in .data or else rewritten to zero with .bss

ARMTagsAddress:LongWord = ARMTAGS_INITIAL;

Pointer to the ARM TAGS provided by the bootloader at startup (Set by Startup). Must be initialized to remain in .data or else rewritten to zero with .bss

ARMMachineType:LongWord = 0;

ARM Machine Type provided by the bootloader at startup (Set by Startup). Must be initialized to remain in .data or else rewritten to zero with .bss

ARM tags variables

ARMTagsCount:LongWord;

Number of ARM Tags found during parse

Tag none variables

TagNoneCount:LongWord;

Number of ARM NONE Tags found during parse

Tag core variables

TagCoreCount:LongWord;

Number of ARM CORE Tags found during parse

TagCoreFlags:LongWord;

TagCorePageSize:LongWord;

TagCoreRootDevice:LongWord;

Tag memory variables

TagMemoryCount:LongWord;

Number of ARM MEM Tags found during parse

TagMemorySize:LongWord;

Size of the last block reported by ARM Tags

TagMemoryStart:LongWord;

Start of the last block reported by ARM Tags

TagMemoryLength:LongWord;

Adjusted Size of the last block reported by ARM Tags

TagMemoryAddress:LongWord;

Adjusted Address of the last block reported by ARM Tags

Tag video text variables

TagVideoTextCount:LongWord;

Number of ARM VIDEOTEXT Tags found during parse

Tag ramdisk variables

TagRamdiskCount:LongWord;

Number of ARM RAMDISK Tags found during parse

Tag Init RD2 variables

TagInitRd2Count:LongWord;

Number of ARM INITRD2 Tags found during parse

Tag serial variables

TagSerialCount:LongWord;

Number of ARM SERIAL Tags found during parse

TagSerialNoLow:LongWord;

TagSerialNoHigh:LongWord;

Tag revision variables

TagRevisionCount:LongWord;

Number of ARM REVISION Tags found during parse

TagRevisionNo:LongWord;

Tag video FB variables

TagVideoFBCount:LongWord;

Number of ARM VIDEOLFB Tags found during parse

Tag command variables

TagCmdCount:LongWord;

Number of ARM CMDLINE Tags found during parse

TagCommandSize:LongWord;

Length of the command line in characters (Including null terminator)

TagCommandCount:LongInt;

Count of parameters (space delimited) in the command line

TagCommandAddress:PChar;

Pointer to the start of the command line

Wait handlers

ARMWaitHandler:TARMWait;

ARMLongWaitHandler:TARMLongWait;

ARMShortWaitHandler:TARMShortWait;

Blink handlers

ARMSlowBlinkHandler:TARMSlowBlink;

ARMFastBlinkHandler:TARMFastBlink;

Function declarations

---

Initialization functions

[Expand]

procedure ARMInit;

Description: To be documented

Note	None documented

ARM platform functions

[Expand]

procedure ARMParseBootTags;

Description: Extract some information from the ARM boot tag list and use it to load the memory manager, some other information is stored in variables for future use

Note	None documented

[Expand]

procedure ARMParseCommandLine;

Description: Setup argc, argv and cmdline and process known command line options

Note	None documented

[Expand]

procedure ARMParseEnvironment;

Description: Setup envp and process known environment options

Note	None documented

[Expand]

function ARMGetSP:PtrUInt; assembler; nostackframe;

Description: Get the current stack pointer (SP)

Note	None documented

[Expand]

function ARMGetPC:PtrUInt; assembler; nostackframe;

Description: Get the current program counter (PC)

Note	None documented

[Expand]

function ARMGetIRQ:Boolean; assembler; nostackframe;

Description: Get Interrupts (IRQ) state

Return	True is enabled, False if disabled (Returned in R0)

[Expand]

procedure ARMEnableIRQ; assembler; nostackframe;

Description: Enable Interrupts (IRQ) unconditionally

Note	None documented

[Expand]

procedure ARMDisableIRQ; assembler; nostackframe;

Description: Disable Interrupts (IRQ) unconditionally

Note	None documented

[Expand]

function ARMSaveIRQ:TIRQMask; assembler; nostackframe;

Description: Disable Interrupts (IRQ) and return the previous state

Return	IRQ state when called (Returned in R0)

[Expand]

function ARMRestoreIRQ(IRQMask:TIRQMask):TIRQMask; assembler; nostackframe;

Description: Restore Interrupts (IRQ) to a previous state

IRQMask	IRQ state to restore (Passed in R0)
Return	IRQ state when called (Returned in R0)

[Expand]

function ARMGetFIQ:Boolean; assembler; nostackframe;

Description: Get Fast Interrupts (FIQ) state

Return	True is enabled, False if disabled (Returned in R0)

[Expand]

procedure ARMEnableFIQ; assembler; nostackframe;

Description: Enable Fast Interrupts (FIQ) unconditionally

Note	None documented

[Expand]

procedure ARMDisableFIQ; assembler; nostackframe;

Description: Disable Fast Interrupts (FIQ) unconditionally

Note	None documented

[Expand]

function ARMSaveFIQ:TFIQMask; assembler; nostackframe;

Description: Disable Fast Interrupts (FIQ) and return the previous state

Return	FIQ state when called (Returned in R0)

[Expand]

function ARMRestoreFIQ(FIQMask:TFIQMask):TFIQMask; assembler; nostackframe;

Description: Restore Fast Interrupts (FIQ) to a previous state

FIQMask	FIQ state to restore (Passed in R0)
Return	FIQ state when called (Returned in R0)

[Expand]

procedure ARMEnableIRQFIQ; assembler; nostackframe;

Description: Enable Interrupts and Fast Interrupts (IRQ/FIQ) unconditionally

Note	None documented

[Expand]

procedure ARMDisableIRQFIQ; assembler; nostackframe;

Description: Disable Interrupts and Fast Interrupts (IRQ/FIQ) unconditionally

Note	None documented

[Expand]

function ARMSaveIRQFIQ:TIRQFIQMask; assembler; nostackframe;

Description: Disable Interrupts and Fast Interrupts (IRQ/FIQ) and return the previous state

Return	IRQ/FIQ state when called (Returned in R0)

[Expand]

function ARMRestoreIRQFIQ(IRQFIQMask:TIRQFIQMask):TIRQFIQMask; assembler; nostackframe;

Description: Restore Interrupts and Fast Interrupts (IRQ/FIQ) to a previous state

IRQFIQMask	IRQ/FIQ state to restore (Passed in R0)
Return	IRQ/FIQ state when called (Returned in R0)

[Expand]

function ARMGetAbort:Boolean; assembler; nostackframe;

Description: Get Abort state

Return	True is enabled, False if disabled (Returned in R0)

[Expand]

procedure ARMEnableAbort; assembler; nostackframe;

Description: Enable Aborts unconditionally

Note	None documented

[Expand]

procedure ARMDisableAbort; assembler; nostackframe;

Description: Disable Aborts unconditionally

Note	None documented

[Expand]

function ARMSaveAbort:TAbortMask; assembler; nostackframe;

Description: Disable Aborts and return the previous state

Return	Abort state when called (Returned in R0)

[Expand]

function ARMRestoreAbort(AbortMask:TAbortMask):TAbortMask; assembler; nostackframe;

Description: Restore Aborts to a previous state

AbortMask	Abort state to restore (Passed in R0)
Return	Abort state when called (Returned in R0)

ARM helper functions

[Expand]

procedure ARMWait; inline;

Description: To be documented

Note	None documented

[Expand]

procedure ARMLongWait; inline;

Description: To be documented

Note	None documented

[Expand]

procedure ARMShortWait; inline;

Description: To be documented

Note	None documented

[Expand]

procedure ARMSlowBlink; inline;

Description: To be documented

Note	None documented

[Expand]

procedure ARMFastBlink; inline;

Description: To be documented

Note	None documented

[Expand]

function ARMModeToString(ARMMode:LongWord):String;

Description: To be documented

Note	None documented

Return to Unit Reference