SecurityPkg/TrEESmm: remove TrEE.

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

/** @file\r
  Implement the connection to the EFI socket library\r
\r
  Copyright (c) 2011, 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
\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
\r
\r
/**\r
  The following GUID values are only used when an application links\r
  against EfiSocketLib.  An alternative set of values exists in\r
  SocketDxe\EntryUnload.c which the SocketDxe driver uses to coexist\r
  with socket applications.\r
  \r
  Tag GUID - IPv4 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslIp4ServiceGuid __attribute__((weak)) = {\r
  0x9c756011, 0x5d44, 0x4ee0, { 0xbc, 0xe7, 0xc3, 0x82, 0x18, 0xfe, 0x39, 0x8d }\r
};\r
\r
\r
/**\r
  Tag GUID - IPv6 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslIp6ServiceGuid __attribute__((weak)) = {\r
  0xc51b2761, 0xc476, 0x45fe, { 0xbe, 0x61, 0xba, 0x4b, 0xcc, 0x32, 0xf2, 0x34 }\r
};\r
\r
\r
/**\r
  Tag GUID - TCPv4 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslTcp4ServiceGuid __attribute__((weak)) = {\r
  0xffc659c2, 0x4ef2, 0x4532, { 0xb8, 0x75, 0xcd, 0x9a, 0xa4, 0x27, 0x4c, 0xde }\r
};\r
\r
\r
/**\r
  Tag GUID - TCPv6 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslTcp6ServiceGuid __attribute__((weak)) = {\r
  0x279858a4, 0x4e9e, 0x4e53, { 0x93, 0x22, 0xf2, 0x54, 0xe0, 0x7e, 0xef, 0xd4 }\r
};\r
\r
\r
/**\r
  Tag GUID - UDPv4 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslUdp4ServiceGuid __attribute__((weak)) = {\r
  0x44e03a55, 0x8d97, 0x4511, { 0xbf, 0xef, 0xa, 0x8b, 0xc6, 0x2c, 0x25, 0xae }\r
};\r
\r
\r
/**\r
  Tag GUID - UDPv6 in use by an application using EfiSocketLib\r
**/\r
CONST EFI_GUID mEslUdp6ServiceGuid __attribute__((weak)) = {\r
  0xaa4af677, 0x6efe, 0x477c, { 0x96, 0x68, 0xe8, 0x13, 0x9d, 0x2, 0xfd, 0x9b }\r
};\r
\r
\r
/**\r
  Free the socket resources\r
\r
  This releases the socket resources allocated by calling\r
  EslServiceGetProtocol.\r
\r
  This routine is called from the ::close routine in BsdSocketLib\r
  to release the socket resources.\r
\r
  @param [in] pSocketProtocol   Address of an ::EFI_SOCKET_PROTOCOL\r
                                structure\r
\r
  @return       Value for ::errno, zero (0) indicates success.\r
\r
 **/\r
int\r
EslServiceFreeProtocol (\r
  IN EFI_SOCKET_PROTOCOL * pSocketProtocol\r
  )\r
{\r
  int RetVal;\r
\r
  //\r
  //  Release the socket resources\r
  //\r
  EslSocketFree ( pSocketProtocol, &RetVal );\r
\r
  //\r
  //  Return the operation status\r
  //\r
  return RetVal;\r
}\r
\r
\r
/**\r
  Connect to the EFI socket library\r
\r
  This routine creates the ::ESL_SOCKET structure and returns\r
  the API (::EFI_SOCKET_PROTOCOL address) to the socket file\r
  system layer in BsdSocketLib.\r
\r
  This routine is called from the ::socket routine in BsdSocketLib\r
  to create the data structure and initialize the API for a socket.\r
  Note that this implementation is only used by socket applications\r
  that link directly to EslSocketLib.\r
\r
  @param [in] ppSocketProtocol  Address to receive the ::EFI_SOCKET_PROTOCOL\r
                                structure address\r
\r
  @return       Value for ::errno, zero (0) indicates success.\r
\r
 **/\r
