summaryrefslogtreecommitdiff
path: root/Chipset/NB/SystemAgentWrap/LegacyRegion2/LegacyRegion2.c
blob: 3a5a8b40e3fffa7119ca0bb7cd05ac0be2c2b52c (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2012, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************

//*************************************************************************
// $Header: /Alaska/BIN/Chipset/Intel/NorthBridge/Haswell/Intel SystemAgent NB Chipset/SystemAgentWrap/LegacyRegion2/LegacyRegion2.c 1     4/05/12 3:08a Yurenlai $
//
// $Date: 4/05/12 3:08a $
//*************************************************************************
// Revision History
// ----------------
// $Log:
// 
//*************************************************************************
//<AMI_FHDR_START>
//
// Name: LegacyRegion2.c
//
// Description: Legacy Region 2 functions implementation
//
//<AMI_FHDR_END>
//*************************************************************************

#include <efi.h>
#include <AmiDxeLib.h>
#include <AmiCspLib.h>
#include <Protocol\LegacyRegion.h>
#include <Protocol\LegacyRegion2.h>

EFI_LEGACY_REGION_PROTOCOL *gLegacyRegionProtocol = NULL;

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   LegacyRegionDecode
//
// Description: Program chipset to allow decoding of 0xc0000 - 0xfffff.
//
// Input:
//  IN EFI_LEGACY_REGION_PROTOCOL   *This,
//  IN UINT32                       Start,
//  IN UINT32                       Length,
//  OUT UINT32                      *Granularity,
//  IN BOOLEAN                      *On
//
// Output:
//  Status of the operation
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS LegacyRegionDecode(
    IN EFI_LEGACY_REGION2_PROTOCOL   *This,
    IN UINT32                       Start,
    IN UINT32                       Length,
    OUT UINT32                      *Granularity,
    IN BOOLEAN                      *On
)
{
    return gLegacyRegionProtocol->Decode( gLegacyRegionProtocol, Start, Length, On);
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   LegacyRegionLock
//
// Description: To disallow writes to memory 0xc0000 - 0xfffff.
//
// Input:
//  IN  EFI_LEGACY_REGION_PROTOCOL  *This,
//  IN  UINT32                      Start,
//  IN  UINT32                      Length,
//  OUT UINT32                      *Granularity  OPTIONAL
//
// Output:
//  Status of the operation
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS LegacyRegionLock(
    IN  EFI_LEGACY_REGION2_PROTOCOL *This,
    IN  UINT32                      Start,
    IN  UINT32                      Length,
    OUT UINT32                      *Granularity  OPTIONAL
)
{
    return gLegacyRegionProtocol->Lock( gLegacyRegionProtocol, Start, Length, Granularity);
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   LegacyRegionBootLock
//
// Description: To permanently disallow writes to memory 0xc0000 - 0xffff.
//
// Input:
//  IN  EFI_LEGACY_REGION_PROTOCOL  *This,
//  IN  UINT32                      Start,
//  IN  UINT32                      Length,
//  OUT UINT32                      *Granularity  OPTIONAL
//
// Output:
//  Status of the operation
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS LegacyRegionBootLock(
    IN  EFI_LEGACY_REGION2_PROTOCOL *This,
    IN  UINT32                      Start,
    IN  UINT32                      Length,
    OUT UINT32                      *Granularity  OPTIONAL
)
{
    return gLegacyRegionProtocol->BootLock( gLegacyRegionProtocol, Start, Length, Granularity);
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   LegacyRegionUnlock
//
// Description: To allow read/write of memory 0xc0000-0xfffff.
//
// Input:
//  IN  EFI_LEGACY_REGION_PROTOCOL  *This,
//  IN  UINT32                      Start,
//  IN  UINT32                      Length,
//  OUT UINT32                      *Granularity  OPTIONAL
//
// Output:
//  Status of the operation
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS LegacyRegionUnlock(
    IN  EFI_LEGACY_REGION2_PROTOCOL *This,
    IN  UINT32                      Start,
    IN  UINT32                      Length,
    OUT UINT32                      *Granularity  OPTIONAL
)
{
    return gLegacyRegionProtocol->UnLock(gLegacyRegionProtocol, Start, Length, Granularity);
}

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   GetLegacyRegionInfo
//
// Description:
//  This function is used to discover the granularity of the attributes
//  for the memory in the legacy region. Each attribute may have a different
//  granularity and the granularity may not be the same for all memory ranges
//  in the legacy region.  
//
// Input:
//  IN  EFI_LEGACY_REGION_PROTOCOL    *This
//      --  Indicates the EFI_LEGACY_REGION_PROTOCOL instance.
//
// Output:
//  EFI_UNSUPPORTED - This function is not supported
//  EFI_SUCCESS - The following information structure is returned:
//      OUT UINT32                          *DescriptorCount
//      --  The number of region descriptor entries returned in the Descriptor
//          buffer. See EFI_LEGACY_REGION_DESCRIPTOR definition for reference.
//      OUT EFI_LEGACY_REGION_DESCRIPTOR    **Descriptor
//      --  A pointer to a pointer used to return a buffer where the legacy
//          region information is deposited. This buffer will contain a list
//          of DescriptorCount number of region descriptors. This function will
//          provide the memory for the buffer.
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS GetLegacyRegionInfo(
    IN  EFI_LEGACY_REGION2_PROTOCOL *This,
    OUT UINT32                      *DescriptorCount,
    OUT EFI_LEGACY_REGION_DESCRIPTOR    **Descriptor
)
{
    return EFI_UNSUPPORTED; // Note: to support this function there is a need
                            // to update NB template.
}

EFI_LEGACY_REGION2_PROTOCOL gLegacyRegion2Protocol =
{
    LegacyRegionDecode, LegacyRegionLock,
    LegacyRegionBootLock, LegacyRegionUnlock,
    GetLegacyRegionInfo
};

//*************************************************************************
//<AMI_PHDR_START>
//
// Procedure:   InitializeLegacyRegion2
//
// Description: Install the legacy region 2 protocol.
//
// Input:
//  IN EFI_HANDLE        ImageHandle,
//  IN EFI_SYSTEM_TABLE  *SystemTable
//
// Output:
//  Status of the operation
//
// Notes:
//  Here is the control flow of this function:
//  1. Get root bridge io protocol.
//  2. Install legacy region protocol.
//
//<AMI_PHDR_END>
//*************************************************************************
EFI_STATUS InitializeLegacyRegion2(
    IN EFI_HANDLE        ImageHandle,
    IN EFI_SYSTEM_TABLE  *SystemTable
  )
{
    EFI_STATUS  Status;

    InitAmiLib(ImageHandle, SystemTable);

    Status = pBS->LocateProtocol(
            &gEfiLegacyRegionProtocolGuid,
            NULL,
            &gLegacyRegionProtocol);

    if(!EFI_ERROR(Status)) {

       Status = pBS->InstallProtocolInterface (
                     &ImageHandle,
                     &gEfiLegacyRegion2ProtocolGuid,
                     EFI_NATIVE_INTERFACE,
                     &gLegacyRegion2Protocol
                     );
    }

    return Status;

}

//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (C)Copyright 1985-2012, American Megatrends, Inc.            **
//**                                                                     **
//**                       All Rights Reserved.                          **
//**                                                                     **
//**      5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093           **
//**                                                                     **
//**                       Phone: (770)-246-8600                         **
//**                                                                     **
//*************************************************************************
//*************************************************************************