<div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Jul 18, 2019 at 9:07 PM Gedare Bloom <<a href="mailto:gedare@rtems.org">gedare@rtems.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On Thu, Jul 18, 2019 at 8:24 AM Vijay Kumar Banerjee<br>
<<a href="mailto:vijaykumar9597@gmail.com" target="_blank">vijaykumar9597@gmail.com</a>> wrote:<br>
><br>
> ---<br>
>  user/bsps/arm/beagle.rst | 91 +++++++++++++++++++++++++++++++++++++++-<br>
>  1 file changed, 89 insertions(+), 2 deletions(-)<br>
><br>
> diff --git a/user/bsps/arm/beagle.rst b/user/bsps/arm/beagle.rst<br>
> index a36efde..84bfe2d 100644<br>
> --- a/user/bsps/arm/beagle.rst<br>
> +++ b/user/bsps/arm/beagle.rst<br>
> @@ -1,8 +1,95 @@<br>
>  .. SPDX-License-Identifier: CC-BY-SA-4.0<br>
><br>
> -.. Copyright (C) 2019 TBD<br>
> +.. Copyright (C) 2019 Vijay Kumar Banerjee<br>
><br>
>  beagle<br>
>  ======<br>
><br>
> -TODO.<br>
> +This BSP supports four variants, `beagleboardorig`, `beagleboardxm`, `beaglebonewhite`<br>
<br></blockquote><div>Hi,</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
We need a style guide for writing docs. I will send in separate email<br>
though I wondered if we should set a maximum line length/line breaks<br>
at 80 char as with code?<br>
<br></blockquote><div>Thanks for the review. I have fixed the issues you mentioned below and also</div><div>set the line length to 80 characters. I rewrote those areas to make it more clear</div><div>to the reader. Here's the v2 of the patch :<br><a href="https://lists.rtems.org/pipermail/devel/2019-July/026712.html">https://lists.rtems.org/pipermail/devel/2019-July/026712.html</a><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
> +and `beagleboneblack`. The basic hardware initialization is not performed by<br>
> +the BSP.  A boot loader with device tree support must be used to start the BSP,<br>
> +e.g. U-Boot.<br>
There is always a comma after e.g.<br>
<br>
> +<br>
> +TODO(These drivers are present but not documented yet):<br>
> +<br>
> + *  Clock driver.<br>
> + *  Network Interface Driver.<br>
> + *  SDcard driver.<br>
> + *  GPIO Driver.<br>
> + *  Console driver.<br>
> + *  PWM Driver.<br>
> + *  RTC driver.<br>
> +<br>
> +Boot via U-Boot<br>
> +---------------<br>
> +To boot via uboot, the ELF must be converted to a U-Boot image like below:<br>
> +<br>
> +.. code-block:: none<br>
> +<br>
> +    arm-rtems5-objcopy hello.exe -O app.bin<br>
> +    gzip 9 app.bin<br>
> +    mkimage -A arm -O linux -T kernel -a 0x80000000 -e 0x80000000 -n RTEMS -d app.bin.gz rtems-app.img<br>
> +<br>
> +Getting the Device Tree Blob<br>
> +----------------------------<br>
> +<br>
> +The Device Tree Blob(dtb) is needed to load the device tree while starting up<br>
We (American, British) normally put a space before parentheticals such<br>
as defining an acronym, like "Blob (dtb)".<br>
<br>
> +the kernel. We build the dtb from the FreeBSD source matching the commit hash<br>
> +from the libbsd HEAD of freebsd-org. For example if the HEAD is at<br>
> +"19a6ceb89dbacf74697d493e48c388767126d418"<br>
> +Then the right dts file is:<br>
dts should be mentioned before this<br>
<br>
> +<a href="https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/gnu/dts/arm/am335x-boneblack.dts" rel="noreferrer" target="_blank">https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/gnu/dts/arm/am335x-boneblack.dts</a><br>
> +<br>
> +.. code-block:: none<br>
> +<br>
> +     #building the dtb<br>
> +     #We will use the script from <a href="https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/tools/fdt/make_dtb.sh" rel="noreferrer" target="_blank">https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/tools/fdt/make_dtb.sh</a><br>
> +<br>
> +     export MACHINE='arm' #The make_dtb.sh script uses environment variable MACHINE<br>
> +     SCRIPT_DIR=$HOME/freebsd/sys/tools/fdt<br>
> +     #The arguments to the script are<br>
> +     # $1 -> Build Tree<br>
> +     # $2 -> DTS source file<br>
> +     # $3 -> output path of the DTB file<br>
> +     ${SCRIPT_DIR}/make_dtb.sh ${SCRIPT_DIR}/../../ \<br>
> +     ${SCRIPT_DIR}/../../gnu/dts/arm/am335x-boneblack.dts \<br>
> +     $(pwd)<br>
> +Writing the uEnv.txt file<br>
> +-------------------------<br>
> +<br>
> +The uEnv.txt file is needed to set any environment variable before the kernel is<br>
> +loaded. Each line is a u-boot command that the uboot will execute during<br>
> +starting up.<br>
"during starting" is awkward, try "during start up" or "while starting up"<br>
<br>
> +<br>
> +Add the following to a file named uEnv.txt:<br>
> +<br>
> +.. code-block:: none<br>
> +<br>
> +     setenv bootdelay 5<br>
> +     uenvcmd=run boot<br>
> +     boot=fatload mmc 0 0x80800000 rtems-app.img ; fatload mmc 0 0x88000000 am335x-boneblack.dtb ; bootm 0x80800000 - 0x88000000<br>
> +<br>
> +I2C Driver<br>
> +----------<br>
> +<br>
> +This BSP uses the I2C framework and is registered using<br>
> +``am335x_i2c_bus_register()`` the function prototype is given below:<br>
> +<br>
> +.. code-block:: C<br>
> +<br>
> +   int am335x_i2c_bus_register(<br>
> +   const char         *bus_path,<br>
> +   uintptr_t           register_base,<br>
> +   uint32_t            input_clock,<br>
> +   rtems_vector_number irq<br>
> +   );<br>
> +<br>
> +This function is needed only while registering with custom path with custom<br>
This "registering with custom path" is awkward, maybe it needs<br>
"registering with a custom path"<br>
<br>
> +values. For registering the `/dev/i2c-0` device, a wrapper function is provided,<br>
> +``bbb_register_i2c_0()`` similarly ``bbb_register_i2c_1()`` and<br>
> +``bbb_register_i2c_2()`` are respectively used to register `i2c-1` and `i2c-2`.<br>
> +<br>
> +SPI Driver<br>
> +----------<br>
> +<br>
> +The SPI device `/dev/spi-0` can be registered with ``bbb_register_spi_0()```<br>
> --<br>
Thanks for contributing documentation!<br>
<br>
> 2.20.1<br>
><br>
> _______________________________________________<br>
> devel mailing list<br>
> <a href="mailto:devel@rtems.org" target="_blank">devel@rtems.org</a><br>
> <a href="http://lists.rtems.org/mailman/listinfo/devel" rel="noreferrer" target="_blank">http://lists.rtems.org/mailman/listinfo/devel</a><br>
</blockquote></div></div>