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
|
/** @file
PCH Smbus Protocol
@copyright
Copyright (c) 2009 - 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 _SMM_PCH_SMBUS_H
#define _SMM_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_DEFINITION (Smbus)
#include EFI_PROTOCOL_PRODUCER (SmmSmbus)
//
// Driver Consumed Protcol Prototypes
//
#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)
///
/// 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;
} SMBUS_INSTANCE;
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[in, out] Length Length of data
@param[in, 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
InitializePchSmbusSmm (
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.
@exception EFI_UNSUPPORTED This functionality is not supported
**/
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
@exception EFI_UNSUPPORTED This functionality is not supported
**/
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 This functionality is not supported
**/
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
);
#endif
|
