Update for NetworkPkg.

[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6Option.h

/** @file\r
  Definition of IP6 option process routines.\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_IP6_OPTION_H__\r
#define __EFI_IP6_OPTION_H__\r
\r
#define IP6_FRAGMENT_OFFSET_MASK (~0x3)\r
\r
typedef struct _IP6_FRAGMENT_HEADER {\r
  UINT8                     NextHeader;\r
  UINT8                     Reserved;\r
  UINT16                    FragmentOffset;\r
  UINT32                    Identification;\r
} IP6_FRAGMENT_HEADER;\r
\r
typedef struct _IP6_ROUTING_HEADER {\r
  UINT8                     NextHeader;\r
  UINT8                     HeaderLen;\r
  UINT8                     RoutingType;\r
  UINT8                     SegmentsLeft;\r
} IP6_ROUTING_HEADER;\r
\r
typedef enum {\r
  Ip6OptionPad1             = 0,\r
  Ip6OptionPadN             = 1,\r
  Ip6OptionRouterAlert      = 5,\r
  Ip6OptionSkip             = 0,\r
  Ip6OptionDiscard          = 0x40,\r
  Ip6OptionParameterProblem = 0x80,\r
  Ip6OptionMask             = 0xc0,\r
\r
  Ip6OptionEtherSource      = 1,\r
  Ip6OptionEtherTarget      = 2,\r
  Ip6OptionPrefixInfo       = 3,\r
  Ip6OptionRedirected       = 4,\r
  Ip6OptionMtu              = 5\r
} IP6_OPTION_TYPE;\r
\r
/**\r
  Validate the IP6 extension header format for both the packets we received\r
  and that we will transmit. It will compute the ICMPv6 error message fields\r
  if the option is mal-formated.\r
\r
  @param[in]  IpSb          The IP6 service instance. This is an optional parameter.\r
  @param[in]  Packet        The data of the packet. Ignored if NULL.\r
  @param[in]  NextHeader    The next header field in IPv6 basic header.\r
  @param[in]  ExtHdrs       The first byte of the option.\r
  @param[in]  ExtHdrsLen    The length of the whole option.\r
  @param[in]  Rcvd          The option is from the packet we received if TRUE,\r
                            otherwise, the option we want to transmit.\r
  @param[out] FormerHeader  The offset of NextHeader which points to Fragment\r
                            Header when we received, of the ExtHdrs.\r
                            Ignored if we transmit.\r
  @param[out] LastHeader    The pointer of NextHeader of the last extension\r
                            header processed by IP6.\r
  @param[out] RealExtsLen   The length of extension headers processed by IP6 layer.\r
                            This is an optional parameter that may be NULL.\r
  @param[out] UnFragmentLen The length of unfragmented length of extension headers.\r
                            This is an optional parameter that may be NULL.\r
  @param[out] Fragmented    Indicate whether the packet is fragmented.\r
                            This is an optional parameter that may be NULL.\r
\r
  @retval     TRUE          The option is properly formated.\r
  @retval     FALSE         The option is malformated.\r
\r
**/\r
BOOLEAN\r
Ip6IsExtsValid (\r
  IN IP6_SERVICE            *IpSb           OPTIONAL,\r
  IN NET_BUF                *Packet         OPTIONAL,\r
  IN UINT8                  *NextHeader,\r
  IN UINT8                  *ExtHdrs,\r
  IN UINT32                 ExtHdrsLen,\r
  IN BOOLEAN                Rcvd,\r
  OUT UINT32                *FormerHeader   OPTIONAL,\r
  OUT UINT8                 **LastHeader,\r
  OUT UINT32                *RealExtsLen    OPTIONAL,\r
  OUT UINT32                *UnFragmentLen  OPTIONAL,\r
  OUT BOOLEAN               *Fragmented     OPTIONAL\r
  );\r
\r
/**\r
  Generate an IPv6 router alert option in network order and output it through Buffer.\r
\r
  @param[out]     Buffer         Points to a buffer to record the generated option.\r
  @param[in, out] BufferLen      The length of Buffer, in bytes.\r
  @param[in]      NextHeader     The 8-bit selector indicates the type of header\r
                                 immediately following the Hop-by-Hop Options header.\r
\r
  @retval EFI_BUFFER_TOO_SMALL   The Buffer is too small to contain the generated\r
                                 option. BufferLen is updated for the required size.\r
\r
  @retval EFI_SUCCESS            The option is generated and filled in to Buffer.\r
\r
**/\r
EFI_STATUS\r
Ip6FillHopByHop (\r
  OUT UINT8                  *Buffer,\r
  IN OUT UINTN               *BufferLen,\r
  IN UINT8                   NextHeader\r
  );\r
\r
/**\r
  Insert a Fragment Header to the Extension headers and output it in UpdatedExtHdrs.\r
\r
  @param[in]  IpSb             The IP6 service instance to transmit the packet.\r
  @param[in]  NextHeader       The extension header type of first extension header.\r
  @param[in]  LastHeader       The extension header type of last extension header.\r
  @param[in]  ExtHdrs          The length of the original extension header.\r
  @param[in]  ExtHdrsLen       The length of the extension headers.\r
  @param[in]  FragmentOffset   The fragment offset of the data following the header.\r
  @param[out] UpdatedExtHdrs   The updated ExtHdrs with Fragment header inserted.\r
                               It's caller's responsiblity to free this buffer.\r
\r
  @retval EFI_OUT_OF_RESOURCES Failed to finish the operation due to lake of\r
                               resource.\r
  @retval EFI_UNSUPPORTED      The extension header specified in ExtHdrs is not\r
                               supported currently.\r
  @retval EFI_SUCCESS          The operation performed successfully.\r
\r
**/\r
EFI_STATUS\r
Ip6FillFragmentHeader (\r
  IN  IP6_SERVICE           *IpSb,\r
  IN  UINT8                 NextHeader,\r
  IN  UINT8                 LastHeader,\r
  IN  UINT8                 *ExtHdrs,\r
  IN  UINT32                ExtHdrsLen,\r
  IN  UINT16                FragmentOffset,\r
  OUT UINT8                 **UpdatedExtHdrs\r
  );\r
\r
/**\r
  Copy the extension headers from the original to buffer. A Fragment header is\r
  appended to the end.\r
\r
  @param[in]       NextHeader       The 8-bit selector indicates the type of\r
                                    the fragment header's next header.\r
  @param[in]       ExtHdrs          The length of the original extension header.\r
  @param[in]       LastHeader       The pointer of next header of last extension header.\r
  @param[in]       FragmentOffset   The fragment offset of the data following the header.\r
  @param[in]       UnFragmentHdrLen The length of unfragmented length of extension headers.\r
  @param[in, out]  Buf              The buffer to copy options to.\r
  @param[in, out]  BufLen           The length of the buffer.\r
\r
  @retval EFI_SUCCESS           The options are copied over.\r
  @retval EFI_BUFFER_TOO_SMALL  The buffer caller provided is too small.\r
\r
**/\r
EFI_STATUS\r
Ip6CopyExts (\r
  IN UINT8                  NextHeader,\r
  IN UINT8                  *ExtHdrs,\r
  IN UINT8                  *LastHeader,\r
  IN UINT16                 FragmentOffset,\r
  IN UINT32                 UnFragmentHdrLen,\r
  IN OUT UINT8              *Buf,\r
  IN OUT UINT32             *BufLen\r
  );\r
\r
/**\r
  Validate the IP6 option format for both the packets we received\r
  and that we will transmit. It supports the defined options in Neighbor\r
  Discovery messages.\r
\r
  @param[in]  Option            The first byte of the option.\r
  @param[in]  OptionLen         The length of the whole option.\r
\r
  @retval TRUE     The option is properly formatted.\r
  @retval FALSE    The option is malformated.\r
\r
**/\r
BOOLEAN\r
Ip6IsNDOptionValid (\r
  IN UINT8                  *Option,\r
  IN UINT16                 OptionLen\r
  );\r
\r
#endif\r