]>
Commit | Line | Data |
---|---|---|
4b738c76 HT |
1 | /** @file\r |
2 | Header file for EFI_DISK_INFO_PROTOCOL interface.\r | |
3 | \r | |
4 | Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r | |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
4b738c76 HT |
6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _NVME_DISKINFO_H_\r | |
10 | #define _NVME_DISKINFO_H_\r | |
11 | \r | |
12 | /**\r | |
13 | Initialize the installation of DiskInfo protocol.\r | |
14 | \r | |
15 | This function prepares for the installation of DiskInfo protocol on the child handle.\r | |
16 | By default, it installs DiskInfo protocol with NVME interface GUID.\r | |
17 | \r | |
18 | @param[in] Device The pointer of NVME_DEVICE_PRIVATE_DATA.\r | |
19 | \r | |
20 | **/\r | |
21 | VOID\r | |
22 | InitializeDiskInfo (\r | |
1436aea4 | 23 | IN NVME_DEVICE_PRIVATE_DATA *Device\r |
4b738c76 HT |
24 | );\r |
25 | \r | |
4b738c76 HT |
26 | /**\r |
27 | Provides inquiry information for the controller type.\r | |
28 | \r | |
29 | This function is used to get inquiry data. Data format\r | |
30 | of Identify data is defined by the Interface GUID.\r | |
31 | \r | |
32 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
33 | @param[in, out] InquiryData Pointer to a buffer for the inquiry data.\r | |
34 | @param[in, out] InquiryDataSize Pointer to the value for the inquiry data size.\r | |
35 | \r | |
36 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
37 | @retval EFI_NOT_FOUND Device does not support this data class\r | |
38 | @retval EFI_DEVICE_ERROR Error reading InquiryData from device\r | |
39 | @retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough\r | |
40 | \r | |
41 | **/\r | |
42 | EFI_STATUS\r | |
43 | EFIAPI\r | |
44 | NvmExpressDiskInfoInquiry (\r | |
1436aea4 MK |
45 | IN EFI_DISK_INFO_PROTOCOL *This,\r |
46 | IN OUT VOID *InquiryData,\r | |
47 | IN OUT UINT32 *InquiryDataSize\r | |
4b738c76 HT |
48 | );\r |
49 | \r | |
50 | /**\r | |
51 | Provides identify information for the controller type.\r | |
52 | \r | |
53 | This function is used to get identify data. Data format\r | |
54 | of Identify data is defined by the Interface GUID.\r | |
55 | \r | |
56 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL\r | |
57 | instance.\r | |
58 | @param[in, out] IdentifyData Pointer to a buffer for the identify data.\r | |
59 | @param[in, out] IdentifyDataSize Pointer to the value for the identify data\r | |
60 | size.\r | |
61 | \r | |
62 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
63 | @retval EFI_NOT_FOUND Device does not support this data class\r | |
64 | @retval EFI_DEVICE_ERROR Error reading IdentifyData from device\r | |
65 | @retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough\r | |
66 | \r | |
67 | **/\r | |
68 | EFI_STATUS\r | |
69 | EFIAPI\r | |
70 | NvmExpressDiskInfoIdentify (\r | |
1436aea4 MK |
71 | IN EFI_DISK_INFO_PROTOCOL *This,\r |
72 | IN OUT VOID *IdentifyData,\r | |
73 | IN OUT UINT32 *IdentifyDataSize\r | |
4b738c76 HT |
74 | );\r |
75 | \r | |
76 | /**\r | |
77 | Provides sense data information for the controller type.\r | |
78 | \r | |
79 | This function is used to get sense data.\r | |
80 | Data format of Sense data is defined by the Interface GUID.\r | |
81 | \r | |
82 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
83 | @param[in, out] SenseData Pointer to the SenseData.\r | |
84 | @param[in, out] SenseDataSize Size of SenseData in bytes.\r | |
85 | @param[out] SenseDataNumber Pointer to the value for the sense data size.\r | |
86 | \r | |
87 | @retval EFI_SUCCESS The command was accepted without any errors.\r | |
88 | @retval EFI_NOT_FOUND Device does not support this data class.\r | |
89 | @retval EFI_DEVICE_ERROR Error reading SenseData from device.\r | |
90 | @retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.\r | |
91 | \r | |
92 | **/\r | |
93 | EFI_STATUS\r | |
94 | EFIAPI\r | |
95 | NvmExpressDiskInfoSenseData (\r | |
1436aea4 MK |
96 | IN EFI_DISK_INFO_PROTOCOL *This,\r |
97 | IN OUT VOID *SenseData,\r | |
98 | IN OUT UINT32 *SenseDataSize,\r | |
99 | OUT UINT8 *SenseDataNumber\r | |
4b738c76 HT |
100 | );\r |
101 | \r | |
4b738c76 HT |
102 | /**\r |
103 | This function is used to get controller information.\r | |
104 | \r | |
105 | @param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.\r | |
106 | @param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.\r | |
107 | @param[out] IdeDevice Pointer to the Ide Device number. Master or slave.\r | |
108 | \r | |
109 | @retval EFI_SUCCESS IdeChannel and IdeDevice are valid.\r | |
110 | @retval EFI_UNSUPPORTED This is not an IDE device.\r | |
111 | \r | |
112 | **/\r | |
113 | EFI_STATUS\r | |
114 | EFIAPI\r | |
115 | NvmExpressDiskInfoWhichIde (\r | |
1436aea4 MK |
116 | IN EFI_DISK_INFO_PROTOCOL *This,\r |
117 | OUT UINT32 *IdeChannel,\r | |
118 | OUT UINT32 *IdeDevice\r | |
4b738c76 HT |
119 | );\r |
120 | \r | |
121 | #endif\r |