diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-19 13:36:34 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-19 13:36:34 +0000 |
| commit | 7064c0a5aa3eabe99be9c143e4abaa73d7139609 (patch) | |
| tree | 295d15f5c84138519bdaf9182e59e0feff774fee /MdeModulePkg/Universal/DriverSampleDxe | |
| parent | a3a70b6ac1be0138b3c264284b110480b0bb88cc (diff) | |
| download | edk2-7064c0a5aa3eabe99be9c143e4abaa73d7139609.tar.gz edk2-7064c0a5aa3eabe99be9c143e4abaa73d7139609.tar.bz2 edk2-7064c0a5aa3eabe99be9c143e4abaa73d7139609.zip | |
ECC Cleanup: Update Doxygen comment
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6633 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/DriverSampleDxe')
| -rw-r--r-- | MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c | 43 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h | 4 | ||||
| -rw-r--r-- | MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h | 4 |
3 files changed, 43 insertions, 8 deletions
diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c index 7199566b93..9e82009e82 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c +++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c @@ -29,6 +29,13 @@ EFI_GUID mInventoryGuid = INVENTORY_GUID; CHAR16 VariableName[] = L"MyIfrNVData";
+/**
+ Encode the password using a simple algorithm.
+
+ @param Password The string to be encoded.
+ @param MaxSize The size of the string.
+
+**/
VOID
EncodePassword (
IN CHAR16 *Password,
@@ -56,10 +63,19 @@ EncodePassword ( return ;
}
+/**
+ Validate the user's password.
+
+ @param PrivateData This driver's private context data.
+ @param StringId The user's input.
+
+ @retval EFI_SUCCESS The user's input matches the password.
+ @retval EFI_NOT_READY The user's input does not match the password.
+**/
EFI_STATUS
ValidatePassword (
- DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
- EFI_STRING_ID StringId
+ IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
+ IN EFI_STRING_ID StringId
)
{
EFI_STATUS Status;
@@ -138,10 +154,20 @@ ValidatePassword ( return Status;
}
+/**
+ Encode the password using a simple algorithm.
+
+ @param PrivateData This driver's private context data.
+ @param StringId The password from User.
+
+ @retval EFI_SUCESS The operation is successful.
+ @return Other value if gRT->SetVariable () fails.
+
+**/
EFI_STATUS
SetPassword (
- DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
- EFI_STRING_ID StringId
+ IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,
+ IN EFI_STRING_ID StringId
)
{
EFI_STATUS Status;
@@ -646,6 +672,15 @@ DriverCallback ( return Status;
}
+/**
+ Main entry for this driver.
+
+ @param ImageHandle Image handle this driver.
+ @param SystemTable Pointer to SystemTable.
+
+ @retval EFI_SUCESS This function always complete successfully.
+
+**/
EFI_STATUS
EFIAPI
DriverSampleInit (
diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h index 1489da22ed..8c20cf26ba 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h +++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h @@ -21,8 +21,8 @@ Revision History **/
-#ifndef _DRIVER_SAMPLE_H
-#define _DRIVER_SAMPLE_H
+#ifndef _DRIVER_SAMPLE_H_
+#define _DRIVER_SAMPLE_H_
#include <Uefi.h>
diff --git a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h index 453e474b67..4fbd6a5650 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h +++ b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h @@ -22,8 +22,8 @@ Revision History: **/
-#ifndef _NVDATASTRUC_H
-#define _NVDATASTRUC_H
+#ifndef _NVDATASTRUC_H_
+#define _NVDATASTRUC_H_
#define FORMSET_GUID \
{ \
|