alder_lake_bios/Intel/AlderLake/AlderLakePlatSamplePkg/Features/Nvme/PowerLossNotifyDxe/PowerLossNotify.h

94 lines
3.6 KiB
C

/**@file
Power Loss Notification
@copyright
INTEL CONFIDENTIAL
Copyright 2020 - 2021 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 a 'Sample Driver' and is licensed as such under the terms
of your license agreement with Intel or your vendor. This file may be modified
by the user, subject to the additional terms of the license agreement.
@par Specification Reference:
**/
#ifndef _POWER_LOST_NOTIFY_H_
#define _POWER_LOST_NOTIFY_H_
#include <Protocol/NvmExpressPassthru.h>
#include <IndustryStandard/Pci22.h>
#include <IndustryStandard/Nvme.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/PrintLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/EcMiscLib.h>
#include <Library/GpioLib.h>
#include <SetupVariable.h>
#define NVME_CONTROLLER_ID 0
#define NVME_ALL_NAMESPACES 0xFFFFFFFF
#define PLN_FEATURE_ID 0xD8
#define SV_BIT_OFFSET 31
#define SEL_BIT_OFFSET 8
#define SEL_MASK 0xF00
#define SEL_CURRENT 0x0
#define GPIO_PLN_ENABLED 0x0
#define GPIO_PLN_DISABLED 0x1
#define GPIO_PLN_PB_OVR_NO_CS 0x0
#define GPIO_PLN_PB_OVR_CS 0x1
#define EC_PLN_DISABLED 0
#define EC_PLN_PB_OVR_NO_CS 4 // 4 sec
#define EC_PLN_PB_OVR_CS 10 // 10 sec
#define CTL_PLN_DISABLED 0x0
#define CTL_PLN_ENABLED 0x1
#define CTL_PLN_DEFAULT 0x2
typedef struct {
UINT32 Reserved1:17;
UINT32 StatusCode:8;
UINT32 StatusCodeType:3;
UINT32 Reserved2:2;
UINT32 More:1;
UINT32 DoNotRetry:1;
} SAVE_FEATURE_DW3;
typedef struct {
UINT32 PlnEnable:1;
UINT32 Reserved:31;
} SAVE_FEATURE_DW0;
typedef struct {
UINT32 PlnEnable:1;
UINT32 Reserved:31;
} GET_FEATURE_ATTR_CUR;
#endif