utownerid.c revision 1.1.1.1.10.3
1 1.1.1.1.10.2 tls /******************************************************************************* 2 1.1.1.1.10.2 tls * 3 1.1.1.1.10.2 tls * Module Name: utownerid - Support for Table/Method Owner IDs 4 1.1.1.1.10.2 tls * 5 1.1.1.1.10.2 tls ******************************************************************************/ 6 1.1.1.1.10.2 tls 7 1.1.1.1.10.2 tls /* 8 1.1.1.1.10.3 jdolecek * Copyright (C) 2000 - 2017, Intel Corp. 9 1.1.1.1.10.2 tls * All rights reserved. 10 1.1.1.1.10.2 tls * 11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without 12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions 13 1.1.1.1.10.2 tls * are met: 14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright 15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer, 16 1.1.1.1.10.2 tls * without modification. 17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below 19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon 20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further 21 1.1.1.1.10.2 tls * binary redistribution. 22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names 23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived 24 1.1.1.1.10.2 tls * from this software without specific prior written permission. 25 1.1.1.1.10.2 tls * 26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the 27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free 28 1.1.1.1.10.2 tls * Software Foundation. 29 1.1.1.1.10.2 tls * 30 1.1.1.1.10.2 tls * NO WARRANTY 31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES. 42 1.1.1.1.10.2 tls */ 43 1.1.1.1.10.2 tls 44 1.1.1.1.10.2 tls #include "acpi.h" 45 1.1.1.1.10.2 tls #include "accommon.h" 46 1.1.1.1.10.2 tls #include "acnamesp.h" 47 1.1.1.1.10.2 tls 48 1.1.1.1.10.2 tls 49 1.1.1.1.10.2 tls #define _COMPONENT ACPI_UTILITIES 50 1.1.1.1.10.2 tls ACPI_MODULE_NAME ("utownerid") 51 1.1.1.1.10.2 tls 52 1.1.1.1.10.2 tls 53 1.1.1.1.10.2 tls /******************************************************************************* 54 1.1.1.1.10.2 tls * 55 1.1.1.1.10.2 tls * FUNCTION: AcpiUtAllocateOwnerId 56 1.1.1.1.10.2 tls * 57 1.1.1.1.10.2 tls * PARAMETERS: OwnerId - Where the new owner ID is returned 58 1.1.1.1.10.2 tls * 59 1.1.1.1.10.2 tls * RETURN: Status 60 1.1.1.1.10.2 tls * 61 1.1.1.1.10.2 tls * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to 62 1.1.1.1.10.2 tls * track objects created by the table or method, to be deleted 63 1.1.1.1.10.2 tls * when the method exits or the table is unloaded. 64 1.1.1.1.10.2 tls * 65 1.1.1.1.10.2 tls ******************************************************************************/ 66 1.1.1.1.10.2 tls 67 1.1.1.1.10.2 tls ACPI_STATUS 68 1.1.1.1.10.2 tls AcpiUtAllocateOwnerId ( 69 1.1.1.1.10.2 tls ACPI_OWNER_ID *OwnerId) 70 1.1.1.1.10.2 tls { 71 1.1.1.1.10.2 tls UINT32 i; 72 1.1.1.1.10.2 tls UINT32 j; 73 1.1.1.1.10.2 tls UINT32 k; 74 1.1.1.1.10.2 tls ACPI_STATUS Status; 75 1.1.1.1.10.2 tls 76 1.1.1.1.10.2 tls 77 1.1.1.1.10.2 tls ACPI_FUNCTION_TRACE (UtAllocateOwnerId); 78 1.1.1.1.10.2 tls 79 1.1.1.1.10.2 tls 80 1.1.1.1.10.2 tls /* Guard against multiple allocations of ID to the same location */ 81 1.1.1.1.10.2 tls 82 1.1.1.1.10.2 tls if (*OwnerId) 83 1.1.1.1.10.2 tls { 84 1.1.1.1.10.3 jdolecek ACPI_ERROR ((AE_INFO, 85 1.1.1.1.10.3 jdolecek "Owner ID [0x%2.2X] already exists", *OwnerId)); 86 1.1.1.1.10.2 tls return_ACPI_STATUS (AE_ALREADY_EXISTS); 87 1.1.1.1.10.2 tls } 88 1.1.1.1.10.2 tls 89 1.1.1.1.10.2 tls /* Mutex for the global ID mask */ 90 1.1.1.1.10.2 tls 91 1.1.1.1.10.2 tls Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES); 92 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status)) 93 1.1.1.1.10.2 tls { 94 1.1.1.1.10.2 tls return_ACPI_STATUS (Status); 95 1.1.1.1.10.2 tls } 96 1.1.1.1.10.2 tls 97 1.1.1.1.10.2 tls /* 98 1.1.1.1.10.2 tls * Find a free owner ID, cycle through all possible IDs on repeated 99 1.1.1.1.10.3 jdolecek * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index 100 1.1.1.1.10.3 jdolecek * may have to be scanned twice. 101 1.1.1.1.10.2 tls */ 102 1.1.1.1.10.2 tls for (i = 0, j = AcpiGbl_LastOwnerIdIndex; 103 1.1.1.1.10.2 tls i < (ACPI_NUM_OWNERID_MASKS + 1); 104 1.1.1.1.10.2 tls i++, j++) 105 1.1.1.1.10.2 tls { 106 1.1.1.1.10.2 tls if (j >= ACPI_NUM_OWNERID_MASKS) 107 1.1.1.1.10.2 tls { 108 1.1.1.1.10.2 tls j = 0; /* Wraparound to start of mask array */ 109 1.1.1.1.10.2 tls } 110 1.1.1.1.10.2 tls 111 1.1.1.1.10.2 tls for (k = AcpiGbl_NextOwnerIdOffset; k < 32; k++) 112 1.1.1.1.10.2 tls { 113 1.1.1.1.10.2 tls if (AcpiGbl_OwnerIdMask[j] == ACPI_UINT32_MAX) 114 1.1.1.1.10.2 tls { 115 1.1.1.1.10.2 tls /* There are no free IDs in this mask */ 116 1.1.1.1.10.2 tls 117 1.1.1.1.10.2 tls break; 118 1.1.1.1.10.2 tls } 119 1.1.1.1.10.2 tls 120 1.1.1.1.10.3 jdolecek /* 121 1.1.1.1.10.3 jdolecek * Note: the UINT32 cast ensures that 1 is stored as a unsigned 122 1.1.1.1.10.3 jdolecek * integer. Omitting the cast may result in 1 being stored as an 123 1.1.1.1.10.3 jdolecek * int. Some compilers or runtime error detection may flag this as 124 1.1.1.1.10.3 jdolecek * an error. 125 1.1.1.1.10.3 jdolecek */ 126 1.1.1.1.10.3 jdolecek if (!(AcpiGbl_OwnerIdMask[j] & ((UINT32) 1 << k))) 127 1.1.1.1.10.2 tls { 128 1.1.1.1.10.2 tls /* 129 1.1.1.1.10.2 tls * Found a free ID. The actual ID is the bit index plus one, 130 1.1.1.1.10.2 tls * making zero an invalid Owner ID. Save this as the last ID 131 1.1.1.1.10.2 tls * allocated and update the global ID mask. 132 1.1.1.1.10.2 tls */ 133 1.1.1.1.10.3 jdolecek AcpiGbl_OwnerIdMask[j] |= ((UINT32) 1 << k); 134 1.1.1.1.10.2 tls 135 1.1.1.1.10.2 tls AcpiGbl_LastOwnerIdIndex = (UINT8) j; 136 1.1.1.1.10.2 tls AcpiGbl_NextOwnerIdOffset = (UINT8) (k + 1); 137 1.1.1.1.10.2 tls 138 1.1.1.1.10.2 tls /* 139 1.1.1.1.10.2 tls * Construct encoded ID from the index and bit position 140 1.1.1.1.10.2 tls * 141 1.1.1.1.10.2 tls * Note: Last [j].k (bit 255) is never used and is marked 142 1.1.1.1.10.2 tls * permanently allocated (prevents +1 overflow) 143 1.1.1.1.10.2 tls */ 144 1.1.1.1.10.2 tls *OwnerId = (ACPI_OWNER_ID) ((k + 1) + ACPI_MUL_32 (j)); 145 1.1.1.1.10.2 tls 146 1.1.1.1.10.2 tls ACPI_DEBUG_PRINT ((ACPI_DB_VALUES, 147 1.1.1.1.10.2 tls "Allocated OwnerId: %2.2X\n", (unsigned int) *OwnerId)); 148 1.1.1.1.10.2 tls goto Exit; 149 1.1.1.1.10.2 tls } 150 1.1.1.1.10.2 tls } 151 1.1.1.1.10.2 tls 152 1.1.1.1.10.2 tls AcpiGbl_NextOwnerIdOffset = 0; 153 1.1.1.1.10.2 tls } 154 1.1.1.1.10.2 tls 155 1.1.1.1.10.2 tls /* 156 1.1.1.1.10.2 tls * All OwnerIds have been allocated. This typically should 157 1.1.1.1.10.2 tls * not happen since the IDs are reused after deallocation. The IDs are 158 1.1.1.1.10.2 tls * allocated upon table load (one per table) and method execution, and 159 1.1.1.1.10.2 tls * they are released when a table is unloaded or a method completes 160 1.1.1.1.10.2 tls * execution. 161 1.1.1.1.10.2 tls * 162 1.1.1.1.10.3 jdolecek * If this error happens, there may be very deep nesting of invoked 163 1.1.1.1.10.3 jdolecek * control methods, or there may be a bug where the IDs are not released. 164 1.1.1.1.10.2 tls */ 165 1.1.1.1.10.2 tls Status = AE_OWNER_ID_LIMIT; 166 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO, 167 1.1.1.1.10.2 tls "Could not allocate new OwnerId (255 max), AE_OWNER_ID_LIMIT")); 168 1.1.1.1.10.2 tls 169 1.1.1.1.10.2 tls Exit: 170 1.1.1.1.10.2 tls (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES); 171 1.1.1.1.10.2 tls return_ACPI_STATUS (Status); 172 1.1.1.1.10.2 tls } 173 1.1.1.1.10.2 tls 174 1.1.1.1.10.2 tls 175 1.1.1.1.10.2 tls /******************************************************************************* 176 1.1.1.1.10.2 tls * 177 1.1.1.1.10.2 tls * FUNCTION: AcpiUtReleaseOwnerId 178 1.1.1.1.10.2 tls * 179 1.1.1.1.10.2 tls * PARAMETERS: OwnerIdPtr - Pointer to a previously allocated OwnerID 180 1.1.1.1.10.2 tls * 181 1.1.1.1.10.2 tls * RETURN: None. No error is returned because we are either exiting a 182 1.1.1.1.10.2 tls * control method or unloading a table. Either way, we would 183 1.1.1.1.10.2 tls * ignore any error anyway. 184 1.1.1.1.10.2 tls * 185 1.1.1.1.10.2 tls * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255 186 1.1.1.1.10.2 tls * 187 1.1.1.1.10.2 tls ******************************************************************************/ 188 1.1.1.1.10.2 tls 189 1.1.1.1.10.2 tls void 190 1.1.1.1.10.2 tls AcpiUtReleaseOwnerId ( 191 1.1.1.1.10.2 tls ACPI_OWNER_ID *OwnerIdPtr) 192 1.1.1.1.10.2 tls { 193 1.1.1.1.10.2 tls ACPI_OWNER_ID OwnerId = *OwnerIdPtr; 194 1.1.1.1.10.2 tls ACPI_STATUS Status; 195 1.1.1.1.10.2 tls UINT32 Index; 196 1.1.1.1.10.2 tls UINT32 Bit; 197 1.1.1.1.10.2 tls 198 1.1.1.1.10.2 tls 199 1.1.1.1.10.2 tls ACPI_FUNCTION_TRACE_U32 (UtReleaseOwnerId, OwnerId); 200 1.1.1.1.10.2 tls 201 1.1.1.1.10.2 tls 202 1.1.1.1.10.2 tls /* Always clear the input OwnerId (zero is an invalid ID) */ 203 1.1.1.1.10.2 tls 204 1.1.1.1.10.2 tls *OwnerIdPtr = 0; 205 1.1.1.1.10.2 tls 206 1.1.1.1.10.2 tls /* Zero is not a valid OwnerID */ 207 1.1.1.1.10.2 tls 208 1.1.1.1.10.2 tls if (OwnerId == 0) 209 1.1.1.1.10.2 tls { 210 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO, "Invalid OwnerId: 0x%2.2X", OwnerId)); 211 1.1.1.1.10.2 tls return_VOID; 212 1.1.1.1.10.2 tls } 213 1.1.1.1.10.2 tls 214 1.1.1.1.10.2 tls /* Mutex for the global ID mask */ 215 1.1.1.1.10.2 tls 216 1.1.1.1.10.2 tls Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES); 217 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status)) 218 1.1.1.1.10.2 tls { 219 1.1.1.1.10.2 tls return_VOID; 220 1.1.1.1.10.2 tls } 221 1.1.1.1.10.2 tls 222 1.1.1.1.10.2 tls /* Normalize the ID to zero */ 223 1.1.1.1.10.2 tls 224 1.1.1.1.10.2 tls OwnerId--; 225 1.1.1.1.10.2 tls 226 1.1.1.1.10.2 tls /* Decode ID to index/offset pair */ 227 1.1.1.1.10.2 tls 228 1.1.1.1.10.2 tls Index = ACPI_DIV_32 (OwnerId); 229 1.1.1.1.10.3 jdolecek Bit = (UINT32) 1 << ACPI_MOD_32 (OwnerId); 230 1.1.1.1.10.2 tls 231 1.1.1.1.10.2 tls /* Free the owner ID only if it is valid */ 232 1.1.1.1.10.2 tls 233 1.1.1.1.10.2 tls if (AcpiGbl_OwnerIdMask[Index] & Bit) 234 1.1.1.1.10.2 tls { 235 1.1.1.1.10.2 tls AcpiGbl_OwnerIdMask[Index] ^= Bit; 236 1.1.1.1.10.2 tls } 237 1.1.1.1.10.2 tls else 238 1.1.1.1.10.2 tls { 239 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO, 240 1.1.1.1.10.2 tls "Release of non-allocated OwnerId: 0x%2.2X", OwnerId + 1)); 241 1.1.1.1.10.2 tls } 242 1.1.1.1.10.2 tls 243 1.1.1.1.10.2 tls (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES); 244 1.1.1.1.10.2 tls return_VOID; 245 1.1.1.1.10.2 tls } 246
Indexes created Mon Oct 20 11:09:49 GMT 2025