summaryrefslogtreecommitdiff
path: root/ReferenceCode/Haswell/SampleCode/Include/AslUpdateLib.h
blob: eb9d1cf7286d9770fd9f0f31cb7b0f29137397fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/** @file
  ASL dynamic update library definitions.

  This library provides dymanic update to various ASL structures.

  There may be different libraries for different environments (PEI, BS, RT, SMM).
  Make sure you meet the requirements for the library (protocol dependencies, use
  restrictions, etc).

@copyright
  Copyright (c) 1999 - 2012 Intel Corporation. All rights reserved
  This software and associated documentation (if any) is furnished
  under a license and may only be used or copied in accordance
  with the terms of the license. Except as permitted by such
  license, no part of this software or documentation may be
  reproduced, stored in a retrieval system, or transmitted in any
  form or by any means without the express written consent of
  Intel Corporation.

  This file contains a 'Sample Driver' and is licensed as such
  under the terms of your license agreement with Intel or your
  vendor.  This file may be modified by the user, subject to
  the additional terms of the license agreement
**/
#ifndef _ASL_UPDATE_LIB_H_
#define _ASL_UPDATE_LIB_H_

///
/// Include files
///
#include "Tiano.h"
#include "Acpi.h"
#include "Acpi3_0.h"

#include EFI_PROTOCOL_DEPENDENCY (AcpiSupport)
#include EFI_PROTOCOL_DEPENDENCY (AcpiTable)

///
/// AML parsing definitions
///
#define AML_NAME_OP       0x08
#define AML_BYTE_OP       0x0A
#define AML_WORD_OP       0x0B
#define AML_DWORD_OP      0x0C
#define AML_QWORD_OP      0x0E
#define AML_SCOPE_OP      0x10
#define AML_BUFFER_OP     0x11
#define AML_PACKAGE_OP    0x12
#define AML_METHOD_OP     0x14
#define AML_EXT_OP        0x5B
#define AML_OPREGION_OP   0x80
#define AML_DEVICE_OP     0x82
#define AML_PROCESSOR_OP  0x83

///
/// Magic number definition for values to be updated
///
#define UINT16_BIT_MAGIC_NUMBER 0xFFFF
#define UINT32_BIT_MAGIC_NUMBER 0xFFFFFFFF

///
/// ASL PSS package structure layout
///
#pragma pack(1)
typedef struct {
  UINT8  NameOp;        ///< 12h ;First opcode is a NameOp.
  UINT8  PackageLead;   ///< 20h ;First opcode is a NameOp.
  UINT8  NumEntries;    ///< 06h ;First opcode is a NameOp.
  UINT8  DwordPrefix1;  ///< 0Ch
  UINT32 CoreFrequency; ///< 00h
  UINT8  DwordPrefix2;  ///< 0Ch
  UINT32 Power;         ///< 00h
  UINT8  DwordPrefix3;  ///< 0Ch
  UINT32 TransLatency;  ///< 00h
  UINT8  DwordPrefix4;  ///< 0Ch
  UINT32 BMLatency;     ///< 00h
  UINT8  DwordPrefix5;  ///< 0Ch
  UINT32 Control;       ///< 00h
  UINT8  DwordPrefix6;  ///< 0Ch
  UINT32 Status;        ///< 00h
} PSS_PACKAGE_LAYOUT;
#pragma pack()

/**
  Initialize the ASL update library state.
  This must be called prior to invoking other library functions.

  @retval EFI_SUCCESS                  - The function completed successfully.
**/
EFI_STATUS
InitializeAslUpdateLib (
  VOID
  );

/**
  This function locates an ACPI structure and updates it.
  This function knows how to update operation regions and BUFA/BUFB resource structures.

  This function may not be implemented in all instantiations of this library.

  @param[in] AslSignature      - The signature of Operation Region that we want to update.
  @param[in] BaseAddress       - Base address of IO trap.
  @param[in] Length            - Length of IO address.

  @retval EFI_SUCCESS       - The function completed successfully.
**/
EFI_STATUS
UpdateAslCode (
  IN UINT32 AslSignature,
  IN UINT16 BaseAddress,
  IN UINT8  Length
  );

/**
  This function uses the ACPI support protocol to locate an ACPI table using the .
  It is really only useful for finding tables that only have a single instance,
  e.g. FADT, FACS, MADT, etc.  It is not good for locating SSDT, etc.
  Matches are determined by finding the table with ACPI table that has
  a matching signature and version.

  @param[in] TableId           - Pointer to an ASCII string containing the Signature to match
  @param[in] Table             - Updated with a pointer to the table
  @param[in] Handle            - AcpiSupport protocol table handle for the table found
  @param[in] Version           - On input, the version of the table desired,
                      on output, the versions the table belongs to
                      (see AcpiSupport protocol for details)

  @retval EFI_SUCCESS       - The function completed successfully.
**/
EFI_STATUS
LocateAcpiTableBySignature (
  IN UINT32                          Signature,
  IN OUT EFI_ACPI_DESCRIPTION_HEADER **Table,
  IN OUT UINTN                       *Handle,
  IN OUT EFI_ACPI_TABLE_VERSION      *Version
  );

/**
  This function uses the ACPI support protocol to locate an ACPI SSDT table.
  The table is located by searching for a matching OEM Table ID field.
  Partial match searches are supported via the TableIdSize parameter.

  @param[in] TableId           - Pointer to an ASCII string containing the OEM Table ID from the ACPI table header
  @param[in] TableIdSize       - Length of the TableId to match.  Table ID are 8 bytes long, this function
                      will consider it a match if the first TableIdSize bytes match
  @param[in] Table             - Updated with a pointer to the table
  @param[in] Handle            - AcpiSupport protocol table handle for the table found
  @param[in] Version           - See AcpiSupport protocol, GetAcpiTable function for use

  @retval EFI_SUCCESS       - The function completed successfully.
**/
EFI_STATUS
LocateAcpiTableByOemTableId (
  IN UINT8                           *TableId,
  IN UINT8                           TableIdSize,
  IN OUT EFI_ACPI_DESCRIPTION_HEADER **Table,
  IN OUT UINTN                       *Handle,
  IN OUT EFI_ACPI_TABLE_VERSION      *Version
  );

/**
  This function calculates and updates an UINT8 checksum.

  @param[in] Buffer          Pointer to buffer to checksum
  @param[in] Size            Number of bytes to checksum
  @param[in] ChecksumOffset  Offset to place the checksum result in

  @retval EFI_SUCCESS             The function completed successfully.
**/
EFI_STATUS
EFI_BOOTSERVICE
AcpiChecksum (
  IN VOID  *Buffer,
  IN UINTN Size,
  IN UINTN ChecksumOffset
  );

#endif