]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | The header file of IScsiConfig.c.\r | |
3 | \r | |
4 | Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r | |
5 | All rights reserved. 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 _ISCSI_CONFIG_H_\r | |
16 | #define _ISCSI_CONFIG_H_\r | |
17 | \r | |
18 | #include <Protocol/HiiConfigRouting.h>\r | |
19 | #include <Library/HiiLib.h>\r | |
20 | #include <Library/ExtendedHiiLib.h>\r | |
21 | #include <Library/IfrSupportLib.h>\r | |
22 | #include <Library/ExtendedIfrSupportLib.h>\r | |
23 | #include <Library/DebugLib.h>\r | |
24 | #include <Library/BaseLib.h>\r | |
25 | #include <Library/NetLib.h>\r | |
26 | \r | |
27 | extern UINT8 IScsiConfigDxeBin[];\r | |
28 | extern UINT8 IScsiDxeStrings[];\r | |
29 | \r | |
30 | #define ISCSI_INITATOR_NAME_VAR_NAME L"I_NAME"\r | |
31 | \r | |
32 | #define ISCSI_CONFIG_VAR_ATTR (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)\r | |
33 | \r | |
34 | #define ISCSI_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'f', 'c', 'i')\r | |
35 | \r | |
36 | \r | |
37 | \r | |
38 | /**\r | |
39 | If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r | |
40 | then this macro return a pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r | |
41 | \r | |
42 | If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set, \r | |
43 | The Signature field of the data structure ISCSI_FORM_CALLBACK_INFO \r | |
44 | is compared to TestSignature. If the signatures match, then a pointer \r | |
45 | to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO is returned. \r | |
46 | If the signatures do not match, then DebugAssert() is called with a description \r | |
47 | of "CR has a bad signature" and Callback is returned. \r | |
48 | \r | |
49 | If the data type ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain the field\r | |
50 | specified by Callback, then the module will not compile.\r | |
51 | \r | |
52 | If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature, \r | |
53 | then the module will not compile.\r | |
54 | \r | |
55 | @param Callback Pointer to the specified field within the data \r | |
56 | structure ISCSI_FORM_CALLBACK_INFO.\r | |
57 | @return A pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r | |
58 | @retval Others Some unexpected error happened.\r | |
59 | **/\r | |
60 | \r | |
61 | #define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r | |
62 | CR ( \\r | |
63 | Callback, \\r | |
64 | ISCSI_FORM_CALLBACK_INFO, \\r | |
65 | ConfigAccess, \\r | |
66 | ISCSI_FORM_CALLBACK_INFO_SIGNATURE \\r | |
67 | )\r | |
68 | \r | |
69 | #pragma pack(1)\r | |
70 | \r | |
71 | typedef struct _ISCSI_MAC_INFO {\r | |
72 | EFI_MAC_ADDRESS Mac;\r | |
73 | UINT8 Len;\r | |
74 | } ISCSI_MAC_INFO;\r | |
75 | \r | |
76 | typedef struct _ISCSI_DEVICE_LIST {\r | |
77 | UINT8 NumDevice;\r | |
78 | ISCSI_MAC_INFO MacInfo[1];\r | |
79 | } ISCSI_DEVICE_LIST;\r | |
80 | \r | |
81 | #pragma pack()\r | |
82 | \r | |
83 | typedef struct _ISCSI_CONFIG_FORM_ENTRY {\r | |
84 | LIST_ENTRY Link;\r | |
85 | EFI_HANDLE Controller;\r | |
86 | CHAR16 MacString[95];\r | |
87 | EFI_STRING_ID PortTitleToken;\r | |
88 | EFI_STRING_ID PortTitleHelpToken;\r | |
89 | \r | |
90 | ISCSI_SESSION_CONFIG_NVDATA SessionConfigData;\r | |
91 | ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfigData;\r | |
92 | } ISCSI_CONFIG_FORM_ENTRY;\r | |
93 | \r | |
94 | typedef struct _ISCSI_FORM_CALLBACK_INFO {\r | |
95 | UINTN Signature;\r | |
96 | EFI_HANDLE DriverHandle;\r | |
97 | EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r | |
98 | EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r | |
99 | EFI_HII_CONFIG_ROUTING_PROTOCOL *ConfigRouting;\r | |
100 | UINT16 *KeyList;\r | |
101 | VOID *FormBuffer;\r | |
102 | EFI_HII_HANDLE RegisteredHandle;\r | |
103 | ISCSI_CONFIG_FORM_ENTRY *Current;\r | |
104 | } ISCSI_FORM_CALLBACK_INFO;\r | |
105 | \r | |
106 | /**\r | |
107 | Updates the iSCSI configuration form to add/delete an entry for the iSCSI\r | |
108 | device specified by the Controller.\r | |
109 | \r | |
110 | @param[in] DriverBindingHandle The driverbinding handle.\r | |
111 | @param[in] Controller The controller handle of the iSCSI device.\r | |
112 | @param[in] AddForm Whether to add or delete a form entry.\r | |
113 | \r | |
114 | @retval EFI_SUCCESS The iSCSI configuration form is updated.\r | |
115 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
116 | @retval Others Other errors as indicated.\r | |
117 | **/\r | |
118 | EFI_STATUS\r | |
119 | IScsiConfigUpdateForm (\r | |
120 | IN EFI_HANDLE DriverBindingHandle,\r | |
121 | IN EFI_HANDLE Controller,\r | |
122 | IN BOOLEAN AddForm\r | |
123 | );\r | |
124 | \r | |
125 | /**\r | |
126 | Initialize the iSCSI configuration form.\r | |
127 | \r | |
128 | @param[in] DriverBindingHandle The iSCSI driverbinding handle.\r | |
129 | \r | |
130 | @retval EFI_SUCCESS The iSCSI configuration form is initialized.\r | |
131 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
132 | @retval Others Other errors as indicated.\r | |
133 | **/\r | |
134 | EFI_STATUS\r | |
135 | IScsiConfigFormInit (\r | |
136 | VOID\r | |
137 | );\r | |
138 | \r | |
139 | /**\r | |
140 | Unload the iSCSI configuration form, this includes: delete all the iSCSI\r | |
141 | device configuration entries, uninstall the form callback protocol and\r | |
142 | free the resources used.\r | |
143 | \r | |
144 | @param[in] DriverBindingHandle The iSCSI driverbinding handle.\r | |
145 | \r | |
146 | @retval EFI_SUCCESS The iSCSI configuration form is unloaded.\r | |
147 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
148 | **/\r | |
149 | EFI_STATUS\r | |
150 | IScsiConfigFormUnload (\r | |
151 | IN EFI_HANDLE DriverBindingHandle\r | |
152 | );\r | |
153 | \r | |
154 | #endif\r |