BeagleBoardPkg EmbeddedPkg Omap35xxPkg: move to ArmBaseLib

[mirror_edk2.git] / StdLib / EfiSocketLib / Init.c

diff --git a/StdLib/EfiSocketLib/Init.c b/StdLib/EfiSocketLib/Init.c
index 7a1b89da87a09c0a57331d49c745e02c0856631d..88d2065c2116e7ecb08c999ff1b4a2c8ef87b313 100644 (file)
--- a/StdLib/EfiSocketLib/Init.c
+++ b/StdLib/EfiSocketLib/Init.c
@@ -5,20 +5,35 @@
   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
+  http://opensource.org/licenses/bsd-license.\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
 **/\r
 \r
-#include <socket.h>\r
+#include "Socket.h"\r
 \r
 \r
 /**\r
   EFI Socket Library Constructor\r
 \r
-  @retval EFI_SUCCESS       The initialization was successful\r
+  This routine supports an implementation dependent constructor\r
+  depending upon whether the library is linked to a socket\r
+  application or the SocketDxe driver.  The following modules\r
+  declare the redirection for the constructor in ::mpfnEslConstructor:\r
+  <ul>\r
+    <li>StdLib/EfiSocketLib/UseSocketLib.c - Application links against EfiSocketLib</li>\r
+    <li>StdLib/SocketDxe/EntryUnload.c - SocketDxe links against EfiSocketLib</li>\r
+  </ul>\r
+\r
+  The EfiSocketLib.inf file lists ::EslConstructor as the CONSTRUCTOR\r
+  in the [Defines] section.  As a result, this routine is called by\r
+  the ProcessLibraryConstructorList routine of the AutoGen.c module\r
+  in the Build directory associated with the socket application or\r
+  the SocketDxe driver.\r
+\r
+  @retval EFI_SUCCESS       The socket layer initialization was successful\r
 \r
  **/\r
 EFI_STATUS\r
@@ -54,7 +69,22 @@ EslConstructor (
 /**\r
   EFI Socket Library Destructor\r
 \r
-  @retval EFI_SUCCESS       The shutdown was successful\r
+  This routine supports an implementation dependent destructor\r
+  depending upon whether the library is linked to a socket\r
+  application or the SocketDxe driver.  The following modules\r
+  declare the redirection for the destructor in ::mpfnEslDestructor:\r
+  <ul>\r
+    <li>StdLib/EfiSocketLib/UseSocketLib.c - Application links against EfiSocketLib</li>\r
+    <li>StdLib/SocketDxe/EntryUnload.c - SocketDxe links against EfiSocketLib</li>\r
+  </ul>\r
+\r
+  The EfiSocketLib.inf file lists ::EslDestructor as the DESTRUCTOR\r
+  in the [Defines] section.  As a result, this routine is called by\r
+  the ProcessLibraryDestructorList routine of the AutoGen.c module\r
+  in the Build directory associated with the socket application or\r
+  the SocketDxe driver.\r
+\r
+  @retval EFI_SUCCESS       The socket layer shutdown was successful\r
 \r
  **/\r
 EFI_STATUS\r