Pull acpica into release branch
[linux-2.6.git] / drivers / acpi / events / evregion.c
1 /******************************************************************************
2  *
3  * Module Name: evregion - ACPI address_space (op_region) handler dispatch
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, 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 #include <acpi/acinterp.h>
48
49 #define _COMPONENT          ACPI_EVENTS
50 ACPI_MODULE_NAME("evregion")
51 #define ACPI_NUM_DEFAULT_SPACES     4
52 static u8 acpi_gbl_default_address_spaces[ACPI_NUM_DEFAULT_SPACES] = {
53         ACPI_ADR_SPACE_SYSTEM_MEMORY,
54         ACPI_ADR_SPACE_SYSTEM_IO,
55         ACPI_ADR_SPACE_PCI_CONFIG,
56         ACPI_ADR_SPACE_DATA_TABLE
57 };
58
59 /* Local prototypes */
60
61 static acpi_status
62 acpi_ev_reg_run(acpi_handle obj_handle,
63                 u32 level, void *context, void **return_value);
64
65 static acpi_status
66 acpi_ev_install_handler(acpi_handle obj_handle,
67                         u32 level, void *context, void **return_value);
68
69 /*******************************************************************************
70  *
71  * FUNCTION:    acpi_ev_install_region_handlers
72  *
73  * PARAMETERS:  None
74  *
75  * RETURN:      Status
76  *
77  * DESCRIPTION: Installs the core subsystem default address space handlers.
78  *
79  ******************************************************************************/
80
81 acpi_status acpi_ev_install_region_handlers(void)
82 {
83         acpi_status status;
84         acpi_native_uint i;
85
86         ACPI_FUNCTION_TRACE(ev_install_region_handlers);
87
88         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
89         if (ACPI_FAILURE(status)) {
90                 return_ACPI_STATUS(status);
91         }
92
93         /*
94          * All address spaces (PCI Config, EC, SMBus) are scope dependent
95          * and registration must occur for a specific device.
96          *
97          * In the case of the system memory and IO address spaces there is currently
98          * no device associated with the address space.  For these we use the root.
99          *
100          * We install the default PCI config space handler at the root so
101          * that this space is immediately available even though the we have
102          * not enumerated all the PCI Root Buses yet.  This is to conform
103          * to the ACPI specification which states that the PCI config
104          * space must be always available -- even though we are nowhere
105          * near ready to find the PCI root buses at this point.
106          *
107          * NOTE: We ignore AE_ALREADY_EXISTS because this means that a handler
108          * has already been installed (via acpi_install_address_space_handler).
109          * Similar for AE_SAME_HANDLER.
110          */
111         for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
112                 status = acpi_ev_install_space_handler(acpi_gbl_root_node,
113                                                        acpi_gbl_default_address_spaces
114                                                        [i],
115                                                        ACPI_DEFAULT_HANDLER,
116                                                        NULL, NULL);
117                 switch (status) {
118                 case AE_OK:
119                 case AE_SAME_HANDLER:
120                 case AE_ALREADY_EXISTS:
121
122                         /* These exceptions are all OK */
123
124                         status = AE_OK;
125                         break;
126
127                 default:
128
129                         goto unlock_and_exit;
130                 }
131         }
132
133       unlock_and_exit:
134         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
135         return_ACPI_STATUS(status);
136 }
137
138 /*******************************************************************************
139  *
140  * FUNCTION:    acpi_ev_initialize_op_regions
141  *
142  * PARAMETERS:  None
143  *
144  * RETURN:      Status
145  *
146  * DESCRIPTION: Execute _REG methods for all Operation Regions that have
147  *              an installed default region handler.
148  *
149  ******************************************************************************/
150
151 acpi_status acpi_ev_initialize_op_regions(void)
152 {
153         acpi_status status;
154         acpi_native_uint i;
155
156         ACPI_FUNCTION_TRACE(ev_initialize_op_regions);
157
158         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
159         if (ACPI_FAILURE(status)) {
160                 return_ACPI_STATUS(status);
161         }
162
163         /*
164          * Run the _REG methods for op_regions in each default address space
165          */
166         for (i = 0; i < ACPI_NUM_DEFAULT_SPACES; i++) {
167
168                 /* TBD: Make sure handler is the DEFAULT handler, otherwise
169                  * _REG will have already been run.
170                  */
171                 status = acpi_ev_execute_reg_methods(acpi_gbl_root_node,
172                                                      acpi_gbl_default_address_spaces
173                                                      [i]);
174         }
175
176         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
177         return_ACPI_STATUS(status);
178 }
179
180 /*******************************************************************************
181  *
182  * FUNCTION:    acpi_ev_execute_reg_method
183  *
184  * PARAMETERS:  region_obj          - Region object
185  *              Function            - Passed to _REG: On (1) or Off (0)
186  *
187  * RETURN:      Status
188  *
189  * DESCRIPTION: Execute _REG method for a region
190  *
191  ******************************************************************************/
192
193 acpi_status
194 acpi_ev_execute_reg_method(union acpi_operand_object *region_obj, u32 function)
195 {
196         struct acpi_evaluate_info *info;
197         union acpi_operand_object *args[3];
198         union acpi_operand_object *region_obj2;
199         acpi_status status;
200
201         ACPI_FUNCTION_TRACE(ev_execute_reg_method);
202
203         region_obj2 = acpi_ns_get_secondary_object(region_obj);
204         if (!region_obj2) {
205                 return_ACPI_STATUS(AE_NOT_EXIST);
206         }
207
208         if (region_obj2->extra.method_REG == NULL) {
209                 return_ACPI_STATUS(AE_OK);
210         }
211
212         /* Allocate and initialize the evaluation information block */
213
214         info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
215         if (!info) {
216                 return_ACPI_STATUS(AE_NO_MEMORY);
217         }
218
219         info->prefix_node = region_obj2->extra.method_REG;
220         info->pathname = NULL;
221         info->parameters = args;
222         info->parameter_type = ACPI_PARAM_ARGS;
223         info->flags = ACPI_IGNORE_RETURN_VALUE;
224
225         /*
226          * The _REG method has two arguments:
227          *
228          * Arg0 - Integer:
229          *  Operation region space ID Same value as region_obj->Region.space_id
230          *
231          * Arg1 - Integer:
232          *  connection status 1 for connecting the handler, 0 for disconnecting
233          *  the handler (Passed as a parameter)
234          */
235         args[0] = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
236         if (!args[0]) {
237                 status = AE_NO_MEMORY;
238                 goto cleanup1;
239         }
240
241         args[1] = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
242         if (!args[1]) {
243                 status = AE_NO_MEMORY;
244                 goto cleanup2;
245         }
246
247         /* Setup the parameter objects */
248
249         args[0]->integer.value = region_obj->region.space_id;
250         args[1]->integer.value = function;
251         args[2] = NULL;
252
253         /* Execute the method, no return value */
254
255         ACPI_DEBUG_EXEC(acpi_ut_display_init_pathname
256                         (ACPI_TYPE_METHOD, info->prefix_node, NULL));
257
258         status = acpi_ns_evaluate(info);
259         acpi_ut_remove_reference(args[1]);
260
261       cleanup2:
262         acpi_ut_remove_reference(args[0]);
263
264       cleanup1:
265         ACPI_FREE(info);
266         return_ACPI_STATUS(status);
267 }
268
269 /*******************************************************************************
270  *
271  * FUNCTION:    acpi_ev_address_space_dispatch
272  *
273  * PARAMETERS:  region_obj          - Internal region object
274  *              Function            - Read or Write operation
275  *              Address             - Where in the space to read or write
276  *              bit_width           - Field width in bits (8, 16, 32, or 64)
277  *              Value               - Pointer to in or out value, must be
278  *                                    full 64-bit acpi_integer
279  *
280  * RETURN:      Status
281  *
282  * DESCRIPTION: Dispatch an address space or operation region access to
283  *              a previously installed handler.
284  *
285  ******************************************************************************/
286
287 acpi_status
288 acpi_ev_address_space_dispatch(union acpi_operand_object *region_obj,
289                                u32 function,
290                                acpi_physical_address address,
291                                u32 bit_width, acpi_integer * value)
292 {
293         acpi_status status;
294         acpi_status status2;
295         acpi_adr_space_handler handler;
296         acpi_adr_space_setup region_setup;
297         union acpi_operand_object *handler_desc;
298         union acpi_operand_object *region_obj2;
299         void *region_context = NULL;
300
301         ACPI_FUNCTION_TRACE(ev_address_space_dispatch);
302
303         region_obj2 = acpi_ns_get_secondary_object(region_obj);
304         if (!region_obj2) {
305                 return_ACPI_STATUS(AE_NOT_EXIST);
306         }
307
308         /* Ensure that there is a handler associated with this region */
309
310         handler_desc = region_obj->region.handler;
311         if (!handler_desc) {
312                 ACPI_ERROR((AE_INFO,
313                             "No handler for Region [%4.4s] (%p) [%s]",
314                             acpi_ut_get_node_name(region_obj->region.node),
315                             region_obj,
316                             acpi_ut_get_region_name(region_obj->region.
317                                                     space_id)));
318
319                 return_ACPI_STATUS(AE_NOT_EXIST);
320         }
321
322         /*
323          * It may be the case that the region has never been initialized
324          * Some types of regions require special init code
325          */
326         if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
327                 /*
328                  * This region has not been initialized yet, do it
329                  */
330                 region_setup = handler_desc->address_space.setup;
331                 if (!region_setup) {
332
333                         /* No initialization routine, exit with error */
334
335                         ACPI_ERROR((AE_INFO,
336                                     "No init routine for region(%p) [%s]",
337                                     region_obj,
338                                     acpi_ut_get_region_name(region_obj->region.
339                                                             space_id)));
340                         return_ACPI_STATUS(AE_NOT_EXIST);
341                 }
342
343                 /*
344                  * We must exit the interpreter because the region
345                  * setup will potentially execute control methods
346                  * (e.g., _REG method for this region)
347                  */
348                 acpi_ex_exit_interpreter();
349
350                 status = region_setup(region_obj, ACPI_REGION_ACTIVATE,
351                                       handler_desc->address_space.context,
352                                       &region_context);
353
354                 /* Re-enter the interpreter */
355
356                 status2 = acpi_ex_enter_interpreter();
357                 if (ACPI_FAILURE(status2)) {
358                         return_ACPI_STATUS(status2);
359                 }
360
361                 /* Check for failure of the Region Setup */
362
363                 if (ACPI_FAILURE(status)) {
364                         ACPI_EXCEPTION((AE_INFO, status,
365                                         "During region initialization: [%s]",
366                                         acpi_ut_get_region_name(region_obj->
367                                                                 region.
368                                                                 space_id)));
369                         return_ACPI_STATUS(status);
370                 }
371
372                 /*
373                  * Region initialization may have been completed by region_setup
374                  */
375                 if (!(region_obj->region.flags & AOPOBJ_SETUP_COMPLETE)) {
376                         region_obj->region.flags |= AOPOBJ_SETUP_COMPLETE;
377
378                         if (region_obj2->extra.region_context) {
379
380                                 /* The handler for this region was already installed */
381
382                                 ACPI_FREE(region_context);
383                         } else {
384                                 /*
385                                  * Save the returned context for use in all accesses to
386                                  * this particular region
387                                  */
388                                 region_obj2->extra.region_context =
389                                     region_context;
390                         }
391                 }
392         }
393
394         /* We have everything we need, we can invoke the address space handler */
395
396         handler = handler_desc->address_space.handler;
397
398         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
399                           "Handler %p (@%p) Address %8.8X%8.8X [%s]\n",
400                           &region_obj->region.handler->address_space, handler,
401                           ACPI_FORMAT_UINT64(address),
402                           acpi_ut_get_region_name(region_obj->region.
403                                                   space_id)));
404
405         if (!(handler_desc->address_space.handler_flags &
406               ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
407                 /*
408                  * For handlers other than the default (supplied) handlers, we must
409                  * exit the interpreter because the handler *might* block -- we don't
410                  * know what it will do, so we can't hold the lock on the intepreter.
411                  */
412                 acpi_ex_exit_interpreter();
413         }
414
415         /* Call the handler */
416
417         status = handler(function, address, bit_width, value,
418                          handler_desc->address_space.context,
419                          region_obj2->extra.region_context);
420
421         if (ACPI_FAILURE(status)) {
422                 ACPI_EXCEPTION((AE_INFO, status, "Returned by Handler for [%s]",
423                                 acpi_ut_get_region_name(region_obj->region.
424                                                         space_id)));
425         }
426
427         if (!(handler_desc->address_space.handler_flags &
428               ACPI_ADDR_HANDLER_DEFAULT_INSTALLED)) {
429                 /*
430                  * We just returned from a non-default handler, we must re-enter the
431                  * interpreter
432                  */
433                 status2 = acpi_ex_enter_interpreter();
434                 if (ACPI_FAILURE(status2)) {
435                         return_ACPI_STATUS(status2);
436                 }
437         }
438
439         return_ACPI_STATUS(status);
440 }
441
442 /*******************************************************************************
443  *
444  * FUNCTION:    acpi_ev_detach_region
445  *
446  * PARAMETERS:  region_obj          - Region Object
447  *              acpi_ns_is_locked   - Namespace Region Already Locked?
448  *
449  * RETURN:      None
450  *
451  * DESCRIPTION: Break the association between the handler and the region
452  *              this is a two way association.
453  *
454  ******************************************************************************/
455
456 void
457 acpi_ev_detach_region(union acpi_operand_object *region_obj,
458                       u8 acpi_ns_is_locked)
459 {
460         union acpi_operand_object *handler_obj;
461         union acpi_operand_object *obj_desc;
462         union acpi_operand_object **last_obj_ptr;
463         acpi_adr_space_setup region_setup;
464         void **region_context;
465         union acpi_operand_object *region_obj2;
466         acpi_status status;
467
468         ACPI_FUNCTION_TRACE(ev_detach_region);
469
470         region_obj2 = acpi_ns_get_secondary_object(region_obj);
471         if (!region_obj2) {
472                 return_VOID;
473         }
474         region_context = &region_obj2->extra.region_context;
475
476         /* Get the address handler from the region object */
477
478         handler_obj = region_obj->region.handler;
479         if (!handler_obj) {
480
481                 /* This region has no handler, all done */
482
483                 return_VOID;
484         }
485
486         /* Find this region in the handler's list */
487
488         obj_desc = handler_obj->address_space.region_list;
489         last_obj_ptr = &handler_obj->address_space.region_list;
490
491         while (obj_desc) {
492
493                 /* Is this the correct Region? */
494
495                 if (obj_desc == region_obj) {
496                         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
497                                           "Removing Region %p from address handler %p\n",
498                                           region_obj, handler_obj));
499
500                         /* This is it, remove it from the handler's list */
501
502                         *last_obj_ptr = obj_desc->region.next;
503                         obj_desc->region.next = NULL;   /* Must clear field */
504
505                         if (acpi_ns_is_locked) {
506                                 status =
507                                     acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
508                                 if (ACPI_FAILURE(status)) {
509                                         return_VOID;
510                                 }
511                         }
512
513                         /* Now stop region accesses by executing the _REG method */
514
515                         status = acpi_ev_execute_reg_method(region_obj, 0);
516                         if (ACPI_FAILURE(status)) {
517                                 ACPI_EXCEPTION((AE_INFO, status,
518                                                 "from region _REG, [%s]",
519                                                 acpi_ut_get_region_name
520                                                 (region_obj->region.space_id)));
521                         }
522
523                         if (acpi_ns_is_locked) {
524                                 status =
525                                     acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
526                                 if (ACPI_FAILURE(status)) {
527                                         return_VOID;
528                                 }
529                         }
530
531                         /* Call the setup handler with the deactivate notification */
532
533                         region_setup = handler_obj->address_space.setup;
534                         status =
535                             region_setup(region_obj, ACPI_REGION_DEACTIVATE,
536                                          handler_obj->address_space.context,
537                                          region_context);
538
539                         /* Init routine may fail, Just ignore errors */
540
541                         if (ACPI_FAILURE(status)) {
542                                 ACPI_EXCEPTION((AE_INFO, status,
543                                                 "from region init, [%s]",
544                                                 acpi_ut_get_region_name
545                                                 (region_obj->region.space_id)));
546                         }
547
548                         region_obj->region.flags &= ~(AOPOBJ_SETUP_COMPLETE);
549
550                         /*
551                          * Remove handler reference in the region
552                          *
553                          * NOTE: this doesn't mean that the region goes away
554                          * The region is just inaccessible as indicated to
555                          * the _REG method
556                          *
557                          * If the region is on the handler's list
558                          * this better be the region's handler
559                          */
560                         region_obj->region.handler = NULL;
561                         acpi_ut_remove_reference(handler_obj);
562
563                         return_VOID;
564                 }
565
566                 /* Walk the linked list of handlers */
567
568                 last_obj_ptr = &obj_desc->region.next;
569                 obj_desc = obj_desc->region.next;
570         }
571
572         /* If we get here, the region was not in the handler's region list */
573
574         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
575                           "Cannot remove region %p from address handler %p\n",
576                           region_obj, handler_obj));
577
578         return_VOID;
579 }
580
581 /*******************************************************************************
582  *
583  * FUNCTION:    acpi_ev_attach_region
584  *
585  * PARAMETERS:  handler_obj         - Handler Object
586  *              region_obj          - Region Object
587  *              acpi_ns_is_locked   - Namespace Region Already Locked?
588  *
589  * RETURN:      None
590  *
591  * DESCRIPTION: Create the association between the handler and the region
592  *              this is a two way association.
593  *
594  ******************************************************************************/
595
596 acpi_status
597 acpi_ev_attach_region(union acpi_operand_object *handler_obj,
598                       union acpi_operand_object *region_obj,
599                       u8 acpi_ns_is_locked)
600 {
601
602         ACPI_FUNCTION_TRACE(ev_attach_region);
603
604         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
605                           "Adding Region [%4.4s] %p to address handler %p [%s]\n",
606                           acpi_ut_get_node_name(region_obj->region.node),
607                           region_obj, handler_obj,
608                           acpi_ut_get_region_name(region_obj->region.
609                                                   space_id)));
610
611         /* Link this region to the front of the handler's list */
612
613         region_obj->region.next = handler_obj->address_space.region_list;
614         handler_obj->address_space.region_list = region_obj;
615
616         /* Install the region's handler */
617
618         if (region_obj->region.handler) {
619                 return_ACPI_STATUS(AE_ALREADY_EXISTS);
620         }
621
622         region_obj->region.handler = handler_obj;
623         acpi_ut_add_reference(handler_obj);
624
625         return_ACPI_STATUS(AE_OK);
626 }
627
628 /*******************************************************************************
629  *
630  * FUNCTION:    acpi_ev_install_handler
631  *
632  * PARAMETERS:  walk_namespace callback
633  *
634  * DESCRIPTION: This routine installs an address handler into objects that are
635  *              of type Region or Device.
636  *
637  *              If the Object is a Device, and the device has a handler of
638  *              the same type then the search is terminated in that branch.
639  *
640  *              This is because the existing handler is closer in proximity
641  *              to any more regions than the one we are trying to install.
642  *
643  ******************************************************************************/
644
645 static acpi_status
646 acpi_ev_install_handler(acpi_handle obj_handle,
647                         u32 level, void *context, void **return_value)
648 {
649         union acpi_operand_object *handler_obj;
650         union acpi_operand_object *next_handler_obj;
651         union acpi_operand_object *obj_desc;
652         struct acpi_namespace_node *node;
653         acpi_status status;
654
655         ACPI_FUNCTION_NAME(ev_install_handler);
656
657         handler_obj = (union acpi_operand_object *)context;
658
659         /* Parameter validation */
660
661         if (!handler_obj) {
662                 return (AE_OK);
663         }
664
665         /* Convert and validate the device handle */
666
667         node = acpi_ns_map_handle_to_node(obj_handle);
668         if (!node) {
669                 return (AE_BAD_PARAMETER);
670         }
671
672         /*
673          * We only care about regions.and objects
674          * that are allowed to have address space handlers
675          */
676         if ((node->type != ACPI_TYPE_DEVICE) &&
677             (node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
678                 return (AE_OK);
679         }
680
681         /* Check for an existing internal object */
682
683         obj_desc = acpi_ns_get_attached_object(node);
684         if (!obj_desc) {
685
686                 /* No object, just exit */
687
688                 return (AE_OK);
689         }
690
691         /* Devices are handled different than regions */
692
693         if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_DEVICE) {
694
695                 /* Check if this Device already has a handler for this address space */
696
697                 next_handler_obj = obj_desc->device.handler;
698                 while (next_handler_obj) {
699
700                         /* Found a handler, is it for the same address space? */
701
702                         if (next_handler_obj->address_space.space_id ==
703                             handler_obj->address_space.space_id) {
704                                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
705                                                   "Found handler for region [%s] in device %p(%p) handler %p\n",
706                                                   acpi_ut_get_region_name
707                                                   (handler_obj->address_space.
708                                                    space_id), obj_desc,
709                                                   next_handler_obj,
710                                                   handler_obj));
711
712                                 /*
713                                  * Since the object we found it on was a device, then it
714                                  * means that someone has already installed a handler for
715                                  * the branch of the namespace from this device on.  Just
716                                  * bail out telling the walk routine to not traverse this
717                                  * branch.  This preserves the scoping rule for handlers.
718                                  */
719                                 return (AE_CTRL_DEPTH);
720                         }
721
722                         /* Walk the linked list of handlers attached to this device */
723
724                         next_handler_obj = next_handler_obj->address_space.next;
725                 }
726
727                 /*
728                  * As long as the device didn't have a handler for this
729                  * space we don't care about it.  We just ignore it and
730                  * proceed.
731                  */
732                 return (AE_OK);
733         }
734
735         /* Object is a Region */
736
737         if (obj_desc->region.space_id != handler_obj->address_space.space_id) {
738                 /*
739                  * This region is for a different address space
740                  * -- just ignore it
741                  */
742                 return (AE_OK);
743         }
744
745         /*
746          * Now we have a region and it is for the handler's address
747          * space type.
748          *
749          * First disconnect region for any previous handler (if any)
750          */
751         acpi_ev_detach_region(obj_desc, FALSE);
752
753         /* Connect the region to the new handler */
754
755         status = acpi_ev_attach_region(handler_obj, obj_desc, FALSE);
756         return (status);
757 }
758
759 /*******************************************************************************
760  *
761  * FUNCTION:    acpi_ev_install_space_handler
762  *
763  * PARAMETERS:  Node            - Namespace node for the device
764  *              space_id        - The address space ID
765  *              Handler         - Address of the handler
766  *              Setup           - Address of the setup function
767  *              Context         - Value passed to the handler on each access
768  *
769  * RETURN:      Status
770  *
771  * DESCRIPTION: Install a handler for all op_regions of a given space_id.
772  *              Assumes namespace is locked
773  *
774  ******************************************************************************/
775
776 acpi_status
777 acpi_ev_install_space_handler(struct acpi_namespace_node * node,
778                               acpi_adr_space_type space_id,
779                               acpi_adr_space_handler handler,
780                               acpi_adr_space_setup setup, void *context)
781 {
782         union acpi_operand_object *obj_desc;
783         union acpi_operand_object *handler_obj;
784         acpi_status status;
785         acpi_object_type type;
786         u8 flags = 0;
787
788         ACPI_FUNCTION_TRACE(ev_install_space_handler);
789
790         /*
791          * This registration is valid for only the types below
792          * and the root.  This is where the default handlers
793          * get placed.
794          */
795         if ((node->type != ACPI_TYPE_DEVICE) &&
796             (node->type != ACPI_TYPE_PROCESSOR) &&
797             (node->type != ACPI_TYPE_THERMAL) && (node != acpi_gbl_root_node)) {
798                 status = AE_BAD_PARAMETER;
799                 goto unlock_and_exit;
800         }
801
802         if (handler == ACPI_DEFAULT_HANDLER) {
803                 flags = ACPI_ADDR_HANDLER_DEFAULT_INSTALLED;
804
805                 switch (space_id) {
806                 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
807                         handler = acpi_ex_system_memory_space_handler;
808                         setup = acpi_ev_system_memory_region_setup;
809                         break;
810
811                 case ACPI_ADR_SPACE_SYSTEM_IO:
812                         handler = acpi_ex_system_io_space_handler;
813                         setup = acpi_ev_io_space_region_setup;
814                         break;
815
816                 case ACPI_ADR_SPACE_PCI_CONFIG:
817                         handler = acpi_ex_pci_config_space_handler;
818                         setup = acpi_ev_pci_config_region_setup;
819                         break;
820
821                 case ACPI_ADR_SPACE_CMOS:
822                         handler = acpi_ex_cmos_space_handler;
823                         setup = acpi_ev_cmos_region_setup;
824                         break;
825
826                 case ACPI_ADR_SPACE_PCI_BAR_TARGET:
827                         handler = acpi_ex_pci_bar_space_handler;
828                         setup = acpi_ev_pci_bar_region_setup;
829                         break;
830
831                 case ACPI_ADR_SPACE_DATA_TABLE:
832                         handler = acpi_ex_data_table_space_handler;
833                         setup = NULL;
834                         break;
835
836                 default:
837                         status = AE_BAD_PARAMETER;
838                         goto unlock_and_exit;
839                 }
840         }
841
842         /* If the caller hasn't specified a setup routine, use the default */
843
844         if (!setup) {
845                 setup = acpi_ev_default_region_setup;
846         }
847
848         /* Check for an existing internal object */
849
850         obj_desc = acpi_ns_get_attached_object(node);
851         if (obj_desc) {
852                 /*
853                  * The attached device object already exists.
854                  * Make sure the handler is not already installed.
855                  */
856                 handler_obj = obj_desc->device.handler;
857
858                 /* Walk the handler list for this device */
859
860                 while (handler_obj) {
861
862                         /* Same space_id indicates a handler already installed */
863
864                         if (handler_obj->address_space.space_id == space_id) {
865                                 if (handler_obj->address_space.handler ==
866                                     handler) {
867                                         /*
868                                          * It is (relatively) OK to attempt to install the SAME
869                                          * handler twice. This can easily happen
870                                          * with PCI_Config space.
871                                          */
872                                         status = AE_SAME_HANDLER;
873                                         goto unlock_and_exit;
874                                 } else {
875                                         /* A handler is already installed */
876
877                                         status = AE_ALREADY_EXISTS;
878                                 }
879                                 goto unlock_and_exit;
880                         }
881
882                         /* Walk the linked list of handlers */
883
884                         handler_obj = handler_obj->address_space.next;
885                 }
886         } else {
887                 ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
888                                   "Creating object on Device %p while installing handler\n",
889                                   node));
890
891                 /* obj_desc does not exist, create one */
892
893                 if (node->type == ACPI_TYPE_ANY) {
894                         type = ACPI_TYPE_DEVICE;
895                 } else {
896                         type = node->type;
897                 }
898
899                 obj_desc = acpi_ut_create_internal_object(type);
900                 if (!obj_desc) {
901                         status = AE_NO_MEMORY;
902                         goto unlock_and_exit;
903                 }
904
905                 /* Init new descriptor */
906
907                 obj_desc->common.type = (u8) type;
908
909                 /* Attach the new object to the Node */
910
911                 status = acpi_ns_attach_object(node, obj_desc, type);
912
913                 /* Remove local reference to the object */
914
915                 acpi_ut_remove_reference(obj_desc);
916
917                 if (ACPI_FAILURE(status)) {
918                         goto unlock_and_exit;
919                 }
920         }
921
922         ACPI_DEBUG_PRINT((ACPI_DB_OPREGION,
923                           "Installing address handler for region %s(%X) on Device %4.4s %p(%p)\n",
924                           acpi_ut_get_region_name(space_id), space_id,
925                           acpi_ut_get_node_name(node), node, obj_desc));
926
927         /*
928          * Install the handler
929          *
930          * At this point there is no existing handler.
931          * Just allocate the object for the handler and link it
932          * into the list.
933          */
934         handler_obj =
935             acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_ADDRESS_HANDLER);
936         if (!handler_obj) {
937                 status = AE_NO_MEMORY;
938                 goto unlock_and_exit;
939         }
940
941         /* Init handler obj */
942
943         handler_obj->address_space.space_id = (u8) space_id;
944         handler_obj->address_space.handler_flags = flags;
945         handler_obj->address_space.region_list = NULL;
946         handler_obj->address_space.node = node;
947         handler_obj->address_space.handler = handler;
948         handler_obj->address_space.context = context;
949         handler_obj->address_space.setup = setup;
950
951         /* Install at head of Device.address_space list */
952
953         handler_obj->address_space.next = obj_desc->device.handler;
954
955         /*
956          * The Device object is the first reference on the handler_obj.
957          * Each region that uses the handler adds a reference.
958          */
959         obj_desc->device.handler = handler_obj;
960
961         /*
962          * Walk the namespace finding all of the regions this
963          * handler will manage.
964          *
965          * Start at the device and search the branch toward
966          * the leaf nodes until either the leaf is encountered or
967          * a device is detected that has an address handler of the
968          * same type.
969          *
970          * In either case, back up and search down the remainder
971          * of the branch
972          */
973         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
974                                         ACPI_NS_WALK_UNLOCK,
975                                         acpi_ev_install_handler, handler_obj,
976                                         NULL);
977
978       unlock_and_exit:
979         return_ACPI_STATUS(status);
980 }
981
982 /*******************************************************************************
983  *
984  * FUNCTION:    acpi_ev_execute_reg_methods
985  *
986  * PARAMETERS:  Node            - Namespace node for the device
987  *              space_id        - The address space ID
988  *
989  * RETURN:      Status
990  *
991  * DESCRIPTION: Run all _REG methods for the input Space ID;
992  *              Note: assumes namespace is locked, or system init time.
993  *
994  ******************************************************************************/
995
996 acpi_status
997 acpi_ev_execute_reg_methods(struct acpi_namespace_node *node,
998                             acpi_adr_space_type space_id)
999 {
1000         acpi_status status;
1001
1002         ACPI_FUNCTION_TRACE(ev_execute_reg_methods);
1003
1004         /*
1005          * Run all _REG methods for all Operation Regions for this
1006          * space ID.  This is a separate walk in order to handle any
1007          * interdependencies between regions and _REG methods.  (i.e. handlers
1008          * must be installed for all regions of this Space ID before we
1009          * can run any _REG methods)
1010          */
1011         status = acpi_ns_walk_namespace(ACPI_TYPE_ANY, node, ACPI_UINT32_MAX,
1012                                         ACPI_NS_WALK_UNLOCK, acpi_ev_reg_run,
1013                                         &space_id, NULL);
1014
1015         return_ACPI_STATUS(status);
1016 }
1017
1018 /*******************************************************************************
1019  *
1020  * FUNCTION:    acpi_ev_reg_run
1021  *
1022  * PARAMETERS:  walk_namespace callback
1023  *
1024  * DESCRIPTION: Run _REG method for region objects of the requested space_iD
1025  *
1026  ******************************************************************************/
1027
1028 static acpi_status
1029 acpi_ev_reg_run(acpi_handle obj_handle,
1030                 u32 level, void *context, void **return_value)
1031 {
1032         union acpi_operand_object *obj_desc;
1033         struct acpi_namespace_node *node;
1034         acpi_adr_space_type space_id;
1035         acpi_status status;
1036
1037         space_id = *ACPI_CAST_PTR(acpi_adr_space_type, context);
1038
1039         /* Convert and validate the device handle */
1040
1041         node = acpi_ns_map_handle_to_node(obj_handle);
1042         if (!node) {
1043                 return (AE_BAD_PARAMETER);
1044         }
1045
1046         /*
1047          * We only care about regions.and objects
1048          * that are allowed to have address space handlers
1049          */
1050         if ((node->type != ACPI_TYPE_REGION) && (node != acpi_gbl_root_node)) {
1051                 return (AE_OK);
1052         }
1053
1054         /* Check for an existing internal object */
1055
1056         obj_desc = acpi_ns_get_attached_object(node);
1057         if (!obj_desc) {
1058
1059                 /* No object, just exit */
1060
1061                 return (AE_OK);
1062         }
1063
1064         /* Object is a Region */
1065
1066         if (obj_desc->region.space_id != space_id) {
1067                 /*
1068                  * This region is for a different address space
1069                  * -- just ignore it
1070                  */
1071                 return (AE_OK);
1072         }
1073
1074         status = acpi_ev_execute_reg_method(obj_desc, 1);
1075         return (status);
1076 }