3 Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
4 Copyright (C) 2013, Red Hat, Inc.
5 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <Library/BaseLib.h>
19 #include <Library/BaseMemoryLib.h>
20 #include <Library/DebugLib.h>
21 #include <Library/IoLib.h>
22 #include <Library/QemuFwCfgLib.h>
23 #include <Library/MemoryAllocationLib.h>
24 #include <Library/UefiBootServicesTableLib.h>
26 #include "QemuFwCfgLibInternal.h"
30 Selects a firmware configuration item for reading.
32 Following this call, any data read from this item will start from
33 the beginning of the configuration item's data.
35 @param[in] QemuFwCfgItem - Firmware Configuration item to read
41 IN FIRMWARE_CONFIG_ITEM QemuFwCfgItem
44 DEBUG ((EFI_D_INFO
, "Select Item: 0x%x\n", (UINT16
)(UINTN
) QemuFwCfgItem
));
45 IoWrite16 (0x510, (UINT16
)(UINTN
) QemuFwCfgItem
);
50 Transfer an array of bytes using the DMA interface.
52 @param[in] Size Size in bytes to transfer.
53 @param[in,out] Buffer Buffer to read data into or write data from. May be
55 @param[in] Write TRUE if writing to fw_cfg from Buffer, FALSE if
56 reading from fw_cfg into Buffer.
59 InternalQemuFwCfgDmaBytes (
61 IN OUT VOID
*Buffer OPTIONAL
,
65 volatile FW_CFG_DMA_ACCESS Access
;
66 UINT32 AccessHigh
, AccessLow
;
73 Access
.Control
= SwapBytes32 (
74 Write
? FW_CFG_DMA_CTL_WRITE
: FW_CFG_DMA_CTL_READ
76 Access
.Length
= SwapBytes32 (Size
);
77 Access
.Address
= SwapBytes64 ((UINTN
)Buffer
);
80 // Delimit the transfer from (a) modifications to Access, (b) in case of a
81 // write, from writes to Buffer by the caller.
86 // Start the transfer.
88 AccessHigh
= (UINT32
)RShiftU64 ((UINTN
)&Access
, 32);
89 AccessLow
= (UINT32
)(UINTN
)&Access
;
90 IoWrite32 (0x514, SwapBytes32 (AccessHigh
));
91 IoWrite32 (0x518, SwapBytes32 (AccessLow
));
94 // Don't look at Access.Control before starting the transfer.
99 // Wait for the transfer to complete.
102 Status
= SwapBytes32 (Access
.Control
);
103 ASSERT ((Status
& FW_CFG_DMA_CTL_ERROR
) == 0);
104 } while (Status
!= 0);
107 // After a read, the caller will want to use Buffer.
114 Reads firmware configuration bytes into a buffer
116 @param[in] Size - Size in bytes to read
117 @param[in] Buffer - Buffer to store data into (OPTIONAL if Size is 0)
122 InternalQemuFwCfgReadBytes (
124 IN VOID
*Buffer OPTIONAL
127 if (InternalQemuFwCfgDmaIsAvailable () && Size
<= MAX_UINT32
) {
128 InternalQemuFwCfgDmaBytes ((UINT32
)Size
, Buffer
, FALSE
);
131 IoReadFifo8 (0x511, Size
, Buffer
);
136 Reads firmware configuration bytes into a buffer
138 If called multiple times, then the data read will
139 continue at the offset of the firmware configuration
140 item where the previous read ended.
142 @param[in] Size - Size in bytes to read
143 @param[in] Buffer - Buffer to store data into
153 if (InternalQemuFwCfgIsAvailable ()) {
154 InternalQemuFwCfgReadBytes (Size
, Buffer
);
156 ZeroMem (Buffer
, Size
);
161 Write firmware configuration bytes from a buffer
163 If called multiple times, then the data written will
164 continue at the offset of the firmware configuration
165 item where the previous write ended.
167 @param[in] Size - Size in bytes to write
168 @param[in] Buffer - Buffer to read data from
173 QemuFwCfgWriteBytes (
178 if (InternalQemuFwCfgIsAvailable ()) {
179 if (InternalQemuFwCfgDmaIsAvailable () && Size
<= MAX_UINT32
) {
180 InternalQemuFwCfgDmaBytes ((UINT32
)Size
, Buffer
, TRUE
);
183 IoWriteFifo8 (0x511, Size
, Buffer
);
189 Reads a UINT8 firmware configuration value
191 @return Value of Firmware Configuration item read
202 QemuFwCfgReadBytes (sizeof (Result
), &Result
);
209 Reads a UINT16 firmware configuration value
211 @return Value of Firmware Configuration item read
222 QemuFwCfgReadBytes (sizeof (Result
), &Result
);
229 Reads a UINT32 firmware configuration value
231 @return Value of Firmware Configuration item read
242 QemuFwCfgReadBytes (sizeof (Result
), &Result
);
249 Reads a UINT64 firmware configuration value
251 @return Value of Firmware Configuration item read
262 QemuFwCfgReadBytes (sizeof (Result
), &Result
);
269 Find the configuration item corresponding to the firmware configuration file.
271 @param[in] Name - Name of file to look up.
272 @param[out] Item - Configuration item corresponding to the file, to be passed
273 to QemuFwCfgSelectItem ().
274 @param[out] Size - Number of bytes in the file.
276 @return RETURN_SUCCESS If file is found.
277 RETURN_NOT_FOUND If file is not found.
278 RETURN_UNSUPPORTED If firmware configuration is unavailable.
284 IN CONST CHAR8
*Name
,
285 OUT FIRMWARE_CONFIG_ITEM
*Item
,
292 if (!InternalQemuFwCfgIsAvailable ()) {
293 return RETURN_UNSUPPORTED
;
296 QemuFwCfgSelectItem (QemuFwCfgItemFileDir
);
297 Count
= SwapBytes32 (QemuFwCfgRead32 ());
299 for (Idx
= 0; Idx
< Count
; ++Idx
) {
303 CHAR8 FName
[QEMU_FW_CFG_FNAME_SIZE
];
305 FileSize
= QemuFwCfgRead32 ();
306 FileSelect
= QemuFwCfgRead16 ();
307 FileReserved
= QemuFwCfgRead16 ();
308 (VOID
) FileReserved
; /* Force a do-nothing reference. */
309 InternalQemuFwCfgReadBytes (sizeof (FName
), FName
);
311 if (AsciiStrCmp (Name
, FName
) == 0) {
312 *Item
= SwapBytes16 (FileSelect
);
313 *Size
= SwapBytes32 (FileSize
);
314 return RETURN_SUCCESS
;
318 return RETURN_NOT_FOUND
;
323 Determine if S3 support is explicitly enabled.
325 @retval TRUE if S3 support is explicitly enabled.
326 FALSE otherwise. This includes unavailability of the firmware
327 configuration interface.
335 RETURN_STATUS Status
;
336 FIRMWARE_CONFIG_ITEM FwCfgItem
;
338 UINT8 SystemStates
[6];
340 Status
= QemuFwCfgFindFile ("etc/system-states", &FwCfgItem
, &FwCfgSize
);
341 if (Status
!= RETURN_SUCCESS
|| FwCfgSize
!= sizeof SystemStates
) {
344 QemuFwCfgSelectItem (FwCfgItem
);
345 QemuFwCfgReadBytes (sizeof SystemStates
, SystemStates
);
346 return (BOOLEAN
) (SystemStates
[3] & BIT7
);