[mirror_edk2.git] / ArmVirtPkg / FdtClientDxe / FdtClientDxe.c

/** @file\r
*  FDT client driver\r
*\r
*  Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>\r
*\r
*  This program and the accompanying materials are\r
*  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 <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
  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
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
    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
      if (AsciiStrCmp (CompatibleString, Compatible) == 0) {\r
        *Node = Next;\r
        return EFI_SUCCESS;\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 (This, CompatibleString, "reg", Reg,\r
             RegSize);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((*RegSize % 16) != 0) {\r
    DEBUG ((EFI_D_ERROR,\r
      "%a: '%a' compatible node has invalid 'reg' property (size == 0x%x)\n",\r
      __FUNCTION__, CompatibleString, *RegSize));\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
  CONST CHAR8    *NodeStatus;\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
    NodeStatus = fdt_getprop (mDeviceTreeBase, Next, "status", &Len);\r
    if (NodeStatus != NULL && AsciiStrCmp (NodeStatus, "okay") != 0) {\r
      DEBUG ((DEBUG_WARN, "%a: ignoring memory node with status \"%a\"\n",\r
        __FUNCTION__, NodeStatus));\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 ((EFI_D_WARN,\r
          "%a: ignoring memory node with no 'reg' property\n",\r
          __FUNCTION__));\r
        continue;\r
      }\r
      if ((*RegSize % 16) != 0) {\r
        DEBUG ((EFI_D_WARN,\r
          "%a: ignoring memory node with invalid 'reg' property (size == 0x%x)\n",\r
          __FUNCTION__, *RegSize));\r
        continue;\r
      }\r
\r
      *Node = Next;\r
      *AddressCells = 2;\r
      *SizeCells = 2;\r
      return EFI_SUCCESS;\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 (This, 0, Node, Reg, AddressCells, SizeCells,\r
           RegSize);\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
  DeviceTreeBase = (VOID *)(UINTN)*(UINT64 *)GET_GUID_HOB_DATA (Hob);\r
\r
  if (fdt_check_header (DeviceTreeBase) != 0) {\r
    DEBUG ((EFI_D_ERROR, "%a: No DTB found @ 0x%p\n", __FUNCTION__,\r
      DeviceTreeBase));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  mDeviceTreeBase = DeviceTreeBase;\r
\r
  DEBUG ((EFI_D_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
Commit	Line	Data
30740795 AB	1	/** @file\r
	2	* FDT client driver\r
	3	*\r
	4	* Copyright (c) 2016, Linaro Ltd. All rights reserved.<BR>\r
	5	*\r
	6	* This program and the accompanying materials are\r
	7	* licensed and made available under the terms and conditions of the BSD License\r
	8	* which accompanies this distribution. The full text of the license may be found at\r
	9	* http://opensource.org/licenses/bsd-license.php\r
	10	*\r
	11	* THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	* WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	*\r
	14	**/\r
	15	\r
	16	#include <Library/BaseLib.h>\r
	17	#include <Library/DebugLib.h>\r
	18	#include <Library/UefiDriverEntryPoint.h>\r
	19	#include <Library/UefiBootServicesTableLib.h>\r
	20	#include <Library/HobLib.h>\r
	21	#include <libfdt.h>\r
	22	\r
1e7143d8	23	#include <Guid/Fdt.h>\r
30740795	24	#include <Guid/FdtHob.h>\r
51b09a2c	25	#include <Guid/PlatformHasDeviceTree.h>\r
30740795 AB	26	\r
	27	#include <Protocol/FdtClient.h>\r
	28	\r
	29	STATIC VOID *mDeviceTreeBase;\r
	30	\r
	31	STATIC\r
	32	EFI_STATUS\r
eec1ba7d	33	EFIAPI\r
30740795 AB	34	GetNodeProperty (\r
	35	IN FDT_CLIENT_PROTOCOL *This,\r
	36	IN INT32 Node,\r
	37	IN CONST CHAR8 *PropertyName,\r
	38	OUT CONST VOID **Prop,\r
	39	OUT UINT32 *PropSize OPTIONAL\r
	40	)\r
	41	{\r
	42	INT32 Len;\r
	43	\r
	44	ASSERT (mDeviceTreeBase != NULL);\r
	45	ASSERT (Prop != NULL);\r
	46	\r
	47	*Prop = fdt_getprop (mDeviceTreeBase, Node, PropertyName, &Len);\r
	48	if (*Prop == NULL) {\r
	49	return EFI_NOT_FOUND;\r
	50	}\r
	51	\r
	52	if (PropSize != NULL) {\r
	53	*PropSize = Len;\r
	54	}\r
	55	return EFI_SUCCESS;\r
	56	}\r
	57	\r
	58	STATIC\r
	59	EFI_STATUS\r
