Changeset 8b203e2 in rtems-docs


Ignore:
Timestamp:
Jul 22, 2019, 4:12:32 AM (4 months ago)
Author:
Vijay Kumar Banerjee <vijaykumar9597@…>
Branches:
master
Children:
8037cbb
Parents:
735bcd7
git-author:
Vijay Kumar Banerjee <vijaykumar9597@…> (07/22/19 04:12:32)
git-committer:
Christian Mauderer <oss@…> (07/27/19 11:26:16)
Message:

user/bsps : Fix formatting and typo in arm/beagle

File:
1 edited

Legend:

Unmodified
Added
Removed
  • user/bsps/arm/beagle.rst

    r735bcd7 r8b203e2  
    66======
    77
    8 This BSP supports four variants, `beagleboardorig`, `beagleboardxm`, `beaglebonewhite`
    9 and `beagleboneblack`. The basic hardware initialization is not performed by
    10 the BSP.  A boot loader with device tree support must be used to start the BSP,
    11 e.g. U-Boot.
     8This BSP supports four variants, `beagleboardorig`, `beagleboardxm`,
     9`beaglebonewhite` and `beagleboneblack`. The basic hardware initialization is
     10not performed by the BSP.  A boot loader with device tree support must be used
     11to start the BSP, e.g., U-Boot.
    1212
    1313TODO(These drivers are present but not documented yet):
     
    3434----------------------------
    3535
    36 The Device Tree Blob(dtb) is needed to load the device tree while starting up
     36The Device Tree Blob (DTB) is needed to load the device tree while starting up
    3737the kernel. We build the dtb from the FreeBSD source matching the commit hash
    3838from the libbsd HEAD of freebsd-org. For example if the HEAD is at
    3939"19a6ceb89dbacf74697d493e48c388767126d418"
    40 Then the right dts file is:
     40Then the right Device Tree Source (DTS) file is:
    4141https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/gnu/dts/arm/am335x-boneblack.dts
    4242
    43 .. code-block:: none
     43.. code-block:: shell
     44   :linenos:
    4445
    4546     #building the dtb
    4647     #We will use the script from https://github.com/freebsd/freebsd/blob/19a6ceb89dbacf74697d493e48c388767126d418/sys/tools/fdt/make_dtb.sh
    4748
    48      export MACHINE='arm' #The make_dtb.sh script uses environment variable MACHINE
     49     #The make_dtb.sh script uses environment variable MACHINE
     50     export MACHINE='arm'
     51
    4952     SCRIPT_DIR=$HOME/freebsd/sys/tools/fdt
     53
    5054     #The arguments to the script are
    5155     # $1 -> Build Tree
    5256     # $2 -> DTS source file
    5357     # $3 -> output path of the DTB file
     58
    5459     ${SCRIPT_DIR}/make_dtb.sh ${SCRIPT_DIR}/../../ \
    5560     ${SCRIPT_DIR}/../../gnu/dts/arm/am335x-boneblack.dts \
    5661     $(pwd)
     62
    5763Writing the uEnv.txt file
    5864-------------------------
    5965
    6066The uEnv.txt file is needed to set any environment variable before the kernel is
    61 loaded. Each line is a u-boot command that the uboot will execute during
    62 starting up.
     67loaded. Each line is a u-boot command that the uboot will execute during start
     68up.
    6369
    6470Add the following to a file named uEnv.txt:
     
    7379----------
    7480
    75 This BSP uses the I2C framework and is registered using
    76 ``am335x_i2c_bus_register()`` the function prototype is given below:
     81For registering the `/dev/i2c-0` device, a wrapper function is provided,
     82``bbb_register_i2c_0()`` similarly ``bbb_register_i2c_1()`` and
     83``bbb_register_i2c_2()`` are respectively used to register `i2c-1` and `i2c-2`.
     84
     85For registering an I2C device with a custom path (say `/dev/i2c-3`) the
     86function ``am335x_i2c_bus_register()`` has to be used.
     87
     88The function prototype is given below:
    7789
    7890.. code-block:: C
     
    8597   );
    8698
    87 This function is needed only while registering with custom path with custom
    88 values. For registering the `/dev/i2c-0` device, a wrapper function is provided,
    89 ``bbb_register_i2c_0()`` similarly ``bbb_register_i2c_1()`` and
    90 ``bbb_register_i2c_2()`` are respectively used to register `i2c-1` and `i2c-2`.
    91 
    9299SPI Driver
    93100----------
    94101
    95 The SPI device `/dev/spi-0` can be registered with ``bbb_register_spi_0()```
     102The SPI device `/dev/spi-0` can be registered with ``bbb_register_spi_0()``
     103
     104For registering with a custom path, the ``bsp_register_spi()`` can be used.
     105
     106The function prototype is given below:
     107
     108.. code-block:: C
     109
     110    rtems_status_code bsp_register_spi(
     111       const char         *bus_path,
     112       uintptr_t           register_base,
     113       rtems_vector_number irq
     114    );
Note: See TracChangeset for help on using the changeset viewer.