From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=41765 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OJ4He-0006PH-PH for qemu-devel@nongnu.org; Mon, 31 May 2010 08:40:01 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OJ4Hb-0007JD-EN for qemu-devel@nongnu.org; Mon, 31 May 2010 08:39:58 -0400 Received: from mx1.redhat.com ([209.132.183.28]:58228) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OJ4Hb-0007J7-6j for qemu-devel@nongnu.org; Mon, 31 May 2010 08:39:55 -0400 Received: from int-mx08.intmail.prod.int.phx2.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id o4VCdsTM024791 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 31 May 2010 08:39:54 -0400 From: Amit Shah Date: Mon, 31 May 2010 18:11:28 +0530 Message-Id: In-Reply-To: References: In-Reply-To: References: Subject: [Qemu-devel] [PATCH 2/5] virtio-serial: Add description fields for qdev properties List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu list Cc: Amit Shah , Juan Quintela , Markus Armbruster , Gerd Hoffmann Document the parameters for the virtserialport and virtioconsole devices. Example: $ ./x86_64-softmmu/qemu-system-x86_64 -device virtserialport,? virtserialport.nr=uint32, The 'number' for the port for \ predictable port numbers. Use this to spawn ports if you \ plan to migrate the guest. virtserialport.chardev=chr, The chardev to associate this port with. virtserialport.name=string, Name for the port that's exposed to \ the guest for port discovery. Signed-off-by: Amit Shah --- hw/virtio-console.c | 17 ++++++++++------- hw/virtio-serial.h | 13 +++++++++++++ 2 files changed, 23 insertions(+), 7 deletions(-) diff --git a/hw/virtio-console.c b/hw/virtio-console.c index ccd277a..8a99a99 100644 --- a/hw/virtio-console.c +++ b/hw/virtio-console.c @@ -95,11 +95,13 @@ static VirtIOSerialPortInfo virtconsole_info = { .init = virtconsole_initfn, .exit = virtconsole_exitfn, .qdev.props = (Property[]) { - DEFINE_PROP_UINT8("is_console", VirtConsole, port.is_console, 1, ""), + DEFINE_PROP_UINT8("is_console", VirtConsole, port.is_console, 1, + PROP_VIRTSERIAL_IS_CONSOLE_DESC), DEFINE_PROP_UINT32("nr", VirtConsole, port.id, VIRTIO_CONSOLE_BAD_ID, - ""), - DEFINE_PROP_CHR("chardev", VirtConsole, chr, ""), - DEFINE_PROP_STRING("name", VirtConsole, port.name, ""), + PROP_VIRTSERIAL_NR_DESC), + DEFINE_PROP_CHR("chardev", VirtConsole, chr, PROP_VIRTSERIAL_CHR_DESC), + DEFINE_PROP_STRING("name", VirtConsole, port.name, + PROP_VIRTSERIAL_NAME_DESC), DEFINE_PROP_END_OF_LIST(), }, }; @@ -133,9 +135,10 @@ static VirtIOSerialPortInfo virtserialport_info = { .exit = virtconsole_exitfn, .qdev.props = (Property[]) { DEFINE_PROP_UINT32("nr", VirtConsole, port.id, VIRTIO_CONSOLE_BAD_ID, - ""), - DEFINE_PROP_CHR("chardev", VirtConsole, chr, ""), - DEFINE_PROP_STRING("name", VirtConsole, port.name, ""), + PROP_VIRTSERIAL_NR_DESC), + DEFINE_PROP_CHR("chardev", VirtConsole, chr, PROP_VIRTSERIAL_CHR_DESC), + DEFINE_PROP_STRING("name", VirtConsole, port.name, + PROP_VIRTSERIAL_NAME_DESC), DEFINE_PROP_END_OF_LIST(), }, }; diff --git a/hw/virtio-serial.h b/hw/virtio-serial.h index a93b545..91f3da3 100644 --- a/hw/virtio-serial.h +++ b/hw/virtio-serial.h @@ -58,6 +58,19 @@ struct virtio_console_control { /* == In-qemu interface == */ +#define PROP_VIRTSERIAL_IS_CONSOLE_DESC \ + "An hvc console will be spawned in the guest if this is set." + +#define PROP_VIRTSERIAL_NR_DESC \ + "The 'number' for the port for predictable port numbers. Use this to " \ + "spawn ports if you plan to migrate the guest." + +#define PROP_VIRTSERIAL_CHR_DESC \ + "The chardev to associate this port with." + +#define PROP_VIRTSERIAL_NAME_DESC \ + "Name for the port that's exposed to the guest for port discovery." + typedef struct VirtIOSerial VirtIOSerial; typedef struct VirtIOSerialBus VirtIOSerialBus; typedef struct VirtIOSerialPort VirtIOSerialPort; -- 1.7.0.1