eec1ba7d	60	EFIAPI\r
30740795 AB	61	SetNodeProperty (\r
	62	IN FDT_CLIENT_PROTOCOL *This,\r
	63	IN INT32 Node,\r
	64	IN CONST CHAR8 *PropertyName,\r
	65	IN CONST VOID *Prop,\r
	66	IN UINT32 PropSize\r
	67	)\r
	68	{\r
	69	INT32 Ret;\r
	70	\r
	71	ASSERT (mDeviceTreeBase != NULL);\r
	72	\r
	73	Ret = fdt_setprop (mDeviceTreeBase, Node, PropertyName, Prop, PropSize);\r
	74	if (Ret != 0) {\r
	75	return EFI_DEVICE_ERROR;\r
	76	}\r
	77	\r
	78	return EFI_SUCCESS;\r
	79	}\r
	80	\r
	81	STATIC\r
	82	EFI_STATUS\r
	83	EFIAPI\r
	84	FindNextCompatibleNode (\r
	85	IN FDT_CLIENT_PROTOCOL *This,\r
	86	IN CONST CHAR8 *CompatibleString,\r
	87	IN INT32 PrevNode,\r
	88	OUT INT32 *Node\r
	89	)\r
	90	{\r
	91	INT32 Prev, Next;\r
	92	CONST CHAR8 Type, Compatible;\r
	93	INT32 Len;\r
	94	\r
	95	ASSERT (mDeviceTreeBase != NULL);\r
	96	ASSERT (Node != NULL);\r
	97	\r
	98	for (Prev = PrevNode;; Prev = Next) {\r
	99	Next = fdt_next_node (mDeviceTreeBase, Prev, NULL);\r
	100	if (Next < 0) {\r
	101	break;\r
	102	}\r
	103	\r
	104	Type = fdt_getprop (mDeviceTreeBase, Next, "compatible", &Len);\r
	105	if (Type == NULL) {\r
	106	continue;\r
	107	}\r
	108	\r
	109	//\r
	110	// A 'compatible' node may contain a sequence of NUL terminated\r
	111	// compatible strings so check each one\r
	112	//\r
	113	for (Compatible = Type; Compatible < Type + Len && *Compatible;\r
	114	Compatible += 1 + AsciiStrLen (Compatible)) {\r
	115	if (AsciiStrCmp (CompatibleString, Compatible) == 0) {\r
	116	*Node = Next;\r
	117	return EFI_SUCCESS;\r
	118	}\r
	119	}\r
	120	}\r
	121	return EFI_NOT_FOUND;\r
	122	}\r
	123	\r
	124	STATIC\r
