lib/libfdt/: General aesthetic/style fixes.
A number of style fixes across the files in this directory, including: * Correct invalid kernel-doc content. * Tidy up massive comment in fdt_region.c. * Use correct spelling of "U-Boot". * Replace tests of "! <var>" with "!<var>". * Replace "libfdt_env.h" with <libfdt_env.h>. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Acked-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Robert P. J. Day
Simon Glass
parent
fc76b69873
commit
6feed2a5ae
|
|
@ -5,5 +5,13 @@
|
|||
# SPDX-License-Identifier: GPL-2.0+
|
||||
#
|
||||
|
||||
obj-y += fdt.o fdt_ro.o fdt_rw.o fdt_strerror.o fdt_sw.o fdt_wip.o \
|
||||
fdt_empty_tree.o fdt_addresses.o fdt_region.o
|
||||
obj-y += \
|
||||
fdt.o \
|
||||
fdt_ro.o \
|
||||
fdt_rw.o \
|
||||
fdt_strerror.o \
|
||||
fdt_sw.o \
|
||||
fdt_wip.o \
|
||||
fdt_empty_tree.o \
|
||||
fdt_addresses.o \
|
||||
fdt_region.o
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
The libfdt functionality was written by David Gibson. The original
|
||||
source came from the git repository:
|
||||
source came from the Git repository:
|
||||
|
||||
URL: git://ozlabs.org/home/dgibson/git/libfdt.git
|
||||
|
||||
|
|
@ -11,13 +11,15 @@ commit 857f54e79f74429af20c2b5ecc00ee98af6a3b8b
|
|||
tree 2f648f0f88225a51ded452968d28b4402df8ade0
|
||||
parent 07a12a08005f3b5cd9337900a6551e450c07b515
|
||||
|
||||
To adapt for u-boot usage, only the applicable files were copied and
|
||||
imported into the u-boot git repository.
|
||||
Omitted:
|
||||
* GPL - u-boot comes with a copy of the GPL license
|
||||
* test subdirectory - not directly useful for u-boot
|
||||
To adapt for U-Boot usage, only the applicable files were copied and
|
||||
imported into the U-Boot Git repository.
|
||||
|
||||
After importing, other customizations were performed. See the git log
|
||||
for details.
|
||||
Omitted:
|
||||
|
||||
* GPL - U-Boot comes with a copy of the GPL license
|
||||
* test subdirectory - not directly useful for U-Boot
|
||||
|
||||
After importing, other customizations were performed. See the
|
||||
"git log" for details.
|
||||
|
||||
Jerry Van Baren
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2014 David Gibson <david@gibson.dropbear.id.au>
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
|
|||
|
|
@ -3,8 +3,7 @@
|
|||
* Copyright (C) 2012 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
|
||||
#include <libfdt_env.h>
|
||||
#include <fdt.h>
|
||||
#include <libfdt.h>
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
@ -18,14 +18,13 @@
|
|||
|
||||
/**
|
||||
* fdt_add_region() - Add a new region to our list
|
||||
* @info: State information
|
||||
* @offset: Start offset of region
|
||||
* @size: Size of region
|
||||
*
|
||||
* The region is added if there is space, but in any case we increment the
|
||||
* count. If permitted, and the new region overlaps the last one, we merge
|
||||
* them.
|
||||
*
|
||||
* @info: State information
|
||||
* @offset: Start offset of region
|
||||
* @size: Size of region
|
||||
*/
|
||||
static int fdt_add_region(struct fdt_region_state *info, int offset, int size)
|
||||
{
|
||||
|
|
@ -119,6 +118,8 @@ int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count,
|
|||
|
||||
/**
|
||||
* fdt_include_supernodes() - Include supernodes required by this node
|
||||
* @info: State information
|
||||
* @depth: Current stack depth
|
||||
*
|
||||
* When we decided to include a node or property which is not at the top
|
||||
* level, this function forces the inclusion of higher level nodes. For
|
||||
|
|
@ -131,9 +132,6 @@ int fdt_add_alias_regions(const void *fdt, struct fdt_region *region, int count,
|
|||
*
|
||||
* If we decide to include testing then we need the root node to have a valid
|
||||
* tree. This function adds those regions.
|
||||
*
|
||||
* @info: State information
|
||||
* @depth: Current stack depth
|
||||
*/
|
||||
static int fdt_include_supernodes(struct fdt_region_state *info, int depth)
|
||||
{
|
||||
|
|
@ -203,72 +201,78 @@ int fdt_first_region(const void *fdt,
|
|||
path, path_len, flags, info);
|
||||
}
|
||||
|
||||
/*
|
||||
* Theory of operation
|
||||
/***********************************************************************
|
||||
*
|
||||
* Theory of operation
|
||||
*
|
||||
* Note: in this description 'included' means that a node (or other part
|
||||
* of the tree) should be included in the region list, i.e. it will have
|
||||
* a region which covers its part of the tree.
|
||||
*
|
||||
* This function maintains some state from the last time it is called.
|
||||
* It checks the next part of the tree that it is supposed to look at
|
||||
* (p.nextoffset) to see if that should be included or not. When it
|
||||
* finds something to include, it sets info->start to its offset. This
|
||||
* marks the start of the region we want to include.
|
||||
*
|
||||
* Once info->start is set to the start (i.e. not -1), we continue
|
||||
* scanning until we find something that we don't want included. This
|
||||
* will be the end of a region. At this point we can close off the
|
||||
* region and add it to the list. So we do so, and reset info->start
|
||||
* to -1.
|
||||
*
|
||||
* One complication here is that we want to merge regions. So when we
|
||||
* come to add another region later, we may in fact merge it with the
|
||||
* previous one if one ends where the other starts.
|
||||
*
|
||||
* The function fdt_add_region() will return -1 if it fails to add the
|
||||
* region, because we already have a region ready to be returned, and
|
||||
* the new one cannot be merged in with it. In this case, we must return
|
||||
* the region we found, and wait for another call to this function.
|
||||
* When it comes, we will repeat the processing of the tag and again
|
||||
* try to add a region. This time it will succeed.
|
||||
*
|
||||
* The current state of the pointers (stack, offset, etc.) is maintained
|
||||
* in a ptrs member. At the start of every loop iteration we make a copy
|
||||
* of it. The copy is then updated as the tag is processed. Only if we
|
||||
* get to the end of the loop iteration (and successfully call
|
||||
* fdt_add_region() if we need to) can we commit the changes we have
|
||||
* made to these pointers. For example, if we see an FDT_END_NODE tag,
|
||||
* we will decrement the depth value. But if we need to add a region
|
||||
* for this tag (let's say because the previous tag is included and this
|
||||
* FDT_END_NODE tag is not included) then we will only commit the result
|
||||
* if we were able to add the region. That allows us to retry again next
|
||||
* time.
|
||||
*
|
||||
* We keep track of a variable called 'want' which tells us what we want
|
||||
* to include when there is no specific information provided by the
|
||||
* h_include function for a particular property. This basically handles
|
||||
* the inclusion of properties which are pulled in by virtue of the node
|
||||
* they are in. So if you include a node, its properties are also
|
||||
* included. In this case 'want' will be WANT_NODES_AND_PROPS. The
|
||||
* FDT_REG_DIRECT_SUBNODES feature also makes use of 'want'. While we
|
||||
* are inside the subnode, 'want' will be set to WANT_NODES_ONLY, so
|
||||
* that only the subnode's FDT_BEGIN_NODE and FDT_END_NODE tags will be
|
||||
* included, and properties will be skipped. If WANT_NOTHING is
|
||||
* selected, then we will just rely on what the h_include() function
|
||||
* tells us.
|
||||
*
|
||||
* Using 'want' we work out 'include', which tells us whether this
|
||||
* current tag should be included or not. As you can imagine, if the
|
||||
* value of 'include' changes, that means we are on a boundary between
|
||||
* nodes to include and nodes to exclude. At this point we either close
|
||||
* off a previous region and add it to the list, or mark the start of a
|
||||
* new region.
|
||||
*
|
||||
* Apart from the nodes, we have mem_rsvmap, the FDT_END tag and the
|
||||
* string list. Each of these dealt with as a whole (i.e. we create a
|
||||
* region for each if it is to be included). For mem_rsvmap we don't
|
||||
* allow it to merge with the first struct region. For the stringlist,
|
||||
* we don't allow it to merge with the last struct region (which
|
||||
* contains at minimum the FDT_END tag).
|
||||
*
|
||||
*********************************************************************/
|
||||
|
||||
Note: in this description 'included' means that a node (or other part of
|
||||
the tree) should be included in the region list, i.e. it will have a region
|
||||
which covers its part of the tree.
|
||||
|
||||
This function maintains some state from the last time it is called. It
|
||||
checks the next part of the tree that it is supposed to look at
|
||||
(p.nextoffset) to see if that should be included or not. When it finds
|
||||
something to include, it sets info->start to its offset. This marks the
|
||||
start of the region we want to include.
|
||||
|
||||
Once info->start is set to the start (i.e. not -1), we continue scanning
|
||||
until we find something that we don't want included. This will be the end
|
||||
of a region. At this point we can close off the region and add it to the
|
||||
list. So we do so, and reset info->start to -1.
|
||||
|
||||
One complication here is that we want to merge regions. So when we come to
|
||||
add another region later, we may in fact merge it with the previous one if
|
||||
one ends where the other starts.
|
||||
|
||||
The function fdt_add_region() will return -1 if it fails to add the region,
|
||||
because we already have a region ready to be returned, and the new one
|
||||
cannot be merged in with it. In this case, we must return the region we
|
||||
found, and wait for another call to this function. When it comes, we will
|
||||
repeat the processing of the tag and again try to add a region. This time it
|
||||
will succeed.
|
||||
|
||||
The current state of the pointers (stack, offset, etc.) is maintained in
|
||||
a ptrs member. At the start of every loop iteration we make a copy of it.
|
||||
The copy is then updated as the tag is processed. Only if we get to the end
|
||||
of the loop iteration (and successfully call fdt_add_region() if we need
|
||||
to) can we commit the changes we have made to these pointers. For example,
|
||||
if we see an FDT_END_NODE tag we will decrement the depth value. But if we
|
||||
need to add a region for this tag (let's say because the previous tag is
|
||||
included and this FDT_END_NODE tag is not included) then we will only commit
|
||||
the result if we were able to add the region. That allows us to retry again
|
||||
next time.
|
||||
|
||||
We keep track of a variable called 'want' which tells us what we want to
|
||||
include when there is no specific information provided by the h_include
|
||||
function for a particular property. This basically handles the inclusion of
|
||||
properties which are pulled in by virtue of the node they are in. So if you
|
||||
include a node, its properties are also included. In this case 'want' will
|
||||
be WANT_NODES_AND_PROPS. The FDT_REG_DIRECT_SUBNODES feature also makes use
|
||||
of 'want'. While we are inside the subnode, 'want' will be set to
|
||||
WANT_NODES_ONLY, so that only the subnode's FDT_BEGIN_NODE and FDT_END_NODE
|
||||
tags will be included, and properties will be skipped. If WANT_NOTHING is
|
||||
selected, then we will just rely on what the h_include() function tells us.
|
||||
|
||||
Using 'want' we work out 'include', which tells us whether this current tag
|
||||
should be included or not. As you can imagine, if the value of 'include'
|
||||
changes, that means we are on a boundary between nodes to include and nodes
|
||||
to exclude. At this point we either close off a previous region and add it
|
||||
to the list, or mark the start of a new region.
|
||||
|
||||
Apart from the nodes, we have mem_rsvmap, the FDT_END tag and the string
|
||||
list. Each of these dealt with as a whole (i.e. we create a region for each
|
||||
if it is to be included). For mem_rsvmap we don't allow it to merge with
|
||||
the first struct region. For the stringlist we don't allow it to merge with
|
||||
the last struct region (which contains at minimum the FDT_END tag).
|
||||
*/
|
||||
int fdt_next_region(const void *fdt,
|
||||
int (*h_include)(void *priv, const void *fdt, int offset,
|
||||
int type, const char *data, int size),
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
@ -19,7 +19,7 @@ static int _fdt_nodename_eq(const void *fdt, int offset,
|
|||
{
|
||||
const char *p = fdt_offset_ptr(fdt, offset + FDT_TAGSIZE, len+1);
|
||||
|
||||
if (! p)
|
||||
if (!p)
|
||||
/* short match */
|
||||
return 0;
|
||||
|
||||
|
|
@ -115,7 +115,7 @@ int fdt_subnode_offset(const void *fdt, int parentoffset,
|
|||
|
||||
/*
|
||||
* Find the next of path seperator, note we need to search for both '/' and ':'
|
||||
* and then take the first one so that we do the rigth thing for e.g.
|
||||
* and then take the first one so that we do the right thing for e.g.
|
||||
* "foo/bar:option" and "bar:option/otheroption", both of which happen, so
|
||||
* first searching for either ':' or '/' does not work.
|
||||
*/
|
||||
|
|
@ -163,7 +163,7 @@ int fdt_path_offset(const void *fdt, const char *path)
|
|||
if (*p == '\0' || *p == ':')
|
||||
return offset;
|
||||
q = fdt_path_next_seperator(p);
|
||||
if (! q)
|
||||
if (!q)
|
||||
q = end;
|
||||
|
||||
offset = fdt_subnode_offset_namelen(fdt, offset, p, q-p);
|
||||
|
|
@ -273,7 +273,7 @@ const void *fdt_getprop_namelen(const void *fdt, int nodeoffset,
|
|||
const struct fdt_property *prop;
|
||||
|
||||
prop = fdt_get_property_namelen(fdt, nodeoffset, name, namelen, lenp);
|
||||
if (! prop)
|
||||
if (!prop)
|
||||
return NULL;
|
||||
|
||||
return prop->data;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
@ -168,7 +168,7 @@ static int _fdt_resize_property(void *fdt, int nodeoffset, const char *name,
|
|||
int err;
|
||||
|
||||
*prop = fdt_get_property_w(fdt, nodeoffset, name, &oldlen);
|
||||
if (! (*prop))
|
||||
if (!(*prop))
|
||||
return oldlen;
|
||||
|
||||
if ((err = _fdt_splice_struct(fdt, (*prop)->data, FDT_TAGALIGN(oldlen),
|
||||
|
|
@ -283,7 +283,7 @@ int fdt_delprop(void *fdt, int nodeoffset, const char *name)
|
|||
FDT_RW_CHECK_HEADER(fdt);
|
||||
|
||||
prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
|
||||
if (! prop)
|
||||
if (!prop)
|
||||
return len;
|
||||
|
||||
proplen = sizeof(*prop) + FDT_TAGALIGN(len);
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
|
|||
|
|
@ -3,8 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
|
||||
#include <libfdt_env.h>
|
||||
#include <fdt.h>
|
||||
#include <libfdt.h>
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* Copyright (C) 2006 David Gibson, IBM Corporation.
|
||||
* SPDX-License-Identifier: GPL-2.0+ BSD-2-Clause
|
||||
*/
|
||||
#include "libfdt_env.h"
|
||||
#include <libfdt_env.h>
|
||||
|
||||
#ifndef USE_HOSTCC
|
||||
#include <fdt.h>
|
||||
|
|
@ -21,7 +21,7 @@ int fdt_setprop_inplace(void *fdt, int nodeoffset, const char *name,
|
|||
int proplen;
|
||||
|
||||
propval = fdt_getprop_w(fdt, nodeoffset, name, &proplen);
|
||||
if (! propval)
|
||||
if (!propval)
|
||||
return proplen;
|
||||
|
||||
if (proplen != len)
|
||||
|
|
@ -45,7 +45,7 @@ int fdt_nop_property(void *fdt, int nodeoffset, const char *name)
|
|||
int len;
|
||||
|
||||
prop = fdt_get_property_w(fdt, nodeoffset, name, &len);
|
||||
if (! prop)
|
||||
if (!prop)
|
||||
return len;
|
||||
|
||||
_fdt_nop_region(prop, len + sizeof(*prop));
|
||||
|
|
|
|||
Loading…
Reference in New Issue