mirror of https://github.com/acidanthera/audk.git
158 lines
4.7 KiB
C
158 lines
4.7 KiB
C
/** @file
|
|
Routines used to operate the Ip4 configure variable.
|
|
|
|
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at<BR>
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _NIC_IP4_VARIABLE_H_
|
|
#define _NIC_IP4_VARIABLE_H_
|
|
|
|
#include <Uefi.h>
|
|
|
|
#include <Guid/NicIp4ConfigNvData.h>
|
|
|
|
#include <Library/NetLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/BaseMemoryLib.h>
|
|
#include <Library/MemoryAllocationLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/UefiRuntimeServicesTableLib.h>
|
|
|
|
///
|
|
/// IP4_CONFIG_VARIABLE is the EFI variable to
|
|
/// save the configuration. IP4_CONFIG_VARIABLE is
|
|
/// of variable length.
|
|
///
|
|
typedef struct {
|
|
UINT32 Len; ///< Total length of the variable
|
|
UINT16 CheckSum; ///< CheckSum, the same as IP4 head checksum
|
|
UINT32 Count; ///< Number of NIC_IP4_CONFIG_INFO follows
|
|
NIC_IP4_CONFIG_INFO ConfigInfo;
|
|
} IP4_CONFIG_VARIABLE;
|
|
|
|
//
|
|
// Return the size of NIC_IP4_CONFIG_INFO and EFI_IP4_IPCONFIG_DATA.
|
|
// They are of variable size
|
|
//
|
|
#define SIZEOF_IP4_CONFIG_INFO(Ip4Config) \
|
|
(sizeof (EFI_IP4_IPCONFIG_DATA) + \
|
|
sizeof (EFI_IP4_ROUTE_TABLE) * (Ip4Config)->RouteTableSize)
|
|
|
|
#define SIZEOF_NIC_IP4_CONFIG_INFO(NicConfig) \
|
|
(sizeof (NIC_IP4_CONFIG_INFO) + \
|
|
sizeof (EFI_IP4_ROUTE_TABLE) * (NicConfig)->Ip4Info.RouteTableSize)
|
|
|
|
//
|
|
// Compare whether two NIC address are equal includes their type and length.
|
|
//
|
|
#define NIC_ADDR_EQUAL(Nic1, Nic2) \
|
|
(((Nic1)->Type == (Nic2)->Type) && ((Nic1)->Len == (Nic2)->Len) && \
|
|
NET_MAC_EQUAL (&(Nic1)->MacAddr, &(Nic2)->MacAddr, (Nic1)->Len))
|
|
|
|
/**
|
|
Check whether the configure parameter is valid.
|
|
|
|
@param NicConfig The configure parameter to check
|
|
|
|
@return TRUE if the parameter is valid for the interface, otherwise FALSE.
|
|
|
|
**/
|
|
BOOLEAN
|
|
Ip4ConfigIsValid (
|
|
IN NIC_IP4_CONFIG_INFO *NicConfig
|
|
);
|
|
|
|
/**
|
|
Read the ip4 configure variable from the EFI variable.
|
|
|
|
None
|
|
|
|
@return The IP4 configure read if it is there and is valid, otherwise NULL
|
|
|
|
**/
|
|
IP4_CONFIG_VARIABLE *
|
|
Ip4ConfigReadVariable (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Write the IP4 configure variable to the NVRAM. If Config
|
|
is NULL, remove the variable.
|
|
|
|
@param Config The IP4 configure data to write
|
|
|
|
@retval EFI_SUCCESS The variable is written to the NVRam
|
|
@retval Others Failed to write the variable.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
Ip4ConfigWriteVariable (
|
|
IN IP4_CONFIG_VARIABLE *Config OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Locate the IP4 configure parameters from the variable.If a
|
|
configuration is found, copy it to a newly allocated block
|
|
of memory to avoid the alignment problem. Caller should
|
|
release the memory after use.
|
|
|
|
@param Variable The IP4 configure variable to search in
|
|
@param NicAddr The interface address to check
|
|
|
|
@return The point to the NIC's IP4 configure info if it is found
|
|
in the IP4 variable, otherwise NULL.
|
|
|
|
**/
|
|
NIC_IP4_CONFIG_INFO *
|
|
Ip4ConfigFindNicVariable (
|
|
IN IP4_CONFIG_VARIABLE *Variable,
|
|
IN NIC_ADDR *NicAddr
|
|
);
|
|
|
|
/**
|
|
Modify the configuration parameter for the NIC in the variable.
|
|
If Config is NULL, old configuration will be remove from the new
|
|
variable. Otherwise, append it or replace the old one.
|
|
|
|
@param Variable The IP4 variable to change
|
|
@param NicAddr The interface to search
|
|
@param Config The new configuration parameter (NULL to remove the old)
|
|
|
|
@return The new IP4_CONFIG_VARIABLE variable if the new variable has at
|
|
least one NIC configure and no EFI_OUT_OF_RESOURCES failure.
|
|
Return NULL either because failed to locate memory for new variable
|
|
or the only NIC configure is removed from the Variable.
|
|
|
|
**/
|
|
IP4_CONFIG_VARIABLE *
|
|
Ip4ConfigModifyVariable (
|
|
IN IP4_CONFIG_VARIABLE *Variable OPTIONAL,
|
|
IN NIC_ADDR *NicAddr,
|
|
IN NIC_IP4_CONFIG_INFO *Config OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Fix the RouteTable pointer in an EFI_IP4_IPCONFIG_DATA structure.
|
|
|
|
The pointer is set to be immediately follow the ConfigData if there're entries
|
|
in the RouteTable. Otherwise it is set to NULL.
|
|
|
|
@param ConfigData The IP4 IP configure data.
|
|
|
|
**/
|
|
VOID
|
|
Ip4ConfigFixRouteTablePointer (
|
|
IN OUT EFI_IP4_IPCONFIG_DATA *ConfigData
|
|
);
|
|
|
|
#endif
|
|
|