Difference between revisions of "Unit Platform"

Revision as of 06:56, 7 June 2017

Return to Unit Reference

@@ Line 7,982: / Line 7,982: @@
 '''Clock functions'''
+<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 ClockTicks:LongWord;</pre>
+<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current number of clock ticks</div>
+<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+{| class="wikitable" style="font-size: 14px; background: white;"
+|-
+! '''The current number of clock ticks'''
+| The
+|-
+! '''Note'''
+| When this reaches CLOCK_TICKS_PER_SECOND then ClockSeconds is incremented and this is reset to zero
+|-
+|}
+<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 ClockSeconds:LongWord;</pre>
+<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the number of clock seconds since the system was started</div>
+<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+{| class="wikitable" style="font-size: 14px; background: white;"
+|-
+! '''Return'''
+| The current number of clock seconds
+|-
+! '''Note'''
+| This forms the system clock
+|-
+|}
+<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 ClockGetTime:Int64;</pre>

`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_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

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

`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

Difference between revisions of "Unit Platform"

Revision as of 06:56, 7 June 2017

Contents

Description

Constants

Type definitions

Class definitions

Public variables

Function declarations

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

`EXCEPTION_TYPE_DATA_ABORT = 1;`
`EXCEPTION_TYPE_PREFETCH_ABORT = 2;`
`EXCEPTION_TYPE_UNDEFINED_INSTRUCTION = 3;`

`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_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

`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

Data Properties
`Source:Pointer;`	Source address for DMA (May need to be allocated in accordance with DMA host configuration)
`Dest:Pointer;`	Dest address for DMA (May need to be allocated in accordance with DMA host configuration)
`Size:LongWord;`	Size for DMA transfer (For 2D stride the length of a row multiplied by the count of rows)
`Flags:LongWord;`	Flags for DMA transfer (See DMA_DATA_FLAG_* above)
Stride Properties
`StrideLength:LongWord;`	Length of each row during 2D stride (If supported)
`SourceStride:LongInt;`	Increment between rows for source address during 2D stride (If supported)
`DestStride:LongInt;`	Increment between rows for destination address during 2D stride (If supported)
Next Block
`Next:PDMAData;`	Link to next DMA data block (or nil for the last block)

`Number:LongWord;`
`Param1:LongWord;`
`Param2:LongWord;`
`Param3:LongWord;`

Handle Properties
`Signature:LongWord;`	Signature for entry validation
`HandleType:LongWord;`	Type of this Handle (eg HANDLE_TYPE_THREAD)
`HandleCount:LongWord;`	Reference Count of the Handle
Internal Properties
`Prev:PHandleEntry;`	Previous entry in Handle table
`Next:PHandleEntry;`	Next entry in Handle table
Statistics Properties

Shutdown Properties
`Signature:LongWord;`	Signature for entry validation
`Shutdown:procedure(Parameter:Pointer);`	The procedure to call on Shutdown
`Parameter:Pointer;`	The parameter to pass to the Shutdown procedure (or nil)
Internal Properties
`Prev:PShutdownEntry;`	Previous entry in Shutdown table
`Next:PShutdownEntry;`	Next entry in Shutdown table

`Number:LongWord;`
`CPUID:LongWord;`
`Handler:procedure(Parameter:Pointer);`
`HandlerEx:function(CPUID:LongWord; Thread:TThreadHandle; Parameter:Pointer):TThreadHandle;`
`Parameter:Pointer;`

`Number:LongWord;`
`CPUID:LongWord;`
`Handler:procedure(Request:PSystemCallRequest);`
`HandlerEx:function(CPUID:LongWord; Thread:TThreadHandle; Request:PSystemCallRequest):TThreadHandle;`

`VirtualAddress:PtrUInt;`
`PhysicalAddress:PtrUInt;`
`Size:LongWord;`
`Flags:LongWord;`

`Lock:THandle;`
`AcquireLock:function(Handle:THandle):LongWord;`
`ReleaseLock:function(Handle:THandle):LongWord;`

`Semaphore:THandle;`
`WaitSemaphore:function(Handle:THandle):LongWord;`
`SignalSemaphore:function(Handle:THandle):LongWord;`

`WriteChar:TTextIOWriteChar;`
`ReadChar:TTextIOReadChar;`
`UserData:Pointer;`

protected
`AllowFree:Boolean;`
public
`procedure FreeInstance; override;`

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

Rate	The clock rate in Hz to set
Return	ERROR_SUCCESS if the clock rate was set or another error code on failure

Return	The current interval in ticks or 0 on failure (or not set)
Note	The tick rate is determined by the clock rate

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

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)

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

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

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

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

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

The current number of clock ticks	The
Note	When this reaches CLOCK_TICKS_PER_SECOND then ClockSeconds is incremented and this is reset to zero

Return	The current number of clock seconds
Note	This forms the system clock

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.

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.

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)

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

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

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)