From patchwork Mon Jul 17 13:58:22 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Cooper X-Patchwork-Id: 9845195 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 3D7EB60392 for ; Mon, 17 Jul 2017 14:00:45 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2F7B228509 for ; Mon, 17 Jul 2017 14:00:45 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2480E2851A; Mon, 17 Jul 2017 14:00:45 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 89F4328459 for ; Mon, 17 Jul 2017 14:00:44 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dX6Xg-0002mC-8r; Mon, 17 Jul 2017 13:58:32 +0000 Received: from mail6.bemta5.messagelabs.com ([195.245.231.135]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dX6Xe-0002m3-QO for xen-devel@lists.xen.org; Mon, 17 Jul 2017 13:58:30 +0000 Received: from [85.158.139.211] by server-3.bemta-5.messagelabs.com id 35/8F-02022-582CC695; Mon, 17 Jul 2017 13:58:29 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFmpgkeJIrShJLcpLzFFi42JxWrrBXrf1UE6 kwelJ8hZLPi5mcWD0OLr7N1MAYxRrZl5SfkUCa8bFuS9YCtbJVtzb2MfUwPhRvIuRk0NCwF/i w4qFjCA2m4C+xO4Xn5hAbBEBdYnTHRdZuxi5OJgF9jFJvP13gQUkISwQLTHtagsriM0ioCrRc PUEO4jNK+Ap8eHHaSaIoXIS54//ZAaxhQTUJK71X4KqEZQ4OfMJ2BxmAQmJgy9eME9g5J6FJD ULSWoBI9MqRo3i1KKy1CJdIxO9pKLM9IyS3MTMHF1DA1O93NTi4sT01JzEpGK95PzcTYzAcKh nYGDcwXhzst8hRkkOJiVR3ots2ZFCfEn5KZUZicUZ8UWlOanFhxhlODiUJHh/HciJFBIsSk1P rUjLzAEGJkxagoNHSYTX+CBQmre4IDG3ODMdInWK0Zhjw+r1X5g4Xk34/41JiCUvPy9VSpz3L 8gkAZDSjNI8uEGwiLnEKCslzMvIwMAgxFOQWpSbWYIq/4pRnINRSZhXF2QhT2ZeCdy+V0CnMA GdIuwLdkpJIkJKqoExcrv8ewPreQX1ZTZWVYas14SbJab8b7Xh4tj5dddLu7siWw6ULdgpsjW bU080zsZz5ztr93lv7TI+WAm6iPY9VT61sSLA+4jFrkdHM9J9fdQcNqpwnqux4/pZXnto4qmV fovX7jv1ddY+Ti6Xmc/DVVyXZvNLxJ+4cLqzaqKc84+rN+6+OWynxFKckWioxVxUnAgAqGBUP 5MCAAA= X-Env-Sender: prvs=364a4c011=Andrew.Cooper3@citrix.com X-Msg-Ref: server-5.tower-206.messagelabs.com!1500299907!101616354!1 X-Originating-IP: [66.165.176.63] X-SpamReason: No, hits=0.0 required=7.0 tests=sa_preprocessor: VHJ1c3RlZCBJUDogNjYuMTY1LjE3Ni42MyA9PiAzMDYwNDg=\n, received_headers: No Received headers X-StarScan-Received: X-StarScan-Version: 9.4.25; banners=-,-,- X-VirusChecked: Checked Received: (qmail 50435 invoked from network); 17 Jul 2017 13:58:29 -0000 Received: from smtp02.citrix.com (HELO SMTP02.CITRIX.COM) (66.165.176.63) by server-5.tower-206.messagelabs.com with RC4-SHA encrypted SMTP; 17 Jul 2017 13:58:29 -0000 X-IronPort-AV: E=Sophos;i="5.40,374,1496102400"; d="scan'208";a="440149395" From: Andrew Cooper To: Xen-devel Date: Mon, 17 Jul 2017 14:58:22 +0100 Message-ID: <1500299902-15180-1-git-send-email-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.1.4 MIME-Version: 1.0 Cc: Stefano Stabellini , Wei Liu , George Dunlap , Andrew Cooper , Ian Jackson , Tim Deegan , Jan Beulich Subject: [Xen-devel] [PATCH] docs: Fix the markdown for the com{1, 2} keyword command line documentation X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" X-Virus-Scanned: ClamAV using ClamSMTP No change in content. Signed-off-by: Andrew Cooper Acked-by: Wei Liu --- CC: George Dunlap CC: Ian Jackson CC: Jan Beulich CC: Konrad Rzeszutek Wilk CC: Stefano Stabellini CC: Tim Deegan CC: Wei Liu --- docs/misc/xen-command-line.markdown | 48 +++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown index 6eb5cfc..3f90c3b 100644 --- a/docs/misc/xen-command-line.markdown +++ b/docs/misc/xen-command-line.markdown @@ -336,31 +336,33 @@ will be considered a positional parameter. The syntax consists of com1=(comma-separated positional parameters),(comma separated name-value pairs) -The accepted name keywords for name=value pairs are - * `baud` - accepts integer baud rate (eg. 115200) or `auto` - * `bridge`- Similar to bridge-bdf in positional parameters. - Used to determine the PCI bridge to access the UART device. - Notation is xx:xx.xx :. - * `clock-hz`- accepts large integers to setup UART clock frequencies. - Do note - these values are multiplied by 16. - * `data-bits` - integer between 5 and 8 - * `dev` - accepted values are `pci` OR `amt`. If this option - is used to specify if the serial device is pci-based. The io_base - cannot be specified when `dev=pci` or `dev=amt` is used. - * `io-base` - accepts integer which specified IO base port for UART registers - * `irq` - IRQ number to use - * `parity` - accepted values are same as positional parameters - * `port` - Used to specify which port the PCI serial device is located on - Notation is xx:xx.xx :. - * `reg-shift` - register shifts required to set UART registers - * `reg-width` - register width required to set UART registers - (only accepts 1 and 4) - * `stop-bits` - only accepts 1 or 2 for the number of stop bits +The accepted name keywords for name=value pairs are: + +* `baud` - accepts integer baud rate (eg. 115200) or `auto` +* `bridge`- Similar to bridge-bdf in positional parameters. + Used to determine the PCI bridge to access the UART device. + Notation is xx:xx.x `:.` +* `clock-hz`- accepts large integers to setup UART clock frequencies. + Do note - these values are multiplied by 16. +* `data-bits` - integer between 5 and 8 +* `dev` - accepted values are `pci` OR `amt`. If this option + is used to specify if the serial device is pci-based. The io_base + cannot be specified when `dev=pci` or `dev=amt` is used. +* `io-base` - accepts integer which specified IO base port for UART registers +* `irq` - IRQ number to use +* `parity` - accepted values are same as positional parameters +* `port` - Used to specify which port the PCI serial device is located on + Notation is xx:xx.x `:.` +* `reg-shift` - register shifts required to set UART registers +* `reg-width` - register width required to set UART registers + (only accepts 1 and 4) +* `stop-bits` - only accepts 1 or 2 for the number of stop bits The following are examples of correct specifications: -`com1=115200,8n1,0x3f8,4` -`com1=115200,8n1,0x3f8,4,reg_width=4,reg_shift=2` -`com1=baud=115200,parity=n,stop_bits=1,io_base=0x3f8,reg_width=4` + + com1=115200,8n1,0x3f8,4 + com1=115200,8n1,0x3f8,4,reg_width=4,reg_shift=2 + com1=baud=115200,parity=n,stop_bits=1,io_base=0x3f8,reg_width=4 ### conring\_size > `= `