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
|
/** @file
TODO: Brief Description of UEFI Driver LegacySpeaker
TODO: Detailed Description of UEFI Driver LegacySpeaker
TODO: Copyright for UEFI Driver LegacySpeaker
TODO: License for UEFI Driver LegacySpeaker
**/
#include "LegacySpeaker.h"
#include <Library/IoLib.h>
//////////////////////////////////////////////////////////////////////////
// Speaker
//////////////////////////////////////////////////////////////////////////
/**
This function will enable the speaker to generate beep
@retval EFI_STATUS
**/
EFI_STATUS
TurnOnSpeaker (
)
{
UINT8 Data;
Data = IoRead8 (EFI_SPEAKER_CONTROL_PORT);
Data |= 0x03;
IoWrite8(EFI_SPEAKER_CONTROL_PORT, Data);
return EFI_SUCCESS;
}
/**
This function will stop beep from speaker.
@retval Status
**/
EFI_STATUS
TurnOffSpeaker (
)
{
UINT8 Data;
Data = IoRead8 (EFI_SPEAKER_CONTROL_PORT);
Data &= 0xFC;
IoWrite8(EFI_SPEAKER_CONTROL_PORT, Data);
return EFI_SUCCESS;
}
/**
Generate beep sound based upon number of beeps and duration of the beep
@param NumberOfBeeps Number of beeps which user want to produce
@param BeepDuration Duration for speaker gate need to be enabled
@param TimeInterval Interval between each beep
@retval Does not return if the reset takes place.
EFI_INVALID_PARAMETER If ResetType is invalid.
**/
EFI_STATUS
OutputBeep (
IN UINTN NumberOfBeep,
IN UINTN BeepDuration,
IN UINTN TimeInterval
)
{
UINTN Num;
for (Num=0; Num < NumberOfBeep; Num++) {
TurnOnSpeaker ();
//
// wait some time,at least 120us
//
gBS->Stall (BeepDuration);
TurnOffSpeaker();
gBS->Stall (TimeInterval);
}
return EFI_SUCCESS;
}
/**
This function will program the speaker tone frequency. The value should be with 64k
boundary since it takes only 16 bit value which gets programmed in two step IO opearattion
@param Frequency A value which should be 16 bit only.
@retval EFI_SUCESS
**/
EFI_STATUS
EFIAPI
ProgramToneFrequency (
IN EFI_SPEAKER_IF_PROTOCOL * This,
IN UINT16 Frequency
)
{
UINT8 Data;
Data = 0xB6;
IoWrite8(EFI_TIMER_CONTROL_PORT, Data);
Data = (UINT8)(Frequency & 0x00FF);
IoWrite8(EFI_TIMER_2_PORT, Data);
Data = (UINT8)((Frequency & 0xFF00) >> 8);
IoWrite8(EFI_TIMER_2_PORT, Data);
return EFI_SUCCESS;
}
/**
This function will generate the beep for specified duration.
@param NumberOfBeeps Number of beeps which user want to produce
@param BeepDuration Duration for speaker gate need to be enabled
@param TimeInterval Interval between each beep
@retval EFI_STATUS
**/
EFI_STATUS
EFIAPI
GenerateBeepTone (
IN EFI_SPEAKER_IF_PROTOCOL * This,
IN UINTN NumberOfBeeps,
IN UINTN BeepDuration,
IN UINTN TimeInterval
)
{
if ((NumberOfBeeps == 1) && (BeepDuration == 0) && (TimeInterval == 0)) {
TurnOnSpeaker ();
return EFI_SUCCESS;
}
if ((NumberOfBeeps == 0) && (BeepDuration == 0) && (TimeInterval == 0)) {
TurnOffSpeaker ();
return EFI_SUCCESS;
}
if (BeepDuration == 0) {
BeepDuration = EFI_DEFAULT_SHORT_BEEP_DURATION;
}
if (TimeInterval == 0) {
TimeInterval = EFI_DEFAULT_BEEP_TIME_INTERVAL;
}
OutputBeep (NumberOfBeeps, BeepDuration, TimeInterval);
return EFI_SUCCESS;
}
GUID gEfiSpeakerInterfaceProtocolGuid = EFI_SPEAKER_INTERFACE_PROTOCOL_GUID;
EFI_SPEAKER_IF_PROTOCOL gEfiSpeakerInterfaceProtocol = {
ProgramToneFrequency,
GenerateBeepTone
};
//////////////////////////////////////////////////////////////////////////
// Driver
//////////////////////////////////////////////////////////////////////////
/**
Unloads an image.
@param ImageHandle Handle that identifies the image to be unloaded.
@retval EFI_SUCCESS The image has been unloaded.
@retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
**/
EFI_STATUS
EFIAPI
LegacySpeakerUnload (
IN EFI_HANDLE ImageHandle
)
{
EFI_STATUS Status;
Status = EFI_SUCCESS;
//
// Uninstall Driver Supported EFI Version Protocol onto ImageHandle
//
Status = gBS->UninstallMultipleProtocolInterfaces(
ImageHandle,
&gEfiSpeakerInterfaceProtocolGuid, &gEfiSpeakerInterfaceProtocol,
NULL
);
if (EFI_ERROR(Status)) {
return Status;
}
// Clean up
return EFI_SUCCESS;
}
/**
This is the declaration of an EFI image entry point. This entry point is
the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
both device drivers and bus drivers.
@param ImageHandle The firmware allocated handle for the UEFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The operation completed successfully.
@retval Others An unexpected error occurred.
**/
EFI_STATUS
EFIAPI
LegacySpeakerDriverEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
Status = EFI_SUCCESS;
//
// Install Speaker protocol onto ImageHandle
//
Status = gBS->InstallMultipleProtocolInterfaces(
&ImageHandle,
&gEfiSpeakerInterfaceProtocolGuid, &gEfiSpeakerInterfaceProtocol,
NULL
);
ASSERT_EFI_ERROR(Status);
// gEfiSpeakerInterfaceProtocol.SetSpeakerToneFrequency(&gEfiSpeakerInterfaceProtocol, 0x500);
// gEfiSpeakerInterfaceProtocol.GenerateBeep(&gEfiSpeakerInterfaceProtocol, 2, 200000, 200000);
return Status;
}
|
