[linux.git] / drivers / acpi / acpica / exserial.c

// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
/******************************************************************************
 *
 * Module Name: exserial - field_unit support for serial address spaces
 *
 * Copyright (C) 2000 - 2018, Intel Corp.
 *
 *****************************************************************************/

#include <acpi/acpi.h>
#include "accommon.h"
#include "acdispat.h"
#include "acinterp.h"
#include "amlcode.h"

#define _COMPONENT          ACPI_EXECUTER
ACPI_MODULE_NAME("exserial")

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_read_gpio
 *
 * PARAMETERS:  obj_desc            - The named field to read
 *              buffer              - Where the return data is returnd
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Read from a named field that references a Generic Serial Bus
 *              field
 *
 ******************************************************************************/
acpi_status acpi_ex_read_gpio(union acpi_operand_object *obj_desc, void *buffer)
{
	acpi_status status;

	ACPI_FUNCTION_TRACE_PTR(ex_read_gpio, obj_desc);

	/*
	 * For GPIO (general_purpose_io), the Address will be the bit offset
	 * from the previous Connection() operator, making it effectively a
	 * pin number index. The bit_length is the length of the field, which
	 * is thus the number of pins.
	 */
	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "GPIO FieldRead [FROM]:  Pin %u Bits %u\n",
			  obj_desc->field.pin_number_index,
			  obj_desc->field.bit_length));

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/* Perform the read */

	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, ACPI_READ);

	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
	return_ACPI_STATUS(status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_write_gpio
 *
 * PARAMETERS:  source_desc         - Contains data to write. Expect to be
 *                                    an Integer object.
 *              obj_desc            - The named field
 *              result_desc         - Where the return value is returned, if any
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Write to a named field that references a General Purpose I/O
 *              field.
 *
 ******************************************************************************/

acpi_status
acpi_ex_write_gpio(union acpi_operand_object *source_desc,
		   union acpi_operand_object *obj_desc,
		   union acpi_operand_object **return_buffer)
{
	acpi_status status;
	void *buffer;

	ACPI_FUNCTION_TRACE_PTR(ex_write_gpio, obj_desc);

	/*
	 * For GPIO (general_purpose_io), we will bypass the entire field
	 * mechanism and handoff the bit address and bit width directly to
	 * the handler. The Address will be the bit offset
	 * from the previous Connection() operator, making it effectively a
	 * pin number index. The bit_length is the length of the field, which
	 * is thus the number of pins.
	 */
	if (source_desc->common.type != ACPI_TYPE_INTEGER) {
		return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "GPIO FieldWrite [FROM]: (%s:%X), Value %.8X  [TO]: Pin %u Bits %u\n",
			  acpi_ut_get_type_name(source_desc->common.type),
			  source_desc->common.type,
			  (u32)source_desc->integer.value,
			  obj_desc->field.pin_number_index,
			  obj_desc->field.bit_length));

	buffer = &source_desc->integer.value;

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/* Perform the write */

	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, ACPI_WRITE);
	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
	return_ACPI_STATUS(status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_read_serial_bus
 *
 * PARAMETERS:  obj_desc            - The named field to read
 *              return_buffer       - Where the return value is returned, if any
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Read from a named field that references a serial bus
 *              (SMBus, IPMI, or GSBus).
 *
 ******************************************************************************/

acpi_status
acpi_ex_read_serial_bus(union acpi_operand_object *obj_desc,
			union acpi_operand_object **return_buffer)
{
	acpi_status status;
	u32 buffer_length;
	union acpi_operand_object *buffer_desc;
	u32 function;
	u16 accessor_type;

	ACPI_FUNCTION_TRACE_PTR(ex_read_serial_bus, obj_desc);

	/*
	 * This is an SMBus, GSBus or IPMI read. We must create a buffer to
	 * hold the data and then directly access the region handler.
	 *
	 * Note: SMBus and GSBus protocol value is passed in upper 16-bits
	 * of Function
	 *
	 * Common buffer format:
	 *     Status;    (Byte 0 of the data buffer)
	 *     Length;    (Byte 1 of the data buffer)
	 *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
	 */
	switch (obj_desc->field.region_obj->region.space_id) {
	case ACPI_ADR_SPACE_SMBUS:

		buffer_length = ACPI_SMBUS_BUFFER_SIZE;
		function = ACPI_READ | (obj_desc->field.attribute << 16);
		break;

	case ACPI_ADR_SPACE_IPMI:

		buffer_length = ACPI_IPMI_BUFFER_SIZE;
		function = ACPI_READ;
		break;

	case ACPI_ADR_SPACE_GSBUS:

		accessor_type = obj_desc->field.attribute;
		if (accessor_type == AML_FIELD_ATTRIB_RAW_PROCESS_BYTES) {
			ACPI_ERROR((AE_INFO,
				    "Invalid direct read using bidirectional write-then-read protocol"));

			return_ACPI_STATUS(AE_AML_PROTOCOL);
		}

		status =
		    acpi_ex_get_protocol_buffer_length(accessor_type,
						       &buffer_length);
		if (ACPI_FAILURE(status)) {
			ACPI_ERROR((AE_INFO,
				    "Invalid protocol ID for GSBus: 0x%4.4X",
				    accessor_type));

			return_ACPI_STATUS(status);
		}

		/* Add header length to get the full size of the buffer */

		buffer_length += ACPI_SERIAL_HEADER_SIZE;
		function = ACPI_READ | (accessor_type << 16);
		break;

	default:
		return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
	}

	/* Create the local transfer buffer that is returned to the caller */

	buffer_desc = acpi_ut_create_buffer_object(buffer_length);
	if (!buffer_desc) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/* Call the region handler for the write-then-read */

	status = acpi_ex_access_region(obj_desc, 0,
				       ACPI_CAST_PTR(u64,
						     buffer_desc->buffer.
						     pointer), function);
	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);

	*return_buffer = buffer_desc;
	return_ACPI_STATUS(status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_write_serial_bus
 *
 * PARAMETERS:  source_desc         - Contains data to write
 *              obj_desc            - The named field
 *              return_buffer       - Where the return value is returned, if any
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Write to a named field that references a serial bus
 *              (SMBus, IPMI, GSBus).
 *
 ******************************************************************************/

acpi_status
acpi_ex_write_serial_bus(union acpi_operand_object *source_desc,
			 union acpi_operand_object *obj_desc,
			 union acpi_operand_object **return_buffer)
{
	acpi_status status;
	u32 buffer_length;
	void *buffer;
	union acpi_operand_object *buffer_desc;
	u32 function;
	u16 accessor_type;

	ACPI_FUNCTION_TRACE_PTR(ex_write_serial_bus, obj_desc);

	/*
	 * This is an SMBus, GSBus or IPMI write. We will bypass the entire
	 * field mechanism and handoff the buffer directly to the handler.
	 * For these address spaces, the buffer is bidirectional; on a
	 * write, return data is returned in the same buffer.
	 *
	 * Source must be a buffer of sufficient size, these are fixed size:
	 * ACPI_SMBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE.
	 *
	 * Note: SMBus and GSBus protocol type is passed in upper 16-bits
	 * of Function
	 *
	 * Common buffer format:
	 *     Status;    (Byte 0 of the data buffer)
	 *     Length;    (Byte 1 of the data buffer)
	 *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
	 */
	if (source_desc->common.type != ACPI_TYPE_BUFFER) {
		ACPI_ERROR((AE_INFO,
			    "SMBus/IPMI/GenericSerialBus write requires "
			    "Buffer, found type %s",
			    acpi_ut_get_object_type_name(source_desc)));

		return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
	}

	switch (obj_desc->field.region_obj->region.space_id) {
	case ACPI_ADR_SPACE_SMBUS:

		buffer_length = ACPI_SMBUS_BUFFER_SIZE;
		function = ACPI_WRITE | (obj_desc->field.attribute << 16);
		break;

	case ACPI_ADR_SPACE_IPMI:

		buffer_length = ACPI_IPMI_BUFFER_SIZE;
		function = ACPI_WRITE;
		break;

	case ACPI_ADR_SPACE_GSBUS:

		accessor_type = obj_desc->field.attribute;
		status =
		    acpi_ex_get_protocol_buffer_length(accessor_type,
						       &buffer_length);
		if (ACPI_FAILURE(status)) {
			ACPI_ERROR((AE_INFO,
				    "Invalid protocol ID for GSBus: 0x%4.4X",
				    accessor_type));

			return_ACPI_STATUS(status);
		}

		/* Add header length to get the full size of the buffer */

		buffer_length += ACPI_SERIAL_HEADER_SIZE;
		function = ACPI_WRITE | (accessor_type << 16);
		break;

	default:
		return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
	}

	/* Create the transfer/bidirectional/return buffer */

	buffer_desc = acpi_ut_create_buffer_object(buffer_length);
	if (!buffer_desc) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	/* Copy the input buffer data to the transfer buffer */

	buffer = buffer_desc->buffer.pointer;
	memcpy(buffer, source_desc->buffer.pointer,
	       min(buffer_length, source_desc->buffer.length));

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/*
	 * Perform the write (returns status and perhaps data in the
	 * same buffer)
	 */
	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, function);
	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);

	*return_buffer = buffer_desc;
	return_ACPI_STATUS(status);
}
Commit	Line	Data
9e9f8733 BM	1	// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
	2	/******************************************************************************
	3	*
	4	* Module Name: exserial - field_unit support for serial address spaces
	5	*
	6	* Copyright (C) 2000 - 2018, Intel Corp.
	7	*
	8	*****************************************************************************/
	9
	10	#include <acpi/acpi.h>
	11	#include "accommon.h"
	12	#include "acdispat.h"
	13	#include "acinterp.h"
	14	#include "amlcode.h"
	15
	16	#define _COMPONENT ACPI_EXECUTER
	17	ACPI_MODULE_NAME("exserial")
	18
	19	/*******************************************************************************
	20	*
	21	* FUNCTION: acpi_ex_read_gpio
	22	*
	23	* PARAMETERS: obj_desc - The named field to read
	24	* buffer - Where the return data is returnd
	25	*
	26	* RETURN: Status
	27	*
	28	* DESCRIPTION: Read from a named field that references a Generic Serial Bus
	29	* field
	30	*
	31	******************************************************************************/
	32	acpi_status acpi_ex_read_gpio(union acpi_operand_object obj_desc, void buffer)
	33	{
	34	acpi_status status;
	35
	36	ACPI_FUNCTION_TRACE_PTR(ex_read_gpio, obj_desc);
	37
	38	/*
	39	* For GPIO (general_purpose_io), the Address will be the bit offset
	40	* from the previous Connection() operator, making it effectively a
	41	* pin number index. The bit_length is the length of the field, which
	42	* is thus the number of pins.
	43	*/
	44	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
	45	"GPIO FieldRead [FROM]: Pin %u Bits %u\n",
	46	obj_desc->field.pin_number_index,
	47	obj_desc->field.bit_length));
	48
	49	/* Lock entire transaction if requested */
	50
	51	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
	52
	53	/* Perform the read */
	54
	55	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, ACPI_READ);
	56
	57	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
	58	return_ACPI_STATUS(status);
	59	}
	60
	61	/*******************************************************************************
	62	*
	63	* FUNCTION: acpi_ex_write_gpio
	64	*
65	* PARAMETERS: source_desc - Contains data to write. Expect to be
66	* an Integer object.
67	* obj_desc - The named field
68	* result_desc - Where the return value is returned, if any
69	*
70	* RETURN: Status
71	*
72	* DESCRIPTION: Write to a named field that references a General Purpose I/O
73	* field.
74	*
75	******************************************************************************/
76
77	acpi_status
78	acpi_ex_write_gpio(union acpi_operand_object *source_desc,
79	union acpi_operand_object *obj_desc,
80	union acpi_operand_object **return_buffer)
81	{
82	acpi_status status;
83	void *buffer;
84
85	ACPI_FUNCTION_TRACE_PTR(ex_write_gpio, obj_desc);
86
87	/*
88	* For GPIO (general_purpose_io), we will bypass the entire field
89	* mechanism and handoff the bit address and bit width directly to
90	* the handler. The Address will be the bit offset
91	* from the previous Connection() operator, making it effectively a
92	* pin number index. The bit_length is the length of the field, which
93	* is thus the number of pins.
94	*/
95	if (source_desc->common.type != ACPI_TYPE_INTEGER) {
96	return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
97	}
98
99	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
100	"GPIO FieldWrite [FROM]: (%s:%X), Value %.8X [TO]: Pin %u Bits %u\n",
101	acpi_ut_get_type_name(source_desc->common.type),
102	source_desc->common.type,
103	(u32)source_desc->integer.value,
104	obj_desc->field.pin_number_index,
105	obj_desc->field.bit_length));
106
107	buffer = &source_desc->integer.value;
108
109	/* Lock entire transaction if requested */
110
111	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
112
113	/* Perform the write */
114
115	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, ACPI_WRITE);
116	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
117	return_ACPI_STATUS(status);
118	}
119
120	/*******************************************************************************
121	*
122	* FUNCTION: acpi_ex_read_serial_bus
123	*
124	* PARAMETERS: obj_desc - The named field to read
125	* return_buffer - Where the return value is returned, if any
126	*
127	* RETURN: Status
128	*
129	* DESCRIPTION: Read from a named field that references a serial bus
130	* (SMBus, IPMI, or GSBus).
131	*
132	******************************************************************************/
133
134	acpi_status
135	acpi_ex_read_serial_bus(union acpi_operand_object *obj_desc,
136	union acpi_operand_object **return_buffer)
137	{
138	acpi_status status;
139	u32 buffer_length;
140	union acpi_operand_object *buffer_desc;
141	u32 function;
142	u16 accessor_type;
143
144	ACPI_FUNCTION_TRACE_PTR(ex_read_serial_bus, obj_desc);
145
146	/*
147	* This is an SMBus, GSBus or IPMI read. We must create a buffer to
148	* hold the data and then directly access the region handler.
149	*
150	* Note: SMBus and GSBus protocol value is passed in upper 16-bits
151	* of Function
152	*
153	* Common buffer format:
154	* Status; (Byte 0 of the data buffer)
155	* Length; (Byte 1 of the data buffer)
156	* Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
157	*/
158	switch (obj_desc->field.region_obj->region.space_id) {
159	case ACPI_ADR_SPACE_SMBUS:
160
161	buffer_length = ACPI_SMBUS_BUFFER_SIZE;
162	function = ACPI_READ \| (obj_desc->field.attribute << 16);
163	break;
164
165	case ACPI_ADR_SPACE_IPMI:
166
167	buffer_length = ACPI_IPMI_BUFFER_SIZE;
168	function = ACPI_READ;
169	break;
170
171	case ACPI_ADR_SPACE_GSBUS:
172
173	accessor_type = obj_desc->field.attribute;
174	if (accessor_type == AML_FIELD_ATTRIB_RAW_PROCESS_BYTES) {
175	ACPI_ERROR((AE_INFO,
176	"Invalid direct read using bidirectional write-then-read protocol"));
177
178	return_ACPI_STATUS(AE_AML_PROTOCOL);
179	}
180
181	status =
182	acpi_ex_get_protocol_buffer_length(accessor_type,
183	&buffer_length);
184	if (ACPI_FAILURE(status)) {
185	ACPI_ERROR((AE_INFO,
186	"Invalid protocol ID for GSBus: 0x%4.4X",
187	accessor_type));
188
189	return_ACPI_STATUS(status);
190	}
191
192	/* Add header length to get the full size of the buffer */
193
194	buffer_length += ACPI_SERIAL_HEADER_SIZE;
195	function = ACPI_READ \| (accessor_type << 16);
196	break;
197
198	default:
199	return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
200	}
201
202	/* Create the local transfer buffer that is returned to the caller */
203
204	buffer_desc = acpi_ut_create_buffer_object(buffer_length);
205	if (!buffer_desc) {
206	return_ACPI_STATUS(AE_NO_MEMORY);
207	}
208
209	/* Lock entire transaction if requested */
210
211	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
212
213	/* Call the region handler for the write-then-read */
214
215	status = acpi_ex_access_region(obj_desc, 0,
216	ACPI_CAST_PTR(u64,
217	buffer_desc->buffer.
218	pointer), function);
219	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
220
221	*return_buffer = buffer_desc;
222	return_ACPI_STATUS(status);
223	}
224
225	/*******************************************************************************
226	*
227	* FUNCTION: acpi_ex_write_serial_bus
228	*
229	* PARAMETERS: source_desc - Contains data to write
230	* obj_desc - The named field
231	* return_buffer - Where the return value is returned, if any
232	*
233	* RETURN: Status
234	*
235	* DESCRIPTION: Write to a named field that references a serial bus
236	* (SMBus, IPMI, GSBus).
237	*
238	******************************************************************************/
239
240	acpi_status
241	acpi_ex_write_serial_bus(union acpi_operand_object *source_desc,
242	union acpi_operand_object *obj_desc,
243	union acpi_operand_object **return_buffer)
244	{
245	acpi_status status;
246	u32 buffer_length;
9e9f8733 BM	247	void *buffer;
	248	union acpi_operand_object *buffer_desc;
	249	u32 function;
	250	u16 accessor_type;
	251
	252	ACPI_FUNCTION_TRACE_PTR(ex_write_serial_bus, obj_desc);
	253
	254	/*
	255	* This is an SMBus, GSBus or IPMI write. We will bypass the entire
	256	* field mechanism and handoff the buffer directly to the handler.
	257	* For these address spaces, the buffer is bidirectional; on a
	258	* write, return data is returned in the same buffer.
	259	*
	260	* Source must be a buffer of sufficient size, these are fixed size:
	261	* ACPI_SMBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE.
	262	*
	263	* Note: SMBus and GSBus protocol type is passed in upper 16-bits
	264	* of Function
	265	*
	266	* Common buffer format:
	267	* Status; (Byte 0 of the data buffer)
	268	* Length; (Byte 1 of the data buffer)
	269	* Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
	270	*/
	271	if (source_desc->common.type != ACPI_TYPE_BUFFER) {
	272	ACPI_ERROR((AE_INFO,
	273	"SMBus/IPMI/GenericSerialBus write requires "
	274	"Buffer, found type %s",
	275	acpi_ut_get_object_type_name(source_desc)));
	276
	277	return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
	278	}
	279
	280	switch (obj_desc->field.region_obj->region.space_id) {
	281	case ACPI_ADR_SPACE_SMBUS:
	282
	283	buffer_length = ACPI_SMBUS_BUFFER_SIZE;
9e9f8733 BM	284	function = ACPI_WRITE \| (obj_desc->field.attribute << 16);
	285	break;
	286
	287	case ACPI_ADR_SPACE_IPMI:
	288
	289	buffer_length = ACPI_IPMI_BUFFER_SIZE;
9e9f8733 BM	290	function = ACPI_WRITE;
	291	break;
	292
	293	case ACPI_ADR_SPACE_GSBUS:
	294
	295	accessor_type = obj_desc->field.attribute;
	296	status =
	297	acpi_ex_get_protocol_buffer_length(accessor_type,
	298	&buffer_length);
	299	if (ACPI_FAILURE(status)) {
	300	ACPI_ERROR((AE_INFO,
	301	"Invalid protocol ID for GSBus: 0x%4.4X",
	302	accessor_type));
	303
	304	return_ACPI_STATUS(status);
	305	}
	306
	307	/* Add header length to get the full size of the buffer */
	308
	309	buffer_length += ACPI_SERIAL_HEADER_SIZE;
9e9f8733 BM	310	function = ACPI_WRITE \| (accessor_type << 16);
	311	break;
	312
	313	default:
	314	return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
	315	}
	316
9e9f8733 BM	317	/* Create the transfer/bidirectional/return buffer */
	318
	319	buffer_desc = acpi_ut_create_buffer_object(buffer_length);
	320	if (!buffer_desc) {
	321	return_ACPI_STATUS(AE_NO_MEMORY);
	322	}
	323
	324	/* Copy the input buffer data to the transfer buffer */
	325
	326	buffer = buffer_desc->buffer.pointer;
ae6b3e54 HG	327	memcpy(buffer, source_desc->buffer.pointer,
ae6b3e54 HG	328	min(buffer_length, source_desc->buffer.length));
9e9f8733 BM	329
	330	/* Lock entire transaction if requested */
	331
	332	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
	333
	334	/*
	335	* Perform the write (returns status and perhaps data in the
	336	* same buffer)
	337	*/
	338	status = acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, function);
	339	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
	340
	341	*return_buffer = buffer_desc;
	342	return_ACPI_STATUS(status);
	343	}