chiark / gitweb /
hwdb: add IAB to the OUI database
[elogind.git] / src / udev / udev-builtin-net_id.c
index 44a29fe3713a7bc13924dbe04052c1ad6f67d8be..977545d996554dc557c714a9e4da1de203b97773 100644 (file)
 ***/
 
 /*
- * prefixes:
+ * predictable network interface device names based on:
+ *  - firmware/bios-provided index numbers for on-board devices
+ *  - firmware-provided pci-express hotplug slot index number
+ *  - physical/geographical location of the hardware
+ *  - the interface's MAC address
+ *
+ * two character prefixes based on the type of interface:
  *   en -- ethernet
  *   wl -- wlan
  *   ww -- wwan
  *
- * types:
- *   o<index>                 -- on-board device index
- *   s<slot>f<function>       -- hotplug slot number
- *   x<MAC>                   -- MAC address
- *   p<bus>s<slot>f<function> -- PCI/physical location
+ * type of names:
+ *   o<index>                   -- on-board device index number
+ *   s<slot>[f<function>]       -- hotplug slot index number
+ *   x<MAC>                     -- MAC address
+ *   p<bus>s<slot>[f<function>] -- PCI geographical location
+ *
+ * All multi-function devices will carry the [f<function>] number in the
+ * device name, including the function 0 device.
  *
- * example:
+ * examples:
  *   ID_NET_NAME_ONBOARD=eno1
- *   ID_NET_NAME_SLOT=ens1f0
+ *   ID_NET_NAME_SLOT=ens1
+ *   ID_NET_NAME_SLOT=ens2f0
+ *   ID_NET_NAME_SLOT=ens2f1
  *   ID_NET_NAME_MAC=enxf0def180d479
- *   ID_NET_NAME_PATH=enp19s0f0
+ *   ID_NET_NAME_PATH=enp0s25
+ *   ID_NET_NAME_PATH=enp19s3f0
+ *   ID_NET_NAME_PATH=enp19s3f1
  */
 
 #include <stdio.h>
@@ -42,6 +55,7 @@
 #include <unistd.h>
 #include <string.h>
 #include <errno.h>
+#include <linux/pci_regs.h>
 
 #include "udev.h"
 
@@ -77,6 +91,28 @@ static int dev_pci_onboard(struct udev_device *dev, struct udev_device *parent,
         return 0;
 }
 
+/* read the 256 bytes PCI configuration space to check the multi-function bit */
+static bool is_pci_singlefunction(struct udev_device *dev) {
+        char filename[256];
+        FILE *f;
+        char config[256];
+        bool single = false;
+
+        snprintf(filename, sizeof(filename), "%s/config", udev_device_get_syspath(dev));
+        f = fopen(filename, "re");
+        if (!f)
+                goto out;
+        if (fread(&config, sizeof(config), 1, f) != 1)
+                goto out;
+
+        /* bit 0-6 header type, bit 7 multi/single function device */
+        if ((config[PCI_HEADER_TYPE] & 0x80) == 0)
+                single = true;
+out:
+        fclose(f);
+        return single;
+}
+
 static int dev_pci_slot(struct udev_device *dev, struct udev_device *parent, const char *prefix, bool test) {
         struct udev *udev = udev_device_get_udev(dev);
         unsigned int bus;
@@ -93,7 +129,10 @@ static int dev_pci_slot(struct udev_device *dev, struct udev_device *parent, con
         /* compose a name based on the raw kernel's PCI bus, slot numbers */
         if (sscanf(udev_device_get_sysname(parent), "0000:%x:%x.%d", &bus, &slot, &func) != 3)
                 return -ENOENT;
-        snprintf(str, sizeof(str), "%sp%ds%df%d", prefix, bus, slot, func);
+        if (func == 0 && is_pci_singlefunction(parent))
+                snprintf(str, sizeof(str), "%sp%ds%d", prefix, bus, slot);
+        else
+                snprintf(str, sizeof(str), "%sp%ds%df%d", prefix, bus, slot, func);
         err = udev_builtin_add_property(dev, test, "ID_NET_NAME_PATH", str);
         if (err < 0)
                 return err;
@@ -137,7 +176,10 @@ static int dev_pci_slot(struct udev_device *dev, struct udev_device *parent, con
         closedir(dir);
 
         if (hotplug_slot > 0) {
-                snprintf(str, sizeof(str), "%ss%df%d", prefix, hotplug_slot, func);
+                if (func == 0 && is_pci_singlefunction(parent))
+                        snprintf(str, sizeof(str), "%ss%d", prefix, hotplug_slot);
+                else
+                        snprintf(str, sizeof(str), "%ss%df%d", prefix, hotplug_slot, func);
                 err = udev_builtin_add_property(dev, test, "ID_NET_NAME_SLOT", str);
         }
 out:
@@ -182,9 +224,14 @@ static int dev_mac(struct udev_device *dev, const char *prefix, bool test) {
         if (a1 + a2 + a3 + a4 + a5 + a6 == 0)
                 return -EINVAL;
 
-        /* add IEEE Organizationally Unique Identifier */
-        snprintf(str, sizeof(str), "OUI:%X%X%X", a1, a2, a3);
-        udev_builtin_hwdb_lookup(dev, str, test);
+        /*
+         * IEEE Organizationally Unique Identifier vendor string
+         * skip commonly misused 00:00:00 (Xerox) prefix
+         */
+        if (a1 + a2 + a3 > 0) {
+                snprintf(str, sizeof(str), "OUI:%02X%02X%02X%02X%02X%02X", a1, a2, a3, a4, a5, a6);
+                udev_builtin_hwdb_lookup(dev, str, test);
+        }
 
         snprintf(str, sizeof(str), "%sx%02x%02x%02x%02x%02x%02x", prefix, a1, a2, a3, a4, a5, a6);
         return udev_builtin_add_property(dev, test, "ID_NET_NAME_MAC", str);