wmi_acpivar.h revision 1.6 1 /* $NetBSD: wmi_acpivar.h,v 1.6 2020/04/16 21:56:42 rin Exp $ */
2
3 /*-
4 * Copyright (c) 2009, 2010 Jukka Ruohonen <jruohonen (at) iki.fi>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 #ifndef _SYS_DEV_ACPI_WMI_WMI_ACPIVAR_H
31 #define _SYS_DEV_ACPI_WMI_WMI_ACPIVAR_H
32
33 ACPI_STATUS acpi_wmi_event_register(device_t, ACPI_NOTIFY_HANDLER);
34 ACPI_STATUS acpi_wmi_event_deregister(device_t);
35 ACPI_STATUS acpi_wmi_event_get(device_t, uint32_t, ACPI_BUFFER *);
36
37 int acpi_wmi_guid_match(device_t, const char *);
38
39 ACPI_STATUS acpi_wmi_data_query(device_t, const char *,
40 uint8_t, ACPI_BUFFER *);
41 ACPI_STATUS acpi_wmi_data_write(device_t, const char *,
42 uint8_t, ACPI_BUFFER *);
43
44 ACPI_STATUS acpi_wmi_method(device_t, const char *, uint8_t,
45 uint32_t, ACPI_BUFFER *, ACPI_BUFFER *);
46
47 struct guid_t {
48
49 /*
50 * The GUID itself. The used format is the usual 32-16-16-64-bit
51 * representation. All except the fourth field are in native byte
52 * order. A 32-16-16-16-48-bit hexadecimal notation with hyphens
53 * is used for human-readable GUIDs.
54 */
55 struct {
56 uint32_t data1;
57 uint16_t data2;
58 uint16_t data3;
59 uint8_t data4[8];
60 } __packed;
61
62 union {
63 char oid[2]; /* ACPI object ID. */
64
65 struct {
66 uint8_t nid; /* Notification value. */
67 uint8_t res; /* Reserved. */
68 } __packed;
69 } __packed;
70
71 uint8_t count; /* Number of instances. */
72 uint8_t flags; /* Additional flags. */
73
74 } __packed;
75
76 #define ACPI_WMI_FLAG_EXPENSIVE 0x01
77 #define ACPI_WMI_FLAG_METHOD 0x02
78 #define ACPI_WMI_FLAG_STRING 0x04
79 #define ACPI_WMI_FLAG_EVENT 0x08
80 #define ACPI_WMI_FLAG_DATA (ACPI_WMI_FLAG_EXPENSIVE | \
81 ACPI_WMI_FLAG_STRING)
82
83 struct wmi_t {
84 struct guid_t guid;
85 bool eevent;
86
87 SIMPLEQ_ENTRY(wmi_t) wmi_link;
88 };
89
90 struct acpi_wmi_softc {
91 device_t sc_dev;
92 device_t sc_child;
93 device_t sc_ecdev;
94 struct acpi_devnode *sc_node;
95 ACPI_NOTIFY_HANDLER sc_handler;
96
97 SIMPLEQ_HEAD(, wmi_t) wmi_head;
98 };
99
100 #define UGET16(x) (*(uint16_t *)(x))
101 #define UGET64(x) (*(uint64_t *)(x))
102
103 #define HEXCHAR(x) (((x) >= '0' && (x) <= '9') || \
104 ((x) >= 'a' && (x) <= 'f') || \
105 ((x) >= 'A' && (x) <= 'F'))
106
107 #define GUIDCMP(a, b) \
108 ((a)->data1 == (b)->data1 && \
109 (a)->data2 == (b)->data2 && \
110 (a)->data3 == (b)->data3 && \
111 UGET64((a)->data4) == UGET64((b)->data4))
112
113 #endif /* !_SYS_DEV_ACPI_WMI_WMI_ACPIVAR_H */
114