Re: [PATCH 4/5] Documentation: rename of_selftest.txt to of_unittest.txt
Please use -M flag while sending rename patch, as mentioned in my other mail. On Tue, Mar 10, 2015 at 8:37 PM, Wang Long wrote: > Since the test of the devicetree's OF api use unittest as > its name. so we should rename of_selftest.txt to of_unittest.txt. > > Signed-off-by: Wang Long > --- > Documentation/devicetree/of_selftest.txt | 198 > --- > Documentation/devicetree/of_unittest.txt | 198 > +++ > 2 files changed, 198 insertions(+), 198 deletions(-) > delete mode 100644 Documentation/devicetree/of_selftest.txt > create mode 100644 Documentation/devicetree/of_unittest.txt > > diff --git a/Documentation/devicetree/of_selftest.txt > b/Documentation/devicetree/of_selftest.txt > deleted file mode 100644 > index d79a6bc..000 > --- a/Documentation/devicetree/of_selftest.txt > +++ /dev/null > @@ -1,198 +0,0 @@ > -Open Firmware Device Tree Unittest > --- > - > -Author: Gaurav Minocha > - > -1. Introduction > - > -This document explains how the test data required for executing OF unittest > -is attached to the live tree dynamically, independent of the machine's > -architecture. > - > -It is recommended to read the following documents before moving ahead. > - > -[1] Documentation/devicetree/usage-model.txt > -[2] http://www.devicetree.org/Device_Tree_Usage > - > -OF Selftest has been designed to test the interface (include/linux/of.h) > -provided to device driver developers to fetch the device information..etc. > -from the unflattened device tree data structure. This interface is used by > -most of the device drivers in various use cases. > - > - > -2. Test-data > - > -The Device Tree Source file (drivers/of/unittest-data/testcases.dts) contains > -the test data required for executing the unit tests automated in > -drivers/of/unittest.c. Currently, following Device Tree Source Include files > -(.dtsi) are included in testcases.dts: > - > -drivers/of/unittest-data/tests-interrupts.dtsi > -drivers/of/unittest-data/tests-platform.dtsi > -drivers/of/unittest-data/tests-phandle.dtsi > -drivers/of/unittest-data/tests-match.dtsi > -drivers/of/unittest-data/tests-overlay.dtsi > - > -When the kernel is build with OF_SELFTEST enabled, then the following make > rule > - > -$(obj)/%.dtb: $(src)/%.dts FORCE > - $(call if_changed_dep, dtc) > - > -is used to compile the DT source file (testcases.dts) into a binary blob > -(testcases.dtb), also referred as flattened DT. > - > -After that, using the following rule the binary blob above is wrapped as an > -assembly file (testcases.dtb.S). > - > -$(obj)/%.dtb.S: $(obj)/%.dtb > - $(call cmd, dt_S_dtb) > - > -The assembly file is compiled into an object file (testcases.dtb.o), and is > -linked into the kernel image. > - > - > -2.1. Adding the test data > - > -Un-flattened device tree structure: > - > -Un-flattened device tree consists of connected device_node(s) in form of a > tree > -structure described below. > - > -// following struct members are used to construct the tree > -struct device_node { > -... > -struct device_node *parent; > -struct device_node *child; > -struct device_node *sibling; > -... > - }; > - > -Figure 1, describes a generic structure of machine's un-flattened device tree > -considering only child and sibling pointers. There exists another pointer, > -*parent, that is used to traverse the tree in the reverse direction. So, at > -a particular level the child node and all the sibling nodes will have a > parent > -pointer pointing to a common node (e.g. child1, sibling2, sibling3, > sibling4's > -parent points to root node) > - > -root ('/') > - | > -child1 -> sibling2 -> sibling3 -> sibling4 -> null > - | | | | > - | | | null > - | | | > - | |child31 -> sibling32 -> null > - | | | | > - | | null null > - | | > - | child21 -> sibling22 -> sibling23 -> null > - | | || > - |null null null > - | > -child11 -> sibling12 -> sibling13 -> sibling14 -> null > - | | || > - | | | null > - | | | > - nullnull child131 -> null > - | > - null > - > -Figure 1: Generic structure of un-flattened device tree > - > - > -Before executing OF unittest, it is required to attach the test data to > -machine's device tree (if present). So, when unittest_data_add() is called, > -at first it reads the flattened device tree data linked into the kernel image > -via the following kernel symbols: > - > -__dtb_testcases_begin - address marking the start of test data blob > -__dtb_testcases_end - address marking the end of test data blob > - > -Secondly, it calls
[PATCH 4/5] Documentation: rename of_selftest.txt to of_unittest.txt
Since the test of the devicetree's OF api use unittest as its name. so we should rename of_selftest.txt to of_unittest.txt. Signed-off-by: Wang Long --- Documentation/devicetree/of_selftest.txt | 198 --- Documentation/devicetree/of_unittest.txt | 198 +++ 2 files changed, 198 insertions(+), 198 deletions(-) delete mode 100644 Documentation/devicetree/of_selftest.txt create mode 100644 Documentation/devicetree/of_unittest.txt diff --git a/Documentation/devicetree/of_selftest.txt b/Documentation/devicetree/of_selftest.txt deleted file mode 100644 index d79a6bc..000 --- a/Documentation/devicetree/of_selftest.txt +++ /dev/null @@ -1,198 +0,0 @@ -Open Firmware Device Tree Unittest --- - -Author: Gaurav Minocha - -1. Introduction - -This document explains how the test data required for executing OF unittest -is attached to the live tree dynamically, independent of the machine's -architecture. - -It is recommended to read the following documents before moving ahead. - -[1] Documentation/devicetree/usage-model.txt -[2] http://www.devicetree.org/Device_Tree_Usage - -OF Selftest has been designed to test the interface (include/linux/of.h) -provided to device driver developers to fetch the device information..etc. -from the unflattened device tree data structure. This interface is used by -most of the device drivers in various use cases. - - -2. Test-data - -The Device Tree Source file (drivers/of/unittest-data/testcases.dts) contains -the test data required for executing the unit tests automated in -drivers/of/unittest.c. Currently, following Device Tree Source Include files -(.dtsi) are included in testcases.dts: - -drivers/of/unittest-data/tests-interrupts.dtsi -drivers/of/unittest-data/tests-platform.dtsi -drivers/of/unittest-data/tests-phandle.dtsi -drivers/of/unittest-data/tests-match.dtsi -drivers/of/unittest-data/tests-overlay.dtsi - -When the kernel is build with OF_SELFTEST enabled, then the following make rule - -$(obj)/%.dtb: $(src)/%.dts FORCE - $(call if_changed_dep, dtc) - -is used to compile the DT source file (testcases.dts) into a binary blob -(testcases.dtb), also referred as flattened DT. - -After that, using the following rule the binary blob above is wrapped as an -assembly file (testcases.dtb.S). - -$(obj)/%.dtb.S: $(obj)/%.dtb - $(call cmd, dt_S_dtb) - -The assembly file is compiled into an object file (testcases.dtb.o), and is -linked into the kernel image. - - -2.1. Adding the test data - -Un-flattened device tree structure: - -Un-flattened device tree consists of connected device_node(s) in form of a tree -structure described below. - -// following struct members are used to construct the tree -struct device_node { -... -struct device_node *parent; -struct device_node *child; -struct device_node *sibling; -... - }; - -Figure 1, describes a generic structure of machine's un-flattened device tree -considering only child and sibling pointers. There exists another pointer, -*parent, that is used to traverse the tree in the reverse direction. So, at -a particular level the child node and all the sibling nodes will have a parent -pointer pointing to a common node (e.g. child1, sibling2, sibling3, sibling4's -parent points to root node) - -root ('/') - | -child1 -> sibling2 -> sibling3 -> sibling4 -> null - | | | | - | | | null - | | | - | |child31 -> sibling32 -> null - | | | | - | | null null - | | - | child21 -> sibling22 -> sibling23 -> null - | | || - |null null null - | -child11 -> sibling12 -> sibling13 -> sibling14 -> null - | | || - | | | null - | | | - nullnull child131 -> null - | - null - -Figure 1: Generic structure of un-flattened device tree - - -Before executing OF unittest, it is required to attach the test data to -machine's device tree (if present). So, when unittest_data_add() is called, -at first it reads the flattened device tree data linked into the kernel image -via the following kernel symbols: - -__dtb_testcases_begin - address marking the start of test data blob -__dtb_testcases_end - address marking the end of test data blob - -Secondly, it calls of_fdt_unflatten_tree() to unflatten the flattened -blob. And finally, if the machine's device tree (i.e live tree) is present, -then it attaches the unflattened test data tree to the live tree, else it -attaches itself as a live device tree. - -attach_node_and_children() uses of_attach_node() to attach the nodes into the -live tree as explained below. To explain the same, the test data tree described - in Figure 2 is
[PATCH 4/5] Documentation: rename of_selftest.txt to of_unittest.txt
Since the test of the devicetree's OF api use unittest as its name. so we should rename of_selftest.txt to of_unittest.txt. Signed-off-by: Wang Long long.wangl...@huawei.com --- Documentation/devicetree/of_selftest.txt | 198 --- Documentation/devicetree/of_unittest.txt | 198 +++ 2 files changed, 198 insertions(+), 198 deletions(-) delete mode 100644 Documentation/devicetree/of_selftest.txt create mode 100644 Documentation/devicetree/of_unittest.txt diff --git a/Documentation/devicetree/of_selftest.txt b/Documentation/devicetree/of_selftest.txt deleted file mode 100644 index d79a6bc..000 --- a/Documentation/devicetree/of_selftest.txt +++ /dev/null @@ -1,198 +0,0 @@ -Open Firmware Device Tree Unittest --- - -Author: Gaurav Minocha gaurav.minocha...@gmail.com - -1. Introduction - -This document explains how the test data required for executing OF unittest -is attached to the live tree dynamically, independent of the machine's -architecture. - -It is recommended to read the following documents before moving ahead. - -[1] Documentation/devicetree/usage-model.txt -[2] http://www.devicetree.org/Device_Tree_Usage - -OF Selftest has been designed to test the interface (include/linux/of.h) -provided to device driver developers to fetch the device information..etc. -from the unflattened device tree data structure. This interface is used by -most of the device drivers in various use cases. - - -2. Test-data - -The Device Tree Source file (drivers/of/unittest-data/testcases.dts) contains -the test data required for executing the unit tests automated in -drivers/of/unittest.c. Currently, following Device Tree Source Include files -(.dtsi) are included in testcases.dts: - -drivers/of/unittest-data/tests-interrupts.dtsi -drivers/of/unittest-data/tests-platform.dtsi -drivers/of/unittest-data/tests-phandle.dtsi -drivers/of/unittest-data/tests-match.dtsi -drivers/of/unittest-data/tests-overlay.dtsi - -When the kernel is build with OF_SELFTEST enabled, then the following make rule - -$(obj)/%.dtb: $(src)/%.dts FORCE - $(call if_changed_dep, dtc) - -is used to compile the DT source file (testcases.dts) into a binary blob -(testcases.dtb), also referred as flattened DT. - -After that, using the following rule the binary blob above is wrapped as an -assembly file (testcases.dtb.S). - -$(obj)/%.dtb.S: $(obj)/%.dtb - $(call cmd, dt_S_dtb) - -The assembly file is compiled into an object file (testcases.dtb.o), and is -linked into the kernel image. - - -2.1. Adding the test data - -Un-flattened device tree structure: - -Un-flattened device tree consists of connected device_node(s) in form of a tree -structure described below. - -// following struct members are used to construct the tree -struct device_node { -... -struct device_node *parent; -struct device_node *child; -struct device_node *sibling; -... - }; - -Figure 1, describes a generic structure of machine's un-flattened device tree -considering only child and sibling pointers. There exists another pointer, -*parent, that is used to traverse the tree in the reverse direction. So, at -a particular level the child node and all the sibling nodes will have a parent -pointer pointing to a common node (e.g. child1, sibling2, sibling3, sibling4's -parent points to root node) - -root ('/') - | -child1 - sibling2 - sibling3 - sibling4 - null - | | | | - | | | null - | | | - | |child31 - sibling32 - null - | | | | - | | null null - | | - | child21 - sibling22 - sibling23 - null - | | || - |null null null - | -child11 - sibling12 - sibling13 - sibling14 - null - | | || - | | | null - | | | - nullnull child131 - null - | - null - -Figure 1: Generic structure of un-flattened device tree - - -Before executing OF unittest, it is required to attach the test data to -machine's device tree (if present). So, when unittest_data_add() is called, -at first it reads the flattened device tree data linked into the kernel image -via the following kernel symbols: - -__dtb_testcases_begin - address marking the start of test data blob -__dtb_testcases_end - address marking the end of test data blob - -Secondly, it calls of_fdt_unflatten_tree() to unflatten the flattened -blob. And finally, if the machine's device tree (i.e live tree) is present, -then it attaches the unflattened test data tree to the live tree, else it -attaches itself as a live device tree. - -attach_node_and_children() uses of_attach_node() to attach the nodes into the -live tree as explained below. To explain the same, the test
Re: [PATCH 4/5] Documentation: rename of_selftest.txt to of_unittest.txt
Please use -M flag while sending rename patch, as mentioned in my other mail. On Tue, Mar 10, 2015 at 8:37 PM, Wang Long long.wangl...@huawei.com wrote: Since the test of the devicetree's OF api use unittest as its name. so we should rename of_selftest.txt to of_unittest.txt. Signed-off-by: Wang Long long.wangl...@huawei.com --- Documentation/devicetree/of_selftest.txt | 198 --- Documentation/devicetree/of_unittest.txt | 198 +++ 2 files changed, 198 insertions(+), 198 deletions(-) delete mode 100644 Documentation/devicetree/of_selftest.txt create mode 100644 Documentation/devicetree/of_unittest.txt diff --git a/Documentation/devicetree/of_selftest.txt b/Documentation/devicetree/of_selftest.txt deleted file mode 100644 index d79a6bc..000 --- a/Documentation/devicetree/of_selftest.txt +++ /dev/null @@ -1,198 +0,0 @@ -Open Firmware Device Tree Unittest --- - -Author: Gaurav Minocha gaurav.minocha...@gmail.com - -1. Introduction - -This document explains how the test data required for executing OF unittest -is attached to the live tree dynamically, independent of the machine's -architecture. - -It is recommended to read the following documents before moving ahead. - -[1] Documentation/devicetree/usage-model.txt -[2] http://www.devicetree.org/Device_Tree_Usage - -OF Selftest has been designed to test the interface (include/linux/of.h) -provided to device driver developers to fetch the device information..etc. -from the unflattened device tree data structure. This interface is used by -most of the device drivers in various use cases. - - -2. Test-data - -The Device Tree Source file (drivers/of/unittest-data/testcases.dts) contains -the test data required for executing the unit tests automated in -drivers/of/unittest.c. Currently, following Device Tree Source Include files -(.dtsi) are included in testcases.dts: - -drivers/of/unittest-data/tests-interrupts.dtsi -drivers/of/unittest-data/tests-platform.dtsi -drivers/of/unittest-data/tests-phandle.dtsi -drivers/of/unittest-data/tests-match.dtsi -drivers/of/unittest-data/tests-overlay.dtsi - -When the kernel is build with OF_SELFTEST enabled, then the following make rule - -$(obj)/%.dtb: $(src)/%.dts FORCE - $(call if_changed_dep, dtc) - -is used to compile the DT source file (testcases.dts) into a binary blob -(testcases.dtb), also referred as flattened DT. - -After that, using the following rule the binary blob above is wrapped as an -assembly file (testcases.dtb.S). - -$(obj)/%.dtb.S: $(obj)/%.dtb - $(call cmd, dt_S_dtb) - -The assembly file is compiled into an object file (testcases.dtb.o), and is -linked into the kernel image. - - -2.1. Adding the test data - -Un-flattened device tree structure: - -Un-flattened device tree consists of connected device_node(s) in form of a tree -structure described below. - -// following struct members are used to construct the tree -struct device_node { -... -struct device_node *parent; -struct device_node *child; -struct device_node *sibling; -... - }; - -Figure 1, describes a generic structure of machine's un-flattened device tree -considering only child and sibling pointers. There exists another pointer, -*parent, that is used to traverse the tree in the reverse direction. So, at -a particular level the child node and all the sibling nodes will have a parent -pointer pointing to a common node (e.g. child1, sibling2, sibling3, sibling4's -parent points to root node) - -root ('/') - | -child1 - sibling2 - sibling3 - sibling4 - null - | | | | - | | | null - | | | - | |child31 - sibling32 - null - | | | | - | | null null - | | - | child21 - sibling22 - sibling23 - null - | | || - |null null null - | -child11 - sibling12 - sibling13 - sibling14 - null - | | || - | | | null - | | | - nullnull child131 - null - | - null - -Figure 1: Generic structure of un-flattened device tree - - -Before executing OF unittest, it is required to attach the test data to -machine's device tree (if present). So, when unittest_data_add() is called, -at first it reads the flattened device tree data linked into the kernel image -via the following kernel symbols: - -__dtb_testcases_begin - address marking the start of test data blob -__dtb_testcases_end - address marking the end of test data blob - -Secondly, it calls of_fdt_unflatten_tree() to unflatten the flattened -blob. And finally, if the machine's