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

91 lines
3.2 KiB
C

/** @file
Protocol definitions for TPSxFwUpdateWrapper
@copyright
INTEL CONFIDENTIAL
Copyright 2020 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 __TPSX_FW_UPDATE_WRAPPER_PROTOCOL_H___
#define __TPSX_FW_UPDATE_WRAPPER_PROTOCOL_H___
extern EFI_GUID gTPSxFwUpdateWrapperProtocolGuid;
//
// Used to indicate PD Firmware device
//
#define PD_FW_DEVICE_0 0
#define PD_FW_DEVICE_1 1
//
// FW Version Format
//
typedef struct {
UINT32 RomMajor0 : 8;
UINT32 RomMajor1 : 8;
UINT32 RomMinor : 8;
UINT32 Patch : 8;
} PD_FW_VERSION;
typedef
UINT16
(EFIAPI *TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_DEVSILICONID_FROM_IMAGE) (
IN UINT8 *FwImage,
IN UINTN ImageSize
);
typedef
UINT16
(EFIAPI *TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_DEVSILICONID_FROM_DEV) (
VOID
);
typedef
EFI_STATUS
(EFIAPI *TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_PDFWVERSION_FROM_DEV) (
IN UINT8 PdIndex,
IN OUT UINT8 *FwVersion
);
typedef
EFI_STATUS
(EFIAPI *TPSX_FW_UPDATE_WRAPPER_PROTOCOL_PERFORM_PDFWUPDATE) (
IN UINT8 PdIndex,
IN CONST VOID *FwImage,
IN UINTN ImageSize
);
typedef struct _TPSX_FW_UPDATE_WRAPPER_PROTOCOL {
TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_DEVSILICONID_FROM_IMAGE GetDevSiliconIdFromImage;
TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_DEVSILICONID_FROM_DEV GetDevSiliconIdFromDev;
TPSX_FW_UPDATE_WRAPPER_PROTOCOL_GET_PDFWVERSION_FROM_DEV GetPDFwVersionFromDev;
TPSX_FW_UPDATE_WRAPPER_PROTOCOL_PERFORM_PDFWUPDATE PerformPDFwUpdate;
} TPSX_FW_UPDATE_WRAPPER_PROTOCOL;
#endif