Patchwork [RFC,2/3] virtio-serial: Add description fields for qdev properties

login
register
mail settings
Submitter Amit Shah
Date May 28, 2010, 9:57 a.m.
Message ID <9015b06db9d4493ede78ed2fc52859e0e4e5728f.1275040675.git.amit.shah@redhat.com>
Download mbox | patch
Permalink /patch/53876/
State New
Headers show

Comments

Amit Shah - May 28, 2010, 9:57 a.m.
Signed-off-by: Amit Shah <amit.shah@redhat.com>
---
 hw/virtio-console.c |   17 ++++++++++-------
 hw/virtio-serial.h  |   12 ++++++++++++
 2 files changed, 22 insertions(+), 7 deletions(-)
Markus Armbruster - May 28, 2010, 12:50 p.m.
Amit Shah <amit.shah@redhat.com> writes:

> Signed-off-by: Amit Shah <amit.shah@redhat.com>
> ---
>  hw/virtio-console.c |   17 ++++++++++-------
>  hw/virtio-serial.h  |   12 ++++++++++++
>  2 files changed, 22 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..2a13432 100644
> --- a/hw/virtio-serial.h
> +++ b/hw/virtio-serial.h
> @@ -58,6 +58,18 @@ struct virtio_console_control {
>  
>  /* == In-qemu interface == */
>  
> +#define PROP_VIRTSERIAL_IS_CONSOLE_DESC                                 \
> +    "An hvc console will be spawned in the guest since this is a console port"
> +
> +#define PROP_VIRTSERIAL_NR_DESC                                         \
> +    "The 'number' for the port for predictable port numbers for better migration support"
> +
> +#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;

Why put the description macros in the header, away from their only uses?
Amit Shah - May 28, 2010, 12:58 p.m.
On (Fri) May 28 2010 [14:50:17], Markus Armbruster wrote:
> Amit Shah <amit.shah@redhat.com> writes:
> 
> > Signed-off-by: Amit Shah <amit.shah@redhat.com>
> > ---
> >  hw/virtio-console.c |   17 ++++++++++-------
> >  hw/virtio-serial.h  |   12 ++++++++++++
> >  2 files changed, 22 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..2a13432 100644
> > --- a/hw/virtio-serial.h
> > +++ b/hw/virtio-serial.h
> > @@ -58,6 +58,18 @@ struct virtio_console_control {
> >  
> >  /* == In-qemu interface == */
> >  
> > +#define PROP_VIRTSERIAL_IS_CONSOLE_DESC                                 \
> > +    "An hvc console will be spawned in the guest since this is a console port"
> > +
> > +#define PROP_VIRTSERIAL_NR_DESC                                         \
> > +    "The 'number' for the port for predictable port numbers for better migration support"
> > +
> > +#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;
> 
> Why put the description macros in the header, away from their only uses?

That's because the virtserial infrastructure will be used in places
other than just the virtio-console.c file (spice, clipboard, etc.).

		Amit

Patch

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..2a13432 100644
--- a/hw/virtio-serial.h
+++ b/hw/virtio-serial.h
@@ -58,6 +58,18 @@  struct virtio_console_control {
 
 /* == In-qemu interface == */
 
+#define PROP_VIRTSERIAL_IS_CONSOLE_DESC                                 \
+    "An hvc console will be spawned in the guest since this is a console port"
+
+#define PROP_VIRTSERIAL_NR_DESC                                         \
+    "The 'number' for the port for predictable port numbers for better migration support"
+
+#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;