alder_lake_bios/Intel/AlderLake/AlderLakePlatSamplePkg/Include/Protocol/LifeCycleState.h

95 lines
3.0 KiB
C

/**@file
@copyright
INTEL CONFIDENTIAL
Copyright 2016 - 2017 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
**/
#ifndef LIFE_CYCLE_STATE_H_
#define LIFE_CYCLE_STATE_H_
#define LIFE_CYCLE_STATE_PROTOCOL_GUID \
{ 0xf3c1138e, 0xcd89, 0x4e20, { 0x9e, 0x68, 0x25, 0xa6, 0x76, 0x95, 0xa5, 0x6a } }
#define LIFE_CYCLE_STATE_PROTOCOL_REVISION1 0x00000001
//*******************************************************
// LIFE_CYCLE_STATE
//*******************************************************
typedef enum {
StateManufacturing,
StateEndUser,
StateRnD,
StateCare
} LIFE_CYCLE_STATE;
typedef struct _LIFE_CYCLE_STATE_PROTOCOL LIFE_CYCLE_STATE_PROTOCOL;
/**
Retrieves life cycle state
@param[in] This Protocol instance pointer.
@param[out] LifeCycleState The life cycle state read from ME FW status.
@retval EFI_SUCCESS The state was successfully retrived.
**/
typedef
EFI_STATUS
(EFIAPI * GET_LIFE_CYCLE_STATE) (
IN LIFE_CYCLE_STATE_PROTOCOL *This,
OUT LIFE_CYCLE_STATE *LifeCycleState
);
#pragma pack(1)
struct _LIFE_CYCLE_STATE_PROTOCOL {
UINT32 Revision;
GET_LIFE_CYCLE_STATE GetLifeCycleState;
};
#pragma pack()
/**
Retrieves life cycle state
@param[in] This Protocol instance pointer.
@param[out] LifeCycleState The life cycle state read from ME FW status.
@retval EFI_SUCCESS The state was successfully retrived.
**/
EFI_STATUS
GetLifeCycleState (
IN LIFE_CYCLE_STATE_PROTOCOL *This,
OUT LIFE_CYCLE_STATE *LifeCycleState
);
extern EFI_GUID gLifeCycleStateProtocolGuid;
#endif