Unit PL031 - Revision history

Ultibo at 04:59, 17 June 2021

2021-06-17T04:59:27Z

Ultibo at 04:43, 24 April 2018

2018-04-24T04:43:24Z

Ultibo at 05:12, 23 April 2017

2017-04-23T05:12:59Z

Ultibo at 05:12, 23 April 2017

2017-04-23T05:12:08Z

Ultibo at 05:11, 23 April 2017

2017-04-23T05:11:15Z

Ultibo at 05:10, 23 April 2017

2017-04-23T05:10:01Z

Ultibo at 05:09, 23 April 2017

2017-04-23T05:09:24Z

Ultibo at 05:08, 23 April 2017

2017-04-23T05:08:17Z

Ultibo: Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

2017-04-23T05:07:19Z

Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To..."

New page

Return to [[Unit_Reference|Unit Reference]]

=== Description ===
----

''To be documented''

=== Constants ===
----

''To be documented''

=== Type definitions ===
----

''To be documented''

=== Public variables ===
----

''To be documented''

=== Function declarations ===
----

''To be documented''

Return to [[Unit_Reference|Unit Reference]]

@@ Line 180: / Line 180: @@
 <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 PL031RTCCreate(Address:LongWord; const Name:String; IRQ:LongWord):PRTCDevice;</pre>
+<pre style="border: 0; padding-bottom:0px;">function PL031RTCCreate(Address:PtrUInt; const Name:String; IRQ:LongWord):PRTCDevice;</pre>
 <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create, register and start a new PL031 RTC device which can be accessed using the RTC API</div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">

@@ Line 185: / Line 185: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Address'''
+! Address
 | The address of the PL031 registers
 |-
-! '''Name'''
+! Name
 | The text description of this device which will show in the device list (Optional)
 |-
-! '''IRQ'''
+! IRQ
 | The interrupt number for the PL031
 |-
-! '''Return'''
+! Return
 | Pointer to the new RTC device or nil if the RTC device could not be created
 |-
@@ Line 206: / Line 206: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''RTC'''
+! RTC
 | The RTC device to destroy
 |-
-! '''Return'''
+! Return
 | ERROR_SUCCESS if completed or another error code on failure
 |-
@@ Line 224: / Line 224: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use RTCDeviceStart instead
+| Not intended to be called directly by applications, use RTCDeviceStart instead.
 |-
 |}
@@ Line 236: / Line 236: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use RTCDeviceStop instead
+| Not intended to be called directly by applications, use RTCDeviceStop instead.
 |-
 |}
@@ Line 248: / Line 248: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use RTCDeviceGetTime instead
+| Not intended to be called directly by applications, use RTCDeviceGetTime instead.
 |-
 |}
@@ Line 260: / Line 260: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use RTCDeviceSetTime instead
+| Not intended to be called directly by applications, use RTCDeviceSetTime instead.
 |-
 |}
@@ Line 275: / Line 275: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
 | None documented
 |-
@@ Line 287: / Line 287: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
 | None documented
 |-

← Older revision		Revision as of 05:11, 23 April 2017
Line 31:		Line 31:
	----		----

−	~~''To be documented''~~

		+	'''PL031 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 PL031RTCCreate(Address:LongWord; const Name:String; IRQ:LongWord):PRTCDevice;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Create, register and start a new PL031 RTC device which can be accessed using the RTC API</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Address'''
		+	\| The address of the PL031 registers
		+	\|-
		+	! '''Name'''
		+	\| The text description of this device which will show in the device list (Optional)
		+	\|-
		+	! '''IRQ'''
		+	\| The interrupt number for the PL031
		+	\|-
		+	! '''Return'''
		+	\| Pointer to the new RTC device or nil if the RTC device could not be created
		+	\|-
		+	\|}
		+	</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 PL031RTCDestroy(RTC:PRTCDevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Stop, deregister and destroy a PL031 RTC device created by this driver</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''RTC'''
		+	\| The RTC device to destroy
		+	\|-
		+	! '''Return'''
		+	\| ERROR_SUCCESS if completed or another error code on failure
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+
		+	'''PL031 RTC 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 PL031RTCStart(RTC:PRTCDevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of RTCDeviceStart API for PL031 RTC</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use RTCDeviceStart instead
		+	\|-
		+	\|}
		+	</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 PL031RTCStop(RTC:PRTCDevice):LongWord;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of RTCDeviceStop API for PL031 RTC</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use RTCDeviceStop instead
		+	\|-
		+	\|}
		+	</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 PL031RTCGetTime(RTC:PRTCDevice):Int64;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of RTCDeviceGetTime API for PL031 RTC</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use RTCDeviceGetTime instead
		+	\|-
		+	\|}
		+	</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 PL031RTCSetTime(RTC:PRTCDevice; const Time:Int64):Int64;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of RTCDeviceSetTime API for PL031 RTC</div>
		+	<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
		+	{\| class="wikitable" style="font-size: 14px; background: white;"
		+	\|-
		+	! '''Note'''
		+	\| Not intended to be called directly by applications, use RTCDeviceSetTime instead
		+	\|-
		+	\|}
		+	</div></div>
		+	<br />
		+
		+	'''PL031 helper 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 PL031FileTimeToRTCTime(RTC:PRTCDevice; const FileTime:Int64; var RTCTime:LongWord):Boolean;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a FileTime value in 100 nanosecond ticks since 1 January 1601 to the time format of the PL031 RTC which is seconds since 1 January 1970</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 PL031RTCTimeToFileTime(RTC:PRTCDevice; RTCTime:LongWord; var FileTime:Int64):Boolean;</pre>
		+	<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a PL031 RTC time value in seconds since 1 January 1970 to the FileTime format which is 100 nanosecond ticks since 1 January 1601</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 />

	Return to [[Unit_Reference\|Unit Reference]]		Return to [[Unit_Reference\|Unit Reference]]

@@ Line 5: / Line 5: @@
 ----
-ARM PrimeCell PL031 Real Time Clock Driver
+'''ARM PrimeCell PL031 Real Time Clock Driver unit'''
 The PL031 is a simple memory mapped Real Time Clock (RTC) device that supports a single 32-bit time counter based on the Unix time format which starts at 1 Jan 1970 and runs out at 19 Jan 2038.

@@ Line 16: / Line 16: @@
 ----
-''To be documented''
 === Type definitions ===

@@ Line 21: / Line 21: @@
 ----
-''To be documented''
 === Public variables ===

@@ Line 20: / Line 20: @@
 ----
-''To be documented''
+''None defined''
 === Function declarations ===