aboutsummaryrefslogtreecommitdiff
path: root/drivers/platform/x86/wmaa-backlight-wmi.c
blob: f5c4f8337c2c02891217f86164ec191f2c2d60af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2020, NVIDIA CORPORATION.  All rights reserved.
 */

#include <linux/acpi.h>
#include <linux/backlight.h>
#include <linux/mod_devicetable.h>
#include <linux/module.h>
#include <linux/types.h>
#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 wmaa_method {
	WMAA_METHOD_LEVEL = 1,
	WMAA_METHOD_SOURCE = 2,
	WMAA_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 wmaa_mode {
	WMAA_MODE_GET = 0,
	WMAA_MODE_SET = 1,
	WMAA_MODE_GET_MAX_LEVEL = 2,
	WMAA_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 wmaa_source {
	WMAA_SOURCE_GPU = 1,
	WMAA_SOURCE_EC = 2,
	WMAA_SOURCE_AUX = 3,
	WMAA_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.
 * @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.
 * @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.
 */
struct wmaa_args {
	u32 mode;
	u32 val;
	u32 ret;
	u32 ignored[3];
};

/**
 * 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)
 * @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.
 *
 * 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)
{
	struct wmaa_args args = {
		.mode = mode,
		.val = 0,
		.ret = 0,
	};
	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)
		return -EINVAL;

	if (mode == WMAA_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",
			acpi_format_exception(status));
		return -EIO;
	}

	if (mode != WMAA_MODE_SET)
		*val = args.ret;

	return 0;
}

static int wmaa_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);
}

static int wmaa_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);
	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 int wmaa_backlight_wmi_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);
	if (ret)
		return ret;

	/*
	 * 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)
		return -ENODEV;

	/*
	 * Identify this backlight device as a firmware device so that it can
	 * be prioritized over any exposed GPU-driven raw device(s).
	 */
	props.type = BACKLIGHT_FIRMWARE;

	ret = wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_GET_MAX_LEVEL,
			    &props.max_brightness);
	if (ret)
		return ret;

	ret = wmi_call_wmaa(wdev, WMAA_METHOD_LEVEL, WMAA_MODE_GET,
			    &props.brightness);
	if (ret)
		return ret;

	bdev = devm_backlight_device_register(&wdev->dev, "wmaa_backlight",
					      &wdev->dev, wdev,
					      &wmaa_backlight_ops, &props);
	return PTR_ERR_OR_ZERO(bdev);
}

#define WMAA_WMI_GUID "603E9613-EF25-4338-A3D0-C46177516DB7"

static const struct wmi_device_id wmaa_backlight_wmi_id_table[] = {
	{ .guid_string = WMAA_WMI_GUID },
	{ }
};
MODULE_DEVICE_TABLE(wmi, wmaa_backlight_wmi_id_table);

static struct wmi_driver wmaa_backlight_wmi_driver = {
	.driver = {
		.name = "wmaa-backlight",
	},
	.probe = wmaa_backlight_wmi_probe,
	.id_table = wmaa_backlight_wmi_id_table,
};
module_wmi_driver(wmaa_backlight_wmi_driver);

MODULE_AUTHOR("Daniel Dadap <ddadap@nvidia.com>");
MODULE_DESCRIPTION("WMAA Backlight WMI driver");
MODULE_LICENSE("GPL");