2 VLAN Config Protocol implementation and VLAN packet process routine.
4 Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions
7 of the BSD License which accompanies this distribution. The full
8 text of the license may be found at<BR>
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 VLAN_DEVICE_PATH mVlanDevicePathTemplate
= {
21 MESSAGING_DEVICE_PATH
,
24 (UINT8
) (sizeof (VLAN_DEVICE_PATH
)),
25 (UINT8
) ((sizeof (VLAN_DEVICE_PATH
)) >> 8)
31 EFI_VLAN_CONFIG_PROTOCOL mVlanConfigProtocolTemplate
= {
39 Create a child handle for the VLAN ID.
41 @param[in] ImageHandle The driver image handle.
42 @param[in] ControllerHandle Handle of device to bind driver to.
43 @param[in] VlanId The VLAN ID.
44 @param[out] Devicepath Pointer to returned device path for child handle.
46 @return The handle of VLAN child or NULL if failed to create VLAN child.
51 IN EFI_HANDLE ImageHandle
,
52 IN EFI_HANDLE ControllerHandle
,
54 OUT EFI_DEVICE_PATH_PROTOCOL
**Devicepath OPTIONAL
57 EFI_HANDLE ChildHandle
;
58 VLAN_DEVICE_PATH VlanNode
;
59 EFI_DEVICE_PATH_PROTOCOL
*ParentDevicePath
;
60 EFI_DEVICE_PATH_PROTOCOL
*VlanDevicePath
;
64 // Try to get parent device path
66 Status
= gBS
->OpenProtocol (
68 &gEfiDevicePathProtocolGuid
,
69 (VOID
**) &ParentDevicePath
,
72 EFI_OPEN_PROTOCOL_GET_PROTOCOL
74 if (EFI_ERROR (Status
)) {
79 // Construct device path for child handle: MAC + VLAN
81 CopyMem (&VlanNode
, &mVlanDevicePathTemplate
, sizeof (VLAN_DEVICE_PATH
));
82 VlanNode
.VlanId
= VlanId
;
83 VlanDevicePath
= AppendDevicePathNode (
85 (EFI_DEVICE_PATH_PROTOCOL
*) &VlanNode
87 if (VlanDevicePath
== NULL
) {
92 // Create child VLAN handle by installing DevicePath protocol
95 Status
= gBS
->InstallMultipleProtocolInterfaces (
97 &gEfiDevicePathProtocolGuid
,
101 if (EFI_ERROR (Status
)) {
102 FreePool (VlanDevicePath
);
106 if (Devicepath
!= NULL
) {
107 *Devicepath
= VlanDevicePath
;
114 Remove VLAN tag from a packet.
116 @param[in, out] MnpDeviceData Pointer to the mnp device context data.
117 @param[in, out] Nbuf Pointer to the NET_BUF to remove VLAN tag.
118 @param[out] VlanId Pointer to the returned VLAN ID.
120 @retval TRUE VLAN tag is removed from this packet.
121 @retval FALSE There is no VLAN tag in this packet.
126 IN OUT MNP_DEVICE_DATA
*MnpDeviceData
,
127 IN OUT NET_BUF
*Nbuf
,
132 UINTN ProtocolOffset
;
136 ProtocolOffset
= MnpDeviceData
->Snp
->Mode
->HwAddressSize
* 2;
139 // Get the packet buffer.
141 Packet
= NetbufGetByte (Nbuf
, 0, NULL
);
142 ASSERT (Packet
!= NULL
);
145 // Check whether this is VLAN tagged frame by Ether Type
148 ProtocolType
= NTOHS (*(UINT16
*) (Packet
+ ProtocolOffset
));
149 if (ProtocolType
!= ETHER_TYPE_VLAN
) {
151 // Not a VLAN tagged frame
156 VlanTag
.Uint16
= NTOHS (*(UINT16
*) (Packet
+ ProtocolOffset
+ sizeof (ProtocolType
)));
157 *VlanId
= VlanTag
.Bits
.Vid
;
160 // Move hardware address (DA + SA) 4 bytes right to override VLAN tag
162 CopyMem (Packet
+ NET_VLAN_TAG_LEN
, Packet
, ProtocolOffset
);
165 // Remove VLAN tag from the Nbuf
167 NetbufTrim (Nbuf
, NET_VLAN_TAG_LEN
, NET_BUF_HEAD
);
174 Build the packet to transmit from the TxData passed in.
176 @param MnpServiceData Pointer to the mnp service context data.
177 @param TxData Pointer to the transmit data containing the
178 information to build the packet.
179 @param ProtocolType Pointer to the Ethernet protocol type.
180 @param Packet Pointer to record the address of the packet.
181 @param Length Pointer to a UINT32 variable used to record the
187 IN MNP_SERVICE_DATA
*MnpServiceData
,
188 IN EFI_MANAGED_NETWORK_TRANSMIT_DATA
*TxData
,
189 OUT UINT16
*ProtocolType
,
190 IN OUT UINT8
**Packet
,
191 IN OUT UINT32
*Length
197 MNP_DEVICE_DATA
*MnpDeviceData
;
198 EFI_SIMPLE_NETWORK_MODE
*SnpMode
;
200 if (MnpServiceData
->VlanId
== 0) {
201 *ProtocolType
= TxData
->ProtocolType
;
205 MnpDeviceData
= MnpServiceData
->MnpDeviceData
;
206 SnpMode
= MnpDeviceData
->Snp
->Mode
;
208 *ProtocolType
= ETHER_TYPE_VLAN
;
209 *Length
= *Length
+ NET_VLAN_TAG_LEN
;
210 *Packet
= *Packet
- NET_VLAN_TAG_LEN
;
212 Tpid
= (UINT16
*) (*Packet
+ SnpMode
->MediaHeaderSize
- sizeof (*ProtocolType
));
213 VlanTci
= (VLAN_TCI
*) (UINTN
) (Tpid
+ 1);
214 if (TxData
->HeaderLength
!= 0) {
216 // Media header is in packet, move DA+SA 4 bytes left
220 *Packet
+ NET_VLAN_TAG_LEN
,
221 SnpMode
->MediaHeaderSize
- sizeof (*ProtocolType
)
223 *Tpid
= HTONS (ETHER_TYPE_VLAN
);
226 // Media header not in packet, VLAN TCI and original protocol type becomes payload
228 EtherType
= (UINT16
*) (UINTN
) (VlanTci
+ 1);
229 *EtherType
= HTONS (TxData
->ProtocolType
);
232 VlanTci
->Bits
.Vid
= MnpServiceData
->VlanId
;
233 VlanTci
->Bits
.Cfi
= VLAN_TCI_CFI_CANONICAL_MAC
;
234 VlanTci
->Bits
.Priority
= MnpServiceData
->Priority
;
235 VlanTci
->Uint16
= HTONS (VlanTci
->Uint16
);
240 Get VLAN configuration variable.
242 @param[in] MnpDeviceData Pointer to the MNP device context data.
243 @param[out] NumberOfVlan Pointer to number of VLAN to be returned.
244 @param[out] VlanVariable Pointer to the buffer to return requested
247 @retval EFI_SUCCESS The array of VLAN_TCI was returned in VlanVariable
248 and number of VLAN was returned in NumberOfVlan.
249 @retval EFI_NOT_FOUND VLAN configuration variable not found.
250 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the configuration.
255 IN MNP_DEVICE_DATA
*MnpDeviceData
,
256 OUT UINTN
*NumberOfVlan
,
257 OUT VLAN_TCI
**VlanVariable
265 // Get VLAN configuration from EFI Variable
269 Status
= gRT
->GetVariable (
270 MnpDeviceData
->MacString
,
271 &gEfiVlanConfigProtocolGuid
,
276 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
277 return EFI_NOT_FOUND
;
281 // Allocate buffer to read the variable
283 Buffer
= AllocateZeroPool (BufferSize
);
284 if (Buffer
== NULL
) {
285 return EFI_OUT_OF_RESOURCES
;
288 Status
= gRT
->GetVariable (
289 MnpDeviceData
->MacString
,
290 &gEfiVlanConfigProtocolGuid
,
295 if (EFI_ERROR (Status
)) {
300 *NumberOfVlan
= BufferSize
/ sizeof (VLAN_TCI
);
301 *VlanVariable
= Buffer
;
308 Set VLAN configuration variable.
310 @param[in] MnpDeviceData Pointer to the MNP device context data.
311 @param[in] NumberOfVlan Number of VLAN in array VlanVariable.
312 @param[in] VlanVariable Pointer to array of VLAN_TCI.
314 @retval EFI_SUCCESS The VLAN variable is successfully set.
315 @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration.
320 IN MNP_DEVICE_DATA
*MnpDeviceData
,
321 IN UINTN NumberOfVlan
,
322 IN VLAN_TCI
*VlanVariable
325 return gRT
->SetVariable (
326 MnpDeviceData
->MacString
,
327 &gEfiVlanConfigProtocolGuid
,
328 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
329 NumberOfVlan
* sizeof (VLAN_TCI
),
336 Create a VLAN device or modify the configuration parameter of an
337 already-configured VLAN.
339 The Set() function is used to create a new VLAN device or change the VLAN
340 configuration parameters. If the VlanId hasn't been configured in the
341 physical Ethernet device, a new VLAN device will be created. If a VLAN with
342 this VlanId is already configured, then related configuration will be updated
343 as the input parameters.
345 If VlanId is zero, the VLAN device will send and receive untagged frames.
346 Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId.
347 If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned.
348 If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned.
349 If there is not enough system memory to perform the registration, then
350 EFI_OUT_OF_RESOURCES is returned.
352 @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.
353 @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created
354 or modified, or zero (0).
355 @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If
356 VlanId is zero (0), Priority is ignored.
358 @retval EFI_SUCCESS The VLAN is successfully configured.
359 @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:
361 - VlanId is an invalid VLAN Identifier.
362 - Priority is invalid.
363 @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration.
369 IN EFI_VLAN_CONFIG_PROTOCOL
*This
,
375 MNP_DEVICE_DATA
*MnpDeviceData
;
376 MNP_SERVICE_DATA
*MnpServiceData
;
377 VLAN_TCI
*OldVariable
;
378 VLAN_TCI
*NewVariable
;
384 if ((This
== NULL
) || (VlanId
> 4094) || (Priority
> 7)) {
385 return EFI_INVALID_PARAMETER
;
389 MnpDeviceData
= MNP_DEVICE_DATA_FROM_THIS (This
);
390 if (MnpDeviceData
->NumberOfVlan
== 0) {
392 // No existing VLAN, this is the first VLAN to add
395 Entry
= GetFirstNode (&MnpDeviceData
->ServiceList
);
396 MnpServiceData
= MNP_SERVICE_DATA_FROM_LINK (Entry
);
400 // VlanId is not 0, need destroy the default MNP service data
402 Status
= MnpDestroyServiceChild (MnpServiceData
);
403 if (EFI_ERROR (Status
)) {
407 Status
= MnpDestroyServiceData (MnpServiceData
);
408 if (EFI_ERROR (Status
)) {
413 // Create a new MNP service data for this VLAN
415 MnpServiceData
= MnpCreateServiceData (MnpDeviceData
, VlanId
, Priority
);
416 if (MnpServiceData
== NULL
) {
417 return EFI_OUT_OF_RESOURCES
;
422 // Try to find VlanId in existing VLAN list
424 MnpServiceData
= MnpFindServiceData (MnpDeviceData
, VlanId
);
425 if (MnpServiceData
== NULL
) {
427 // VlanId not found, create a new MNP service data
430 MnpServiceData
= MnpCreateServiceData (MnpDeviceData
, VlanId
, Priority
);
431 if (MnpServiceData
== NULL
) {
432 return EFI_OUT_OF_RESOURCES
;
437 MnpServiceData
->VlanId
= VlanId
;
438 MnpServiceData
->Priority
= Priority
;
440 MnpDeviceData
->NumberOfVlan
++;
444 // Update VLAN configuration variable
449 MnpGetVlanVariable (MnpDeviceData
, &NumberOfVlan
, &OldVariable
);
453 // VLAN not exist - add
455 NewVariable
= AllocateZeroPool ((NumberOfVlan
+ 1) * sizeof (VLAN_TCI
));
456 if (NewVariable
== NULL
) {
457 Status
= EFI_OUT_OF_RESOURCES
;
461 if (OldVariable
!= NULL
) {
462 CopyMem (NewVariable
, OldVariable
, NumberOfVlan
* sizeof (VLAN_TCI
));
465 Index
= NumberOfVlan
++;
468 // VLAN already exist - update
470 for (Index
= 0; Index
< NumberOfVlan
; Index
++) {
471 if (OldVariable
[Index
].Bits
.Vid
== VlanId
) {
475 ASSERT (Index
< NumberOfVlan
);
477 NewVariable
= OldVariable
;
481 NewVariable
[Index
].Bits
.Vid
= VlanId
;
482 NewVariable
[Index
].Bits
.Priority
= Priority
;
484 Status
= MnpSetVlanVariable (MnpDeviceData
, NumberOfVlan
, NewVariable
);
485 FreePool (NewVariable
);
488 if (OldVariable
!= NULL
) {
489 FreePool (OldVariable
);
497 Find configuration information for specified VLAN or all configured VLANs.
499 The Find() function is used to find the configuration information for matching
500 VLAN and allocate a buffer into which those entries are copied.
502 @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.
503 @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all
505 @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria.
506 @param[out] Entries The buffer which receive the VLAN configuration.
508 @retval EFI_SUCCESS The VLAN is successfully found.
509 @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:
511 - Specified VlanId is invalid.
512 @retval EFI_NOT_FOUND No matching VLAN is found.
518 IN EFI_VLAN_CONFIG_PROTOCOL
*This
,
519 IN UINT16
*VlanId OPTIONAL
,
520 OUT UINT16
*NumberOfVlan
,
521 OUT EFI_VLAN_FIND_DATA
**Entries
524 MNP_DEVICE_DATA
*MnpDeviceData
;
525 MNP_SERVICE_DATA
*MnpServiceData
;
527 EFI_VLAN_FIND_DATA
*VlanData
;
529 if ((This
== NULL
) || (VlanId
!= NULL
&& *VlanId
> 4094) || (NumberOfVlan
== NULL
) || (Entries
== NULL
)) {
530 return EFI_INVALID_PARAMETER
;
536 MnpDeviceData
= MNP_DEVICE_DATA_FROM_THIS (This
);
537 if (MnpDeviceData
->NumberOfVlan
== 0) {
538 return EFI_NOT_FOUND
;
541 if (VlanId
== NULL
) {
543 // Return all current VLAN configuration
545 *NumberOfVlan
= (UINT16
) MnpDeviceData
->NumberOfVlan
;
546 VlanData
= AllocateZeroPool (*NumberOfVlan
* sizeof (EFI_VLAN_FIND_DATA
));
547 if (VlanData
== NULL
) {
548 return EFI_OUT_OF_RESOURCES
;
552 NET_LIST_FOR_EACH (Entry
, &MnpDeviceData
->ServiceList
) {
553 MnpServiceData
= MNP_SERVICE_DATA_FROM_LINK (Entry
);
555 VlanData
->VlanId
= MnpServiceData
->VlanId
;
556 VlanData
->Priority
= MnpServiceData
->Priority
;
564 // VlanId is specified, try to find it in current VLAN list
566 MnpServiceData
= MnpFindServiceData (MnpDeviceData
, *VlanId
);
567 if (MnpServiceData
== NULL
) {
568 return EFI_NOT_FOUND
;
571 VlanData
= AllocateZeroPool (sizeof (EFI_VLAN_FIND_DATA
));
572 if (VlanData
== NULL
) {
573 return EFI_OUT_OF_RESOURCES
;
575 VlanData
->VlanId
= MnpServiceData
->VlanId
;
576 VlanData
->Priority
= MnpServiceData
->Priority
;
586 Remove the configured VLAN device.
588 The Remove() function is used to remove the specified VLAN device.
589 If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned.
590 If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned.
592 @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL.
593 @param[in] VlanId Identifier (0-4094) of the VLAN to be removed.
595 @retval EFI_SUCCESS The VLAN is successfully removed.
596 @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE:
598 - VlanId is an invalid parameter.
599 @retval EFI_NOT_FOUND The to-be-removed VLAN does not exist.
605 IN EFI_VLAN_CONFIG_PROTOCOL
*This
,
610 MNP_DEVICE_DATA
*MnpDeviceData
;
611 MNP_SERVICE_DATA
*MnpServiceData
;
613 VLAN_TCI
*VlanVariable
;
616 if ((This
== NULL
) || (VlanId
> 4094)) {
617 return EFI_INVALID_PARAMETER
;
620 MnpDeviceData
= MNP_DEVICE_DATA_FROM_THIS (This
);
621 if (MnpDeviceData
->NumberOfVlan
== 0) {
622 return EFI_NOT_FOUND
;
626 // Try to find the VlanId
628 MnpServiceData
= MnpFindServiceData (MnpDeviceData
, VlanId
);
629 if (MnpServiceData
== NULL
) {
630 return EFI_NOT_FOUND
;
633 MnpDeviceData
->NumberOfVlan
--;
635 if ((VlanId
!= 0) || (MnpDeviceData
->NumberOfVlan
!= 0)) {
637 // If VlanId is not 0 or VlanId is 0 and it is not the last VLAN to remove,
638 // destroy its MNP service data
640 Status
= MnpDestroyServiceChild (MnpServiceData
);
641 if (EFI_ERROR (Status
)) {
645 Status
= MnpDestroyServiceData (MnpServiceData
);
646 if (EFI_ERROR (Status
)) {
651 if ((VlanId
!= 0) && (MnpDeviceData
->NumberOfVlan
== 0)) {
653 // This is the last VLAN to be removed, restore the default MNP service data
655 MnpServiceData
= MnpCreateServiceData (MnpDeviceData
, 0, 0);
656 if (MnpServiceData
== NULL
) {
657 return EFI_OUT_OF_RESOURCES
;
662 // Update VLAN configuration variable
665 if (MnpDeviceData
->NumberOfVlan
!= 0) {
666 VlanVariable
= AllocatePool (MnpDeviceData
->NumberOfVlan
* sizeof (VLAN_TCI
));
667 if (VlanVariable
== NULL
) {
668 return EFI_OUT_OF_RESOURCES
;
671 VlanData
= VlanVariable
;
672 NET_LIST_FOR_EACH (Entry
, &MnpDeviceData
->ServiceList
) {
673 MnpServiceData
= MNP_SERVICE_DATA_FROM_LINK (Entry
);
675 VlanData
->Bits
.Vid
= MnpServiceData
->VlanId
;
676 VlanData
->Bits
.Priority
= MnpServiceData
->Priority
;
681 Status
= MnpSetVlanVariable (MnpDeviceData
, MnpDeviceData
->NumberOfVlan
, VlanVariable
);
683 if (VlanVariable
!= NULL
) {
684 FreePool (VlanVariable
);