projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 9b6bbcdb MK |
1 | /** @file\r |
| 2 | Prototypes and defines for the QNC SMM Dispatcher.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2013-2015 Intel Corporation.\r | |
| 5 | \r | |
| 6 | This program and the accompanying materials\r | |
| 7 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 16 | #ifndef QNC_SMM_H\r | |
| 17 | #define QNC_SMM_H\r | |
| 18 | \r | |
| 19 | //\r | |
| 20 | // Include common header file for this module.\r | |
| 21 | //\r | |
| 22 | #include "CommonHeader.h"\r | |
| 23 | \r | |
| 24 | #include "QNCSmmRegisters.h"\r | |
| 25 | \r | |
| 26 | extern EFI_HANDLE mQNCSmmDispatcherImageHandle;\r | |
| 27 | \r | |
| 28 | \r | |
| 29 | //\r | |
| 30 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 31 | // SUPPORTED PROTOCOLS\r | |
| 32 | //\r | |
| 33 | \r | |
| 34 | //\r | |
| 35 | // Define an enumeration for all the supported protocols\r | |
| 36 | //\r | |
| 37 | typedef enum {\r | |
| 38 | // UsbType, DELETE:on QuarkNcSocId, there is no usb smi supported\r | |
| 39 | SxType,\r | |
| 40 | SwType,\r | |
| 41 | GpiType,\r | |
| 42 | QNCnType,\r | |
| 43 | PowerButtonType,\r | |
| 44 | PeriodicTimerType,\r | |
| 45 | NUM_PROTOCOLS\r | |
| 46 | } QNC_SMM_PROTOCOL_TYPE;\r | |
| 47 | \r | |
| 48 | //\r | |
| 49 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 50 | // SPECIFYING A REGISTER\r | |
| 51 | // We want a general way of referring to addresses. For this case, we'll only\r | |
| 52 | // need addresses in the ACPI table (and the TCO entries within the ACPI table).\r | |
| 53 | // However, it's interesting to consider what it would take to support other types\r | |
| 54 | // of addresses. To address Will's concern, I think it prudent to accommodate it\r | |
| 55 | // early on in the design.\r | |
| 56 | //\r | |
| 57 | // Addresses we need to consider:\r | |
| 58 | //\r | |
| 59 | // Type: Required:\r | |
| 60 | // I/O Yes\r | |
| 61 | // ACPI (special case of I/O) Only if we want to\r | |
| 62 | // TCO (special case of ACPI) Only if we want to\r | |
| 63 | // Memory (or Memory Mapped I/O) Only if we want to\r | |
| 64 | // PCI Yes, for BiosWp\r | |
| 65 | //\r | |
| 66 | typedef enum {\r | |
| 67 | //\r | |
| 68 | // IO_ADDR_TYPE, // unimplemented\r | |
| 69 | //\r | |
| 70 | ACPI_ADDR_TYPE,\r | |
| 71 | GPE_ADDR_TYPE,\r | |
| 72 | //\r | |
| 73 | // MEMORY_ADDR_TYPE, // unimplemented\r | |
| 74 | //\r | |
| 75 | MEMORY_MAPPED_IO_ADDRESS_TYPE,\r | |
| 76 | PCI_ADDR_TYPE,\r | |
| 77 | NUM_ADDR_TYPES, // count of items in this enum\r | |
| 78 | QNC_SMM_ADDR_TYPE_NULL = -1 // sentinel to indicate NULL or to signal end of arrays\r | |
| 79 | } ADDR_TYPE;\r | |
| 80 | \r | |
| 81 | //\r | |
| 82 | // Assumption: 32-bits -- enum's evaluate to integer\r | |
| 83 | // Assumption: This code will only run on IA-32. Justification: IA-64 doesn't have SMIs.\r | |
| 84 | // We don't have to worry about 64-bit addresses.\r | |
| 85 | // Typedef the size of addresses in case the numbers I'm using are wrong or in case\r | |
| 86 | // this changes. This is a good idea because PCI_ADDR will change, for example, when\r | |
| 87 | // we add support for PciExpress.\r | |
| 88 | //\r | |
| 89 | typedef UINT16 IO_ADDR;\r | |
| 90 | typedef IO_ADDR ACPI_ADDR; // can omit\r | |
| 91 | typedef IO_ADDR GPE_ADDR; // can omit\r | |
| 92 | typedef IO_ADDR TCO_ADDR; // can omit\r | |
| 93 | typedef VOID *MEM_ADDR;\r | |
| 94 | typedef MEM_ADDR MEMORY_MAPPED_IO_ADDRESS;\r | |
| 95 | typedef union {\r | |
| 96 | UINT32 Raw;\r | |
| 97 | struct {\r | |
| 98 | UINT8 Reg;\r | |
| 99 | UINT8 Fnc;\r | |
| 100 | UINT8 Dev;\r | |
| 101 | UINT8 Bus;\r | |
| 102 | } Fields;\r | |
| 103 | } PCI_ADDR;\r | |
| 104 | \r | |
| 105 | typedef struct {\r | |
| 106 | ADDR_TYPE Type;\r | |
| 107 | union {\r | |
| 108 | //\r | |
| 109 | // used to initialize during declaration/definition\r | |
| 110 | //\r | |
| 111 | UINTN raw;\r | |
| 112 | \r | |
| 113 | //\r | |
| 114 | // used to access useful data\r | |
| 115 | //\r | |
| 116 | IO_ADDR io;\r | |
| 117 | ACPI_ADDR acpi;\r | |
| 118 | GPE_ADDR gpe;\r | |
| 119 | TCO_ADDR tco;\r | |
| 120 | MEM_ADDR mem;\r | |
| 121 | MEMORY_MAPPED_IO_ADDRESS Mmio;\r | |
| 122 | PCI_ADDR pci;\r | |
| 123 | \r | |
| 124 | } Data;\r | |
| 125 | \r | |
| 126 | } QNC_SMM_ADDRESS;\r | |
| 127 | //\r | |
| 128 | // Assumption: total size is 64 bits (32 for type and 32 for data) or 8 bytes\r | |
| 129 | //\r | |
| 130 | #define EFI_PCI_ADDRESS_PORT 0xcf8\r | |
| 131 | #define EFI_PCI_DATA_PORT 0xcfc\r | |
| 132 | \r | |
| 133 | //\r | |
| 134 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 135 | // SPECIFYING BITS WITHIN A REGISTER\r | |
| 136 | // Here's a struct that helps us specify a source or enable bit.\r | |
| 137 | //\r | |
| 138 | typedef struct {\r | |
| 139 | QNC_SMM_ADDRESS Reg;\r | |
| 140 | UINT8 SizeInBytes; // of the register\r | |
| 141 | UINT8 Bit;\r | |
| 142 | } QNC_SMM_BIT_DESC;\r | |
| 143 | \r | |
| 144 | //\r | |
| 145 | // Sometimes, we'll have bit descriptions that are unused. It'd be great to have a\r | |
| 146 | // way to easily identify them:\r | |
| 147 | //\r | |
| 148 | #define IS_BIT_DESC_NULL(BitDesc) ((BitDesc).Reg.Type == QNC_SMM_ADDR_TYPE_NULL) // "returns" true when BitDesc is NULL\r | |
| 149 | #define NULL_THIS_BIT_DESC(BitDesc) ((BitDesc).Reg.Type = QNC_SMM_ADDR_TYPE_NULL) // will "return" an integer w/ value of 0\r | |
| 150 | #define NULL_BIT_DESC_INITIALIZER \\r | |
| 151 | { \\r | |
| 152 | { \\r | |
| 153 | QNC_SMM_ADDR_TYPE_NULL, \\r | |
| 154 | { \\r | |
| 155 | 0 \\r | |
| 156 | } \\r | |
| 157 | }, \\r | |
| 158 | 0, 0 \\r | |
| 159 | }\r | |
| 160 | //\r | |
| 161 | // I'd like a type to specify the callback's Sts & En bits because they'll\r | |
| 162 | // be commonly used together:\r | |
| 163 | //\r | |
| 164 | #define NUM_EN_BITS 2\r | |
| 165 | #define NUM_STS_BITS 1\r | |
| 166 | \r | |
| 167 | //\r | |
| 168 | // Flags\r | |
| 169 | //\r | |
| 170 | typedef UINT8 QNC_SMM_SOURCE_FLAGS;\r | |
| 171 | \r | |
| 172 | //\r | |
| 173 | // Flags required today\r | |
| 174 | //\r | |
| 175 | #define QNC_SMM_NO_FLAGS 0\r | |
| 176 | #define QNC_SMM_SCI_EN_DEPENDENT (BIT0)\r | |
| 177 | #define QNC_SMM_CLEAR_WITH_ZERO (BIT6)\r | |
| 178 | \r | |
| 179 | //\r | |
| 180 | // Flags that might be required tomorrow\r | |
| 181 | // #define QNC_SMM_CLEAR_WITH_ONE 2 // may need to support bits that clear by writing 0\r | |
| 182 | // #define QNC_SMM_MULTIBIT_FIELD 3 // may need to support status/enable fields 2 bits wide\r | |
| 183 | //\r | |
| 184 | typedef struct {\r | |
| 185 | QNC_SMM_SOURCE_FLAGS Flags;\r | |
| 186 | QNC_SMM_BIT_DESC En[NUM_EN_BITS];\r | |
| 187 | QNC_SMM_BIT_DESC Sts[NUM_STS_BITS];\r | |
| 188 | } QNC_SMM_SOURCE_DESC;\r | |
| 189 | //\r | |
| 190 | // 31 bytes, I think\r | |
| 191 | //\r | |
| 192 | #define NULL_SOURCE_DESC_INITIALIZER \\r | |
| 193 | { \\r | |
| 194 | QNC_SMM_NO_FLAGS, \\r | |
| 195 | { \\r | |
| 196 | NULL_BIT_DESC_INITIALIZER, NULL_BIT_DESC_INITIALIZER \\r | |
| 197 | }, \\r | |
| 198 | { \\r | |
| 199 | NULL_BIT_DESC_INITIALIZER \\r | |
| 200 | } \\r | |
| 201 | }\r | |
| 202 | \r | |
| 203 | //\r | |
| 204 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 205 | // CHILD CONTEXTS\r | |
| 206 | // To keep consistent w/ the architecture, we'll need to provide the context\r | |
| 207 | // to the child when we call its callback function. After talking with Will,\r | |
| 208 | // we agreed that we'll need functions to "dig" the context out of the hardware\r | |
| 209 | // in many cases (Sx, Trap, Gpi, etc), and we'll need a function to compare those\r | |
| 210 | // contexts to prevent unnecessary dispatches. I'd like a general type for these\r | |
| 211 | // "GetContext" functions, so I'll need a union of all the protocol contexts for\r | |
| 212 | // our internal use:\r | |
| 213 | //\r | |
| 214 | typedef union {\r | |
| 215 | //\r | |
| 216 | // (in no particular order)\r | |
| 217 | //\r | |
| 218 | EFI_SMM_ICHN_REGISTER_CONTEXT QNCn;\r | |
| 219 | EFI_SMM_SX_REGISTER_CONTEXT Sx;\r | |
| 220 | EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT PeriodicTimer;\r | |
| 221 | EFI_SMM_SW_REGISTER_CONTEXT Sw;\r | |
| 222 | EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT PowerButton;\r | |
| 223 | // EFI_SMM_USB_REGISTER_CONTEXT Usb; DELETE:on QuarkNcSocId, there is no usb smi supported\r | |
| 224 | EFI_SMM_GPI_REGISTER_CONTEXT Gpi;\r | |
| 225 | } QNC_SMM_CONTEXT;\r | |
| 226 | \r | |
| 227 | typedef union {\r | |
| 228 | //\r | |
| 229 | // (in no particular order)\r | |
| 230 | //\r | |
| 231 | EFI_SMM_SW_CONTEXT Sw;\r | |
| 232 | EFI_SMM_PERIODIC_TIMER_CONTEXT PeriodicTimer;\r | |
| 233 | } QNC_SMM_BUFFER;\r | |
| 234 | \r | |
| 235 | //\r | |
| 236 | // Assumption: PeriodicTimer largest at 3x64-bits or 24 bytes\r | |
| 237 | //\r | |
| 238 | typedef struct _DATABASE_RECORD DATABASE_RECORD;\r | |
| 239 | \r | |
| 240 | typedef\r | |
| 241 | VOID\r | |
| 242 | (EFIAPI *GET_CONTEXT) (\r | |
| 243 | IN DATABASE_RECORD * Record,\r | |
| 244 | OUT QNC_SMM_CONTEXT * Context\r | |
| 245 | );\r | |
| 246 | //\r | |
| 247 | // Assumption: the GET_CONTEXT function will be as small and simple as possible.\r | |
| 248 | // Assumption: We don't need to pass in an enumeration for the protocol because each\r | |
| 249 | // GET_CONTEXT function is written for only one protocol.\r | |
| 250 | // We also need a function to compare contexts to see if the child should be dispatched\r | |
| 251 | //\r | |
| 252 | typedef\r | |
| 253 | BOOLEAN\r | |
| 254 | (EFIAPI *CMP_CONTEXT) (\r | |
| 255 | IN QNC_SMM_CONTEXT * Context1,\r | |
| 256 | IN QNC_SMM_CONTEXT * Context2\r | |
| 257 | );\r | |
| 258 | \r | |
| 259 | /*\r | |
| 260 | Returns: True when contexts are equivalent; False otherwise\r | |
| 261 | */\r | |
| 262 | \r | |
| 263 | //\r | |
| 264 | // This function is used to get the content of CommBuffer that will be passed\r | |
| 265 | // to Callback function\r | |
| 266 | //\r | |
| 267 | typedef\r | |
| 268 | VOID\r | |
| 269 | (EFIAPI *GET_BUFFER) (\r | |
| 270 | IN DATABASE_RECORD * Record\r | |
| 271 | );\r | |
| 272 | \r | |
| 273 | //\r | |
| 274 | // Finally, every protocol will require a "Get Context", "Compare Context"\r | |
| 275 | // and "Get CommBuffer" call, so we may as well wrap that up in a table, too.\r | |
| 276 | //\r | |
| 277 | typedef struct {\r | |
| 278 | GET_CONTEXT GetContext;\r | |
| 279 | CMP_CONTEXT CmpContext;\r | |
| 280 | GET_BUFFER GetBuffer;\r | |
| 281 | } CONTEXT_FUNCTIONS;\r | |
| 282 | \r | |
| 283 | extern CONTEXT_FUNCTIONS ContextFunctions[NUM_PROTOCOLS];\r | |
| 284 | \r | |
| 285 | //\r | |
| 286 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 287 | // MAPPING CONTEXT TO BIT DESCRIPTIONS\r | |
| 288 | // I'd like to have a general approach to mapping contexts to bit descriptions.\r | |
| 289 | // Sometimes, we'll find that we can use table lookups or CONSTant assignments;\r | |
| 290 | // other times, we'll find that we'll need to use a function to perform the mapping.\r | |
| 291 | // If we define a macro to mask that process, we'll never have to change the code.\r | |
| 292 | // I don't know if this is desirable or not -- if it isn't, then we can get rid\r | |
| 293 | // of the macros and just use function calls or variable assignments. Doesn't matter\r | |
| 294 | // to me.\r | |
| 295 | // Mapping complex contexts requires a function\r | |
| 296 | //\r | |
| 297 | // DELETE:on QuarkNcSocId, there is no usb smi supported\r | |
| 298 | //EFI_STATUS\r | |
| 299 | //EFIAPI\r | |
| 300 | //MapUsbToSrcDesc (\r | |
| 301 | // IN QNC_SMM_CONTEXT *RegisterContext,\r | |
| 302 | // OUT QNC_SMM_SOURCE_DESC *SrcDesc\r | |
| 303 | // )\r | |
| 304 | /*++\r | |
| 305 | \r | |
| 306 | Routine Description:\r | |
| 307 | \r | |
| 308 | GC_TODO: Add function description\r | |
| 309 | \r | |
| 310 | Arguments:\r | |
| 311 | \r | |
| 312 | RegisterContext - GC_TODO: add argument description\r | |
| 313 | SrcDesc - GC_TODO: add argument description\r | |
| 314 | \r | |
| 315 | Returns:\r | |
| 316 | \r | |
| 317 | GC_TODO: add return values\r | |
| 318 | \r | |
| 319 | --*/\r | |
| 320 | ;\r | |
| 321 | \r | |
| 322 | EFI_STATUS\r | |
| 323 | MapPeriodicTimerToSrcDesc (\r | |
| 324 | IN QNC_SMM_CONTEXT *RegisterContext,\r | |
| 325 | OUT QNC_SMM_SOURCE_DESC *SrcDesc\r | |
| 326 | )\r | |
| 327 | /*++\r | |
| 328 | \r | |
| 329 | Routine Description:\r | |
| 330 | \r | |
| 331 | GC_TODO: Add function description\r | |
| 332 | \r | |
| 333 | Arguments:\r | |
| 334 | \r | |
| 335 | RegisterContext - GC_TODO: add argument description\r | |
| 336 | SrcDesc - GC_TODO: add argument description\r | |
| 337 | \r | |
| 338 | Returns:\r | |
| 339 | \r | |
| 340 | GC_TODO: add return values\r | |
| 341 | \r | |
| 342 | --*/\r | |
| 343 | ;\r | |
| 344 | \r | |
| 345 | //\r | |
| 346 | // Mapping simple contexts can be done by assignment or lookup table\r | |
| 347 | //\r | |
| 348 | extern CONST QNC_SMM_SOURCE_DESC SW_SOURCE_DESC;\r | |
| 349 | extern CONST QNC_SMM_SOURCE_DESC SX_SOURCE_DESC;\r | |
| 350 | \r | |
| 351 | //\r | |
| 352 | // With the changes we've made to the protocols, we can now use table\r | |
| 353 | // lookups for the following protocols:\r | |
| 354 | //\r | |
| 355 | extern CONST QNC_SMM_SOURCE_DESC GPI_SOURCE_DESC;\r | |
| 356 | \r | |
| 357 | extern QNC_SMM_SOURCE_DESC QNCN_SOURCE_DESCS[NUM_ICHN_TYPES];\r | |
| 358 | \r | |
| 359 | \r | |
| 360 | //\r | |
| 361 | // For QNCx, APMC is UINT8 port, so the MAX SWI Value is 0xFF.\r | |
| 362 | //\r | |
| 363 | #define MAXIMUM_SWI_VALUE 0xFF\r | |
| 364 | \r | |
| 365 | \r | |
| 366 | //\r | |
| 367 | // Open: Need to make sure this kind of type cast will actually work.\r | |
| 368 | // May need an intermediate form w/ two VOID* arguments. I'll figure\r | |
| 369 | // that out when I start compiling.\r | |
| 370 | \r | |
| 371 | ///////////////////////////////////////////////////////////////////////////////\r | |
| 372 | //\r | |
| 373 | typedef\r | |
| 374 | VOID\r | |
| 375 | (EFIAPI *QNC_SMM_CLEAR_SOURCE) (\r | |
| 376 | QNC_SMM_SOURCE_DESC * SrcDesc\r | |
| 377 | );\r | |
| 378 | \r | |
| 379 | //\r | |
| 380 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 381 | // "DATABASE" RECORD\r | |
| 382 | // Linked list data structures\r | |
| 383 | //\r | |
| 384 | #define DATABASE_RECORD_SIGNATURE SIGNATURE_32 ('D', 'B', 'R', 'C')\r | |
| 385 | \r | |
| 386 | struct _DATABASE_RECORD {\r | |
| 387 | UINT32 Signature;\r | |
| 388 | LIST_ENTRY Link;\r | |
| 389 | \r | |
| 390 | //\r | |
| 391 | // Status and Enable bit description\r | |
| 392 | //\r | |
| 393 | QNC_SMM_SOURCE_DESC SrcDesc;\r | |
| 394 | \r | |
| 395 | //\r | |
| 396 | // Callback function\r | |
| 397 | //\r | |
| 398 | EFI_SMM_HANDLER_ENTRY_POINT2 Callback;\r | |
| 399 | QNC_SMM_CONTEXT ChildContext;\r | |
| 400 | QNC_SMM_BUFFER CommBuffer;\r | |
| 401 | UINTN BufferSize;\r | |
| 402 | \r | |
| 403 | //\r | |
| 404 | // Special handling hooks -- init them to NULL if unused/unneeded\r | |
| 405 | //\r | |
| 406 | QNC_SMM_CLEAR_SOURCE ClearSource; // needed for SWSMI timer\r | |
| 407 | // Functions required to make callback code general\r | |
| 408 | //\r | |
| 409 | CONTEXT_FUNCTIONS ContextFunctions;\r | |
| 410 | \r | |
| 411 | //\r | |
| 412 | // The protocol that this record dispatches\r | |
| 413 | //\r | |
| 414 | QNC_SMM_PROTOCOL_TYPE ProtocolType;\r | |
| 415 | \r | |
| 416 | };\r | |
| 417 | \r | |
| 418 | #define DATABASE_RECORD_FROM_LINK(_record) CR (_record, DATABASE_RECORD, Link, DATABASE_RECORD_SIGNATURE)\r | |
| 419 | #define DATABASE_RECORD_FROM_CONTEXT(_record) CR (_record, DATABASE_RECORD, ChildContext, DATABASE_RECORD_SIGNATURE)\r | |
| 420 | \r | |
| 421 | //\r | |
| 422 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 423 | // HOOKING INTO THE ARCHITECTURE\r | |
| 424 | //\r | |
| 425 | typedef\r | |
| 426 | EFI_STATUS\r | |
| 427 | (EFIAPI *QNC_SMM_GENERIC_REGISTER) (\r | |
| 428 | IN VOID **This,\r | |
| 429 | IN VOID *DispatchFunction,\r | |
| 430 | IN VOID *RegisterContext,\r | |
| 431 | OUT EFI_HANDLE * DispatchHandle\r | |
| 432 | );\r | |
| 433 | typedef\r | |
| 434 | EFI_STATUS\r | |
| 435 | (EFIAPI *QNC_SMM_GENERIC_UNREGISTER) (\r | |
| 436 | IN VOID **This,\r | |
| 437 | IN EFI_HANDLE DispatchHandle\r | |
| 438 | );\r | |
| 439 | \r | |
| 440 | //\r | |
| 441 | // Define a memory "stamp" equivalent in size and function to most of the protocols\r | |
| 442 | //\r | |
| 443 | typedef struct {\r | |
| 444 | QNC_SMM_GENERIC_REGISTER Register;\r | |
| 445 | QNC_SMM_GENERIC_UNREGISTER Unregister;\r | |
| 446 | UINTN Extra1;\r | |
| 447 | UINTN Extra2; // may not need this one\r | |
| 448 | } QNC_SMM_GENERIC_PROTOCOL;\r | |
| 449 | \r | |
| 450 | EFI_STATUS\r | |
| 451 | QNCSmmCoreRegister (\r | |
| 452 | IN QNC_SMM_GENERIC_PROTOCOL *This,\r | |
| 453 | IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction,\r | |
| 454 | IN QNC_SMM_CONTEXT *RegisterContext,\r | |
| 455 | OUT EFI_HANDLE *DispatchHandle\r | |
| 456 | )\r | |
| 457 | /*++\r | |
| 458 | \r | |
| 459 | Routine Description:\r | |
| 460 | \r | |
| 461 | GC_TODO: Add function description\r | |
| 462 | \r | |
| 463 | Arguments:\r | |
| 464 | \r | |
| 465 | This - GC_TODO: add argument description\r | |
| 466 | DispatchFunction - GC_TODO: add argument description\r | |
| 467 | RegisterContext - GC_TODO: add argument description\r | |
| 468 | DispatchHandle - GC_TODO: add argument description\r | |
| 469 | \r | |
| 470 | Returns:\r | |
| 471 | \r | |
| 472 | GC_TODO: add return values\r | |
| 473 | \r | |
| 474 | --*/\r | |
| 475 | ;\r | |
| 476 | EFI_STATUS\r | |
| 477 | QNCSmmCoreUnRegister (\r | |
| 478 | IN QNC_SMM_GENERIC_PROTOCOL *This,\r | |
| 479 | IN EFI_HANDLE DispatchHandle\r | |
| 480 | )\r | |
| 481 | /*++\r | |
| 482 | \r | |
| 483 | Routine Description:\r | |
| 484 | \r | |
| 485 | GC_TODO: Add function description\r | |
| 486 | \r | |
| 487 | Arguments:\r | |
| 488 | \r | |
| 489 | This - GC_TODO: add argument description\r | |
| 490 | DispatchHandle - GC_TODO: add argument description\r | |
| 491 | \r | |
| 492 | Returns:\r | |
| 493 | \r | |
| 494 | GC_TODO: add return values\r | |
| 495 | \r | |
| 496 | --*/\r | |
| 497 | ;\r | |
| 498 | \r | |
| 499 | typedef union {\r | |
| 500 | QNC_SMM_GENERIC_PROTOCOL Generic;\r | |
| 501 | \r | |
| 502 | // EFI_SMM_USB_DISPATCH2_PROTOCOL Usb; DELETE:on QuarkNcSocId, there is no usb smi supported\r | |
| 503 | EFI_SMM_SX_DISPATCH2_PROTOCOL Sx;\r | |
| 504 | EFI_SMM_SW_DISPATCH2_PROTOCOL Sw;\r | |
| 505 | EFI_SMM_GPI_DISPATCH2_PROTOCOL Gpi;\r | |
| 506 | EFI_SMM_ICHN_DISPATCH2_PROTOCOL QNCn;\r | |
| 507 | EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL PowerButton;\r | |
| 508 | EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL PeriodicTimer;\r | |
| 509 | } QNC_SMM_PROTOCOL;\r | |
| 510 | \r | |
| 511 | //\r | |
| 512 | // Define a structure to help us identify the generic protocol\r | |
| 513 | //\r | |
| 514 | #define PROTOCOL_SIGNATURE SIGNATURE_32 ('P', 'R', 'O', 'T')\r | |
| 515 | \r | |
| 516 | typedef struct {\r | |
| 517 | UINTN Signature;\r | |
| 518 | \r | |
| 519 | QNC_SMM_PROTOCOL_TYPE Type;\r | |
| 520 | EFI_GUID *Guid;\r | |
| 521 | QNC_SMM_PROTOCOL Protocols;\r | |
| 522 | } QNC_SMM_QUALIFIED_PROTOCOL;\r | |
| 523 | \r | |
| 524 | #define QUALIFIED_PROTOCOL_FROM_GENERIC(_generic) \\r | |
| 525 | CR (_generic, \\r | |
| 526 | QNC_SMM_QUALIFIED_PROTOCOL, \\r | |
| 527 | Protocols, \\r | |
| 528 | PROTOCOL_SIGNATURE \\r | |
| 529 | )\r | |
| 530 | \r | |
| 531 | //\r | |
| 532 | // Create private data for the protocols that we'll publish\r | |
| 533 | //\r | |
| 534 | typedef struct {\r | |
| 535 | LIST_ENTRY CallbackDataBase;\r | |
| 536 | EFI_HANDLE SmiHandle;\r | |
| 537 | EFI_HANDLE InstallMultProtHandle;\r | |
| 538 | QNC_SMM_QUALIFIED_PROTOCOL Protocols[NUM_PROTOCOLS];\r | |
| 539 | } PRIVATE_DATA;\r | |
| 540 | \r | |
| 541 | extern PRIVATE_DATA mPrivateData;\r | |
| 542 | \r | |
| 543 | //\r | |
| 544 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 545 | //\r | |
| 546 | VOID\r | |
| 547 | EFIAPI\r | |
| 548 | SwGetContext (\r | |
| 549 | IN DATABASE_RECORD *Record,\r | |
| 550 | OUT QNC_SMM_CONTEXT *Context\r | |
| 551 | )\r | |
| 552 | /*++\r | |
| 553 | \r | |
| 554 | Routine Description:\r | |
| 555 | \r | |
| 556 | GC_TODO: Add function description\r | |
| 557 | \r | |
| 558 | Arguments:\r | |
| 559 | \r | |
| 560 | Record - GC_TODO: add argument description\r | |
| 561 | Context - GC_TODO: add argument description\r | |
| 562 | \r | |
| 563 | Returns:\r | |
| 564 | \r | |
| 565 | GC_TODO: add return values\r | |
| 566 | \r | |
| 567 | --*/\r | |
| 568 | ;\r | |
| 569 | \r | |
| 570 | BOOLEAN\r | |
| 571 | EFIAPI\r | |
| 572 | SwCmpContext (\r | |
| 573 | IN QNC_SMM_CONTEXT *Context1,\r | |
| 574 | IN QNC_SMM_CONTEXT *Context2\r | |
| 575 | )\r | |
| 576 | /*++\r | |
| 577 | \r | |
| 578 | Routine Description:\r | |
| 579 | \r | |
| 580 | GC_TODO: Add function description\r | |
| 581 | \r | |
| 582 | Arguments:\r | |
| 583 | \r | |
| 584 | Context1 - GC_TODO: add argument description\r | |
| 585 | Context2 - GC_TODO: add argument description\r | |
| 586 | \r | |
| 587 | Returns:\r | |
| 588 | \r | |
| 589 | GC_TODO: add return values\r | |
| 590 | \r | |
| 591 | --*/\r | |
| 592 | ;\r | |
| 593 | \r | |
| 594 | VOID\r | |
| 595 | SwGetBuffer (\r | |
| 596 | IN DATABASE_RECORD * Record\r | |
| 597 | )\r | |
| 598 | /*++\r | |
| 599 | \r | |
| 600 | Routine Description:\r | |
| 601 | \r | |
| 602 | GC_TODO: Add function description\r | |
| 603 | \r | |
| 604 | Arguments:\r | |
| 605 | \r | |
| 606 | Record - GC_TODO: add argument description\r | |
| 607 | \r | |
| 608 | Returns:\r | |
| 609 | \r | |
| 610 | GC_TODO: add return values\r | |
| 611 | \r | |
| 612 | --*/\r | |
| 613 | ;\r | |
| 614 | \r | |
| 615 | VOID\r | |
| 616 | EFIAPI\r | |
| 617 | SxGetContext (\r | |
| 618 | IN DATABASE_RECORD *Record,\r | |
| 619 | OUT QNC_SMM_CONTEXT *Context\r | |
| 620 | )\r | |
| 621 | /*++\r | |
| 622 | \r | |
| 623 | Routine Description:\r | |
| 624 | \r | |
| 625 | GC_TODO: Add function description\r | |
| 626 | \r | |
| 627 | Arguments:\r | |
| 628 | \r | |
| 629 | Record - GC_TODO: add argument description\r | |
| 630 | Context - GC_TODO: add argument description\r | |
| 631 | \r | |
| 632 | Returns:\r | |
| 633 | \r | |
| 634 | GC_TODO: add return values\r | |
| 635 | \r | |
| 636 | --*/\r | |
| 637 | ;\r | |
| 638 | \r | |
| 639 | BOOLEAN\r | |
| 640 | EFIAPI\r | |
| 641 | SxCmpContext (\r | |
| 642 | IN QNC_SMM_CONTEXT *Context1,\r | |
| 643 | IN QNC_SMM_CONTEXT *Context2\r | |
| 644 | )\r | |
| 645 | /*++\r | |
| 646 | \r | |
| 647 | Routine Description:\r | |
| 648 | \r | |
| 649 | GC_TODO: Add function description\r | |
| 650 | \r | |
| 651 | Arguments:\r | |
| 652 | \r | |
| 653 | Context1 - GC_TODO: add argument description\r | |
| 654 | Context2 - GC_TODO: add argument description\r | |
| 655 | \r | |
| 656 | Returns:\r | |
| 657 | \r | |
| 658 | GC_TODO: add return values\r | |
| 659 | \r | |
| 660 | --*/\r | |
| 661 | ;\r | |
| 662 | \r | |
| 663 | VOID\r | |
| 664 | EFIAPI\r | |
| 665 | PeriodicTimerGetContext (\r | |
| 666 | IN DATABASE_RECORD *Record,\r | |
| 667 | OUT QNC_SMM_CONTEXT *Context\r | |
| 668 | )\r | |
| 669 | /*++\r | |
| 670 | \r | |
| 671 | Routine Description:\r | |
| 672 | \r | |
| 673 | GC_TODO: Add function description\r | |
| 674 | \r | |
| 675 | Arguments:\r | |
| 676 | \r | |
| 677 | Record - GC_TODO: add argument description\r | |
| 678 | Context - GC_TODO: add argument description\r | |
| 679 | \r | |
| 680 | Returns:\r | |
| 681 | \r | |
| 682 | GC_TODO: add return values\r | |
| 683 | \r | |
| 684 | --*/\r | |
| 685 | ;\r | |
| 686 | \r | |
| 687 | BOOLEAN\r | |
| 688 | EFIAPI\r | |
| 689 | PeriodicTimerCmpContext (\r | |
| 690 | IN QNC_SMM_CONTEXT *Context1,\r | |
| 691 | IN QNC_SMM_CONTEXT *Context2\r | |
| 692 | )\r | |
| 693 | /*++\r | |
| 694 | \r | |
| 695 | Routine Description:\r | |
| 696 | \r | |
| 697 | GC_TODO: Add function description\r | |
| 698 | \r | |
| 699 | Arguments:\r | |
| 700 | \r | |
| 701 | Context1 - GC_TODO: add argument description\r | |
| 702 | Context2 - GC_TODO: add argument description\r | |
| 703 | \r | |
| 704 | Returns:\r | |
| 705 | \r | |
| 706 | GC_TODO: add return values\r | |
| 707 | \r | |
| 708 | --*/\r | |
| 709 | ;\r | |
| 710 | \r | |
| 711 | VOID\r | |
| 712 | PeriodicTimerGetBuffer (\r | |
| 713 | IN DATABASE_RECORD * Record\r | |
| 714 | )\r | |
| 715 | /*++\r | |
| 716 | \r | |
| 717 | Routine Description:\r | |
| 718 | \r | |
| 719 | GC_TODO: Add function description\r | |
| 720 | \r | |
| 721 | Arguments:\r | |
| 722 | \r | |
| 723 | Record - GC_TODO: add argument description\r | |
| 724 | \r | |
| 725 | Returns:\r | |
| 726 | \r | |
| 727 | GC_TODO: add return values\r | |
| 728 | \r | |
| 729 | --*/\r | |
| 730 | ;\r | |
| 731 | \r | |
| 732 | VOID\r | |
| 733 | EFIAPI\r | |
| 734 | PowerButtonGetContext (\r | |
| 735 | IN DATABASE_RECORD *Record,\r | |
| 736 | OUT QNC_SMM_CONTEXT *Context\r | |
| 737 | )\r | |
| 738 | /*++\r | |
| 739 | \r | |
| 740 | Routine Description:\r | |
| 741 | \r | |
| 742 | GC_TODO: Add function description\r | |
| 743 | \r | |
| 744 | Arguments:\r | |
| 745 | \r | |
| 746 | Record - GC_TODO: add argument description\r | |
| 747 | Context - GC_TODO: add argument description\r | |
| 748 | \r | |
| 749 | Returns:\r | |
| 750 | \r | |
| 751 | GC_TODO: add return values\r | |
| 752 | \r | |
| 753 | --*/\r | |
| 754 | ;\r | |
| 755 | \r | |
| 756 | BOOLEAN\r | |
| 757 | EFIAPI\r | |
| 758 | PowerButtonCmpContext (\r | |
| 759 | IN QNC_SMM_CONTEXT *Context1,\r | |
| 760 | IN QNC_SMM_CONTEXT *Context2\r | |
| 761 | )\r | |
| 762 | /*++\r | |
| 763 | \r | |
| 764 | Routine Description:\r | |
| 765 | \r | |
| 766 | GC_TODO: Add function description\r | |
| 767 | \r | |
| 768 | Arguments:\r | |
| 769 | \r | |
| 770 | Context1 - GC_TODO: add argument description\r | |
| 771 | Context2 - GC_TODO: add argument description\r | |
| 772 | \r | |
| 773 | Returns:\r | |
| 774 | \r | |
| 775 | GC_TODO: add return values\r | |
| 776 | \r | |
| 777 | --*/\r | |
| 778 | ;\r | |
| 779 | \r | |
| 780 | //\r | |
| 781 | // /////////////////////////////////////////////////////////////////////////////\r | |
| 782 | //\r | |
| 783 | VOID\r | |
| 784 | EFIAPI\r | |
| 785 | QNCSmmPeriodicTimerClearSource (\r | |
| 786 | QNC_SMM_SOURCE_DESC *SrcDesc\r | |
| 787 | )\r | |
| 788 | /*++\r | |
| 789 | \r | |
| 790 | Routine Description:\r | |
| 791 | \r | |
| 792 | GC_TODO: Add function description\r | |
| 793 | \r | |
| 794 | Arguments:\r | |
| 795 | \r | |
| 796 | SrcDesc - GC_TODO: add argument description\r | |
| 797 | \r | |
| 798 | Returns:\r | |
| 799 | \r | |
| 800 | GC_TODO: add return values\r | |
| 801 | \r | |
| 802 | --*/\r | |
| 803 | ;\r | |
| 804 | \r | |
| 805 | EFI_STATUS\r | |
| 806 | QNCSmmPeriodicTimerDispatchGetNextShorterInterval (\r | |
| 807 | IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This,\r | |
| 808 | IN OUT UINT64 **SmiTickInterval\r | |
| 809 | )\r | |
| 810 | /*++\r | |
| 811 | \r | |
| 812 | Routine Description:\r | |
| 813 | \r | |
| 814 | GC_TODO: Add function description\r | |
| 815 | \r | |
| 816 | Arguments:\r | |
| 817 | \r | |
| 818 | This - GC_TODO: add argument description\r | |
| 819 | SmiTickInterval - GC_TODO: add argument description\r | |
| 820 | \r | |
| 821 | Returns:\r | |
| 822 | \r | |
| 823 | GC_TODO: add return values\r | |
| 824 | \r | |
| 825 | --*/\r | |
| 826 | ;\r | |
| 827 | \r | |
| 828 | VOID\r | |
| 829 | QNCSmmSxGoToSleep (\r | |
| 830 | VOID\r | |
| 831 | )\r | |
| 832 | /*++\r | |
| 833 | \r | |
| 834 | Routine Description:\r | |
| 835 | \r | |
| 836 | GC_TODO: Add function description\r | |
| 837 | \r | |
| 838 | Arguments:\r | |
| 839 | \r | |
| 840 | None\r | |
| 841 | \r | |
| 842 | Returns:\r | |
| 843 | \r | |
| 844 | GC_TODO: add return values\r | |
| 845 | \r | |
| 846 | --*/\r | |
| 847 | ;\r | |
| 848 | \r | |
| 849 | VOID\r | |
| 850 | EFIAPI\r | |
| 851 | QNCSmmQNCnClearSource (\r | |
| 852 | QNC_SMM_SOURCE_DESC *SrcDesc\r | |
| 853 | )\r | |
| 854 | /*++\r | |
| 855 | \r | |
| 856 | Routine Description:\r | |
| 857 | \r | |
| 858 | GC_TODO: Add function description\r | |
| 859 | \r | |
| 860 | Arguments:\r | |
| 861 | \r | |
| 862 | SrcDesc - GC_TODO: add argument description\r | |
| 863 | \r | |
| 864 | Returns:\r | |
| 865 | \r | |
| 866 | GC_TODO: add return values\r | |
| 867 | \r | |
| 868 | --*/\r | |
| 869 | ;\r | |
| 870 | \r | |
| 871 | #endif\r |