int\r
EslServiceGetProtocol (\r
  IN EFI_SOCKET_PROTOCOL ** ppSocketProtocol\r
  )\r
{\r
  EFI_HANDLE ChildHandle;\r
  ESL_SOCKET * pSocket;\r
  int RetVal;\r
  EFI_STATUS Status;\r
\r
  DBG_ENTER ( );\r
\r
  //\r
  //  Assume success\r
  //\r
  RetVal = 0;\r
\r
  //\r
  //  Locate the socket protocol\r
  //\r
  ChildHandle = NULL;\r
  Status = EslSocketAllocate ( &ChildHandle,\r
                               DEBUG_SOCKET,\r
                               &pSocket );\r
  if ( !EFI_ERROR ( Status )) {\r
    *ppSocketProtocol = &pSocket->SocketProtocol;\r
  }\r
  else {\r
    //\r
    //  No resources\r
    //\r
    RetVal = ENOMEM;\r
  }\r
\r
  //\r
  //  Return the operation status\r
  //\r
  DBG_EXIT_DEC ( RetVal );\r
  return RetVal;\r
}\r
\r
\r
/**\r
  Connect to the network layer\r
\r
  This routine is the constructor for the EfiSocketLib when the\r
  library is linked directly to an application.  This routine\r
  walks the ::cEslSocketBinding table to create ::ESL_SERVICE\r
  structures, associated with the network adapters, which this\r
  routine links to the ::ESL_LAYER structure.\r
\r
  This routine is called from ::EslConstructor as a result of the\r
  constructor redirection in ::mpfnEslConstructor at the end of this\r
  file.\r
\r
  @retval EFI_SUCCESS   Successfully connected to the network layer\r
\r
 **/\r
EFI_STATUS\r
EslServiceNetworkConnect (\r
  VOID\r
  )\r
{\r
  BOOLEAN bSomethingFound;\r
  UINTN HandleCount;\r
  UINTN Index;\r
  CONST ESL_SOCKET_BINDING * pEnd;\r
  EFI_HANDLE * pHandles;\r
  CONST ESL_SOCKET_BINDING * pSocketBinding;\r
  EFI_STATUS Status;\r
\r
  DBG_ENTER ( );\r
\r
  //\r
  //  Initialize the socket layer\r
  //\r
  Status = EFI_SUCCESS;\r
  bSomethingFound = FALSE;\r
  EslServiceLoad ( gImageHandle );\r
\r
  //\r
  //  Connect the network devices\r
  //\r
  pSocketBinding = &cEslSocketBinding[0];\r
  pEnd = &pSocketBinding[ cEslSocketBindingEntries ];\r
  while ( pEnd > pSocketBinding ) {\r
    //\r
    //  Attempt to locate the network adapters\r
    //\r
    HandleCount = 0;\r
    pHandles = NULL;\r
    Status = gBS->LocateHandleBuffer ( ByProtocol,\r
                                       pSocketBinding->pNetworkBinding,\r
                                       NULL,\r
                                       &HandleCount,\r
                                       &pHandles );\r
    if ( EFI_ERROR ( Status )) {\r
      DEBUG (( DEBUG_ERROR,\r
               "ERROR with %s layer, Status: %r\r\n",\r
               pSocketBinding->pName,\r
               Status ));\r
    }\r
    else {\r
      if ( NULL != pHandles ) {\r
        //\r
        //  Attempt to connect to this network adapter\r
        //\r
        for ( Index = 0; HandleCount > Index; Index++ ) {\r
          Status = EslServiceConnect ( gImageHandle,\r
                                       pHandles[ Index ]);\r
          if ( !EFI_ERROR ( Status )) {\r
            bSomethingFound = TRUE;\r
          }\r
          else {\r
            if ( EFI_OUT_OF_RESOURCES == Status ) {\r
              //\r
              //  Pointless to continue without memory\r
              //\r
              break;\r
            }\r
          }\r
        }\r
\r
        //\r
        //  Done with the handles\r
        //\r
        gBS->FreePool ( pHandles );\r
      }\r
    }\r
\r
    //\r
    //  Set the next network protocol\r
    //\r
    pSocketBinding += 1;\r
  }\r
\r
  //\r
  //  Return the network connection status\r
  //\r
  if ( bSomethingFound ) {\r
    Status = EFI_SUCCESS;\r
  }\r
  DBG_EXIT_STATUS ( Status );\r
  return Status;\r
}\r
\r
\r
/**\r
  Disconnect from the network layer\r
\r
  Destructor for the EfiSocketLib when the library is linked\r
  directly to an application.  This routine walks the\r
  ::cEslSocketBinding table to remove the ::ESL_SERVICE\r
  structures (network connections) from the ::ESL_LAYER structure.\r
\r
  This routine is called from ::EslDestructor as a result of the\r
  destructor redirection in ::mpfnEslDestructor at the end of this\r
  file.\r
\r
  @retval EFI_SUCCESS   Successfully disconnected from the network layer\r
\r
 **/\r
