Unit PL011 - Revision history

Ultibo at 05:46, 31 August 2021

2021-08-31T05:46:21Z

Ultibo at 04:57, 17 June 2021

2021-06-17T04:57:47Z

Ultibo at 02:52, 3 May 2018

2018-05-03T02:52:11Z

Ultibo at 02:51, 3 May 2018

2018-05-03T02:51:03Z

Ultibo at 02:49, 3 May 2018

2018-05-03T02:49:46Z

Ultibo at 04:41, 24 April 2018

2018-04-24T04:41:23Z

Ultibo at 04:54, 27 March 2018

2018-03-27T04:54:51Z

Ultibo at 07:11, 20 April 2017

2017-04-20T07:11:03Z

Ultibo at 07:04, 20 April 2017

2017-04-20T07:04:43Z

Ultibo at 06:56, 20 April 2017

2017-04-20T06:56:17Z

← Older revision		Revision as of 05:46, 31 August 2021
Line 6:		Line 6:

	'''ARM PrimeCell PL011 UART Driver unit'''		'''ARM PrimeCell PL011 UART Driver unit'''
−
−	~~''To be documented''~~

	=== Constants ===		=== Constants ===

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

@@ Line 58: / Line 58: @@
 |-
 | <code>PL011_UART_CLOCK_RATE = 24000000;</code>
 | &nbsp;
 |-

@@ Line 722: / Line 722: @@
 | <code>Registers:PPL011UARTRegisters;</code>
 | Device registers
 |-
 |colspan="2"|''Statistics Properties''

@@ Line 826: / Line 826: @@
 ! Note
 | Not intended to be called directly by applications, use UARTDeviceRead instead.
 |-
 |}

@@ Line 758: / Line 758: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Address'''
+! Address
 | The address of the PL011 registers
 |-
-! '''Name'''
+! Name
 | The text description of this device which will show in the device list (Optional)
 |-
-! '''IRQ'''
+! IRQ
 | The interrupt number for the PL011
 |-
-! '''ClockRate'''
+! ClockRate
 | The clock source frequency for the PL011
 |-
-! '''Return'''
+! Return
 | Pointer to the new UART device or nil if the UART device could not be created
 |-
@@ Line 782: / Line 782: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''UART'''
+! UART
 | The UART device to destroy
 |-
-! '''Return'''
+! Return
 | ERROR_SUCCESS if completed or another error code on failure
 |-
@@ Line 800: / Line 800: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceOpen instead
+| Not intended to be called directly by applications, use UARTDeviceOpen instead.
 |-
 |}
@@ Line 812: / Line 812: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceClose instead
+| Not intended to be called directly by applications, use UARTDeviceClose instead.
 |-
 |}
@@ Line 824: / Line 824: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceRead instead
+| Not intended to be called directly by applications, use UARTDeviceRead instead.
 |-
 |}
@@ Line 836: / Line 836: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceWrite instead
+| Not intended to be called directly by applications, use UARTDeviceWrite instead.
 |-
 |}
@@ Line 848: / Line 848: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceGetStatus instead
+| Not intended to be called directly by applications, use UARTDeviceGetStatus instead.
 |-
 |}
@@ Line 860: / Line 860: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
-| Not intended to be called directly by applications, use UARTDeviceSetStatus instead
+| Not intended to be called directly by applications, use UARTDeviceSetStatus instead.
 |-
 |}
@@ Line 872: / Line 872: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
 | Not intended to be called directly by applications
 |-
@@ Line 884: / Line 884: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
 | Not intended to be called directly by applications
 |-
@@ Line 896: / Line 896: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Note'''
+! Note
 | Not intended to be called directly by applications
 |-
@@ Line 908: / Line 908: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''UART'''
+! UART
 | The PL011 UART device to enable the interrupt for
 |-
-! '''Interrupt'''
+! Interrupt
 | The interrupt to enable
 |-
-! '''Note'''
+! Note
 | Caller must hold the UART lock
 |-
@@ Line 926: / Line 926: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-! '''Network'''
+! Network
 | The PL011 UART device to disable the interrupt for
 |-
-! '''Interrupt'''
+! Interrupt
 | The interrupt to disable
 |-
-! '''Note'''
+! Note
 | Caller must hold the UART lock
 |-

@@ Line 843: / Line 843: @@
 <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 PL011UARTStatus(UART:PUARTDevice):LongWord;</pre>
+<pre style="border: 0; padding-bottom:0px;">function PL011UARTGetStatus(UART:PUARTDevice):LongWord;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of UARTDeviceStatus API for PL011 UART</div>
+<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Implementation of UARTDeviceGetStatus API for PL011 UART</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 UARTDeviceStatus instead
+| Not intended to be called directly by applications, use UARTDeviceGetStatus instead
 |-
 |}

@@ Line 735: / Line 735: @@
 ----
-''None defined''
 === Function declarations ===

@@ Line 582: / Line 582: @@
 {| class="wikitable" style="font-size: 14px; background: white;"
 |-
-|colspan="2"|Note: Layout of the PL011 registers (See: http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0183g/index.html)
+|colspan="2"|Note: Layout of the PL011 registers (See: http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0183g/I18702.html))
 |-
 | <code>DR:LongWord;</code>
@@ Line 713: / Line 713: @@
 | <code>IRQ:LongWord;</code>
 | &nbsp;
 |-
 | <code>ClockRate:LongWord;</code>