tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Ronald Cron 2014-10-27 15:37:37 +00:00 committed by oliviermartin
parent 5f81a62094
commit ab71619108
4 changed files with 114 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c
View File

@ -2,7 +2,7 @@
Serial I/O Port library functions with no library constructor/destructor Serial I/O Port library functions with no library constructor/destructor
Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR> Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
Copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR> Copyright (c) 2011 - 2014, ARM Ltd. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -20,6 +20,12 @@
#include <Drivers/PL011Uart.h> #include <Drivers/PL011Uart.h>
//
// EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE is the only
// control bit that is not supported.
//
STATIC CONST UINT32 mInvalidControlBits = EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE;
/* /*
Initialise the serial port to the specified settings. Initialise the serial port to the specified settings.
@ -159,14 +165,30 @@ PL011UartInitializePort (
} }
/** /**
Set the serial device control bits.
@param UartBase The base address of the PL011 UART. Assert or deassert the control signals on a serial port.
@param Control Control bits which are to be set on the serial device. The following control signals are set according their bit settings :
. Request to Send
. Data Terminal Ready
@retval EFI_SUCCESS The new control bits were set on the serial device. @param[in] UartBase UART registers base address
@retval EFI_UNSUPPORTED The serial device does not support this operation. @param[in] Control The following bits are taken into account :
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. . 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 RETURN_STATUS
@ -177,35 +199,35 @@ PL011UartSetControl (
) )
{ {
UINT32 Bits; UINT32 Bits;
UINT32 ValidControlBits;
ValidControlBits = ( EFI_SERIAL_REQUEST_TO_SEND if (Control & (mInvalidControlBits)) {
| EFI_SERIAL_DATA_TERMINAL_READY return RETURN_UNSUPPORTED;
// | EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE // Not implemented yet.
// | EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE // Not implemented yet.
| EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE
);
if (Control & (~ValidControlBits)) {
return EFI_UNSUPPORTED;
} }
Bits = MmioRead32 (UartBase + UARTCR); Bits = MmioRead32 (UartBase + UARTCR);
if (Control & EFI_SERIAL_REQUEST_TO_SEND) { if (Control & EFI_SERIAL_REQUEST_TO_SEND) {
Bits |= PL011_UARTCR_RTS; Bits |= PL011_UARTCR_RTS;
} else {
Bits &= ~PL011_UARTCR_RTS;
} }
if (Control & EFI_SERIAL_DATA_TERMINAL_READY) { if (Control & EFI_SERIAL_DATA_TERMINAL_READY) {
Bits |= PL011_UARTCR_DTR; Bits |= PL011_UARTCR_DTR;
} else {
Bits &= ~PL011_UARTCR_DTR;
} }
if (Control & EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE) { if (Control & EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE) {
Bits |= PL011_UARTCR_LBE; Bits |= PL011_UARTCR_LBE;
} else {
Bits &= ~PL011_UARTCR_LBE;
} }
if (Control & EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE) { if (Control & EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE) {
Bits |= (PL011_UARTCR_CTSEN & PL011_UARTCR_RTSEN); Bits |= (PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN);
} else {
Bits &= ~(PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN);
} }
MmioWrite32 (UartBase + UARTCR, Bits); MmioWrite32 (UartBase + UARTCR, Bits);

30
ArmPlatformPkg/Include/Drivers/PL011Uart.h
View File

@ -1,6 +1,6 @@
/** @file /** @file
* *
* Copyright (c) 2011-2012, ARM Limited. All rights reserved. * Copyright (c) 2011-2014, ARM Limited. All rights reserved.
* *
* This program and the accompanying materials * This program and the accompanying materials
* are licensed and made available under the terms and conditions of the BSD License * are licensed and made available under the terms and conditions of the BSD License
@ -100,14 +100,30 @@ PL011UartInitializePort (
); );
/** /**
Set the serial device control bits.
@param UartBase The base address of the PL011 UART. Assert or deassert the control signals on a serial port.
@param Control Control bits which are to be set on the serial device. The following control signals are set according their bit settings :
. Request to Send
. Data Terminal Ready
@retval EFI_SUCCESS The new control bits were set on the serial device. @param[in] UartBase UART registers base address
@retval EFI_UNSUPPORTED The serial device does not support this operation. @param[in] Control The following bits are taken into account :
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. . 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 RETURN_STATUS

28
ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortExtLib.c
View File

@ -1,7 +1,7 @@
/** @file /** @file
Serial I/O Port library functions with no library constructor/destructor 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 This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -65,13 +65,29 @@ SerialPortSetAttributes (
} }
/** /**
Set the serial device control bits.
@param Control Control bits which are to be set on the serial device. 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
@retval EFI_SUCCESS The new control bits were set on the serial device. @param[in] Control The following bits are taken into account :
@retval EFI_UNSUPPORTED The serial device does not support this operation. . EFI_SERIAL_REQUEST_TO_SEND : assert/deassert the
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. "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 RETURN_STATUS

24
EmbeddedPkg/Include/Library/SerialPortExtLib.h
View File

@ -29,9 +29,29 @@
#include <Protocol/SerialIo.h> #include <Protocol/SerialIo.h>
/** /**
Set the serial device control bits.
@return Always return EFI_UNSUPPORTED. 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 RETURN_STATUS