MnpDriver.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Implementation of driver entry point and driver binding protocol.
Copyright (c) 2005 - 2011, 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>
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "MnpDriver.h"
#include "MnpImpl.h"
#include "MnpVlan.h"
0xa,
NULL,
};
/**
Test to see if this driver supports ControllerHandle. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are a few calling
restrictions for this service. ConnectController() must
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test.
@param[in] RemainingDevicePath Optional parameter use to pick a specific
child device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_ALREADY_STARTED This driver is already running on this device.
@retval Others This driver does not support this device.
**/
)
{
//
// Test to open the Simple Network protocol BY_DRIVER.
//
);
return Status;
}
//
// Close the openned SNP protocol.
//
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
/**
Start this driver on ControllerHandle. This service is called by the
EFI boot service ConnectController(). In order to make drivers as small
as possible, there are a few calling restrictions for this service.
ConnectController() must follow these calling restrictions. If any other
agent wishes to call Start() it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to.
@param[in] RemainingDevicePath Optional parameter use to pick a specific
child device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle.
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for Mnp Service Data.
@retval Others This driver does not support this device.
**/
)
{
VlanVariable = NULL;
//
// Initialize the Mnp Device Data
//
if (MnpDeviceData == NULL) {
return EFI_OUT_OF_RESOURCES;
}
return Status;
}
//
// Check whether NIC driver has already produced VlanConfig protocol
//
NULL,
);
//
// NIC hardware already implement VLAN,
// no need to provide software VLAN implementation in MNP driver
//
MnpDeviceData->NumberOfVlan = 0;
goto Exit;
}
//
// Install VLAN Config Protocol
//
);
goto Exit;
}
//
// Get current VLAN configuration from EFI Variable
//
NumberOfVlan = 0;
//
// No VLAN is set, create a default MNP service data for untagged frame
//
MnpDeviceData->NumberOfVlan = 0;
goto Exit;
}
//
// Create MNP service data for each VLAN
//
);
if (MnpServiceData == NULL) {
goto Exit;
}
}
Exit:
if (VlanVariable != NULL) {
}
//
// Destroy all MNP service data
//
}
//
// Uninstall the VLAN Config Protocol if any
//
);
}
//
// Destroy Mnp Device Data
//
}
return Status;
}
/**
Stop this driver on ControllerHandle. This service is called by the
EFI boot service DisconnectController(). In order to make drivers as
small as possible, there are a few calling restrictions for this service.
DisconnectController() must follow these calling restrictions. If any other
agent wishes to call Stop() it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to stop driver on.
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If
number of children is zero stop the entire
bus driver.
@param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
**/
)
{
//
// Try to retrieve MNP service binding protocol from the ControllerHandle
//
(VOID **) &ServiceBinding,
);
//
// Retrieve VLAN Config Protocol from the ControllerHandle
//
(VOID **) &VlanConfig,
);
return EFI_DEVICE_ERROR;
}
} else {
}
if (NumberOfChildren == 0) {
//
// Destroy all MNP service data
//
}
//
// Uninstall the VLAN Config Protocol if any
//
);
}
//
// Destroy Mnp Device Data
//
return EFI_SUCCESS;
}
//
// Stop all MNP child
//
}
}
if (!AllChildrenStopped) {
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
/**
Creates a child handle with a set of I/O services.
@param[in] This Protocol instance pointer.
@param[in, out] ChildHandle Pointer to the handle of the child to create. If
it is NULL, then a new handle is created. If
it is not NULL, then the I/O services are added
to the existing child handle.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to
create the child.
@retval Others The child handle was not created.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Allocate buffer for the new instance.
//
DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n"));
return EFI_OUT_OF_RESOURCES;
}
//
// Init the instance data.
//
);
DEBUG (
"MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n",
);
goto ErrorExit;
}
//
// Save the instance's childhandle.
//
);
goto ErrorExit;
}
//
// Add the child instance into ChildrenList.
//
);
}
}
return Status;
}
/**
Destroys a child handle with a set of I/O services.
The DestroyChild() function does the opposite of CreateChild(). It removes a
protocol that was installed by CreateChild() from ChildHandle. If the removed
protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL
instance.
@param[in] ChildHandle Handle of the child to destroy.
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that
is being removed.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the
ChildHandle because its services are being
used.
@retval Others The child handle was not destroyed.
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Try to retrieve ManagedNetwork Protocol from ChildHandle.
//
(VOID **) &ManagedNetwork,
);
return EFI_UNSUPPORTED;
}
//
// MnpServiceBindingDestroyChild may be called twice: first called by
// MnpServiceBindingStop, second called by uninstalling the MNP protocol
// in this ChildHandle. Use destroyed to make sure the resource clean code
// will only excecute once.
//
return EFI_SUCCESS;
}
//
// Close the Simple Network protocol.
//
gBS->CloseProtocol (
);
//
// Uninstall the ManagedNetwork protocol.
//
);
DEBUG (
"MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n",
);
return Status;
}
//
// Reset the configuration.
//
//
// Try to flush the RcvdPacketQueue.
//
//
// Clean the RxTokenMap.
//
//
// Remove this instance from the ChildrenList.
//
return Status;
}
/**
The entry point for Mnp driver which installs the driver binding and component
name protocol on its ImageHandle.
@param[in] ImageHandle The image handle of the driver.
@param[in] SystemTable The system table.
@retval EFI_SUCCES The driver binding and component name protocols are
successfully installed.
@retval Others Other errors as indicated.
**/
)
{
);
}