Re: [Qemu-devel] [PATCH] e1000: allow command-line selection of card model

["Andreas Färber" <afaerber@suse.de>]

Hi,

Am 20.05.2014 17:05, schrieb Gabriel L. Somlo:
> Allow selection of different card models from the qemu
> command line, to better accomodate a wider range of guests.
> 
> Based-on-patch-by: Romain Dolbeau <romain@dolbeau.org>

If that patch carried a Signed-off-by line, you should retain it. Your
From: line already indicates that it has been rewritten since.

> Signed-off-by: Gabriel Somlo <somlo@cmu.edu>
> ---
> 
> Based on the conversation in [2,3,4], and given that I would still like
> OS X to work as close to "out of the box" as possible, I took a stab
> at isolating just the bits that allow command-line selection of the
> specific e1000 device model from Romain's patch set [1]. Hope that's
> OK with everyone :)
> 
> Beyond a few small style improvements, I'm still not 100% familiar with
> QOM, so I wonder if there isn't a cleaner way to offer "e1000" as some
> sort of "alias" to the default 82540EM, instead of listing two different
> devices (e1000 and 82540EM) with otherwise 100% identical properties.
> However, if the patch is acceptable as-is, I'm happy to leave it be... :)
> 
> I tested this on Windows 7 (where the default e1000 continues to work
> as before), Linux (F20, which is fine with either model), and OS X
> (10.9 requires E1000_DEV_ID_82545EM_COPPER, which also works with prior
> versions starting at 10.6; and the default e1000 works on versions <= 10.8).
> 
> Comments, suggestions, (or even a straight-forward upstream acceptance
> of the patch) much appreciated ! :)
> 
> Thanks,
>    Gabriel
> 
> [1] http://lists.nongnu.org/archive/html/qemu-devel/2014-03/msg01397.html
> [2] http://lists.nongnu.org/archive/html/qemu-devel/2014-03/msg01831.html
> [3] http://lists.nongnu.org/archive/html/qemu-devel/2014-03/msg01841.html
> [4] http://lists.nongnu.org/archive/html/qemu-devel/2014-03/msg03669.html
> 
>  hw/net/e1000.c | 97 ++++++++++++++++++++++++++++++++++++++++++++++++----------
>  1 file changed, 80 insertions(+), 17 deletions(-)
> 
> diff --git a/hw/net/e1000.c b/hw/net/e1000.c
> index 8387443..92323a3 100644
> --- a/hw/net/e1000.c
> +++ b/hw/net/e1000.c
> @@ -69,23 +69,29 @@ static int debugflags = DBGBIT(TXERR) | DBGBIT(GENERAL);
>  
>  /*
>   * HW models:
> - *  E1000_DEV_ID_82540EM works with Windows and Linux
> + *  E1000_DEV_ID_82540EM works with Windows, Linux, and OS X <= 10.8
>   *  E1000_DEV_ID_82573L OK with windoze and Linux 2.6.22,
>   *	appears to perform better than 82540EM, but breaks with Linux 2.6.18
>   *  E1000_DEV_ID_82544GC_COPPER appears to work; not well tested
> + *  E1000_DEV_ID_82545EM_COPPER works with Linux and OS X >= 10.6
>   *  Others never tested
>   */
> -enum { E1000_DEVID = E1000_DEV_ID_82540EM };
>  
>  /*
>   * May need to specify additional MAC-to-PHY entries --
>   * Intel's Windows driver refuses to initialize unless they match
>   */
> -enum {
> -    PHY_ID2_INIT = E1000_DEVID == E1000_DEV_ID_82573L ?		0xcc2 :
> -                   E1000_DEVID == E1000_DEV_ID_82544GC_COPPER ?	0xc30 :
> -                   /* default to E1000_DEV_ID_82540EM */	0xc20
> -};
> +static uint16_t

   static inline uint16_t maybe?

