summaryrefslogtreecommitdiff
path: root/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
diff options
context:
space:
mode:
Diffstat (limited to 'NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h')
-rw-r--r--NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h201
1 files changed, 90 insertions, 111 deletions
diff --git a/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h b/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
index 8405f6f..a885b96 100644
--- a/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
+++ b/NetworkPkg/UefiPxeBcDxe/PxeBcSupport.h
@@ -10,15 +10,12 @@
#ifndef __EFI_PXEBC_SUPPORT_H__
#define __EFI_PXEBC_SUPPORT_H__
-
-#define ICMP_DEST_UNREACHABLE 3
-#define ICMP_SOURCE_QUENCH 4
-#define ICMP_REDIRECT 5
-#define ICMP_ECHO_REQUEST 8
-#define ICMP_TIME_EXCEEDED 11
-#define ICMP_PARAMETER_PROBLEM 12
-
-
+#define ICMP_DEST_UNREACHABLE 3
+#define ICMP_SOURCE_QUENCH 4
+#define ICMP_REDIRECT 5
+#define ICMP_ECHO_REQUEST 8
+#define ICMP_TIME_EXCEEDED 11
+#define ICMP_PARAMETER_PROBLEM 12
/**
Flush the previous configuration using the new station Ip address.
@@ -33,12 +30,11 @@
**/
EFI_STATUS
PxeBcFlushStationIp (
- PXEBC_PRIVATE_DATA *Private,
- EFI_IP_ADDRESS *StationIp OPTIONAL,
- EFI_IP_ADDRESS *SubnetMask OPTIONAL
+ PXEBC_PRIVATE_DATA *Private,
+ EFI_IP_ADDRESS *StationIp OPTIONAL,
+ EFI_IP_ADDRESS *SubnetMask OPTIONAL
);
-
/**
Notify callback function when an event is triggered.
@@ -49,11 +45,10 @@ PxeBcFlushStationIp (
VOID
EFIAPI
PxeBcCommonNotify (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
-
/**
Perform arp resolution from the arp cache in PxeBcMode.
@@ -68,12 +63,11 @@ PxeBcCommonNotify (
**/
BOOLEAN
PxeBcCheckArpCache (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN EFI_IPv4_ADDRESS *Ip4Addr,
- OUT EFI_MAC_ADDRESS *MacAddress
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN EFI_IPv4_ADDRESS *Ip4Addr,
+ OUT EFI_MAC_ADDRESS *MacAddress
);
-
/**
Update arp cache periodically.
@@ -84,11 +78,10 @@ PxeBcCheckArpCache (
VOID
EFIAPI
PxeBcArpCacheUpdate (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
-
/**
xxx
@@ -99,11 +92,10 @@ PxeBcArpCacheUpdate (
VOID
EFIAPI
PxeBcIcmpErrorUpdate (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
-
/**
xxx
@@ -114,11 +106,10 @@ PxeBcIcmpErrorUpdate (
VOID
EFIAPI
PxeBcIcmp6ErrorUpdate (
- IN EFI_EVENT Event,
- IN VOID *Context
+ IN EFI_EVENT Event,
+ IN VOID *Context
);
-
/**
This function is to configure a UDPv4 instance for UdpWrite.
@@ -148,7 +139,6 @@ PxeBcConfigUdp4Write (
IN UINT8 ToS
);
-
/**
This function is to configure a UDPv6 instance for UdpWrite.
@@ -187,17 +177,16 @@ PxeBcConfigUdp6Write (
**/
EFI_STATUS
PxeBcUdp4Write (
- IN EFI_UDP4_PROTOCOL *Udp4,
- IN EFI_UDP4_SESSION_DATA *Session,
- IN EFI_EVENT TimeoutEvent,
- IN EFI_IPv4_ADDRESS *Gateway OPTIONAL,
- IN UINTN *HeaderSize OPTIONAL,
- IN VOID *HeaderPtr OPTIONAL,
- IN UINTN *BufferSize,
- IN VOID *BufferPtr
+ IN EFI_UDP4_PROTOCOL *Udp4,
+ IN EFI_UDP4_SESSION_DATA *Session,
+ IN EFI_EVENT TimeoutEvent,
+ IN EFI_IPv4_ADDRESS *Gateway OPTIONAL,
+ IN UINTN *HeaderSize OPTIONAL,
+ IN VOID *HeaderPtr OPTIONAL,
+ IN UINTN *BufferSize,
+ IN VOID *BufferPtr
);
-
/**
This function is to configure a UDPv6 instance for UdpWrite.
@@ -217,16 +206,15 @@ PxeBcUdp4Write (
**/
EFI_STATUS
PxeBcUdp6Write (
- IN EFI_UDP6_PROTOCOL *Udp6,
- IN EFI_UDP6_SESSION_DATA *Session,
- IN EFI_EVENT TimeoutEvent,
- IN UINTN *HeaderSize OPTIONAL,
- IN VOID *HeaderPtr OPTIONAL,
- IN UINTN *BufferSize,
- IN VOID *BufferPtr
+ IN EFI_UDP6_PROTOCOL *Udp6,
+ IN EFI_UDP6_SESSION_DATA *Session,
+ IN EFI_EVENT TimeoutEvent,
+ IN UINTN *HeaderSize OPTIONAL,
+ IN VOID *HeaderPtr OPTIONAL,
+ IN UINTN *BufferSize,
+ IN VOID *BufferPtr
);
-
/**
Check the received packet with the Ip filter.
@@ -240,12 +228,11 @@ PxeBcUdp6Write (
**/
BOOLEAN
PxeBcCheckByIpFilter (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN VOID *Session,
- IN UINT16 OpFlags
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN VOID *Session,
+ IN UINT16 OpFlags
);
-
/**
Filter the received packet with the destination Ip.
@@ -260,13 +247,12 @@ PxeBcCheckByIpFilter (
**/
BOOLEAN
PxeBcCheckByDestIp (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN VOID *Session,
- IN OUT EFI_IP_ADDRESS *DestIp,
- IN UINT16 OpFlags
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN VOID *Session,
+ IN OUT EFI_IP_ADDRESS *DestIp,
+ IN UINT16 OpFlags
);
-
/**
Check the received packet with the destination port.
@@ -281,13 +267,12 @@ PxeBcCheckByDestIp (
**/
BOOLEAN
PxeBcCheckByDestPort (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN VOID *Session,
- IN OUT UINT16 *DestPort,
- IN UINT16 OpFlags
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN VOID *Session,
+ IN OUT UINT16 *DestPort,
+ IN UINT16 OpFlags
);
-
/**
Filter the received packet with the source Ip.
@@ -302,13 +287,12 @@ PxeBcCheckByDestPort (
**/
BOOLEAN
PxeBcFilterBySrcIp (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN VOID *Session,
- IN OUT EFI_IP_ADDRESS *SrcIp,
- IN UINT16 OpFlags
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN VOID *Session,
+ IN OUT EFI_IP_ADDRESS *SrcIp,
+ IN UINT16 OpFlags
);
-
/**
Filter the received packet with the source port.
@@ -323,13 +307,12 @@ PxeBcFilterBySrcIp (
**/
BOOLEAN
PxeBcFilterBySrcPort (
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN VOID *Session,
- IN OUT UINT16 *SrcPort,
- IN UINT16 OpFlags
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN VOID *Session,
+ IN OUT UINT16 *SrcPort,
+ IN UINT16 OpFlags
);
-
/**
This function is to receive packet with Udp4Read.
@@ -351,20 +334,19 @@ PxeBcFilterBySrcPort (
**/
EFI_STATUS
PxeBcUdp4Read (
- IN EFI_UDP4_PROTOCOL *Udp4,
- IN EFI_UDP4_COMPLETION_TOKEN *Token,
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN EFI_EVENT TimeoutEvent,
- IN UINT16 OpFlags,
- IN BOOLEAN *IsDone,
- OUT BOOLEAN *IsMatched,
- IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
- IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
- IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
- IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL
+ IN EFI_UDP4_PROTOCOL *Udp4,
+ IN EFI_UDP4_COMPLETION_TOKEN *Token,
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN EFI_EVENT TimeoutEvent,
+ IN UINT16 OpFlags,
+ IN BOOLEAN *IsDone,
+ OUT BOOLEAN *IsMatched,
+ IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
+ IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
+ IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
+ IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL
);
-
/**
This function is to receive packet with Udp6Read.
@@ -386,20 +368,19 @@ PxeBcUdp4Read (
**/
EFI_STATUS
PxeBcUdp6Read (
- IN EFI_UDP6_PROTOCOL *Udp6,
- IN EFI_UDP6_COMPLETION_TOKEN *Token,
- IN EFI_PXE_BASE_CODE_MODE *Mode,
- IN EFI_EVENT TimeoutEvent,
- IN UINT16 OpFlags,
- IN BOOLEAN *IsDone,
- OUT BOOLEAN *IsMatched,
- IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
- IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
- IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
- IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL
+ IN EFI_UDP6_PROTOCOL *Udp6,
+ IN EFI_UDP6_COMPLETION_TOKEN *Token,
+ IN EFI_PXE_BASE_CODE_MODE *Mode,
+ IN EFI_EVENT TimeoutEvent,
+ IN UINT16 OpFlags,
+ IN BOOLEAN *IsDone,
+ OUT BOOLEAN *IsMatched,
+ IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
+ IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
+ IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
+ IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL
);
-
/**
This function is to display the IPv4 address.
@@ -408,10 +389,9 @@ PxeBcUdp6Read (
**/
VOID
PxeBcShowIp4Addr (
- IN EFI_IPv4_ADDRESS *Ip
+ IN EFI_IPv4_ADDRESS *Ip
);
-
/**
This function is to display the IPv6 address.
@@ -420,10 +400,9 @@ PxeBcShowIp4Addr (
**/
VOID
PxeBcShowIp6Addr (
- IN EFI_IPv6_ADDRESS *Ip
+ IN EFI_IPv6_ADDRESS *Ip
);
-
/**
This function is to convert UINTN to ASCII string with required format.
@@ -434,12 +413,11 @@ PxeBcShowIp6Addr (
**/
VOID
PxeBcUintnToAscDecWithFormat (
- IN UINTN Number,
- IN UINT8 *Buffer,
- IN INTN Length
+ IN UINTN Number,
+ IN UINT8 *Buffer,
+ IN INTN Length
);
-
/**
This function is to convert a UINTN to a ASCII string, and return the
actual length of the buffer.
@@ -453,9 +431,9 @@ PxeBcUintnToAscDecWithFormat (
**/
UINTN
PxeBcUintnToAscDec (
- IN UINTN Number,
- IN UINT8 *Buffer,
- IN UINTN BufferSize
+ IN UINTN Number,
+ IN UINT8 *Buffer,
+ IN UINTN BufferSize
);
/**
@@ -470,8 +448,8 @@ PxeBcUintnToAscDec (
**/
EFI_STATUS
PxeBcUniHexToUint8 (
- OUT UINT8 *Digit,
- IN CHAR16 Char
+ OUT UINT8 *Digit,
+ IN CHAR16 Char
);
/**
@@ -482,7 +460,7 @@ PxeBcUniHexToUint8 (
**/
VOID
CalcElapsedTime (
- IN PXEBC_PRIVATE_DATA *Private
+ IN PXEBC_PRIVATE_DATA *Private
);
/**
@@ -495,7 +473,7 @@ CalcElapsedTime (
**/
EFI_HANDLE
PxeBcGetNicByIp4Children (
- IN EFI_HANDLE ControllerHandle
+ IN EFI_HANDLE ControllerHandle
);
/**
@@ -508,6 +486,7 @@ PxeBcGetNicByIp4Children (
**/
EFI_HANDLE
PxeBcGetNicByIp6Children (
- IN EFI_HANDLE ControllerHandle
+ IN EFI_HANDLE ControllerHandle
);
+
#endif