Keyboard backlight LED naming was Re: [PATCH v5 2/3] platform/chrome: Add Wilco EC keyboard backlight LEDs support

From: Pavel Machek <pavel@ucw.cz>
To: Dmitry Torokhov <dtor@google.com>
Cc: Guenter Roeck <linux@roeck-us.net>,
	Nick Crews <ncrews@chromium.org>,
	enric.balletbo@collabora.com, Benson Leung <bleung@chromium.org>,
	linux-leds@vger.kernel.org, jacek.anaszewski@gmail.com,
	alexandre.belloni@bootlin.com,
	Alessandro Zummo <a.zummo@towertech.it>,
	linux-rtc@vger.kernel.org, lkml <linux-kernel@vger.kernel.org>,
	dlaurie@chromium.org, sjg@google.com,
	Guenter Roeck <groeck@google.com>
Subject: Keyboard backlight LED naming was Re: [PATCH v5 2/3] platform/chrome: Add Wilco EC keyboard backlight LEDs support
Date: Mon, 8 Apr 2019 11:41:13 +0200	[thread overview]
Message-ID: <20190408094113.GB30958@amd> (raw)
In-Reply-To: <CAE_wzQ_5Ha6hNt28_+j-pF3mAdXXifv9CuotDCeXff8KC1DNmA@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2716 bytes --]

Hi!

> > > > > This document also states "The naming scheme above leaves scope
> > > > > for further attributes should they be needed". It does not permit,
> > > > > however, to redefine one of the fields to mean "location", much less
> > > > > the declaration that a devicename of "platform" shall refer to an
> > > > > "internal" backlight, or that there shall be no more than one
> > > > > "internal" backlight in a given system.
> > > >
> > > > "platform" is as good devicename as "wilco" or "chromeos".
> > >
> > > No, because "platform" is not a device, it is something that you are
> > > trying to assign a magic meaning to.
> >
> > "chromeos" is not a device, either.
> 
> I agree, it is not a device name. We do not assign any specific
> meaning to it though. We could change it to "cros_ec" if so desired
> and nothing should break.

Yes. And you can also change it to "platform" and nothing will break
:-). Can we end the discussion here?

If not, lets take a look at existing names:

./drivers/platform/x86/asus-laptop.c:		cdev->name = "asus::kbd_backlight";
./drivers/platform/x86/samsung-laptop.c:		samsung->kbd_led.name = "samsung::kbd_backlight";
./drivers/platform/x86/thinkpad_acpi.c:		.name		= "tpacpi::kbd_backlight",
./drivers/platform/x86/toshiba_acpi.c:		dev->kbd_led.name = "toshiba::kbd_backlight";
./drivers/platform/x86/asus-wmi.c:		asus->kbd_led.name = "asus::kbd_backlight";
./drivers/platform/x86/dell-laptop.c:	.name           = "dell::kbd_backlight",
./drivers/platform/chrome/cros_kbd_led_backlight.c:	cdev->name = "chromeos::kbd_backlight";
./drivers/hwmon/applesmc.c:	.name			= "smc::kbd_backlight",
./drivers/hid/hid-asus.c:	drvdata->kbd_backlight->cdev.name = "asus::kbd_backlight";
./drivers/hid/hid-google-hammer.c:	kbd_backlight->cdev.name = "hammer::kbd_backlight";
./drivers/input/misc/ims-pcu.c:		 "pcu%d::kbd_backlight", pcu->device_no);

asus, samsung, toshiba, asus, dell, chromeos... Those are really not
device names, either. But in these cases, LED is probably controlled
by EC, or by ACPI BIOS talking to the EC. People usually call such
devices "platform devices".

(Linux Platform Device Driver - CodeProject
https://www.codeproject.com/tips/1080177/linux-platform-device-driver
A platform device is one which is hardwired on the board and hence not
hot-pluggable. )

You can take a look at discussion around micmute LED.

Thus "platform" is quite suitable name in your case, and incidentaly,
it will be more useful for userspace than "cros_ec".

								Pavel
-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]