1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * wmi.h - ACPI WMI interface
4  *
5  * Copyright (c) 2015 Andrew Lutomirski
6  */
7 
8 #ifndef _LINUX_WMI_H
9 #define _LINUX_WMI_H
10 
11 #include <linux/device.h>
12 #include <linux/acpi.h>
13 #include <linux/mod_devicetable.h>
14 
15 /**
16  * struct wmi_device - WMI device structure
17  * @dev: Device associated with this WMI device
18  * @setable: True for devices implementing the Set Control Method
19  *
20  * This represents WMI devices discovered by the WMI driver core.
21  */
22 struct wmi_device {
23 	struct device dev;
24 	bool setable;
25 };
26 
27 /**
28  * to_wmi_device() - Helper macro to cast a device to a wmi_device
29  * @device: device struct
30  *
31  * Cast a struct device to a struct wmi_device.
32  */
33 #define to_wmi_device(device)	container_of(device, struct wmi_device, dev)
34 
35 extern acpi_status wmidev_evaluate_method(struct wmi_device *wdev,
36 					  u8 instance, u32 method_id,
37 					  const struct acpi_buffer *in,
38 					  struct acpi_buffer *out);
39 
40 extern union acpi_object *wmidev_block_query(struct wmi_device *wdev,
41 					     u8 instance);
42 
43 acpi_status wmidev_block_set(struct wmi_device *wdev, u8 instance, const struct acpi_buffer *in);
44 
45 u8 wmidev_instance_count(struct wmi_device *wdev);
46 
47 /**
48  * struct wmi_driver - WMI driver structure
49  * @driver: Driver model structure
50  * @id_table: List of WMI GUIDs supported by this driver
51  * @no_notify_data: WMI events provide no event data
52  * @probe: Callback for device binding
53  * @remove: Callback for device unbinding
54  * @notify: Callback for receiving WMI events
55  *
56  * This represents WMI drivers which handle WMI devices.
57  */
58 struct wmi_driver {
59 	struct device_driver driver;
60 	const struct wmi_device_id *id_table;
61 	bool no_notify_data;
62 
63 	int (*probe)(struct wmi_device *wdev, const void *context);
64 	void (*remove)(struct wmi_device *wdev);
65 	void (*notify)(struct wmi_device *device, union acpi_object *data);
66 };
67 
68 extern int __must_check __wmi_driver_register(struct wmi_driver *driver,
69 					      struct module *owner);
70 extern void wmi_driver_unregister(struct wmi_driver *driver);
71 
72 /**
73  * wmi_driver_register() - Helper macro to register a WMI driver
74  * @driver: wmi_driver struct
75  *
76  * Helper macro for registering a WMI driver. It automatically passes
77  * THIS_MODULE to the underlying function.
78  */
79 #define wmi_driver_register(driver) __wmi_driver_register((driver), THIS_MODULE)
80 
81 /**
82  * module_wmi_driver() - Helper macro to register/unregister a WMI driver
83  * @__wmi_driver: wmi_driver struct
84  *
85  * Helper macro for WMI drivers which do not do anything special in module
86  * init/exit. This eliminates a lot of boilerplate. Each module may only
87  * use this macro once, and calling it replaces module_init() and module_exit().
88  */
89 #define module_wmi_driver(__wmi_driver) \
90 	module_driver(__wmi_driver, wmi_driver_register, \
91 		      wmi_driver_unregister)
92 
93 #endif
94