drm/virtio: document drm_dev_set_unique workaround

A while back we removed it, yet that lead to regressions. At some later
point, I've attempted to remove it again without fully grasping the
unique (pun intended) situation that virtio is in.

Add a bulky comment to document why the call should stay as-is, for the
next person who's around.

As a Tl;Dr: virtio sits on top of struct virtio_device, which confuses
dev_is_pci(), wrong info gets sent to userspace and X doesn't start.
Driver needs to explicitly call drm_dev_set_unique() to keep it working.

v2: Fix handful of typos (Laszlo)

Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20181024144252.16518-1-emil.l.velikov@gmail.com

diff --git a/drivers/gpu/drm/virtio/virtgpu_drm_bus.c b/drivers/gpu/drm/virtio/virtgpu_drm_bus.c
index 757ca28..0887e0b 100644 (file)
--- a/drivers/gpu/drm/virtio/virtgpu_drm_bus.c
+++ b/drivers/gpu/drm/virtio/virtgpu_drm_bus.c
@@ -53,6 +53,37 @@ int drm_virtio_init(struct drm_driver *driver, struct virtio_device *vdev)
                                                                          0,
                                                                          "virtiodrmfb");
 
+               /*
+                * Normally the drm_dev_set_unique() call is done by core DRM.
+                * The following comment covers, why virtio cannot rely on it.
+                *
+                * Unlike the other virtual GPU drivers, virtio abstracts the
+                * underlying bus type by using struct virtio_device.
+                *
+                * Hence the dev_is_pci() check, used in core DRM, will fail
+                * and the unique returned will be the virtio_device "virtio0",
+                * while a "pci:..." one is required.
+                *
+                * A few other ideas were considered:
+                * - Extend the dev_is_pci() check [in drm_set_busid] to
+                *   consider virtio.
+                *   Seems like a bigger hack than what we have already.
+                *
+                * - Point drm_device::dev to the parent of the virtio_device
+                *   Semantic changes:
+                *   * Using the wrong device for i2c, framebuffer_alloc and
+                *     prime import.
+                *   Visual changes:
+                *   * Helpers such as DRM_DEV_ERROR, dev_info, drm_printer,
+                *     will print the wrong information.
+                *
+                * We could address the latter issues, by introducing
+                * drm_device::bus_dev, ... which would be used solely for this.
+                *
+                * So for the moment keep things as-is, with a bulky comment
+                * for the next person who feels like removing this
+                * drm_dev_set_unique() quirk.
+                */
                snprintf(unique, sizeof(unique), "pci:%s", pname);
                ret = drm_dev_set_unique(dev, unique);
                if (ret)