diff mbox

[U-Boot] fdt: Documentation for a few support functions aside their prototypes

Message ID 1432461713-10467-1-git-send-email-contact@paulk.fr
State Accepted
Delegated to: Simon Glass
Headers show

Commit Message

Paul Kocialkowski May 24, 2015, 10:01 a.m. UTC
This instroduces comments that explain the purpose, parameters and return codes
of a few fdt support functions, that are used to fill the fdt.

Signed-off-by: Paul Kocialkowski <contact@paulk.fr>
---
 include/fdt_support.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

Comments

Simon Glass May 26, 2015, 3:15 p.m. UTC | #1
Hi Paul,

On 24 May 2015 at 04:01, Paul Kocialkowski <contact@paulk.fr> wrote:
> This instroduces comments that explain the purpose, parameters and return codes
> of a few fdt support functions, that are used to fill the fdt.

introduces

>
> Signed-off-by: Paul Kocialkowski <contact@paulk.fr>
> ---
>  include/fdt_support.h | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)

Thanks for the patch.

Acked-by: Simon Glass <sjg@chromium.org>

>
> diff --git a/include/fdt_support.h b/include/fdt_support.h
> index 56185c9..0edc4fa 100644
> --- a/include/fdt_support.h
> +++ b/include/fdt_support.h
> @@ -16,9 +16,35 @@ u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
>                                 const char *prop, const u32 dflt);
>  u32 fdt_getprop_u32_default(const void *fdt, const char *path,
>                                 const char *prop, const u32 dflt);
> +
> +/**
> + * Add data to the root of the FDT before booting the OS.
> + *
> + * See doc/device-tree-bindings/root.txt
> + *
> + * @param fdt          FDT address in memory
> + * @return 0 if ok, or -FDT_ERR_... on error
> + */
>  int fdt_root(void *fdt);
> +
> +/**
> + * Add chosen data the FDT before booting the OS.
> + *
> + * In particular, this adds the kernel command line (bootargs) to the FDT.
> + *
> + * @param fdt          FDT address in memory
> + * @return 0 if ok, or -FDT_ERR_... on error
> + */
>  int fdt_chosen(void *fdt);
> +
> +/**
> + * Add initrd information to the FDT before booting the OS.
> + *
> + * @param fdt          FDT address in memory
> + * @return 0 if ok, or -FDT_ERR_... on error
> + */
>  int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
> +
>  void do_fixup_by_path(void *fdt, const char *path, const char *prop,
>                       const void *val, int len, int create);
>  void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
> --
> 1.9.1
>

Regards,
Simon
diff mbox

Patch

diff --git a/include/fdt_support.h b/include/fdt_support.h
index 56185c9..0edc4fa 100644
--- a/include/fdt_support.h
+++ b/include/fdt_support.h
@@ -16,9 +16,35 @@  u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
 				const char *prop, const u32 dflt);
 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
 				const char *prop, const u32 dflt);
+
+/**
+ * Add data to the root of the FDT before booting the OS.
+ *
+ * See doc/device-tree-bindings/root.txt
+ *
+ * @param fdt		FDT address in memory
+ * @return 0 if ok, or -FDT_ERR_... on error
+ */
 int fdt_root(void *fdt);
+
+/**
+ * Add chosen data the FDT before booting the OS.
+ *
+ * In particular, this adds the kernel command line (bootargs) to the FDT.
+ *
+ * @param fdt		FDT address in memory
+ * @return 0 if ok, or -FDT_ERR_... on error
+ */
 int fdt_chosen(void *fdt);
+
+/**
+ * Add initrd information to the FDT before booting the OS.
+ *
+ * @param fdt		FDT address in memory
+ * @return 0 if ok, or -FDT_ERR_... on error
+ */
 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
+
 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
 		      const void *val, int len, int create);
 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,