fixed typo.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4ConfigDxe / Ip4ConfigNv.h

/** @file\r
  The header file of IP4ConfigNv.c\r
\r
Copyright (c) 2009, Intel Corporation.<BR>\r
All rights reserved. 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 _IP4_CONFIGNV_H_\r
#define _IP4_CONFIGNV_H_\r
\r
#include "Ip4Config.h"\r
#include "Ip4NvData.h"\r
\r
extern UINT8  Ip4ConfigDxeBin[];\r
extern UINT8  Ip4ConfigDxeStrings[];\r
\r
#define NIC_ITEM_CONFIG_SIZE   sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * 2\r
\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH             VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
/**\r
  Updates the network configuration form to add/delete an entry for the network\r
  device specified by the Instance.\r
\r
  @param[in]  Instance            The IP4 Config instance.\r
  @param[in]  AddForm             Whether to add or delete a form entry.\r
\r
  @retval EFI_SUCCESS             The network configuration form is updated.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
  @retval Others                  Other errors as indicated.\r
**/\r
EFI_STATUS\r
Ip4ConfigUpdateForm (\r
  IN IP4_CONFIG_INSTANCE                   *Instance,\r
  IN BOOLEAN     AddForm\r
  );\r
\r
/**\r
  Install HII Config Access protocol for network device and allocate resource.\r
\r
  @param[in]  Instance            The IP4 Config instance.\r
\r
  @retval EFI_SUCCESS              The HII Config Access protocol is installed.\r
  @retval EFI_OUT_OF_RESOURCES     Failed to allocate memory.\r
  @retval Others                   Other errors as indicated.\r
**/\r
EFI_STATUS\r
Ip4ConfigDeviceInit (\r
    IN IP4_CONFIG_INSTANCE                   *Instance\r
  );\r
\r
/**\r
  Uninstall HII Config Access protocol for network device and free resource.\r
\r
  @param[in]  Instance            The IP4 Config instance.\r
\r
  @retval EFI_SUCCESS             The HII Config Access protocol is uninstalled.\r
  @retval Others                  Other errors as indicated.\r
**/\r
EFI_STATUS\r
Ip4ConfigDeviceUnload (\r
    IN IP4_CONFIG_INSTANCE                   *Instance\r
  );\r
\r
/**\r
  Initialize the network configuration form, this includes: delete all the network\r
  device configuration entries, install the form callback protocol and\r
  allocate the resources used.\r
\r
  @retval EFI_SUCCESS             The network configuration form is unloaded.\r
  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
**/\r
EFI_STATUS\r
Ip4ConfigFormInit (\r
    VOID\r
  );\r
\r
/**\r
  Unload the network configuration form, this includes: delete all the network\r
  device configuration entries, uninstall the form callback protocol and\r
  free the resources used.\r
\r
  @retval EFI_SUCCESS             The network configuration form is unloaded.\r
**/\r
EFI_STATUS\r
Ip4ConfigFormUnload (\r
  VOID\r
  );\r
\r
#endif\r