[deliverable/linux.git] / drivers / acpi / executer / exstorob.c


/******************************************************************************
 *
 * Module Name: exstorob - AML Interpreter object store support, store to object
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2006, R. Byron Moore
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include <acpi/acinterp.h>

#define _COMPONENT          ACPI_EXECUTER
ACPI_MODULE_NAME("exstorob")

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_store_buffer_to_buffer
 *
 * PARAMETERS:  source_desc         - Source object to copy
 *              target_desc         - Destination object of the copy
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Copy a buffer object to another buffer object.
 *
 ******************************************************************************/
acpi_status
acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
			       union acpi_operand_object *target_desc)
{
	u32 length;
	u8 *buffer;

	ACPI_FUNCTION_TRACE_PTR("ex_store_buffer_to_buffer", source_desc);

	/* We know that source_desc is a buffer by now */

	buffer = ACPI_CAST_PTR(u8, source_desc->buffer.pointer);
	length = source_desc->buffer.length;

	/*
	 * If target is a buffer of length zero or is a static buffer,
	 * allocate a new buffer of the proper length
	 */
	if ((target_desc->buffer.length == 0) ||
	    (target_desc->common.flags & AOPOBJ_STATIC_POINTER)) {
		target_desc->buffer.pointer = ACPI_ALLOCATE(length);
		if (!target_desc->buffer.pointer) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}

		target_desc->buffer.length = length;
	}

	/* Copy source buffer to target buffer */

	if (length <= target_desc->buffer.length) {

		/* Clear existing buffer and copy in the new one */

		ACPI_MEMSET(target_desc->buffer.pointer, 0,
			    target_desc->buffer.length);
		ACPI_MEMCPY(target_desc->buffer.pointer, buffer, length);

#ifdef ACPI_OBSOLETE_BEHAVIOR
		/*
		 * NOTE: ACPI versions up to 3.0 specified that the buffer must be
		 * truncated if the string is smaller than the buffer.  However, "other"
		 * implementations of ACPI never did this and thus became the defacto
		 * standard. ACPi 3.0_a changes this behavior such that the buffer
		 * is no longer truncated.
		 */

		/*
		 * OBSOLETE BEHAVIOR:
		 * If the original source was a string, we must truncate the buffer,
		 * according to the ACPI spec.  Integer-to-Buffer and Buffer-to-Buffer
		 * copy must not truncate the original buffer.
		 */
		if (original_src_type == ACPI_TYPE_STRING) {

			/* Set the new length of the target */

			target_desc->buffer.length = length;
		}
#endif
	} else {
		/* Truncate the source, copy only what will fit */

		ACPI_MEMCPY(target_desc->buffer.pointer, buffer,
			    target_desc->buffer.length);

		ACPI_DEBUG_PRINT((ACPI_DB_INFO,
				  "Truncating source buffer from %X to %X\n",
				  length, target_desc->buffer.length));
	}

	/* Copy flags */

	target_desc->buffer.flags = source_desc->buffer.flags;
	target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_store_string_to_string
 *
 * PARAMETERS:  source_desc         - Source object to copy
 *              target_desc         - Destination object of the copy
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Copy a String object to another String object
 *
 ******************************************************************************/

acpi_status
acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
			       union acpi_operand_object *target_desc)
{
	u32 length;
	u8 *buffer;

	ACPI_FUNCTION_TRACE_PTR("ex_store_string_to_string", source_desc);

	/* We know that source_desc is a string by now */

	buffer = ACPI_CAST_PTR(u8, source_desc->string.pointer);
	length = source_desc->string.length;

