diff mbox series

[regression,fix] firmware/dmi: Move product_sku info to the end of the modalias

Message ID 20210831130508.14511-1-hdegoede@redhat.com
State Accepted
Commit f97a2103f1a75ca70f23deadb4d96a16c4d85e7d
Headers show
Series [regression,fix] firmware/dmi: Move product_sku info to the end of the modalias | expand

Commit Message

Hans de Goede Aug. 31, 2021, 1:05 p.m. UTC
Commit e26f023e01ef ("firmware/dmi: Include product_sku info to modalias")
added a new field to the modalias in the middle of the modalias, breaking
some existing udev/hwdb matches on the whole modalias without a wildcard
('*') in between the pvr and rvn fields.

All modalias matches in e.g. :
https://github.com/systemd/systemd/blob/main/hwdb.d/60-sensor.hwdb
deliberately end in ':*' so that new fields can be added at *the end* of
the modalias, but adding a new field in the middle like this breaks things.

Move the new sku field to the end of the modalias to fix some hwdb
entries no longer matching.

The new sku field has already been put to use in 2 new hwdb entries:

 sensor:modalias:platform:HID-SENSOR-200073:dmi:*svnDell*:sku0A3E:*
  ACCEL_LOCATION=base

 sensor:modalias:platform:HID-SENSOR-200073:dmi:*svnDell*:sku0B0B:*
  ACCEL_LOCATION=base

The wildcard use before and after the sku in these matches means that they
should keep working with the sku moved to the end.

Note that there is a second instance of in essence the same problem,
commit f5152f4ded3c ("firmware/dmi: Report DMI Bios & EC firmware release")

Added 2 new br and efr fields in the middle of the modalias. This too
breaks some hwdb modalias matches, but this has gone unnoticed for over
a year. So some newer hwdb modalias matches actually depend on these
fields being in the middle of the string. Moving these to the end now
would break 3 hwdb entries, while fixing 8 entries.

Since there is no good answer for the new br and efr fields I have chosen
to leave these as is. Instead I'll submit a hwdb update to put a wildcard
at the place where these fields may or may not be present depending on the
kernel version.

BugLink: https://github.com/systemd/systemd/issues/20550
Link: https://github.com/systemd/systemd/pull/20562
Fixes: e26f023e01ef ("firmware/dmi: Include product_sku info to modalias")
Cc: stable@vger.kernel.org
Cc: Kai-Chuan Hsieh <kaichuan.hsieh@canonical.com>
Cc: Erwan Velu <e.velu@criteo.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
 drivers/firmware/dmi-id.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

Comments

Jean Delvare Sept. 2, 2021, 5:07 p.m. UTC | #1
Hi Hans,

On Tue, 31 Aug 2021 15:05:08 +0200, Hans de Goede wrote:
> Commit e26f023e01ef ("firmware/dmi: Include product_sku info to modalias")

> added a new field to the modalias in the middle of the modalias, breaking

> some existing udev/hwdb matches on the whole modalias without a wildcard

> ('*') in between the pvr and rvn fields.

> 

> All modalias matches in e.g. :

> https://github.com/systemd/systemd/blob/main/hwdb.d/60-sensor.hwdb

> deliberately end in ':*' so that new fields can be added at *the end* of

> the modalias, but adding a new field in the middle like this breaks things.

> 

> Move the new sku field to the end of the modalias to fix some hwdb

> entries no longer matching.


Argh. Sorry for missing that, and thanks a lot for spotting it,
reporting it and providing a fix. I never liked the modalias format as
it makes matches clearly fragile. I really need to keep this in mind
when touching it.

Patch applied and pushed to linux-next. I'll send it to Linus for
5.14.1 quickly too.

-- 
Jean Delvare
SUSE L3 Support
diff mbox series

Patch

diff --git a/drivers/firmware/dmi-id.c b/drivers/firmware/dmi-id.c
index 4d5421d14a41..940ddf916202 100644
--- a/drivers/firmware/dmi-id.c
+++ b/drivers/firmware/dmi-id.c
@@ -73,6 +73,10 @@  static void ascii_filter(char *d, const char *s)
 
 static ssize_t get_modalias(char *buffer, size_t buffer_size)
 {
+	/*
+	 * Note new fields need to be added at the end to keep compatibility
+	 * with udev's hwdb which does matches on "`cat dmi/id/modalias`*".
+	 */
 	static const struct mafield {
 		const char *prefix;
 		int field;
@@ -85,13 +89,13 @@  static ssize_t get_modalias(char *buffer, size_t buffer_size)
 		{ "svn", DMI_SYS_VENDOR },
 		{ "pn",  DMI_PRODUCT_NAME },
 		{ "pvr", DMI_PRODUCT_VERSION },
-		{ "sku", DMI_PRODUCT_SKU },
 		{ "rvn", DMI_BOARD_VENDOR },
 		{ "rn",  DMI_BOARD_NAME },
 		{ "rvr", DMI_BOARD_VERSION },
 		{ "cvn", DMI_CHASSIS_VENDOR },
 		{ "ct",  DMI_CHASSIS_TYPE },
 		{ "cvr", DMI_CHASSIS_VERSION },
+		{ "sku", DMI_PRODUCT_SKU },
 		{ NULL,  DMI_NONE }
 	};