125	EFI_STATUS\r
126	EFIAPI\r
127	FindCompatibleNode (\r
128	IN FDT_CLIENT_PROTOCOL *This,\r
129	IN CONST CHAR8 *CompatibleString,\r
130	OUT INT32 *Node\r
131	)\r
132	{\r
133	return FindNextCompatibleNode (This, CompatibleString, 0, Node);\r
134	}\r
135	\r
136	STATIC\r
137	EFI_STATUS\r
138	EFIAPI\r
139	FindCompatibleNodeProperty (\r
140	IN FDT_CLIENT_PROTOCOL *This,\r
141	IN CONST CHAR8 *CompatibleString,\r
142	IN CONST CHAR8 *PropertyName,\r
143	OUT CONST VOID **Prop,\r
144	OUT UINT32 *PropSize OPTIONAL\r
145	)\r
146	{\r
147	EFI_STATUS Status;\r
148	INT32 Node;\r
149	\r
150	Status = FindCompatibleNode (This, CompatibleString, &Node);\r
151	if (EFI_ERROR (Status)) {\r
152	return Status;\r
153	}\r
154	\r
155	return GetNodeProperty (This, Node, PropertyName, Prop, PropSize);\r
156	}\r
157	\r
158	STATIC\r
159	EFI_STATUS\r
160	EFIAPI\r
161	FindCompatibleNodeReg (\r
162	IN FDT_CLIENT_PROTOCOL *This,\r
163	IN CONST CHAR8 *CompatibleString,\r
164	OUT CONST VOID **Reg,\r
cfc8d51c AB	165	OUT UINTN *AddressCells,\r
cfc8d51c AB	166	OUT UINTN *SizeCells,\r
30740795 AB	167	OUT UINT32 *RegSize\r
	168	)\r
	169	{\r
	170	EFI_STATUS Status;\r
	171	\r
	172	ASSERT (RegSize != NULL);\r
	173	\r
	174	//\r
	175	// Get the 'reg' property of this node. For now, we will assume\r
	176	// 8 byte quantities for base and size, respectively.\r
	177	// TODO use #cells root properties instead\r
	178	//\r
	179	Status = FindCompatibleNodeProperty (This, CompatibleString, "reg", Reg,\r
	180	RegSize);\r
	181	if (EFI_ERROR (Status)) {\r
	182	return Status;\r
	183	}\r
	184	\r
38ed4a9e	185	if ((*RegSize % 16) != 0) {\r
30740795 AB	186	DEBUG ((EFI_D_ERROR,\r
	187	"%a: '%a' compatible node has invalid 'reg' property (size == 0x%x)\n",\r
	188	__FUNCTION__, CompatibleString, *RegSize));\r
	189	return EFI_NOT_FOUND;\r
	190	}\r
	191	\r
cfc8d51c AB	192	*AddressCells = 2;\r
cfc8d51c AB	193	*SizeCells = 2;\r
30740795 AB	194	\r
	195	return EFI_SUCCESS;\r
	196	}\r
	197	\r
969d2eb3 AB	198	STATIC\r
	199	EFI_STATUS\r
	200	EFIAPI\r
	201	FindNextMemoryNodeReg (\r
	202	IN FDT_CLIENT_PROTOCOL *This,\r
	203	IN INT32 PrevNode,\r
	204	OUT INT32 *Node,\r
	205	OUT CONST VOID **Reg,\r
	206	OUT UINTN *AddressCells,\r
	207	OUT UINTN *SizeCells,\r
	208	OUT UINT32 *RegSize\r
	209	)\r
	210	{\r
	211	INT32 Prev, Next;\r
	212	CONST CHAR8 *DeviceType;\r
d0140443	213	CONST CHAR8 *NodeStatus;\r
969d2eb3 AB	214	INT32 Len;\r
	215	EFI_STATUS Status;\r
	216	\r
	217	ASSERT (mDeviceTreeBase != NULL);\r
	218	ASSERT (Node != NULL);\r
	219	\r
	220	for (Prev = PrevNode;; Prev = Next) {\r
	221	Next = fdt_next_node (mDeviceTreeBase, Prev, NULL);\r
	222	if (Next < 0) {\r
	223	break;\r
	224	}\r
	225	\r
d0140443 AB	226	NodeStatus = fdt_getprop (mDeviceTreeBase, Next, "status", &Len);\r
	227	if (NodeStatus != NULL && AsciiStrCmp (NodeStatus, "okay") != 0) {\r
	228	DEBUG ((DEBUG_WARN, "%a: ignoring memory node with status \"%a\"\n",\r
	229	__FUNCTION__, NodeStatus));\r
	230	continue;\r
	231	}\r
	232	\r
969d2eb3 AB	233	DeviceType = fdt_getprop (mDeviceTreeBase, Next, "device_type", &Len);\r
	234	if (DeviceType != NULL && AsciiStrCmp (DeviceType, "memory") == 0) {\r
	235	//\r
	236	// Get the 'reg' property of this memory node. For now, we will assume\r
	237	// 8 byte quantities for base and size, respectively.\r
	238	// TODO use #cells root properties instead\r
	239	//\r
	240	Status = GetNodeProperty (This, Next, "reg", Reg, RegSize);\r
	241	if (EFI_ERROR (Status)) {\r
	242	DEBUG ((EFI_D_WARN,\r
	243	"%a: ignoring memory node with no 'reg' property\n",\r
	244	__FUNCTION__));\r
	245	continue;\r
	246	}\r
	247	if ((*RegSize % 16) != 0) {\r
	248	DEBUG ((EFI_D_WARN,\r
	249	"%a: ignoring memory node with invalid 'reg' property (size == 0x%x)\n",\r
	250	__FUNCTION__, *RegSize));\r
	251	continue;\r
	252	}\r
	253	\r
	254	*Node = Next;\r
	255	*AddressCells = 2;\r
	256	*SizeCells = 2;\r
	257	return EFI_SUCCESS;\r
	258	}\r
	259	}\r
	260	return EFI_NOT_FOUND;\r
	261	}\r
	262	\r
	263	STATIC\r
	264	EFI_STATUS\r
	265	EFIAPI\r
	266	FindMemoryNodeReg (\r
	267	IN FDT_CLIENT_PROTOCOL *This,\r
	268	OUT INT32 *Node,\r
	269	OUT CONST VOID **Reg,\r
	270	OUT UINTN *AddressCells,\r
	271	OUT UINTN *SizeCells,\r
	272	OUT UINT32 *RegSize\r
	273	)\r
	274	{\r
	275	return FindNextMemoryNodeReg (This, 0, Node, Reg, AddressCells, SizeCells,\r
	276	RegSize);\r
	277	}\r
	278	\r
