fix incorrect usage of DT node unit address in comments
authorAndre Przywara <andre.przywara@arm.com>
Mon, 4 Dec 2017 02:05:10 +0000 (02:05 +0000)
committerSimon Glass <sjg@chromium.org>
Tue, 16 Jan 2018 01:29:21 +0000 (18:29 -0700)
The DT spec demands a unit-address in a node name to match the "reg"
property in that node. Newer dtc versions will throw warnings if this is
not the case.
Fix all occurences in the tree where node names were mentioned in
comments, to not give bad examples to the reader.

Signed-off-by: Andre Przywara <andre.przywara@arm.com>
common/image-fit.c
common/image-sig.c
include/image.h
tools/image-host.c

index b785d8a36e6a0483f1cbdf30f73a3fec82d12b01..f6e956ad963a0d2a390c64bed812b23de9d4dbbc 100644 (file)
@@ -330,7 +330,7 @@ static void fit_image_print_verification_data(const void *fit, int noffset,
        /*
         * Check subnode name, must be equal to "hash" or "signature".
         * Multiple hash/signature nodes require unique unit node
-        * names, e.g. hash@1, hash@2, signature@1, signature@2, etc.
+        * names, e.g. hash-1, hash-2, signature-1, signature-2, etc.
         */
        name = fit_get_name(fit, noffset, NULL);
        if (!strncmp(name, FIT_HASH_NODENAME, strlen(FIT_HASH_NODENAME))) {
@@ -1111,7 +1111,7 @@ int fit_image_verify(const void *fit, int image_noffset)
                /*
                 * Check subnode name, must be equal to "hash".
                 * Multiple hash nodes require unique unit node
-                * names, e.g. hash@1, hash@2, etc.
+                * names, e.g. hash-1, hash-2, etc.
                 */
                if (!strncmp(name, FIT_HASH_NODENAME,
                             strlen(FIT_HASH_NODENAME))) {
@@ -1348,15 +1348,15 @@ int fit_check_format(const void *fit)
  *
  * / o image-tree
  *   |-o images
- *   | |-o fdt@1
- *   | |-o fdt@2
+ *   | |-o fdt-1
+ *   | |-o fdt-2
  *   |
  *   |-o configurations
- *     |-o config@1
- *     | |-fdt = fdt@1
+ *     |-o config-1
+ *     | |-fdt = fdt-1
  *     |
- *     |-o config@2
- *       |-fdt = fdt@2
+ *     |-o config-2
+ *       |-fdt = fdt-2
  *
  * / o U-Boot fdt
  *   |-compatible = "foo,bar", "bim,bam"
index bf824fef3c71bf4fa2b4f66aaed89ff17a021e43..d9f712fc1e04185316c1d9bdeb54da2ff529580c 100644 (file)
@@ -347,7 +347,7 @@ int fit_config_check_sig(const void *fit, int noffset, int required_keynode,
 
        /*
         * Each node can generate one region for each sub-node. Allow for
-        * 7 sub-nodes (hash@1, signature@1, etc.) and some extra.
+        * 7 sub-nodes (hash-1, signature-1, etc.) and some extra.
         */
        max_regions = 20 + count * 7;
        struct fdt_region fdt_regions[max_regions];
index a41a8369c65432ec73c40f3c4aa0033979616f98..b2b23a96f110bc2af9af2e20206ecf0cf68d2b17 100644 (file)
@@ -578,7 +578,7 @@ int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
  * boot_get_loadable() will take the given FIT configuration, and look
  * for a field named "loadables".  Loadables, is a list of elements in
  * the FIT given as strings.  exe:
- *   loadables = "linux_kernel@1", "fdt@2";
+ *   loadables = "linux_kernel", "fdt-2";
  * this function will attempt to parse each string, and load the
  * corresponding element from the FIT into memory.  Once placed,
  * no aditional actions are taken.
@@ -604,10 +604,10 @@ int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
  * @param images       Boot images structure
  * @param addr         Address of FIT in memory
  * @param fit_unamep   On entry this is the requested image name
- *                     (e.g. "kernel@1") or NULL to use the default. On exit
+ *                     (e.g. "kernel") or NULL to use the default. On exit
  *                     points to the selected image name
  * @param fit_uname_configp    On entry this is the requested configuration
- *                     name (e.g. "conf@1") or NULL to use the default. On
+ *                     name (e.g. "conf-1") or NULL to use the default. On
  *                     exit points to the selected configuration name.
  * @param arch         Expected architecture (IH_ARCH_...)
  * @param datap                Returns address of loaded image
@@ -632,10 +632,10 @@ int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
  * @param images       Boot images structure
  * @param addr         Address of FIT in memory
  * @param fit_unamep   On entry this is the requested image name
- *                     (e.g. "kernel@1") or NULL to use the default. On exit
+ *                     (e.g. "kernel") or NULL to use the default. On exit
  *                     points to the selected image name
  * @param fit_uname_configp    On entry this is the requested configuration
- *                     name (e.g. "conf@1") or NULL to use the default. On
+ *                     name (e.g. "conf-1") or NULL to use the default. On
  *                     exit points to the selected configuration name.
  * @param arch         Expected architecture (IH_ARCH_...)
  * @param image_type   Required image type (IH_TYPE_...). If this is
@@ -658,25 +658,25 @@ int fit_image_load(bootm_headers_t *images, ulong addr,
 /**
  * fit_get_node_from_config() - Look up an image a FIT by type
  *
- * This looks in the selected conf@ node (images->fit_uname_cfg) for a
+ * This looks in the selected conf- node (images->fit_uname_cfg) for a
  * particular image type (e.g. "kernel") and then finds the image that is
  * referred to.
  *
  * For example, for something like:
  *
  * images {
- *     kernel@1 {
+ *     kernel {
  *             ...
  *     };
  * };
  * configurations {
- *     conf@1 {
- *             kernel = "kernel@1";
+ *     conf-1 {
+ *             kernel = "kernel";
  *     };
  * };
  *
  * the function will return the node offset of the kernel@1 node, assuming
- * that conf@1 is the chosen configuration.
+ * that conf-1 is the chosen configuration.
  *
  * @param images       Boot images structure
  * @param prop_name    Property name to look up (FIT_..._PROP)
@@ -1022,10 +1022,10 @@ int fit_conf_get_node(const void *fit, const char *conf_uname);
  * @noffset:   Offset of conf@xxx node to check
  * @prop_name: Property to read from the conf node
  *
- * The conf@ nodes contain references to other nodes, using properties
- * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"),
+ * The conf- nodes contain references to other nodes, using properties
+ * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
  * return the offset of the node referred to (e.g. offset of node
- * "/images/kernel@1".
+ * "/images/kernel".
  */
 int fit_conf_get_prop_node(const void *fit, int noffset,
                const char *prop_name);
index 2c0030b5e23ef076c9fb48ce821982708486c873..8a7469e5383961e346bf4b91b7ab365c28e14e23 100644 (file)
@@ -270,16 +270,16 @@ static int fit_image_process_sig(const char *keydir, void *keydest,
  *
  * Input component image node structure:
  *
- * o image@1 (at image_noffset)
+ * o image-1 (at image_noffset)
  *   | - data = [binary data]
- *   o hash@1
+ *   o hash-1
  *     |- algo = "sha1"
  *
  * Output component image node structure:
  *
- * o image@1 (at image_noffset)
+ * o image-1 (at image_noffset)
  *   | - data = [binary data]
- *   o hash@1
+ *   o hash-1
  *     |- algo = "sha1"
  *     |- value = sha1(data)
  *
@@ -321,7 +321,7 @@ int fit_image_add_verification_data(const char *keydir, void *keydest,
                /*
                 * Check subnode name, must be equal to "hash" or "signature".
                 * Multiple hash nodes require unique unit node
-                * names, e.g. hash@1, hash@2, signature@1, etc.
+                * names, e.g. hash-1, hash-2, signature-1, etc.
                 */
                node_name = fit_get_name(fit, noffset, NULL);
                if (!strncmp(node_name, FIT_HASH_NODENAME,