Home | History | Annotate | Line # | Download | only in events
evxfregn.c revision 1.1.1.15
      1       1.1    jruoho /******************************************************************************
      2       1.1    jruoho  *
      3       1.1    jruoho  * Module Name: evxfregn - External Interfaces, ACPI Operation Regions and
      4       1.1    jruoho  *                         Address Spaces.
      5       1.1    jruoho  *
      6       1.1    jruoho  *****************************************************************************/
      7       1.1    jruoho 
      8   1.1.1.2    jruoho /*
      9  1.1.1.15  christos  * Copyright (C) 2000 - 2023, Intel Corp.
     10       1.1    jruoho  * All rights reserved.
     11       1.1    jruoho  *
     12   1.1.1.2    jruoho  * Redistribution and use in source and binary forms, with or without
     13   1.1.1.2    jruoho  * modification, are permitted provided that the following conditions
     14   1.1.1.2    jruoho  * are met:
     15   1.1.1.2    jruoho  * 1. Redistributions of source code must retain the above copyright
     16   1.1.1.2    jruoho  *    notice, this list of conditions, and the following disclaimer,
     17   1.1.1.2    jruoho  *    without modification.
     18   1.1.1.2    jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     19   1.1.1.2    jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     20   1.1.1.2    jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     21   1.1.1.2    jruoho  *    including a substantially similar Disclaimer requirement for further
     22   1.1.1.2    jruoho  *    binary redistribution.
     23   1.1.1.2    jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     24   1.1.1.2    jruoho  *    of any contributors may be used to endorse or promote products derived
     25   1.1.1.2    jruoho  *    from this software without specific prior written permission.
     26   1.1.1.2    jruoho  *
     27   1.1.1.2    jruoho  * Alternatively, this software may be distributed under the terms of the
     28   1.1.1.2    jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     29   1.1.1.2    jruoho  * Software Foundation.
     30   1.1.1.2    jruoho  *
     31   1.1.1.2    jruoho  * NO WARRANTY
     32   1.1.1.2    jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     33   1.1.1.2    jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     34  1.1.1.13  christos  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     35   1.1.1.2    jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     36   1.1.1.2    jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     37   1.1.1.2    jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     38   1.1.1.2    jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     39   1.1.1.2    jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     40   1.1.1.2    jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     41   1.1.1.2    jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     42   1.1.1.2    jruoho  * POSSIBILITY OF SUCH DAMAGES.
     43   1.1.1.2    jruoho  */
     44       1.1    jruoho 
     45   1.1.1.4  christos #define EXPORT_ACPI_INTERFACES
     46       1.1    jruoho 
     47       1.1    jruoho #include "acpi.h"
     48       1.1    jruoho #include "accommon.h"
     49       1.1    jruoho #include "acnamesp.h"
     50       1.1    jruoho #include "acevents.h"
     51       1.1    jruoho 
     52       1.1    jruoho #define _COMPONENT          ACPI_EVENTS
     53       1.1    jruoho         ACPI_MODULE_NAME    ("evxfregn")
     54       1.1    jruoho 
     55       1.1    jruoho 
     56       1.1    jruoho /*******************************************************************************
     57       1.1    jruoho  *
     58  1.1.1.15  christos  * FUNCTION:    AcpiInstallAddressSpaceHandlerInternal
     59       1.1    jruoho  *
     60       1.1    jruoho  * PARAMETERS:  Device          - Handle for the device
     61       1.1    jruoho  *              SpaceId         - The address space ID
     62       1.1    jruoho  *              Handler         - Address of the handler
     63       1.1    jruoho  *              Setup           - Address of the setup function
     64       1.1    jruoho  *              Context         - Value passed to the handler on each access
     65  1.1.1.15  christos  *              Run_Reg         - Run _REG methods for this address space?
     66       1.1    jruoho  *
     67       1.1    jruoho  * RETURN:      Status
     68       1.1    jruoho  *
     69       1.1    jruoho  * DESCRIPTION: Install a handler for all OpRegions of a given SpaceId.
     70       1.1    jruoho  *
     71   1.1.1.2    jruoho  * NOTE: This function should only be called after AcpiEnableSubsystem has
     72   1.1.1.2    jruoho  * been called. This is because any _REG methods associated with the Space ID
     73   1.1.1.2    jruoho  * are executed here, and these methods can only be safely executed after
     74   1.1.1.2    jruoho  * the default handlers have been installed and the hardware has been
     75   1.1.1.2    jruoho  * initialized (via AcpiEnableSubsystem.)
     76  1.1.1.15  christos  * To avoid this problem pass FALSE for Run_Reg and later on call
     77  1.1.1.15  christos  * AcpiExecuteRegMethods() to execute _REG.
     78   1.1.1.2    jruoho  *
     79       1.1    jruoho  ******************************************************************************/
     80       1.1    jruoho 
     81  1.1.1.15  christos static ACPI_STATUS
     82  1.1.1.15  christos AcpiInstallAddressSpaceHandlerInternal (
     83       1.1    jruoho     ACPI_HANDLE             Device,
     84       1.1    jruoho     ACPI_ADR_SPACE_TYPE     SpaceId,
     85       1.1    jruoho     ACPI_ADR_SPACE_HANDLER  Handler,
     86       1.1    jruoho     ACPI_ADR_SPACE_SETUP    Setup,
     87  1.1.1.15  christos     void                    *Context,
     88  1.1.1.15  christos     BOOLEAN                 Run_Reg)
     89       1.1    jruoho {
     90       1.1    jruoho     ACPI_NAMESPACE_NODE     *Node;
     91       1.1    jruoho     ACPI_STATUS             Status;
     92       1.1    jruoho 
     93       1.1    jruoho 
     94       1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiInstallAddressSpaceHandler);
     95       1.1    jruoho 
     96       1.1    jruoho 
     97       1.1    jruoho     /* Parameter validation */
     98       1.1    jruoho 
     99       1.1    jruoho     if (!Device)
    100       1.1    jruoho     {
    101       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    102       1.1    jruoho     }
    103       1.1    jruoho 
    104       1.1    jruoho     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
    105       1.1    jruoho     if (ACPI_FAILURE (Status))
    106       1.1    jruoho     {
    107       1.1    jruoho         return_ACPI_STATUS (Status);
    108       1.1    jruoho     }
    109       1.1    jruoho 
    110       1.1    jruoho     /* Convert and validate the device handle */
    111       1.1    jruoho 
    112       1.1    jruoho     Node = AcpiNsValidateHandle (Device);
    113       1.1    jruoho     if (!Node)
    114       1.1    jruoho     {
    115       1.1    jruoho         Status = AE_BAD_PARAMETER;
    116       1.1    jruoho         goto UnlockAndExit;
    117       1.1    jruoho     }
    118       1.1    jruoho 
    119       1.1    jruoho     /* Install the handler for all Regions for this Space ID */
    120       1.1    jruoho 
    121   1.1.1.7  christos     Status = AcpiEvInstallSpaceHandler (
    122   1.1.1.7  christos         Node, SpaceId, Handler, Setup, Context);
    123       1.1    jruoho     if (ACPI_FAILURE (Status))
    124       1.1    jruoho     {
    125       1.1    jruoho         goto UnlockAndExit;
    126       1.1    jruoho     }
    127       1.1    jruoho 
    128   1.1.1.3    jruoho     /* Run all _REG methods for this address space */
    129   1.1.1.3    jruoho 
    130  1.1.1.15  christos     if (Run_Reg)
    131  1.1.1.15  christos     {
    132  1.1.1.15  christos         AcpiEvExecuteRegMethods (Node, SpaceId, ACPI_REG_CONNECT);
    133  1.1.1.15  christos     }
    134       1.1    jruoho 
    135       1.1    jruoho UnlockAndExit:
    136       1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
    137       1.1    jruoho     return_ACPI_STATUS (Status);
    138       1.1    jruoho }
    139       1.1    jruoho 
    140  1.1.1.15  christos ACPI_STATUS
    141  1.1.1.15  christos AcpiInstallAddressSpaceHandler (
    142  1.1.1.15  christos     ACPI_HANDLE             Device,
    143  1.1.1.15  christos     ACPI_ADR_SPACE_TYPE     SpaceId,
    144  1.1.1.15  christos     ACPI_ADR_SPACE_HANDLER  Handler,
    145  1.1.1.15  christos     ACPI_ADR_SPACE_SETUP    Setup,
    146  1.1.1.15  christos     void                    *Context)
    147  1.1.1.15  christos {
    148  1.1.1.15  christos     return AcpiInstallAddressSpaceHandlerInternal (Device, SpaceId, Handler, Setup, Context, TRUE);
    149  1.1.1.15  christos }
    150  1.1.1.15  christos 
    151       1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandler)
    152       1.1    jruoho 
    153  1.1.1.15  christos ACPI_STATUS
    154  1.1.1.15  christos AcpiInstallAddressSpaceHandlerNo_Reg (
    155  1.1.1.15  christos     ACPI_HANDLE             Device,
    156  1.1.1.15  christos     ACPI_ADR_SPACE_TYPE     SpaceId,
    157  1.1.1.15  christos     ACPI_ADR_SPACE_HANDLER  Handler,
    158  1.1.1.15  christos     ACPI_ADR_SPACE_SETUP    Setup,
    159  1.1.1.15  christos     void                    *Context)
    160  1.1.1.15  christos {
    161  1.1.1.15  christos     return AcpiInstallAddressSpaceHandlerInternal (Device, SpaceId, Handler, Setup, Context, FALSE);
    162  1.1.1.15  christos }
    163  1.1.1.15  christos 
    164  1.1.1.15  christos ACPI_EXPORT_SYMBOL (AcpiInstallAddressSpaceHandlerNo_Reg)
    165  1.1.1.15  christos 
    166       1.1    jruoho 
    167       1.1    jruoho /*******************************************************************************
    168       1.1    jruoho  *
    169       1.1    jruoho  * FUNCTION:    AcpiRemoveAddressSpaceHandler
    170       1.1    jruoho  *
    171       1.1    jruoho  * PARAMETERS:  Device          - Handle for the device
    172       1.1    jruoho  *              SpaceId         - The address space ID
    173       1.1    jruoho  *              Handler         - Address of the handler
    174       1.1    jruoho  *
    175       1.1    jruoho  * RETURN:      Status
    176       1.1    jruoho  *
    177       1.1    jruoho  * DESCRIPTION: Remove a previously installed handler.
    178       1.1    jruoho  *
    179       1.1    jruoho  ******************************************************************************/
    180       1.1    jruoho 
    181       1.1    jruoho ACPI_STATUS
    182       1.1    jruoho AcpiRemoveAddressSpaceHandler (
    183       1.1    jruoho     ACPI_HANDLE             Device,
    184       1.1    jruoho     ACPI_ADR_SPACE_TYPE     SpaceId,
    185       1.1    jruoho     ACPI_ADR_SPACE_HANDLER  Handler)
    186       1.1    jruoho {
    187       1.1    jruoho     ACPI_OPERAND_OBJECT     *ObjDesc;
    188       1.1    jruoho     ACPI_OPERAND_OBJECT     *HandlerObj;
    189       1.1    jruoho     ACPI_OPERAND_OBJECT     *RegionObj;
    190       1.1    jruoho     ACPI_OPERAND_OBJECT     **LastObjPtr;
    191       1.1    jruoho     ACPI_NAMESPACE_NODE     *Node;
    192       1.1    jruoho     ACPI_STATUS             Status;
    193       1.1    jruoho 
    194       1.1    jruoho 
    195       1.1    jruoho     ACPI_FUNCTION_TRACE (AcpiRemoveAddressSpaceHandler);
    196       1.1    jruoho 
    197       1.1    jruoho 
    198       1.1    jruoho     /* Parameter validation */
    199       1.1    jruoho 
    200       1.1    jruoho     if (!Device)
    201       1.1    jruoho     {
    202       1.1    jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    203       1.1    jruoho     }
    204       1.1    jruoho 
    205       1.1    jruoho     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
    206       1.1    jruoho     if (ACPI_FAILURE (Status))
    207       1.1    jruoho     {
    208       1.1    jruoho         return_ACPI_STATUS (Status);
    209       1.1    jruoho     }
    210       1.1    jruoho 
    211       1.1    jruoho     /* Convert and validate the device handle */
    212       1.1    jruoho 
    213       1.1    jruoho     Node = AcpiNsValidateHandle (Device);
    214       1.1    jruoho     if (!Node ||
    215       1.1    jruoho         ((Node->Type != ACPI_TYPE_DEVICE)    &&
    216       1.1    jruoho          (Node->Type != ACPI_TYPE_PROCESSOR) &&
    217       1.1    jruoho          (Node->Type != ACPI_TYPE_THERMAL)   &&
    218       1.1    jruoho          (Node != AcpiGbl_RootNode)))
    219       1.1    jruoho     {
    220       1.1    jruoho         Status = AE_BAD_PARAMETER;
    221       1.1    jruoho         goto UnlockAndExit;
    222       1.1    jruoho     }
    223       1.1    jruoho 
    224       1.1    jruoho     /* Make sure the internal object exists */
    225       1.1    jruoho 
    226       1.1    jruoho     ObjDesc = AcpiNsGetAttachedObject (Node);
    227       1.1    jruoho     if (!ObjDesc)
    228       1.1    jruoho     {
    229       1.1    jruoho         Status = AE_NOT_EXIST;
    230       1.1    jruoho         goto UnlockAndExit;
    231       1.1    jruoho     }
    232       1.1    jruoho 
    233       1.1    jruoho     /* Find the address handler the user requested */
    234       1.1    jruoho 
    235   1.1.1.7  christos     HandlerObj = ObjDesc->CommonNotify.Handler;
    236   1.1.1.7  christos     LastObjPtr = &ObjDesc->CommonNotify.Handler;
    237       1.1    jruoho     while (HandlerObj)
    238       1.1    jruoho     {
    239       1.1    jruoho         /* We have a handler, see if user requested this one */
    240       1.1    jruoho 
    241       1.1    jruoho         if (HandlerObj->AddressSpace.SpaceId == SpaceId)
    242       1.1    jruoho         {
    243       1.1    jruoho             /* Handler must be the same as the installed handler */
    244       1.1    jruoho 
    245       1.1    jruoho             if (HandlerObj->AddressSpace.Handler != Handler)
    246       1.1    jruoho             {
    247       1.1    jruoho                 Status = AE_BAD_PARAMETER;
    248       1.1    jruoho                 goto UnlockAndExit;
    249       1.1    jruoho             }
    250       1.1    jruoho 
    251       1.1    jruoho             /* Matched SpaceId, first dereference this in the Regions */
    252       1.1    jruoho 
    253       1.1    jruoho             ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
    254       1.1    jruoho                 "Removing address handler %p(%p) for region %s "
    255       1.1    jruoho                 "on Device %p(%p)\n",
    256       1.1    jruoho                 HandlerObj, Handler, AcpiUtGetRegionName (SpaceId),
    257       1.1    jruoho                 Node, ObjDesc));
    258       1.1    jruoho 
    259       1.1    jruoho             RegionObj = HandlerObj->AddressSpace.RegionList;
    260       1.1    jruoho 
    261       1.1    jruoho             /* Walk the handler's region list */
    262       1.1    jruoho 
    263       1.1    jruoho             while (RegionObj)
    264       1.1    jruoho             {
    265       1.1    jruoho                 /*
    266       1.1    jruoho                  * First disassociate the handler from the region.
    267       1.1    jruoho                  *
    268       1.1    jruoho                  * NOTE: this doesn't mean that the region goes away
    269       1.1    jruoho                  * The region is just inaccessible as indicated to
    270       1.1    jruoho                  * the _REG method
    271       1.1    jruoho                  */
    272       1.1    jruoho                 AcpiEvDetachRegion (RegionObj, TRUE);
    273       1.1    jruoho 
    274       1.1    jruoho                 /*
    275       1.1    jruoho                  * Walk the list: Just grab the head because the
    276       1.1    jruoho                  * DetachRegion removed the previous head.
    277       1.1    jruoho                  */
    278       1.1    jruoho                 RegionObj = HandlerObj->AddressSpace.RegionList;
    279       1.1    jruoho             }
    280       1.1    jruoho 
    281       1.1    jruoho             /* Remove this Handler object from the list */
    282       1.1    jruoho 
    283       1.1    jruoho             *LastObjPtr = HandlerObj->AddressSpace.Next;
    284       1.1    jruoho 
    285       1.1    jruoho             /* Now we can delete the handler object */
    286       1.1    jruoho 
    287  1.1.1.13  christos             AcpiOsReleaseMutex (HandlerObj->AddressSpace.ContextMutex);
    288       1.1    jruoho             AcpiUtRemoveReference (HandlerObj);
    289       1.1    jruoho             goto UnlockAndExit;
    290       1.1    jruoho         }
    291       1.1    jruoho 
    292       1.1    jruoho         /* Walk the linked list of handlers */
    293       1.1    jruoho 
    294       1.1    jruoho         LastObjPtr = &HandlerObj->AddressSpace.Next;
    295       1.1    jruoho         HandlerObj = HandlerObj->AddressSpace.Next;
    296       1.1    jruoho     }
    297       1.1    jruoho 
    298       1.1    jruoho     /* The handler does not exist */
    299       1.1    jruoho 
    300       1.1    jruoho     ACPI_DEBUG_PRINT ((ACPI_DB_OPREGION,
    301       1.1    jruoho         "Unable to remove address handler %p for %s(%X), DevNode %p, obj %p\n",
    302       1.1    jruoho         Handler, AcpiUtGetRegionName (SpaceId), SpaceId, Node, ObjDesc));
    303       1.1    jruoho 
    304       1.1    jruoho     Status = AE_NOT_EXIST;
    305       1.1    jruoho 
    306       1.1    jruoho UnlockAndExit:
    307       1.1    jruoho     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
    308       1.1    jruoho     return_ACPI_STATUS (Status);
    309       1.1    jruoho }
    310       1.1    jruoho 
    311       1.1    jruoho ACPI_EXPORT_SYMBOL (AcpiRemoveAddressSpaceHandler)
    312  1.1.1.15  christos 
    313  1.1.1.15  christos 
    314  1.1.1.15  christos /*******************************************************************************
    315  1.1.1.15  christos  *
    316  1.1.1.15  christos  * FUNCTION:    AcpiExecuteRegMethods
    317  1.1.1.15  christos  *
    318  1.1.1.15  christos  * PARAMETERS:  Device          - Handle for the device
    319  1.1.1.15  christos  *              SpaceId         - The address space ID
    320  1.1.1.15  christos  *
    321  1.1.1.15  christos  * RETURN:      Status
    322  1.1.1.15  christos  *
    323  1.1.1.15  christos  * DESCRIPTION: Execute _REG for all OpRegions of a given SpaceId.
    324  1.1.1.15  christos  *
    325  1.1.1.15  christos  ******************************************************************************/
    326  1.1.1.15  christos 
    327  1.1.1.15  christos ACPI_STATUS
    328  1.1.1.15  christos AcpiExecuteRegMethods (
    329  1.1.1.15  christos     ACPI_HANDLE             Device,
    330  1.1.1.15  christos     ACPI_ADR_SPACE_TYPE     SpaceId)
    331  1.1.1.15  christos {
    332  1.1.1.15  christos     ACPI_NAMESPACE_NODE     *Node;
    333  1.1.1.15  christos     ACPI_STATUS             Status;
    334  1.1.1.15  christos 
    335  1.1.1.15  christos 
    336  1.1.1.15  christos     ACPI_FUNCTION_TRACE (AcpiExecuteRegMethods);
    337  1.1.1.15  christos 
    338  1.1.1.15  christos 
    339  1.1.1.15  christos     /* Parameter validation */
    340  1.1.1.15  christos 
    341  1.1.1.15  christos     if (!Device)
    342  1.1.1.15  christos     {
    343  1.1.1.15  christos         return_ACPI_STATUS (AE_BAD_PARAMETER);
    344  1.1.1.15  christos     }
    345  1.1.1.15  christos 
    346  1.1.1.15  christos     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
    347  1.1.1.15  christos     if (ACPI_FAILURE (Status))
    348  1.1.1.15  christos     {
    349  1.1.1.15  christos         return_ACPI_STATUS (Status);
    350  1.1.1.15  christos     }
    351  1.1.1.15  christos 
    352  1.1.1.15  christos     /* Convert and validate the device handle */
    353  1.1.1.15  christos 
    354  1.1.1.15  christos     Node = AcpiNsValidateHandle (Device);
    355  1.1.1.15  christos     if (Node)
    356  1.1.1.15  christos     {
    357  1.1.1.15  christos         /* Run all _REG methods for this address space */
    358  1.1.1.15  christos 
    359  1.1.1.15  christos         AcpiEvExecuteRegMethods (Node, SpaceId, ACPI_REG_CONNECT);
    360  1.1.1.15  christos     }
    361  1.1.1.15  christos     else
    362  1.1.1.15  christos     {
    363  1.1.1.15  christos         Status = AE_BAD_PARAMETER;
    364  1.1.1.15  christos     }
    365  1.1.1.15  christos 
    366  1.1.1.15  christos     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
    367  1.1.1.15  christos     return_ACPI_STATUS (Status);
    368  1.1.1.15  christos }
    369  1.1.1.15  christos 
    370  1.1.1.15  christos ACPI_EXPORT_SYMBOL (AcpiExecuteRegMethods)
    371