X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FLibrary%2FDxeNetLib%2FDxeNetLib.c;h=fb296e5f595d20f65698dcfc08a08ef5d1a5df6d;hb=7be273b7f583ef202bb4e3d4cede9e332cb306e5;hp=a1525ee69f5699356f3472eecc868299b2d34b3f;hpb=7b414b4ed6ccdefce8e167ecc7d67ad64118eb94;p=mirror_edk2.git diff --git a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c index a1525ee69f..fb296e5f59 100644 --- a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c +++ b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c @@ -1,6 +1,7 @@ /** @file - -Copyright (c) 2005 - 2007, Intel Corporation + Network library. + +Copyright (c) 2005 - 2009, Intel Corporation.
All rights reserved. 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 @@ -8,42 +9,38 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - -Module Name: - - NetLib.c - -Abstract: - - - **/ -#include +#include +#include #include #include -#include -#include +#include #include #include +#include + #include #include #include #include #include #include -#include #include +#include +#include +#include +GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 mNetLibHexStr[] = {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'}; -EFI_DPC_PROTOCOL *mDpc = NULL; +#define NIC_ITEM_CONFIG_SIZE sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE // // All the supported IP4 maskes in host byte order. // -IP4_ADDR mIp4AllMasks[IP4_MASK_NUM] = { +IP4_ADDR gIp4AllMasks[IP4_MASK_NUM] = { 0x00000000, 0x80000000, 0xC0000000, @@ -85,42 +82,16 @@ IP4_ADDR mIp4AllMasks[IP4_MASK_NUM] = { EFI_IPv4_ADDRESS mZeroIp4Addr = {{0, 0, 0, 0}}; /** - Converts the low nibble of a byte to hex unicode character. - - @param Nibble lower nibble of a byte. - - @return Hex unicode character. - -**/ -CHAR16 -NibbleToHexChar ( - IN UINT8 Nibble - ) -{ - // - // Porting Guide: - // This library interface is simply obsolete. - // Include the source code to user code. - // - - Nibble &= 0x0F; - if (Nibble <= 0x9) { - return (CHAR16)(Nibble + L'0'); - } - - return (CHAR16)(Nibble - 0xA + L'A'); -} - -/** - Return the length of the mask. If the mask is invalid, - return the invalid length 33, which is IP4_MASK_NUM. + Return the length of the mask. + + Return the length of the mask, the correct value is from 0 to 32. + If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM. NetMask is in the host byte order. - @param NetMask The netmask to get the length from - - @return The length of the netmask, IP4_MASK_NUM if the mask isn't - @return supported. + @param[in] NetMask The netmask to get the length from. + @return The length of the netmask, IP4_MASK_NUM if the mask is invalid. + **/ INTN EFIAPI @@ -131,7 +102,7 @@ NetGetMaskLength ( INTN Index; for (Index = 0; Index < IP4_MASK_NUM; Index++) { - if (NetMask == mIp4AllMasks[Index]) { + if (NetMask == gIp4AllMasks[Index]) { break; } } @@ -142,12 +113,24 @@ NetGetMaskLength ( /** - Return the class of the address, such as class a, b, c. + Return the class of the IP address, such as class A, B, C. Addr is in host byte order. - - @param Addr The address to get the class from - - @return IP address class, such as IP4_ADDR_CLASSA + + The address of class A starts with 0. + If the address belong to class A, return IP4_ADDR_CLASSA. + The address of class B starts with 10. + If the address belong to class B, return IP4_ADDR_CLASSB. + The address of class C starts with 110. + If the address belong to class C, return IP4_ADDR_CLASSC. + The address of class D starts with 1110. + If the address belong to class D, return IP4_ADDR_CLASSD. + The address of class E starts with 1111. + If the address belong to class E, return IP4_ADDR_CLASSE. + + + @param[in] Addr The address to get the class from. + + @return IP address class, such as IP4_ADDR_CLASSA. **/ INTN @@ -181,13 +164,17 @@ NetGetIpClass ( /** Check whether the IP is a valid unicast address according to - the netmask. If NetMask is zero, use the IP address's class to - get the default mask. + the netmask. If NetMask is zero, use the IP address's class to get the default mask. + + If Ip is 0, IP is not a valid unicast address. + Class D address is used for multicasting and class E address is reserved for future. If Ip + belongs to class D or class E, IP is not a valid unicast address. + If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address. - @param Ip The IP to check againist - @param NetMask The mask of the IP + @param[in] Ip The IP to check against. + @param[in] NetMask The mask of the IP. - @return TRUE if IP is a valid unicast address on the network, otherwise FALSE + @return TRUE if IP is a valid unicast address on the network, otherwise FALSE. **/ BOOLEAN @@ -206,7 +193,7 @@ Ip4IsUnicast ( } if (NetMask == 0) { - NetMask = mIp4AllMasks[Class << 3]; + NetMask = gIp4AllMasks[Class << 3]; } if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) { @@ -216,12 +203,86 @@ Ip4IsUnicast ( return TRUE; } +/** + Check whether the incoming IPv6 address is a valid unicast address. + + If the address is a multicast address has binary 0xFF at the start, it is not + a valid unicast address. If the address is unspecified ::, it is not a valid + unicast address to be assigned to any node. If the address is loopback address + ::1, it is also not a valid unicast address to be assigned to any physical + interface. + + @param[in] Ip6 The IPv6 address to check against. + + @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE. + +**/ +BOOLEAN +Ip6IsValidUnicast ( + IN EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT8 Byte; + UINT8 Index; + + if (Ip6->Addr[0] == 0xFF) { + return FALSE; + } + + for (Index = 0; Index < 15; Index++) { + if (Ip6->Addr[Index] != 0) { + return TRUE; + } + } + + Byte = Ip6->Addr[Index]; + + if (Byte == 0x0 || Byte == 0x1) { + return FALSE; + } + + return TRUE; +} /** - Initialize a random seed using current time. + Switches the endianess of an IPv6 address + + This function swaps the bytes in a 128-bit IPv6 address to switch the value + from little endian to big endian or vice versa. The byte swapped value is + returned. + + @param Ip6 Points to an IPv6 address + + @return The byte swapped IPv6 address. + +**/ +EFI_IPv6_ADDRESS * +Ip6Swap128 ( + EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT64 High; + UINT64 Low; + + CopyMem (&High, Ip6, sizeof (UINT64)); + CopyMem (&Low, &Ip6->Addr[8], sizeof (UINT64)); + + High = SwapBytes64 (High); + Low = SwapBytes64 (Low); + + CopyMem (Ip6, &Low, sizeof (UINT64)); + CopyMem (&Ip6->Addr[8], &High, sizeof (UINT64)); - None + return Ip6; +} +/** + Initialize a random seed using current time. + + Get current time first. Then initialize a random seed based on some basic + mathematics operation on the hour, day, minute, second, nanosecond and year + of the current time. + @return The random seed initialized with current time. **/ @@ -244,10 +305,12 @@ NetRandomInitSeed ( /** - Extract a UINT32 from a byte stream, then convert it to host - byte order. Use this function to avoid alignment error. + Extract a UINT32 from a byte stream. + + Copy a UINT32 from a byte stream, then converts it from Network + byte order to host byte order. Use this function to avoid alignment error. - @param Buf The buffer to extract the UINT32. + @param[in] Buf The buffer to extract the UINT32. @return The UINT32 extracted. @@ -266,20 +329,20 @@ NetGetUint32 ( /** - Put a UINT32 to the byte stream. Convert it from host byte order - to network byte order before putting. - - @param Buf The buffer to put the UINT32 - @param Data The data to put - - @return None - + Put a UINT32 to the byte stream in network byte order. + + Converts a UINT32 from host byte order to network byte order. Then copy it to the + byte stream. + + @param[in, out] Buf The buffer to put the UINT32. + @param[in] Data The data to put. + **/ VOID EFIAPI NetPutUint32 ( - IN UINT8 *Buf, - IN UINT32 Data + IN OUT UINT8 *Buf, + IN UINT32 Data ) { Data = HTONL (Data); @@ -288,17 +351,27 @@ NetPutUint32 ( /** - Remove the first entry on the list + Remove the first node entry on the list, and return the removed node entry. + + Removes the first node Entry from a doubly linked list. It is up to the caller of + this function to release the memory used by the first node if that is required. On + exit, the removed node is returned. + + If Head is NULL, then ASSERT(). + If Head was not initialized, then ASSERT(). + If PcdMaximumLinkedListLength is not zero, and the number of nodes in the + linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, + then ASSERT(). - @param Head The list header + @param[in, out] Head The list header. - @return The entry that is removed from the list, NULL if the list is empty. + @return The first node entry that is removed from the list, NULL if the list is empty. **/ LIST_ENTRY * EFIAPI NetListRemoveHead ( - LIST_ENTRY *Head + IN OUT LIST_ENTRY *Head ) { LIST_ENTRY *First; @@ -323,17 +396,27 @@ NetListRemoveHead ( /** - Remove the last entry on the list + Remove the last node entry on the list and and return the removed node entry. - @param Head The list head + Removes the last node entry from a doubly linked list. It is up to the caller of + this function to release the memory used by the first node if that is required. On + exit, the removed node is returned. - @return The entry that is removed from the list, NULL if the list is empty. + If Head is NULL, then ASSERT(). + If Head was not initialized, then ASSERT(). + If PcdMaximumLinkedListLength is not zero, and the number of nodes in the + linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, + then ASSERT(). + + @param[in, out] Head The list head. + + @return The last node entry that is removed from the list, NULL if the list is empty. **/ LIST_ENTRY * EFIAPI NetListRemoveTail ( - LIST_ENTRY *Head + IN OUT LIST_ENTRY *Head ) { LIST_ENTRY *Last; @@ -358,19 +441,20 @@ NetListRemoveTail ( /** - Insert the NewEntry after the PrevEntry - - @param PrevEntry The previous entry to insert after - @param NewEntry The new entry to insert - - @return None + Insert a new node entry after a designated node entry of a doubly linked list. + + Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry + of the doubly linked list. + + @param[in, out] PrevEntry The previous entry to insert after. + @param[in, out] NewEntry The new entry to insert. **/ VOID EFIAPI NetListInsertAfter ( - IN LIST_ENTRY *PrevEntry, - IN LIST_ENTRY *NewEntry + IN OUT LIST_ENTRY *PrevEntry, + IN OUT LIST_ENTRY *NewEntry ) { NewEntry->BackLink = PrevEntry; @@ -381,19 +465,20 @@ NetListInsertAfter ( /** - Insert the NewEntry before the PostEntry - - @param PostEntry The entry to insert before - @param NewEntry The new entry to insert - - @return None + Insert a new node entry before a designated node entry of a doubly linked list. + + Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry + of the doubly linked list. + + @param[in, out] PostEntry The entry to insert before. + @param[in, out] NewEntry The new entry to insert. **/ VOID EFIAPI NetListInsertBefore ( - IN LIST_ENTRY *PostEntry, - IN LIST_ENTRY *NewEntry + IN OUT LIST_ENTRY *PostEntry, + IN OUT LIST_ENTRY *NewEntry ) { NewEntry->ForwardLink = PostEntry; @@ -405,16 +490,22 @@ NetListInsertBefore ( /** Initialize the netmap. Netmap is a reposity to keep the pairs. - - @param Map The netmap to initialize - - @return None + + Initialize the forward and backward links of two head nodes donated by Map->Used + and Map->Recycled of two doubly linked lists. + Initializes the count of the pairs in the netmap to zero. + + If Map is NULL, then ASSERT(). + If the address of Map->Used is NULL, then ASSERT(). + If the address of Map->Recycled is NULl, then ASSERT(). + + @param[in, out] Map The netmap to initialize. **/ VOID EFIAPI NetMapInit ( - IN NET_MAP *Map + IN OUT NET_MAP *Map ) { ASSERT (Map != NULL); @@ -427,16 +518,20 @@ NetMapInit ( /** To clean up the netmap, that is, release allocated memories. - - @param Map The netmap to clean up. - - @return None + + Removes all nodes of the Used doubly linked list and free memory of all related netmap items. + Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items. + The number of the pairs in the netmap is set to be zero. + + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to clean up. **/ VOID EFIAPI NetMapClean ( - IN NET_MAP *Map + IN OUT NET_MAP *Map ) { NET_MAP_ITEM *Item; @@ -468,9 +563,14 @@ NetMapClean ( /** - Test whether the netmap is empty - - @param Map The net map to test + Test whether the netmap is empty and return true if it is. + + If the number of the pairs in the netmap is zero, return TRUE. + + If Map is NULL, then ASSERT(). + + + @param[in] Map The net map to test. @return TRUE if the netmap is empty, otherwise FALSE. @@ -489,7 +589,7 @@ NetMapIsEmpty ( /** Return the number of the pairs in the netmap. - @param Map The netmap to get the entry number + @param[in] Map The netmap to get the entry number. @return The entry number in the netmap. @@ -505,18 +605,24 @@ NetMapGetCount ( /** - Allocate an item for the netmap. It will try to allocate - a batch of items and return one. - - @param Map The netmap to allocate item for - - @return The allocated item or NULL + Return one allocated item. + + If the Recycled doubly linked list of the netmap is empty, it will try to allocate + a batch of items if there are enough resources and add corresponding nodes to the begining + of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove + the fist node entry of the Recycled doubly linked list and return the corresponding item. + + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to allocate item for. + + @return The allocated item. If NULL, the + allocation failed due to resource limit. **/ -STATIC NET_MAP_ITEM * NetMapAllocItem ( - IN NET_MAP *Map + IN OUT NET_MAP *Map ) { NET_MAP_ITEM *Item; @@ -552,19 +658,25 @@ NetMapAllocItem ( /** Allocate an item to save the pair to the head of the netmap. + + Allocate an item to save the pair and add corresponding node entry + to the beginning of the Used doubly linked list. The number of the + pairs in the netmap increase by 1. - @param Map The netmap to insert into - @param Key The user's key - @param Value The user's value for the key + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to insert into. + @param[in] Key The user's key. + @param[in] Value The user's value for the key. - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item - @retval EFI_SUCCESS The item is inserted to the head + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. + @retval EFI_SUCCESS The item is inserted to the head. **/ EFI_STATUS EFIAPI NetMapInsertHead ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL ) @@ -591,18 +703,24 @@ NetMapInsertHead ( /** Allocate an item to save the pair to the tail of the netmap. - @param Map The netmap to insert into - @param Key The user's key - @param Value The user's value for the key + Allocate an item to save the pair and add corresponding node entry + to the tail of the Used doubly linked list. The number of the + pairs in the netmap increase by 1. - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item - @retval EFI_SUCCESS The item is inserted to the tail + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to insert into. + @param[in] Key The user's key. + @param[in] Value The user's value for the key. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. + @retval EFI_SUCCESS The item is inserted to the tail. **/ EFI_STATUS EFIAPI NetMapInsertTail ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, IN VOID *Key, IN VOID *Value OPTIONAL ) @@ -628,15 +746,14 @@ NetMapInsertTail ( /** - Check whther the item is in the Map + Check whether the item is in the Map and return TRUE if it is. - @param Map The netmap to search within - @param Item The item to search + @param[in] Map The netmap to search within. + @param[in] Item The item to search. @return TRUE if the item is in the netmap, otherwise FALSE. **/ -STATIC BOOLEAN NetItemInMap ( IN NET_MAP *Map, @@ -656,10 +773,15 @@ NetItemInMap ( /** - Find the key in the netmap + Find the key in the netmap and returns the point to the item contains the Key. + + Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every + item with the key to search. It returns the point to the item contains the Key if found. - @param Map The netmap to search within - @param Key The key to search + If Map is NULL, then ASSERT(). + + @param[in] Map The netmap to search within. + @param[in] Key The key to search. @return The point to the item contains the Key, or NULL if Key isn't in the map. @@ -689,21 +811,30 @@ NetMapFindKey ( /** - Remove the item from the netmap - - @param Map The netmap to remove the item from - @param Item The item to remove - @param Value The variable to receive the value if not NULL - - @return The key of the removed item. + Remove the node entry of the item from the netmap and return the key of the removed item. + + Remove the node entry of the item from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL, + Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If Item is NULL, then ASSERT(). + if item in not in the netmap, then ASSERT(). + + @param[in, out] Map The netmap to remove the item from. + @param[in, out] Item The item to remove. + @param[out] Value The variable to receive the value if not NULL. + + @return The key of the removed item. **/ VOID * EFIAPI NetMapRemoveItem ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - OUT VOID **Value OPTIONAL + IN OUT NET_MAP *Map, + IN OUT NET_MAP_ITEM *Item, + OUT VOID **Value OPTIONAL ) { ASSERT ((Map != NULL) && (Item != NULL)); @@ -722,18 +853,26 @@ NetMapRemoveItem ( /** - Remove the first entry on the netmap + Remove the first node entry on the netmap and return the key of the removed item. - @param Map The netmap to remove the head from - @param Value The variable to receive the value if not NULL + Remove the first node entry from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, + parameter Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If the Used doubly linked list is empty, then ASSERT(). + + @param[in, out] Map The netmap to remove the head from. + @param[out] Value The variable to receive the value if not NULL. - @return The key of the item removed + @return The key of the item removed. **/ VOID * EFIAPI NetMapRemoveHead ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, OUT VOID **Value OPTIONAL ) { @@ -759,18 +898,26 @@ NetMapRemoveHead ( /** - Remove the last entry on the netmap + Remove the last node entry on the netmap and return the key of the removed item. - @param Map The netmap to remove the tail from - @param Value The variable to receive the value if not NULL + Remove the last node entry from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, + parameter Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If the Used doubly linked list is empty, then ASSERT(). + + @param[in, out] Map The netmap to remove the tail from. + @param[out] Value The variable to receive the value if not NULL. - @return The key of the item removed + @return The key of the item removed. **/ VOID * EFIAPI NetMapRemoveTail ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, OUT VOID **Value OPTIONAL ) { @@ -796,16 +943,22 @@ NetMapRemoveTail ( /** - Iterate through the netmap and call CallBack for each item. It will - contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break - from the loop. It returns the CallBack's last return value. This - function is delete safe for the current item. - - @param Map The Map to iterate through - @param CallBack The callback function to call for each item. - @param Arg The opaque parameter to the callback - - @return It returns the CallBack's last return value. + Iterate through the netmap and call CallBack for each item. + + It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break + from the loop. It returns the CallBack's last return value. This function is + delete safe for the current item. + + If Map is NULL, then ASSERT(). + If CallBack is NULL, then ASSERT(). + + @param[in] Map The Map to iterate through. + @param[in] CallBack The callback function to call for each item. + @param[in] Arg The opaque parameter to the callback. + + @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item + return EFI_SUCCESS. + @retval Others It returns the CallBack's last return value. **/ EFI_STATUS @@ -820,8 +973,8 @@ NetMapIterate ( LIST_ENTRY *Entry; LIST_ENTRY *Next; LIST_ENTRY *Head; - NET_MAP_ITEM *Item; - EFI_STATUS Result; + NET_MAP_ITEM *Item; + EFI_STATUS Result; ASSERT ((Map != NULL) && (CallBack != NULL)); @@ -847,7 +1000,10 @@ NetMapIterate ( /** This is the default unload handle for all the network drivers. - @param ImageHandle The drivers' driver image. + Disconnect the driver specified by ImageHandle from all the devices in the handle database. + Uninstall all the protocols installed in the driver entry point. + + @param[in] ImageHandle The drivers' driver image. @retval EFI_SUCCESS The image is unloaded. @retval Others Failed to unload the image. @@ -960,11 +1116,16 @@ NetLibDefaultUnload ( /** Create a child of the service that is identified by ServiceBindingGuid. + + Get the ServiceBinding Protocol first, then use it to create a child. - @param Controller The controller which has the service installed. - @param Image The image handle used to open service. - @param ServiceBindingGuid The service's Guid. - @param ChildHandle The handle to receive the create child + If ServiceBindingGuid is NULL, then ASSERT(). + If ChildHandle is NULL, then ASSERT(). + + @param[in] Controller The controller which has the service installed. + @param[in] Image The image handle used to open service. + @param[in] ServiceBindingGuid The service's Guid. + @param[in, out] ChildHandle The handle to receive the create child. @retval EFI_SUCCESS The child is successfully created. @retval Others Failed to create the child. @@ -976,7 +1137,7 @@ NetLibCreateServiceChild ( IN EFI_HANDLE Controller, IN EFI_HANDLE Image, IN EFI_GUID *ServiceBindingGuid, - OUT EFI_HANDLE *ChildHandle + IN OUT EFI_HANDLE *ChildHandle ) { EFI_STATUS Status; @@ -1011,11 +1172,15 @@ NetLibCreateServiceChild ( /** Destory a child of the service that is identified by ServiceBindingGuid. - - @param Controller The controller which has the service installed. - @param Image The image handle used to open service. - @param ServiceBindingGuid The service's Guid. - @param ChildHandle The child to destory + + Get the ServiceBinding Protocol first, then use it to destroy a child. + + If ServiceBindingGuid is NULL, then ASSERT(). + + @param[in] Controller The controller which has the service installed. + @param[in] Image The image handle used to open service. + @param[in] ServiceBindingGuid The service's Guid. + @param[in] ChildHandle The child to destory. @retval EFI_SUCCESS The child is successfully destoried. @retval Others Failed to destory the child. @@ -1064,23 +1229,29 @@ NetLibDestroyServiceChild ( SnpHandle to a unicode string. Callers are responsible for freeing the string storage. - @param SnpHandle The handle where the simple network protocol is - installed on. - @param ImageHandle The image handle used to act as the agent handle to - get the simple network protocol. - @param MacString The pointer to store the address of the string - representation of the mac address. + Get the mac address of the Simple Network protocol from the SnpHandle. Then convert + the mac address into a unicode string. It takes 2 unicode characters to represent + a 1 byte binary buffer. Plus one unicode character for the null-terminator. + + @param[in] SnpHandle The handle where the simple network protocol is + installed on. + @param[in] ImageHandle The image handle used to act as the agent handle to + get the simple network protocol. + @param[out] MacString The pointer to store the address of the string + representation of the mac address. + + @retval EFI_SUCCESS Convert the mac address a unicode string successfully. @retval EFI_OUT_OF_RESOURCES There are not enough memory resource. - @retval other Failed to open the simple network protocol. + @retval Others Failed to open the simple network protocol. **/ EFI_STATUS EFIAPI NetLibGetMacString ( - IN EFI_HANDLE SnpHandle, - IN EFI_HANDLE ImageHandle, - IN OUT CHAR16 **MacString + IN EFI_HANDLE SnpHandle, + IN EFI_HANDLE ImageHandle, + OUT CHAR16 **MacString ) { EFI_STATUS Status; @@ -1121,8 +1292,8 @@ NetLibGetMacString ( // Convert the mac address into a unicode string. // for (Index = 0; Index < Mode->HwAddressSize; Index++) { - MacAddress[Index * 2] = NibbleToHexChar ((UINT8) (Mode->CurrentAddress.Addr[Index] >> 4)); - MacAddress[Index * 2 + 1] = NibbleToHexChar (Mode->CurrentAddress.Addr[Index]); + MacAddress[Index * 2] = (CHAR16) mNetLibHexStr[(Mode->CurrentAddress.Addr[Index] >> 4) & 0x0F]; + MacAddress[Index * 2 + 1] = (CHAR16) mNetLibHexStr[Mode->CurrentAddress.Addr[Index] & 0x0F]; } MacAddress[Mode->HwAddressSize * 2] = L'\0'; @@ -1136,73 +1307,139 @@ NetLibGetMacString ( Check the default address used by the IPv4 driver is static or dynamic (acquired from DHCP). - @param Controller The controller handle which has the NIC Ip4 Config Protocol - relative with the default address to judge. + If the controller handle does not have the NIC Ip4 Config Protocol installed, the + default address is static. If the EFI variable to save the configuration is not found, + the default address is static. Otherwise, get the result from the EFI variable which + saving the configuration. + + @param[in] Controller The controller handle which has the NIC Ip4 Config Protocol + relative with the default address to judge. @retval TRUE If the default address is static. @retval FALSE If the default address is acquired from DHCP. **/ -STATIC BOOLEAN NetLibDefaultAddressIsStatic ( IN EFI_HANDLE Controller ) { - EFI_STATUS Status; - EFI_NIC_IP4_CONFIG_PROTOCOL *NicIp4; - UINTN Len; - NIC_IP4_CONFIG_INFO *ConfigInfo; - BOOLEAN IsStatic; - - Status = gBS->HandleProtocol ( - Controller, - &gEfiNicIp4ConfigProtocolGuid, - (VOID **) &NicIp4 - ); + EFI_STATUS Status; + EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting; + UINTN Len; + NIC_IP4_CONFIG_INFO *ConfigInfo; + BOOLEAN IsStatic; + EFI_STRING ConfigHdr; + EFI_STRING ConfigResp; + EFI_STRING AccessProgress; + EFI_STRING AccessResults; + EFI_STRING String; + + ConfigInfo = NULL; + ConfigHdr = NULL; + ConfigResp = NULL; + AccessProgress = NULL; + AccessResults = NULL; + IsStatic = TRUE; + + Status = gBS->LocateProtocol ( + &gEfiHiiConfigRoutingProtocolGuid, + NULL, + (VOID **) &HiiConfigRouting + ); if (EFI_ERROR (Status)) { return TRUE; } - Len = 0; - Status = NicIp4->GetInfo (NicIp4, &Len, NULL); - if (Status != EFI_BUFFER_TOO_SMALL) { + // + // Construct config request string header + // + ConfigHdr = HiiConstructConfigHdr (&gEfiNicIp4ConfigVariableGuid, EFI_NIC_IP4_CONFIG_VARIABLE, Controller); + if (ConfigHdr == NULL) { return TRUE; } + + Len = StrLen (ConfigHdr); + ConfigResp = AllocateZeroPool ((Len + NIC_ITEM_CONFIG_SIZE * 2 + 100) * sizeof (CHAR16)); + if (ConfigResp == NULL) { + goto ON_EXIT; + } + StrCpy (ConfigResp, ConfigHdr); + + String = ConfigResp + Len; + UnicodeSPrint ( + String, + (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16), + L"&OFFSET=%04X&WIDTH=%04X", + OFFSET_OF (NIC_IP4_CONFIG_INFO, Source), + sizeof (UINT32) + ); + + Status = HiiConfigRouting->ExtractConfig ( + HiiConfigRouting, + ConfigResp, + &AccessProgress, + &AccessResults + ); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } - ConfigInfo = AllocatePool (Len); + ConfigInfo = AllocateZeroPool (sizeof (NIC_ITEM_CONFIG_SIZE)); if (ConfigInfo == NULL) { - return TRUE; + goto ON_EXIT; } - IsStatic = TRUE; - Status = NicIp4->GetInfo (NicIp4, &Len, ConfigInfo); + ConfigInfo->Source = IP4_CONFIG_SOURCE_STATIC; + Len = NIC_ITEM_CONFIG_SIZE; + Status = HiiConfigRouting->ConfigToBlock ( + HiiConfigRouting, + AccessResults, + (UINT8 *) ConfigInfo, + &Len, + &AccessProgress + ); if (EFI_ERROR (Status)) { goto ON_EXIT; } IsStatic = (BOOLEAN) (ConfigInfo->Source == IP4_CONFIG_SOURCE_STATIC); - + ON_EXIT: - gBS->FreePool (ConfigInfo); + if (AccessResults != NULL) { + FreePool (AccessResults); + } + if (ConfigInfo != NULL) { + FreePool (ConfigInfo); + } + if (ConfigResp != NULL) { + FreePool (ConfigResp); + } + if (ConfigHdr != NULL) { + FreePool (ConfigHdr); + } return IsStatic; } /** Create an IPv4 device path node. + + The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. + The header subtype of IPv4 device path node is MSG_IPv4_DP. + The length of the IPv4 device path node in bytes is 19. + Get other info from parameters to make up the whole IPv4 device path node. + + @param[in, out] Node Pointer to the IPv4 device path node. + @param[in] Controller The handle where the NIC IP4 config protocol resides. + @param[in] LocalIp The local IPv4 address. + @param[in] LocalPort The local port. + @param[in] RemoteIp The remote IPv4 address. + @param[in] RemotePort The remote port. + @param[in] Protocol The protocol type in the IP header. + @param[in] UseDefaultAddress Whether this instance is using default address or not. - @param Node Pointer to the IPv4 device path node. - @param Controller The handle where the NIC IP4 config protocol resides. - @param LocalIp The local IPv4 address. - @param LocalPort The local port. - @param RemoteIp The remote IPv4 address. - @param RemotePort The remote port. - @param Protocol The protocol type in the IP header. - @param UseDefaultAddress Whether this instance is using default address or not. - - @retval None **/ VOID EFIAPI @@ -1239,6 +1476,7 @@ NetLibCreateIPv4DPathNode ( /** Find the UNDI/SNP handle from controller and protocol GUID. + For example, IP will open a MNP child to transmit/receive packets, when MNP is stopped, IP should also be stopped. IP needs to find its own private data which is related the IP's @@ -1247,10 +1485,10 @@ NetLibCreateIPv4DPathNode ( IP opens these handle BY_DRIVER, use that info, we can get the UNDI/SNP handle. - @param Controller Then protocol handle to check - @param ProtocolGuid The protocol that is related with the handle. + @param[in] Controller Then protocol handle to check. + @param[in] ProtocolGuid The protocol that is related with the handle. - @return The UNDI/SNP handle or NULL. + @return The UNDI/SNP handle or NULL for errors. **/ EFI_HANDLE @@ -1289,74 +1527,3 @@ NetLibGetNicHandle ( gBS->FreePool (OpenBuffer); return Handle; } - -/** - Add a Deferred Procedure Call to the end of the DPC queue. - - @DpcTpl The EFI_TPL that the DPC should be invoked. - @DpcProcedure Pointer to the DPC's function. - @DpcContext Pointer to the DPC's context. Passed to DpcProcedure - when DpcProcedure is invoked. - - @retval EFI_SUCCESS The DPC was queued. - @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. - DpcProcedure is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - add the DPC to the queue. - -**/ -EFI_STATUS -EFIAPI -NetLibQueueDpc ( - IN EFI_TPL DpcTpl, - IN EFI_DPC_PROCEDURE DpcProcedure, - IN VOID *DpcContext OPTIONAL - ) -{ - return mDpc->QueueDpc (mDpc, DpcTpl, DpcProcedure, DpcContext); -} - -/** - Add a Deferred Procedure Call to the end of the DPC queue. - - @retval EFI_SUCCESS One or more DPCs were invoked. - @retval EFI_NOT_FOUND No DPCs were invoked. - -**/ -EFI_STATUS -EFIAPI -NetLibDispatchDpc ( - VOID - ) -{ - return mDpc->DispatchDpc(mDpc); -} - - -/** - The constructor function caches the pointer to DPC protocol. - - The constructor function locates DPC protocol from protocol database. - It will ASSERT() if that operation fails and it will always return EFI_SUCCESS. - - @param ImageHandle The firmware allocated handle for the EFI image. - @param SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS. - -**/ -EFI_STATUS -EFIAPI -NetLibConstructor ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - EFI_STATUS Status; - - Status = gBS->LocateProtocol (&gEfiDpcProtocolGuid, NULL, (VOID**) &mDpc); - ASSERT_EFI_ERROR (Status); - ASSERT (mDpc != NULL); - - return Status; -}