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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
|
/** @file
PCH Smbus Protocol
@copyright
Copyright (c) 2004 - 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 an 'Intel Peripheral Driver' and uniquely
identified as "Intel Reference Module" and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef _DXE_PCH_SMBUS_H
#define _DXE_PCH_SMBUS_H
//
// External include files do NOT need to be explicitly specified in real EDKII
// environment
//
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#include "EdkIIGlueDxe.h"
//
// Driver Produced Protocol Prototypes
//
#include EFI_PROTOCOL_PRODUCER (Smbus)
#include EFI_GUID_DEFINITION (SmbusArpMap)
//
// Driver Consumed Protcol Prototypes
//
#include EFI_PROTOCOL_CONSUMER (PchPlatformPolicy)
#include "PchSmbusCommon.h"
#endif
//
// Definitions
//
///
/// Max number of SMBus devices (7 bit address yields 128 combinations but 21 of those are reserved)
///
#define MAX_SMBUS_DEVICES 107
#define MICROSECOND 10
#define MILLISECOND (1000 * MICROSECOND)
#define ONESECOND (1000 * MILLISECOND)
///
/// Private Data Structures
///
typedef struct _SMBUS_NOTIFY_FUNCTION_LIST_NODE {
UINT32 Signature;
LIST_ENTRY Link;
EFI_SMBUS_DEVICE_ADDRESS SlaveAddress;
UINTN Data;
EFI_SMBUS_NOTIFY_FUNCTION NotifyFunction;
} SMBUS_NOTIFY_FUNCTION_LIST_NODE;
#define SMBUS_NOTIFY_FUNCTION_LIST_NODE_FROM_LINK(_node) \
CR ( \
_node, \
SMBUS_NOTIFY_FUNCTION_LIST_NODE, \
Link, \
PCH_SMBUS_PRIVATE_DATA_SIGNATURE \
)
///
/// Declare a local instance structure for this driver
///
typedef struct _SMBUS_INSTANCE {
UINTN Signature;
EFI_HANDLE Handle;
UINT32 SmbusIoBase;
SMBUS_IO_READ SmbusIoRead;
SMBUS_IO_WRITE SmbusIoWrite;
SMBUS_IO_DONE IoDone;
///
/// Published interface
///
EFI_SMBUS_HC_PROTOCOL SmbusController;
UINT8 DeviceMapEntries;
EFI_SMBUS_DEVICE_MAP DeviceMap[MAX_SMBUS_DEVICES];
UINT8 PlatformNumRsvd;
UINT8 *PlatformRsvdAddr;
LIST_ENTRY NotifyFunctionList;
EFI_EVENT NotificationEvent;
} SMBUS_INSTANCE;
//
// Driver global data
//
SMBUS_INSTANCE *mSmbusContext;
//
// Prototypes
//
/**
Execute an SMBUS operation
@param[in] This The protocol instance
@param[in] SlaveAddress The address of the SMBUS slave device
@param[in] Command The SMBUS command
@param[in] Operation Which SMBus protocol will be issued
@param[in] PecCheck If Packet Error Code Checking is to be used
@param[out] Length Length of data
@param[out] Buffer Data buffer
@retval EFI_SUCCESS The SMBUS operation is successful
@retval Other Values Something error occurred
**/
EFI_STATUS
EFIAPI
SmbusExecute (
IN EFI_SMBUS_HC_PROTOCOL *This,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN EFI_SMBUS_DEVICE_COMMAND Command,
IN EFI_SMBUS_OPERATION Operation,
IN BOOLEAN PecCheck,
IN OUT UINTN *Length,
IN OUT VOID *Buffer
);
/**
Smbus driver entry point
@param[in] ImageHandle ImageHandle of this module
@param[in] SystemTable EFI System Table
@retval EFI_SUCCESS Driver initializes successfully
@retval Other values Some error occurred
**/
EFI_STATUS
EFIAPI
InitializePchSmbus (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
/**
Set Slave address for an Smbus device with a known UDID or perform a general
ARP of all devices.
@param[in] This Pointer to the instance of the EFI_SMBUS_HC_PROTOCOL.
@param[in] ArpAll If TRUE, do a full ARP. Otherwise, just ARP the specified UDID.
@param[in] SmbusUdid When doing a directed ARP, ARP the device with this UDID.
@@param[in, out] SlaveAddress Buffer to store new Slave Address during directed ARP. On output,If
ArpAlll == TRUE, this will contain the newly assigned Slave address.
@retval EFI_INVALID_PARAMETER ArpAll == FALSE but SmbusUdid or SlaveAddress are NULL.
Return value from SmbusFullArp() or SmbusDirectedArp().
**/
EFI_STATUS
EFIAPI
SmbusArpDevice (
IN EFI_SMBUS_HC_PROTOCOL * This,
IN BOOLEAN ArpAll,
IN EFI_SMBUS_UDID * SmbusUdid, OPTIONAL
IN OUT EFI_SMBUS_DEVICE_ADDRESS * SlaveAddress OPTIONAL
);
/**
Get a pointer to the assigned mappings of UDID's to Slave Addresses.
@param[in] This Pointer to the instance of the EFI_SMBUS_HC_PROTOCOL.
@param[in, out] Length Buffer to contain the lenght of the Device Map, it will be updated to
contain the number of pairs of UDID's mapped to Slave Addresses.
@param[in, out] SmbusDeviceMap Buffer to contian a pointer to the Device Map, it will be updated to
point to the first pair in the Device Map
@retval EFI_SUCCESS Function completed successfully.
**/
EFI_STATUS
EFIAPI
SmbusGetArpMap (
IN EFI_SMBUS_HC_PROTOCOL *This,
IN OUT UINTN *Length,
IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
);
/**
Register a callback in the event of a Host Notify command being sent by a
specified Slave Device.
@param[in] This Pointer to the instance of the EFI_SMBUS_HC_PROTOCOL.
@param[in] SlaveAddress Address of the device whose Host Notify command we want to
trap.
@param[in] Data Data of the Host Notify command we want to trap.
@param[in] NotifyFunction Function to be called in the event the desired Host Notify
command occurs.
@exception EFI_UNSUPPORTED Unable to create the event needed for notifications.
@retval EFI_INVALID_PARAMETER NotifyFunction was NULL.
@retval EFI_OUT_OF_RESOURCES Unable to allocate space to register the notification.
@retval EFI_SUCCESS Function completed successfully
**/
EFI_STATUS
EFIAPI
SmbusNotify (
IN EFI_SMBUS_HC_PROTOCOL *This,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN UINTN Data,
IN EFI_SMBUS_NOTIFY_FUNCTION NotifyFunction
);
/**
Set up a periodic event so that we can check if any Slave Device has sent a
Notify ARP Master command.
@param[in] None.
@retval EFI_SUCCESS Periodic event successfully set up.
@retval Other Errors Failed to set up Periodic event.
Error value from CreateEvent().
Error value from SetTimer().
**/
EFI_STATUS
InitializePeriodicEvent (
VOID
);
/**
Function to be called every time periodic event happens. This will check if
the SMBus Host Controller has received a Host Notify command. If so, it will
see if a notification has been reqested on that event and make any callbacks
that may be necessary.
@param[in] Event The periodic event that occured and got us into this callback.
@param[in] Context Event context. Will be NULL in this case, since we already have our
private data in a module global variable.
@retval None
**/
VOID
EFIAPI
PollSmbusNotify (
IN EFI_EVENT Event,
IN VOID *Context
);
/**
Issue a prepare ARP command to informs all devices that the ARP Master is starting the ARP process
@param[in] Private Pointer to the SMBUS_INSTANCE
@retval EFI_SUCCESS The SMBUS operation is successful
@retval Other Values Something error occurred
**/
EFI_STATUS
SmbusPrepareToArp (
IN SMBUS_INSTANCE *Private
);
/**
Issue a Get UDID (general) command to requests ARP-capable and/or Discoverable devices to
return their slave address along with their UDID.
@param[in] Private Pointer to the SMBUS_INSTANCE
@param[in, out] DeviceMap Pointer to SMBUS device map table that slave device return
@retval EFI_SUCCESS The SMBUS operation is successful
@retval Other Values Something error occurred
**/
EFI_STATUS
SmbusGetUdidGeneral (
IN SMBUS_INSTANCE *Private,
IN OUT EFI_SMBUS_DEVICE_MAP *DeviceMap
);
/**
Issue a Assign address command to assigns an address to a specific slave device.
@param[in] Private Pointer to the SMBUS_INSTANCE
@param[in, out] DeviceMap Pointer to SMBUS device map table that send to slave device
@retval EFI_SUCCESS The SMBUS operation is successful
@retval Other Values Something error occurred
**/
EFI_STATUS
SmbusAssignAddress (
IN SMBUS_INSTANCE *Private,
IN OUT EFI_SMBUS_DEVICE_MAP *DeviceMap
);
/**
Do a fully (general) Arp procress to assign the slave address of all ARP-capable device.
This function will issue issue the "Prepare to ARP", "Get UDID" and "Assign Address" commands.
@param[in] Private Pointer to the SMBUS_INSTANCE
@retval EFI_OUT_OF_RESOURCES No available address to assign
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
SmbusFullArp (
IN SMBUS_INSTANCE *Private
);
/**
Do a directed Arp procress to assign the slave address of a single ARP-capable device.
@param[in] Private Pointer to the SMBUS_INSTANCE
@param[in] SmbusUdid When doing a directed ARP, ARP the device with this UDID.
@param[in, out] SlaveAddress Buffer to store new Slave Address during directed ARP.
@retval EFI_OUT_OF_RESOURCES DeviceMapEntries is more than Max number of SMBus devices
Or there is no available address to assign
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
SmbusDirectedArp (
IN SMBUS_INSTANCE *Private,
IN EFI_SMBUS_UDID *SmbusUdid,
IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress
);
/**
Find an available address to assign
@param[in] Private Pointer to the SMBUS_INSTANCE
@param[in] SlaveAddress Buffer to store new Slave Address during directed ARP.
@retval EFI_OUT_OF_RESOURCES There is no available address to assign
@retval EFI_SUCCESS The function completed successfully
**/
EFI_STATUS
GetNextAvailableAddress (
IN SMBUS_INSTANCE *Private,
IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress
);
/**
Check whether the address is assignable.
@param[in] Private Pointer to the SMBUS_INSTANCE
@param[in] SlaveAddress The Slave Address for checking
@retval TRUE The address is assignable
@retval FALSE The address is not assignable
**/
BOOLEAN
IsAddressAvailable (
IN SMBUS_INSTANCE *Private,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress
);
#endif
|