> +e1000_phy_id2_init(uint16_t dev_id) {
> +    switch(dev_id) {

       switch (dev_id) {

> +        case E1000_DEV_ID_82573L:
> +            return 0xcc2;
> +        case E1000_DEV_ID_82544GC_COPPER:
> +            return 0xc30;
> +        default:
> +            return 0xc20; /* default for 82540EM and others */
> +    }
> +}
>  
>  typedef struct E1000State_st {
>      /*< private >*/
> @@ -151,7 +157,7 @@ typedef struct E1000State_st {
>      uint32_t compat_flags;
>  } E1000State;
>  
> -#define TYPE_E1000 "e1000"
> +#define TYPE_E1000 "e1000-base"
>  
>  #define E1000(obj) \
>      OBJECT_CHECK(E1000State, (obj), TYPE_E1000)
> @@ -235,7 +241,7 @@ static const char phy_regcap[0x20] = {
>  static const uint16_t phy_reg_init[] = {
>      [PHY_CTRL] = 0x1140,
>      [PHY_STATUS] = 0x794d, /* link initially up with not completed autoneg */
> -    [PHY_ID1] = 0x141,				[PHY_ID2] = PHY_ID2_INIT,
> +    [PHY_ID1] = 0x141, /* [PHY_ID2] configured per DevId, from e1000_reset() */
>      [PHY_1000T_CTRL] = 0x0e00,			[M88E1000_PHY_SPEC_CTRL] = 0x360,
>      [M88E1000_EXT_PHY_SPEC_CTRL] = 0x0d60,	[PHY_AUTONEG_ADV] = 0xde1,
>      [PHY_LP_ABILITY] = 0x1e0,			[PHY_1000T_STATUS] = 0x3c00,
> @@ -271,8 +277,9 @@ set_interrupt_cause(E1000State *s, int index, uint32_t val)
>      PCIDevice *d = PCI_DEVICE(s);

       PCIDeviceClass *pdc = PCI_DEVICE_GET_CLASS(s); // note: not d

>      uint32_t pending_ints;
>      uint32_t mit_delay;
> +    uint16_t dev_id = PCI_DEVICE_GET_CLASS(d)->device_id;

       uint16_t dev_id = pdc->device_id;

By convention, don't use these macros inline in FOO(bar)->baz style
expressions, use a variable. Applies elsewhere as well.

>  
> -    if (val && (E1000_DEVID >= E1000_DEV_ID_82547EI_MOBILE)) {
> +    if (val && (dev_id >= E1000_DEV_ID_82547EI_MOBILE)) {
>          /* Only for 8257x */
>          val |= E1000_ICR_INT_ASSERTED;
>      }
> @@ -377,6 +384,7 @@ static void e1000_reset(void *opaque)
>      E1000State *d = opaque;
>      uint8_t *macaddr = d->conf.macaddr.a;
>      int i;
> +    uint16_t dev_id = PCI_DEVICE_GET_CLASS(d)->device_id;
>  
>      timer_del(d->autoneg_timer);
>      timer_del(d->mit_timer);
> @@ -385,6 +393,7 @@ static void e1000_reset(void *opaque)
>      d->mit_ide = 0;
>      memset(d->phy_reg, 0, sizeof d->phy_reg);
>      memmove(d->phy_reg, phy_reg_init, sizeof phy_reg_init);
> +    d->phy_reg[PHY_ID2] = e1000_phy_id2_init(dev_id);
>      memset(d->mac_reg, 0, sizeof d->mac_reg);
>      memmove(d->mac_reg, mac_reg_init, sizeof mac_reg_init);
>      d->rxbuf_min_shift = 1;
> @@ -1440,9 +1449,13 @@ static const VMStateDescription vmstate_e1000 = {
>      }
>  };
>  
> +/*
> + * EEPROM contents documented in Tables 5-2 and 5-3, pp. 98-102.
> + * Note: A valid DevId will be inserted during pci_e1000_init().
> + */
>  static const uint16_t e1000_eeprom_template[64] = {
>      0x0000, 0x0000, 0x0000, 0x0000,      0xffff, 0x0000,      0x0000, 0x0000,
> -    0x3000, 0x1000, 0x6403, E1000_DEVID, 0x8086, E1000_DEVID, 0x8086, 0x3040,
> +    0x3000, 0x1000, 0x6403, 0 /*DevId*/, 0x8086, 0 /*DevId*/, 0x8086, 0x3040,
>      0x0008, 0x2000, 0x7e14, 0x0048,      0x1000, 0x00d8,      0x0000, 0x2700,
>      0x6cc9, 0x3150, 0x0722, 0x040b,      0x0984, 0x0000,      0xc000, 0x0706,
>      0x1008, 0x0000, 0x0f04, 0x7fff,      0x4d01, 0xffff,      0xffff, 0xffff,
> @@ -1511,6 +1524,7 @@ static int pci_e1000_init(PCIDevice *pci_dev)
>      uint16_t checksum = 0;
>      int i;
>      uint8_t *macaddr;
> +    uint16_t dev_id = PCI_DEVICE_GET_CLASS(pci_dev)->device_id;
>  
>      pci_conf = pci_dev->config;
>  
> @@ -1531,6 +1545,7 @@ static int pci_e1000_init(PCIDevice *pci_dev)
>      macaddr = d->conf.macaddr.a;
>      for (i = 0; i < 3; i++)
>          d->eeprom_data[i] = (macaddr[2*i+1]<<8) | macaddr[2*i];
> +    d->eeprom_data[11] = d->eeprom_data[13] = dev_id;
>      for (i = 0; i < EEPROM_CHECKSUM_REG; i++)
>          checksum += d->eeprom_data[i];
>      checksum = (uint16_t) EEPROM_SUM - checksum;
> @@ -1564,17 +1579,25 @@ static Property e1000_properties[] = {
>      DEFINE_PROP_END_OF_LIST(),
>  };
>  
> +typedef struct E1000Info_st {
> +    const char *name;
> +    uint16_t   vendor_id;
> +    uint16_t   device_id;
> +    uint8_t    revision;
> +} E1000Info;
> +
>  static void e1000_class_init(ObjectClass *klass, void *data)
>  {
>      DeviceClass *dc = DEVICE_CLASS(klass);
>      PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
> +    const E1000Info *info = data;
>  
>      k->init = pci_e1000_init;
>      k->exit = pci_e1000_uninit;
>      k->romfile = "efi-e1000.rom";
> -    k->vendor_id = PCI_VENDOR_ID_INTEL;
> -    k->device_id = E1000_DEVID;
> -    k->revision = 0x03;
> +    k->vendor_id = info->vendor_id;
> +    k->device_id = info->device_id;
> +    k->revision = info->revision;
>      k->class_id = PCI_CLASS_NETWORK_ETHERNET;
>      set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
>      dc->desc = "Intel Gigabit Ethernet";
> @@ -1583,16 +1606,56 @@ static void e1000_class_init(ObjectClass *klass, void *data)
>      dc->props = e1000_properties;
>  }
>  
> -static const TypeInfo e1000_info = {
> +static const TypeInfo e1000_base_info = {
>      .name          = TYPE_E1000,
>      .parent        = TYPE_PCI_DEVICE,
>      .instance_size = sizeof(E1000State),
> -    .class_init    = e1000_class_init,
> +    .abstract      = true,
> +};
> +
> +static const E1000Info e1000_devices[] = {
> +    {
> +        .name      = "e1000", /* default "alias" for 82540EM */
> +        .vendor_id = PCI_VENDOR_ID_INTEL,
> +        .device_id = E1000_DEV_ID_82540EM,
> +        .revision  = 0x03,
> +    },
> +    {
> +        .name      = "82540EM",
> +        .vendor_id = PCI_VENDOR_ID_INTEL,
> +        .device_id = E1000_DEV_ID_82540EM,
> +        .revision  = 0x03,
> +    },
> +    {
> +        .name      = "82544GC",
> +        .vendor_id = PCI_VENDOR_ID_INTEL,
> +        .device_id = E1000_DEV_ID_82544GC_COPPER,
> +        .revision  = 0x03,
> +    },
> +    {
> +        .name      = "82545EM",
> +        .vendor_id = PCI_VENDOR_ID_INTEL,
> +        .device_id = E1000_DEV_ID_82545EM_COPPER,
> +        .revision  = 0x03,
> +    },
>  };
>  
>  static void e1000_register_types(void)
>  {
> -    type_register_static(&e1000_info);
> +    int i;
> +
> +    type_register_static(&e1000_base_info);
> +    for (i = 0; i < ARRAY_SIZE(e1000_devices); i++) {
> +        const E1000Info *info = &e1000_devices[i];
> +        TypeInfo type_info = {};
> +
> +        type_info.name = info->name;
> +        type_info.parent = TYPE_E1000;
> +        type_info.class_data = (void *)info;
> +        type_info.class_init = e1000_class_init;
> +
> +        type_register(&type_info);
> +    }
>  }
>  
>  type_init(e1000_register_types)

The QOM modeling looks right, and I can't think of a better way to
handle "e1000" type name compatibility reliably.

What's missing is an update to tests/e1000-test.c to test those three
new devices as part of "make check" as well. May involve moving
qtest_start()/qtest_end() from main() to what is now the nop() test
function and calling qtest_add_func() four times.

Regards,
Andreas

-- 
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer; HRB 16746 AG Nürnberg