2 Serial I/O Port library functions with base address discovered from FDT
4 Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
5 Copyright (c) 2012 - 2013, ARM Ltd. All rights reserved.<BR>
6 Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>
7 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #include <Library/PcdLib.h>
22 #include <Library/SerialPortLib.h>
25 #include <Drivers/PL011Uart.h>
29 SerialPortInitialize (
34 // This SerialPortInitialize() function is completely empty, for a number of
36 // - if we are executing from flash, it is hard to keep state (i.e., store the
37 // discovered base address in a global), and the most robust way to deal
38 // with this is to discover the base address at every Write ();
39 // - calls to the Write() function in this module may be issued before this
40 // initialization function is called: this is not a problem when the base
41 // address of the UART is hardcoded, and only the baud rate may be wrong,
42 // but if we don't know the base address yet, we may be poking into memory
43 // that does not tolerate being poked into;
44 // - SEC and PEI phases produce debug output only, so with debug disabled, no
45 // initialization (or device tree parsing) is performed at all.
47 // Note that this means that on *every* Write () call, the device tree will be
48 // parsed and the UART re-initialized. However, this is a small price to pay
49 // for having serial debug output on a UART with no fixed base address.
51 return RETURN_SUCCESS
;
56 SerialPortGetBaseAddress (
61 UINT32 ReceiveFifoDepth
;
62 EFI_PARITY_TYPE Parity
;
64 EFI_STOP_BITS_TYPE StopBits
;
68 CONST CHAR8
*Compatible
;
69 CONST CHAR8
*NodeStatus
;
70 CONST CHAR8
*CompatibleItem
;
71 CONST UINT64
*RegProperty
;
75 DeviceTreeBase
= (VOID
*)(UINTN
)PcdGet64 (PcdDeviceTreeInitialBaseAddress
);
77 if ((DeviceTreeBase
== NULL
) || (fdt_check_header (DeviceTreeBase
) != 0)) {
82 // Enumerate all FDT nodes looking for a PL011 and capture its base address
84 for (Prev
= 0;; Prev
= Node
) {
85 Node
= fdt_next_node (DeviceTreeBase
, Prev
, NULL
);
90 Compatible
= fdt_getprop (DeviceTreeBase
, Node
, "compatible", &Len
);
91 if (Compatible
== NULL
) {
96 // Iterate over the NULL-separated items in the compatible string
98 for (CompatibleItem
= Compatible
; CompatibleItem
< Compatible
+ Len
;
99 CompatibleItem
+= 1 + AsciiStrLen (CompatibleItem
)) {
101 if (AsciiStrCmp (CompatibleItem
, "arm,pl011") == 0) {
102 NodeStatus
= fdt_getprop (DeviceTreeBase
, Node
, "status", &Len
);
103 if (NodeStatus
!= NULL
&& AsciiStrCmp (NodeStatus
, "okay") != 0) {
107 RegProperty
= fdt_getprop (DeviceTreeBase
, Node
, "reg", &Len
);
111 UartBase
= (UINTN
)fdt64_to_cpu (ReadUnaligned64 (RegProperty
));
113 BaudRate
= (UINTN
)FixedPcdGet64 (PcdUartDefaultBaudRate
);
114 ReceiveFifoDepth
= 0; // Use the default value for Fifo depth
115 Parity
= (EFI_PARITY_TYPE
)FixedPcdGet8 (PcdUartDefaultParity
);
116 DataBits
= FixedPcdGet8 (PcdUartDefaultDataBits
);
117 StopBits
= (EFI_STOP_BITS_TYPE
) FixedPcdGet8 (PcdUartDefaultStopBits
);
119 Status
= PL011UartInitializePort (
121 FixedPcdGet32 (PL011UartClkInHz
),
128 if (!EFI_ERROR (Status
)) {
138 Write data to serial device.
140 @param Buffer Point of data buffer which need to be written.
141 @param NumberOfBytes Number of output bytes which are cached in Buffer.
143 @retval 0 Write data failed.
144 @retval !0 Actual number of bytes written to serial device.
151 IN UINTN NumberOfBytes
154 UINT64 SerialRegisterBase
;
156 SerialRegisterBase
= SerialPortGetBaseAddress ();
157 if (SerialRegisterBase
!= 0) {
158 return PL011UartWrite ((UINTN
)SerialRegisterBase
, Buffer
, NumberOfBytes
);
164 Read data from serial device and save the data in buffer.
166 @param Buffer Point of data buffer which need to be written.
167 @param NumberOfBytes Size of Buffer[].
169 @retval 0 Read data failed.
170 @retval !0 Actual number of bytes read from serial device.
177 IN UINTN NumberOfBytes
184 Check to see if any data is available to be read from the debug device.
186 @retval TRUE At least one byte of data is available to be read
187 @retval FALSE No data is available to be read
200 Sets the control bits on a serial device.
202 @param[in] Control Sets the bits of Control that are settable.
204 @retval RETURN_SUCCESS The new control bits were set on the serial device.
205 @retval RETURN_UNSUPPORTED The serial device does not support this operation.
206 @retval RETURN_DEVICE_ERROR The serial device is not functioning correctly.
211 SerialPortSetControl (
215 return RETURN_UNSUPPORTED
;
219 Retrieve the status of the control bits on a serial device.
221 @param[out] Control A pointer to return the current control signals from the serial device.
223 @retval RETURN_SUCCESS The control bits were read from the serial device.
224 @retval RETURN_UNSUPPORTED The serial device does not support this operation.
225 @retval RETURN_DEVICE_ERROR The serial device is not functioning correctly.
230 SerialPortGetControl (
234 return RETURN_UNSUPPORTED
;
238 Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
239 data bits, and stop bits on a serial device.
241 @param BaudRate The requested baud rate. A BaudRate value of 0 will use the
242 device's default interface speed.
243 On output, the value actually set.
244 @param ReveiveFifoDepth The requested depth of the FIFO on the receive side of the
245 serial interface. A ReceiveFifoDepth value of 0 will use
246 the device's default FIFO depth.
247 On output, the value actually set.
248 @param Timeout The requested time out for a single character in microseconds.
249 This timeout applies to both the transmit and receive side of the
250 interface. A Timeout value of 0 will use the device's default time
252 On output, the value actually set.
253 @param Parity The type of parity to use on this serial device. A Parity value of
254 DefaultParity will use the device's default parity value.
255 On output, the value actually set.
256 @param DataBits The number of data bits to use on the serial device. A DataBits
257 vaule of 0 will use the device's default data bit setting.
258 On output, the value actually set.
259 @param StopBits The number of stop bits to use on this serial device. A StopBits
260 value of DefaultStopBits will use the device's default number of
262 On output, the value actually set.
264 @retval RETURN_SUCCESS The new attributes were set on the serial device.
265 @retval RETURN_UNSUPPORTED The serial device does not support this operation.
266 @retval RETURN_INVALID_PARAMETER One or more of the attributes has an unsupported value.
267 @retval RETURN_DEVICE_ERROR The serial device is not functioning correctly.
272 SerialPortSetAttributes (
273 IN OUT UINT64
*BaudRate
,
274 IN OUT UINT32
*ReceiveFifoDepth
,
275 IN OUT UINT32
*Timeout
,
276 IN OUT EFI_PARITY_TYPE
*Parity
,
277 IN OUT UINT8
*DataBits
,
278 IN OUT EFI_STOP_BITS_TYPE
*StopBits
281 return RETURN_UNSUPPORTED
;