* [PATCH] pylibfdt: Support boolean properties
@ 2023-09-07 14:45 Simon Glass
[not found] ` <20230907144531.28735-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
0 siblings, 1 reply; 2+ messages in thread
From: Simon Glass @ 2023-09-07 14:45 UTC (permalink / raw)
To: Devicetree Compiler; +Cc: David Gibson, Simon Glass
Boolean properties are unusual in that their presense or absence
indicates the value of the property. This makes them a little painful to
support using the existing getprop() support.
Add new methods to deal with booleans specifically.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
---
Makefile | 3 ++-
pylibfdt/libfdt.i | 55 +++++++++++++++++++++++++++++++++++++++++
tests/pylibfdt_tests.py | 34 +++++++++++++++++++++++++
tests/test_props.dts | 1 +
4 files changed, 92 insertions(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index 6ccee13..4a40993 100644
--- a/Makefile
+++ b/Makefile
@@ -24,8 +24,9 @@ CPPFLAGS = -I libfdt -I . -DFDT_ASSUME_MASK=$(ASSUME_MASK)
WARNINGS = -Wall -Wpointer-arith -Wcast-qual -Wnested-externs -Wsign-compare \
-Wstrict-prototypes -Wmissing-prototypes -Wredundant-decls -Wshadow \
-Wsuggest-attribute=format -Wwrite-strings
-CFLAGS = -g -Os $(SHAREDLIB_CFLAGS) -Werror $(WARNINGS) $(EXTRA_CFLAGS)
+CFLAGS = -g -Os $(SHAREDLIB_CFLAGS) $(WARNINGS) $(EXTRA_CFLAGS)
+# -Werror
BISON = bison
LEX = flex
SWIG = swig
diff --git a/pylibfdt/libfdt.i b/pylibfdt/libfdt.i
index 2361e22..0b50983 100644
--- a/pylibfdt/libfdt.i
+++ b/pylibfdt/libfdt.i
@@ -419,6 +419,35 @@ class FdtRo(object):
return pdata
return Property(prop_name, bytearray(pdata[0]))
+ def hasprop(self, nodeoffset, prop_name, quiet=()):
+ """Check if a node has a property
+
+ This can be used to check boolean properties
+
+ Args:
+ nodeoffset: Node offset containing property to check
+ prop_name: Name of property to check
+ quiet: Errors to ignore (empty to raise on all errors). Note that
+ NOTFOUND is added internally by this function so need not be
+ provided
+
+ Returns:
+ True if the property exists in the node, else False. If an error
+ other than -NOTFOUND is returned by fdt_getprop() then the error
+ is return (-ve integer)
+
+ Raises:
+ FdtError if any error occurs other than NOTFOUND (e.g. the
+ nodeoffset is invalid)
+ """
+ pdata = check_err_null(fdt_getprop(self._fdt, nodeoffset, prop_name),
+ quiet + (NOTFOUND,))
+ if isinstance(pdata, (int)):
+ if pdata == -NOTFOUND:
+ return False
+ return pdata
+ return True
+
def get_phandle(self, nodeoffset):
"""Get the phandle of a node
@@ -605,6 +634,32 @@ class Fdt(FdtRo):
return check_err(fdt_setprop(self._fdt, nodeoffset, prop_name, val,
len(val)), quiet)
+ def setprop_bool(self, nodeoffset, prop_name, val, quiet=()):
+ """Set the boolean value of a property
+
+ Either:
+ adds the property if not already present; or
+ deletes the property if present
+
+ Args:
+ nodeoffset: Node offset containing the property to create/delete
+ prop_name: Name of property
+ val: Boolean value to write (i.e. True or False)
+ quiet: Errors to ignore (empty to raise on all errors)
+
+ Returns:
+ Error code, or 0 if OK
+
+ Raises:
+ FdtException if no parent found or other error occurs
+ """
+ exists = self.hasprop(nodeoffset, prop_name, quiet)
+ if val != exists:
+ if val:
+ return self.setprop(nodeoffset, prop_name, b'', quiet=quiet)
+ else:
+ return self.delprop(nodeoffset, prop_name, quiet=quiet)
+
def setprop_u32(self, nodeoffset, prop_name, val, quiet=()):
"""Set the value of a property
diff --git a/tests/pylibfdt_tests.py b/tests/pylibfdt_tests.py
index 34c2764..6ef8f34 100644
--- a/tests/pylibfdt_tests.py
+++ b/tests/pylibfdt_tests.py
@@ -496,6 +496,40 @@ class PyLibfdtBasicTests(unittest.TestCase):
self.assertEqual(TEST_STRING_3,
self.fdt.getprop(node, prop).as_str())
+ def testSetPropU32(self):
+ """Test that we can update and create integer properties"""
+ node = 0
+ prop = 'prop-int'
+ self.fdt.setprop_u32(node, prop, TEST_VALUE_1)
+ self.assertEqual(struct.pack('>I', TEST_VALUE_1),
+ self.fdt.getprop(node, prop))
+
+ def testSetPropBool(self):
+ """Test that we can update and create boolean properties"""
+ node = 0
+ prop = 'prop-bool'
+
+ # Check adding where there is no space
+ self.assertFalse(self.fdt2.hasprop(node, 'missing'))
+ self.assertEqual(
+ -libfdt.NOSPACE,
+ self.fdt2.setprop_bool(node, 'missing', True,
+ quiet=(libfdt.NOSPACE,)))
+ self.assertFalse(self.fdt2.hasprop(node, 'missing'))
+
+ # Trying toggling an existing boolean property. Do each operation twice
+ # to make sure that the behaviour is correct when setting the property
+ # to the same value.
+ self.assertTrue(self.fdt2.hasprop(node, prop))
+ self.fdt2.setprop_bool(node, prop, False)
+ self.assertFalse(self.fdt2.hasprop(node, prop))
+ self.fdt2.setprop_bool(node, prop, False)
+ self.assertFalse(self.fdt2.hasprop(node, prop))
+ self.fdt2.setprop_bool(node, prop, True)
+ self.assertTrue(self.fdt2.hasprop(node, prop))
+ self.fdt2.setprop_bool(node, prop, True)
+ self.assertTrue(self.fdt2.hasprop(node, prop))
+
def testSetName(self):
"""Test that we can update a node name"""
node = self.fdt.path_offset('/subnode@1')
diff --git a/tests/test_props.dts b/tests/test_props.dts
index 5089023..09be197 100644
--- a/tests/test_props.dts
+++ b/tests/test_props.dts
@@ -12,4 +12,5 @@
prop-uint32-array = <0x1>, <0x98765432>, <0xdeadbeef>;
prop-int64-array = /bits/ 64 <0x100000000 0xfffffffffffffffe>;
prop-uint64-array = /bits/ 64 <0x100000000 0x1>;
+ prop-bool;
};
--
2.42.0.283.g2d96d420d3-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] pylibfdt: Support boolean properties
[not found] ` <20230907144531.28735-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
@ 2023-09-08 1:01 ` David Gibson
0 siblings, 0 replies; 2+ messages in thread
From: David Gibson @ 2023-09-08 1:01 UTC (permalink / raw)
To: Simon Glass; +Cc: Devicetree Compiler
[-- Attachment #1: Type: text/plain, Size: 7289 bytes --]
On Thu, Sep 07, 2023 at 08:45:30AM -0600, Simon Glass wrote:
> Boolean properties are unusual in that their presense or absence
> indicates the value of the property. This makes them a little painful to
> support using the existing getprop() support.
>
> Add new methods to deal with booleans specifically.
>
> Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
> ---
>
> Makefile | 3 ++-
> pylibfdt/libfdt.i | 55 +++++++++++++++++++++++++++++++++++++++++
> tests/pylibfdt_tests.py | 34 +++++++++++++++++++++++++
> tests/test_props.dts | 1 +
> 4 files changed, 92 insertions(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 6ccee13..4a40993 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -24,8 +24,9 @@ CPPFLAGS = -I libfdt -I . -DFDT_ASSUME_MASK=$(ASSUME_MASK)
> WARNINGS = -Wall -Wpointer-arith -Wcast-qual -Wnested-externs -Wsign-compare \
> -Wstrict-prototypes -Wmissing-prototypes -Wredundant-decls -Wshadow \
> -Wsuggest-attribute=format -Wwrite-strings
> -CFLAGS = -g -Os $(SHAREDLIB_CFLAGS) -Werror $(WARNINGS) $(EXTRA_CFLAGS)
> +CFLAGS = -g -Os $(SHAREDLIB_CFLAGS) $(WARNINGS) $(EXTRA_CFLAGS)
>
> +# -Werror
Uh... this doesn't look right. At the very least it's an unrelated change.
> BISON = bison
> LEX = flex
> SWIG = swig
> diff --git a/pylibfdt/libfdt.i b/pylibfdt/libfdt.i
> index 2361e22..0b50983 100644
> --- a/pylibfdt/libfdt.i
> +++ b/pylibfdt/libfdt.i
> @@ -419,6 +419,35 @@ class FdtRo(object):
> return pdata
> return Property(prop_name, bytearray(pdata[0]))
>
> + def hasprop(self, nodeoffset, prop_name, quiet=()):
> + """Check if a node has a property
> +
> + This can be used to check boolean properties
> +
> + Args:
> + nodeoffset: Node offset containing property to check
> + prop_name: Name of property to check
> + quiet: Errors to ignore (empty to raise on all errors). Note that
> + NOTFOUND is added internally by this function so need not be
> + provided
> +
> + Returns:
> + True if the property exists in the node, else False. If an error
> + other than -NOTFOUND is returned by fdt_getprop() then the error
> + is return (-ve integer)
> +
> + Raises:
> + FdtError if any error occurs other than NOTFOUND (e.g. the
> + nodeoffset is invalid)
> + """
> + pdata = check_err_null(fdt_getprop(self._fdt, nodeoffset, prop_name),
> + quiet + (NOTFOUND,))
> + if isinstance(pdata, (int)):
> + if pdata == -NOTFOUND:
> + return False
> + return pdata
> + return True
LGTM.
> +
> def get_phandle(self, nodeoffset):
> """Get the phandle of a node
>
> @@ -605,6 +634,32 @@ class Fdt(FdtRo):
> return check_err(fdt_setprop(self._fdt, nodeoffset, prop_name, val,
> len(val)), quiet)
>
> + def setprop_bool(self, nodeoffset, prop_name, val, quiet=()):
> + """Set the boolean value of a property
> +
> + Either:
> + adds the property if not already present; or
> + deletes the property if present
> +
> + Args:
> + nodeoffset: Node offset containing the property to create/delete
> + prop_name: Name of property
> + val: Boolean value to write (i.e. True or False)
> + quiet: Errors to ignore (empty to raise on all errors)
> +
> + Returns:
> + Error code, or 0 if OK
> +
> + Raises:
> + FdtException if no parent found or other error occurs
> + """
> + exists = self.hasprop(nodeoffset, prop_name, quiet)
> + if val != exists:
> + if val:
> + return self.setprop(nodeoffset, prop_name, b'', quiet=quiet)
> + else:
> + return self.delprop(nodeoffset, prop_name, quiet=quiet)
> +
LGTM
> def setprop_u32(self, nodeoffset, prop_name, val, quiet=()):
> """Set the value of a property
>
> diff --git a/tests/pylibfdt_tests.py b/tests/pylibfdt_tests.py
> index 34c2764..6ef8f34 100644
> --- a/tests/pylibfdt_tests.py
> +++ b/tests/pylibfdt_tests.py
> @@ -496,6 +496,40 @@ class PyLibfdtBasicTests(unittest.TestCase):
> self.assertEqual(TEST_STRING_3,
> self.fdt.getprop(node, prop).as_str())
>
> + def testSetPropU32(self):
> + """Test that we can update and create integer properties"""
> + node = 0
> + prop = 'prop-int'
> + self.fdt.setprop_u32(node, prop, TEST_VALUE_1)
> + self.assertEqual(struct.pack('>I', TEST_VALUE_1),
> + self.fdt.getprop(node, prop))
> +
This looks file, but doesn't really belong with this patch.
> + def testSetPropBool(self):
Might be nice to separate a case testing just hasprop() on the
unmodified tree.
> + """Test that we can update and create boolean properties"""
> + node = 0
> + prop = 'prop-bool'
> +
> + # Check adding where there is no space
> + self.assertFalse(self.fdt2.hasprop(node, 'missing'))
> + self.assertEqual(
> + -libfdt.NOSPACE,
> + self.fdt2.setprop_bool(node, 'missing', True,
> + quiet=(libfdt.NOSPACE,)))
> + self.assertFalse(self.fdt2.hasprop(node, 'missing'))
I'm not sure that specifically checking the NOSPACE case is
particularly valuable. If nothing else it seems like it should be in
a different test case, rather than front and centre in this one.
> +
> + # Trying toggling an existing boolean property. Do each operation twice
> + # to make sure that the behaviour is correct when setting the property
> + # to the same value.
> + self.assertTrue(self.fdt2.hasprop(node, prop))
> + self.fdt2.setprop_bool(node, prop, False)
> + self.assertFalse(self.fdt2.hasprop(node, prop))
> + self.fdt2.setprop_bool(node, prop, False)
> + self.assertFalse(self.fdt2.hasprop(node, prop))
> + self.fdt2.setprop_bool(node, prop, True)
> + self.assertTrue(self.fdt2.hasprop(node, prop))
> + self.fdt2.setprop_bool(node, prop, True)
> + self.assertTrue(self.fdt2.hasprop(node, prop))
> +
> def testSetName(self):
> """Test that we can update a node name"""
> node = self.fdt.path_offset('/subnode@1')
> diff --git a/tests/test_props.dts b/tests/test_props.dts
> index 5089023..09be197 100644
> --- a/tests/test_props.dts
> +++ b/tests/test_props.dts
> @@ -12,4 +12,5 @@
> prop-uint32-array = <0x1>, <0x98765432>, <0xdeadbeef>;
> prop-int64-array = /bits/ 64 <0x100000000 0xfffffffffffffffe>;
> prop-uint64-array = /bits/ 64 <0x100000000 0x1>;
> + prop-bool;
> };
--
David Gibson | I'll have my music baroque, and my code
david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_
| _way_ _around_!
http://www.ozlabs.org/~dgibson
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-09-08 1:01 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-09-07 14:45 [PATCH] pylibfdt: Support boolean properties Simon Glass
[not found] ` <20230907144531.28735-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2023-09-08 1:01 ` David Gibson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).