NetworkPkg: comments clean up.

[mirror_edk2.git] / NetworkPkg / Dhcp6Dxe / Dhcp6Io.h

/** @file\r
  Dhcp6 internal 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_DHCP6_IO_H__\r
#define __EFI_DHCP6_IO_H__\r
\r
\r
/**\r
  Clean up the specific nodes in the retry list.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]  Scope           The scope of cleanup nodes.\r
\r
**/\r
VOID\r
Dhcp6CleanupRetry (\r
  IN DHCP6_INSTANCE         *Instance,\r
  IN UINT32                 Scope\r
  );\r
\r
/**\r
  Clean up the session of the instance stateful exchange.\r
\r
  @param[in, out]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]       Status          The return status from udp.\r
\r
**/\r
VOID\r
Dhcp6CleanupSession (\r
  IN OUT DHCP6_INSTANCE          *Instance,\r
  IN     EFI_STATUS              Status\r
  );\r
\r
/**\r
  Create the solicit message and send it.\r
\r
  @param[in]  Instance        The pointer to Dhcp6 instance.\r
\r
  @retval EFI_SUCCESS           Create and send the solicit message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval Others                Failed to send the solicit message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendSolicitMsg (\r
  IN DHCP6_INSTANCE         *Instance\r
  );\r
\r
/**\r
  Create the request message and send it.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
\r
  @retval EFI_SUCCESS           Create and send the request message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval EFI_DEVICE_ERROR      An unexpected error.\r
  @retval Others                Failed to send the request message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendRequestMsg (\r
  IN DHCP6_INSTANCE         *Instance\r
  );\r
\r
/**\r
  Create the renew/rebind message and send it.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]  RebindRequest   If TRUE, it is a Rebind type message.\r
                              Otherwise, it is a Renew type message.\r
\r
  @retval EFI_SUCCESS           Create and send the renew/rebind message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval EFI_DEVICE_ERROR      An unexpected error.\r
  @retval Others                Failed to send the renew/rebind message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendRenewRebindMsg (\r
  IN DHCP6_INSTANCE         *Instance,\r
  IN BOOLEAN                RebindRequest\r
  );\r
\r
/**\r
  Create the decline message and send it.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]  DecIa           The pointer to the decline Ia.\r
\r
  @retval EFI_SUCCESS           Create and send the decline message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval EFI_DEVICE_ERROR      An unexpected error.\r
  @retval Others                Failed to send the decline message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendDeclineMsg (\r
  IN DHCP6_INSTANCE            *Instance,\r
  IN EFI_DHCP6_IA              *DecIa\r
  );\r
\r
/**\r
  Create the release message and send it.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]  RelIa           The pointer to the release Ia.\r
\r
  @retval EFI_SUCCESS           Create and send the release message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval EFI_DEVICE_ERROR      An unexpected error.\r
  @retval Others                Failed to send the release message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendReleaseMsg (\r
  IN DHCP6_INSTANCE            *Instance,\r
  IN EFI_DHCP6_IA              *RelIa\r
  );\r
\r
/**\r
  Create the information request message and send it.\r
\r
  @param[in]  Instance        The pointer to the Dhcp6 instance.\r
  @param[in]  InfCb           The pointer to the information request control block.\r
  @param[in]  SendClientId    If TRUE, the client identifier option will be included in\r
                              information request message. Otherwise, the client identifier\r
                              option will not be included.\r
  @param[in]  OptionRequest   The pointer to the option request option.\r
  @param[in]  OptionCount     The number options in the OptionList.\r
  @param[in]  OptionList      The array pointers to the appended options.\r
  @param[in]  Retransmission  The pointer to the retransmission control.\r
\r
  @retval EFI_SUCCESS           Create and send the info-request message successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval Others                Failed to send the info-request message.\r
\r
**/\r
EFI_STATUS\r
Dhcp6SendInfoRequestMsg (\r
  IN DHCP6_INSTANCE            *Instance,\r
  IN DHCP6_INF_CB              *InfCb,\r
  IN BOOLEAN                   SendClientId,\r
  IN EFI_DHCP6_PACKET_OPTION   *OptionRequest,\r
  IN UINT32                    OptionCount,\r
  IN EFI_DHCP6_PACKET_OPTION   *OptionList[],\r
  IN EFI_DHCP6_RETRANSMISSION  *Retransmission\r
  );\r
\r
/**\r
  The receive callback function for the Dhcp6 exchange process.\r
\r
  @param[in]  Udp6Wrap        The pointer to the received net buffer.\r
  @param[in]  EndPoint        The pointer to the udp end point.\r
  @param[in]  IoStatus        The return status from udp io.\r
  @param[in]  Context         The opaque parameter to the function.\r
\r
**/\r
VOID\r
EFIAPI\r
Dhcp6ReceivePacket (\r
  IN NET_BUF                *Udp6Wrap,\r
  IN UDP_END_POINT          *EndPoint,\r
  IN EFI_STATUS             IoStatus,\r
  IN VOID                   *Context\r
  );\r
\r
/**\r
  The timer routine of the Dhcp6 instance for each second.\r
\r
  @param[in]  Event           The timer event.\r
  @param[in]  Context         The opaque parameter to the function.\r
\r
**/\r
VOID\r
EFIAPI\r
Dhcp6OnTimerTick (\r
  IN EFI_EVENT              Event,\r
  IN VOID                   *Context\r
  );\r
\r
#endif\r