https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Hao Wu <hao.a.wu@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
		
			
				
	
	
		
			115 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			115 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|   Protocol to describe overrides required to support non-standard SDHCI
 | |
|   implementations
 | |
| 
 | |
|   Copyright (c) 2017 - 2018, Linaro, Ltd. All rights reserved.<BR>
 | |
| 
 | |
|   SPDX-License-Identifier: BSD-2-Clause-Patent
 | |
| 
 | |
| **/
 | |
| 
 | |
| #ifndef __SD_MMC_OVERRIDE_H__
 | |
| #define __SD_MMC_OVERRIDE_H__
 | |
| 
 | |
| #include <Protocol/SdMmcPassThru.h>
 | |
| 
 | |
| #define EDKII_SD_MMC_OVERRIDE_PROTOCOL_GUID \
 | |
|   { 0xeaf9e3c1, 0xc9cd, 0x46db, { 0xa5, 0xe5, 0x5a, 0x12, 0x4c, 0x83, 0x23, 0x23 } }
 | |
| 
 | |
| #define EDKII_SD_MMC_OVERRIDE_PROTOCOL_VERSION    0x2
 | |
| 
 | |
| typedef struct _EDKII_SD_MMC_OVERRIDE EDKII_SD_MMC_OVERRIDE;
 | |
| 
 | |
| //
 | |
| // Bus timing modes
 | |
| //
 | |
| typedef enum {
 | |
|   SdMmcUhsSdr12,
 | |
|   SdMmcUhsSdr25,
 | |
|   SdMmcUhsSdr50,
 | |
|   SdMmcUhsSdr104,
 | |
|   SdMmcUhsDdr50,
 | |
|   SdMmcMmcLegacy,
 | |
|   SdMmcMmcHsSdr,
 | |
|   SdMmcMmcHsDdr,
 | |
|   SdMmcMmcHs200,
 | |
|   SdMmcMmcHs400,
 | |
| } SD_MMC_BUS_MODE;
 | |
| 
 | |
| typedef enum {
 | |
|   EdkiiSdMmcResetPre,
 | |
|   EdkiiSdMmcResetPost,
 | |
|   EdkiiSdMmcInitHostPre,
 | |
|   EdkiiSdMmcInitHostPost,
 | |
|   EdkiiSdMmcUhsSignaling,
 | |
|   EdkiiSdMmcSwitchClockFreqPost,
 | |
| } EDKII_SD_MMC_PHASE_TYPE;
 | |
| 
 | |
| /**
 | |
| 
 | |
|   Override function for SDHCI capability bits
 | |
| 
 | |
|   @param[in]      ControllerHandle      The EFI_HANDLE of the controller.
 | |
|   @param[in]      Slot                  The 0 based slot index.
 | |
|   @param[in,out]  SdMmcHcSlotCapability The SDHCI capability structure.
 | |
|   @param[in,out]  BaseClkFreq           The base clock frequency value that
 | |
|                                         optionally can be updated.
 | |
| 
 | |
|   @retval EFI_SUCCESS           The override function completed successfully.
 | |
|   @retval EFI_NOT_FOUND         The specified controller or slot does not exist.
 | |
|   @retval EFI_INVALID_PARAMETER SdMmcHcSlotCapability is NULL
 | |
| 
 | |
| **/
 | |
| typedef
 | |
| EFI_STATUS
 | |
| (EFIAPI * EDKII_SD_MMC_CAPABILITY) (
 | |
|   IN      EFI_HANDLE                      ControllerHandle,
 | |
|   IN      UINT8                           Slot,
 | |
|   IN OUT  VOID                            *SdMmcHcSlotCapability,
 | |
|   IN OUT  UINT32                          *BaseClkFreq
 | |
|   );
 | |
| 
 | |
| /**
 | |
| 
 | |
|   Override function for SDHCI controller operations
 | |
| 
 | |
|   @param[in]      ControllerHandle      The EFI_HANDLE of the controller.
 | |
|   @param[in]      Slot                  The 0 based slot index.
 | |
|   @param[in]      PhaseType             The type of operation and whether the
 | |
|                                         hook is invoked right before (pre) or
 | |
|                                         right after (post)
 | |
|   @param[in,out]  PhaseData             The pointer to a phase-specific data.
 | |
| 
 | |
|   @retval EFI_SUCCESS           The override function completed successfully.
 | |
|   @retval EFI_NOT_FOUND         The specified controller or slot does not exist.
 | |
|   @retval EFI_INVALID_PARAMETER PhaseType is invalid
 | |
| 
 | |
| **/
 | |
| typedef
 | |
| EFI_STATUS
 | |
| (EFIAPI * EDKII_SD_MMC_NOTIFY_PHASE) (
 | |
|   IN      EFI_HANDLE                      ControllerHandle,
 | |
|   IN      UINT8                           Slot,
 | |
|   IN      EDKII_SD_MMC_PHASE_TYPE         PhaseType,
 | |
|   IN OUT  VOID                           *PhaseData
 | |
|   );
 | |
| 
 | |
| struct _EDKII_SD_MMC_OVERRIDE {
 | |
|   //
 | |
|   // Protocol version of this implementation
 | |
|   //
 | |
|   UINTN                         Version;
 | |
|   //
 | |
|   // Callback to override SD/MMC host controller capability bits
 | |
|   //
 | |
|   EDKII_SD_MMC_CAPABILITY       Capability;
 | |
|   //
 | |
|   // Callback to invoke SD/MMC override hooks
 | |
|   //
 | |
|   EDKII_SD_MMC_NOTIFY_PHASE     NotifyPhase;
 | |
| };
 | |
| 
 | |
| extern EFI_GUID gEdkiiSdMmcOverrideProtocolGuid;
 | |
| 
 | |
| #endif
 |