xref: /openbmc/linux/drivers/acpi/acpica/exregion.c (revision b04b4f78)
1 
2 /******************************************************************************
3  *
4  * Module Name: exregion - ACPI default op_region (address space) handlers
5  *
6  *****************************************************************************/
7 
8 /*
9  * Copyright (C) 2000 - 2008, Intel Corp.
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 
45 #include <acpi/acpi.h>
46 #include "accommon.h"
47 #include "acinterp.h"
48 
49 #define _COMPONENT          ACPI_EXECUTER
50 ACPI_MODULE_NAME("exregion")
51 
52 /*******************************************************************************
53  *
54  * FUNCTION:    acpi_ex_system_memory_space_handler
55  *
56  * PARAMETERS:  Function            - Read or Write operation
57  *              Address             - Where in the space to read or write
58  *              bit_width           - Field width in bits (8, 16, or 32)
59  *              Value               - Pointer to in or out value
60  *              handler_context     - Pointer to Handler's context
61  *              region_context      - Pointer to context specific to the
62  *                                    accessed region
63  *
64  * RETURN:      Status
65  *
66  * DESCRIPTION: Handler for the System Memory address space (Op Region)
67  *
68  ******************************************************************************/
69 acpi_status
70 acpi_ex_system_memory_space_handler(u32 function,
71 				    acpi_physical_address address,
72 				    u32 bit_width,
73 				    acpi_integer * value,
74 				    void *handler_context, void *region_context)
75 {
76 	acpi_status status = AE_OK;
77 	void *logical_addr_ptr = NULL;
78 	struct acpi_mem_space_context *mem_info = region_context;
79 	u32 length;
80 	acpi_size window_size;
81 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
82 	u32 remainder;
83 #endif
84 
85 	ACPI_FUNCTION_TRACE(ex_system_memory_space_handler);
86 
87 	/* Validate and translate the bit width */
88 
89 	switch (bit_width) {
90 	case 8:
91 		length = 1;
92 		break;
93 
94 	case 16:
95 		length = 2;
96 		break;
97 
98 	case 32:
99 		length = 4;
100 		break;
101 
102 	case 64:
103 		length = 8;
104 		break;
105 
106 	default:
107 		ACPI_ERROR((AE_INFO, "Invalid SystemMemory width %d",
108 			    bit_width));
109 		return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
110 	}
111 
112 #ifdef ACPI_MISALIGNMENT_NOT_SUPPORTED
113 	/*
114 	 * Hardware does not support non-aligned data transfers, we must verify
115 	 * the request.
116 	 */
117 	(void)acpi_ut_short_divide((acpi_integer) address, length, NULL,
118 				   &remainder);
119 	if (remainder != 0) {
120 		return_ACPI_STATUS(AE_AML_ALIGNMENT);
121 	}
122 #endif
123 
124 	/*
125 	 * Does the request fit into the cached memory mapping?
126 	 * Is 1) Address below the current mapping? OR
127 	 *    2) Address beyond the current mapping?
128 	 */
129 	if ((address < mem_info->mapped_physical_address) ||
130 	    (((acpi_integer) address + length) > ((acpi_integer)
131 						  mem_info->
132 						  mapped_physical_address +
133 						  mem_info->mapped_length))) {
134 		/*
135 		 * The request cannot be resolved by the current memory mapping;
136 		 * Delete the existing mapping and create a new one.
137 		 */
138 		if (mem_info->mapped_length) {
139 
140 			/* Valid mapping, delete it */
141 
142 			acpi_os_unmap_memory(mem_info->mapped_logical_address,
143 					     mem_info->mapped_length);
144 		}
145 
146 		/*
147 		 * Don't attempt to map memory beyond the end of the region, and
148 		 * constrain the maximum mapping size to something reasonable.
149 		 */
150 		window_size = (acpi_size)
151 		    ((mem_info->address + mem_info->length) - address);
152 
153 		if (window_size > ACPI_SYSMEM_REGION_WINDOW_SIZE) {
154 			window_size = ACPI_SYSMEM_REGION_WINDOW_SIZE;
155 		}
156 
157 		/* Create a new mapping starting at the address given */
158 
159 		mem_info->mapped_logical_address =
160 			acpi_os_map_memory((acpi_physical_address) address, window_size);
161 		if (!mem_info->mapped_logical_address) {
162 			ACPI_ERROR((AE_INFO,
163 				    "Could not map memory at %8.8X%8.8X, size %X",
164 				    ACPI_FORMAT_NATIVE_UINT(address),
165 				    (u32) window_size));
166 			mem_info->mapped_length = 0;
167 			return_ACPI_STATUS(AE_NO_MEMORY);
168 		}
169 
170 		/* Save the physical address and mapping size */
171 
172 		mem_info->mapped_physical_address = address;
173 		mem_info->mapped_length = window_size;
174 	}
175 
176 	/*
177 	 * Generate a logical pointer corresponding to the address we want to
178 	 * access
179 	 */
180 	logical_addr_ptr = mem_info->mapped_logical_address +
181 	    ((acpi_integer) address -
182 	     (acpi_integer) mem_info->mapped_physical_address);
183 
184 	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
185 			  "System-Memory (width %d) R/W %d Address=%8.8X%8.8X\n",
186 			  bit_width, function,
187 			  ACPI_FORMAT_NATIVE_UINT(address)));
188 
189 	/*
190 	 * Perform the memory read or write
191 	 *
192 	 * Note: For machines that do not support non-aligned transfers, the target
193 	 * address was checked for alignment above.  We do not attempt to break the
194 	 * transfer up into smaller (byte-size) chunks because the AML specifically
195 	 * asked for a transfer width that the hardware may require.
196 	 */
197 	switch (function) {
198 	case ACPI_READ:
199 
200 		*value = 0;
201 		switch (bit_width) {
202 		case 8:
203 			*value = (acpi_integer) ACPI_GET8(logical_addr_ptr);
204 			break;
205 
206 		case 16:
207 			*value = (acpi_integer) ACPI_GET16(logical_addr_ptr);
208 			break;
209 
210 		case 32:
211 			*value = (acpi_integer) ACPI_GET32(logical_addr_ptr);
212 			break;
213 
214 		case 64:
215 			*value = (acpi_integer) ACPI_GET64(logical_addr_ptr);
216 			break;
217 
218 		default:
219 			/* bit_width was already validated */
220 			break;
221 		}
222 		break;
223 
224 	case ACPI_WRITE:
225 
226 		switch (bit_width) {
227 		case 8:
228 			ACPI_SET8(logical_addr_ptr) = (u8) * value;
229 			break;
230 
231 		case 16:
232 			ACPI_SET16(logical_addr_ptr) = (u16) * value;
233 			break;
234 
235 		case 32:
236 			ACPI_SET32(logical_addr_ptr) = (u32) * value;
237 			break;
238 
239 		case 64:
240 			ACPI_SET64(logical_addr_ptr) = (u64) * value;
241 			break;
242 
243 		default:
244 			/* bit_width was already validated */
245 			break;
246 		}
247 		break;
248 
249 	default:
250 		status = AE_BAD_PARAMETER;
251 		break;
252 	}
253 
254 	return_ACPI_STATUS(status);
255 }
256 
257 /*******************************************************************************
258  *
259  * FUNCTION:    acpi_ex_system_io_space_handler
260  *
261  * PARAMETERS:  Function            - Read or Write operation
262  *              Address             - Where in the space to read or write
263  *              bit_width           - Field width in bits (8, 16, or 32)
264  *              Value               - Pointer to in or out value
265  *              handler_context     - Pointer to Handler's context
266  *              region_context      - Pointer to context specific to the
267  *                                    accessed region
268  *
269  * RETURN:      Status
270  *
271  * DESCRIPTION: Handler for the System IO address space (Op Region)
272  *
273  ******************************************************************************/
274 
275 acpi_status
276 acpi_ex_system_io_space_handler(u32 function,
277 				acpi_physical_address address,
278 				u32 bit_width,
279 				acpi_integer * value,
280 				void *handler_context, void *region_context)
281 {
282 	acpi_status status = AE_OK;
283 	u32 value32;
284 
285 	ACPI_FUNCTION_TRACE(ex_system_io_space_handler);
286 
287 	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
288 			  "System-IO (width %d) R/W %d Address=%8.8X%8.8X\n",
289 			  bit_width, function,
290 			  ACPI_FORMAT_NATIVE_UINT(address)));
291 
292 	/* Decode the function parameter */
293 
294 	switch (function) {
295 	case ACPI_READ:
296 
297 		status = acpi_hw_read_port((acpi_io_address) address,
298 					   &value32, bit_width);
299 		*value = value32;
300 		break;
301 
302 	case ACPI_WRITE:
303 
304 		status = acpi_hw_write_port((acpi_io_address) address,
305 					    (u32) * value, bit_width);
306 		break;
307 
308 	default:
309 		status = AE_BAD_PARAMETER;
310 		break;
311 	}
312 
313 	return_ACPI_STATUS(status);
314 }
315 
316 /*******************************************************************************
317  *
318  * FUNCTION:    acpi_ex_pci_config_space_handler
319  *
320  * PARAMETERS:  Function            - Read or Write operation
321  *              Address             - Where in the space to read or write
322  *              bit_width           - Field width in bits (8, 16, or 32)
323  *              Value               - Pointer to in or out value
324  *              handler_context     - Pointer to Handler's context
325  *              region_context      - Pointer to context specific to the
326  *                                    accessed region
327  *
328  * RETURN:      Status
329  *
330  * DESCRIPTION: Handler for the PCI Config address space (Op Region)
331  *
332  ******************************************************************************/
333 
334 acpi_status
335 acpi_ex_pci_config_space_handler(u32 function,
336 				 acpi_physical_address address,
337 				 u32 bit_width,
338 				 acpi_integer * value,
339 				 void *handler_context, void *region_context)
340 {
341 	acpi_status status = AE_OK;
342 	struct acpi_pci_id *pci_id;
343 	u16 pci_register;
344 	u32 value32;
345 
346 	ACPI_FUNCTION_TRACE(ex_pci_config_space_handler);
347 
348 	/*
349 	 *  The arguments to acpi_os(Read|Write)pci_configuration are:
350 	 *
351 	 *  pci_segment is the PCI bus segment range 0-31
352 	 *  pci_bus     is the PCI bus number range 0-255
353 	 *  pci_device  is the PCI device number range 0-31
354 	 *  pci_function is the PCI device function number
355 	 *  pci_register is the Config space register range 0-255 bytes
356 	 *
357 	 *  Value - input value for write, output address for read
358 	 *
359 	 */
360 	pci_id = (struct acpi_pci_id *)region_context;
361 	pci_register = (u16) (u32) address;
362 
363 	ACPI_DEBUG_PRINT((ACPI_DB_INFO,
364 			  "Pci-Config %d (%d) Seg(%04x) Bus(%04x) Dev(%04x) Func(%04x) Reg(%04x)\n",
365 			  function, bit_width, pci_id->segment, pci_id->bus,
366 			  pci_id->device, pci_id->function, pci_register));
367 
368 	switch (function) {
369 	case ACPI_READ:
370 
371 		status = acpi_os_read_pci_configuration(pci_id, pci_register,
372 							&value32, bit_width);
373 		*value = value32;
374 		break;
375 
376 	case ACPI_WRITE:
377 
378 		status = acpi_os_write_pci_configuration(pci_id, pci_register,
379 							 *value, bit_width);
380 		break;
381 
382 	default:
383 
384 		status = AE_BAD_PARAMETER;
385 		break;
386 	}
387 
388 	return_ACPI_STATUS(status);
389 }
390 
391 /*******************************************************************************
392  *
393  * FUNCTION:    acpi_ex_cmos_space_handler
394  *
395  * PARAMETERS:  Function            - Read or Write operation
396  *              Address             - Where in the space to read or write
397  *              bit_width           - Field width in bits (8, 16, or 32)
398  *              Value               - Pointer to in or out value
399  *              handler_context     - Pointer to Handler's context
400  *              region_context      - Pointer to context specific to the
401  *                                    accessed region
402  *
403  * RETURN:      Status
404  *
405  * DESCRIPTION: Handler for the CMOS address space (Op Region)
406  *
407  ******************************************************************************/
408 
409 acpi_status
410 acpi_ex_cmos_space_handler(u32 function,
411 			   acpi_physical_address address,
412 			   u32 bit_width,
413 			   acpi_integer * value,
414 			   void *handler_context, void *region_context)
415 {
416 	acpi_status status = AE_OK;
417 
418 	ACPI_FUNCTION_TRACE(ex_cmos_space_handler);
419 
420 	return_ACPI_STATUS(status);
421 }
422 
423 /*******************************************************************************
424  *
425  * FUNCTION:    acpi_ex_pci_bar_space_handler
426  *
427  * PARAMETERS:  Function            - Read or Write operation
428  *              Address             - Where in the space to read or write
429  *              bit_width           - Field width in bits (8, 16, or 32)
430  *              Value               - Pointer to in or out value
431  *              handler_context     - Pointer to Handler's context
432  *              region_context      - Pointer to context specific to the
433  *                                    accessed region
434  *
435  * RETURN:      Status
436  *
437  * DESCRIPTION: Handler for the PCI bar_target address space (Op Region)
438  *
439  ******************************************************************************/
440 
441 acpi_status
442 acpi_ex_pci_bar_space_handler(u32 function,
443 			      acpi_physical_address address,
444 			      u32 bit_width,
445 			      acpi_integer * value,
446 			      void *handler_context, void *region_context)
447 {
448 	acpi_status status = AE_OK;
449 
450 	ACPI_FUNCTION_TRACE(ex_pci_bar_space_handler);
451 
452 	return_ACPI_STATUS(status);
453 }
454 
455 /*******************************************************************************
456  *
457  * FUNCTION:    acpi_ex_data_table_space_handler
458  *
459  * PARAMETERS:  Function            - Read or Write operation
460  *              Address             - Where in the space to read or write
461  *              bit_width           - Field width in bits (8, 16, or 32)
462  *              Value               - Pointer to in or out value
463  *              handler_context     - Pointer to Handler's context
464  *              region_context      - Pointer to context specific to the
465  *                                    accessed region
466  *
467  * RETURN:      Status
468  *
469  * DESCRIPTION: Handler for the Data Table address space (Op Region)
470  *
471  ******************************************************************************/
472 
473 acpi_status
474 acpi_ex_data_table_space_handler(u32 function,
475 				 acpi_physical_address address,
476 				 u32 bit_width,
477 				 acpi_integer * value,
478 				 void *handler_context, void *region_context)
479 {
480 	ACPI_FUNCTION_TRACE(ex_data_table_space_handler);
481 
482 	/* Perform the memory read or write */
483 
484 	switch (function) {
485 	case ACPI_READ:
486 
487 		ACPI_MEMCPY(ACPI_CAST_PTR(char, value),
488 			    ACPI_PHYSADDR_TO_PTR(address),
489 			    ACPI_DIV_8(bit_width));
490 		break;
491 
492 	case ACPI_WRITE:
493 	default:
494 
495 		return_ACPI_STATUS(AE_SUPPORT);
496 	}
497 
498 	return_ACPI_STATUS(AE_OK);
499 }
500