/** @file\r
+ Implementation of Managed Network Protocol private services.\r
\r
-Copyright (c) 2005 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2005 - 2009, Intel Corporation. <BR> \r
+All rights reserved. This program and the accompanying materials are licensed \r
+and made available under the terms and conditions of the BSD License which \r
+accompanies this distribution. The full text of the license may be found at \r
+http://opensource.org/licenses/bsd-license.php \r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- MnpConfig.c\r
-\r
-Abstract:\r
-\r
- Implementation of Managed Network Protocol private services.\r
-\r
-\r
**/\r
\r
\r
};\r
\r
EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = {\r
- 10000,\r
- 10000,\r
+ 10000000,\r
+ 10000000,\r
0,\r
FALSE,\r
FALSE,\r
FALSE\r
};\r
\r
-STATIC\r
-EFI_STATUS\r
-MnpAddFreeNbuf (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN UINTN Count\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpStartSnp (\r
- IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpStopSnp (\r
- IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpStart (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN BOOLEAN IsConfigUpdate,\r
- IN BOOLEAN EnableSystemPoll\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpStop (\r
- IN MNP_SERVICE_DATA *MnpServiceData\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpConfigReceiveFilters (\r
- IN MNP_SERVICE_DATA *MnpServiceData\r
- );\r
-\r
-STATIC\r
-EFI_STATUS\r
-MnpGroupOpAddCtrlBlk (\r
- IN MNP_INSTANCE_DATA *Instance,\r
- IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk,\r
- IN MNP_GROUP_ADDRESS *GroupAddress OPTIONAL,\r
- IN EFI_MAC_ADDRESS *MacAddress,\r
- IN UINT32 HwAddressSize\r
- );\r
-\r
-STATIC\r
-BOOLEAN\r
-MnpGroupOpDelCtrlBlk (\r
- IN MNP_INSTANCE_DATA *Instance,\r
- IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk\r
- );\r
-\r
\r
/**\r
- Add some NET_BUF into MnpServiceData->FreeNbufQue. The buffer length of\r
- the NET_BUF is specified by MnpServiceData->BufferLength.\r
+ Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net\r
+ buffer is specified by MnpServiceData->BufferLength. \r
\r
- @param MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
- @param Count Number of NET_BUFFERs to add.\r
+ @param[in, out] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
+ @param[in] Count Number of NET_BUFFERs to add.\r
\r
- @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated and\r
- added into MnpServiceData->FreeNbufQue.\r
+ @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated \r
+ and added to MnpServiceData->FreeNbufQue.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate a NET_BUF structure.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpAddFreeNbuf (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN UINTN Count\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData,\r
+ IN UINTN Count\r
)\r
{\r
EFI_STATUS Status;\r
in the queue, first try to allocate some and add them into the queue, then\r
fetch the NET_BUF from the updated FreeNbufQue.\r
\r
- @param MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
+ @param[in, out] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
\r
- @return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed.\r
+ @return Pointer to the allocated free NET_BUF structure, if NULL the \r
+ operation is failed.\r
\r
**/\r
NET_BUF *\r
MnpAllocNbuf (\r
- IN MNP_SERVICE_DATA *MnpServiceData\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData\r
)\r
{\r
EFI_STATUS Status;\r
/**\r
Try to reclaim the Nbuf into the buffer pool.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Nbuf Pointer to the NET_BUF to free.\r
-\r
- @return None.\r
+ @param[in, out] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in, out] Nbuf Pointer to the NET_BUF to free.\r
\r
**/\r
VOID\r
MnpFreeNbuf (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN NET_BUF *Nbuf\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData,\r
+ IN OUT NET_BUF *Nbuf\r
)\r
{\r
EFI_TPL OldTpl;\r
/**\r
Initialize the mnp service context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Snp Pointer to the simple network protocol.\r
+ @param[in, out] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] ImageHandle The driver image handle.\r
+ @param[in] ControllerHandle Handle of device to bind driver to.\r
\r
@retval EFI_SUCCESS The mnp service context is initialized.\r
- @retval Other Some error occurs.\r
+ @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
MnpInitializeServiceData (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_HANDLE ControllerHandle\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData,\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_HANDLE ControllerHandle\r
)\r
{\r
EFI_STATUS Status;\r
/**\r
Flush the mnp service context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
-\r
- @return None.\r
+ @param[in, out] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] ImageHandle The driver image handle.\r
\r
**/\r
VOID\r
MnpFlushServiceData (\r
- MNP_SERVICE_DATA *MnpServiceData\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData,\r
+ IN EFI_HANDLE ImageHandle\r
)\r
{\r
NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE);\r
gBS->CloseProtocol (\r
MnpServiceData->ControllerHandle,\r
&gEfiSimpleNetworkProtocolGuid,\r
- This->DriverBindingHandle,\r
+ ImageHandle,\r
MnpServiceData->ControllerHandle\r
);\r
}\r
/**\r
Initialize the mnp instance context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param Instance Pointer to the mnp instance context data to\r
- initialize.\r
-\r
- @return None.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in, out] Instance Pointer to the mnp instance context data \r
+ to initialize.\r
\r
**/\r
VOID\r
MnpInitializeInstanceData (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN MNP_INSTANCE_DATA *Instance\r
+ IN MNP_SERVICE_DATA *MnpServiceData,\r
+ IN OUT MNP_INSTANCE_DATA *Instance\r
)\r
{\r
NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE);\r
\r
\r
/**\r
- Check whether the token specified by Arg maches the token in Item.\r
+ Check whether the token specified by Arg matches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to\r
+ @param[in] Map Pointer to the NET_MAP.\r
+ @param[in] Item Pointer to the NET_MAP_ITEM.\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
check.\r
\r
@retval EFI_SUCCESS The token specified by Arg is different from the\r
return EFI_SUCCESS;\r
}\r
\r
-\r
/**\r
Cancel the token specified by Arg if it matches the token in Item.\r
\r
- @param Map Pointer to the NET_MAP.\r
- @param Item Pointer to the NET_MAP_ITEM\r
- @param Arg Pointer to the Arg, it's a pointer to the token to\r
- cancel.\r
+ @param[in, out] Map Pointer to the NET_MAP.\r
+ @param[in, out] Item Pointer to the NET_MAP_ITEM.\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the \r
+ token to cancel.\r
\r
- @retval EFI_SUCCESS The Arg is NULL, and the token in Item is\r
- cancelled, or the Arg isn't NULL, and the token in\r
- Item is different from the Arg.\r
- @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the\r
- Arg, and the token is cancelled.\r
+ @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, \r
+ or the Arg isn't NULL, and the token in Item is\r
+ different from the Arg.\r
+ @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the\r
+ Arg, and the token is cancelled.\r
\r
**/\r
EFI_STATUS\r
MnpCancelTokens (\r
- IN NET_MAP *Map,\r
- IN NET_MAP_ITEM *Item,\r
- IN VOID *Arg\r
+ IN OUT NET_MAP *Map,\r
+ IN OUT NET_MAP_ITEM *Item,\r
+ IN VOID *Arg\r
)\r
{\r
EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TokenToCancel;\r
/**\r
Start and initialize the simple network.\r
\r
- @param Snp Pointer to the simple network protocol.\r
+ @param[in] Snp Pointer to the simple network protocol.\r
\r
@retval EFI_SUCCESS The simple network protocol is started.\r
- @retval Other Some error occurs.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpStartSnp (\r
IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp\r
/**\r
Stop the simple network.\r
\r
- @param Snp Pointer to the simple network protocol.\r
+ @param[in] Snp Pointer to the simple network protocol.\r
\r
@retval EFI_SUCCESS The simple network is stopped.\r
- @retval Other Some error occurs.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpStopSnp (\r
IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp\r
Start the managed network, this function is called when one instance is configured\r
or reconfigured.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param IsConfigUpdate The instance is reconfigured or it's the first time\r
- the instanced is configured.\r
- @param EnableSystemPoll Enable the system polling or not.\r
+ @param[in, out] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] IsConfigUpdate The instance is reconfigured or it's the first\r
+ time the instanced is configured.\r
+ @param[in] EnableSystemPoll Enable the system polling or not.\r
\r
- @retval EFI_SUCCESS The managed network is started and some\r
- configuration is updated.\r
- @retval Other Some error occurs.\r
+ @retval EFI_SUCCESS The managed network is started and some\r
+ configuration is updated.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpStart (\r
- IN MNP_SERVICE_DATA *MnpServiceData,\r
- IN BOOLEAN IsConfigUpdate,\r
- IN BOOLEAN EnableSystemPoll\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData,\r
+ IN BOOLEAN IsConfigUpdate,\r
+ IN BOOLEAN EnableSystemPoll\r
)\r
{\r
EFI_STATUS Status;\r
/**\r
Stop the managed network.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in, out] MnpServiceData Pointer to the mnp service context data.\r
\r
- @retval EFI_SUCCESS The managed network is stopped.\r
- @retval Other Some error occurs.\r
+ @retval EFI_SUCCESS The managed network is stopped.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpStop (\r
- IN MNP_SERVICE_DATA *MnpServiceData\r
+ IN OUT MNP_SERVICE_DATA *MnpServiceData\r
)\r
{\r
EFI_STATUS Status;\r
/**\r
Flush the instance's received data.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
-\r
- @return None.\r
+ @param[in, out] Instance Pointer to the mnp instance context data.\r
\r
**/\r
VOID\r
MnpFlushRcvdDataQueue (\r
- IN MNP_INSTANCE_DATA *Instance\r
+ IN OUT MNP_INSTANCE_DATA *Instance\r
)\r
{\r
EFI_TPL OldTpl;\r
/**\r
Configure the Instance using ConfigData.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param ConfigData Pointer to the configuration data used to configure\r
+ @param[in, out] Instance Pointer to the mnp instance context data.\r
+ @param[in] ConfigData Pointer to the configuration data used to configure\r
the isntance.\r
\r
@retval EFI_SUCCESS The Instance is configured.\r
@retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the\r
implementation doesn't support it.\r
- @retval Other Some error occurs.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
MnpConfigureInstance (\r
- IN MNP_INSTANCE_DATA *Instance,\r
- IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL\r
+ IN OUT MNP_INSTANCE_DATA *Instance,\r
+ IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL\r
)\r
{\r
EFI_STATUS Status;\r
return Status;\r
}\r
\r
-\r
/**\r
Configure the Snp receive filters according to the instances' receive filter\r
settings.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
\r
- @retval EFI_SUCCESS The receive filters is configured.\r
- @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due to lack\r
- of memory resource.\r
+ @retval EFI_SUCCESS The receive filters is configured.\r
+ @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due \r
+ to lack of memory resource.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpConfigReceiveFilters (\r
IN MNP_SERVICE_DATA *MnpServiceData\r
// multicast.\r
//\r
\r
- if (Snp->Mode->ReceiveFilterMask & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) {\r
+ if ((Snp->Mode->ReceiveFilterMask & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) {\r
EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST;\r
} else {\r
//\r
Add a group address control block which controls the MacAddress for\r
this instance.\r
\r
- @param Instance Pointer to the mnp instance context data.\r
- @param CtrlBlk Pointer to the group address control block.\r
- @param GroupAddress Pointer to the group adress.\r
- @param MacAddress Pointer to the mac address.\r
- @param HwAddressSize The hardware address size.\r
+ @param[in, out] Instance Pointer to the mnp instance context data.\r
+ @param[in, out] CtrlBlk Pointer to the group address control block.\r
+ @param[in, out] GroupAddress Pointer to the group adress.\r
+ @param[in] MacAddress Pointer to the mac address.\r
+ @param[in] HwAddressSize The hardware address size.\r
\r
- @retval EFI_SUCCESS The group address control block is added.\r
- @retval EFI_OUT_OF_RESOURCE Failed due to lack of memory resources.\r
+ @retval EFI_SUCCESS The group address control block is added.\r
+ @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
MnpGroupOpAddCtrlBlk (\r
- IN MNP_INSTANCE_DATA *Instance,\r
- IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk,\r
- IN MNP_GROUP_ADDRESS *GroupAddress OPTIONAL,\r
- IN EFI_MAC_ADDRESS *MacAddress,\r
- IN UINT32 HwAddressSize\r
+ IN OUT MNP_INSTANCE_DATA *Instance,\r
+ IN OUT MNP_GROUP_CONTROL_BLOCK *CtrlBlk,\r
+ IN OUT MNP_GROUP_ADDRESS *GroupAddress OPTIONAL,\r
+ IN EFI_MAC_ADDRESS *MacAddress,\r
+ IN UINT32 HwAddressSize\r
)\r
{\r
MNP_SERVICE_DATA *MnpServiceData;\r
Delete a group control block from the instance. If the controlled group address's\r
reference count reaches zero, the group address is removed too.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param CtrlBlk Pointer to the group control block to delete.\r
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] CtrlBlk Pointer to the group control block to delete.\r
\r
@return The group address controlled by the control block is no longer used or not.\r
\r
**/\r
-STATIC\r
BOOLEAN\r
MnpGroupOpDelCtrlBlk (\r
IN MNP_INSTANCE_DATA *Instance,\r
/**\r
Do the group operations for this instance.\r
\r
- @param Instance Pointer to the instance context data.\r
- @param JoinFlag Set to TRUE to join a group. Set to TRUE to leave a\r
- group/groups.\r
- @param MacAddress Pointer to the group address to join or leave.\r
- @param CtrlBlk Pointer to the group control block if JoinFlag if\r
- FALSE.\r
+ @param[in, out] Instance Pointer to the instance context data.\r
+ @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to \r
+ leave a group/groups.\r
+ @param[in] MacAddress Pointer to the group address to join or leave.\r
+ @param[in] CtrlBlk Pointer to the group control block if JoinFlag \r
+ is FALSE.\r
\r
- @retval EFI_SUCCESS The group operation finished.\r
- @retval Other Some error occurs.\r
+ @retval EFI_SUCCESS The group operation finished.\r
+ @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources.\r
+ @retval Others Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
MnpGroupOp (\r
- IN MNP_INSTANCE_DATA *Instance,\r
+ IN OUT MNP_INSTANCE_DATA *Instance,\r
IN BOOLEAN JoinFlag,\r
IN EFI_MAC_ADDRESS *MacAddress OPTIONAL,\r
IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL\r
projects / mirror_edk2.git / blobdiff