Serial I/O Port library functions with no library constructor/destructor\r
\r
Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
- Copyright (c) 2012 - 2014, ARM Ltd. All rights reserved.<BR>\r
+ Copyright (c) 2012 - 2016, ARM Ltd. All rights reserved.<BR>\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
EFI_STOP_BITS_TYPE StopBits;\r
\r
BaudRate = (UINTN)PcdGet64 (PcdUartDefaultBaudRate);\r
- ReceiveFifoDepth = 0; // Use the default value for Fifo depth\r
+ ReceiveFifoDepth = 0; // Use default FIFO depth\r
Parity = (EFI_PARITY_TYPE)PcdGet8 (PcdUartDefaultParity);\r
DataBits = PcdGet8 (PcdUartDefaultDataBits);\r
StopBits = (EFI_STOP_BITS_TYPE) PcdGet8 (PcdUartDefaultStopBits);\r
\r
return PL011UartInitializePort (\r
(UINTN)PcdGet64 (PcdSerialRegisterBase),\r
- &BaudRate, &ReceiveFifoDepth, &Parity, &DataBits, &StopBits);\r
+ &BaudRate,\r
+ &ReceiveFifoDepth,\r
+ &Parity,\r
+ &DataBits,\r
+ &StopBits\r
+ );\r
}\r
\r
/**\r
/**\r
Set new attributes to PL011.\r
\r
- @param BaudRate The baud rate of the serial device. If the baud rate is not supported,\r
- the speed will be reduced down to the nearest supported one and the\r
- variable's value will be updated accordingly.\r
- @param ReceiveFifoDepth The number of characters the device will buffer on input. If the specified\r
- value is not supported, the variable's value will be reduced down to the\r
- nearest supported one.\r
- @param Timeout If applicable, the number of microseconds the device will wait\r
- before timing out a Read or a Write operation.\r
- @param Parity If applicable, this is the EFI_PARITY_TYPE that is computed or checked\r
- as each character is transmitted or received. If the device does not\r
- support parity, the value is the default parity value.\r
+ @param BaudRate The baud rate of the serial device. If the\r
+ baud rate is not supported, the speed will\r
+ be reduced down to the nearest supported one\r
+ and the variable's value will be updated\r
+ accordingly.\r
+ @param ReceiveFifoDepth The number of characters the device will\r
+ buffer on input. If the specified value is\r
+ not supported, the variable's value will\r
+ be reduced down to the nearest supported one.\r
+ @param Timeout If applicable, the number of microseconds the\r
+ device will wait before timing out a Read or\r
+ a Write operation.\r
+ @param Parity If applicable, this is the EFI_PARITY_TYPE\r
+ that is computed or checked as each character\r
+ is transmitted or received. If the device\r
+ does not support parity, the value is the\r
+ default parity value.\r
@param DataBits The number of data bits in each character\r
- @param StopBits If applicable, the EFI_STOP_BITS_TYPE number of stop bits per character.\r
- If the device does not support stop bits, the value is the default stop\r
- bit value.\r
+ @param StopBits If applicable, the EFI_STOP_BITS_TYPE number\r
+ of stop bits per character. If the device\r
+ does not support stop bits, the value is the\r
+ default stop bit value.\r
\r
- @retval EFI_SUCCESS All attributes were set correctly on the serial device.\r
- @retval EFI_INVALID_PARAMETERS One or more of the attributes has an unsupported value.\r
+ @retval EFI_SUCCESS All attributes were set correctly.\r
+ @retval EFI_INVALID_PARAMETERS One or more attributes has an unsupported\r
+ value.\r
\r
**/\r
RETURN_STATUS\r
)\r
{\r
return PL011UartInitializePort (\r
- (UINTN)PcdGet64 (PcdSerialRegisterBase),\r
- BaudRate,\r
- ReceiveFifoDepth,\r
- Parity,\r
- DataBits,\r
- StopBits);\r
+ (UINTN)PcdGet64 (PcdSerialRegisterBase),\r
+ BaudRate,\r
+ ReceiveFifoDepth,\r
+ Parity,\r
+ DataBits,\r
+ StopBits\r
+ );\r
}\r
\r
/**\r
disable the hardware flow control based on CTS (Clear\r
To Send) and RTS (Ready To Send) control signals.\r
\r
- @retval RETURN_SUCCESS The new control bits were set on the serial device.\r
- @retval RETURN_UNSUPPORTED The serial device does not support this operation.\r
+ @retval RETURN_SUCCESS The new control bits were set on the device.\r
+ @retval RETURN_UNSUPPORTED The device does not support this operation.\r
\r
**/\r
RETURN_STATUS\r
\r
@param[out] Control Status of the control bits on a serial device :\r
\r
- . EFI_SERIAL_DATA_CLEAR_TO_SEND, EFI_SERIAL_DATA_SET_READY,\r
- EFI_SERIAL_RING_INDICATE, EFI_SERIAL_CARRIER_DETECT,\r
- EFI_SERIAL_REQUEST_TO_SEND, EFI_SERIAL_DATA_TERMINAL_READY\r
- are all related to the DTE (Data Terminal Equipment) and\r
- DCE (Data Communication Equipment) modes of operation of\r
- the serial device.\r
- . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the receive\r
- buffer is empty, 0 otherwise.\r
- . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the transmit\r
- buffer is empty, 0 otherwise.\r
- . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if the\r
- hardware loopback is enabled (the output feeds the receive\r
- buffer), 0 otherwise.\r
- . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if a\r
- loopback is accomplished by software, 0 otherwise.\r
- . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to one if the\r
- hardware flow control based on CTS (Clear To Send) and RTS\r
- (Ready To Send) control signals is enabled, 0 otherwise.\r
-\r
- @retval RETURN_SUCCESS The control bits were read from the serial device.\r
+ . EFI_SERIAL_DATA_CLEAR_TO_SEND,\r
+ EFI_SERIAL_DATA_SET_READY,\r
+ EFI_SERIAL_RING_INDICATE,\r
+ EFI_SERIAL_CARRIER_DETECT,\r
+ EFI_SERIAL_REQUEST_TO_SEND,\r
+ EFI_SERIAL_DATA_TERMINAL_READY\r
+ are all related to the DTE (Data Terminal Equipment)\r
+ and DCE (Data Communication Equipment) modes of\r
+ operation of the serial device.\r
+ . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the\r
+ receive buffer is empty, 0 otherwise.\r
+ . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the\r
+ transmit buffer is empty, 0 otherwise.\r
+ . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if\r
+ the hardware loopback is enabled (the output feeds\r
+ the receive buffer), 0 otherwise.\r
+ . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one\r
+ if a loopback is accomplished by software, else 0.\r
+ . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to\r
+ one if the hardware flow control based on CTS (Clear\r
+ To Send) and RTS (Ready To Send) control signals is\r
+ enabled, 0 otherwise.\r
+\r
+ @retval RETURN_SUCCESS The control bits were read from the device.\r
\r
**/\r
RETURN_STATUS\r
projects / mirror_edk2.git / blobdiff