Fix a bug about the iSCSI DHCP dependency issue.

[mirror_edk2.git] / NetworkPkg / Mtftp6Dxe / Mtftp6Option.h

/** @file\r
  Mtftp6 option parse functions declaration.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_MTFTP6_OPTION_H__\r
#define __EFI_MTFTP6_OPTION_H__\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/ServiceBinding.h>\r
\r
#include <Library/NetLib.h>\r
#include <Library/UdpIoLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
\r
#define MTFTP6_SUPPORTED_OPTIONS_NUM  4\r
#define MTFTP6_OPCODE_LEN             2\r
#define MTFTP6_ERRCODE_LEN            2\r
#define MTFTP6_BLKNO_LEN              2\r
#define MTFTP6_DATA_HEAD_LEN          4\r
\r
//\r
// The bit map definition for Mtftp6 extension options.\r
//\r
#define MTFTP6_OPT_BLKSIZE_BIT        0x01\r
#define MTFTP6_OPT_TIMEOUT_BIT        0x02\r
#define MTFTP6_OPT_TSIZE_BIT          0x04\r
#define MTFTP6_OPT_MCAST_BIT          0x08\r
\r
extern CHAR8 *mMtftp6SupportedOptions[MTFTP6_SUPPORTED_OPTIONS_NUM];\r
\r
typedef struct {\r
  UINT16                    BlkSize;\r
  UINT8                     Timeout;\r
  UINT32                    Tsize;\r
  EFI_IPv6_ADDRESS          McastIp;\r
  UINT16                    McastPort;\r
  BOOLEAN                   IsMaster;\r
  UINT32                    BitMap;\r
} MTFTP6_EXT_OPTION_INFO;\r
\r
/**\r
  Parse the Ascii string of multi-cast option.\r
\r
  @param[in]  Str           The pointer to the Ascii string of multi-cast option.\r
  @param[in]  ExtInfo       The pointer to the option information to be filled.\r
\r
  @retval EFI_SUCCESS            Parse the multicast option successfully.\r
  @retval EFI_INVALID_PARAMETER  The string is malformatted.\r
\r
**/\r
EFI_STATUS\r
Mtftp6ParseMcastOption (\r
  IN UINT8                  *Str,\r
  IN MTFTP6_EXT_OPTION_INFO *ExtInfo\r
  );\r
\r
\r
/**\r
  Parse the MTFTP6 extesion options.\r
\r
  @param[in]  Options       The pointer to the extension options list.\r
  @param[in]  Count         The num of the extension options.\r
  @param[in]  IsRequest     If FALSE, the extension options is included\r
                            by a request packet.\r
  @param[in]  ExtInfo       The pointer to the option information to be filled.\r
\r
  @retval EFI_SUCCESS            Parse the multi-cast option successfully.\r
  @retval EFI_INVALID_PARAMETER  An option is malformatted.\r
  @retval EFI_UNSUPPORTED        An option is not supported.\r
\r
**/\r
EFI_STATUS\r
Mtftp6ParseExtensionOption (\r
  IN EFI_MTFTP6_OPTION        *Options,\r
  IN UINT32                   Count,\r
  IN BOOLEAN                  IsRequest,\r
  IN MTFTP6_EXT_OPTION_INFO   *ExtInfo\r
  );\r
\r
\r
/**\r
  Go through the packet to fill the options array with the start\r
  addresses of each MTFTP option name/value pair.\r
\r
  @param[in]      Packet                 The packet to be checked.\r
  @param[in]      PacketLen              The length of the packet.\r
  @param[in, out] Count                  The num of the Options on input.\r
                                         The actual one on output.\r
  @param[in]      Options                The option array to be filled\r
                                         it's optional.\r
\r
  @retval EFI_SUCCESS            The packet has been parsed successfully.\r
  @retval EFI_INVALID_PARAMETER  The packet is malformatted\r
  @retval EFI_BUFFER_TOO_SMALL   The Options array is too small\r
  @retval EFI_PROTOCOL_ERROR     An unexpected MTFTPv6 packet was received.\r
\r
**/\r
EFI_STATUS\r
Mtftp6ParsePacketOption (\r
  IN     EFI_MTFTP6_PACKET     *Packet,\r
  IN     UINT32                PacketLen,\r
  IN OUT UINT32                *Count,\r
  IN     EFI_MTFTP6_OPTION     *Options          OPTIONAL\r
  );\r
\r
\r
/**\r
  Go through the packet, generate option list array and fill it\r
  by the result of parse options.\r
\r
  @param[in]      Packet                 The packet to be checked.\r
  @param[in]      PacketLen              The length of the packet.\r
  @param[in, out] OptionCount            The num of the Options on input.\r
                                         The actual one on output.\r
  @param[out]     OptionList             The option list array to be generated\r
                                         and filled. It is optional.\r
\r
  @retval EFI_SUCCESS            The packet has been parsed successfully.\r
  @retval EFI_INVALID_PARAMETER  The packet is malformatted.\r
  @retval EFI_PROTOCOL_ERROR     An option is malformatted.\r
  @retval EFI_NOT_FOUND          The packet has no options.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory for the array.\r
  @retval EFI_BUFFER_TOO_SMALL   The size of option list array is too small.\r
\r
**/\r
EFI_STATUS\r
Mtftp6ParseStart (\r
  IN     EFI_MTFTP6_PACKET      *Packet,\r
  IN     UINT32                 PacketLen,\r
  IN OUT UINT32                 *OptionCount,\r
     OUT EFI_MTFTP6_OPTION      **OptionList          OPTIONAL\r
  );\r
\r
#endif\r