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
|
/** @file
Implementation of SmBusLib class library for PEI phase.
Copyright (c) 2006, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: DxeSmbusLib.c
**/
#include "InternalSmbusLib.h"
//
// Globle varible to cache pointer to Smbus protocol.
//
STATIC EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL;
/**
The constructor function caches the pointer to Smbus protocol.
The constructor function locates Smbus protocol from protocol database.
It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
EFIAPI
SmbusLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
Status = gBS->LocateProtocol (
&gEfiCpuIoProtocolGuid,
NULL,
(VOID**) &mSmbus
);
ASSERT_EFI_ERROR (Status);
ASSERT (mSmbus != NULL);
return Status;
}
/**
Executes an SMBus operation to an SMBus controller.
This function provides a standard way to execute Smbus script
as defined in the SmBus Specification. The data can either be of
the Length byte, word, or a block of data.
@param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
execute the SMBus transactions.
@param SmBusAddress Address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
@param Length Signifies the number of bytes that this operation will do. The maximum number of
bytes can be revision specific and operation specific.
@param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
require this argument. The length of this buffer is identified by Length.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
@return The actual number of bytes that are executed for this operation..
**/
UINTN
InternalSmBusExec (
IN EFI_SMBUS_OPERATION SmbusOperation,
IN UINTN SmBusAddress,
IN UINTN Length,
IN VOID *Buffer,
OUT RETURN_STATUS *Status OPTIONAL
)
{
RETURN_STATUS ReturnStatus;
EFI_SMBUS_DEVICE_ADDRESS SmbusDeviceAddress;
SmbusDeviceAddress.SmbusDeviceAddress = SMBUS_LIB_SLAVE_ADDRESS (SmBusAddress);
ReturnStatus = mSmbus->Execute (
mSmbus,
SmbusDeviceAddress,
SMBUS_LIB_COMMAND (SmBusAddress),
SmbusOperation,
SMBUS_LIB_PEC (SmBusAddress),
&Length,
Buffer
);
if (Status != NULL) {
*Status = ReturnStatus;
}
return Length;
}
/**
Assigns an SMBUS slave addresses.
Assigns the SMBUS device specified by Uuid the slave address specified by SmBusAddress.
The status of the executed command is returned.
@param SmBusAddress Address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
@param Uuid Pointer to the UUID of the device to assign a slave address.
It will assign to all SMBUS slave devices if it is NULL.
@retval RETURN_SUCCESS The SMBUS command was executed.
@retval RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
@retval RETURN_DEVICE_ERROR The request was not completed because a failure reflected
in the Host Status Register bit.
Device errors are a result of a transaction collision, illegal command field,
unclaimed cycle (host initiated), or bus errors (collisions).
**/
RETURN_STATUS
InternalSmBusArpDevice (
IN UINTN SmBusAddress,
IN CONST GUID *Uuid OPTIONAL
)
{
EFI_SMBUS_DEVICE_ADDRESS SmbusDeviceAddress;
SmbusDeviceAddress.SmbusDeviceAddress = SMBUS_LIB_SLAVE_ADDRESS (SmBusAddress);
return (RETURN_STATUS) mSmbus->ArpDevice (
mSmbus,
(BOOLEAN) (Uuid == NULL),
(EFI_SMBUS_UDID *) Uuid,
&SmbusDeviceAddress
);
}
/**
Retrieves the mapping of all the SMBus devices.
The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
@param Length Size of the buffer that contains the SMBus device map.
@param SmbusDeviceMap The pointer to the device map as enumerated by the SMBus controller driver.
@retval RETURN_SUCCESS The SMBUS command was executed.
@retval RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
@retval RETURN_DEVICE_ERROR The request was not completed because a failure reflected
in the Host Status Register bit.
Device errors are a result of a transaction collision, illegal command field,
unclaimed cycle (host initiated), or bus errors (collisions).
**/
RETURN_STATUS
InternalGetArpMap (
OUT UINTN *Length,
OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
)
{
return (RETURN_STATUS) mSmbus->GetArpMap (mSmbus, Length, SmbusDeviceMap);
}
|
