Update the copyright notice format
[mirror_edk2.git] / MdeModulePkg / Universal / Network / SnpDxe / Mcast_ip_to_mac.c
1 /** @file\r
2                 Implementation of converting an multicast IP address to multicast HW MAC\r
3                 address.\r
4  \r
5 Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
6 This program and the accompanying materials are licensed \r
7 and made available under the terms and conditions of the BSD License which \r
8 accompanies this distribution. The full text of the license may be found at \r
9 http://opensource.org/licenses/bsd-license.php \r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 \r
14 **/\r
15 \r
16 #include "Snp.h"\r
17 \r
18 /**\r
19   Call undi to convert an multicast IP address to a MAC address.\r
20 \r
21   @param  Snp   Pointer to snp driver structure.\r
22   @param  IPv6  Flag to indicate if this is an ipv6 address.\r
23   @param  IP    Multicast IP address.\r
24   @param  MAC   Pointer to hold the return MAC address.\r
25 \r
26   @retval EFI_SUCCESS           The multicast IP address was mapped to the \r
27                                 multicast HW MAC address.\r
28   @retval EFI_INVALID_PARAMETER Invalid UNDI command. \r
29   @retval EFI_UNSUPPORTED       Command is not supported by UNDI. \r
30   @retval EFI_DEVICE_ERROR      Fail to execute UNDI command. \r
31 \r
32 **/\r
33 EFI_STATUS\r
34 PxeIp2Mac (\r
35   IN SNP_DRIVER          *Snp,\r
36   IN BOOLEAN             IPv6,\r
37   IN EFI_IP_ADDRESS      *IP,\r
38   IN OUT EFI_MAC_ADDRESS *MAC\r
39   )\r
40 {\r
41   PXE_CPB_MCAST_IP_TO_MAC *Cpb;\r
42   PXE_DB_MCAST_IP_TO_MAC  *Db;\r
43 \r
44   Cpb                 = Snp->Cpb;\r
45   Db                  = Snp->Db;\r
46   Snp->Cdb.OpCode     = PXE_OPCODE_MCAST_IP_TO_MAC;\r
47   Snp->Cdb.OpFlags    = (UINT16) (IPv6 ? PXE_OPFLAGS_MCAST_IPV6_TO_MAC : PXE_OPFLAGS_MCAST_IPV4_TO_MAC);\r
48   Snp->Cdb.CPBsize    = sizeof (PXE_CPB_MCAST_IP_TO_MAC);\r
49   Snp->Cdb.DBsize     = sizeof (PXE_DB_MCAST_IP_TO_MAC);\r
50 \r
51   Snp->Cdb.CPBaddr    = (UINT64)(UINTN) Cpb;\r
52   Snp->Cdb.DBaddr     = (UINT64)(UINTN) Db;\r
53 \r
54   Snp->Cdb.StatCode   = PXE_STATCODE_INITIALIZE;\r
55   Snp->Cdb.StatFlags  = PXE_STATFLAGS_INITIALIZE;\r
56   Snp->Cdb.IFnum      = Snp->IfNum;\r
57   Snp->Cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;\r
58 \r
59   CopyMem (&Cpb->IP, IP, sizeof (PXE_IP_ADDR));\r
60 \r
61   //\r
62   // Issue UNDI command and check result.\r
63   //\r
64   DEBUG ((EFI_D_NET, "\nSnp->undi.mcast_ip_to_mac()  "));\r
65 \r
66   (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);\r
67 \r
68   switch (Snp->Cdb.StatCode) {\r
69   case PXE_STATCODE_SUCCESS:\r
70     break;\r
71 \r
72   case PXE_STATCODE_INVALID_CPB:\r
73     return EFI_INVALID_PARAMETER;\r
74 \r
75   case PXE_STATCODE_UNSUPPORTED:\r
76     DEBUG (\r
77       (EFI_D_NET,\r
78       "\nSnp->undi.mcast_ip_to_mac()  %xh:%xh\n",\r
79       Snp->Cdb.StatFlags,\r
80       Snp->Cdb.StatCode)\r
81       );\r
82     return EFI_UNSUPPORTED;\r
83 \r
84   default:\r
85     //\r
86     // UNDI command failed.  Return EFI_DEVICE_ERROR\r
87     // to caller.\r
88     //\r
89     DEBUG (\r
90       (EFI_D_NET,\r
91       "\nSnp->undi.mcast_ip_to_mac()  %xh:%xh\n",\r
92       Snp->Cdb.StatFlags,\r
93       Snp->Cdb.StatCode)\r
94       );\r
95 \r
96     return EFI_DEVICE_ERROR;\r
97   }\r
98 \r
99   CopyMem (MAC, &Db->MAC, sizeof (PXE_MAC_ADDR));\r
100   return EFI_SUCCESS;\r
101 }\r
102 \r
103 \r
104 /**\r
105   Converts a multicast IP address to a multicast HW MAC address.\r
106   \r
107   This function converts a multicast IP address to a multicast HW MAC address \r
108   for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will\r
109   be returned.\r
110 \r
111   @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
112   @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460].\r
113               Set to FALSE if the multicast IP address is IPv4 [RFC 791]. \r
114   @param IP   The multicast IP address that is to be converted to a multicast \r
115               HW MAC address.\r
116   @param MAC  The multicast HW MAC address that is to be generated from IP.\r
117 \r
118   @retval EFI_SUCCESS           The multicast IP address was mapped to the\r
119                                 multicast HW MAC address.\r
120   @retval EFI_NOT_STARTED       The Simple Network Protocol interface has not \r
121                                 been started by calling Start().\r
122   @retval EFI_INVALID_PARAMETER IP is NULL.\r
123   @retval EFI_INVALID_PARAMETER MAC is NULL.\r
124   @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 \r
125                                 multicast address.\r
126   @retval EFI_DEVICE_ERROR      The Simple Network Protocol interface has not \r
127                                 been initialized by calling Initialize().\r
128   @retval EFI_UNSUPPORTED       IPv6 is TRUE and the implementation does not \r
129                                 support IPv6 multicast to MAC address conversion.\r
130 \r
131 **/\r
132 EFI_STATUS\r
133 EFIAPI\r
134 SnpUndi32McastIpToMac (\r
135   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
136   IN BOOLEAN                     IPv6,\r
137   IN EFI_IP_ADDRESS              *IP,\r
138   OUT EFI_MAC_ADDRESS            *MAC\r
139   )\r
140 {\r
141   SNP_DRIVER  *Snp;\r
142   EFI_TPL     OldTpl;\r
143   EFI_STATUS  Status;\r
144 \r
145   //\r
146   // Get pointer to SNP driver instance for *this.\r
147   //\r
148   if (This == NULL) {\r
149     return EFI_INVALID_PARAMETER;\r
150   }\r
151 \r
152   if (IP == NULL || MAC == NULL) {\r
153     return EFI_INVALID_PARAMETER;\r
154   }\r
155 \r
156   Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This);\r
157 \r
158   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
159 \r
160   switch (Snp->Mode.State) {\r
161   case EfiSimpleNetworkInitialized:\r
162     break;\r
163 \r
164   case EfiSimpleNetworkStopped:\r
165     Status = EFI_NOT_STARTED;\r
166     goto ON_EXIT;\r
167 \r
168   default:\r
169     Status = EFI_DEVICE_ERROR;\r
170     goto ON_EXIT;\r
171   }\r
172 \r
173   Status = PxeIp2Mac (Snp, IPv6, IP, MAC);\r
174 \r
175 ON_EXIT:\r
176   gBS->RestoreTPL (OldTpl);\r
177 \r
178   return Status;\r
179 }\r