diff options
author | jgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-11 09:23:25 +0000 |
---|---|---|
committer | jgong5 <jgong5@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-11 09:23:25 +0000 |
commit | 96e1079fa412753e42edf293ce28adda88e68a45 (patch) | |
tree | 48415fb13b1773d3d10136799a4781f05990e468 /MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c | |
parent | a8d048d54d683249db6444a208c44dbdfd6dbc09 (diff) | |
download | edk2-96e1079fa412753e42edf293ce28adda88e68a45.zip edk2-96e1079fa412753e42edf293ce28adda88e68a45.tar.gz edk2-96e1079fa412753e42edf293ce28adda88e68a45.tar.bz2 |
Scrubbed more.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6454 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c')
-rw-r--r-- | MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c index a28656c..334bb41 100644 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c +++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c @@ -33,8 +33,8 @@ Abstract: @param Rcvd The option is from the packet we received if TRUE,
otherwise the option we wants to transmit.
- @return TRUE: The option is properly formated
- @return FALSE: The option is mal-formated
+ @retval TRUE The option is properly formatted
+ @retval FALSE The option is mal-formated
**/
BOOLEAN
@@ -74,7 +74,7 @@ Ip4OptionIsValid ( Point = Option[Cur + 2];
//
- // SRR/RR options are formated as |Type|Len|Point|Ip1|Ip2|...
+ // SRR/RR options are formatted as |Type|Len|Point|Ip1|Ip2|...
//
if ((OptionLen - Cur < Len) || (Len < 3) || ((Len - 3) % 4 != 0)) {
IcmpPoint = Cur + 1;
@@ -124,25 +124,25 @@ Ip4OptionIsValid ( Copy the option from the original option to buffer. It
handles the details such as:
1. whether copy the single IP4 option to the first/non-first
- fragments.
- 2. Pad the options copied over to aligened to 4 bytes.
+ fragments.
+ 2. Pad the options copied over to aligned to 4 bytes.
@param Option The original option to copy from
@param OptionLen The length of the original option
@param FirstFragment Whether it is the first fragment
- @param Buf The buffer to copy options to
+ @param Buf The buffer to copy options to. NULL
@param BufLen The length of the buffer
@retval EFI_SUCCESS The options are copied over
- @retval EFI_BUFFER_TOO_SMALL The buffer caller provided is too small.
+ @retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small.
**/
EFI_STATUS
Ip4CopyOption (
- IN UINT8 *Option,
- IN UINT32 OptionLen,
- IN BOOLEAN FirstFragment,
- IN UINT8 *Buf, OPTIONAL
+ IN UINT8 *Option,
+ IN UINT32 OptionLen,
+ IN BOOLEAN FirstFragment,
+ IN OUT UINT8 *Buf, OPTIONAL
IN OUT UINT32 *BufLen
)
{
|