30740795 AB	279	STATIC\r
30740795 AB	280	EFI_STATUS\r
eec1ba7d	281	EFIAPI\r
30740795 AB	282	GetOrInsertChosenNode (\r
	283	IN FDT_CLIENT_PROTOCOL *This,\r
	284	OUT INT32 *Node\r
	285	)\r
	286	{\r
	287	INT32 NewNode;\r
	288	\r
	289	ASSERT (mDeviceTreeBase != NULL);\r
	290	ASSERT (Node != NULL);\r
	291	\r
	292	NewNode = fdt_path_offset (mDeviceTreeBase, "/chosen");\r
	293	if (NewNode < 0) {\r
	294	NewNode = fdt_add_subnode (mDeviceTreeBase, 0, "/chosen");\r
	295	}\r
	296	\r
	297	if (NewNode < 0) {\r
	298	return EFI_OUT_OF_RESOURCES;\r
	299	}\r
	300	\r
	301	*Node = NewNode;\r
	302	\r
	303	return EFI_SUCCESS;\r
	304	}\r
	305	\r
	306	STATIC FDT_CLIENT_PROTOCOL mFdtClientProtocol = {\r
	307	GetNodeProperty,\r
	308	SetNodeProperty,\r
	309	FindCompatibleNode,\r
	310	FindNextCompatibleNode,\r
	311	FindCompatibleNodeProperty,\r
	312	FindCompatibleNodeReg,\r
969d2eb3 AB	313	FindMemoryNodeReg,\r
969d2eb3 AB	314	FindNextMemoryNodeReg,\r
30740795 AB	315	GetOrInsertChosenNode,\r
	316	};\r
	317	\r
51b09a2c LE	318	STATIC\r
	319	VOID\r
	320	EFIAPI\r
	321	OnPlatformHasDeviceTree (\r
	322	IN EFI_EVENT Event,\r
	323	IN VOID *Context\r
	324	)\r
	325	{\r
	326	EFI_STATUS Status;\r
	327	VOID *Interface;\r
	328	VOID *DeviceTreeBase;\r
	329	\r
	330	Status = gBS->LocateProtocol (\r
	331	&gEdkiiPlatformHasDeviceTreeGuid,\r
	332	NULL, // Registration\r
	333	&Interface\r
	334	);\r
	335	if (EFI_ERROR (Status)) {\r
	336	return;\r
	337	}\r
	338	\r
	339	DeviceTreeBase = Context;\r
	340	DEBUG ((\r
	341	DEBUG_INFO,\r
	342	"%a: exposing DTB @ 0x%p to OS\n",\r
	343	__FUNCTION__,\r
	344	DeviceTreeBase\r
	345	));\r
	346	Status = gBS->InstallConfigurationTable (&gFdtTableGuid, DeviceTreeBase);\r
	347	ASSERT_EFI_ERROR (Status);\r
	348	\r
	349	gBS->CloseEvent (Event);\r
	350	}\r
	351	\r
