IntelFsp2WrapperPkg: Update gFspWrapperTokenSpaceGuid to gIntelFsp2WrapperTokenSpaceGuid.

[mirror_edk2.git] / StdLib / BsdSocketLib / socket.c

diff --git a/StdLib/BsdSocketLib/socket.c b/StdLib/BsdSocketLib/socket.c
index e78329291cdd21c5c6a0215b63786e299769ca0a..6b00f41f40696cd5524c58d34617b606ab1c2122 100644 (file)
--- a/StdLib/BsdSocketLib/socket.c
+++ b/StdLib/BsdSocketLib/socket.c
@@ -15,6 +15,12 @@
 #include <SocketInternals.h>\r
 \r
 \r
+/**\r
+  File system interface for the socket layer.\r
+\r
+  This data structure defines the routines for the various\r
+  file system functions associated with the socket layer.\r
+**/\r
 const struct fileops SocketOperations = {\r
   BslSocketClose,     //  close\r
   BslSocketRead,      //  read\r
@@ -47,7 +53,7 @@ const struct fileops SocketOperations = {
                             address for the file\r
   @param [in] pErrno        Address of the errno variable\r
 \r
-  @return   A pointer to the socket protocol structure or NULL if\r
+  @return   A pointer to the EFI_SOCKET_PROTOCOL structure or NULL if\r
             an invalid file descriptor was passed in.\r
 \r
  **/\r
@@ -79,7 +85,7 @@ BslFdToSocketProtocol (
     //\r
     //  Get the descriptor for the file\r
     //\r
-    pDescriptor = &gMD->fdarray [ s ];\r
+    pDescriptor = &gMD->fdarray[ s ];\r
 \r
     //\r
     //  Validate that the descriptor is associated with sockets\r
@@ -125,7 +131,7 @@ BslSocketProtocolToFd (
   //  Locate a file descriptor\r
   //\r
   FileDescriptor = FindFreeFD ( VALID_CLOSED );\r
-  if( FileDescriptor < 0 ) {\r
+  if ( FileDescriptor < 0 ) {\r
     //\r
     // All available FDs are in use\r
     //\r
@@ -135,12 +141,12 @@ BslSocketProtocolToFd (
     //\r
     //  Initialize the file descriptor\r
     //\r
-    pDescriptor = &gMD->fdarray [ FileDescriptor ];\r
+    pDescriptor = &gMD->fdarray[ FileDescriptor ];\r
     pDescriptor->f_offset = 0;\r
     pDescriptor->f_flag = 0;\r
     pDescriptor->f_iflags = DTYPE_SOCKET;\r
     pDescriptor->MyFD = (UINT16)FileDescriptor;\r
-    pDescriptor->Oflags = 0;\r
+    pDescriptor->Oflags = O_RDWR;\r
     pDescriptor->Omode = S_ACC_READ | S_ACC_WRITE;\r
     pDescriptor->RefCount = 1;\r
     FILE_SET_MATURE ( pDescriptor );\r
@@ -162,28 +168,33 @@ BslSocketProtocolToFd (
 /**\r
   Creates an endpoint for network communication.\r
 \r
-  The ::Socket routine initializes the communication endpoint by providing\r
-  the support for the socket library function ::socket.  The\r
+  The socket routine initializes the communication endpoint and returns a\r
+  file descriptor.\r
+\r
+  The\r
   <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html">POSIX</a>\r
-  documentation for the socket routine is available online for reference.\r
+  documentation is available online.\r
 \r
   @param [in] domain    Select the family of protocols for the client or server\r
-                        application.\r
+                        application.  The supported values are:\r
+                        <ul>\r
+                          <li>AF_INET - Version 4 UEFI network stack</li>\r
+                        </ul>\r
 \r
   @param [in] type      Specifies how to make the network connection.  The following values\r
                         are supported:\r
                         <ul>\r
                           <li>\r
-                            SOCK_STREAM - Connect to TCP, provides a byte stream\r
-                            that is manipluated by read, recv, send and write.\r
+                            SOCK_DGRAM - Connect to UDP, provides a datagram service that is\r
+                            manipulated by recvfrom and sendto.\r
                           </li>\r
                           <li>\r
-                            SOCK_SEQPACKET - Connect to TCP, provides sequenced packet stream\r
-                            that is manipulated by read, recv, send and write.\r
+                            SOCK_STREAM - Connect to TCP, provides a byte stream\r
+                            that is manipluated by read, recv, send and write.\r
                           </li>\r
                           <li>\r
-                            SOCK_DGRAM - Connect to UDP, provides a datagram service that is\r
-                            manipulated by recvfrom and sendto.\r
+                            SOCK_RAW - Connect to IP, provides a datagram service that\r
+                            is manipulated by recvfrom and sendto.\r
                           </li>\r
                         </ul>\r
 \r
@@ -192,9 +203,14 @@ BslSocketProtocolToFd (
                         <ul>\r
                           <li>IPPROTO_TCP</li> - This value must be combined with SOCK_STREAM.</li>\r
                           <li>IPPROTO_UDP</li> - This value must be combined with SOCK_DGRAM.</li>\r
+                          <li>0 - 254</li> - An assigned\r
+                            <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml">protocol number</a>\r
+                            is combined with SOCK_RAW.\r
+                          </li>\r
                         </ul>\r
 \r
-  @return  This routine returns a file descriptor for the socket.\r
+  @return  This routine returns a file descriptor for the socket.  If an error\r
+           occurs -1 is returned and ::errno contains more details.\r
 \r
  **/\r
 INT32\r
@@ -226,8 +242,7 @@ socket (
                                           type,\r
                                           protocol,\r
                                           &errno );\r
-    if ( !EFI_ERROR ( Status ))\r
-    {\r
+    if ( !EFI_ERROR ( Status )) {\r
       //\r
       //  Build the file descriptor for the socket\r
       //\r
@@ -250,7 +265,7 @@ socket (
 \r
   @param [in] pErrno      Address of the errno variable\r
 \r
-  @return   A pointer to the socket protocol structure or NULL if\r
+  @return   A pointer to the EFI_SOCKET_PROTOCOL structure or NULL if\r
             an invalid file descriptor was passed in.\r
 \r
  **/\r