ACPI: autoload modules - ACPICA modifications
[linux-3.10.git] / drivers / acpi / events / evrgnini.c
1 /******************************************************************************
2  *
3  * Module Name: evrgnini- ACPI address_space (op_region) init
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2007, R. Byron Moore
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
44 #include <acpi/acpi.h>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
47
48 #define _COMPONENT          ACPI_EVENTS
49 ACPI_MODULE_NAME("evrgnini")
50
51 /* Local prototypes */
52 static u8 acpi_ev_match_pci_root_bridge(char *id);
53
54 static u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node);
55
56 /*******************************************************************************
57  *
58  * FUNCTION:    acpi_ev_system_memory_region_setup
59  *
60  * PARAMETERS:  Handle              - Region we are interested in
61  *              Function            - Start or stop
62  *              handler_context     - Address space handler context
63  *              region_context      - Region specific context
64  *
65  * RETURN:      Status
66  *
67  * DESCRIPTION: Setup a system_memory operation region
68  *
69  ******************************************************************************/
70
71 acpi_status
72 acpi_ev_system_memory_region_setup(acpi_handle handle,
73                                    u32 function,
74                                    void *handler_context, void **region_context)
75 {
76         union acpi_operand_object *region_desc =
77             (union acpi_operand_object *)handle;
78         struct acpi_mem_space_context *local_region_context;
79
80         ACPI_FUNCTION_TRACE(ev_system_memory_region_setup);
81
82         if (function == ACPI_REGION_DEACTIVATE) {
83                 if (*region_context) {
84                         local_region_context =
85                             (struct acpi_mem_space_context *)*region_context;
86
87                         /* Delete a cached mapping if present */
88
89                         if (local_region_context->mapped_length) {
90                                 acpi_os_unmap_memory(local_region_context->
91                                                      mapped_logical_address,
92                                                      local_region_context->
93                                                      mapped_length);
94                         }
95                         ACPI_FREE(local_region_context);
96                         *region_context = NULL;
97                 }
98                 return_ACPI_STATUS(AE_OK);
99         }
100
101         /* Create a new context */
102
103         local_region_context =
104             ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_mem_space_context));
105         if (!(local_region_context)) {
106                 return_ACPI_STATUS(AE_NO_MEMORY);
107         }
108
109         /* Save the region length and address for use in the handler */
110
111         local_region_context->length = region_desc->region.length;
112         local_region_context->address = region_desc->region.address;
113
114         *region_context = local_region_context;
115         return_ACPI_STATUS(AE_OK);
116 }
117
118 /*******************************************************************************
119  *
120  * FUNCTION:    acpi_ev_io_space_region_setup
121  *
122  * PARAMETERS:  Handle              - Region we are interested in
123  *              Function            - Start or stop
124  *              handler_context     - Address space handler context
125  *              region_context      - Region specific context
126  *
127  * RETURN:      Status
128  *
129  * DESCRIPTION: Setup a IO operation region
130  *
131  ******************************************************************************/
132
133 acpi_status
134 acpi_ev_io_space_region_setup(acpi_handle handle,
135                               u32 function,
136                               void *handler_context, void **region_context)
137 {
138         ACPI_FUNCTION_TRACE(ev_io_space_region_setup);
139
140         if (function == ACPI_REGION_DEACTIVATE) {
141                 *region_context = NULL;
142         } else {
143                 *region_context = handler_context;
144         }
145
146         return_ACPI_STATUS(AE_OK);
147 }
148
149 /*******************************************************************************
150  *
151  * FUNCTION:    acpi_ev_pci_config_region_setup
152  *
153  * PARAMETERS:  Handle              - Region we are interested in
154  *              Function            - Start or stop
155  *              handler_context     - Address space handler context
156  *              region_context      - Region specific context
157  *
158  * RETURN:      Status
159  *
160  * DESCRIPTION: Setup a PCI_Config operation region
161  *
162  * MUTEX:       Assumes namespace is not locked
163  *
164  ******************************************************************************/
165
166 acpi_status
167 acpi_ev_pci_config_region_setup(acpi_handle handle,
168                                 u32 function,
169                                 void *handler_context, void **region_context)
170 {
171         acpi_status status = AE_OK;
172         acpi_integer pci_value;
173         struct acpi_pci_id *pci_id = *region_context;
174         union acpi_operand_object *handler_obj;
175         struct acpi_namespace_node *parent_node;
176         struct acpi_namespace_node *pci_root_node;
177         struct acpi_namespace_node *pci_device_node;
178         union acpi_operand_object *region_obj =
179             (union acpi_operand_object *)handle;
180
181         ACPI_FUNCTION_TRACE(ev_pci_config_region_setup);
182
183         handler_obj = region_obj->region.handler;
184         if (!handler_obj) {
185                 /*
186                  * No installed handler. This shouldn't happen because the dispatch
187                  * routine checks before we get here, but we check again just in case.
188                  */
189                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
190                                   "Attempting to init a region %p, with no handler\n",
191                                   region_obj));
192                 return_ACPI_STATUS(AE_NOT_EXIST);
193         }
194
195         *region_context = NULL;
196         if (function == ACPI_REGION_DEACTIVATE) {
197                 if (pci_id) {
198                         ACPI_FREE(pci_id);
199                 }
200                 return_ACPI_STATUS(status);
201         }
202
203         parent_node = acpi_ns_get_parent_node(region_obj->region.node);
204
205         /*
206          * Get the _SEG and _BBN values from the device upon which the handler
207          * is installed.
208          *
209          * We need to get the _SEG and _BBN objects relative to the PCI BUS device.
210          * This is the device the handler has been registered to handle.
211          */
212
213         /*
214          * If the address_space.Node is still pointing to the root, we need
215          * to scan upward for a PCI Root bridge and re-associate the op_region
216          * handlers with that device.
217          */
218         if (handler_obj->address_space.node == acpi_gbl_root_node) {
219
220                 /* Start search from the parent object */
221
222                 pci_root_node = parent_node;
223                 while (pci_root_node != acpi_gbl_root_node) {
224
225                         /* Get the _HID/_CID in order to detect a root_bridge */
226
227                         if (acpi_ev_is_pci_root_bridge(pci_root_node)) {
228
229                                 /* Install a handler for this PCI root bridge */
230
231                                 status =
232                                     acpi_install_address_space_handler((acpi_handle) pci_root_node, ACPI_ADR_SPACE_PCI_CONFIG, ACPI_DEFAULT_HANDLER, NULL, NULL);
233                                 if (ACPI_FAILURE(status)) {
234                                         if (status == AE_SAME_HANDLER) {
235                                                 /*
236                                                  * It is OK if the handler is already installed on the root
237                                                  * bridge.  Still need to return a context object for the
238                                                  * new PCI_Config operation region, however.
239                                                  */
240                                                 status = AE_OK;
241                                         } else {
242                                                 ACPI_EXCEPTION((AE_INFO, status,
243                                                                 "Could not install PciConfig handler for Root Bridge %4.4s",
244                                                                 acpi_ut_get_node_name
245                                                                 (pci_root_node)));
246                                         }
247                                 }
248                                 break;
249                         }
250
251                         pci_root_node = acpi_ns_get_parent_node(pci_root_node);
252                 }
253
254                 /* PCI root bridge not found, use namespace root node */
255         } else {
256                 pci_root_node = handler_obj->address_space.node;
257         }
258
259         /*
260          * If this region is now initialized, we are done.
261          * (install_address_space_handler could have initialized it)
262          */
263         if (region_obj->region.flags & AOPOBJ_SETUP_COMPLETE) {
264                 return_ACPI_STATUS(AE_OK);
265         }
266
267         /* Region is still not initialized. Create a new context */
268
269         pci_id = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pci_id));
270         if (!pci_id) {
271                 return_ACPI_STATUS(AE_NO_MEMORY);
272         }
273
274         /*
275          * For PCI_Config space access, we need the segment, bus,
276          * device and function numbers.  Acquire them here.
277          *
278          * Find the parent device object. (This allows the operation region to be
279          * within a subscope under the device, such as a control method.)
280          */
281         pci_device_node = region_obj->region.node;
282         while (pci_device_node && (pci_device_node->type != ACPI_TYPE_DEVICE)) {
283                 pci_device_node = acpi_ns_get_parent_node(pci_device_node);
284         }
285
286         if (!pci_device_node) {
287                 ACPI_FREE(pci_id);
288                 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
289         }
290
291         /*
292          * Get the PCI device and function numbers from the _ADR object
293          * contained in the parent's scope.
294          */
295         status =
296             acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR, pci_device_node,
297                                             &pci_value);
298
299         /*
300          * The default is zero, and since the allocation above zeroed
301          * the data, just do nothing on failure.
302          */
303         if (ACPI_SUCCESS(status)) {
304                 pci_id->device = ACPI_HIWORD(ACPI_LODWORD(pci_value));
305                 pci_id->function = ACPI_LOWORD(ACPI_LODWORD(pci_value));
306         }
307
308         /* The PCI segment number comes from the _SEG method */
309
310         status =
311             acpi_ut_evaluate_numeric_object(METHOD_NAME__SEG, pci_root_node,
312                                             &pci_value);
313         if (ACPI_SUCCESS(status)) {
314                 pci_id->segment = ACPI_LOWORD(pci_value);
315         }
316
317         /* The PCI bus number comes from the _BBN method */
318
319         status =
320             acpi_ut_evaluate_numeric_object(METHOD_NAME__BBN, pci_root_node,
321                                             &pci_value);
322         if (ACPI_SUCCESS(status)) {
323                 pci_id->bus = ACPI_LOWORD(pci_value);
324         }
325
326         /* Complete this device's pci_id */
327
328         acpi_os_derive_pci_id(pci_root_node, region_obj->region.node, &pci_id);
329
330         *region_context = pci_id;
331         return_ACPI_STATUS(AE_OK);
332 }
333
334 /*******************************************************************************
335  *
336  * FUNCTION:    acpi_ev_match_pci_root_bridge
337  *
338  * PARAMETERS:  Id              - The HID/CID in string format
339  *
340  * RETURN:      TRUE if the Id is a match for a PCI/PCI-Express Root Bridge
341  *
342  * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID.
343  *
344  ******************************************************************************/
345
346 static u8 acpi_ev_match_pci_root_bridge(char *id)
347 {
348
349         /*
350          * Check if this is a PCI root.
351          * ACPI 3.0+: check for a PCI Express root also.
352          */
353         if (!(ACPI_STRNCMP(id,
354                            PCI_ROOT_HID_STRING,
355                            sizeof(PCI_ROOT_HID_STRING))) ||
356             !(ACPI_STRNCMP(id,
357                            PCI_EXPRESS_ROOT_HID_STRING,
358                            sizeof(PCI_EXPRESS_ROOT_HID_STRING)))) {
359                 return (TRUE);
360         }
361
362         return (FALSE);
363 }
364
365 /*******************************************************************************
366  *
367  * FUNCTION:    acpi_ev_is_pci_root_bridge
368  *
369  * PARAMETERS:  Node            - Device node being examined
370  *
371  * RETURN:      TRUE if device is a PCI/PCI-Express Root Bridge
372  *
373  * DESCRIPTION: Determine if the input device represents a PCI Root Bridge by
374  *              examining the _HID and _CID for the device.
375  *
376  ******************************************************************************/
377
378 static u8 acpi_ev_is_pci_root_bridge(struct acpi_namespace_node *node)
379 {
380         acpi_status status;
381         struct acpica_device_id hid;
382         struct acpi_compatible_id_list *cid;
383         acpi_native_uint i;
384
385         /*
386          * Get the _HID and check for a PCI Root Bridge
387          */
388         status = acpi_ut_execute_HID(node, &hid);
389         if (ACPI_FAILURE(status)) {
390                 return (FALSE);
391         }
392
393         if (acpi_ev_match_pci_root_bridge(hid.value)) {
394                 return (TRUE);
395         }
396
397         /*
398          * The _HID did not match.
399          * Get the _CID and check for a PCI Root Bridge
400          */
401         status = acpi_ut_execute_CID(node, &cid);
402         if (ACPI_FAILURE(status)) {
403                 return (FALSE);
404         }
405
406         /* Check all _CIDs in the returned list */
407
408         for (i = 0; i < cid->count; i++) {
409                 if (acpi_ev_match_pci_root_bridge(cid->id[i].value)) {
410                         ACPI_FREE(cid);
411                         return (TRUE);
412                 }
413         }
414
415         ACPI_FREE(cid);
416         return (FALSE);
417 }
418
419 /*******************************************************************************
420  *
421  * FUNCTION:    acpi_ev_pci_bar_region_setup
422  *
423  * PARAMETERS:  Handle              - Region we are interested in
424  *              Function            - Start or stop
425  *              handler_context     - Address space handler context
426  *              region_context      - Region specific context
427  *
428  * RETURN:      Status
429  *
430  * DESCRIPTION: Setup a pci_bAR operation region
431  *
432  * MUTEX:       Assumes namespace is not locked
433  *
434  ******************************************************************************/
435
436 acpi_status
437 acpi_ev_pci_bar_region_setup(acpi_handle handle,
438                              u32 function,
439                              void *handler_context, void **region_context)
440 {
441         ACPI_FUNCTION_TRACE(ev_pci_bar_region_setup);
442
443         return_ACPI_STATUS(AE_OK);
444 }
445
446 /*******************************************************************************
447  *
448  * FUNCTION:    acpi_ev_cmos_region_setup
449  *
450  * PARAMETERS:  Handle              - Region we are interested in
451  *              Function            - Start or stop
452  *              handler_context     - Address space handler context
453  *              region_context      - Region specific context
454  *
455  * RETURN:      Status
456  *
457  * DESCRIPTION: Setup a CMOS operation region
458  *
459  * MUTEX:       Assumes namespace is not locked
460  *
461  ******************************************************************************/
462
463 acpi_status
464 acpi_ev_cmos_region_setup(acpi_handle handle,
465                           u32 function,
466                           void *handler_context, void **region_context)
467 {
468         ACPI_FUNCTION_TRACE(ev_cmos_region_setup);
469
470         return_ACPI_STATUS(AE_OK);
471 }
472
473 /*******************************************************************************
474  *
475  * FUNCTION:    acpi_ev_default_region_setup
476  *
477  * PARAMETERS:  Handle              - Region we are interested in
478  *              Function            - Start or stop
479  *              handler_context     - Address space handler context
480  *              region_context      - Region specific context
481  *
482  * RETURN:      Status
483  *
484  * DESCRIPTION: Default region initialization
485  *
486  ******************************************************************************/
487
488 acpi_status
489 acpi_ev_default_region_setup(acpi_handle handle,
490                              u32 function,
491                              void *handler_context, void **region_context)
492 {
493         ACPI_FUNCTION_TRACE(ev_default_region_setup);
494
495         if (function == ACPI_REGION_DEACTIVATE) {
496                 *region_context = NULL;
497         } else {
498                 *region_context = handler_context;
499         }
500
501         return_ACPI_STATUS(AE_OK);
502 }
503
504 /*******************************************************************************
505  *
506  * FUNCTION:    acpi_ev_initialize_region
507  *
508  * PARAMETERS:  region_obj      - Region we are initializing
509  *              acpi_ns_locked  - Is namespace locked?
510  *
511  * RETURN:      Status
512  *
513  * DESCRIPTION: Initializes the region, finds any _REG methods and saves them
514  *              for execution at a later time
515  *
516  *              Get the appropriate address space handler for a newly
517  *              created region.
518  *
519  *              This also performs address space specific initialization.  For
520  *              example, PCI regions must have an _ADR object that contains
521  *              a PCI address in the scope of the definition.  This address is
522  *              required to perform an access to PCI config space.
523  *
524  * MUTEX:       Interpreter should be unlocked, because we may run the _REG
525  *              method for this region.
526  *
527  ******************************************************************************/
528
529 acpi_status
530 acpi_ev_initialize_region(union acpi_operand_object *region_obj,
531                           u8 acpi_ns_locked)
532 {
533         union acpi_operand_object *handler_obj;
534         union acpi_operand_object *obj_desc;
535         acpi_adr_space_type space_id;
536         struct acpi_namespace_node *node;
537         acpi_status status;
538         struct acpi_namespace_node *method_node;
539         acpi_name *reg_name_ptr = (acpi_name *) METHOD_NAME__REG;
540         union acpi_operand_object *region_obj2;
541
542         ACPI_FUNCTION_TRACE_U32(ev_initialize_region, acpi_ns_locked);
543
544         if (!region_obj) {
545                 return_ACPI_STATUS(AE_BAD_PARAMETER);
546         }
547
548         if (region_obj->common.flags & AOPOBJ_OBJECT_INITIALIZED) {
549                 return_ACPI_STATUS(AE_OK);
550         }
551
552         region_obj2 = acpi_ns_get_secondary_object(region_obj);
553         if (!region_obj2) {
554                 return_ACPI_STATUS(AE_NOT_EXIST);
555         }
556
557         node = acpi_ns_get_parent_node(region_obj->region.node);
558         space_id = region_obj->region.space_id;
559
560         /* Setup defaults */
561
562         region_obj->region.handler = NULL;
563         region_obj2->extra.method_REG = NULL;
564         region_obj->common.flags &= ~(AOPOBJ_SETUP_COMPLETE);
565         region_obj->common.flags |= AOPOBJ_OBJECT_INITIALIZED;
566
567         /* Find any "_REG" method associated with this region definition */
568
569         status =
570             acpi_ns_search_one_scope(*reg_name_ptr, node, ACPI_TYPE_METHOD,
571                                      &method_node);
572         if (ACPI_SUCCESS(status)) {
573                 /*
574                  * The _REG method is optional and there can be only one per region
575                  * definition.  This will be executed when the handler is attached
576                  * or removed
577                  */
578                 region_obj2->extra.method_REG = method_node;
579         }
580
581         /*
582          * The following loop depends upon the root Node having no parent
583          * ie: acpi_gbl_root_node->parent_entry being set to NULL
584          */
585         while (node) {
586
587                 /* Check to see if a handler exists */
588
589                 handler_obj = NULL;
590                 obj_desc = acpi_ns_get_attached_object(node);
591                 if (obj_desc) {
592
593                         /* Can only be a handler if the object exists */
594
595                         switch (node->type) {
596                         case ACPI_TYPE_DEVICE:
597
598                                 handler_obj = obj_desc->device.handler;
599                                 break;
600
601                         case ACPI_TYPE_PROCESSOR:
602
603                                 handler_obj = obj_desc->processor.handler;
604                                 break;
605
606                         case ACPI_TYPE_THERMAL:
607
608                                 handler_obj = obj_desc->thermal_zone.handler;
609                                 break;
610
611                         default:
612                                 /* Ignore other objects */
613                                 break;
614                         }
615
616                         while (handler_obj) {
617
618                                 /* Is this handler of the correct type? */
619
620                                 if (handler_obj->address_space.space_id ==
621                                     space_id) {
622
623                                         /* Found correct handler */
624
625                                         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
626                                                           "Found handler %p for region %p in obj %p\n",
627                                                           handler_obj,
628                                                           region_obj,
629                                                           obj_desc));
630
631                                         status =
632                                             acpi_ev_attach_region(handler_obj,
633                                                                   region_obj,
634                                                                   acpi_ns_locked);
635
636                                         /*
637                                          * Tell all users that this region is usable by running the _REG
638                                          * method
639                                          */
640                                         if (acpi_ns_locked) {
641                                                 status =
642                                                     acpi_ut_release_mutex
643                                                     (ACPI_MTX_NAMESPACE);
644                                                 if (ACPI_FAILURE(status)) {
645                                                         return_ACPI_STATUS
646                                                             (status);
647                                                 }
648                                         }
649
650                                         status =
651                                             acpi_ev_execute_reg_method
652                                             (region_obj, 1);
653
654                                         if (acpi_ns_locked) {
655                                                 status =
656                                                     acpi_ut_acquire_mutex
657                                                     (ACPI_MTX_NAMESPACE);
658                                                 if (ACPI_FAILURE(status)) {
659                                                         return_ACPI_STATUS
660                                                             (status);
661                                                 }
662                                         }
663
664                                         return_ACPI_STATUS(AE_OK);
665                                 }
666
667                                 /* Try next handler in the list */
668
669                                 handler_obj = handler_obj->address_space.next;
670                         }
671                 }
672
673                 /*
674                  * This node does not have the handler we need;
675                  * Pop up one level
676                  */
677                 node = acpi_ns_get_parent_node(node);
678         }
679
680         /* If we get here, there is no handler for this region */
681
682         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
683                           "No handler for RegionType %s(%X) (RegionObj %p)\n",
684                           acpi_ut_get_region_name(space_id), space_id,
685                           region_obj));
686
687         return_ACPI_STATUS(AE_NOT_EXIST);
688 }