summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
diff options
context:
space:
mode:
authorywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-12 07:03:44 +0000
committerywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-12 07:03:44 +0000
commit963dbb30018c6420a9b27778e05e5eed74b23173 (patch)
treef8fc28301f368c56cac36b8b2d7bd48b53f02bcc /MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
parent96dcf1973f975ece358d8d70523a976ea218a962 (diff)
downloadedk2-963dbb30018c6420a9b27778e05e5eed74b23173.zip
edk2-963dbb30018c6420a9b27778e05e5eed74b23173.tar.gz
edk2-963dbb30018c6420a9b27778e05e5eed74b23173.tar.bz2
1)update function header coding style issue
change Some unexpected error happened. to Other errors as indicated. 2) delete unused parameter in IScsiConfigFormInit() 3) correct IN OUT mistake in IScsiSessionInit () 4)roll back one update for Piece of code in IScsiDhcp.c around line 99 on FieldIndex git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7013 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h')
-rw-r--r--MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h31
1 files changed, 28 insertions, 3 deletions
diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
index e4f2645..eb6e0e3 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
@@ -32,6 +32,31 @@ extern UINT8 IScsiDxeStrings[];
#define ISCSI_FORM_CALLBACK_INFO_SIGNATURE EFI_SIGNATURE_32 ('I', 'f', 'c', 'i')
+
+
+/**
+ If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear,
+ then this macro return a pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
+
+ If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,
+ The Signature field of the data structure ISCSI_FORM_CALLBACK_INFO
+ is compared to TestSignature. If the signatures match, then a pointer
+ to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO is returned.
+ If the signatures do not match, then DebugAssert() is called with a description
+ of "CR has a bad signature" and Callback is returned.
+
+ If the data type ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain the field
+ specified by Callback, then the module will not compile.
+
+ If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature,
+ then the module will not compile.
+
+ @param Callback Pointer to the specified field within the data
+ structure ISCSI_FORM_CALLBACK_INFO.
+ @return a pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
+ @return Others Some unexpected error happened.
+**/
+
#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \
CR ( \
Callback, \
@@ -87,7 +112,7 @@ typedef struct _ISCSI_FORM_CALLBACK_INFO {
@retval EFI_SUCCESS The iSCSI configuration form is updated.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
- @retval Others Some unexpected errors happened.
+ @retval Others Other errors as indicated.
**/
EFI_STATUS
IScsiConfigUpdateForm (
@@ -103,11 +128,11 @@ IScsiConfigUpdateForm (
@retval EFI_SUCCESS The iSCSI configuration form is initialized.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
- @retval Others Some unexpected error happened.
+ @retval Others Other errors as indicated.
**/
EFI_STATUS
IScsiConfigFormInit (
- IN EFI_HANDLE DriverBindingHandle
+ VOID
);
/**