From patchwork Fri Mar 27 18:56:17 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 46439 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-la0-f69.google.com (mail-la0-f69.google.com [209.85.215.69]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id 8850B21597 for ; Fri, 27 Mar 2015 18:56:44 +0000 (UTC) Received: by labss8 with SMTP id ss8sf14296326lab.2 for ; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:in-reply-to :references:subject:precedence:reply-to:list-id:list-unsubscribe :list-archive:list-post:list-help:list-subscribe:mime-version :content-type:content-transfer-encoding:errors-to:x-original-sender :x-original-authentication-results:mailing-list; bh=sjIgD3klwBalQLUn5fdBvx2Fjdo1N6Mct3QKgLfgmfs=; b=i+ZKX3KkeHPiX+Jqc2JFanDNphfAM+/q0sW1kuXcm7AYEMPXBZyA5ay+/gpOrwxc6H ijFhGesG4QJR1PqUC5bdYP7QL2D2kBy1Vw8kSqXadIMp2X2eWh0j7B6F/L8MBWoOHUh6 jKzIDlg3Ww/80ht/WUQh9YZERFTG+ARvlYAfSxMuLcylNfiF4DNu/mRwmouuntzEU8eo 9GN3o/As+kLINHZJOVe3e9RLCuXk768OH9db6ShKp7x7TY2JgsJ2lYn1ZLDRk658w+xp SzZsIRS4gHp8iWjTSLTUqxCyv8lFfjrwf4uRtD7jf8pn40Fb6gfypv7Ipyq99mwqjlOC ZX7A== X-Gm-Message-State: ALoCoQlyYi43CmXjLWrXCcNX8+n18OUh9/Q35q2k8+O67FAg86euXQnLrbhQG+iUd+Ict9OQNWqs X-Received: by 10.112.235.70 with SMTP id uk6mr2301717lbc.24.1427482603387; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.152.1.135 with SMTP id 7ls422429lam.8.gmail; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) X-Received: by 10.112.16.195 with SMTP id i3mr501673lbd.95.1427482603199; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) Received: from mail-la0-f44.google.com (mail-la0-f44.google.com. [209.85.215.44]) by mx.google.com with ESMTPS id gj8si1928019lbc.131.2015.03.27.11.56.43 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 27 Mar 2015 11:56:43 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) client-ip=209.85.215.44; Received: by lahp7 with SMTP id p7so58596044lah.2 for ; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) X-Received: by 10.112.160.227 with SMTP id xn3mr5095513lbb.112.1427482603034; Fri, 27 Mar 2015 11:56:43 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.57.201 with SMTP id k9csp57952lbq; Fri, 27 Mar 2015 11:56:42 -0700 (PDT) X-Received: by 10.50.254.4 with SMTP id ae4mr484489igd.10.1427482601358; Fri, 27 Mar 2015 11:56:41 -0700 (PDT) Received: from lists.sourceforge.net (lists.sourceforge.net. [216.34.181.88]) by mx.google.com with ESMTPS id qo11si2857297igb.36.2015.03.27.11.56.40 (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 27 Mar 2015 11:56:41 -0700 (PDT) Received-SPF: pass (google.com: domain of edk2-devel-bounces@lists.sourceforge.net designates 216.34.181.88 as permitted sender) client-ip=216.34.181.88; Received: from localhost ([127.0.0.1] helo=sfs-ml-1.v29.ch3.sourceforge.com) by sfs-ml-1.v29.ch3.sourceforge.com with esmtp (Exim 4.76) (envelope-from ) id 1YbZQj-0006GT-Fq; Fri, 27 Mar 2015 18:56:29 +0000 Received: from sog-mx-4.v43.ch3.sourceforge.com ([172.29.43.194] helo=mx.sourceforge.net) by sfs-ml-1.v29.ch3.sourceforge.com with esmtp (Exim 4.76) (envelope-from ) id 1YbZQi-0006GN-9s for edk2-devel@lists.sourceforge.net; Fri, 27 Mar 2015 18:56:28 +0000 Received-SPF: pass (sog-mx-4.v43.ch3.sourceforge.com: domain of linaro.org designates 74.125.82.45 as permitted sender) client-ip=74.125.82.45; envelope-from=ard.biesheuvel@linaro.org; helo=mail-wg0-f45.google.com; Received: from mail-wg0-f45.google.com ([74.125.82.45]) by sog-mx-4.v43.ch3.sourceforge.com with esmtps (TLSv1:RC4-SHA:128) (Exim 4.76) id 1YbZQg-0000Mz-Va for edk2-devel@lists.sourceforge.net; Fri, 27 Mar 2015 18:56:28 +0000 Received: by wgbgs4 with SMTP id gs4so17937587wgb.0 for ; Fri, 27 Mar 2015 11:56:21 -0700 (PDT) X-Received: by 10.180.20.177 with SMTP id o17mr432114wie.66.1427482580840; Fri, 27 Mar 2015 11:56:20 -0700 (PDT) Received: from ards-macbook-pro.local ([90.174.5.29]) by mx.google.com with ESMTPSA id fs8sm4632480wib.8.2015.03.27.11.56.18 (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Fri, 27 Mar 2015 11:56:20 -0700 (PDT) From: Ard Biesheuvel To: edk2-devel@lists.sourceforge.net, leif.lindholm@linaro.org, roy.franz@linaro.org, ian.campbell@citrix.com, stefano.stabellini@eu.citrix.com, lersek@redhat.com, julien.grall@linaro.org Date: Fri, 27 Mar 2015 19:56:17 +0100 Message-Id: <1427482577-1467-1-git-send-email-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 1.8.3.2 In-Reply-To: <1427402714-15564-1-git-send-email-ard.biesheuvel@linaro.org> References: <1427402714-15564-1-git-send-email-ard.biesheuvel@linaro.org> X-Spam-Score: -1.5 (-) X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -1.5 SPF_CHECK_PASS SPF reports sender host as permitted sender for sender-domain -0.0 SPF_PASS SPF: sender matches SPF record -0.0 AWL AWL: Adjusted score from AWL reputation of From: address X-Headers-End: 1YbZQg-0000Mz-Va Subject: [edk2] [PATCH v2] XenConsoleSerialPortLib: deal with output overflow X-BeenThere: edk2-devel@lists.sourceforge.net X-Mailman-Version: 2.1.9 Precedence: list Reply-To: edk2-devel@lists.sourceforge.net List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: edk2-devel-bounces@lists.sourceforge.net X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: ard.biesheuvel@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.215.44 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 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 --- OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c | 85 +++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 61 insertions(+), 24 deletions(-) diff --git a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c index 467cb27a30c4..822e50e7fb2e 100644 --- a/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c +++ b/OvmfPkg/Library/XenConsoleSerialPortLib/XenConsoleSerialPortLib.c @@ -17,6 +17,7 @@ #include #include +#include #include #include @@ -34,6 +35,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 +53,7 @@ SerialPortInitialize ( ) { if (! XenHypercallIsAvailable ()) { - return RETURN_NOT_FOUND; + return RETURN_DEVICE_ERROR; } if (!mXenConsoleInterface) { @@ -57,13 +69,20 @@ SerialPortInitialize ( } /** - Write data to serial device. + Write data from buffer to serial device. + + 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. - @param Buffer Point of data buffer which need to be written. - @param NumberOfBytes Number of output bytes which are cached in Buffer. + @param Buffer Pointer to the data buffer to be written. + @param NumberOfBytes Number of bytes to written to the serial device. - @retval 0 Write data failed. - @retval !0 Actual number of bytes written to 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 @@ -76,38 +95,50 @@ SerialPortWrite ( 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 @@ -120,6 +151,12 @@ SerialPortRead ( XENCONS_RING_IDX Consumer, Producer; UINTN Received; + ASSERT (Buffer != NULL); + + if (NumberOfBytes == 0) { + return 0; + } + if (!mXenConsoleInterface) { return 0; } @@ -143,10 +180,10 @@ SerialPortRead ( } /** - 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