xref: /dflybsd-src/sys/contrib/dev/acpica/source/components/executer/exserial.c (revision 4898bea4f8fa2e0c5362bfd557dbfc06cbe9106a)
1806343b9SSascha Wildner /******************************************************************************
2806343b9SSascha Wildner  *
3806343b9SSascha Wildner  * Module Name: exserial - FieldUnit support for serial address spaces
4806343b9SSascha Wildner  *
5806343b9SSascha Wildner  *****************************************************************************/
6806343b9SSascha Wildner 
7806343b9SSascha Wildner /******************************************************************************
8806343b9SSascha Wildner  *
9806343b9SSascha Wildner  * 1. Copyright Notice
10806343b9SSascha Wildner  *
11383048acSSascha Wildner  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12806343b9SSascha Wildner  * All rights reserved.
13806343b9SSascha Wildner  *
14806343b9SSascha Wildner  * 2. License
15806343b9SSascha Wildner  *
16806343b9SSascha Wildner  * 2.1. This is your license from Intel Corp. under its intellectual property
17806343b9SSascha Wildner  * rights. You may have additional license terms from the party that provided
18806343b9SSascha Wildner  * you this software, covering your right to use that party's intellectual
19806343b9SSascha Wildner  * property rights.
20806343b9SSascha Wildner  *
21806343b9SSascha Wildner  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22806343b9SSascha Wildner  * copy of the source code appearing in this file ("Covered Code") an
23806343b9SSascha Wildner  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24806343b9SSascha Wildner  * base code distributed originally by Intel ("Original Intel Code") to copy,
25806343b9SSascha Wildner  * make derivatives, distribute, use and display any portion of the Covered
26806343b9SSascha Wildner  * Code in any form, with the right to sublicense such rights; and
27806343b9SSascha Wildner  *
28806343b9SSascha Wildner  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29806343b9SSascha Wildner  * license (with the right to sublicense), under only those claims of Intel
30806343b9SSascha Wildner  * patents that are infringed by the Original Intel Code, to make, use, sell,
31806343b9SSascha Wildner  * offer to sell, and import the Covered Code and derivative works thereof
32806343b9SSascha Wildner  * solely to the minimum extent necessary to exercise the above copyright
33806343b9SSascha Wildner  * license, and in no event shall the patent license extend to any additions
34806343b9SSascha Wildner  * to or modifications of the Original Intel Code. No other license or right
35806343b9SSascha Wildner  * is granted directly or by implication, estoppel or otherwise;
36806343b9SSascha Wildner  *
37806343b9SSascha Wildner  * The above copyright and patent license is granted only if the following
38806343b9SSascha Wildner  * conditions are met:
39806343b9SSascha Wildner  *
40806343b9SSascha Wildner  * 3. Conditions
41806343b9SSascha Wildner  *
42806343b9SSascha Wildner  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43806343b9SSascha Wildner  * Redistribution of source code of any substantial portion of the Covered
44806343b9SSascha Wildner  * Code or modification with rights to further distribute source must include
45806343b9SSascha Wildner  * the above Copyright Notice, the above License, this list of Conditions,
46806343b9SSascha Wildner  * and the following Disclaimer and Export Compliance provision. In addition,
47806343b9SSascha Wildner  * Licensee must cause all Covered Code to which Licensee contributes to
48806343b9SSascha Wildner  * contain a file documenting the changes Licensee made to create that Covered
49806343b9SSascha Wildner  * Code and the date of any change. Licensee must include in that file the
50806343b9SSascha Wildner  * documentation of any changes made by any predecessor Licensee. Licensee
51806343b9SSascha Wildner  * must include a prominent statement that the modification is derived,
52806343b9SSascha Wildner  * directly or indirectly, from Original Intel Code.
53806343b9SSascha Wildner  *
54806343b9SSascha Wildner  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55806343b9SSascha Wildner  * Redistribution of source code of any substantial portion of the Covered
56806343b9SSascha Wildner  * Code or modification without rights to further distribute source must
57806343b9SSascha Wildner  * include the following Disclaimer and Export Compliance provision in the
58806343b9SSascha Wildner  * documentation and/or other materials provided with distribution. In
59806343b9SSascha Wildner  * addition, Licensee may not authorize further sublicense of source of any
60806343b9SSascha Wildner  * portion of the Covered Code, and must include terms to the effect that the
61806343b9SSascha Wildner  * license from Licensee to its licensee is limited to the intellectual
62806343b9SSascha Wildner  * property embodied in the software Licensee provides to its licensee, and
63806343b9SSascha Wildner  * not to intellectual property embodied in modifications its licensee may
64806343b9SSascha Wildner  * make.
65806343b9SSascha Wildner  *
66806343b9SSascha Wildner  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67806343b9SSascha Wildner  * substantial portion of the Covered Code or modification must reproduce the
68806343b9SSascha Wildner  * above Copyright Notice, and the following Disclaimer and Export Compliance
69806343b9SSascha Wildner  * provision in the documentation and/or other materials provided with the
70806343b9SSascha Wildner  * distribution.
71806343b9SSascha Wildner  *
72806343b9SSascha Wildner  * 3.4. Intel retains all right, title, and interest in and to the Original
73806343b9SSascha Wildner  * Intel Code.
74806343b9SSascha Wildner  *
75806343b9SSascha Wildner  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76806343b9SSascha Wildner  * Intel shall be used in advertising or otherwise to promote the sale, use or
77806343b9SSascha Wildner  * other dealings in products derived from or relating to the Covered Code
78806343b9SSascha Wildner  * without prior written authorization from Intel.
79806343b9SSascha Wildner  *
80806343b9SSascha Wildner  * 4. Disclaimer and Export Compliance
81806343b9SSascha Wildner  *
82806343b9SSascha Wildner  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83806343b9SSascha Wildner  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84806343b9SSascha Wildner  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85806343b9SSascha Wildner  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86806343b9SSascha Wildner  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87806343b9SSascha Wildner  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88806343b9SSascha Wildner  * PARTICULAR PURPOSE.
89806343b9SSascha Wildner  *
90806343b9SSascha Wildner  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91806343b9SSascha Wildner  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92806343b9SSascha Wildner  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93806343b9SSascha Wildner  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94806343b9SSascha Wildner  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95806343b9SSascha Wildner  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96806343b9SSascha Wildner  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97806343b9SSascha Wildner  * LIMITED REMEDY.
98806343b9SSascha Wildner  *
99806343b9SSascha Wildner  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100806343b9SSascha Wildner  * software or system incorporating such software without first obtaining any
101806343b9SSascha Wildner  * required license or other approval from the U. S. Department of Commerce or
102806343b9SSascha Wildner  * any other agency or department of the United States Government. In the
103806343b9SSascha Wildner  * event Licensee exports any such software from the United States or
104806343b9SSascha Wildner  * re-exports any such software from a foreign destination, Licensee shall
105806343b9SSascha Wildner  * ensure that the distribution and export/re-export of the software is in
106806343b9SSascha Wildner  * compliance with all laws, regulations, orders, or other restrictions of the
107806343b9SSascha Wildner  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108806343b9SSascha Wildner  * any of its subsidiaries will export/re-export any technical data, process,
109806343b9SSascha Wildner  * software, or service, directly or indirectly, to any country for which the
110806343b9SSascha Wildner  * United States government or any agency thereof requires an export license,
111806343b9SSascha Wildner  * other governmental approval, or letter of assurance, without first obtaining
112806343b9SSascha Wildner  * such license, approval or letter.
113806343b9SSascha Wildner  *
114806343b9SSascha Wildner  *****************************************************************************
115806343b9SSascha Wildner  *
116806343b9SSascha Wildner  * Alternatively, you may choose to be licensed under the terms of the
117806343b9SSascha Wildner  * following license:
118806343b9SSascha Wildner  *
119806343b9SSascha Wildner  * Redistribution and use in source and binary forms, with or without
120806343b9SSascha Wildner  * modification, are permitted provided that the following conditions
121806343b9SSascha Wildner  * are met:
122806343b9SSascha Wildner  * 1. Redistributions of source code must retain the above copyright
123806343b9SSascha Wildner  *    notice, this list of conditions, and the following disclaimer,
124806343b9SSascha Wildner  *    without modification.
125806343b9SSascha Wildner  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126806343b9SSascha Wildner  *    substantially similar to the "NO WARRANTY" disclaimer below
127806343b9SSascha Wildner  *    ("Disclaimer") and any redistribution must be conditioned upon
128806343b9SSascha Wildner  *    including a substantially similar Disclaimer requirement for further
129806343b9SSascha Wildner  *    binary redistribution.
130806343b9SSascha Wildner  * 3. Neither the names of the above-listed copyright holders nor the names
131806343b9SSascha Wildner  *    of any contributors may be used to endorse or promote products derived
132806343b9SSascha Wildner  *    from this software without specific prior written permission.
133806343b9SSascha Wildner  *
134806343b9SSascha Wildner  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135806343b9SSascha Wildner  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136806343b9SSascha Wildner  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137806343b9SSascha Wildner  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138806343b9SSascha Wildner  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139806343b9SSascha Wildner  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140806343b9SSascha Wildner  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141806343b9SSascha Wildner  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142806343b9SSascha Wildner  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143806343b9SSascha Wildner  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144806343b9SSascha Wildner  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145806343b9SSascha Wildner  *
146806343b9SSascha Wildner  * Alternatively, you may choose to be licensed under the terms of the
147806343b9SSascha Wildner  * GNU General Public License ("GPL") version 2 as published by the Free
148806343b9SSascha Wildner  * Software Foundation.
149806343b9SSascha Wildner  *
150806343b9SSascha Wildner  *****************************************************************************/
151806343b9SSascha Wildner 
152806343b9SSascha Wildner #include "acpi.h"
153806343b9SSascha Wildner #include "accommon.h"
154806343b9SSascha Wildner #include "acdispat.h"
155806343b9SSascha Wildner #include "acinterp.h"
156806343b9SSascha Wildner #include "amlcode.h"
157806343b9SSascha Wildner 
158806343b9SSascha Wildner 
159806343b9SSascha Wildner #define _COMPONENT          ACPI_EXECUTER
160806343b9SSascha Wildner         ACPI_MODULE_NAME    ("exserial")
161806343b9SSascha Wildner 
162806343b9SSascha Wildner 
163806343b9SSascha Wildner /*******************************************************************************
164806343b9SSascha Wildner  *
165806343b9SSascha Wildner  * FUNCTION:    AcpiExReadGpio
166806343b9SSascha Wildner  *
167806343b9SSascha Wildner  * PARAMETERS:  ObjDesc             - The named field to read
16800ffa116SSascha Wildner  *              Buffer              - Where the return data is returned
169806343b9SSascha Wildner  *
170806343b9SSascha Wildner  * RETURN:      Status
171806343b9SSascha Wildner  *
172806343b9SSascha Wildner  * DESCRIPTION: Read from a named field that references a Generic Serial Bus
173806343b9SSascha Wildner  *              field
174806343b9SSascha Wildner  *
175806343b9SSascha Wildner  ******************************************************************************/
176806343b9SSascha Wildner 
177806343b9SSascha Wildner ACPI_STATUS
AcpiExReadGpio(ACPI_OPERAND_OBJECT * ObjDesc,void * Buffer)178806343b9SSascha Wildner AcpiExReadGpio (
179806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *ObjDesc,
180806343b9SSascha Wildner     void                    *Buffer)
181806343b9SSascha Wildner {
182806343b9SSascha Wildner     ACPI_STATUS             Status;
183806343b9SSascha Wildner 
184806343b9SSascha Wildner 
185806343b9SSascha Wildner     ACPI_FUNCTION_TRACE_PTR (ExReadGpio, ObjDesc);
186806343b9SSascha Wildner 
187806343b9SSascha Wildner 
188806343b9SSascha Wildner     /*
189806343b9SSascha Wildner      * For GPIO (GeneralPurposeIo), the Address will be the bit offset
190806343b9SSascha Wildner      * from the previous Connection() operator, making it effectively a
191806343b9SSascha Wildner      * pin number index. The BitLength is the length of the field, which
192806343b9SSascha Wildner      * is thus the number of pins.
193806343b9SSascha Wildner      */
194806343b9SSascha Wildner     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
195806343b9SSascha Wildner         "GPIO FieldRead [FROM]:  Pin %u Bits %u\n",
196806343b9SSascha Wildner         ObjDesc->Field.PinNumberIndex, ObjDesc->Field.BitLength));
197806343b9SSascha Wildner 
198806343b9SSascha Wildner     /* Lock entire transaction if requested */
199806343b9SSascha Wildner 
200806343b9SSascha Wildner     AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
201806343b9SSascha Wildner 
202806343b9SSascha Wildner     /* Perform the read */
203806343b9SSascha Wildner 
204806343b9SSascha Wildner     Status = AcpiExAccessRegion (
205806343b9SSascha Wildner         ObjDesc, 0, (UINT64 *) Buffer, ACPI_READ);
206806343b9SSascha Wildner 
207806343b9SSascha Wildner     AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
208806343b9SSascha Wildner     return_ACPI_STATUS (Status);
209806343b9SSascha Wildner }
210806343b9SSascha Wildner 
211806343b9SSascha Wildner 
212806343b9SSascha Wildner /*******************************************************************************
213806343b9SSascha Wildner  *
214806343b9SSascha Wildner  * FUNCTION:    AcpiExWriteGpio
215806343b9SSascha Wildner  *
216806343b9SSascha Wildner  * PARAMETERS:  SourceDesc          - Contains data to write. Expect to be
217806343b9SSascha Wildner  *                                    an Integer object.
218806343b9SSascha Wildner  *              ObjDesc             - The named field
219806343b9SSascha Wildner  *              ResultDesc          - Where the return value is returned, if any
220806343b9SSascha Wildner  *
221806343b9SSascha Wildner  * RETURN:      Status
222806343b9SSascha Wildner  *
223806343b9SSascha Wildner  * DESCRIPTION: Write to a named field that references a General Purpose I/O
224806343b9SSascha Wildner  *              field.
225806343b9SSascha Wildner  *
226806343b9SSascha Wildner  ******************************************************************************/
227806343b9SSascha Wildner 
228806343b9SSascha Wildner ACPI_STATUS
AcpiExWriteGpio(ACPI_OPERAND_OBJECT * SourceDesc,ACPI_OPERAND_OBJECT * ObjDesc,ACPI_OPERAND_OBJECT ** ReturnBuffer)229806343b9SSascha Wildner AcpiExWriteGpio (
230806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *SourceDesc,
231806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *ObjDesc,
232806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     **ReturnBuffer)
233806343b9SSascha Wildner {
234806343b9SSascha Wildner     ACPI_STATUS             Status;
235806343b9SSascha Wildner     void                    *Buffer;
236806343b9SSascha Wildner 
237806343b9SSascha Wildner 
238806343b9SSascha Wildner     ACPI_FUNCTION_TRACE_PTR (ExWriteGpio, ObjDesc);
239806343b9SSascha Wildner 
240806343b9SSascha Wildner 
241806343b9SSascha Wildner     /*
242806343b9SSascha Wildner      * For GPIO (GeneralPurposeIo), we will bypass the entire field
243806343b9SSascha Wildner      * mechanism and handoff the bit address and bit width directly to
244806343b9SSascha Wildner      * the handler. The Address will be the bit offset
245806343b9SSascha Wildner      * from the previous Connection() operator, making it effectively a
246806343b9SSascha Wildner      * pin number index. The BitLength is the length of the field, which
247806343b9SSascha Wildner      * is thus the number of pins.
248806343b9SSascha Wildner      */
249806343b9SSascha Wildner     if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
250806343b9SSascha Wildner     {
251806343b9SSascha Wildner         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
252806343b9SSascha Wildner     }
253806343b9SSascha Wildner 
254806343b9SSascha Wildner     ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
255806343b9SSascha Wildner         "GPIO FieldWrite [FROM]: (%s:%X), Value %.8X  [TO]: Pin %u Bits %u\n",
256806343b9SSascha Wildner         AcpiUtGetTypeName (SourceDesc->Common.Type),
257806343b9SSascha Wildner         SourceDesc->Common.Type, (UINT32) SourceDesc->Integer.Value,
258806343b9SSascha Wildner         ObjDesc->Field.PinNumberIndex, ObjDesc->Field.BitLength));
259806343b9SSascha Wildner 
260806343b9SSascha Wildner     Buffer = &SourceDesc->Integer.Value;
261806343b9SSascha Wildner 
262806343b9SSascha Wildner     /* Lock entire transaction if requested */
263806343b9SSascha Wildner 
264806343b9SSascha Wildner     AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
265806343b9SSascha Wildner 
266806343b9SSascha Wildner     /* Perform the write */
267806343b9SSascha Wildner 
268806343b9SSascha Wildner     Status = AcpiExAccessRegion (
269806343b9SSascha Wildner         ObjDesc, 0, (UINT64 *) Buffer, ACPI_WRITE);
270806343b9SSascha Wildner     AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
271806343b9SSascha Wildner     return_ACPI_STATUS (Status);
272806343b9SSascha Wildner }
273806343b9SSascha Wildner 
274806343b9SSascha Wildner 
275806343b9SSascha Wildner /*******************************************************************************
276806343b9SSascha Wildner  *
277806343b9SSascha Wildner  * FUNCTION:    AcpiExReadSerialBus
278806343b9SSascha Wildner  *
279806343b9SSascha Wildner  * PARAMETERS:  ObjDesc             - The named field to read
280806343b9SSascha Wildner  *              ReturnBuffer        - Where the return value is returned, if any
281806343b9SSascha Wildner  *
282806343b9SSascha Wildner  * RETURN:      Status
283806343b9SSascha Wildner  *
284806343b9SSascha Wildner  * DESCRIPTION: Read from a named field that references a serial bus
285806343b9SSascha Wildner  *              (SMBus, IPMI, or GSBus).
286806343b9SSascha Wildner  *
287806343b9SSascha Wildner  ******************************************************************************/
288806343b9SSascha Wildner 
289806343b9SSascha Wildner ACPI_STATUS
AcpiExReadSerialBus(ACPI_OPERAND_OBJECT * ObjDesc,ACPI_OPERAND_OBJECT ** ReturnBuffer)290806343b9SSascha Wildner AcpiExReadSerialBus (
291806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *ObjDesc,
292806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     **ReturnBuffer)
293806343b9SSascha Wildner {
294806343b9SSascha Wildner     ACPI_STATUS             Status;
295806343b9SSascha Wildner     UINT32                  BufferLength;
296806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *BufferDesc;
297806343b9SSascha Wildner     UINT32                  Function;
298806343b9SSascha Wildner     UINT16                  AccessorType;
299806343b9SSascha Wildner 
300806343b9SSascha Wildner 
301806343b9SSascha Wildner     ACPI_FUNCTION_TRACE_PTR (ExReadSerialBus, ObjDesc);
302806343b9SSascha Wildner 
303806343b9SSascha Wildner 
304806343b9SSascha Wildner     /*
305806343b9SSascha Wildner      * This is an SMBus, GSBus or IPMI read. We must create a buffer to
306806343b9SSascha Wildner      * hold the data and then directly access the region handler.
307806343b9SSascha Wildner      *
308806343b9SSascha Wildner      * Note: SMBus and GSBus protocol value is passed in upper 16-bits
309806343b9SSascha Wildner      * of Function
310806343b9SSascha Wildner      *
311806343b9SSascha Wildner      * Common buffer format:
312806343b9SSascha Wildner      *     Status;    (Byte 0 of the data buffer)
313806343b9SSascha Wildner      *     Length;    (Byte 1 of the data buffer)
314806343b9SSascha Wildner      *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
315806343b9SSascha Wildner      */
316806343b9SSascha Wildner     switch (ObjDesc->Field.RegionObj->Region.SpaceId)
317806343b9SSascha Wildner     {
318806343b9SSascha Wildner     case ACPI_ADR_SPACE_SMBUS:
319806343b9SSascha Wildner 
320806343b9SSascha Wildner         BufferLength = ACPI_SMBUS_BUFFER_SIZE;
321806343b9SSascha Wildner         Function = ACPI_READ | (ObjDesc->Field.Attribute << 16);
322806343b9SSascha Wildner         break;
323806343b9SSascha Wildner 
324806343b9SSascha Wildner     case ACPI_ADR_SPACE_IPMI:
325806343b9SSascha Wildner 
326806343b9SSascha Wildner         BufferLength = ACPI_IPMI_BUFFER_SIZE;
327806343b9SSascha Wildner         Function = ACPI_READ;
328806343b9SSascha Wildner         break;
329806343b9SSascha Wildner 
330806343b9SSascha Wildner     case ACPI_ADR_SPACE_GSBUS:
331806343b9SSascha Wildner 
332806343b9SSascha Wildner         AccessorType = ObjDesc->Field.Attribute;
333806343b9SSascha Wildner         if (AccessorType == AML_FIELD_ATTRIB_RAW_PROCESS_BYTES)
334806343b9SSascha Wildner         {
335806343b9SSascha Wildner             ACPI_ERROR ((AE_INFO,
336806343b9SSascha Wildner                 "Invalid direct read using bidirectional write-then-read protocol"));
337806343b9SSascha Wildner 
338806343b9SSascha Wildner             return_ACPI_STATUS (AE_AML_PROTOCOL);
339806343b9SSascha Wildner         }
340806343b9SSascha Wildner 
341806343b9SSascha Wildner         Status = AcpiExGetProtocolBufferLength (AccessorType, &BufferLength);
342806343b9SSascha Wildner         if (ACPI_FAILURE (Status))
343806343b9SSascha Wildner         {
344806343b9SSascha Wildner             ACPI_ERROR ((AE_INFO,
345806343b9SSascha Wildner                 "Invalid protocol ID for GSBus: 0x%4.4X", AccessorType));
346806343b9SSascha Wildner 
347806343b9SSascha Wildner             return_ACPI_STATUS (Status);
348806343b9SSascha Wildner         }
349806343b9SSascha Wildner 
350806343b9SSascha Wildner         /* Add header length to get the full size of the buffer */
351806343b9SSascha Wildner 
352806343b9SSascha Wildner         BufferLength += ACPI_SERIAL_HEADER_SIZE;
353806343b9SSascha Wildner         Function = ACPI_READ | (AccessorType << 16);
354806343b9SSascha Wildner         break;
355806343b9SSascha Wildner 
356*4898bea4SSascha Wildner     case ACPI_ADR_SPACE_PLATFORM_RT:
357*4898bea4SSascha Wildner 
358*4898bea4SSascha Wildner         BufferLength = ACPI_PRM_INPUT_BUFFER_SIZE;
359*4898bea4SSascha Wildner         Function = ACPI_READ;
360*4898bea4SSascha Wildner         break;
361*4898bea4SSascha Wildner 
362806343b9SSascha Wildner     default:
363806343b9SSascha Wildner         return_ACPI_STATUS (AE_AML_INVALID_SPACE_ID);
364806343b9SSascha Wildner     }
365806343b9SSascha Wildner 
366806343b9SSascha Wildner     /* Create the local transfer buffer that is returned to the caller */
367806343b9SSascha Wildner 
368806343b9SSascha Wildner     BufferDesc = AcpiUtCreateBufferObject (BufferLength);
369806343b9SSascha Wildner     if (!BufferDesc)
370806343b9SSascha Wildner     {
371806343b9SSascha Wildner         return_ACPI_STATUS (AE_NO_MEMORY);
372806343b9SSascha Wildner     }
373806343b9SSascha Wildner 
374806343b9SSascha Wildner     /* Lock entire transaction if requested */
375806343b9SSascha Wildner 
376806343b9SSascha Wildner     AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
377806343b9SSascha Wildner 
378806343b9SSascha Wildner     /* Call the region handler for the write-then-read */
379806343b9SSascha Wildner 
380806343b9SSascha Wildner     Status = AcpiExAccessRegion (ObjDesc, 0,
381806343b9SSascha Wildner         ACPI_CAST_PTR (UINT64, BufferDesc->Buffer.Pointer), Function);
382806343b9SSascha Wildner     AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
383806343b9SSascha Wildner 
384806343b9SSascha Wildner     *ReturnBuffer = BufferDesc;
385806343b9SSascha Wildner     return_ACPI_STATUS (Status);
386806343b9SSascha Wildner }
387806343b9SSascha Wildner 
388806343b9SSascha Wildner 
389806343b9SSascha Wildner /*******************************************************************************
390806343b9SSascha Wildner  *
391806343b9SSascha Wildner  * FUNCTION:    AcpiExWriteSerialBus
392806343b9SSascha Wildner  *
393806343b9SSascha Wildner  * PARAMETERS:  SourceDesc          - Contains data to write
394806343b9SSascha Wildner  *              ObjDesc             - The named field
395806343b9SSascha Wildner  *              ReturnBuffer        - Where the return value is returned, if any
396806343b9SSascha Wildner  *
397806343b9SSascha Wildner  * RETURN:      Status
398806343b9SSascha Wildner  *
399806343b9SSascha Wildner  * DESCRIPTION: Write to a named field that references a serial bus
400806343b9SSascha Wildner  *              (SMBus, IPMI, GSBus).
401806343b9SSascha Wildner  *
402806343b9SSascha Wildner  ******************************************************************************/
403806343b9SSascha Wildner 
404806343b9SSascha Wildner ACPI_STATUS
AcpiExWriteSerialBus(ACPI_OPERAND_OBJECT * SourceDesc,ACPI_OPERAND_OBJECT * ObjDesc,ACPI_OPERAND_OBJECT ** ReturnBuffer)405806343b9SSascha Wildner AcpiExWriteSerialBus (
406806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *SourceDesc,
407806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *ObjDesc,
408806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     **ReturnBuffer)
409806343b9SSascha Wildner {
410806343b9SSascha Wildner     ACPI_STATUS             Status;
411806343b9SSascha Wildner     UINT32                  BufferLength;
412806343b9SSascha Wildner     UINT32                  DataLength;
413806343b9SSascha Wildner     void                    *Buffer;
414806343b9SSascha Wildner     ACPI_OPERAND_OBJECT     *BufferDesc;
415806343b9SSascha Wildner     UINT32                  Function;
416806343b9SSascha Wildner     UINT16                  AccessorType;
417806343b9SSascha Wildner 
418806343b9SSascha Wildner 
419806343b9SSascha Wildner     ACPI_FUNCTION_TRACE_PTR (ExWriteSerialBus, ObjDesc);
420806343b9SSascha Wildner 
421806343b9SSascha Wildner 
422806343b9SSascha Wildner     /*
423806343b9SSascha Wildner      * This is an SMBus, GSBus or IPMI write. We will bypass the entire
424806343b9SSascha Wildner      * field mechanism and handoff the buffer directly to the handler.
425806343b9SSascha Wildner      * For these address spaces, the buffer is bidirectional; on a
426806343b9SSascha Wildner      * write, return data is returned in the same buffer.
427806343b9SSascha Wildner      *
428806343b9SSascha Wildner      * Source must be a buffer of sufficient size, these are fixed size:
429806343b9SSascha Wildner      * ACPI_SMBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE.
430806343b9SSascha Wildner      *
431806343b9SSascha Wildner      * Note: SMBus and GSBus protocol type is passed in upper 16-bits
432806343b9SSascha Wildner      * of Function
433806343b9SSascha Wildner      *
434806343b9SSascha Wildner      * Common buffer format:
435806343b9SSascha Wildner      *     Status;    (Byte 0 of the data buffer)
436806343b9SSascha Wildner      *     Length;    (Byte 1 of the data buffer)
437806343b9SSascha Wildner      *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
438806343b9SSascha Wildner      */
439806343b9SSascha Wildner     if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
440806343b9SSascha Wildner     {
441806343b9SSascha Wildner         ACPI_ERROR ((AE_INFO,
442806343b9SSascha Wildner             "SMBus/IPMI/GenericSerialBus write requires "
443806343b9SSascha Wildner             "Buffer, found type %s",
444806343b9SSascha Wildner             AcpiUtGetObjectTypeName (SourceDesc)));
445806343b9SSascha Wildner 
446806343b9SSascha Wildner         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
447806343b9SSascha Wildner     }
448806343b9SSascha Wildner 
449806343b9SSascha Wildner     switch (ObjDesc->Field.RegionObj->Region.SpaceId)
450806343b9SSascha Wildner     {
451806343b9SSascha Wildner     case ACPI_ADR_SPACE_SMBUS:
452806343b9SSascha Wildner 
453806343b9SSascha Wildner         BufferLength = ACPI_SMBUS_BUFFER_SIZE;
454806343b9SSascha Wildner         Function = ACPI_WRITE | (ObjDesc->Field.Attribute << 16);
455806343b9SSascha Wildner         break;
456806343b9SSascha Wildner 
457806343b9SSascha Wildner     case ACPI_ADR_SPACE_IPMI:
458806343b9SSascha Wildner 
459806343b9SSascha Wildner         BufferLength = ACPI_IPMI_BUFFER_SIZE;
460806343b9SSascha Wildner         Function = ACPI_WRITE;
461806343b9SSascha Wildner         break;
462806343b9SSascha Wildner 
463806343b9SSascha Wildner     case ACPI_ADR_SPACE_GSBUS:
464806343b9SSascha Wildner 
465806343b9SSascha Wildner         AccessorType = ObjDesc->Field.Attribute;
466806343b9SSascha Wildner         Status = AcpiExGetProtocolBufferLength (AccessorType, &BufferLength);
467806343b9SSascha Wildner         if (ACPI_FAILURE (Status))
468806343b9SSascha Wildner         {
469806343b9SSascha Wildner             ACPI_ERROR ((AE_INFO,
470806343b9SSascha Wildner                 "Invalid protocol ID for GSBus: 0x%4.4X", AccessorType));
471806343b9SSascha Wildner 
472806343b9SSascha Wildner             return_ACPI_STATUS (Status);
473806343b9SSascha Wildner         }
474806343b9SSascha Wildner 
475806343b9SSascha Wildner         /* Add header length to get the full size of the buffer */
476806343b9SSascha Wildner 
477806343b9SSascha Wildner         BufferLength += ACPI_SERIAL_HEADER_SIZE;
478806343b9SSascha Wildner         Function = ACPI_WRITE | (AccessorType << 16);
479806343b9SSascha Wildner         break;
480806343b9SSascha Wildner 
481*4898bea4SSascha Wildner     case ACPI_ADR_SPACE_PLATFORM_RT:
482*4898bea4SSascha Wildner 
483*4898bea4SSascha Wildner         BufferLength = ACPI_PRM_INPUT_BUFFER_SIZE;
484*4898bea4SSascha Wildner         Function = ACPI_WRITE;
485*4898bea4SSascha Wildner         break;
486*4898bea4SSascha Wildner 
487806343b9SSascha Wildner     default:
488806343b9SSascha Wildner         return_ACPI_STATUS (AE_AML_INVALID_SPACE_ID);
489806343b9SSascha Wildner     }
490806343b9SSascha Wildner 
491806343b9SSascha Wildner     /* Create the transfer/bidirectional/return buffer */
492806343b9SSascha Wildner 
493806343b9SSascha Wildner     BufferDesc = AcpiUtCreateBufferObject (BufferLength);
494806343b9SSascha Wildner     if (!BufferDesc)
495806343b9SSascha Wildner     {
496806343b9SSascha Wildner         return_ACPI_STATUS (AE_NO_MEMORY);
497806343b9SSascha Wildner     }
498806343b9SSascha Wildner 
499806343b9SSascha Wildner     /* Copy the input buffer data to the transfer buffer */
500806343b9SSascha Wildner 
501806343b9SSascha Wildner     Buffer = BufferDesc->Buffer.Pointer;
502ef944814SSascha Wildner     DataLength = (BufferLength < SourceDesc->Buffer.Length ?
503ef944814SSascha Wildner         BufferLength : SourceDesc->Buffer.Length);
504806343b9SSascha Wildner     memcpy (Buffer, SourceDesc->Buffer.Pointer, DataLength);
505806343b9SSascha Wildner 
506806343b9SSascha Wildner     /* Lock entire transaction if requested */
507806343b9SSascha Wildner 
508806343b9SSascha Wildner     AcpiExAcquireGlobalLock (ObjDesc->CommonField.FieldFlags);
509806343b9SSascha Wildner 
510806343b9SSascha Wildner     /*
511806343b9SSascha Wildner      * Perform the write (returns status and perhaps data in the
512806343b9SSascha Wildner      * same buffer)
513806343b9SSascha Wildner      */
514806343b9SSascha Wildner     Status = AcpiExAccessRegion (
515806343b9SSascha Wildner         ObjDesc, 0, (UINT64 *) Buffer, Function);
516806343b9SSascha Wildner     AcpiExReleaseGlobalLock (ObjDesc->CommonField.FieldFlags);
517806343b9SSascha Wildner 
518806343b9SSascha Wildner     *ReturnBuffer = BufferDesc;
519806343b9SSascha Wildner     return_ACPI_STATUS (Status);
520806343b9SSascha Wildner }
521