448 lines
8.6 KiB
C
448 lines
8.6 KiB
C
/** @file
|
|
EC miscellaneous library functions.
|
|
|
|
@copyright
|
|
INTEL CONFIDENTIAL
|
|
Copyright 1999 - 2019 Intel Corporation.
|
|
|
|
The source code contained or described herein and all documents related to the
|
|
source code ("Material") are owned by Intel Corporation or its suppliers or
|
|
licensors. Title to the Material remains with Intel Corporation or its suppliers
|
|
and licensors. The Material may contain trade secrets and proprietary and
|
|
confidential information of Intel Corporation and its suppliers and licensors,
|
|
and is protected by worldwide copyright and trade secret laws and treaty
|
|
provisions. No part of the Material may be used, copied, reproduced, modified,
|
|
published, uploaded, posted, transmitted, distributed, or disclosed in any way
|
|
without Intel's prior express written permission.
|
|
|
|
No license under any patent, copyright, trade secret or other intellectual
|
|
property right is granted to or conferred upon you by disclosure or delivery
|
|
of the Materials, either expressly, by implication, inducement, estoppel or
|
|
otherwise. Any license under such intellectual property rights must be
|
|
express and approved by Intel in writing.
|
|
|
|
Unless otherwise agreed by Intel in writing, you may not remove or alter
|
|
this notice or any other notice embedded in Materials by Intel or
|
|
Intel's suppliers or licensors in any way.
|
|
|
|
This file contains 'Framework Code' and is licensed as such under the terms
|
|
of your license agreement with Intel or your vendor. This file may not be
|
|
modified, except as allowed by additional terms of your license agreement.
|
|
|
|
@par Specification Reference:
|
|
**/
|
|
|
|
#ifndef _BASE_EC_MISC_LIB_H_
|
|
#define _BASE_EC_MISC_LIB_H_
|
|
|
|
//
|
|
// Include files
|
|
//
|
|
#include <Base.h>
|
|
#include <Uefi.h>
|
|
#include "EcCommands.h"
|
|
#include <Library/EcLib.h>
|
|
|
|
/**
|
|
Send enable ACPI mode command to EC
|
|
|
|
@param[in] Enable TURE - Enable EC ACPI mode
|
|
FALSE - Disable EC ACPI mode
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
EnableEcAcpiMode (
|
|
IN BOOLEAN Enable
|
|
);
|
|
|
|
|
|
/**
|
|
Send disable SMI mode command to EC
|
|
|
|
@param EFI_SUCCESS Command success
|
|
@param EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DisableEcSmiMode (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Set EC critical shutdown temperature
|
|
|
|
@param[in] DataBuffer Shutdown temperature
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
SetEcCriticalShutdownTemperature (
|
|
IN UINT8 DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Get power state from EC. If power state cannot be determined,
|
|
battery powered is assumed.
|
|
|
|
@param TRUE AC powered
|
|
@param FALSE Battery powered
|
|
**/
|
|
BOOLEAN
|
|
PowerStateIsAc (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Do EC reset
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
EcReset (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Initiate EC reset sequence. EC is in Normal Mode.
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
EcResetEcInNormalMode (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Enable LAN power
|
|
|
|
@param[in] Enable TURE - Enable LAN power
|
|
FALSE - Disable LAN power
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
EnableLanPower (
|
|
IN BOOLEAN Enable
|
|
);
|
|
|
|
|
|
/**
|
|
Query SMI event
|
|
|
|
@param[out] DataBuffer SMI event
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
QuerySmiEvent (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Get the scan code of hotkey pressed (CTRL + ALT + SHIFT + key)
|
|
|
|
@param[out] DataBuffer Scan code of hotkey
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
GetHotkeyScanCode (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Get the number of battery
|
|
|
|
@param[out] DataBuffer The number of battery
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
GetBatteryNumber (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Get PCIe dock status
|
|
|
|
@param[out] DataBuffer PCIe dock status
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
GetPcieDockStatus (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Clear ten second power button mode
|
|
|
|
**/
|
|
VOID
|
|
ClearTenSecPwrButtonMode (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Enable SATA port2 power
|
|
|
|
**/
|
|
VOID
|
|
EnableSataPort2Power (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Set SLP_S0 Voltage
|
|
|
|
@param[in] EcDataV085ACNT
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
SetSlpS0Voltage (
|
|
IN UINT8 EcDataV085ACNT
|
|
);
|
|
|
|
/**
|
|
Detect Pmic Vendor ID
|
|
@param[out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DetectPmicVendorID (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
/**
|
|
Set Pmic Voltage
|
|
|
|
@param[in] EcDataVcc
|
|
@param[in] EcDataVddq
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
SetPmicVoltage (
|
|
IN UINT8 EcDataVcc,
|
|
IN UINT8 EcDataVddq
|
|
);
|
|
|
|
|
|
/**
|
|
Read data from EC RAM
|
|
|
|
@param[in][out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
ReadEcRam (
|
|
IN OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Write data to EC RAM
|
|
|
|
@param[in][out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
WriteEcRam (
|
|
IN OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Update Device Power
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
UpdateDevicePower (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Query system status
|
|
|
|
@param[out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
QuerySysStatus (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Get board fab ID
|
|
|
|
@param[out] BoardFabId
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
GetBoardInfo (
|
|
OUT UINT16 *BoardFabId
|
|
);
|
|
|
|
|
|
/**
|
|
Send Exit Low Power Mode command to EC
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
ExitLowPowerMode (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
System power off
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
SystemPowerOff (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Detect EC support
|
|
|
|
@param[out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DetectEcSupport (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
/**
|
|
Detect EC revision
|
|
|
|
@param[out] DataBuffer
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DetectEcRevision (
|
|
OUT UINT8 *DataBuffer
|
|
);
|
|
|
|
|
|
/**
|
|
Disable PCH DTS reading on SMLink 1
|
|
|
|
@param[in] Disable 0: Enable PCH DTS reading
|
|
1: Disable PCH DTS reading
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DisablePchDtsReading (
|
|
IN UINT8 Disable
|
|
);
|
|
|
|
/**
|
|
Wake up EC
|
|
|
|
@retval TRUE EC wake up successfully.
|
|
@retval FALSE Fail to wake up EC.
|
|
**/
|
|
EFI_STATUS
|
|
WakeUpEc (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Send Update PWM command to EC
|
|
|
|
@param EFI_SUCCESS Command success
|
|
@param EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
UpdatePwm (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Updates the PWM to the given value and returns the Fan speed.
|
|
@param Pwmvalue Pwm ending value
|
|
@param Speed Updates the Speed
|
|
|
|
@retval EFI_SUCCESS when successfully able to get the nominal data.
|
|
@retval ERROR Error if anything went wrong.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
GetFanSpeed(
|
|
IN UINT8 Pwmvalue,
|
|
OUT UINT16 *Speed
|
|
);
|
|
|
|
|
|
/**
|
|
Select charging method
|
|
|
|
@param[in] Enable TURE - Fast charging (DFCT)
|
|
FALSE - Normal charging
|
|
|
|
@retval EFI_SUCCESS Command success
|
|
@retval EFI_DEVICE_ERROR Command error
|
|
**/
|
|
EFI_STATUS
|
|
DfctFastChargingMode (
|
|
IN BOOLEAN Enable
|
|
);
|
|
|
|
/**
|
|
EcForceResetAfterAcRemoval
|
|
|
|
@param[in] ForceResetAfterAcRemovalVar 0 : Clear AC Removal reset bit in EC
|
|
1 : Set AC Removal reset bit in EC
|
|
**/
|
|
VOID
|
|
EcForceResetAfterAcRemoval (
|
|
IN UINT8 ForceResetAfterAcRemovalVar
|
|
);
|
|
|
|
#endif
|