mirror of https://github.com/acidanthera/audk.git
MdePkg: Add EFI UFS Device Config Protocol definitions
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hao Wu <hao.a.wu@intel.com> Reviewed-by: Star Zeng <star.zeng@intel.com>
This commit is contained in:
Hao Wu
parent
d52f8e4313
commit
ed960a1d11
|
|
@ -0,0 +1,143 @@
|
|||
/** @file
|
||||
This file defines the EFI UFS Device Config Protocol.
|
||||
|
||||
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
@par Revision Reference:
|
||||
This Protocol is introduced in UEFI Specification 2.7
|
||||
|
||||
**/
|
||||
|
||||
#ifndef __UFS_DEVICE_CONFIG_PROTOCOL_H__
|
||||
#define __UFS_DEVICE_CONFIG_PROTOCOL_H__
|
||||
|
||||
//
|
||||
// EFI UFS Device Config Protocol GUID value
|
||||
//
|
||||
#define EFI_UFS_DEVICE_CONFIG_GUID \
|
||||
{ 0xb81bfab0, 0xeb3, 0x4cf9, { 0x84, 0x65, 0x7f, 0xa9, 0x86, 0x36, 0x16, 0x64 }};
|
||||
|
||||
//
|
||||
// Forward reference for pure ANSI compatability
|
||||
//
|
||||
typedef struct _EFI_UFS_DEVICE_CONFIG_PROTOCOL EFI_UFS_DEVICE_CONFIG_PROTOCOL;
|
||||
|
||||
/**
|
||||
Read or write specified device descriptor of a UFS device.
|
||||
|
||||
The service is used to read/write UFS device descriptors. The consumer of this API is responsible
|
||||
for allocating the data buffer pointed by Descriptor.
|
||||
|
||||
@param[in] This The pointer to the EFI_UFS_DEVICE_CONFIG_PROTOCOL instance.
|
||||
@param[in] Read The boolean variable to show r/w direction.
|
||||
@param[in] DescId The ID of device descriptor.
|
||||
@param[in] Index The Index of device descriptor.
|
||||
@param[in] Selector The Selector of device descriptor.
|
||||
@param[in, out] Descriptor The buffer of device descriptor to be read or written.
|
||||
@param[in, out] DescSize The size of device descriptor buffer. On input, the size, in bytes,
|
||||
of the data buffer specified by Descriptor. On output, the number
|
||||
of bytes that were actually transferred.
|
||||
|
||||
@retval EFI_SUCCESS The device descriptor is read/written successfully.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL or Descriptor is NULL or DescSize is NULL.
|
||||
DescId, Index and Selector are invalid combination to point to a
|
||||
type of UFS device descriptor.
|
||||
@retval EFI_DEVICE_ERROR The device descriptor is not read/written successfully.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_UFS_DEVICE_CONFIG_RW_DESCRIPTOR) (
|
||||
IN EFI_UFS_DEVICE_CONFIG_PROTOCOL *This,
|
||||
IN BOOLEAN Read,
|
||||
IN UINT8 DescId,
|
||||
IN UINT8 Index,
|
||||
IN UINT8 Selector,
|
||||
IN OUT UINT8 *Descriptor,
|
||||
IN OUT UINT32 *DescSize
|
||||
);
|
||||
|
||||
/**
|
||||
Read or write specified flag of a UFS device.
|
||||
|
||||
The service is used to read/write UFS flag descriptors. The consumer of this API is responsible
|
||||
for allocating the buffer pointed by Flag. The buffer size is 1 byte as UFS flag descriptor is
|
||||
just a single Boolean value that represents a TRUE or FALSE, '0' or '1', ON or OFF type of value.
|
||||
|
||||
@param[in] This The pointer to the EFI_UFS_DEVICE_CONFIG_PROTOCOL instance.
|
||||
@param[in] Read The boolean variable to show r/w direction.
|
||||
@param[in] FlagId The ID of flag to be read or written.
|
||||
@param[in, out] Flag The buffer to set or clear flag.
|
||||
|
||||
@retval EFI_SUCCESS The flag descriptor is set/clear successfully.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL or Flag is NULL.
|
||||
FlagId is an invalid UFS flag ID.
|
||||
@retval EFI_DEVICE_ERROR The flag is not set/clear successfully.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_UFS_DEVICE_CONFIG_RW_FLAG) (
|
||||
IN EFI_UFS_DEVICE_CONFIG_PROTOCOL *This,
|
||||
IN BOOLEAN Read,
|
||||
IN UINT8 FlagId,
|
||||
IN OUT UINT8 *Flag
|
||||
);
|
||||
|
||||
/**
|
||||
Read or write specified attribute of a UFS device.
|
||||
|
||||
The service is used to read/write UFS attributes. The consumer of this API is responsible for
|
||||
allocating the data buffer pointed by Attribute.
|
||||
|
||||
@param[in] This The pointer to the EFI_UFS_DEVICE_CONFIG_PROTOCOL instance.
|
||||
@param[in] Read The boolean variable to show r/w direction.
|
||||
@param[in] AttrId The ID of Attribute.
|
||||
@param[in] Index The Index of Attribute.
|
||||
@param[in] Selector The Selector of Attribute.
|
||||
@param[in, out] Attribute The buffer of Attribute to be read or written.
|
||||
@param[in, out] AttrSize The size of Attribute buffer. On input, the size, in bytes, of the
|
||||
data buffer specified by Attribute. On output, the number of bytes
|
||||
that were actually transferred.
|
||||
|
||||
@retval EFI_SUCCESS The attribute is read/written successfully.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL or Attribute is NULL or AttrSize is NULL.
|
||||
AttrId, Index and Selector are invalid combination to point to a
|
||||
type of UFS attribute.
|
||||
@retval EFI_DEVICE_ERROR The attribute is not read/written successfully.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_UFS_DEVICE_CONFIG_RW_ATTRIBUTE) (
|
||||
IN EFI_UFS_DEVICE_CONFIG_PROTOCOL *This,
|
||||
IN BOOLEAN Read,
|
||||
IN UINT8 AttrId,
|
||||
IN UINT8 Index,
|
||||
IN UINT8 Selector,
|
||||
IN OUT UINT8 *Attribute,
|
||||
IN OUT UINT32 *AttrSize
|
||||
);
|
||||
|
||||
///
|
||||
/// UFS Device Config Protocol structure.
|
||||
///
|
||||
struct _EFI_UFS_DEVICE_CONFIG_PROTOCOL {
|
||||
EFI_UFS_DEVICE_CONFIG_RW_DESCRIPTOR RwUfsDescriptor;
|
||||
EFI_UFS_DEVICE_CONFIG_RW_FLAG RwUfsFlag;
|
||||
EFI_UFS_DEVICE_CONFIG_RW_ATTRIBUTE RwUfsAttribute;
|
||||
};
|
||||
|
||||
///
|
||||
/// UFS Device Config Protocol GUID variable.
|
||||
///
|
||||
extern EFI_GUID gEfiUfsDeviceConfigProtocolGuid;
|
||||
|
||||
#endif
|
||||
|
|
@ -1663,6 +1663,9 @@
|
|||
## Include/Protocol/BluetoothLeConfig.h
|
||||
gEfiBluetoothLeConfigProtocolGuid = { 0x8f76da58, 0x1f99, 0x4275, { 0xa4, 0xec, 0x47, 0x56, 0x51, 0x5b, 0x1c, 0xe8 } }
|
||||
|
||||
## Include/Protocol/UfsDeviceConfig.h
|
||||
gEfiUfsDeviceConfigProtocolGuid = { 0xb81bfab0, 0xeb3, 0x4cf9, { 0x84, 0x65, 0x7f, 0xa9, 0x86, 0x36, 0x16, 0x64 }}
|
||||
|
||||
#
|
||||
# Protocols defined in Shell2.0
|
||||
#
|
||||
|
|
|
|||
Loading…
Reference in New Issue