2 Serial I/O Port library functions with no library constructor/destructor
4 Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
5 Copyright (c) 2012, ARM Ltd. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Library/IoLib.h>
20 #include <Library/PcdLib.h>
21 #include <Library/SerialPortLib.h>
22 #include <Library/SerialPortExtLib.h>
24 #include <Drivers/PL011Uart.h>
29 Programmed hardware of Serial port.
31 @return Always return RETURN_UNSUPPORTED.
36 SerialPortInitialize (
40 return PL011UartInitializePort (
41 (UINTN
)PcdGet64 (PcdSerialRegisterBase
),
42 (UINTN
)PcdGet64 (PcdUartDefaultBaudRate
),
43 0, // Use the default value for Fifo depth
44 (EFI_PARITY_TYPE
)PcdGet8 (PcdUartDefaultParity
),
45 PcdGet8 (PcdUartDefaultDataBits
),
46 (EFI_STOP_BITS_TYPE
) PcdGet8 (PcdUartDefaultStopBits
));
50 Write data to serial device.
52 @param Buffer Point of data buffer which need to be written.
53 @param NumberOfBytes Number of output bytes which are cached in Buffer.
55 @retval 0 Write data failed.
56 @retval !0 Actual number of bytes written to serial device.
63 IN UINTN NumberOfBytes
66 return PL011UartWrite ((UINTN
)PcdGet64 (PcdSerialRegisterBase
), Buffer
, NumberOfBytes
);
70 Read data from serial device and save the data in buffer.
72 @param Buffer Point of data buffer which need to be written.
73 @param NumberOfBytes Number of output bytes which are cached in Buffer.
75 @retval 0 Read data failed.
76 @retval !0 Actual number of bytes read from serial device.
83 IN UINTN NumberOfBytes
86 return PL011UartRead ((UINTN
)PcdGet64 (PcdSerialRegisterBase
), Buffer
, NumberOfBytes
);
90 Check to see if any data is available to be read from the debug device.
92 @retval EFI_SUCCESS At least one byte of data is available to be read
93 @retval EFI_NOT_READY No data is available to be read
94 @retval EFI_DEVICE_ERROR The serial device is not functioning properly
103 return PL011UartPoll ((UINTN
)PcdGet64 (PcdSerialRegisterBase
));
107 Set new attributes to PL011.
109 @param BaudRate The baud rate of the serial device. If the baud rate is not supported,
110 the speed will be reduced down to the nearest supported one and the
111 variable's value will be updated accordingly.
112 @param ReceiveFifoDepth The number of characters the device will buffer on input. If the specified
113 value is not supported, the variable's value will be reduced down to the
114 nearest supported one.
115 @param Timeout If applicable, the number of microseconds the device will wait
116 before timing out a Read or a Write operation.
117 @param Parity If applicable, this is the EFI_PARITY_TYPE that is computer or checked
118 as each character is transmitted or received. If the device does not
119 support parity, the value is the default parity value.
120 @param DataBits The number of data bits in each character
121 @param StopBits If applicable, the EFI_STOP_BITS_TYPE number of stop bits per character.
122 If the device does not support stop bits, the value is the default stop
125 @retval EFI_SUCCESS All attributes were set correctly on the serial device.
126 @retval EFI_INVALID_PARAMETERS One or more of the attributes has an unsupported value.
131 SerialPortSetAttributes (
133 IN UINT32 ReceiveFifoDepth
,
135 IN EFI_PARITY_TYPE Parity
,
137 IN EFI_STOP_BITS_TYPE StopBits
140 return PL011UartInitializePort (
141 (UINTN
)PcdGet64 (PcdSerialRegisterBase
),
150 Set the serial device control bits.
152 @param Control Control bits which are to be set on the serial device.
154 @retval EFI_SUCCESS The new control bits were set on the serial device.
155 @retval EFI_UNSUPPORTED The serial device does not support this operation.
156 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
161 SerialPortSetControl (
165 return PL011UartSetControl((UINTN
)PcdGet64 (PcdSerialRegisterBase
), Control
);
169 Get the serial device control bits.
171 @param Control Control signals read from the serial device.
173 @retval EFI_SUCCESS The control bits were read from the serial device.
174 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
179 SerialPortGetControl (
183 return PL011UartGetControl((UINTN
)PcdGet64 (PcdSerialRegisterBase
), Control
);