Hi, On 9/27/21 10:23 PM, Daniel Dadap wrote: > The "wmaa" in the name of the wmaa-backlight-wmi driver was named after > the ACPI method handle for EC-based backlight control on the systems > this driver was tested on during development. However, this "WMAA" > handle is generated by the WMI compilation process, and isn't actually > a part of the backlight control mechanism which this driver supports. > Since the "WMAA" handle isn't actually a part of the firmware backlight > interface, the various identifiers in this driver using "WMAA" or > "wmaa" aren't actually appropriate. > > As a common denominator across the systems supported by this driver is > that they are hybrid graphics systems with NVIDIA GPUs, using "nvidia" > in the driver name seems more appropriate than "wmaa". Update the > driver to remove "wmaa" and "WMAA" in identifier names where they > appear. The kerneldoc comments for the enum wmi_brightness_method > values are replaced with the verbatim text from the decompiled BMF code > for this WMI class. > > Signed-off-by: Daniel Dadap <ddadap@xxxxxxxxxx> Thank you for your patch-series, I've applied the series to my review-hans branch: https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans Note it will show up in my review-hans branch once I've pushed my local branch there, which might take a while. Once I've run some tests on this branch the patches there will be added to the platform-drivers-x86/for-next branch and eventually will be included in the pdx86 pull-request to Linus for the next merge-window. Regards, Hans > --- > drivers/platform/x86/wmaa-backlight-wmi.c | 174 +++++++++++----------- > 1 file changed, 91 insertions(+), 83 deletions(-) > > diff --git a/drivers/platform/x86/wmaa-backlight-wmi.c b/drivers/platform/x86/wmaa-backlight-wmi.c > index f5c4f8337c2c..61e37194df70 100644 > --- a/drivers/platform/x86/wmaa-backlight-wmi.c > +++ b/drivers/platform/x86/wmaa-backlight-wmi.c > @@ -11,63 +11,64 @@ > #include <linux/wmi.h> > > /** > - * enum wmaa_method - WMI method IDs for ACPI WMAA > - * @WMAA_METHOD_LEVEL: Get or set the brightness level, > - * or get the maximum brightness level. > - * @WMAA_METHOD_SOURCE: Get the source for backlight control. > + * enum wmi_brightness_method - WMI method IDs > + * @WMI_BRIGHTNESS_METHOD_LEVEL: Get/Set EC brightness level status > + * @WMI_BRIGHTNESS_METHOD_SOURCE: Get/Set EC Brightness Source > */ > -enum wmaa_method { > - WMAA_METHOD_LEVEL = 1, > - WMAA_METHOD_SOURCE = 2, > - WMAA_METHOD_MAX > +enum wmi_brightness_method { > + WMI_BRIGHTNESS_METHOD_LEVEL = 1, > + WMI_BRIGHTNESS_METHOD_SOURCE = 2, > + WMI_BRIGHTNESS_METHOD_MAX > }; > > /** > - * enum wmaa_mode - Operation mode for ACPI WMAA method > - * @WMAA_MODE_GET: Get the current brightness level or source. > - * @WMAA_MODE_SET: Set the brightness level. > - * @WMAA_MODE_GET_MAX_LEVEL: Get the maximum brightness level. This is only > - * valid when the WMI method is %WMAA_METHOD_LEVEL. > + * enum wmi_brightness_mode - Operation mode for WMI-wrapped method > + * @WMI_BRIGHTNESS_MODE_GET: Get the current brightness level/source. > + * @WMI_BRIGHTNESS_MODE_SET: Set the brightness level. > + * @WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL: Get the maximum brightness level. This > + * is only valid when the WMI method is > + * %WMI_BRIGHTNESS_METHOD_LEVEL. > */ > -enum wmaa_mode { > - WMAA_MODE_GET = 0, > - WMAA_MODE_SET = 1, > - WMAA_MODE_GET_MAX_LEVEL = 2, > - WMAA_MODE_MAX > +enum wmi_brightness_mode { > + WMI_BRIGHTNESS_MODE_GET = 0, > + WMI_BRIGHTNESS_MODE_SET = 1, > + WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL = 2, > + WMI_BRIGHTNESS_MODE_MAX > }; > > /** > - * enum wmaa_source - Backlight brightness control source identification > - * @WMAA_SOURCE_GPU: Backlight brightness is controlled by the GPU. > - * @WMAA_SOURCE_EC: Backlight brightness is controlled by the system's > - * Embedded Controller (EC). > - * @WMAA_SOURCE_AUX: Backlight brightness is controlled over the DisplayPort > - * AUX channel. > + * enum wmi_brightness_source - Backlight brightness control source selection > + * @WMI_BRIGHTNESS_SOURCE_GPU: Backlight brightness is controlled by the GPU. > + * @WMI_BRIGHTNESS_SOURCE_EC: Backlight brightness is controlled by the > + * system's Embedded Controller (EC). > + * @WMI_BRIGHTNESS_SOURCE_AUX: Backlight brightness is controlled over the > + * DisplayPort AUX channel. > */ > -enum wmaa_source { > - WMAA_SOURCE_GPU = 1, > - WMAA_SOURCE_EC = 2, > - WMAA_SOURCE_AUX = 3, > - WMAA_SOURCE_MAX > +enum wmi_brightness_source { > + WMI_BRIGHTNESS_SOURCE_GPU = 1, > + WMI_BRIGHTNESS_SOURCE_EC = 2, > + WMI_BRIGHTNESS_SOURCE_AUX = 3, > + WMI_BRIGHTNESS_SOURCE_MAX > }; > > /** > - * struct wmaa_args - arguments for the ACPI WMAA method > - * @mode: Pass in an &enum wmaa_mode value to select between getting or > - * setting a value. > - * @val: In parameter for value to set when operating in %WMAA_MODE_SET > - * mode. Not used in %WMAA_MODE_GET or %WMAA_MODE_GET_MAX_LEVEL mode. > + * struct wmi_brightness_args - arguments for the WMI-wrapped ACPI method > + * @mode: Pass in an &enum wmi_brightness_mode value to select between > + * getting or setting a value. > + * @val: In parameter for value to set when using %WMI_BRIGHTNESS_MODE_SET > + * mode. Not used in conjunction with %WMI_BRIGHTNESS_MODE_GET or > + * %WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL mode. > * @ret: Out parameter returning retrieved value when operating in > - * %WMAA_MODE_GET or %WMAA_MODE_GET_MAX_LEVEL mode. Not used in > - * %WMAA_MODE_SET mode. > + * %WMI_BRIGHTNESS_MODE_GET or %WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL > + * mode. Not used in %WMI_BRIGHTNESS_MODE_SET mode. > * @ignored: Padding; not used. The ACPI method expects a 24 byte params struct. > * > - * This is the parameters structure for the ACPI WMAA method as wrapped by WMI. > - * The value passed in to @val or returned by @ret will be a brightness value > - * when the WMI method ID is %WMAA_METHOD_LEVEL, or an &enum wmaa_source value > - * when the WMI method ID is %WMAA_METHOD_SOURCE. > + * This is the parameters structure for the WmiBrightnessNotify ACPI method as > + * wrapped by WMI. The value passed in to @val or returned by @ret will be a > + * brightness value when the WMI method ID is %WMI_BRIGHTNESS_METHOD_LEVEL, or > + * an &enum wmi_brightness_source value with %WMI_BRIGHTNESS_METHOD_SOURCE. > */ > -struct wmaa_args { > +struct wmi_brightness_args { > u32 mode; > u32 val; > u32 ret; > @@ -75,21 +76,21 @@ struct wmaa_args { > }; > > /** > - * wmi_call_wmaa() - helper function for calling ACPI WMAA via its WMI wrapper > - * @w: Pointer to the struct wmi_device identified by %WMAA_WMI_GUID > - * @id: The method ID for the ACPI WMAA method (e.g. %WMAA_METHOD_LEVEL or > - * %WMAA_METHOD_SOURCE) > - * @mode: The operation to perform on the ACPI WMAA method (e.g. %WMAA_MODE_SET > - * or %WMAA_MODE_GET) > + * wmi_brightness_notify() - helper function for calling WMI-wrapped ACPI method > + * @w: Pointer to the struct wmi_device identified by %WMI_BRIGHTNESS_GUID > + * @id: The WMI method ID to call (e.g. %WMI_BRIGHTNESS_METHOD_LEVEL or > + * %WMI_BRIGHTNESS_METHOD_SOURCE) > + * @mode: The operation to perform on the method (e.g. %WMI_BRIGHTNESS_MODE_SET > + * or %WMI_BRIGHTNESS_MODE_GET) > * @val: Pointer to a value passed in by the caller when @mode is > - * %WMAA_MODE_SET, or a value passed out to the caller when @mode is > - * %WMAA_MODE_GET or %WMAA_MODE_GET_MAX_LEVEL. > + * %WMI_BRIGHTNESS_MODE_SET, or a value passed out to caller when @mode > + * is %WMI_BRIGHTNESS_MODE_GET or %WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL. > * > * Returns 0 on success, or a negative error number on failure. > */ > -static int wmi_call_wmaa(struct wmi_device *w, enum wmaa_method id, enum wmaa_mode mode, u32 *val) > +static int wmi_brightness_notify(struct wmi_device *w, enum wmi_brightness_method id, enum wmi_brightness_mode mode, u32 *val) > { > - struct wmaa_args args = { > + struct wmi_brightness_args args = { > .mode = mode, > .val = 0, > .ret = 0, > @@ -97,60 +98,64 @@ static int wmi_call_wmaa(struct wmi_device *w, enum wmaa_method id, enum wmaa_mo > struct acpi_buffer buf = { (acpi_size)sizeof(args), &args }; > acpi_status status; > > - if (id < WMAA_METHOD_LEVEL || id >= WMAA_METHOD_MAX || > - mode < WMAA_MODE_GET || mode >= WMAA_MODE_MAX) > + if (id < WMI_BRIGHTNESS_METHOD_LEVEL || > + id >= WMI_BRIGHTNESS_METHOD_MAX || > + mode < WMI_BRIGHTNESS_MODE_GET || mode >= WMI_BRIGHTNESS_MODE_MAX) > return -EINVAL; > > - if (mode == WMAA_MODE_SET) > + if (mode == WMI_BRIGHTNESS_MODE_SET) > args.val = *val; > > status = wmidev_evaluate_method(w, 0, id, &buf, &buf); > if (ACPI_FAILURE(status)) { > - dev_err(&w->dev, "ACPI WMAA failed: %s\n", > + dev_err(&w->dev, "EC backlight control failed: %s\n", > acpi_format_exception(status)); > return -EIO; > } > > - if (mode != WMAA_MODE_SET) > + if (mode != WMI_BRIGHTNESS_MODE_SET) > *val = args.ret; > > return 0; > } > > -static int wmaa_backlight_update_status(struct backlight_device *bd) > +static int nvidia_wmi_ec_backlight_update_status(struct backlight_device *bd) > { > struct wmi_device *wdev = bl_get_data(bd); > > - return wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_SET, > - &bd->props.brightness); > + return wmi_brightness_notify(wdev, WMI_BRIGHTNESS_METHOD_LEVEL, > + WMI_BRIGHTNESS_MODE_SET, > + &bd->props.brightness); > } > > -static int wmaa_backlight_get_brightness(struct backlight_device *bd) > +static int nvidia_wmi_ec_backlight_get_brightness(struct backlight_device *bd) > { > struct wmi_device *wdev = bl_get_data(bd); > u32 level; > int ret; > > - ret = wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_GET, &level); > + ret = wmi_brightness_notify(wdev, WMI_BRIGHTNESS_METHOD_LEVEL, > + WMI_BRIGHTNESS_MODE_GET, &level); > if (ret < 0) > return ret; > > return level; > } > > -static const struct backlight_ops wmaa_backlight_ops = { > - .update_status = wmaa_backlight_update_status, > - .get_brightness = wmaa_backlight_get_brightness, > +static const struct backlight_ops nvidia_wmi_ec_backlight_ops = { > + .update_status = nvidia_wmi_ec_backlight_update_status, > + .get_brightness = nvidia_wmi_ec_backlight_get_brightness, > }; > > -static int wmaa_backlight_wmi_probe(struct wmi_device *wdev, const void *ctx) > +static int nvidia_wmi_ec_backlight_probe(struct wmi_device *wdev, const void *ctx) > { > struct backlight_properties props = {}; > struct backlight_device *bdev; > u32 source; > int ret; > > - ret = wmi_call_wmaa(wdev, WMAA_METHOD_SOURCE, WMAA_MODE_GET, &source); > + ret = wmi_brightness_notify(wdev, WMI_BRIGHTNESS_METHOD_SOURCE, > + WMI_BRIGHTNESS_MODE_GET, &source); > if (ret) > return ret; > > @@ -158,7 +163,7 @@ static int wmaa_backlight_wmi_probe(struct wmi_device *wdev, const void *ctx) > * This driver is only to be used when brightness control is handled > * by the EC; otherwise, the GPU driver(s) should control brightness. > */ > - if (source != WMAA_SOURCE_EC) > + if (source != WMI_BRIGHTNESS_SOURCE_EC) > return -ENODEV; > > /* > @@ -167,39 +172,42 @@ static int wmaa_backlight_wmi_probe(struct wmi_device *wdev, const void *ctx) > */ > props.type = BACKLIGHT_FIRMWARE; > > - ret = wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_GET_MAX_LEVEL, > - &props.max_brightness); > + ret = wmi_brightness_notify(wdev, WMI_BRIGHTNESS_METHOD_LEVEL, > + WMI_BRIGHTNESS_MODE_GET_MAX_LEVEL, > + &props.max_brightness); > if (ret) > return ret; > > - ret = wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_GET, > - &props.brightness); > + ret = wmi_brightness_notify(wdev, WMI_BRIGHTNESS_METHOD_LEVEL, > + WMI_BRIGHTNESS_MODE_GET, &props.brightness); > if (ret) > return ret; > > - bdev = devm_backlight_device_register(&wdev->dev, "wmaa_backlight", > + bdev = devm_backlight_device_register(&wdev->dev, > + "nvidia_wmi_ec_backlight", > &wdev->dev, wdev, > - &wmaa_backlight_ops, &props); > + &nvidia_wmi_ec_backlight_ops, > + &props); > return PTR_ERR_OR_ZERO(bdev); > } > > -#define WMAA_WMI_GUID "603E9613-EF25-4338-A3D0-C46177516DB7" > +#define WMI_BRIGHTNESS_GUID "603E9613-EF25-4338-A3D0-C46177516DB7" > > -static const struct wmi_device_id wmaa_backlight_wmi_id_table[] = { > - { .guid_string = WMAA_WMI_GUID }, > +static const struct wmi_device_id nvidia_wmi_ec_backlight_id_table[] = { > + { .guid_string = WMI_BRIGHTNESS_GUID }, > { } > }; > -MODULE_DEVICE_TABLE(wmi, wmaa_backlight_wmi_id_table); > +MODULE_DEVICE_TABLE(wmi, nvidia_wmi_ec_backlight_id_table); > > -static struct wmi_driver wmaa_backlight_wmi_driver = { > +static struct wmi_driver nvidia_wmi_ec_backlight_driver = { > .driver = { > - .name = "wmaa-backlight", > + .name = "nvidia-wmi-ec-backlight", > }, > - .probe = wmaa_backlight_wmi_probe, > - .id_table = wmaa_backlight_wmi_id_table, > + .probe = nvidia_wmi_ec_backlight_probe, > + .id_table = nvidia_wmi_ec_backlight_id_table, > }; > -module_wmi_driver(wmaa_backlight_wmi_driver); > +module_wmi_driver(nvidia_wmi_ec_backlight_driver); > > MODULE_AUTHOR("Daniel Dadap <ddadap@xxxxxxxxxx>"); > -MODULE_DESCRIPTION("WMAA Backlight WMI driver"); > +MODULE_DESCRIPTION("NVIDIA WMI EC Backlight driver"); > MODULE_LICENSE("GPL"); >
