Difference between revisions of "Unit PL011"
From Ultibo.org
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...") |
|||
| Line 25: | Line 25: | ||
---- | ---- | ||
| − | |||
| + | '''PL011 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 PL011UARTCreate(Address:LongWord; 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;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Address''' | ||
| + | | The address of the PL011 registers | ||
| + | |- | ||
| + | ! '''Name''' | ||
| + | | The text description of this device which will show in the device list (Optional) | ||
| + | |- | ||
| + | ! '''IRQ''' | ||
| + | | The interrupt number for the PL011 | ||
| + | |- | ||
| + | ! '''ClockRate''' | ||
| + | | The clock source frequency for the PL011 | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | Pointer to the new UART device or nil if the UART 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 PL011UARTDestroy(UART:PUARTDevice):LongWord;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Close, deregister and destroy a PL011 UART 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;" | ||
| + | |- | ||
| + | ! '''UART''' | ||
| + | | The UART device to destroy | ||
| + | |- | ||
| + | ! '''Return''' | ||
| + | | ERROR_SUCCESS if completed or another error code on failure | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
Return to [[Unit_Reference|Unit Reference]] | Return to [[Unit_Reference|Unit Reference]] | ||
Revision as of 03:21, 23 November 2016
Return to Unit Reference
Description
To be documented
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
PL011 functions
function PL011UARTCreate(Address:LongWord; const Name:String; IRQ,ClockRate:LongWord):PUARTDevice;
Description: Create and register a new PL011 UART device which can be accessed using the UART API
| Address | The address of the PL011 registers |
|---|---|
| Name | The text description of this device which will show in the device list (Optional) |
| IRQ | The interrupt number for the PL011 |
| ClockRate | The clock source frequency for the PL011 |
| Return | Pointer to the new UART device or nil if the UART device could not be created |
function PL011UARTDestroy(UART:PUARTDevice):LongWord;
Description: Close, deregister and destroy a PL011 UART device created by this driver
| UART | The UART device to destroy |
|---|---|
| Return | ERROR_SUCCESS if completed or another error code on failure |
Return to Unit Reference
