diff options
| author | Ronald Cron <ronald.cron@arm.com> | 2014-10-27 15:37:37 +0000 |
|---|---|---|
| committer | oliviermartin <oliviermartin@Edk2> | 2014-10-27 15:37:37 +0000 |
| commit | ab716191081e676179c5d386c706e05e2d940db5 (patch) | |
| tree | a6f9a5068ae395939f949e94e6a549b2980a32d2 /ArmPlatformPkg/Library | |
| parent | 5f81a62094a12a435e677a1b6e5fbedc76a6a978 (diff) | |
| download | edk2-ab716191081e676179c5d386c706e05e2d940db5.tar.gz edk2-ab716191081e676179c5d386c706e05e2d940db5.tar.bz2 edk2-ab716191081e676179c5d386c706e05e2d940db5.zip | |
EmbeddedPkg: Clarify the declaration of SerialPortSetControl()
Rework of PL011UartSetControl() as a consequence as well as update of
function header comment blocks.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
Reviewed-By: Olivier Martin <olivier.martin@arm.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16251 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ArmPlatformPkg/Library')
| -rw-r--r-- | ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c index 723a1b1624..7b3cd89298 100644 --- a/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c +++ b/ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c @@ -1,7 +1,7 @@ /** @file
Serial I/O Port library functions with no library constructor/destructor
- Copyright (c) 2012-2013, ARM Ltd. All rights reserved.<BR>
+ Copyright (c) 2012-2014, ARM Ltd. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@@ -65,19 +65,35 @@ SerialPortSetAttributes ( }
/**
- Set the serial device control bits.
- @param Control Control bits which are to be set on the serial device.
-
- @retval EFI_SUCCESS The new control bits were set on the serial device.
- @retval EFI_UNSUPPORTED The serial device does not support this operation.
- @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
+ Assert or deassert the control signals on a serial port.
+ The following control signals are set according their bit settings :
+ . Request to Send
+ . Data Terminal Ready
+
+ @param[in] Control The following bits are taken into account :
+ . EFI_SERIAL_REQUEST_TO_SEND : assert/deassert the
+ "Request To Send" control signal if this bit is
+ equal to one/zero.
+ . EFI_SERIAL_DATA_TERMINAL_READY : assert/deassert
+ the "Data Terminal Ready" control signal if this
+ bit is equal to one/zero.
+ . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : enable/disable
+ the hardware loopback if this bit is equal to
+ one/zero.
+ . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : not supported.
+ . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : enable/
+ disable the hardware flow control based on CTS (Clear
+ To Send) and RTS (Ready To Send) control signals.
+
+ @retval RETURN_SUCCESS The new control bits were set on the serial device.
+ @retval RETURN_UNSUPPORTED The serial device does not support this operation.
**/
RETURN_STATUS
EFIAPI
SerialPortSetControl (
- IN UINT32 Control
+ IN UINT32 Control
)
{
return PL011UartSetControl ((UINTN)PcdGet64 (PcdSerialRegisterBase), Control);
|