]>
Commit | Line | Data |
---|---|---|
19b2cb5c HW |
1 | /** @file\r |
2 | Header file for EFI_DISK_INFO_PROTOCOL interface on EMMC devices.\r | |
3 | \r | |
4 | Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _EMMC_DISKINFO_H_\r | |
16 | #define _EMMC_DISKINFO_H_\r | |
17 | \r | |
18 | /**\r | |
19 | Provides inquiry information for the controller type.\r | |
20 | \r | |
21 | This function is used by the driver entity to get inquiry data. Data format of\r | |
22 | Identify data is defined by the Interface GUID.\r | |
23 | \r | |
24 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
25 | @param[in,out] InquiryData Pointer to a buffer for the inquiry data.\r | |
26 | @param[in,out] InquiryDataSize Pointer to the value for the inquiry data size.\r | |
27 | \r | |
28 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
29 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
30 | @retval EFI_DEVICE_ERROR Error reading InquiryData from device.\r | |
31 | @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough.\r | |
32 | \r | |
33 | **/\r | |
34 | EFI_STATUS\r | |
35 | EFIAPI\r | |
36 | EmmcDiskInfoInquiry (\r | |
37 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
38 | IN OUT VOID *InquiryData,\r | |
39 | IN OUT UINT32 *InquiryDataSize\r | |
40 | );\r | |
41 | \r | |
42 | /**\r | |
43 | Provides identify information for the controller type.\r | |
44 | \r | |
45 | This function is used by the driver entity to get identify data. Data format\r | |
46 | of Identify data is defined by the Interface GUID.\r | |
47 | \r | |
48 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL\r | |
49 | instance.\r | |
50 | @param[in,out] IdentifyData Pointer to a buffer for the identify data.\r | |
51 | @param[in,out] IdentifyDataSize Pointer to the value for the identify data\r | |
52 | size.\r | |
53 | \r | |
54 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
55 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
56 | @retval EFI_DEVICE_ERROR Error reading IdentifyData from device.\r | |
57 | @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough.\r | |
58 | \r | |
59 | **/\r | |
60 | EFI_STATUS\r | |
61 | EFIAPI\r | |
62 | EmmcDiskInfoIdentify (\r | |
63 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
64 | IN OUT VOID *IdentifyData,\r | |
65 | IN OUT UINT32 *IdentifyDataSize\r | |
66 | );\r | |
67 | \r | |
68 | /**\r | |
69 | Provides sense data information for the controller type.\r | |
70 | \r | |
71 | This function is used by the driver entity to get sense data. Data format of\r | |
72 | Sense data is defined by the Interface GUID.\r | |
73 | \r | |
74 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
75 | @param[in,out] SenseData Pointer to the SenseData.\r | |
76 | @param[in,out] SenseDataSize Size of SenseData in bytes.\r | |
77 | @param[out] SenseDataNumber Pointer to the value for the sense data size.\r | |
78 | \r | |
79 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
80 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
81 | @retval EFI_DEVICE_ERROR Error reading SenseData from device.\r | |
82 | @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.\r | |
83 | \r | |
84 | **/\r | |
85 | EFI_STATUS\r | |
86 | EFIAPI\r | |
87 | EmmcDiskInfoSenseData (\r | |
88 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
89 | IN OUT VOID *SenseData,\r | |
90 | IN OUT UINT32 *SenseDataSize,\r | |
91 | OUT UINT8 *SenseDataNumber\r | |
92 | );\r | |
93 | \r | |
94 | /**\r | |
95 | Provides IDE channel and device information for the interface.\r | |
96 | \r | |
97 | This function is used by the driver entity to get controller information.\r | |
98 | \r | |
99 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
100 | @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r | |
101 | @param[out] IdeDevice Pointer to the Ide Device number. Master or slave.\r | |
102 | \r | |
103 | @retval EFI_SUCCESS IdeChannel and IdeDevice are valid.\r | |
104 | @retval EFI_UNSUPPORTED This is not an IDE device.\r | |
105 | \r | |
106 | **/\r | |
107 | EFI_STATUS\r | |
108 | EFIAPI\r | |
109 | EmmcDiskInfoWhichIde (\r | |
110 | IN EFI_DISK_INFO_PROTOCOL *This,\r | |
111 | OUT UINT32 *IdeChannel,\r | |
112 | OUT UINT32 *IdeDevice\r | |
113 | );\r | |
114 | \r | |
115 | #endif\r |