/** @file\r
Implementation of Managed Network Protocol private services.\r
-\r
-Copyright (c) 2005 - 2008, 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
+Copyright (c) 2005 - 2008, Intel Corporation.<BR>\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
\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
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 \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] 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 \r
and added to MnpServiceData->FreeNbufQue.\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] MnpServiceData Pointer to the MNP_SERVICE_DATA.\r
\r
@return Pointer to the allocated free NET_BUF structure, if NULL the \r
operation is failed.\r
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param Nbuf Pointer to the NET_BUF to free.\r
-\r
+ \r
**/\r
VOID\r
MnpFreeNbuf (\r
/**\r
Initialize the mnp service context data.\r
\r
- @param MnpServiceData Pointer to the mnp service context data.\r
- @param ImageHandle The driver image handle.\r
- @param ControllerHandle Handle of device to bind driver to.\r
+ @param[in] 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
\r
@param MnpServiceData Pointer to the mnp service context data.\r
@param ImageHandle The driver image handle.\r
-\r
+ \r
**/\r
VOID\r
MnpFlushServiceData (\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
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] Instance Pointer to the mnp instance context data to\r
initialize.\r
\r
**/\r
/**\r
Check whether the token specified by Arg maches 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
/**\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] Item Pointer to the NET_MAP_ITEM\r
+ @param[in] Arg Pointer to the Arg, it's a pointer to the token to\r
+ cancel.\r
\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
/**\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
/**\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
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
+ @param[in] MnpServiceData Pointer to the mnp service context data.\r
+ @param[in] 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] EnableSystemPoll Enable the system polling or not.\r
\r
@retval EFI_SUCCESS The managed network is started and some\r
configuration is updated.\r
/**\r
Stop the managed network.\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 managed network is stopped.\r
@retval Other Some error occurs.\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] 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
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] Instance Pointer to the mnp instance context data.\r
+ @param[in] CtrlBlk Pointer to the group address control block.\r
+ @param[in] 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
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
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
+ @param[in] Instance Pointer to the instance context data.\r
+ @param[in] 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
+ @param[in] MacAddress Pointer to the group address to join or leave.\r
+ @param[in] CtrlBlk Pointer to the group control block if JoinFlag if\r
FALSE.\r
\r
@retval EFI_SUCCESS The group operation finished.\r
projects / mirror_edk2.git / blobdiff