EFI_STATUS\r
EslServiceNetworkDisconnect (\r
  VOID\r
  )\r
{\r
  UINTN HandleCount;\r
  UINTN Index;\r
  CONST ESL_SOCKET_BINDING * pEnd;\r
  EFI_HANDLE * pHandles;\r
  CONST ESL_SOCKET_BINDING * pSocketBinding;\r
  EFI_STATUS Status;\r
\r
  DBG_ENTER ( );\r
\r
  //\r
  //  Assume success\r
  //\r
  Status = EFI_SUCCESS;\r
\r
  //\r
  //  Disconnect the network devices\r
  //\r
  pSocketBinding = &cEslSocketBinding[0];\r
  pEnd = &pSocketBinding[ cEslSocketBindingEntries ];\r
  while ( pEnd > pSocketBinding ) {\r
    //\r
    //  Attempt to locate the network adapters\r
    //\r
    HandleCount = 0;\r
    pHandles = NULL;\r
    Status = gBS->LocateHandleBuffer ( ByProtocol,\r
                                       pSocketBinding->pNetworkBinding,\r
                                       NULL,\r
                                       &HandleCount,\r
                                       &pHandles );\r
    if (( !EFI_ERROR ( Status ))\r
      && ( NULL != pHandles )) {\r
      //\r
      //  Attempt to disconnect from this network adapter\r
      //\r
      for ( Index = 0; HandleCount > Index; Index++ ) {\r
        Status = EslServiceDisconnect ( gImageHandle,\r
                                        pHandles[ Index ]);\r
        if ( EFI_ERROR ( Status )) {\r
          break;\r
        }\r
      }\r
\r
      //\r
      //  Done with the handles\r
      //\r
      gBS->FreePool ( pHandles );\r
    }\r
\r
    //\r
    //  Set the next network protocol\r
    //\r
    pSocketBinding += 1;\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  //\r
  //  Finish the disconnect operation\r
  //\r
  if ( !EFI_ERROR ( Status )) {\r
    EslServiceUnload ( );\r
  }\r
\r
  //\r
  //  Return the network connection status\r
  //\r
  DBG_EXIT_STATUS ( Status );\r
  return Status;\r
}\r
\r
\r
/**\r
  Socket layer's service binding protocol delcaration.\r
**/\r
CONST EFI_SERVICE_BINDING_PROTOCOL mEfiServiceBinding __attribute__((weak)) = {\r
  NULL,\r
  NULL\r
};\r
\r
\r
/**\r
  The following entries redirect the constructor and destructor\r
  for any socket application that links against the EfiSocketLib.\r
  Note that the SocketDxe driver uses different redirection.\r
**/\r
PFN_ESL_xSTRUCTOR mpfnEslConstructor __attribute__((weak)) = EslServiceNetworkConnect;    ///<  Constructor for EfiSocketLib\r
PFN_ESL_xSTRUCTOR mpfnEslDestructor __attribute__((weak)) = EslServiceNetworkDisconnect;  ///<  Destructor for EfiSocketLib\r