30740795 AB	352	EFI_STATUS\r
	353	EFIAPI\r
	354	InitializeFdtClientDxe (\r
	355	IN EFI_HANDLE ImageHandle,\r
	356	IN EFI_SYSTEM_TABLE *SystemTable\r
	357	)\r
	358	{\r
	359	VOID *Hob;\r
	360	VOID *DeviceTreeBase;\r
1e7143d8	361	EFI_STATUS Status;\r
51b09a2c LE	362	EFI_EVENT PlatformHasDeviceTreeEvent;\r
51b09a2c LE	363	VOID *Registration;\r
30740795 AB	364	\r
	365	Hob = GetFirstGuidHob (&gFdtHobGuid);\r
	366	if (Hob == NULL \|\| GET_GUID_HOB_DATA_SIZE (Hob) != sizeof (UINT64)) {\r
	367	return EFI_NOT_FOUND;\r
	368	}\r
	369	DeviceTreeBase = (VOID )(UINTN)(UINT64 *)GET_GUID_HOB_DATA (Hob);\r
	370	\r
	371	if (fdt_check_header (DeviceTreeBase) != 0) {\r
	372	DEBUG ((EFI_D_ERROR, "%a: No DTB found @ 0x%p\n", __FUNCTION__,\r
	373	DeviceTreeBase));\r
	374	return EFI_NOT_FOUND;\r
	375	}\r
	376	\r
	377	mDeviceTreeBase = DeviceTreeBase;\r
	378	\r
	379	DEBUG ((EFI_D_INFO, "%a: DTB @ 0x%p\n", __FUNCTION__, mDeviceTreeBase));\r
	380	\r
51b09a2c LE	381	//\r
	382	// Register a protocol notify for the EDKII Platform Has Device Tree\r
	383	// Protocol.\r
	384	//\r
	385	Status = gBS->CreateEvent (\r
	386	EVT_NOTIFY_SIGNAL,\r
	387	TPL_CALLBACK,\r
	388	OnPlatformHasDeviceTree,\r
	389	DeviceTreeBase, // Context\r
	390	&PlatformHasDeviceTreeEvent\r
	391	);\r
	392	if (EFI_ERROR (Status)) {\r
	393	DEBUG ((DEBUG_ERROR, "%a: CreateEvent(): %r\n", __FUNCTION__, Status));\r
	394	return Status;\r
	395	}\r
	396	\r
	397	Status = gBS->RegisterProtocolNotify (\r
	398	&gEdkiiPlatformHasDeviceTreeGuid,\r
	399	PlatformHasDeviceTreeEvent,\r
	400	&Registration\r
	401	);\r
	402	if (EFI_ERROR (Status)) {\r
	403	DEBUG ((\r
	404	DEBUG_ERROR,\r
	405	"%a: RegisterProtocolNotify(): %r\n",\r
	406	__FUNCTION__,\r
	407	Status\r
	408	));\r
	409	goto CloseEvent;\r
	410	}\r
	411	\r
	412	//\r
	413	// Kick the event; the protocol could be available already.\r
	414	//\r
	415	Status = gBS->SignalEvent (PlatformHasDeviceTreeEvent);\r
	416	if (EFI_ERROR (Status)) {\r
	417	DEBUG ((DEBUG_ERROR, "%a: SignalEvent(): %r\n", __FUNCTION__, Status));\r
	418	goto CloseEvent;\r
1e7143d8 AB	419	}\r
1e7143d8 AB	420	\r
51b09a2c LE	421	Status = gBS->InstallProtocolInterface (\r
	422	&ImageHandle,\r
	423	&gFdtClientProtocolGuid,\r
	424	EFI_NATIVE_INTERFACE,\r
	425	&mFdtClientProtocol\r
	426	);\r
	427	if (EFI_ERROR (Status)) {\r
	428	DEBUG ((\r
	429	DEBUG_ERROR,\r
	430	"%a: InstallProtocolInterface(): %r\n",\r
	431	__FUNCTION__,\r
	432	Status\r
	433	));\r
	434	goto CloseEvent;\r
	435	}\r
	436	\r
	437	return Status;\r
	438	\r
	439	CloseEvent:\r
	440	gBS->CloseEvent (PlatformHasDeviceTreeEvent);\r
	441	return Status;\r
30740795	442	}\r