Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /****************************************************************************** |
| 2 | * |
| 3 | * Module Name: exfldio - Aml Field I/O |
| 4 | * |
| 5 | *****************************************************************************/ |
| 6 | |
| 7 | /* |
Len Brown | 75a44ce | 2008-04-23 23:00:13 -0400 | [diff] [blame] | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 9 | * All rights reserved. |
| 10 | * |
| 11 | * Redistribution and use in source and binary forms, with or without |
| 12 | * modification, are permitted provided that the following conditions |
| 13 | * are met: |
| 14 | * 1. Redistributions of source code must retain the above copyright |
| 15 | * notice, this list of conditions, and the following disclaimer, |
| 16 | * without modification. |
| 17 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer |
| 18 | * substantially similar to the "NO WARRANTY" disclaimer below |
| 19 | * ("Disclaimer") and any redistribution must be conditioned upon |
| 20 | * including a substantially similar Disclaimer requirement for further |
| 21 | * binary redistribution. |
| 22 | * 3. Neither the names of the above-listed copyright holders nor the names |
| 23 | * of any contributors may be used to endorse or promote products derived |
| 24 | * from this software without specific prior written permission. |
| 25 | * |
| 26 | * Alternatively, this software may be distributed under the terms of the |
| 27 | * GNU General Public License ("GPL") version 2 as published by the Free |
| 28 | * Software Foundation. |
| 29 | * |
| 30 | * NO WARRANTY |
| 31 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 32 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 33 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR |
| 34 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 35 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 36 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 37 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 38 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 39 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| 40 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 41 | * POSSIBILITY OF SUCH DAMAGES. |
| 42 | */ |
| 43 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | #include <acpi/acpi.h> |
| 45 | #include <acpi/acinterp.h> |
| 46 | #include <acpi/amlcode.h> |
| 47 | #include <acpi/acevents.h> |
| 48 | #include <acpi/acdispat.h> |
| 49 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | #define _COMPONENT ACPI_EXECUTER |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 51 | ACPI_MODULE_NAME("exfldio") |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 53 | /* Local prototypes */ |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 54 | static acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 55 | acpi_ex_field_datum_io(union acpi_operand_object *obj_desc, |
| 56 | u32 field_datum_byte_offset, |
| 57 | acpi_integer * value, u32 read_write); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 58 | |
| 59 | static u8 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 60 | acpi_ex_register_overflow(union acpi_operand_object *obj_desc, |
| 61 | acpi_integer value); |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 62 | |
| 63 | static acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 64 | acpi_ex_setup_region(union acpi_operand_object *obj_desc, |
| 65 | u32 field_datum_byte_offset); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | |
| 67 | /******************************************************************************* |
| 68 | * |
| 69 | * FUNCTION: acpi_ex_setup_region |
| 70 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 71 | * PARAMETERS: obj_desc - Field to be read or written |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 72 | * field_datum_byte_offset - Byte offset of this datum within the |
| 73 | * parent field |
| 74 | * |
| 75 | * RETURN: Status |
| 76 | * |
| 77 | * DESCRIPTION: Common processing for acpi_ex_extract_from_field and |
| 78 | * acpi_ex_insert_into_field. Initialize the Region if necessary and |
| 79 | * validate the request. |
| 80 | * |
| 81 | ******************************************************************************/ |
| 82 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 83 | static acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 84 | acpi_ex_setup_region(union acpi_operand_object *obj_desc, |
| 85 | u32 field_datum_byte_offset) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 87 | acpi_status status = AE_OK; |
| 88 | union acpi_operand_object *rgn_desc; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 90 | ACPI_FUNCTION_TRACE_U32(ex_setup_region, field_datum_byte_offset); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
| 92 | rgn_desc = obj_desc->common_field.region_obj; |
| 93 | |
| 94 | /* We must have a valid region */ |
| 95 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 96 | if (ACPI_GET_OBJECT_TYPE(rgn_desc) != ACPI_TYPE_REGION) { |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 97 | ACPI_ERROR((AE_INFO, "Needed Region, found type %X (%s)", |
| 98 | ACPI_GET_OBJECT_TYPE(rgn_desc), |
| 99 | acpi_ut_get_object_type_name(rgn_desc))); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 101 | return_ACPI_STATUS(AE_AML_OPERAND_TYPE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | /* |
| 105 | * If the Region Address and Length have not been previously evaluated, |
| 106 | * evaluate them now and save the results. |
| 107 | */ |
| 108 | if (!(rgn_desc->common.flags & AOPOBJ_DATA_VALID)) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 109 | status = acpi_ds_get_region_arguments(rgn_desc); |
| 110 | if (ACPI_FAILURE(status)) { |
| 111 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | } |
| 113 | } |
| 114 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 115 | /* Exit if Address/Length have been disallowed by the host OS */ |
| 116 | |
| 117 | if (rgn_desc->common.flags & AOPOBJ_INVALID) { |
| 118 | return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS); |
| 119 | } |
| 120 | |
| 121 | /* |
| 122 | * Exit now for SMBus address space, it has a non-linear address space |
| 123 | * and the request cannot be directly validated |
| 124 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | if (rgn_desc->region.space_id == ACPI_ADR_SPACE_SMBUS) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 126 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 127 | /* SMBus has a non-linear address space */ |
| 128 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 129 | return_ACPI_STATUS(AE_OK); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | #ifdef ACPI_UNDER_DEVELOPMENT |
| 132 | /* |
| 133 | * If the Field access is any_acc, we can now compute the optimal |
| 134 | * access (because we know know the length of the parent region) |
| 135 | */ |
| 136 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 137 | if (ACPI_FAILURE(status)) { |
| 138 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | } |
| 140 | } |
| 141 | #endif |
| 142 | |
| 143 | /* |
| 144 | * Validate the request. The entire request from the byte offset for a |
| 145 | * length of one field datum (access width) must fit within the region. |
| 146 | * (Region length is specified in bytes) |
| 147 | */ |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 148 | if (rgn_desc->region.length < |
| 149 | (obj_desc->common_field.base_byte_offset + |
| 150 | field_datum_byte_offset + |
| 151 | obj_desc->common_field.access_byte_width)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | if (acpi_gbl_enable_interpreter_slack) { |
| 153 | /* |
| 154 | * Slack mode only: We will go ahead and allow access to this |
| 155 | * field if it is within the region length rounded up to the next |
| 156 | * access width boundary. |
| 157 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 158 | if (ACPI_ROUND_UP(rgn_desc->region.length, |
| 159 | obj_desc->common_field. |
| 160 | access_byte_width) >= |
| 161 | (obj_desc->common_field.base_byte_offset + |
| 162 | (acpi_native_uint) obj_desc->common_field. |
| 163 | access_byte_width + field_datum_byte_offset)) { |
| 164 | return_ACPI_STATUS(AE_OK); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 165 | } |
| 166 | } |
| 167 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 168 | if (rgn_desc->region.length < |
| 169 | obj_desc->common_field.access_byte_width) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | /* |
| 171 | * This is the case where the access_type (acc_word, etc.) is wider |
| 172 | * than the region itself. For example, a region of length one |
| 173 | * byte, and a field with Dword access specified. |
| 174 | */ |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 175 | ACPI_ERROR((AE_INFO, |
| 176 | "Field [%4.4s] access width (%d bytes) too large for region [%4.4s] (length %X)", |
| 177 | acpi_ut_get_node_name(obj_desc-> |
| 178 | common_field.node), |
| 179 | obj_desc->common_field.access_byte_width, |
| 180 | acpi_ut_get_node_name(rgn_desc->region. |
| 181 | node), |
| 182 | rgn_desc->region.length)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | /* |
| 186 | * Offset rounded up to next multiple of field width |
| 187 | * exceeds region length, indicate an error |
| 188 | */ |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 189 | ACPI_ERROR((AE_INFO, |
| 190 | "Field [%4.4s] Base+Offset+Width %X+%X+%X is beyond end of region [%4.4s] (length %X)", |
| 191 | acpi_ut_get_node_name(obj_desc->common_field.node), |
| 192 | obj_desc->common_field.base_byte_offset, |
| 193 | field_datum_byte_offset, |
| 194 | obj_desc->common_field.access_byte_width, |
| 195 | acpi_ut_get_node_name(rgn_desc->region.node), |
| 196 | rgn_desc->region.length)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 198 | return_ACPI_STATUS(AE_AML_REGION_LIMIT); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | } |
| 200 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 201 | return_ACPI_STATUS(AE_OK); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | } |
| 203 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 204 | /******************************************************************************* |
| 205 | * |
| 206 | * FUNCTION: acpi_ex_access_region |
| 207 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 208 | * PARAMETERS: obj_desc - Field to be read |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 209 | * field_datum_byte_offset - Byte offset of this datum within the |
| 210 | * parent field |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 211 | * Value - Where to store value (must at least |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | * the size of acpi_integer) |
| 213 | * Function - Read or Write flag plus other region- |
| 214 | * dependent flags |
| 215 | * |
| 216 | * RETURN: Status |
| 217 | * |
| 218 | * DESCRIPTION: Read or Write a single field datum to an Operation Region. |
| 219 | * |
| 220 | ******************************************************************************/ |
| 221 | |
| 222 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 223 | acpi_ex_access_region(union acpi_operand_object *obj_desc, |
| 224 | u32 field_datum_byte_offset, |
| 225 | acpi_integer * value, u32 function) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 227 | acpi_status status; |
| 228 | union acpi_operand_object *rgn_desc; |
| 229 | acpi_physical_address address; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 230 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 231 | ACPI_FUNCTION_TRACE(ex_access_region); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | |
| 233 | /* |
| 234 | * Ensure that the region operands are fully evaluated and verify |
| 235 | * the validity of the request |
| 236 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 237 | status = acpi_ex_setup_region(obj_desc, field_datum_byte_offset); |
| 238 | if (ACPI_FAILURE(status)) { |
| 239 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | } |
| 241 | |
| 242 | /* |
| 243 | * The physical address of this field datum is: |
| 244 | * |
| 245 | * 1) The base of the region, plus |
| 246 | * 2) The base offset of the field, plus |
| 247 | * 3) The current offset into the field |
| 248 | */ |
| 249 | rgn_desc = obj_desc->common_field.region_obj; |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 250 | address = rgn_desc->region.address + |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 251 | obj_desc->common_field.base_byte_offset + field_datum_byte_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 252 | |
| 253 | if ((function & ACPI_IO_MASK) == ACPI_READ) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 254 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[READ]")); |
| 255 | } else { |
| 256 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[WRITE]")); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 257 | } |
| 258 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 259 | ACPI_DEBUG_PRINT_RAW((ACPI_DB_BFIELD, |
Bob Moore | f3d2e78 | 2007-02-02 19:48:18 +0300 | [diff] [blame] | 260 | " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %p\n", |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 261 | acpi_ut_get_region_name(rgn_desc->region. |
| 262 | space_id), |
| 263 | rgn_desc->region.space_id, |
| 264 | obj_desc->common_field.access_byte_width, |
| 265 | obj_desc->common_field.base_byte_offset, |
Bob Moore | b7f9f04 | 2008-04-10 19:06:40 +0400 | [diff] [blame] | 266 | field_datum_byte_offset, ACPI_CAST_PTR(void, |
| 267 | address))); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 268 | |
| 269 | /* Invoke the appropriate address_space/op_region handler */ |
| 270 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 271 | status = acpi_ev_address_space_dispatch(rgn_desc, function, |
| 272 | address, |
| 273 | ACPI_MUL_8(obj_desc-> |
| 274 | common_field. |
| 275 | access_byte_width), |
| 276 | value); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 278 | if (ACPI_FAILURE(status)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | if (status == AE_NOT_IMPLEMENTED) { |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 280 | ACPI_ERROR((AE_INFO, |
| 281 | "Region %s(%X) not implemented", |
| 282 | acpi_ut_get_region_name(rgn_desc->region. |
| 283 | space_id), |
| 284 | rgn_desc->region.space_id)); |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 285 | } else if (status == AE_NOT_EXIST) { |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 286 | ACPI_ERROR((AE_INFO, |
| 287 | "Region %s(%X) has no handler", |
| 288 | acpi_ut_get_region_name(rgn_desc->region. |
| 289 | space_id), |
| 290 | rgn_desc->region.space_id)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | } |
| 292 | } |
| 293 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 294 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 295 | } |
| 296 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 297 | /******************************************************************************* |
| 298 | * |
| 299 | * FUNCTION: acpi_ex_register_overflow |
| 300 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 301 | * PARAMETERS: obj_desc - Register(Field) to be written |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 302 | * Value - Value to be stored |
| 303 | * |
| 304 | * RETURN: TRUE if value overflows the field, FALSE otherwise |
| 305 | * |
| 306 | * DESCRIPTION: Check if a value is out of range of the field being written. |
| 307 | * Used to check if the values written to Index and Bank registers |
| 308 | * are out of range. Normally, the value is simply truncated |
| 309 | * to fit the field, but this case is most likely a serious |
| 310 | * coding error in the ASL. |
| 311 | * |
| 312 | ******************************************************************************/ |
| 313 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 314 | static u8 |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 315 | acpi_ex_register_overflow(union acpi_operand_object *obj_desc, |
| 316 | acpi_integer value) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 317 | { |
| 318 | |
| 319 | if (obj_desc->common_field.bit_length >= ACPI_INTEGER_BIT_SIZE) { |
| 320 | /* |
| 321 | * The field is large enough to hold the maximum integer, so we can |
| 322 | * never overflow it. |
| 323 | */ |
| 324 | return (FALSE); |
| 325 | } |
| 326 | |
| 327 | if (value >= ((acpi_integer) 1 << obj_desc->common_field.bit_length)) { |
| 328 | /* |
| 329 | * The Value is larger than the maximum value that can fit into |
| 330 | * the register. |
| 331 | */ |
| 332 | return (TRUE); |
| 333 | } |
| 334 | |
| 335 | /* The Value will fit into the field with no truncation */ |
| 336 | |
| 337 | return (FALSE); |
| 338 | } |
| 339 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 340 | /******************************************************************************* |
| 341 | * |
| 342 | * FUNCTION: acpi_ex_field_datum_io |
| 343 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 344 | * PARAMETERS: obj_desc - Field to be read |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | * field_datum_byte_offset - Byte offset of this datum within the |
| 346 | * parent field |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 347 | * Value - Where to store value (must be 64 bits) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 348 | * read_write - Read or Write flag |
| 349 | * |
| 350 | * RETURN: Status |
| 351 | * |
| 352 | * DESCRIPTION: Read or Write a single datum of a field. The field_type is |
| 353 | * demultiplexed here to handle the different types of fields |
| 354 | * (buffer_field, region_field, index_field, bank_field) |
| 355 | * |
| 356 | ******************************************************************************/ |
| 357 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 358 | static acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 359 | acpi_ex_field_datum_io(union acpi_operand_object *obj_desc, |
| 360 | u32 field_datum_byte_offset, |
| 361 | acpi_integer * value, u32 read_write) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 362 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 363 | acpi_status status; |
| 364 | acpi_integer local_value; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 366 | ACPI_FUNCTION_TRACE_U32(ex_field_datum_io, field_datum_byte_offset); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 367 | |
| 368 | if (read_write == ACPI_READ) { |
| 369 | if (!value) { |
| 370 | local_value = 0; |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 371 | |
| 372 | /* To support reads without saving return value */ |
| 373 | value = &local_value; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 374 | } |
| 375 | |
| 376 | /* Clear the entire return buffer first, [Very Important!] */ |
| 377 | |
| 378 | *value = 0; |
| 379 | } |
| 380 | |
| 381 | /* |
| 382 | * The four types of fields are: |
| 383 | * |
| 384 | * buffer_field - Read/write from/to a Buffer |
| 385 | * region_field - Read/write from/to a Operation Region. |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 386 | * bank_field - Write to a Bank Register, then read/write from/to an |
| 387 | * operation_region |
| 388 | * index_field - Write to an Index Register, then read/write from/to a |
| 389 | * Data Register |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 390 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 391 | switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 392 | case ACPI_TYPE_BUFFER_FIELD: |
| 393 | /* |
| 394 | * If the buffer_field arguments have not been previously evaluated, |
| 395 | * evaluate them now and save the results. |
| 396 | */ |
| 397 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 398 | status = acpi_ds_get_buffer_field_arguments(obj_desc); |
| 399 | if (ACPI_FAILURE(status)) { |
| 400 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 401 | } |
| 402 | } |
| 403 | |
| 404 | if (read_write == ACPI_READ) { |
| 405 | /* |
| 406 | * Copy the data from the source buffer. |
| 407 | * Length is the field width in bytes. |
| 408 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 409 | ACPI_MEMCPY(value, |
| 410 | (obj_desc->buffer_field.buffer_obj)->buffer. |
| 411 | pointer + |
| 412 | obj_desc->buffer_field.base_byte_offset + |
| 413 | field_datum_byte_offset, |
| 414 | obj_desc->common_field.access_byte_width); |
| 415 | } else { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 416 | /* |
| 417 | * Copy the data to the target buffer. |
| 418 | * Length is the field width in bytes. |
| 419 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 420 | ACPI_MEMCPY((obj_desc->buffer_field.buffer_obj)->buffer. |
| 421 | pointer + |
| 422 | obj_desc->buffer_field.base_byte_offset + |
| 423 | field_datum_byte_offset, value, |
| 424 | obj_desc->common_field.access_byte_width); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 425 | } |
| 426 | |
| 427 | status = AE_OK; |
| 428 | break; |
| 429 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 430 | case ACPI_TYPE_LOCAL_BANK_FIELD: |
| 431 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 432 | /* |
| 433 | * Ensure that the bank_value is not beyond the capacity of |
| 434 | * the register |
| 435 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 436 | if (acpi_ex_register_overflow(obj_desc->bank_field.bank_obj, |
| 437 | (acpi_integer) obj_desc-> |
| 438 | bank_field.value)) { |
| 439 | return_ACPI_STATUS(AE_AML_REGISTER_LIMIT); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 440 | } |
| 441 | |
| 442 | /* |
| 443 | * For bank_fields, we must write the bank_value to the bank_register |
| 444 | * (itself a region_field) before we can access the data. |
| 445 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 446 | status = |
| 447 | acpi_ex_insert_into_field(obj_desc->bank_field.bank_obj, |
| 448 | &obj_desc->bank_field.value, |
| 449 | sizeof(obj_desc->bank_field. |
| 450 | value)); |
| 451 | if (ACPI_FAILURE(status)) { |
| 452 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 453 | } |
| 454 | |
| 455 | /* |
| 456 | * Now that the Bank has been selected, fall through to the |
| 457 | * region_field case and write the datum to the Operation Region |
| 458 | */ |
| 459 | |
| 460 | /*lint -fallthrough */ |
| 461 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 462 | case ACPI_TYPE_LOCAL_REGION_FIELD: |
| 463 | /* |
| 464 | * For simple region_fields, we just directly access the owning |
| 465 | * Operation Region. |
| 466 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 467 | status = |
| 468 | acpi_ex_access_region(obj_desc, field_datum_byte_offset, |
| 469 | value, read_write); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 470 | break; |
| 471 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 472 | case ACPI_TYPE_LOCAL_INDEX_FIELD: |
| 473 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 474 | /* |
| 475 | * Ensure that the index_value is not beyond the capacity of |
| 476 | * the register |
| 477 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 478 | if (acpi_ex_register_overflow(obj_desc->index_field.index_obj, |
| 479 | (acpi_integer) obj_desc-> |
| 480 | index_field.value)) { |
| 481 | return_ACPI_STATUS(AE_AML_REGISTER_LIMIT); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 482 | } |
| 483 | |
| 484 | /* Write the index value to the index_register (itself a region_field) */ |
| 485 | |
| 486 | field_datum_byte_offset += obj_desc->index_field.value; |
| 487 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 488 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
| 489 | "Write to Index Register: Value %8.8X\n", |
| 490 | field_datum_byte_offset)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 491 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 492 | status = |
| 493 | acpi_ex_insert_into_field(obj_desc->index_field.index_obj, |
| 494 | &field_datum_byte_offset, |
| 495 | sizeof(field_datum_byte_offset)); |
| 496 | if (ACPI_FAILURE(status)) { |
| 497 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 498 | } |
| 499 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 500 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 501 | "I/O to Data Register: ValuePtr %p\n", |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 502 | value)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 503 | |
| 504 | if (read_write == ACPI_READ) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 505 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 506 | /* Read the datum from the data_register */ |
| 507 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 508 | status = |
| 509 | acpi_ex_extract_from_field(obj_desc->index_field. |
| 510 | data_obj, value, |
| 511 | sizeof(acpi_integer)); |
| 512 | } else { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 513 | /* Write the datum to the data_register */ |
| 514 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 515 | status = |
| 516 | acpi_ex_insert_into_field(obj_desc->index_field. |
| 517 | data_obj, value, |
| 518 | sizeof(acpi_integer)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 519 | } |
| 520 | break; |
| 521 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 522 | default: |
| 523 | |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 524 | ACPI_ERROR((AE_INFO, "Wrong object type in field I/O %X", |
| 525 | ACPI_GET_OBJECT_TYPE(obj_desc))); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 526 | status = AE_AML_INTERNAL; |
| 527 | break; |
| 528 | } |
| 529 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 530 | if (ACPI_SUCCESS(status)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 531 | if (read_write == ACPI_READ) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 532 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
| 533 | "Value Read %8.8X%8.8X, Width %d\n", |
| 534 | ACPI_FORMAT_UINT64(*value), |
| 535 | obj_desc->common_field. |
| 536 | access_byte_width)); |
| 537 | } else { |
| 538 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
| 539 | "Value Written %8.8X%8.8X, Width %d\n", |
| 540 | ACPI_FORMAT_UINT64(*value), |
| 541 | obj_desc->common_field. |
| 542 | access_byte_width)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 543 | } |
| 544 | } |
| 545 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 546 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 547 | } |
| 548 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 549 | /******************************************************************************* |
| 550 | * |
| 551 | * FUNCTION: acpi_ex_write_with_update_rule |
| 552 | * |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 553 | * PARAMETERS: obj_desc - Field to be written |
| 554 | * Mask - bitmask within field datum |
| 555 | * field_value - Value to write |
| 556 | * field_datum_byte_offset - Offset of datum within field |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 557 | * |
| 558 | * RETURN: Status |
| 559 | * |
| 560 | * DESCRIPTION: Apply the field update rule to a field write |
| 561 | * |
| 562 | ******************************************************************************/ |
| 563 | |
| 564 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 565 | acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc, |
| 566 | acpi_integer mask, |
| 567 | acpi_integer field_value, |
| 568 | u32 field_datum_byte_offset) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 569 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 570 | acpi_status status = AE_OK; |
| 571 | acpi_integer merged_value; |
| 572 | acpi_integer current_value; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 573 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 574 | ACPI_FUNCTION_TRACE_U32(ex_write_with_update_rule, mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 575 | |
| 576 | /* Start with the new bits */ |
| 577 | |
| 578 | merged_value = field_value; |
| 579 | |
| 580 | /* If the mask is all ones, we don't need to worry about the update rule */ |
| 581 | |
| 582 | if (mask != ACPI_INTEGER_MAX) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 583 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 584 | /* Decode the update rule */ |
| 585 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 586 | switch (obj_desc->common_field. |
| 587 | field_flags & AML_FIELD_UPDATE_RULE_MASK) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 588 | case AML_FIELD_UPDATE_PRESERVE: |
| 589 | /* |
| 590 | * Check if update rule needs to be applied (not if mask is all |
| 591 | * ones) The left shift drops the bits we want to ignore. |
| 592 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 593 | if ((~mask << (ACPI_MUL_8(sizeof(mask)) - |
| 594 | ACPI_MUL_8(obj_desc->common_field. |
| 595 | access_byte_width))) != 0) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 596 | /* |
| 597 | * Read the current contents of the byte/word/dword containing |
| 598 | * the field, and merge with the new field value. |
| 599 | */ |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 600 | status = |
| 601 | acpi_ex_field_datum_io(obj_desc, |
| 602 | field_datum_byte_offset, |
| 603 | ¤t_value, |
| 604 | ACPI_READ); |
| 605 | if (ACPI_FAILURE(status)) { |
| 606 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 607 | } |
| 608 | |
| 609 | merged_value |= (current_value & ~mask); |
| 610 | } |
| 611 | break; |
| 612 | |
| 613 | case AML_FIELD_UPDATE_WRITE_AS_ONES: |
| 614 | |
| 615 | /* Set positions outside the field to all ones */ |
| 616 | |
| 617 | merged_value |= ~mask; |
| 618 | break; |
| 619 | |
| 620 | case AML_FIELD_UPDATE_WRITE_AS_ZEROS: |
| 621 | |
| 622 | /* Set positions outside the field to all zeros */ |
| 623 | |
| 624 | merged_value &= mask; |
| 625 | break; |
| 626 | |
| 627 | default: |
| 628 | |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 629 | ACPI_ERROR((AE_INFO, |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 630 | "Unknown UpdateRule value: %X", |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 631 | (obj_desc->common_field. |
| 632 | field_flags & |
| 633 | AML_FIELD_UPDATE_RULE_MASK))); |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 634 | return_ACPI_STATUS(AE_AML_OPERAND_VALUE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 635 | } |
| 636 | } |
| 637 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 638 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 639 | "Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n", |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 640 | ACPI_FORMAT_UINT64(mask), |
| 641 | field_datum_byte_offset, |
| 642 | obj_desc->common_field.access_byte_width, |
| 643 | ACPI_FORMAT_UINT64(field_value), |
| 644 | ACPI_FORMAT_UINT64(merged_value))); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 645 | |
| 646 | /* Write the merged value */ |
| 647 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 648 | status = acpi_ex_field_datum_io(obj_desc, field_datum_byte_offset, |
| 649 | &merged_value, ACPI_WRITE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 650 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 651 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 652 | } |
| 653 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 654 | /******************************************************************************* |
| 655 | * |
| 656 | * FUNCTION: acpi_ex_extract_from_field |
| 657 | * |
| 658 | * PARAMETERS: obj_desc - Field to be read |
| 659 | * Buffer - Where to store the field data |
| 660 | * buffer_length - Length of Buffer |
| 661 | * |
| 662 | * RETURN: Status |
| 663 | * |
| 664 | * DESCRIPTION: Retrieve the current value of the given field |
| 665 | * |
| 666 | ******************************************************************************/ |
| 667 | |
| 668 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 669 | acpi_ex_extract_from_field(union acpi_operand_object *obj_desc, |
| 670 | void *buffer, u32 buffer_length) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 671 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 672 | acpi_status status; |
| 673 | acpi_integer raw_datum; |
| 674 | acpi_integer merged_datum; |
| 675 | u32 field_offset = 0; |
| 676 | u32 buffer_offset = 0; |
| 677 | u32 buffer_tail_bits; |
| 678 | u32 datum_count; |
| 679 | u32 field_datum_count; |
| 680 | u32 i; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 681 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 682 | ACPI_FUNCTION_TRACE(ex_extract_from_field); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 683 | |
| 684 | /* Validate target buffer and clear it */ |
| 685 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 686 | if (buffer_length < |
| 687 | ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length)) { |
Bob Moore | b8e4d89 | 2006-01-27 16:43:00 -0500 | [diff] [blame] | 688 | ACPI_ERROR((AE_INFO, |
| 689 | "Field size %X (bits) is too large for buffer (%X)", |
| 690 | obj_desc->common_field.bit_length, buffer_length)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 691 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 692 | return_ACPI_STATUS(AE_BUFFER_OVERFLOW); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 693 | } |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 694 | ACPI_MEMSET(buffer, 0, buffer_length); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 695 | |
| 696 | /* Compute the number of datums (access width data items) */ |
| 697 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 698 | datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length, |
| 699 | obj_desc->common_field.access_bit_width); |
| 700 | field_datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length + |
| 701 | obj_desc->common_field. |
| 702 | start_field_bit_offset, |
| 703 | obj_desc->common_field. |
| 704 | access_bit_width); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 705 | |
| 706 | /* Priming read from the field */ |
| 707 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 708 | status = |
| 709 | acpi_ex_field_datum_io(obj_desc, field_offset, &raw_datum, |
| 710 | ACPI_READ); |
| 711 | if (ACPI_FAILURE(status)) { |
| 712 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 713 | } |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 714 | merged_datum = |
| 715 | raw_datum >> obj_desc->common_field.start_field_bit_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 716 | |
| 717 | /* Read the rest of the field */ |
| 718 | |
| 719 | for (i = 1; i < field_datum_count; i++) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 720 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 721 | /* Get next input datum from the field */ |
| 722 | |
| 723 | field_offset += obj_desc->common_field.access_byte_width; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 724 | status = acpi_ex_field_datum_io(obj_desc, field_offset, |
| 725 | &raw_datum, ACPI_READ); |
| 726 | if (ACPI_FAILURE(status)) { |
| 727 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 728 | } |
| 729 | |
Bob Moore | 967440e3 | 2006-06-23 17:04:00 -0400 | [diff] [blame] | 730 | /* |
| 731 | * Merge with previous datum if necessary. |
| 732 | * |
| 733 | * Note: Before the shift, check if the shift value will be larger than |
| 734 | * the integer size. If so, there is no need to perform the operation. |
| 735 | * This avoids the differences in behavior between different compilers |
| 736 | * concerning shift values larger than the target data width. |
| 737 | */ |
| 738 | if ((obj_desc->common_field.access_bit_width - |
| 739 | obj_desc->common_field.start_field_bit_offset) < |
| 740 | ACPI_INTEGER_BIT_SIZE) { |
| 741 | merged_datum |= |
| 742 | raw_datum << (obj_desc->common_field. |
| 743 | access_bit_width - |
| 744 | obj_desc->common_field. |
| 745 | start_field_bit_offset); |
| 746 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 747 | |
| 748 | if (i == datum_count) { |
| 749 | break; |
| 750 | } |
| 751 | |
| 752 | /* Write merged datum to target buffer */ |
| 753 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 754 | ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum, |
| 755 | ACPI_MIN(obj_desc->common_field.access_byte_width, |
| 756 | buffer_length - buffer_offset)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 757 | |
| 758 | buffer_offset += obj_desc->common_field.access_byte_width; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 759 | merged_datum = |
| 760 | raw_datum >> obj_desc->common_field.start_field_bit_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 761 | } |
| 762 | |
| 763 | /* Mask off any extra bits in the last datum */ |
| 764 | |
Robert Moore | 44f6c01 | 2005-04-18 22:49:35 -0400 | [diff] [blame] | 765 | buffer_tail_bits = obj_desc->common_field.bit_length % |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 766 | obj_desc->common_field.access_bit_width; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 767 | if (buffer_tail_bits) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 768 | merged_datum &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 769 | } |
| 770 | |
| 771 | /* Write the last datum to the buffer */ |
| 772 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 773 | ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum, |
| 774 | ACPI_MIN(obj_desc->common_field.access_byte_width, |
| 775 | buffer_length - buffer_offset)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 776 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 777 | return_ACPI_STATUS(AE_OK); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 778 | } |
| 779 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 780 | /******************************************************************************* |
| 781 | * |
| 782 | * FUNCTION: acpi_ex_insert_into_field |
| 783 | * |
| 784 | * PARAMETERS: obj_desc - Field to be written |
| 785 | * Buffer - Data to be written |
| 786 | * buffer_length - Length of Buffer |
| 787 | * |
| 788 | * RETURN: Status |
| 789 | * |
| 790 | * DESCRIPTION: Store the Buffer contents into the given field |
| 791 | * |
| 792 | ******************************************************************************/ |
| 793 | |
| 794 | acpi_status |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 795 | acpi_ex_insert_into_field(union acpi_operand_object *obj_desc, |
| 796 | void *buffer, u32 buffer_length) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 797 | { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 798 | acpi_status status; |
| 799 | acpi_integer mask; |
Bob Moore | 4c90ece | 2006-06-08 16:29:00 -0400 | [diff] [blame] | 800 | acpi_integer width_mask; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 801 | acpi_integer merged_datum; |
| 802 | acpi_integer raw_datum = 0; |
| 803 | u32 field_offset = 0; |
| 804 | u32 buffer_offset = 0; |
| 805 | u32 buffer_tail_bits; |
| 806 | u32 datum_count; |
| 807 | u32 field_datum_count; |
| 808 | u32 i; |
Bob Moore | 9aa6169 | 2008-04-10 19:06:41 +0400 | [diff] [blame] | 809 | u32 required_length; |
| 810 | void *new_buffer; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 811 | |
Bob Moore | b229cf9 | 2006-04-21 17:15:00 -0400 | [diff] [blame] | 812 | ACPI_FUNCTION_TRACE(ex_insert_into_field); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 813 | |
| 814 | /* Validate input buffer */ |
| 815 | |
Bob Moore | 9aa6169 | 2008-04-10 19:06:41 +0400 | [diff] [blame] | 816 | new_buffer = NULL; |
| 817 | required_length = |
| 818 | ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length); |
| 819 | /* |
| 820 | * We must have a buffer that is at least as long as the field |
| 821 | * we are writing to. This is because individual fields are |
| 822 | * indivisible and partial writes are not supported -- as per |
| 823 | * the ACPI specification. |
| 824 | */ |
| 825 | if (buffer_length < required_length) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 826 | |
Bob Moore | 9aa6169 | 2008-04-10 19:06:41 +0400 | [diff] [blame] | 827 | /* We need to create a new buffer */ |
| 828 | |
| 829 | new_buffer = ACPI_ALLOCATE_ZEROED(required_length); |
| 830 | if (!new_buffer) { |
| 831 | return_ACPI_STATUS(AE_NO_MEMORY); |
| 832 | } |
| 833 | |
| 834 | /* |
| 835 | * Copy the original data to the new buffer, starting |
| 836 | * at Byte zero. All unused (upper) bytes of the |
| 837 | * buffer will be 0. |
| 838 | */ |
| 839 | ACPI_MEMCPY((char *)new_buffer, (char *)buffer, buffer_length); |
| 840 | buffer = new_buffer; |
| 841 | buffer_length = required_length; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 842 | } |
| 843 | |
Bob Moore | 967440e3 | 2006-06-23 17:04:00 -0400 | [diff] [blame] | 844 | /* |
| 845 | * Create the bitmasks used for bit insertion. |
| 846 | * Note: This if/else is used to bypass compiler differences with the |
| 847 | * shift operator |
| 848 | */ |
| 849 | if (obj_desc->common_field.access_bit_width == ACPI_INTEGER_BIT_SIZE) { |
| 850 | width_mask = ACPI_INTEGER_MAX; |
| 851 | } else { |
| 852 | width_mask = |
| 853 | ACPI_MASK_BITS_ABOVE(obj_desc->common_field. |
| 854 | access_bit_width); |
| 855 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 856 | |
Bob Moore | 967440e3 | 2006-06-23 17:04:00 -0400 | [diff] [blame] | 857 | mask = width_mask & |
| 858 | ACPI_MASK_BITS_BELOW(obj_desc->common_field.start_field_bit_offset); |
| 859 | |
| 860 | /* Compute the number of datums (access width data items) */ |
Bob Moore | 4119532 | 2006-05-26 16:36:00 -0400 | [diff] [blame] | 861 | |
| 862 | datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length, |
| 863 | obj_desc->common_field.access_bit_width); |
| 864 | |
| 865 | field_datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length + |
| 866 | obj_desc->common_field. |
| 867 | start_field_bit_offset, |
| 868 | obj_desc->common_field. |
| 869 | access_bit_width); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 870 | |
| 871 | /* Get initial Datum from the input buffer */ |
| 872 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 873 | ACPI_MEMCPY(&raw_datum, buffer, |
| 874 | ACPI_MIN(obj_desc->common_field.access_byte_width, |
| 875 | buffer_length - buffer_offset)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 876 | |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 877 | merged_datum = |
| 878 | raw_datum << obj_desc->common_field.start_field_bit_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 879 | |
| 880 | /* Write the entire field */ |
| 881 | |
| 882 | for (i = 1; i < field_datum_count; i++) { |
Bob Moore | 52fc0b0 | 2006-10-02 00:00:00 -0400 | [diff] [blame] | 883 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 884 | /* Write merged datum to the target field */ |
| 885 | |
| 886 | merged_datum &= mask; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 887 | status = acpi_ex_write_with_update_rule(obj_desc, mask, |
| 888 | merged_datum, |
| 889 | field_offset); |
| 890 | if (ACPI_FAILURE(status)) { |
Bob Moore | 9aa6169 | 2008-04-10 19:06:41 +0400 | [diff] [blame] | 891 | goto exit; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 892 | } |
| 893 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 894 | field_offset += obj_desc->common_field.access_byte_width; |
Bob Moore | 967440e3 | 2006-06-23 17:04:00 -0400 | [diff] [blame] | 895 | |
| 896 | /* |
| 897 | * Start new output datum by merging with previous input datum |
| 898 | * if necessary. |
| 899 | * |
| 900 | * Note: Before the shift, check if the shift value will be larger than |
| 901 | * the integer size. If so, there is no need to perform the operation. |
| 902 | * This avoids the differences in behavior between different compilers |
| 903 | * concerning shift values larger than the target data width. |
| 904 | */ |
| 905 | if ((obj_desc->common_field.access_bit_width - |
| 906 | obj_desc->common_field.start_field_bit_offset) < |
| 907 | ACPI_INTEGER_BIT_SIZE) { |
| 908 | merged_datum = |
| 909 | raw_datum >> (obj_desc->common_field. |
| 910 | access_bit_width - |
| 911 | obj_desc->common_field. |
| 912 | start_field_bit_offset); |
| 913 | } else { |
| 914 | merged_datum = 0; |
| 915 | } |
| 916 | |
Bob Moore | 4c90ece | 2006-06-08 16:29:00 -0400 | [diff] [blame] | 917 | mask = width_mask; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 918 | |
| 919 | if (i == datum_count) { |
| 920 | break; |
| 921 | } |
| 922 | |
| 923 | /* Get the next input datum from the buffer */ |
| 924 | |
| 925 | buffer_offset += obj_desc->common_field.access_byte_width; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 926 | ACPI_MEMCPY(&raw_datum, ((char *)buffer) + buffer_offset, |
| 927 | ACPI_MIN(obj_desc->common_field.access_byte_width, |
| 928 | buffer_length - buffer_offset)); |
| 929 | merged_datum |= |
| 930 | raw_datum << obj_desc->common_field.start_field_bit_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 931 | } |
| 932 | |
| 933 | /* Mask off any extra bits in the last datum */ |
| 934 | |
| 935 | buffer_tail_bits = (obj_desc->common_field.bit_length + |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 936 | obj_desc->common_field.start_field_bit_offset) % |
| 937 | obj_desc->common_field.access_bit_width; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 938 | if (buffer_tail_bits) { |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 939 | mask &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 940 | } |
| 941 | |
| 942 | /* Write the last datum to the field */ |
| 943 | |
| 944 | merged_datum &= mask; |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 945 | status = acpi_ex_write_with_update_rule(obj_desc, |
| 946 | mask, merged_datum, |
| 947 | field_offset); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 948 | |
Bob Moore | 9aa6169 | 2008-04-10 19:06:41 +0400 | [diff] [blame] | 949 | exit: |
| 950 | /* Free temporary buffer if we used one */ |
| 951 | |
| 952 | if (new_buffer) { |
| 953 | ACPI_FREE(new_buffer); |
| 954 | } |
Len Brown | 4be44fc | 2005-08-05 00:44:28 -0400 | [diff] [blame] | 955 | return_ACPI_STATUS(status); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 956 | } |