1 /* SPDX-License-Identifier: BSD-3-Clause OR GP 1
2 /*********************************************
3 *
4 * Name: acbuffer.h - Support for buffers retu
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *********************************************
9
10 #ifndef __ACBUFFER_H__
11 #define __ACBUFFER_H__
12
13 /*
14 * Contains buffer structures for these predef
15 * _FDE, _GRT, _GTM, _PLD, _SRT
16 */
17
18 /*
19 * Note: C bitfields are not used for this rea
20 *
21 * "Bitfields are great and easy to read, but
22 * does not specify the layout of bitfields in
23 * essentially useless for dealing with packed
24 * binary wire protocols." (Or ACPI tables and
25 * this decision was a design error in C. Ritc
26 * and stuck with it." Norman Ramsey.
27 * See http://stackoverflow.com/a/1053662/4166
28 */
29
30 /* _FDE return value */
31
32 struct acpi_fde_info {
33 u32 floppy0;
34 u32 floppy1;
35 u32 floppy2;
36 u32 floppy3;
37 u32 tape;
38 };
39
40 /*
41 * _GRT return value
42 * _SRT input value
43 */
44 struct acpi_grt_info {
45 u16 year;
46 u8 month;
47 u8 day;
48 u8 hour;
49 u8 minute;
50 u8 second;
51 u8 valid;
52 u16 milliseconds;
53 u16 timezone;
54 u8 daylight;
55 u8 reserved[3];
56 };
57
58 /* _GTM return value */
59
60 struct acpi_gtm_info {
61 u32 pio_speed0;
62 u32 dma_speed0;
63 u32 pio_speed1;
64 u32 dma_speed1;
65 u32 flags;
66 };
67
68 /*
69 * Formatted _PLD return value. The minimum si
70 * one buffer.
71 * Revision 1: Buffer is 16 bytes (128 bits)
72 * Revision 2: Buffer is 20 bytes (160 bits)
73 *
74 * Note: This structure is returned from the a
75 * interface.
76 */
77 struct acpi_pld_info {
78 u8 revision;
79 u8 ignore_color;
80 u8 red;
81 u8 green;
82 u8 blue;
83 u16 width;
84 u16 height;
85 u8 user_visible;
86 u8 dock;
87 u8 lid;
88 u8 panel;
89 u8 vertical_position;
90 u8 horizontal_position;
91 u8 shape;
92 u8 group_orientation;
93 u8 group_token;
94 u8 group_position;
95 u8 bay;
96 u8 ejectable;
97 u8 ospm_eject_required;
98 u8 cabinet_number;
99 u8 card_cage_number;
100 u8 reference;
101 u8 rotation;
102 u8 order;
103 u8 reserved;
104 u16 vertical_offset;
105 u16 horizontal_offset;
106 };
107
108 /*
109 * Macros to:
110 * 1) Convert a _PLD buffer to internal st
111 * (Used by acpi_decode_pld_buffer)
112 * 2) Construct a _PLD buffer - ACPI_PLD_S
113 * (Intended for BIOS use only)
114 */
115 #define ACPI_PLD_REV1_BUFFER_SIZE
116 #define ACPI_PLD_REV2_BUFFER_SIZE
117 #define ACPI_PLD_BUFFER_SIZE
118
119 /* First 32-bit dword, bits 0:32 */
120
121 #define ACPI_PLD_GET_REVISION(dword)
122 #define ACPI_PLD_SET_REVISION(dword,value)
123
124 #define ACPI_PLD_GET_IGNORE_COLOR(dword)
125 #define ACPI_PLD_SET_IGNORE_COLOR(dword,value)
126
127 #define ACPI_PLD_GET_RED(dword)
128 #define ACPI_PLD_SET_RED(dword,value)
129
130 #define ACPI_PLD_GET_GREEN(dword)
131 #define ACPI_PLD_SET_GREEN(dword,value)
132
133 #define ACPI_PLD_GET_BLUE(dword)
134 #define ACPI_PLD_SET_BLUE(dword,value)
135
136 /* Second 32-bit dword, bits 33:63 */
137
138 #define ACPI_PLD_GET_WIDTH(dword)
139 #define ACPI_PLD_SET_WIDTH(dword,value)
140
141 #define ACPI_PLD_GET_HEIGHT(dword)
142 #define ACPI_PLD_SET_HEIGHT(dword,value)
143
144 /* Third 32-bit dword, bits 64:95 */
145
146 #define ACPI_PLD_GET_USER_VISIBLE(dword)
147 #define ACPI_PLD_SET_USER_VISIBLE(dword,value)
148
149 #define ACPI_PLD_GET_DOCK(dword)
150 #define ACPI_PLD_SET_DOCK(dword,value)
151
152 #define ACPI_PLD_GET_LID(dword)
153 #define ACPI_PLD_SET_LID(dword,value)
154
155 #define ACPI_PLD_GET_PANEL(dword)
156 #define ACPI_PLD_SET_PANEL(dword,value)
157
158 #define ACPI_PLD_GET_VERTICAL(dword)
159 #define ACPI_PLD_SET_VERTICAL(dword,value)
160
161 #define ACPI_PLD_GET_HORIZONTAL(dword)
162 #define ACPI_PLD_SET_HORIZONTAL(dword,value)
163
164 #define ACPI_PLD_GET_SHAPE(dword)
165 #define ACPI_PLD_SET_SHAPE(dword,value)
166
167 #define ACPI_PLD_GET_ORIENTATION(dword)
168 #define ACPI_PLD_SET_ORIENTATION(dword,value)
169
170 #define ACPI_PLD_GET_TOKEN(dword)
171 #define ACPI_PLD_SET_TOKEN(dword,value)
172
173 #define ACPI_PLD_GET_POSITION(dword)
174 #define ACPI_PLD_SET_POSITION(dword,value)
175
176 #define ACPI_PLD_GET_BAY(dword)
177 #define ACPI_PLD_SET_BAY(dword,value)
178
179 /* Fourth 32-bit dword, bits 96:127 */
180
181 #define ACPI_PLD_GET_EJECTABLE(dword)
182 #define ACPI_PLD_SET_EJECTABLE(dword,value)
183
184 #define ACPI_PLD_GET_OSPM_EJECT(dword)
185 #define ACPI_PLD_SET_OSPM_EJECT(dword,value)
186
187 #define ACPI_PLD_GET_CABINET(dword)
188 #define ACPI_PLD_SET_CABINET(dword,value)
189
190 #define ACPI_PLD_GET_CARD_CAGE(dword)
191 #define ACPI_PLD_SET_CARD_CAGE(dword,value)
192
193 #define ACPI_PLD_GET_REFERENCE(dword)
194 #define ACPI_PLD_SET_REFERENCE(dword,value)
195
196 #define ACPI_PLD_GET_ROTATION(dword)
197 #define ACPI_PLD_SET_ROTATION(dword,value)
198
199 #define ACPI_PLD_GET_ORDER(dword)
200 #define ACPI_PLD_SET_ORDER(dword,value)
201
202 /* Fifth 32-bit dword, bits 128:159 (Revision
203
204 #define ACPI_PLD_GET_VERT_OFFSET(dword)
205 #define ACPI_PLD_SET_VERT_OFFSET(dword,value)
206
207 #define ACPI_PLD_GET_HORIZ_OFFSET(dword)
208 #define ACPI_PLD_SET_HORIZ_OFFSET(dword,value)
209
210 /* Panel position defined in _PLD section of A
211
212 #define ACPI_PLD_PANEL_TOP 0
213 #define ACPI_PLD_PANEL_BOTTOM 1
214 #define ACPI_PLD_PANEL_LEFT 2
215 #define ACPI_PLD_PANEL_RIGHT 3
216 #define ACPI_PLD_PANEL_FRONT 4
217 #define ACPI_PLD_PANEL_BACK 5
218 #define ACPI_PLD_PANEL_UNKNOWN 6
219
220 #endif /* ACBUFFER_H
221
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.