	/*
	 * Replace existing string value if it will fit and the string
	 * pointer is not a static pointer (part of an ACPI table)
	 */
	if ((length < target_desc->string.length) &&
	    (!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {
		/*
		 * String will fit in existing non-static buffer.
		 * Clear old string and copy in the new one
		 */
		ACPI_MEMSET(target_desc->string.pointer, 0,
			    (acpi_size) target_desc->string.length + 1);
		ACPI_MEMCPY(target_desc->string.pointer, buffer, length);
	} else {
		/*
		 * Free the current buffer, then allocate a new buffer
		 * large enough to hold the value
		 */
		if (target_desc->string.pointer &&
		    (!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {

			/* Only free if not a pointer into the DSDT */

			ACPI_FREE(target_desc->string.pointer);
		}

		target_desc->string.pointer = ACPI_ALLOCATE_ZEROED((acpi_size)
								   length + 1);
		if (!target_desc->string.pointer) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}

		target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
		ACPI_MEMCPY(target_desc->string.pointer, buffer, length);
	}

	/* Set the new target length */

	target_desc->string.length = length;
	return_ACPI_STATUS(AE_OK);
}
Commit	Line	Data
1da177e4 LT	1
	2	/******************************************************************************
	3	*
	4	* Module Name: exstorob - AML Interpreter object store support, store to object
	5	*
	6	*****************************************************************************/
	7
	8	/*
4a90c7e8	9	* Copyright (C) 2000 - 2006, R. Byron Moore
1da177e4 LT	10	* All rights reserved.
	11	*
	12	* Redistribution and use in source and binary forms, with or without
	13	* modification, are permitted provided that the following conditions
	14	* are met:
	15	* 1. Redistributions of source code must retain the above copyright
	16	* notice, this list of conditions, and the following disclaimer,
	17	* without modification.
	18	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	19	* substantially similar to the "NO WARRANTY" disclaimer below
	20	* ("Disclaimer") and any redistribution must be conditioned upon
	21	* including a substantially similar Disclaimer requirement for further
	22	* binary redistribution.
	23	* 3. Neither the names of the above-listed copyright holders nor the names
	24	* of any contributors may be used to endorse or promote products derived
	25	* from this software without specific prior written permission.
	26	*
	27	* Alternatively, this software may be distributed under the terms of the
	28	* GNU General Public License ("GPL") version 2 as published by the Free
	29	* Software Foundation.
	30	*
	31	* NO WARRANTY
	32	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	33	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	34	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	35	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	36	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	37	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	38	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	39	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	40	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	41	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	42	* POSSIBILITY OF SUCH DAMAGES.
	43	*/
	44
1da177e4 LT	45	#include <acpi/acpi.h>
	46	#include <acpi/acinterp.h>
	47
1da177e4	48	#define _COMPONENT ACPI_EXECUTER
4be44fcd	49	ACPI_MODULE_NAME("exstorob")
1da177e4 LT	50
	51	/*******************************************************************************
	52	*
	53	* FUNCTION: acpi_ex_store_buffer_to_buffer
	54	*
	55	* PARAMETERS: source_desc - Source object to copy
	56	* target_desc - Destination object of the copy
	57	*
	58	* RETURN: Status
	59	*
	60	* DESCRIPTION: Copy a buffer object to another buffer object.
	61	*
	62	******************************************************************************/
1da177e4	63	acpi_status
4be44fcd LB	64	acpi_ex_store_buffer_to_buffer(union acpi_operand_object *source_desc,
4be44fcd LB	65	union acpi_operand_object *target_desc)
1da177e4	66	{
4be44fcd LB	67	u32 length;
4be44fcd LB	68	u8 *buffer;
1da177e4	69
4be44fcd	70	ACPI_FUNCTION_TRACE_PTR("ex_store_buffer_to_buffer", source_desc);
1da177e4 LT	71
	72	/* We know that source_desc is a buffer by now */
	73
c51a4de8	74	buffer = ACPI_CAST_PTR(u8, source_desc->buffer.pointer);
1da177e4 LT	75	length = source_desc->buffer.length;
	76
	77	/*
	78	* If target is a buffer of length zero or is a static buffer,
	79	* allocate a new buffer of the proper length
	80	*/
	81	if ((target_desc->buffer.length == 0) \|\|
4be44fcd	82	(target_desc->common.flags & AOPOBJ_STATIC_POINTER)) {
8313524a	83	target_desc->buffer.pointer = ACPI_ALLOCATE(length);
1da177e4	84	if (!target_desc->buffer.pointer) {
4be44fcd	85	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	86	}
	87
	88	target_desc->buffer.length = length;
	89	}
	90
	91	/* Copy source buffer to target buffer */
	92
	93	if (length <= target_desc->buffer.length) {
52fc0b02	94
1da177e4 LT	95	/* Clear existing buffer and copy in the new one */
1da177e4 LT	96
4be44fcd LB	97	ACPI_MEMSET(target_desc->buffer.pointer, 0,
	98	target_desc->buffer.length);
	99	ACPI_MEMCPY(target_desc->buffer.pointer, buffer, length);
1da177e4 LT	100
	101	#ifdef ACPI_OBSOLETE_BEHAVIOR
	102	/*
	103	* NOTE: ACPI versions up to 3.0 specified that the buffer must be
	104	* truncated if the string is smaller than the buffer. However, "other"
	105	* implementations of ACPI never did this and thus became the defacto
	106	* standard. ACPi 3.0_a changes this behavior such that the buffer
	107	* is no longer truncated.
	108	*/
	109
	110	/*
	111	* OBSOLETE BEHAVIOR:
	112	* If the original source was a string, we must truncate the buffer,
	113	* according to the ACPI spec. Integer-to-Buffer and Buffer-to-Buffer
	114	* copy must not truncate the original buffer.
	115	*/
	116	if (original_src_type == ACPI_TYPE_STRING) {
52fc0b02	117
1da177e4 LT	118	/* Set the new length of the target */
	119
	120	target_desc->buffer.length = length;
	121	}
	122	#endif
4be44fcd	123	} else {
1da177e4 LT	124	/* Truncate the source, copy only what will fit */
1da177e4 LT	125
4be44fcd LB	126	ACPI_MEMCPY(target_desc->buffer.pointer, buffer,
4be44fcd LB	127	target_desc->buffer.length);
1da177e4	128
4be44fcd LB	129	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
	130	"Truncating source buffer from %X to %X\n",
	131	length, target_desc->buffer.length));
1da177e4 LT	132	}
	133
	134	/* Copy flags */
	135
	136	target_desc->buffer.flags = source_desc->buffer.flags;
	137	target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
4be44fcd	138	return_ACPI_STATUS(AE_OK);
1da177e4 LT	139	}
1da177e4 LT	140
1da177e4 LT	141	/*******************************************************************************
	142	*
	143	* FUNCTION: acpi_ex_store_string_to_string
	144	*
	145	* PARAMETERS: source_desc - Source object to copy
	146	* target_desc - Destination object of the copy
	147	*
	148	* RETURN: Status
	149	*
	150	* DESCRIPTION: Copy a String object to another String object
	151	*
	152	******************************************************************************/
	153
	154	acpi_status
4be44fcd LB	155	acpi_ex_store_string_to_string(union acpi_operand_object *source_desc,
4be44fcd LB	156	union acpi_operand_object *target_desc)
1da177e4	157	{
4be44fcd LB	158	u32 length;
4be44fcd LB	159	u8 *buffer;
1da177e4	160
4be44fcd	161	ACPI_FUNCTION_TRACE_PTR("ex_store_string_to_string", source_desc);
1da177e4 LT	162
	163	/* We know that source_desc is a string by now */
	164
c51a4de8	165	buffer = ACPI_CAST_PTR(u8, source_desc->string.pointer);
1da177e4 LT	166	length = source_desc->string.length;
	167
	168	/*
	169	* Replace existing string value if it will fit and the string
	170	* pointer is not a static pointer (part of an ACPI table)
	171	*/
	172	if ((length < target_desc->string.length) &&
4be44fcd	173	(!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {
1da177e4 LT	174	/*
	175	* String will fit in existing non-static buffer.
	176	* Clear old string and copy in the new one
	177	*/
4be44fcd LB	178	ACPI_MEMSET(target_desc->string.pointer, 0,
	179	(acpi_size) target_desc->string.length + 1);
	180	ACPI_MEMCPY(target_desc->string.pointer, buffer, length);
	181	} else {
1da177e4 LT	182	/*
	183	* Free the current buffer, then allocate a new buffer
	184	* large enough to hold the value
	185	*/
	186	if (target_desc->string.pointer &&
4be44fcd	187	(!(target_desc->common.flags & AOPOBJ_STATIC_POINTER))) {
52fc0b02	188
1da177e4 LT	189	/* Only free if not a pointer into the DSDT */
1da177e4 LT	190
8313524a	191	ACPI_FREE(target_desc->string.pointer);
1da177e4 LT	192	}
1da177e4 LT	193
8313524a BM	194	target_desc->string.pointer = ACPI_ALLOCATE_ZEROED((acpi_size)
8313524a BM	195	length + 1);
1da177e4	196	if (!target_desc->string.pointer) {
4be44fcd	197	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	198	}
	199
	200	target_desc->common.flags &= ~AOPOBJ_STATIC_POINTER;
4be44fcd	201	ACPI_MEMCPY(target_desc->string.pointer, buffer, length);
1da177e4 LT	202	}
	203
	204	/* Set the new target length */
	205
	206	target_desc->string.length = length;
4be44fcd	207	return_ACPI_STATUS(AE_OK);
1da177e4	208	}