summaryrefslogtreecommitdiff
path: root/Include/Protocol/IntelSaGopDriver.h
blob: a42e7517c79089068ea9c3a2c524f9358ec187a4 (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
//*************************************************************************
//*************************************************************************
//**                                                                     **
//**        (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/IntelGopDriver/IntelSaGopDriverProtocol/IntelSaGopDriver.h 3     4/23/13 8:00a Ireneyang $
//
// $Revision: 3 $
//
// $Date: 4/23/13 8:00a $
//*************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/BIN/Chipset/Intel/NorthBridge/Haswell/IntelGopDriver/IntelSaGopDriverProtocol/IntelSaGopDriver.h $
// 
// 3     4/23/13 8:00a Ireneyang
// [TAG]          None
// [Severity]     Improvement
// [Description]  Support for BIST (Built-In Self Test) Protocol.
// [Files]        IntelSaGopSetup.c; IntelSaGopSetup.h;
// IntelSaGopSetup.sd;
//                IntelSaGopSetup.sd; IntelSaGopSetup.sdl; 
//                IntelSaGopSetup.uni; IntelSaGopDriver.h;  
// 
// 2     8/14/12 5:49a Yurenlai
// [TAG]         None
// [Severity]    Important
// [Description] Implemented BIOS Integration Guide Rev 1.0 to Intel SA
// GOP driver.
// [Files]       IntelSaGopDriver.cif, IntelSaGopDriver.mak,
//               IntelSaGopDriver.sdl, IntelSaGopPolicy.c, 
//               IntelSaGopSetup.c, IntelSaGopSetup.h,
// IntelSaGopSetup.mak,
//               IntelSaGopSetup.sd, IntelSaGopSetup.sdl,
// IntelSaGopSetup.uni, 
//               IntelSaGopSwitch.c, IntelSaGopDriver.h, NBPlatformData.h
// 
// 1     3/08/12 10:57p Yurenlai
// [TAG]         None
// [Category]    Improvement
// [Description] Create Haswell Intel SA GOP Driver module part.
//               Notice : IntelGopDriver.efi and vbt.bin is dummy files.
// 
//*************************************************************************
//<AMI_FHDR_START>
//
// Name:	IntelSaGopDriver.h
//
// Description:	GOP Specific Setup Variables and Structures
//
//<AMI_FHDR_END>
//*************************************************************************

#ifndef _PLATFORM_GOP_POLICY_PROTOCOL_H_
#define _PLATFORM_GOP_POLICY_PROTOCOL_H_

#define EFI_PLATFORM_GOP_POLICY_PROTOCOL_GUID \
  { 0xec2e931b, 0x3281, 0x48a5, 0x81, 0x7, 0xdf, 0x8a, 0x8b, 0xed, 0x3c, 0x5d }

#define GOP_DISPLAY_BRIGHTNESS_PROTOCOL_GUID \
  { 0x6ff23f1d, 0x877c, 0x4b1b, 0x93, 0xfc, 0xf1, 0x42, 0xb2, 0xee, 0xa6, 0xa7 }

#define GOP_DISPLAY_BIST_PROTOCOL_GUID \
  { 0xf51dd33a, 0xe57f, 0x4020, 0xb4, 0x66, 0xf4, 0xc1, 0x71, 0xc6, 0xe4, 0xf7 }

#define PLATFORM_GOP_POLICY_PROTOCOL_REVISION_01 0x01
#define PLATFORM_GOP_POLICY_PROTOCOL_REVISION_02 0x0222

#define GOP_DISPLAY_BRIGHTNESS_PROTOCOL_REVISION_01 0x01

#define GOP_DISPLAY_BIST_PROTOCOL_REVISION_01 0x01

#pragma pack(1)

typedef
struct _GOP_DISPLAY_BRIGHTNESS_PROTOCOL GOP_DISPLAY_BRIGHTNESS_PROTOCOL;

typedef
struct _GOP_DISPLAY_BIST_PROTOCOL GOP_DISPLAY_BIST_PROTOCOL;

typedef enum {
   LidClosed,
   LidOpen,
   LidStatusMax
} LID_STATUS;

typedef enum {
   Docked,
   UnDocked,
   DockStatusMax
} DOCK_STATUS;

typedef
EFI_STATUS
(EFIAPI *GET_PLATFORM_LID_STATUS) (
   OUT LID_STATUS *CurrentLidStatus
);

typedef
EFI_STATUS
(EFIAPI *GET_VBT_DATA) (
   OUT EFI_PHYSICAL_ADDRESS *VbtAddress,
   OUT UINT32 *VbtSize
);

typedef
EFI_STATUS
(EFIAPI *GET_PLATFORM_DOCK_STATUS) (
   OUT DOCK_STATUS CurrentDockStatus
);

typedef
EFI_STATUS
(EFIAPI *GET_MAXIMUM_BRIGHTNESS_LEVEL) (
   IN GOP_DISPLAY_BRIGHTNESS_PROTOCOL *This,
   OUT UINT32 *MaxBrightnessLevel
);

typedef
EFI_STATUS
(EFIAPI *GET_CURRENT_BRIGHTNESS_LEVEL) (
   IN GOP_DISPLAY_BRIGHTNESS_PROTOCOL *This,
   OUT UINT32 *CurrentBrightnessLevel
);

typedef
EFI_STATUS
(EFIAPI *SET_BRIGHTNESS_LEVEL) (
   IN GOP_DISPLAY_BRIGHTNESS_PROTOCOL *This,
   IN UINT32 BrightnessLevel
);

typedef
EFI_STATUS
(EFIAPI *ENABLE_BIST) (
   IN GOP_DISPLAY_BIST_PROTOCOL *This
);

typedef
EFI_STATUS
(EFIAPI *DISABLE_BIST) (
   IN GOP_DISPLAY_BIST_PROTOCOL *This
);

#pragma pack()

typedef struct _PLATFORM_GOP_POLICY_PROTOCOL {
  UINT32                             Revision;
  GET_PLATFORM_LID_STATUS            GetPlatformLidStatus;
  GET_VBT_DATA                       GetVbtData;
  GET_PLATFORM_DOCK_STATUS           GetPlatformDockStatus;
} PLATFORM_GOP_POLICY_PROTOCOL;

typedef struct _GOP_DISPLAY_BRIGHTNESS_PROTOCOL {
  UINT32                             Revision;
  GET_MAXIMUM_BRIGHTNESS_LEVEL       GetMaxBrightnessLevel;
  GET_CURRENT_BRIGHTNESS_LEVEL       GetCurrentBrightnessLevel;
  SET_BRIGHTNESS_LEVEL               SetBrightnessLevel;
} GOP_DISPLAY_BRIGHTNESS_PROTOCOL;

typedef struct _GOP_DISPLAY_BIST_PROTOCOL{
  UINT32                             Revision;
  ENABLE_BIST                        EnableBist;
  DISABLE_BIST                       DisableBist;
} GOP_DISPLAY_BIST_PROTOCOL;

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