xref: /OK3568_Linux_fs/kernel/drivers/acpi/acpica/exstorob.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2*4882a593Smuzhiyun /******************************************************************************
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Module Name: exstorob - AML object store support, store to object
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (C) 2000 - 2020, Intel Corp.
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  *****************************************************************************/
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <acpi/acpi.h>
11*4882a593Smuzhiyun #include "accommon.h"
12*4882a593Smuzhiyun #include "acinterp.h"
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define _COMPONENT          ACPI_EXECUTER
15*4882a593Smuzhiyun ACPI_MODULE_NAME("exstorob")
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun /*******************************************************************************
18*4882a593Smuzhiyun  *
19*4882a593Smuzhiyun  * FUNCTION:    acpi_ex_store_buffer_to_buffer
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  * PARAMETERS:  source_desc         - Source object to copy
22*4882a593Smuzhiyun  *              target_desc         - Destination object of the copy
23*4882a593Smuzhiyun  *
24*4882a593Smuzhiyun  * RETURN:      Status
25*4882a593Smuzhiyun  *
26*4882a593Smuzhiyun  * DESCRIPTION: Copy a buffer object to another buffer object.
27*4882a593Smuzhiyun  *
28*4882a593Smuzhiyun  ******************************************************************************/
29*4882a593Smuzhiyun acpi_status
acpi_ex_store_buffer_to_buffer(union acpi_operand_object * source_desc,union acpi_operand_object * target_desc)30*4882a593Smuzhiyun acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
31*4882a593Smuzhiyun 			       union acpi_operand_object *target_desc)
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun 	u32 length;
34*4882a593Smuzhiyun 	u8 *buffer;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	ACPI_FUNCTION_TRACE_PTR(ex_store_buffer_to_buffer, source_desc);
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun 	/* If Source and Target are the same, just return */
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	if (source_desc == target_desc) {
41*4882a593Smuzhiyun 		return_ACPI_STATUS(AE_OK);
42*4882a593Smuzhiyun 	}
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	/* We know that source_desc is a buffer by now */
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	buffer = ACPI_CAST_PTR(u8, source_desc->buffer.pointer);
47*4882a593Smuzhiyun 	length = source_desc->buffer.length;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	/*
50*4882a593Smuzhiyun 	 * If target is a buffer of length zero or is a static buffer,
51*4882a593Smuzhiyun 	 * allocate a new buffer of the proper length
52*4882a593Smuzhiyun 	 */
53*4882a593Smuzhiyun 	if ((target_desc->buffer.length == 0) ||
54*4882a593Smuzhiyun 	    (target_desc->common.flags & AOPOBJ_STATIC_POINTER)) {
55*4882a593Smuzhiyun 		target_desc->buffer.pointer = ACPI_ALLOCATE(length);
56*4882a593Smuzhiyun 		if (!target_desc->buffer.pointer) {
57*4882a593Smuzhiyun 			return_ACPI_STATUS(AE_NO_MEMORY);
58*4882a593Smuzhiyun 		}
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 		target_desc->buffer.length = length;
61*4882a593Smuzhiyun 	}
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	/* Copy source buffer to target buffer */
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	if (length <= target_desc->buffer.length) {
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 		/* Clear existing buffer and copy in the new one */
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 		memset(target_desc->buffer.pointer, 0,
70*4882a593Smuzhiyun 		       target_desc->buffer.length);
71*4882a593Smuzhiyun 		memcpy(target_desc->buffer.pointer, buffer, length);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #ifdef ACPI_OBSOLETE_BEHAVIOR
74*4882a593Smuzhiyun 		/*
75*4882a593Smuzhiyun 		 * NOTE: ACPI versions up to 3.0 specified that the buffer must be
76*4882a593Smuzhiyun 		 * truncated if the string is smaller than the buffer. However, "other"
77*4882a593Smuzhiyun 		 * implementations of ACPI never did this and thus became the defacto
78*4882a593Smuzhiyun 		 * standard. ACPI 3.0A changes this behavior such that the buffer
79*4882a593Smuzhiyun 		 * is no longer truncated.
80*4882a593Smuzhiyun 		 */
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 		/*
83*4882a593Smuzhiyun 		 * OBSOLETE BEHAVIOR:
84*4882a593Smuzhiyun 		 * If the original source was a string, we must truncate the buffer,
85*4882a593Smuzhiyun 		 * according to the ACPI spec. Integer-to-Buffer and Buffer-to-Buffer
86*4882a593Smuzhiyun 		 * copy must not truncate the original buffer.
87*4882a593Smuzhiyun 		 */
88*4882a593Smuzhiyun 		if (original_src_type == ACPI_TYPE_STRING) {
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 			/* Set the new length of the target */
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 			target_desc->buffer.length = length;
93*4882a593Smuzhiyun 		}
94*4882a593Smuzhiyun #endif
95*4882a593Smuzhiyun 	} else {
96*4882a593Smuzhiyun 		/* Truncate the source, copy only what will fit */
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 		memcpy(target_desc->buffer.pointer, buffer,
99*4882a593Smuzhiyun 		       target_desc->buffer.length);
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
102*4882a593Smuzhiyun 				  "Truncating source buffer from %X to %X\n",
103*4882a593Smuzhiyun 				  length, target_desc->buffer.length));
104*4882a593Smuzhiyun 	}
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	/* Copy flags */
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	target_desc->buffer.flags = source_desc->buffer.flags;
109*4882a593Smuzhiyun 	target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
110*4882a593Smuzhiyun 	return_ACPI_STATUS(AE_OK);
111*4882a593Smuzhiyun }
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun /*******************************************************************************
114*4882a593Smuzhiyun  *
115*4882a593Smuzhiyun  * FUNCTION:    acpi_ex_store_string_to_string
116*4882a593Smuzhiyun  *
117*4882a593Smuzhiyun  * PARAMETERS:  source_desc         - Source object to copy
118*4882a593Smuzhiyun  *              target_desc         - Destination object of the copy
119*4882a593Smuzhiyun  *
120*4882a593Smuzhiyun  * RETURN:      Status
121*4882a593Smuzhiyun  *
122*4882a593Smuzhiyun  * DESCRIPTION: Copy a String object to another String object
123*4882a593Smuzhiyun  *
124*4882a593Smuzhiyun  ******************************************************************************/
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun acpi_status
acpi_ex_store_string_to_string(union acpi_operand_object * source_desc,union acpi_operand_object * target_desc)127*4882a593Smuzhiyun acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
128*4882a593Smuzhiyun 			       union acpi_operand_object *target_desc)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun 	u32 length;
131*4882a593Smuzhiyun 	u8 *buffer;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	ACPI_FUNCTION_TRACE_PTR(ex_store_string_to_string, source_desc);
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun 	/* If Source and Target are the same, just return */
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	if (source_desc == target_desc) {
138*4882a593Smuzhiyun 		return_ACPI_STATUS(AE_OK);
139*4882a593Smuzhiyun 	}
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	/* We know that source_desc is a string by now */
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	buffer = ACPI_CAST_PTR(u8, source_desc->string.pointer);
144*4882a593Smuzhiyun 	length = source_desc->string.length;
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	/*
147*4882a593Smuzhiyun 	 * Replace existing string value if it will fit and the string
148*4882a593Smuzhiyun 	 * pointer is not a static pointer (part of an ACPI table)
149*4882a593Smuzhiyun 	 */
150*4882a593Smuzhiyun 	if ((length < target_desc->string.length) &&
151*4882a593Smuzhiyun 	    (!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {
152*4882a593Smuzhiyun 		/*
153*4882a593Smuzhiyun 		 * String will fit in existing non-static buffer.
154*4882a593Smuzhiyun 		 * Clear old string and copy in the new one
155*4882a593Smuzhiyun 		 */
156*4882a593Smuzhiyun 		memset(target_desc->string.pointer, 0,
157*4882a593Smuzhiyun 		       (acpi_size)target_desc->string.length + 1);
158*4882a593Smuzhiyun 		memcpy(target_desc->string.pointer, buffer, length);
159*4882a593Smuzhiyun 	} else {
160*4882a593Smuzhiyun 		/*
161*4882a593Smuzhiyun 		 * Free the current buffer, then allocate a new buffer
162*4882a593Smuzhiyun 		 * large enough to hold the value
163*4882a593Smuzhiyun 		 */
164*4882a593Smuzhiyun 		if (target_desc->string.pointer &&
165*4882a593Smuzhiyun 		    (!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 			/* Only free if not a pointer into the DSDT */
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 			ACPI_FREE(target_desc->string.pointer);
170*4882a593Smuzhiyun 		}
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 		target_desc->string.pointer =
173*4882a593Smuzhiyun 		    ACPI_ALLOCATE_ZEROED((acpi_size)length + 1);
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 		if (!target_desc->string.pointer) {
176*4882a593Smuzhiyun 			return_ACPI_STATUS(AE_NO_MEMORY);
177*4882a593Smuzhiyun 		}
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 		target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
180*4882a593Smuzhiyun 		memcpy(target_desc->string.pointer, buffer, length);
181*4882a593Smuzhiyun 	}
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun 	/* Set the new target length */
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun 	target_desc->string.length = length;
186*4882a593Smuzhiyun 	return_ACPI_STATUS(AE_OK);
187*4882a593Smuzhiyun }
188