EmbeddedPkg: Apply uncrustify changes

[mirror_edk2.git] / EmbeddedPkg / Drivers / FdtClientDxe / FdtClientDxe.c

/** @file\r
*  FDT client driver\r
*\r
*  Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>\r
*\r
*  SPDX-License-Identifier: BSD-2-Clause-Patent\r
*\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/HobLib.h>\r
#include <libfdt.h>\r
\r
#include <Guid/Fdt.h>\r
#include <Guid/FdtHob.h>\r
#include <Guid/PlatformHasDeviceTree.h>\r
\r
#include <Protocol/FdtClient.h>\r
\r
STATIC VOID  *mDeviceTreeBase;\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GetNodeProperty (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  INT32                Node,\r
  IN  CONST CHAR8          *PropertyName,\r
  OUT CONST VOID           **Prop,\r
  OUT UINT32               *PropSize OPTIONAL\r
  )\r
{\r
  INT32  Len;\r
\r
  ASSERT (mDeviceTreeBase != NULL);\r
  ASSERT (Prop != NULL);\r
\r
  *Prop = fdt_getprop (mDeviceTreeBase, Node, PropertyName, &Len);\r
  if (*Prop == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (PropSize != NULL) {\r
    *PropSize = Len;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
SetNodeProperty (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  INT32                Node,\r
  IN  CONST CHAR8          *PropertyName,\r
  IN  CONST VOID           *Prop,\r
  IN  UINT32               PropSize\r
  )\r
{\r
  INT32  Ret;\r
\r
  ASSERT (mDeviceTreeBase != NULL);\r
\r
  Ret = fdt_setprop (mDeviceTreeBase, Node, PropertyName, Prop, PropSize);\r
  if (Ret != 0) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
BOOLEAN\r
IsNodeEnabled (\r
  INT32  Node\r
  )\r
{\r
  CONST CHAR8  *NodeStatus;\r
  INT32        Len;\r
\r
  //\r
  // A missing status property implies 'ok' so ignore any errors that\r
  // may occur here. If the status property is present, check whether\r
  // it is set to 'ok' or 'okay', anything else is treated as 'disabled'.\r
  //\r
  NodeStatus = fdt_getprop (mDeviceTreeBase, Node, "status", &Len);\r
  if (NodeStatus == NULL) {\r
    return TRUE;\r
  }\r
\r
  if ((Len >= 5) && (AsciiStrCmp (NodeStatus, "okay") == 0)) {\r
    return TRUE;\r
  }\r
\r
  if ((Len >= 3) && (AsciiStrCmp (NodeStatus, "ok") == 0)) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindNextCompatibleNode (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  CONST CHAR8          *CompatibleString,\r
  IN  INT32                PrevNode,\r
  OUT INT32                *Node\r
  )\r
{\r
  INT32        Prev, Next;\r
  CONST CHAR8  *Type, *Compatible;\r
  INT32        Len;\r
\r
  ASSERT (mDeviceTreeBase != NULL);\r
  ASSERT (Node != NULL);\r
\r
  for (Prev = PrevNode; ; Prev = Next) {\r
    Next = fdt_next_node (mDeviceTreeBase, Prev, NULL);\r
    if (Next < 0) {\r
      break;\r
    }\r
\r
    if (!IsNodeEnabled (Next)) {\r
      continue;\r
    }\r
\r
    Type = fdt_getprop (mDeviceTreeBase, Next, "compatible", &Len);\r
    if (Type == NULL) {\r
      continue;\r
    }\r
\r
    //\r
    // A 'compatible' node may contain a sequence of NUL terminated\r
    // compatible strings so check each one\r
    //\r
    for (Compatible = Type; Compatible < Type + Len && *Compatible;\r
         Compatible += 1 + AsciiStrLen (Compatible))\r
    {\r
      if (AsciiStrCmp (CompatibleString, Compatible) == 0) {\r
        *Node = Next;\r
        return EFI_SUCCESS;\r
      }\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindCompatibleNode (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  CONST CHAR8          *CompatibleString,\r
  OUT INT32                *Node\r
  )\r
{\r
  return FindNextCompatibleNode (This, CompatibleString, 0, Node);\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindCompatibleNodeProperty (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  CONST CHAR8          *CompatibleString,\r
  IN  CONST CHAR8          *PropertyName,\r
  OUT CONST VOID           **Prop,\r
  OUT UINT32               *PropSize OPTIONAL\r
  )\r
{\r
  EFI_STATUS  Status;\r
  INT32       Node;\r
\r
  Status = FindCompatibleNode (This, CompatibleString, &Node);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return GetNodeProperty (This, Node, PropertyName, Prop, PropSize);\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindCompatibleNodeReg (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  CONST CHAR8          *CompatibleString,\r
  OUT CONST VOID           **Reg,\r
  OUT UINTN                *AddressCells,\r
  OUT UINTN                *SizeCells,\r
  OUT UINT32               *RegSize\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  ASSERT (RegSize != NULL);\r
\r
  //\r
  // Get the 'reg' property of this node. For now, we will assume\r
  // 8 byte quantities for base and size, respectively.\r
  // TODO use #cells root properties instead\r
  //\r
  Status = FindCompatibleNodeProperty (\r
             This,\r
             CompatibleString,\r
             "reg",\r
             Reg,\r
             RegSize\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((*RegSize % 16) != 0) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: '%a' compatible node has invalid 'reg' property (size == 0x%x)\n",\r
      __FUNCTION__,\r
      CompatibleString,\r
      *RegSize\r
      ));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  *AddressCells = 2;\r
  *SizeCells    = 2;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindNextMemoryNodeReg (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  IN  INT32                PrevNode,\r
  OUT INT32                *Node,\r
  OUT CONST VOID           **Reg,\r
  OUT UINTN                *AddressCells,\r
  OUT UINTN                *SizeCells,\r
  OUT UINT32               *RegSize\r
  )\r
{\r
  INT32        Prev, Next;\r
  CONST CHAR8  *DeviceType;\r
  INT32        Len;\r
  EFI_STATUS   Status;\r
\r
  ASSERT (mDeviceTreeBase != NULL);\r
  ASSERT (Node != NULL);\r
\r
  for (Prev = PrevNode; ; Prev = Next) {\r
    Next = fdt_next_node (mDeviceTreeBase, Prev, NULL);\r
    if (Next < 0) {\r
      break;\r
    }\r
\r
    if (!IsNodeEnabled (Next)) {\r
      DEBUG ((DEBUG_WARN, "%a: ignoring disabled memory node\n", __FUNCTION__));\r
      continue;\r
    }\r
\r
    DeviceType = fdt_getprop (mDeviceTreeBase, Next, "device_type", &Len);\r
    if ((DeviceType != NULL) && (AsciiStrCmp (DeviceType, "memory") == 0)) {\r
      //\r
      // Get the 'reg' property of this memory node. For now, we will assume\r
      // 8 byte quantities for base and size, respectively.\r
      // TODO use #cells root properties instead\r
      //\r
      Status = GetNodeProperty (This, Next, "reg", Reg, RegSize);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((\r
          DEBUG_WARN,\r
          "%a: ignoring memory node with no 'reg' property\n",\r
          __FUNCTION__\r
          ));\r
        continue;\r
      }\r
\r
      if ((*RegSize % 16) != 0) {\r
        DEBUG ((\r
          DEBUG_WARN,\r
          "%a: ignoring memory node with invalid 'reg' property (size == 0x%x)\n",\r
          __FUNCTION__,\r
          *RegSize\r
          ));\r
        continue;\r
      }\r
\r
      *Node         = Next;\r
      *AddressCells = 2;\r
      *SizeCells    = 2;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
FindMemoryNodeReg (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  OUT INT32                *Node,\r
  OUT CONST VOID           **Reg,\r
  OUT UINTN                *AddressCells,\r
  OUT UINTN                *SizeCells,\r
  OUT UINT32               *RegSize\r
  )\r
{\r
  return FindNextMemoryNodeReg (\r
           This,\r
           0,\r
           Node,\r
           Reg,\r
           AddressCells,\r
           SizeCells,\r
           RegSize\r
           );\r
}\r
\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
GetOrInsertChosenNode (\r
  IN  FDT_CLIENT_PROTOCOL  *This,\r
  OUT INT32                *Node\r
  )\r
{\r
  INT32  NewNode;\r
\r
  ASSERT (mDeviceTreeBase != NULL);\r
  ASSERT (Node != NULL);\r
\r
  NewNode = fdt_path_offset (mDeviceTreeBase, "/chosen");\r
  if (NewNode < 0) {\r
    NewNode = fdt_add_subnode (mDeviceTreeBase, 0, "/chosen");\r
  }\r
\r
  if (NewNode < 0) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  *Node = NewNode;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
STATIC FDT_CLIENT_PROTOCOL  mFdtClientProtocol = {\r
  GetNodeProperty,\r
  SetNodeProperty,\r
  FindCompatibleNode,\r
  FindNextCompatibleNode,\r
  FindCompatibleNodeProperty,\r
  FindCompatibleNodeReg,\r
  FindMemoryNodeReg,\r
  FindNextMemoryNodeReg,\r
  GetOrInsertChosenNode,\r
};\r
\r
STATIC\r
VOID\r
EFIAPI\r
OnPlatformHasDeviceTree (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  EFI_STATUS  Status;\r
  VOID        *Interface;\r
  VOID        *DeviceTreeBase;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEdkiiPlatformHasDeviceTreeGuid,\r
                  NULL,                             // Registration\r
                  &Interface\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  DeviceTreeBase = Context;\r
  DEBUG ((\r
    DEBUG_INFO,\r
    "%a: exposing DTB @ 0x%p to OS\n",\r
    __FUNCTION__,\r
    DeviceTreeBase\r
    ));\r
  Status = gBS->InstallConfigurationTable (&gFdtTableGuid, DeviceTreeBase);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  gBS->CloseEvent (Event);\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeFdtClientDxe (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  VOID        *Hob;\r
  VOID        *DeviceTreeBase;\r
  EFI_STATUS  Status;\r
  EFI_EVENT   PlatformHasDeviceTreeEvent;\r
  VOID        *Registration;\r
\r
  Hob = GetFirstGuidHob (&gFdtHobGuid);\r
  if ((Hob == NULL) || (GET_GUID_HOB_DATA_SIZE (Hob) != sizeof (UINT64))) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  DeviceTreeBase = (VOID *)(UINTN)*(UINT64 *)GET_GUID_HOB_DATA (Hob);\r
\r
  if (fdt_check_header (DeviceTreeBase) != 0) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: No DTB found @ 0x%p\n",\r
      __FUNCTION__,\r
      DeviceTreeBase\r
      ));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  mDeviceTreeBase = DeviceTreeBase;\r
\r
  DEBUG ((DEBUG_INFO, "%a: DTB @ 0x%p\n", __FUNCTION__, mDeviceTreeBase));\r
\r
  //\r
  // Register a protocol notify for the EDKII Platform Has Device Tree\r
  // Protocol.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  OnPlatformHasDeviceTree,\r
                  DeviceTreeBase,             // Context\r
                  &PlatformHasDeviceTreeEvent\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: CreateEvent(): %r\n", __FUNCTION__, Status));\r
    return Status;\r
  }\r
\r
  Status = gBS->RegisterProtocolNotify (\r
                  &gEdkiiPlatformHasDeviceTreeGuid,\r
                  PlatformHasDeviceTreeEvent,\r
                  &Registration\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: RegisterProtocolNotify(): %r\n",\r
      __FUNCTION__,\r
      Status\r
      ));\r
    goto CloseEvent;\r
  }\r
\r
  //\r
  // Kick the event; the protocol could be available already.\r
  //\r
  Status = gBS->SignalEvent (PlatformHasDeviceTreeEvent);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: SignalEvent(): %r\n", __FUNCTION__, Status));\r
    goto CloseEvent;\r
  }\r
\r
  Status = gBS->InstallProtocolInterface (\r
                  &ImageHandle,\r
                  &gFdtClientProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &mFdtClientProtocol\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: InstallProtocolInterface(): %r\n",\r
      __FUNCTION__,\r
      Status\r
      ));\r
    goto CloseEvent;\r
  }\r
\r
  return Status;\r
\r
CloseEvent:\r
  gBS->CloseEvent (PlatformHasDeviceTreeEvent);\r
  return Status;\r
}\r