195b482a8SLen Brown /****************************************************************************** 295b482a8SLen Brown * 395b482a8SLen Brown * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities 495b482a8SLen Brown * 595b482a8SLen Brown *****************************************************************************/ 695b482a8SLen Brown 795b482a8SLen Brown /* 8fbb7a2dcSBob Moore * Copyright (C) 2000 - 2014, Intel Corp. 995b482a8SLen Brown * All rights reserved. 1095b482a8SLen Brown * 1195b482a8SLen Brown * Redistribution and use in source and binary forms, with or without 1295b482a8SLen Brown * modification, are permitted provided that the following conditions 1395b482a8SLen Brown * are met: 1495b482a8SLen Brown * 1. Redistributions of source code must retain the above copyright 1595b482a8SLen Brown * notice, this list of conditions, and the following disclaimer, 1695b482a8SLen Brown * without modification. 1795b482a8SLen Brown * 2. Redistributions in binary form must reproduce at minimum a disclaimer 1895b482a8SLen Brown * substantially similar to the "NO WARRANTY" disclaimer below 1995b482a8SLen Brown * ("Disclaimer") and any redistribution must be conditioned upon 2095b482a8SLen Brown * including a substantially similar Disclaimer requirement for further 2195b482a8SLen Brown * binary redistribution. 2295b482a8SLen Brown * 3. Neither the names of the above-listed copyright holders nor the names 2395b482a8SLen Brown * of any contributors may be used to endorse or promote products derived 2495b482a8SLen Brown * from this software without specific prior written permission. 2595b482a8SLen Brown * 2695b482a8SLen Brown * Alternatively, this software may be distributed under the terms of the 2795b482a8SLen Brown * GNU General Public License ("GPL") version 2 as published by the Free 2895b482a8SLen Brown * Software Foundation. 2995b482a8SLen Brown * 3095b482a8SLen Brown * NO WARRANTY 3195b482a8SLen Brown * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 3295b482a8SLen Brown * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3395b482a8SLen Brown * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 3495b482a8SLen Brown * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3595b482a8SLen Brown * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 3695b482a8SLen Brown * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 3795b482a8SLen Brown * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 3895b482a8SLen Brown * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 3995b482a8SLen Brown * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 4095b482a8SLen Brown * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 4195b482a8SLen Brown * POSSIBILITY OF SUCH DAMAGES. 4295b482a8SLen Brown */ 4395b482a8SLen Brown 4495b482a8SLen Brown #include <acpi/acpi.h> 45e2f7a777SLen Brown #include "accommon.h" 46e2f7a777SLen Brown #include "acinterp.h" 47e2f7a777SLen Brown #include "amlcode.h" 48e2f7a777SLen Brown #include "acnamesp.h" 499ce81784SBob Moore #include "acdispat.h" 5095b482a8SLen Brown 5195b482a8SLen Brown #define _COMPONENT ACPI_EXECUTER 5295b482a8SLen Brown ACPI_MODULE_NAME("exprep") 5395b482a8SLen Brown 5495b482a8SLen Brown /* Local prototypes */ 5595b482a8SLen Brown static u32 5695b482a8SLen Brown acpi_ex_decode_field_access(union acpi_operand_object *obj_desc, 5795b482a8SLen Brown u8 field_flags, u32 * return_byte_alignment); 5895b482a8SLen Brown 5995b482a8SLen Brown #ifdef ACPI_UNDER_DEVELOPMENT 6095b482a8SLen Brown 6195b482a8SLen Brown static u32 6295b482a8SLen Brown acpi_ex_generate_access(u32 field_bit_offset, 6395b482a8SLen Brown u32 field_bit_length, u32 region_length); 6495b482a8SLen Brown 6595b482a8SLen Brown /******************************************************************************* 6695b482a8SLen Brown * 6795b482a8SLen Brown * FUNCTION: acpi_ex_generate_access 6895b482a8SLen Brown * 6995b482a8SLen Brown * PARAMETERS: field_bit_offset - Start of field within parent region/buffer 7095b482a8SLen Brown * field_bit_length - Length of field in bits 7195b482a8SLen Brown * region_length - Length of parent in bytes 7295b482a8SLen Brown * 7395b482a8SLen Brown * RETURN: Field granularity (8, 16, 32 or 64) and 7495b482a8SLen Brown * byte_alignment (1, 2, 3, or 4) 7595b482a8SLen Brown * 7695b482a8SLen Brown * DESCRIPTION: Generate an optimal access width for fields defined with the 7795b482a8SLen Brown * any_acc keyword. 7895b482a8SLen Brown * 7995b482a8SLen Brown * NOTE: Need to have the region_length in order to check for boundary 8095b482a8SLen Brown * conditions (end-of-region). However, the region_length is a deferred 8195b482a8SLen Brown * operation. Therefore, to complete this implementation, the generation 8295b482a8SLen Brown * of this access width must be deferred until the region length has 8395b482a8SLen Brown * been evaluated. 8495b482a8SLen Brown * 8595b482a8SLen Brown ******************************************************************************/ 8695b482a8SLen Brown 8795b482a8SLen Brown static u32 8895b482a8SLen Brown acpi_ex_generate_access(u32 field_bit_offset, 8995b482a8SLen Brown u32 field_bit_length, u32 region_length) 9095b482a8SLen Brown { 9195b482a8SLen Brown u32 field_byte_length; 9295b482a8SLen Brown u32 field_byte_offset; 9395b482a8SLen Brown u32 field_byte_end_offset; 9495b482a8SLen Brown u32 access_byte_width; 9595b482a8SLen Brown u32 field_start_offset; 9695b482a8SLen Brown u32 field_end_offset; 9795b482a8SLen Brown u32 minimum_access_width = 0xFFFFFFFF; 9895b482a8SLen Brown u32 minimum_accesses = 0xFFFFFFFF; 9995b482a8SLen Brown u32 accesses; 10095b482a8SLen Brown 10195b482a8SLen Brown ACPI_FUNCTION_TRACE(ex_generate_access); 10295b482a8SLen Brown 10395b482a8SLen Brown /* Round Field start offset and length to "minimal" byte boundaries */ 10495b482a8SLen Brown 10595b482a8SLen Brown field_byte_offset = ACPI_DIV_8(ACPI_ROUND_DOWN(field_bit_offset, 8)); 10695b482a8SLen Brown field_byte_end_offset = ACPI_DIV_8(ACPI_ROUND_UP(field_bit_length + 10795b482a8SLen Brown field_bit_offset, 8)); 10895b482a8SLen Brown field_byte_length = field_byte_end_offset - field_byte_offset; 10995b482a8SLen Brown 11095b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 111b27d6597SBob Moore "Bit length %u, Bit offset %u\n", 11295b482a8SLen Brown field_bit_length, field_bit_offset)); 11395b482a8SLen Brown 11495b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 115b27d6597SBob Moore "Byte Length %u, Byte Offset %u, End Offset %u\n", 11695b482a8SLen Brown field_byte_length, field_byte_offset, 11795b482a8SLen Brown field_byte_end_offset)); 11895b482a8SLen Brown 11995b482a8SLen Brown /* 12095b482a8SLen Brown * Iterative search for the maximum access width that is both aligned 12195b482a8SLen Brown * and does not go beyond the end of the region 12295b482a8SLen Brown * 12395b482a8SLen Brown * Start at byte_acc and work upwards to qword_acc max. (1,2,4,8 bytes) 12495b482a8SLen Brown */ 12595b482a8SLen Brown for (access_byte_width = 1; access_byte_width <= 8; 12695b482a8SLen Brown access_byte_width <<= 1) { 12795b482a8SLen Brown /* 12895b482a8SLen Brown * 1) Round end offset up to next access boundary and make sure that 12995b482a8SLen Brown * this does not go beyond the end of the parent region. 13095b482a8SLen Brown * 2) When the Access width is greater than the field_byte_length, we 13195b482a8SLen Brown * are done. (This does not optimize for the perfectly aligned 13295b482a8SLen Brown * case yet). 13395b482a8SLen Brown */ 13495b482a8SLen Brown if (ACPI_ROUND_UP(field_byte_end_offset, access_byte_width) <= 13595b482a8SLen Brown region_length) { 13695b482a8SLen Brown field_start_offset = 13795b482a8SLen Brown ACPI_ROUND_DOWN(field_byte_offset, 13895b482a8SLen Brown access_byte_width) / 13995b482a8SLen Brown access_byte_width; 14095b482a8SLen Brown 14195b482a8SLen Brown field_end_offset = 14295b482a8SLen Brown ACPI_ROUND_UP((field_byte_length + 14395b482a8SLen Brown field_byte_offset), 14495b482a8SLen Brown access_byte_width) / 14595b482a8SLen Brown access_byte_width; 14695b482a8SLen Brown 14795b482a8SLen Brown accesses = field_end_offset - field_start_offset; 14895b482a8SLen Brown 14995b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 150b27d6597SBob Moore "AccessWidth %u end is within region\n", 15195b482a8SLen Brown access_byte_width)); 15295b482a8SLen Brown 15395b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 154b27d6597SBob Moore "Field Start %u, Field End %u -- requires %u accesses\n", 15595b482a8SLen Brown field_start_offset, field_end_offset, 15695b482a8SLen Brown accesses)); 15795b482a8SLen Brown 15895b482a8SLen Brown /* Single access is optimal */ 15995b482a8SLen Brown 16095b482a8SLen Brown if (accesses <= 1) { 16195b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 162b27d6597SBob Moore "Entire field can be accessed with one operation of size %u\n", 16395b482a8SLen Brown access_byte_width)); 16495b482a8SLen Brown return_VALUE(access_byte_width); 16595b482a8SLen Brown } 16695b482a8SLen Brown 16795b482a8SLen Brown /* 16895b482a8SLen Brown * Fits in the region, but requires more than one read/write. 16995b482a8SLen Brown * try the next wider access on next iteration 17095b482a8SLen Brown */ 17195b482a8SLen Brown if (accesses < minimum_accesses) { 17295b482a8SLen Brown minimum_accesses = accesses; 17395b482a8SLen Brown minimum_access_width = access_byte_width; 17495b482a8SLen Brown } 17595b482a8SLen Brown } else { 17695b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 177b27d6597SBob Moore "AccessWidth %u end is NOT within region\n", 17895b482a8SLen Brown access_byte_width)); 17995b482a8SLen Brown if (access_byte_width == 1) { 18095b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 18195b482a8SLen Brown "Field goes beyond end-of-region!\n")); 18295b482a8SLen Brown 18395b482a8SLen Brown /* Field does not fit in the region at all */ 18495b482a8SLen Brown 18595b482a8SLen Brown return_VALUE(0); 18695b482a8SLen Brown } 18795b482a8SLen Brown 18895b482a8SLen Brown /* 18995b482a8SLen Brown * This width goes beyond the end-of-region, back off to 19095b482a8SLen Brown * previous access 19195b482a8SLen Brown */ 19295b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 193b27d6597SBob Moore "Backing off to previous optimal access width of %u\n", 19495b482a8SLen Brown minimum_access_width)); 19595b482a8SLen Brown return_VALUE(minimum_access_width); 19695b482a8SLen Brown } 19795b482a8SLen Brown } 19895b482a8SLen Brown 19995b482a8SLen Brown /* 20095b482a8SLen Brown * Could not read/write field with one operation, 20195b482a8SLen Brown * just use max access width 20295b482a8SLen Brown */ 20395b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 20495b482a8SLen Brown "Cannot access field in one operation, using width 8\n")); 20595b482a8SLen Brown return_VALUE(8); 20695b482a8SLen Brown } 20795b482a8SLen Brown #endif /* ACPI_UNDER_DEVELOPMENT */ 20895b482a8SLen Brown 20995b482a8SLen Brown /******************************************************************************* 21095b482a8SLen Brown * 21195b482a8SLen Brown * FUNCTION: acpi_ex_decode_field_access 21295b482a8SLen Brown * 21395b482a8SLen Brown * PARAMETERS: obj_desc - Field object 21495b482a8SLen Brown * field_flags - Encoded fieldflags (contains access bits) 21595b482a8SLen Brown * return_byte_alignment - Where the byte alignment is returned 21695b482a8SLen Brown * 21795b482a8SLen Brown * RETURN: Field granularity (8, 16, 32 or 64) and 21895b482a8SLen Brown * byte_alignment (1, 2, 3, or 4) 21995b482a8SLen Brown * 22095b482a8SLen Brown * DESCRIPTION: Decode the access_type bits of a field definition. 22195b482a8SLen Brown * 22295b482a8SLen Brown ******************************************************************************/ 22395b482a8SLen Brown 22495b482a8SLen Brown static u32 22595b482a8SLen Brown acpi_ex_decode_field_access(union acpi_operand_object *obj_desc, 22695b482a8SLen Brown u8 field_flags, u32 * return_byte_alignment) 22795b482a8SLen Brown { 22895b482a8SLen Brown u32 access; 22995b482a8SLen Brown u32 byte_alignment; 23095b482a8SLen Brown u32 bit_length; 23195b482a8SLen Brown 23295b482a8SLen Brown ACPI_FUNCTION_TRACE(ex_decode_field_access); 23395b482a8SLen Brown 23495b482a8SLen Brown access = (field_flags & AML_FIELD_ACCESS_TYPE_MASK); 23595b482a8SLen Brown 23695b482a8SLen Brown switch (access) { 23795b482a8SLen Brown case AML_FIELD_ACCESS_ANY: 23895b482a8SLen Brown 23995b482a8SLen Brown #ifdef ACPI_UNDER_DEVELOPMENT 24095b482a8SLen Brown byte_alignment = 24195b482a8SLen Brown acpi_ex_generate_access(obj_desc->common_field. 24295b482a8SLen Brown start_field_bit_offset, 24395b482a8SLen Brown obj_desc->common_field.bit_length, 24495b482a8SLen Brown 0xFFFFFFFF 24595b482a8SLen Brown /* Temp until we pass region_length as parameter */ 24695b482a8SLen Brown ); 24795b482a8SLen Brown bit_length = byte_alignment * 8; 24895b482a8SLen Brown #endif 24995b482a8SLen Brown 25095b482a8SLen Brown byte_alignment = 1; 25195b482a8SLen Brown bit_length = 8; 25295b482a8SLen Brown break; 25395b482a8SLen Brown 25495b482a8SLen Brown case AML_FIELD_ACCESS_BYTE: 25595b482a8SLen Brown case AML_FIELD_ACCESS_BUFFER: /* ACPI 2.0 (SMBus Buffer) */ 2561d1ea1b7SChao Guan 25795b482a8SLen Brown byte_alignment = 1; 25895b482a8SLen Brown bit_length = 8; 25995b482a8SLen Brown break; 26095b482a8SLen Brown 26195b482a8SLen Brown case AML_FIELD_ACCESS_WORD: 2621d1ea1b7SChao Guan 26395b482a8SLen Brown byte_alignment = 2; 26495b482a8SLen Brown bit_length = 16; 26595b482a8SLen Brown break; 26695b482a8SLen Brown 26795b482a8SLen Brown case AML_FIELD_ACCESS_DWORD: 2681d1ea1b7SChao Guan 26995b482a8SLen Brown byte_alignment = 4; 27095b482a8SLen Brown bit_length = 32; 27195b482a8SLen Brown break; 27295b482a8SLen Brown 27395b482a8SLen Brown case AML_FIELD_ACCESS_QWORD: /* ACPI 2.0 */ 2741d1ea1b7SChao Guan 27595b482a8SLen Brown byte_alignment = 8; 27695b482a8SLen Brown bit_length = 64; 27795b482a8SLen Brown break; 27895b482a8SLen Brown 27995b482a8SLen Brown default: 2801d1ea1b7SChao Guan 28195b482a8SLen Brown /* Invalid field access type */ 28295b482a8SLen Brown 283f6a22b0bSBob Moore ACPI_ERROR((AE_INFO, "Unknown field access type 0x%X", access)); 284fd1af712SBob Moore return_UINT32(0); 28595b482a8SLen Brown } 28695b482a8SLen Brown 2873371c19cSBob Moore if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) { 28895b482a8SLen Brown /* 28995b482a8SLen Brown * buffer_field access can be on any byte boundary, so the 29095b482a8SLen Brown * byte_alignment is always 1 byte -- regardless of any byte_alignment 29195b482a8SLen Brown * implied by the field access type. 29295b482a8SLen Brown */ 29395b482a8SLen Brown byte_alignment = 1; 29495b482a8SLen Brown } 29595b482a8SLen Brown 29695b482a8SLen Brown *return_byte_alignment = byte_alignment; 297fd1af712SBob Moore return_UINT32(bit_length); 29895b482a8SLen Brown } 29995b482a8SLen Brown 30095b482a8SLen Brown /******************************************************************************* 30195b482a8SLen Brown * 30295b482a8SLen Brown * FUNCTION: acpi_ex_prep_common_field_object 30395b482a8SLen Brown * 30495b482a8SLen Brown * PARAMETERS: obj_desc - The field object 30595b482a8SLen Brown * field_flags - Access, lock_rule, and update_rule. 30695b482a8SLen Brown * The format of a field_flag is described 30795b482a8SLen Brown * in the ACPI specification 30895b482a8SLen Brown * field_attribute - Special attributes (not used) 30995b482a8SLen Brown * field_bit_position - Field start position 31095b482a8SLen Brown * field_bit_length - Field length in number of bits 31195b482a8SLen Brown * 31295b482a8SLen Brown * RETURN: Status 31395b482a8SLen Brown * 31495b482a8SLen Brown * DESCRIPTION: Initialize the areas of the field object that are common 31595b482a8SLen Brown * to the various types of fields. Note: This is very "sensitive" 31695b482a8SLen Brown * code because we are solving the general case for field 31795b482a8SLen Brown * alignment. 31895b482a8SLen Brown * 31995b482a8SLen Brown ******************************************************************************/ 32095b482a8SLen Brown 32195b482a8SLen Brown acpi_status 32295b482a8SLen Brown acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc, 32395b482a8SLen Brown u8 field_flags, 32495b482a8SLen Brown u8 field_attribute, 32595b482a8SLen Brown u32 field_bit_position, u32 field_bit_length) 32695b482a8SLen Brown { 32795b482a8SLen Brown u32 access_bit_width; 32895b482a8SLen Brown u32 byte_alignment; 32995b482a8SLen Brown u32 nearest_byte_address; 33095b482a8SLen Brown 33195b482a8SLen Brown ACPI_FUNCTION_TRACE(ex_prep_common_field_object); 33295b482a8SLen Brown 33395b482a8SLen Brown /* 33495b482a8SLen Brown * Note: the structure being initialized is the 33595b482a8SLen Brown * ACPI_COMMON_FIELD_INFO; No structure fields outside of the common 33695b482a8SLen Brown * area are initialized by this procedure. 33795b482a8SLen Brown */ 33895b482a8SLen Brown obj_desc->common_field.field_flags = field_flags; 33995b482a8SLen Brown obj_desc->common_field.attribute = field_attribute; 34095b482a8SLen Brown obj_desc->common_field.bit_length = field_bit_length; 34195b482a8SLen Brown 34295b482a8SLen Brown /* 34395b482a8SLen Brown * Decode the access type so we can compute offsets. The access type gives 34495b482a8SLen Brown * two pieces of information - the width of each field access and the 34595b482a8SLen Brown * necessary byte_alignment (address granularity) of the access. 34695b482a8SLen Brown * 34795b482a8SLen Brown * For any_acc, the access_bit_width is the largest width that is both 34895b482a8SLen Brown * necessary and possible in an attempt to access the whole field in one 34995b482a8SLen Brown * I/O operation. However, for any_acc, the byte_alignment is always one 35095b482a8SLen Brown * byte. 35195b482a8SLen Brown * 35295b482a8SLen Brown * For all Buffer Fields, the byte_alignment is always one byte. 35395b482a8SLen Brown * 35495b482a8SLen Brown * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is 35595b482a8SLen Brown * the same (equivalent) as the byte_alignment. 35695b482a8SLen Brown */ 35795b482a8SLen Brown access_bit_width = acpi_ex_decode_field_access(obj_desc, field_flags, 35895b482a8SLen Brown &byte_alignment); 35995b482a8SLen Brown if (!access_bit_width) { 36095b482a8SLen Brown return_ACPI_STATUS(AE_AML_OPERAND_VALUE); 36195b482a8SLen Brown } 36295b482a8SLen Brown 36309387b43SBob Moore /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */ 36495b482a8SLen Brown 36595b482a8SLen Brown obj_desc->common_field.access_byte_width = (u8) 36609387b43SBob Moore ACPI_DIV_8(access_bit_width); 36795b482a8SLen Brown 36895b482a8SLen Brown /* 36995b482a8SLen Brown * base_byte_offset is the address of the start of the field within the 37095b482a8SLen Brown * region. It is the byte address of the first *datum* (field-width data 37195b482a8SLen Brown * unit) of the field. (i.e., the first datum that contains at least the 37295b482a8SLen Brown * first *bit* of the field.) 37395b482a8SLen Brown * 37495b482a8SLen Brown * Note: byte_alignment is always either equal to the access_bit_width or 8 37595b482a8SLen Brown * (Byte access), and it defines the addressing granularity of the parent 37695b482a8SLen Brown * region or buffer. 37795b482a8SLen Brown */ 37895b482a8SLen Brown nearest_byte_address = 37995b482a8SLen Brown ACPI_ROUND_BITS_DOWN_TO_BYTES(field_bit_position); 38095b482a8SLen Brown obj_desc->common_field.base_byte_offset = (u32) 38195b482a8SLen Brown ACPI_ROUND_DOWN(nearest_byte_address, byte_alignment); 38295b482a8SLen Brown 38395b482a8SLen Brown /* 38495b482a8SLen Brown * start_field_bit_offset is the offset of the first bit of the field within 38595b482a8SLen Brown * a field datum. 38695b482a8SLen Brown */ 38795b482a8SLen Brown obj_desc->common_field.start_field_bit_offset = (u8) 38895b482a8SLen Brown (field_bit_position - 38995b482a8SLen Brown ACPI_MUL_8(obj_desc->common_field.base_byte_offset)); 39095b482a8SLen Brown 39195b482a8SLen Brown return_ACPI_STATUS(AE_OK); 39295b482a8SLen Brown } 39395b482a8SLen Brown 39495b482a8SLen Brown /******************************************************************************* 39595b482a8SLen Brown * 39695b482a8SLen Brown * FUNCTION: acpi_ex_prep_field_value 39795b482a8SLen Brown * 398ba494beeSBob Moore * PARAMETERS: info - Contains all field creation info 39995b482a8SLen Brown * 40095b482a8SLen Brown * RETURN: Status 40195b482a8SLen Brown * 402cf48958eSBob Moore * DESCRIPTION: Construct an object of type union acpi_operand_object with a 403cf48958eSBob Moore * subtype of def_field and connect it to the parent Node. 40495b482a8SLen Brown * 40595b482a8SLen Brown ******************************************************************************/ 40695b482a8SLen Brown 40795b482a8SLen Brown acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info) 40895b482a8SLen Brown { 40995b482a8SLen Brown union acpi_operand_object *obj_desc; 41095b482a8SLen Brown union acpi_operand_object *second_desc = NULL; 41195b482a8SLen Brown acpi_status status; 41209387b43SBob Moore u32 access_byte_width; 41309387b43SBob Moore u32 type; 41495b482a8SLen Brown 41595b482a8SLen Brown ACPI_FUNCTION_TRACE(ex_prep_field_value); 41695b482a8SLen Brown 41795b482a8SLen Brown /* Parameter validation */ 41895b482a8SLen Brown 41995b482a8SLen Brown if (info->field_type != ACPI_TYPE_LOCAL_INDEX_FIELD) { 42095b482a8SLen Brown if (!info->region_node) { 42195b482a8SLen Brown ACPI_ERROR((AE_INFO, "Null RegionNode")); 42295b482a8SLen Brown return_ACPI_STATUS(AE_AML_NO_OPERAND); 42395b482a8SLen Brown } 42495b482a8SLen Brown 42595b482a8SLen Brown type = acpi_ns_get_type(info->region_node); 42695b482a8SLen Brown if (type != ACPI_TYPE_REGION) { 42795b482a8SLen Brown ACPI_ERROR((AE_INFO, 42809387b43SBob Moore "Needed Region, found type 0x%X (%s)", type, 42909387b43SBob Moore acpi_ut_get_type_name(type))); 43095b482a8SLen Brown 43195b482a8SLen Brown return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 43295b482a8SLen Brown } 43395b482a8SLen Brown } 43495b482a8SLen Brown 43595b482a8SLen Brown /* Allocate a new field object */ 43695b482a8SLen Brown 43795b482a8SLen Brown obj_desc = acpi_ut_create_internal_object(info->field_type); 43895b482a8SLen Brown if (!obj_desc) { 43995b482a8SLen Brown return_ACPI_STATUS(AE_NO_MEMORY); 44095b482a8SLen Brown } 44195b482a8SLen Brown 44295b482a8SLen Brown /* Initialize areas of the object that are common to all fields */ 44395b482a8SLen Brown 44495b482a8SLen Brown obj_desc->common_field.node = info->field_node; 44509387b43SBob Moore status = acpi_ex_prep_common_field_object(obj_desc, 44609387b43SBob Moore info->field_flags, 44795b482a8SLen Brown info->attribute, 44895b482a8SLen Brown info->field_bit_position, 44995b482a8SLen Brown info->field_bit_length); 45095b482a8SLen Brown if (ACPI_FAILURE(status)) { 45195b482a8SLen Brown acpi_ut_delete_object_desc(obj_desc); 45295b482a8SLen Brown return_ACPI_STATUS(status); 45395b482a8SLen Brown } 45495b482a8SLen Brown 45595b482a8SLen Brown /* Initialize areas of the object that are specific to the field type */ 45695b482a8SLen Brown 45795b482a8SLen Brown switch (info->field_type) { 45895b482a8SLen Brown case ACPI_TYPE_LOCAL_REGION_FIELD: 45995b482a8SLen Brown 46095b482a8SLen Brown obj_desc->field.region_obj = 46195b482a8SLen Brown acpi_ns_get_attached_object(info->region_node); 46295b482a8SLen Brown 4639ce81784SBob Moore /* Fields specific to generic_serial_bus fields */ 4649ce81784SBob Moore 4659ce81784SBob Moore obj_desc->field.access_length = info->access_length; 4669ce81784SBob Moore 4679ce81784SBob Moore if (info->connection_node) { 4689ce81784SBob Moore second_desc = info->connection_node->object; 4699ce81784SBob Moore if (!(second_desc->common.flags & AOPOBJ_DATA_VALID)) { 4709ce81784SBob Moore status = 4719ce81784SBob Moore acpi_ds_get_buffer_arguments(second_desc); 4729ce81784SBob Moore if (ACPI_FAILURE(status)) { 4739ce81784SBob Moore acpi_ut_delete_object_desc(obj_desc); 4749ce81784SBob Moore return_ACPI_STATUS(status); 4759ce81784SBob Moore } 4769ce81784SBob Moore } 4779ce81784SBob Moore 4789ce81784SBob Moore obj_desc->field.resource_buffer = 4799ce81784SBob Moore second_desc->buffer.pointer; 4809ce81784SBob Moore obj_desc->field.resource_length = 4819ce81784SBob Moore (u16)second_desc->buffer.length; 4829ce81784SBob Moore } else if (info->resource_buffer) { 4839ce81784SBob Moore obj_desc->field.resource_buffer = info->resource_buffer; 4849ce81784SBob Moore obj_desc->field.resource_length = info->resource_length; 4859ce81784SBob Moore } 4869ce81784SBob Moore 487*75ec6e55SBob Moore obj_desc->field.pin_number_index = info->pin_number_index; 488*75ec6e55SBob Moore 48909387b43SBob Moore /* Allow full data read from EC address space */ 49009387b43SBob Moore 49109387b43SBob Moore if ((obj_desc->field.region_obj->region.space_id == 49209387b43SBob Moore ACPI_ADR_SPACE_EC) 49309387b43SBob Moore && (obj_desc->common_field.bit_length > 8)) { 49409387b43SBob Moore access_byte_width = 49509387b43SBob Moore ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field. 49609387b43SBob Moore bit_length); 49709387b43SBob Moore 49809387b43SBob Moore /* Maximum byte width supported is 255 */ 49909387b43SBob Moore 50009387b43SBob Moore if (access_byte_width < 256) { 50109387b43SBob Moore obj_desc->common_field.access_byte_width = 50209387b43SBob Moore (u8)access_byte_width; 50309387b43SBob Moore } 50409387b43SBob Moore } 50595b482a8SLen Brown /* An additional reference for the container */ 50695b482a8SLen Brown 50795b482a8SLen Brown acpi_ut_add_reference(obj_desc->field.region_obj); 50895b482a8SLen Brown 50995b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 51095b482a8SLen Brown "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n", 51195b482a8SLen Brown obj_desc->field.start_field_bit_offset, 51295b482a8SLen Brown obj_desc->field.base_byte_offset, 51395b482a8SLen Brown obj_desc->field.access_byte_width, 51495b482a8SLen Brown obj_desc->field.region_obj)); 51595b482a8SLen Brown break; 51695b482a8SLen Brown 51795b482a8SLen Brown case ACPI_TYPE_LOCAL_BANK_FIELD: 51895b482a8SLen Brown 51995b482a8SLen Brown obj_desc->bank_field.value = info->bank_value; 52095b482a8SLen Brown obj_desc->bank_field.region_obj = 52195b482a8SLen Brown acpi_ns_get_attached_object(info->region_node); 52295b482a8SLen Brown obj_desc->bank_field.bank_obj = 52395b482a8SLen Brown acpi_ns_get_attached_object(info->register_node); 52495b482a8SLen Brown 52595b482a8SLen Brown /* An additional reference for the attached objects */ 52695b482a8SLen Brown 52795b482a8SLen Brown acpi_ut_add_reference(obj_desc->bank_field.region_obj); 52895b482a8SLen Brown acpi_ut_add_reference(obj_desc->bank_field.bank_obj); 52995b482a8SLen Brown 53095b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 53195b482a8SLen Brown "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n", 53295b482a8SLen Brown obj_desc->bank_field.start_field_bit_offset, 53395b482a8SLen Brown obj_desc->bank_field.base_byte_offset, 53495b482a8SLen Brown obj_desc->field.access_byte_width, 53595b482a8SLen Brown obj_desc->bank_field.region_obj, 53695b482a8SLen Brown obj_desc->bank_field.bank_obj)); 53795b482a8SLen Brown 53895b482a8SLen Brown /* 53995b482a8SLen Brown * Remember location in AML stream of the field unit 54095b482a8SLen Brown * opcode and operands -- since the bank_value 54195b482a8SLen Brown * operands must be evaluated. 54295b482a8SLen Brown */ 54395b482a8SLen Brown second_desc = obj_desc->common.next_object; 54495b482a8SLen Brown second_desc->extra.aml_start = 54595b482a8SLen Brown ACPI_CAST_PTR(union acpi_parse_object, 54695b482a8SLen Brown info->data_register_node)->named.data; 54795b482a8SLen Brown second_desc->extra.aml_length = 54895b482a8SLen Brown ACPI_CAST_PTR(union acpi_parse_object, 54995b482a8SLen Brown info->data_register_node)->named.length; 55095b482a8SLen Brown 55195b482a8SLen Brown break; 55295b482a8SLen Brown 55395b482a8SLen Brown case ACPI_TYPE_LOCAL_INDEX_FIELD: 55495b482a8SLen Brown 55595b482a8SLen Brown /* Get the Index and Data registers */ 55695b482a8SLen Brown 55795b482a8SLen Brown obj_desc->index_field.index_obj = 55895b482a8SLen Brown acpi_ns_get_attached_object(info->register_node); 55995b482a8SLen Brown obj_desc->index_field.data_obj = 56095b482a8SLen Brown acpi_ns_get_attached_object(info->data_register_node); 56195b482a8SLen Brown 56295b482a8SLen Brown if (!obj_desc->index_field.data_obj 56395b482a8SLen Brown || !obj_desc->index_field.index_obj) { 56495b482a8SLen Brown ACPI_ERROR((AE_INFO, 56595b482a8SLen Brown "Null Index Object during field prep")); 56695b482a8SLen Brown acpi_ut_delete_object_desc(obj_desc); 56795b482a8SLen Brown return_ACPI_STATUS(AE_AML_INTERNAL); 56895b482a8SLen Brown } 56995b482a8SLen Brown 57095b482a8SLen Brown /* An additional reference for the attached objects */ 57195b482a8SLen Brown 57295b482a8SLen Brown acpi_ut_add_reference(obj_desc->index_field.data_obj); 57395b482a8SLen Brown acpi_ut_add_reference(obj_desc->index_field.index_obj); 57495b482a8SLen Brown 57595b482a8SLen Brown /* 57695b482a8SLen Brown * April 2006: Changed to match MS behavior 57795b482a8SLen Brown * 57895b482a8SLen Brown * The value written to the Index register is the byte offset of the 57995b482a8SLen Brown * target field in units of the granularity of the index_field 58095b482a8SLen Brown * 58195b482a8SLen Brown * Previously, the value was calculated as an index in terms of the 58295b482a8SLen Brown * width of the Data register, as below: 58395b482a8SLen Brown * 58495b482a8SLen Brown * obj_desc->index_field.Value = (u32) 58595b482a8SLen Brown * (Info->field_bit_position / ACPI_MUL_8 ( 58695b482a8SLen Brown * obj_desc->Field.access_byte_width)); 58795b482a8SLen Brown * 58895b482a8SLen Brown * February 2006: Tried value as a byte offset: 58995b482a8SLen Brown * obj_desc->index_field.Value = (u32) 59095b482a8SLen Brown * ACPI_DIV_8 (Info->field_bit_position); 59195b482a8SLen Brown */ 59295b482a8SLen Brown obj_desc->index_field.value = 59395b482a8SLen Brown (u32) ACPI_ROUND_DOWN(ACPI_DIV_8(info->field_bit_position), 59495b482a8SLen Brown obj_desc->index_field. 59595b482a8SLen Brown access_byte_width); 59695b482a8SLen Brown 59795b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 59895b482a8SLen Brown "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n", 59995b482a8SLen Brown obj_desc->index_field.start_field_bit_offset, 60095b482a8SLen Brown obj_desc->index_field.base_byte_offset, 60195b482a8SLen Brown obj_desc->index_field.value, 60295b482a8SLen Brown obj_desc->field.access_byte_width, 60395b482a8SLen Brown obj_desc->index_field.index_obj, 60495b482a8SLen Brown obj_desc->index_field.data_obj)); 60595b482a8SLen Brown break; 60695b482a8SLen Brown 60795b482a8SLen Brown default: 6081d1ea1b7SChao Guan 60995b482a8SLen Brown /* No other types should get here */ 6101d1ea1b7SChao Guan 61195b482a8SLen Brown break; 61295b482a8SLen Brown } 61395b482a8SLen Brown 61495b482a8SLen Brown /* 61595b482a8SLen Brown * Store the constructed descriptor (obj_desc) into the parent Node, 61695b482a8SLen Brown * preserving the current type of that named_obj. 61795b482a8SLen Brown */ 61895b482a8SLen Brown status = acpi_ns_attach_object(info->field_node, obj_desc, 61995b482a8SLen Brown acpi_ns_get_type(info->field_node)); 62095b482a8SLen Brown 62195b482a8SLen Brown ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, 62295b482a8SLen Brown "Set NamedObj %p [%4.4s], ObjDesc %p\n", 62395b482a8SLen Brown info->field_node, 62495b482a8SLen Brown acpi_ut_get_node_name(info->field_node), obj_desc)); 62595b482a8SLen Brown 62695b482a8SLen Brown /* Remove local reference to the object */ 62795b482a8SLen Brown 62895b482a8SLen Brown acpi_ut_remove_reference(obj_desc); 62995b482a8SLen Brown return_ACPI_STATUS(status); 63095b482a8SLen Brown } 631