Revision: 17079
http://sourceforge.net/p/edk2/code/17079
Author: lersek
Date: 2015-03-27 21:25:16 +0000 (Fri, 27 Mar 2015)
Log Message:
-----------
OvmfPkg: XenConsoleSerialPortLib: deal with output overflow
It is the responsibility of the SerialPortLib implementation
to deal with flow control if the underlying medium cannot keep
up with the inflow of data.
So in our SerialPortWrite () function, we should spin as long
as we need to in order to deliver all the data instead of giving
up and returning a smaller value than the number of bytes we were
given. Also, remove the 'if (Sent > 0)' condition on the signalling
of the event channel: if the buffer is full and we haven't been able
to add any more data, it makes perfect sense to signal the event
channel again, even if we have done so before when we did write
the data.
Also, this patch brings the implementation of XenSerialPortLib
in sync with the library class documentation.
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ard Biesheuvel <[email protected]>
Reviewed-by: Laszlo Ersek <[email protected]>
[[email protected]: replace DebugLib dependency with open-coded ASSERT()]
Modified Paths:
--------------
trunk/edk2/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c
Modified:
trunk/edk2/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c
===================================================================
---
trunk/edk2/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c
2015-03-27 17:27:24 UTC (rev 17078)
+++
trunk/edk2/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c
2015-03-27 21:25:16 UTC (rev 17079)
@@ -25,6 +25,17 @@
#include <IndustryStandard/Xen/event_channel.h>
//
+// We can't use DebugLib due to a constructor dependency cycle between DebugLib
+// and ourselves.
+//
+#define ASSERT(Expression) \
+ do { \
+ if (!(Expression)) { \
+ CpuDeadLoop (); \
+ } \
+ } while (FALSE)
+
+//
// The code below expects these global variables to be mutable, even in the
case
// that we have been incorporated into SEC or PEIM phase modules (which is
// allowed by our INF description). While this is a dangerous assumption to
make
@@ -34,6 +45,17 @@
STATIC evtchn_send_t mXenConsoleEventChain;
STATIC struct xencons_interface *mXenConsoleInterface;
+/**
+ Initialize the serial device hardware.
+
+ If no initialization is required, then return RETURN_SUCCESS.
+ If the serial device was successfully initialized, then return
RETURN_SUCCESS.
+ If the serial device could not be initialized, then return
RETURN_DEVICE_ERROR.
+
+ @retval RETURN_SUCCESS The serial device was initialized.
+ @retval RETURN_DEVICE_ERROR The serial device could not be initialized.
+
+**/
RETURN_STATUS
EFIAPI
SerialPortInitialize (
@@ -41,7 +63,7 @@
)
{
if (! XenHypercallIsAvailable ()) {
- return RETURN_NOT_FOUND;
+ return RETURN_DEVICE_ERROR;
}
if (!mXenConsoleInterface) {
@@ -57,14 +79,21 @@
}
/**
- Write data to serial device.
+ Write data from buffer to serial device.
- @param Buffer Point of data buffer which need to be written.
- @param NumberOfBytes Number of output bytes which are cached in Buffer.
+ Writes NumberOfBytes data bytes from Buffer to the serial device.
+ The number of bytes actually written to the serial device is returned.
+ If the return value is less than NumberOfBytes, then the write operation
failed.
+ If Buffer is NULL, then ASSERT().
+ If NumberOfBytes is zero, then return 0.
- @retval 0 Write data failed.
- @retval !0 Actual number of bytes written to serial device.
+ @param Buffer Pointer to the data buffer to be written.
+ @param NumberOfBytes Number of bytes to written to the serial device.
+ @retval 0 NumberOfBytes is 0.
+ @retval >0 The number of bytes written to the serial device.
+ If this value is less than NumberOfBytes, then the
write operation failed.
+
**/
UINTN
EFIAPI
@@ -76,39 +105,51 @@
XENCONS_RING_IDX Consumer, Producer;
UINTN Sent;
+ ASSERT (Buffer != NULL);
+
+ if (NumberOfBytes == 0) {
+ return 0;
+ }
+
if (!mXenConsoleInterface) {
return 0;
}
- Consumer = mXenConsoleInterface->out_cons;
- Producer = mXenConsoleInterface->out_prod;
+ Sent = 0;
+ do {
+ Consumer = mXenConsoleInterface->out_cons;
+ Producer = mXenConsoleInterface->out_prod;
- MemoryFence ();
+ MemoryFence ();
- Sent = 0;
- while (Sent < NumberOfBytes && ((Producer - Consumer) < sizeof
(mXenConsoleInterface->out)))
- mXenConsoleInterface->out[MASK_XENCONS_IDX(Producer++,
mXenConsoleInterface->out)] = Buffer[Sent++];
+ while (Sent < NumberOfBytes && ((Producer - Consumer) < sizeof
(mXenConsoleInterface->out)))
+ mXenConsoleInterface->out[MASK_XENCONS_IDX(Producer++,
mXenConsoleInterface->out)] = Buffer[Sent++];
- MemoryFence ();
+ MemoryFence ();
- mXenConsoleInterface->out_prod = Producer;
+ mXenConsoleInterface->out_prod = Producer;
- if (Sent > 0) {
XenHypercallEventChannelOp (EVTCHNOP_send, &mXenConsoleEventChain);
- }
+ } while (Sent < NumberOfBytes);
+
return Sent;
}
/**
- Read data from serial device and save the data in buffer.
+ Read data from serial device and save the datas in buffer.
- @param Buffer Point of data buffer which need to be written.
- @param NumberOfBytes Size of Buffer[].
+ Reads NumberOfBytes data bytes from a serial device into the buffer
+ specified by Buffer. The number of bytes actually read is returned.
+ If Buffer is NULL, then ASSERT().
+ If NumberOfBytes is zero, then return 0.
- @retval 0 Read data failed.
- @retval !0 Actual number of bytes read from serial device.
+ @param Buffer Pointer to the data buffer to store the data read
from the serial device.
+ @param NumberOfBytes Number of bytes which will be read.
+ @retval 0 Read data failed, no data is to be read.
+ @retval >0 Actual number of bytes read from serial device.
+
**/
UINTN
EFIAPI
@@ -120,6 +161,12 @@
XENCONS_RING_IDX Consumer, Producer;
UINTN Received;
+ ASSERT (Buffer != NULL);
+
+ if (NumberOfBytes == 0) {
+ return 0;
+ }
+
if (!mXenConsoleInterface) {
return 0;
}
@@ -143,10 +190,10 @@
}
/**
- Check to see if any data is available to be read from the debug device.
+ Polls a serial device to see if there is any data waiting to be read.
- @retval TRUE At least one byte of data is available to be read
- @retval FALSE No data is available to be read
+ @retval TRUE Data is waiting to be read from the serial device.
+ @retval FALSE There is no data waiting to be read from the serial
device.
**/
BOOLEAN
------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the
conversation now. http://goparallel.sourceforge.net/
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits
