X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=NetworkPkg%2FIpSecDxe%2FIkeService.h;h=cc21154ac6227cf72d0ceed7d5d34fbb0a388c3f;hb=d40002bab9958da3439a2548aa3003d8d68672ff;hp=cbd58cc08042bae365437de4a8c401e9ec62ad82;hpb=9166f840d2a70b924b0ff66528f056515443e4e8;p=mirror_edk2.git diff --git a/NetworkPkg/IpSecDxe/IkeService.h b/NetworkPkg/IpSecDxe/IkeService.h index cbd58cc080..cc21154ac6 100644 --- a/NetworkPkg/IpSecDxe/IkeService.h +++ b/NetworkPkg/IpSecDxe/IkeService.h @@ -1,7 +1,7 @@ /** @file Prototypes definitions of IKE service. - - Copyright (c) 2010, Intel Corporation. All rights reserved.
+ + Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License @@ -44,7 +44,7 @@ EFI_STATUS ); /** - This is prototype definition fo general interface to start a IKE negotiation at Quick Mode. + This is prototype definition fo general interface to start a IKE negotiation at Quick Mode. This function will be called when the related IKE SA is existed and start to create a Child SA. @@ -81,7 +81,7 @@ EFI_STATUS ); /** - This is prototype definition of the general interface when recived a IKE Pakcet + This is prototype definition of the general interface when recived a IKE Pakcet for the IKE SA establishing. @param[in] UdpService Point to UDP service used to send IKE Packet. @@ -97,8 +97,8 @@ VOID /** This is prototyp definition of the general interface when recived a IKE Packet - xfor the Child SA establishing. - + xfor the Child SA establishing. + @param[in] UdpService Point to UDP service used to send IKE packet. @param[in] IkePacket Point to received IKE packet. @@ -111,7 +111,7 @@ VOID ); /** - This is prototype definition of the general interface when received a IKE + This is prototype definition of the general interface when received a IKE information Packet. @param[in] UdpService Point to UDP service used to send IKE packet. @@ -137,16 +137,16 @@ typedef struct _IKE_EXCHANGE_INTERFACE { /** Open and configure a UDPIO of Udp4 for IKE packet receiving. - - This function is called at the IPsecDriverBinding start. IPsec create a UDP4 and + + This function is called at the IPsecDriverBinding start. IPsec create a UDP4 and a UDP4 IO for each NIC handle. - + @param[in] Private Point to IPSEC_PRIVATE_DATA @param[in] Controller Handler for NIC card. - + @retval EFI_SUCCESS The Operation is successful. @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated. - + **/ EFI_STATUS IkeOpenInputUdp4 ( @@ -156,16 +156,16 @@ IkeOpenInputUdp4 ( /** Open and configure a UDPIO of Udp6 for IKE packet receiving. - + This function is called at the IPsecDriverBinding start. IPsec create a UDP6 and UDP6 IO for each NIC handle. - + @param[in] Private Point to IPSEC_PRIVATE_DATA @param[in] Controller Handler for NIC card. - + @retval EFI_SUCCESS The Operation is successful. @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated. - + **/ EFI_STATUS IkeOpenInputUdp6 ( @@ -175,17 +175,17 @@ IkeOpenInputUdp6 ( /** The general interface of starting IPsec Key Exchange. - + This function is called when start a IKE negotiation to get a Key. - - @param[in] UdpService Point to IKE_UDP_SERVICE which will be used for + + @param[in] UdpService Point to IKE_UDP_SERVICE which will be used for IKE packet sending. @param[in] SpdEntry Point to the SPD entry related to the IKE negotiation. @param[in] RemoteIp Point to EFI_IP_ADDRESS related to the IKE negotiation. - + @retval EFI_SUCCESS The Operation is successful. @retval EFI_ACCESS_DENIED No related PAD entry was found. - + **/ EFI_STATUS IkeNegotiate ( @@ -196,17 +196,18 @@ IkeNegotiate ( /** The general interface when receive a IKE packet. - + This function is called when UDP IO receives a IKE packet. - + @param[in] Packet Point to received IKE packet. - @param[in] EndPoint Point to UDP_END_POINT which contains the information of + @param[in] EndPoint Point to UDP_END_POINT which contains the information of Remote IP and Port. @param[in] IoStatus The Status of Recieve Token. @param[in] Context Point to data passed from the caller. - + **/ VOID +EFIAPI IkeDispatch ( IN NET_BUF *Packet, IN UDP_END_POINT *EndPoint, @@ -218,7 +219,7 @@ IkeDispatch ( Check if the NIC handle is binded to a Udp service. @param[in] Private Pointer of IPSEC_PRIVATE_DATA - @param[in] NicHandle The Handle of the NIC card + @param[in] Handle The Handle of the NIC card @param[in] IpVersion The version of the IP stack. @return a pointer of IKE_UDP_SERVICE. @@ -234,17 +235,19 @@ IkeLookupUdp ( /** Delete all established IKE SAs and related Child SAs. - - This function is the subfunction of the IpSecCleanupAllSa(). It first calls - IkeDeleteChildSa() to delete all Child SAs then send out the related + + This function is the subfunction of the IpSecCleanupAllSa(). It first calls + IkeDeleteChildSa() to delete all Child SAs then send out the related Information packet. - @param[in] Private Pointer of the IPSEC_PRIVATE_DATA. + @param[in] Private Pointer of the IPSEC_PRIVATE_DATA. + @param[in] IsDisableIpsec Indicate whether needs to disable IPsec. **/ VOID IkeDeleteAllSas ( - IN IPSEC_PRIVATE_DATA *Private + IN IPSEC_PRIVATE_DATA *Private, + IN BOOLEAN IsDisableIpsec );