[PATCH v3 15/31] platform/x86: nvidia-wmi-ec-backlight: Move fw interface definitions to a header
Hans de Goede
hdegoede at redhat.com
Fri Aug 19 10:05:30 UTC 2022
Hi,
On 8/18/22 21:38, Daniel Dadap wrote:
>
> On 8/18/22 1:42 PM, Hans de Goede wrote:
>> Move the WMI interface definitions to a header, so that the definitions
>> can be shared with drivers/acpi/video_detect.c .
>>
>> Suggested-by: Daniel Dadap <ddadap at nvidia.com>
>> Signed-off-by: Hans de Goede <hdegoede at redhat.com>
>> ---
>> MAINTAINERS | 1 +
>> .../platform/x86/nvidia-wmi-ec-backlight.c | 66 +----------------
>> .../x86/nvidia-wmi-ec-backlight.h | 70 +++++++++++++++++++
>> 3 files changed, 72 insertions(+), 65 deletions(-)
>> create mode 100644 include/linux/platform_data/x86/nvidia-wmi-ec-backlight.h
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 8a5012ba6ff9..8d59c6e9b4db 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -14526,6 +14526,7 @@ M: Daniel Dadap <ddadap at nvidia.com>
>> L: platform-driver-x86 at vger.kernel.org
>> S: Supported
>> F: drivers/platform/x86/nvidia-wmi-ec-backlight.c
>> +F: include/linux/platform_data/x86/nvidia-wmi-ec-backlight.h
>> NVM EXPRESS DRIVER
>> M: Keith Busch <kbusch at kernel.org>
>> diff --git a/drivers/platform/x86/nvidia-wmi-ec-backlight.c b/drivers/platform/x86/nvidia-wmi-ec-backlight.c
>> index 61e37194df70..e84e1d629b14 100644
>> --- a/drivers/platform/x86/nvidia-wmi-ec-backlight.c
>> +++ b/drivers/platform/x86/nvidia-wmi-ec-backlight.c
>> @@ -7,74 +7,10 @@
>> #include <linux/backlight.h>
>> #include <linux/mod_devicetable.h>
>> #include <linux/module.h>
>> +#include <linux/platform_data/x86/nvidia-wmi-ec-backlight.h>
>> #include <linux/types.h>
>> #include <linux/wmi.h>
>> -/**
>> - * 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 wmi_brightness_method {
>> - WMI_BRIGHTNESS_METHOD_LEVEL = 1,
>> - WMI_BRIGHTNESS_METHOD_SOURCE = 2,
>> - WMI_BRIGHTNESS_METHOD_MAX
>> -};
>> -
>> -/**
>> - * 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 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 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 wmi_brightness_source {
>> - WMI_BRIGHTNESS_SOURCE_GPU = 1,
>> - WMI_BRIGHTNESS_SOURCE_EC = 2,
>> - WMI_BRIGHTNESS_SOURCE_AUX = 3,
>> - WMI_BRIGHTNESS_SOURCE_MAX
>> -};
>> -
>> -/**
>> - * 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
>> - * %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 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 wmi_brightness_args {
>> - u32 mode;
>> - u32 val;
>> - u32 ret;
>> - u32 ignored[3];
>> -};
>> -
>> /**
>> * wmi_brightness_notify() - helper function for calling WMI-wrapped ACPI method
>> * @w: Pointer to the struct wmi_device identified by %WMI_BRIGHTNESS_GUID
>> diff --git a/include/linux/platform_data/x86/nvidia-wmi-ec-backlight.h b/include/linux/platform_data/x86/nvidia-wmi-ec-backlight.h
>> new file mode 100644
>> index 000000000000..d83104c6c6cb
>> --- /dev/null
>> +++ b/include/linux/platform_data/x86/nvidia-wmi-ec-backlight.h
>> @@ -0,0 +1,70 @@
>> +/* SPDX-License-Identifier: GPL-2.0-only */
>
>
> Should the copyright notice from nvidia-wmi-ec-backlight be copied here as well?
Ah right, I forgot that. I'll fix that for version 4 of the series.
I'll also make the GUID a #define for version 4 of the series as
you mentioned in one of your other remarks.
>> +#ifndef __PLATFORM_DATA_X86_NVIDIA_WMI_EC_BACKLIGHT_H
>> +#define __PLATFORM_DATA_X86_NVIDIA_WMI_EC_BACKLIGHT_H
>> +
>> +/**
>> + * 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 wmi_brightness_method {
>> + WMI_BRIGHTNESS_METHOD_LEVEL = 1,
>> + WMI_BRIGHTNESS_METHOD_SOURCE = 2,
>> + WMI_BRIGHTNESS_METHOD_MAX
>> +};
>
>
> It might be nice, but certainly not essential, to namespace these better, now that they're no longer internal to the EC backlight driver. I did that in the version of this change that I had started working up, but got kind of annoyed that it made a lot of lines go over 80 columns, and then got distracted by other work and never ended up finishing the change up. I guess it's probably fine to leave them as is, since there won't be many files that include this header.
This header is only used in 2 .c files, as such I'm not worried about
namespacing the defines, so my plan for version 4 is to just keep
this as is.
Regards,
Hans
>
>
>> +
>> +/**
>> + * 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 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 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 wmi_brightness_source {
>> + WMI_BRIGHTNESS_SOURCE_GPU = 1,
>> + WMI_BRIGHTNESS_SOURCE_EC = 2,
>> + WMI_BRIGHTNESS_SOURCE_AUX = 3,
>> + WMI_BRIGHTNESS_SOURCE_MAX
>> +};
>> +
>> +/**
>> + * 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
>> + * %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 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 wmi_brightness_args {
>> + u32 mode;
>> + u32 val;
>> + u32 ret;
>> + u32 ignored[3];
>> +};
>> +
>> +#endif
>
More information about the dri-devel
mailing list