diff --git a/CONTRIB.rst b/CONTRIB.rst new file mode 100644 index 0000000000000000000000000000000000000000..920370bfa4c6f285376e2aafec5d2e1267f5c9ea --- /dev/null +++ b/CONTRIB.rst @@ -0,0 +1,31 @@ +.. _contributors: + +Contributors +############# + +This is a list of people who have made contributions to BeagleBoard.org unified documentation project. + +People are listed alphabetically, as verified with Unix sort: + +.. code-block:: shell + + $ grep "^- " CONTRIB.rst | LC_ALL=C sort -u -c -f + + +This is certainly not comprehensive, and if you've been overlooked (sorry!), please open an issue on GitLab or mention it on the forum. + +- `Andrei Aldea <https://git.beagleboard.org/andrei1998>`_ +- `Ayush Singh <https://git.beagleboard.org/ayush1325>`_ +- Cathy Wicks +- `Deepak Khatri <https://git.beagleboard.org/lorforlinux>`_ +- `Dhruva Gole <https://git.beagleboard.org/dhruvag2000>`_ +- `Harshil Bhatt <https://git.beagleboard.org/harshilbhatt2001>`_ +- `Jason Kridner <https://git.beagleboard.org/jkridner/>`_ +- `Jian De <https://git.beagleboard.org/jiande>`_ +- `Joshua Neal <https://git.beagleboard.org/jdneal>`_ +- `Kai Yamada <https://git.beagleboard.org/gpioblink>`_ +- `Krishna Narayanan <https://git.beagleboard.org/Krishna_13>`_ +- `Mark A. Yoder <https://git.beagleboard.org/yoder>`_ +- `Robert Nelson <https://git.beagleboard.org/RobertCNelson>`_ +- `Sabeeh Khan <https://git.beagleboard.org/sabeeh.khan14>`_ +- `Seth N <https://git.beagleboard.org/silver2row>`_ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ca379058e90dab0a0e23d07f423cfe0266cc8e5..4835570d99be6a468286ecf2d8357bcd84dd0856 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,15 +7,21 @@ the BeagleBoard.org Foundation at https://git.beagleboard.org/docs/docs.beaglebo mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. -## Code of Conduct +## Contribution -This project and everyone participating in it is governed by -the [BeagleBoard.org Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to -uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or -contact one of the administrators on https://forum.beagleboard.org. +Contributions in any form are appreciated. If you want to contribute to the docs but not sure +where to start then you can checkout our contribution documents to help you with your first pull request. -## FAQ +### Code of Conduct -* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19) +This project and everyone participating in it is governed by the [BeagleBoard.org Code of Conduct](https://docs.beagleboard.org/latest/intro/contribution/index.html#code-of-conduct). By participating, you are expected to uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or contact one of the administrators on https://forum.beagleboard.org. + +### Style and usage guidelines + +If you are new to Sphinx, RST, or git then you can checkout out our [Style and usage guidelines](https://docs.beagleboard.org/latest/intro/contribution/index.html#style-and-usage-guidelines). See more at https://docs.beagleboard.org/en/latest/intro/contribution/. + +## FAQ + +* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19) diff --git a/boards/beaglebone/ai-64/index.rst b/boards/beaglebone/ai-64/index.rst index baa85ee1ff351090c2a94896fe812f28cb39e151..5ed36ecb825a2b28e40f63f42c5b12b99d3b822b 100644 --- a/boards/beaglebone/ai-64/index.rst +++ b/boards/beaglebone/ai-64/index.rst @@ -11,11 +11,6 @@ are all that need to be added to start building performance-optimized embedded a expansion possibilities are enabled through familiar BeagleBone® cape headers, with hundreds of open-source hardware examples and dozens of readily available embedded expansion options available off-the-shelf. -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark .. figure:: images/OSHW_mark_US002120.* @@ -24,6 +19,13 @@ hardware examples and dozens of readily available embedded expansion options ava :alt: BeagleBone AI-64 OSHW Mark .. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-ai-64 + +.. tip:: Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beaglebone/ai/index.rst b/boards/beaglebone/ai/index.rst index 7007d139487ee702a82f5abddf35af5a76561b50..29427990b5153898c31b6b89dfa841c844de9f49 100644 --- a/boards/beaglebone/ai/index.rst +++ b/boards/beaglebone/ai/index.rst @@ -3,14 +3,6 @@ BeagleBone AI ############### -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - - All derivative works are to be attributed to `Jason Kridner of - BeagleBoard.org <https://beagleboard.org/about/jkridner>`__. - .. admonition:: OSHWA Certification mark .. figure:: images/OSHW_mark_US000169.* @@ -19,6 +11,14 @@ BeagleBone AI :alt: BeagleBone AI OSHW Mark .. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-ai + +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beaglebone/black/index.rst b/boards/beaglebone/black/index.rst index 983aec2b3c431767672b227d1c26af1fc401a245..549e7e33605343928aaae408ee54e7dcb13569de 100644 --- a/boards/beaglebone/black/index.rst +++ b/boards/beaglebone/black/index.rst @@ -6,11 +6,6 @@ BeagleBone Black BeagleBone Black is a low-cost, community-supported development platform for developers and hobbyists. Boot Linux in under 10 seconds and get started on development in less than 5 minutes with just a single USB cable. -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark (BeagleBone Black) .. figure:: images/OSHW_mark_US000236.* @@ -25,8 +20,17 @@ Boot Linux in under 10 seconds and get started on development in less than 5 min :target: https://certification.oshwa.org/us000011.html :alt: BeagleBone Black Wireless OSHW Mark +.. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at, + + - BeagleBone Black: https://git.beagleboard.org/beagleboard/beaglebone-black + - BeagleBone Black Wireless: https://git.beagleboard.org/beagleboard/beaglebone-black-wireless -.. note:: +.. tip:: Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beaglebone/blue/index.rst b/boards/beaglebone/blue/index.rst index b8be573d47849979296c2ca219688ea21370db16..21e004a3b263a5b73696f7a194d826c33fb2e24a 100644 --- a/boards/beaglebone/blue/index.rst +++ b/boards/beaglebone/blue/index.rst @@ -15,11 +15,6 @@ robotics by `UCSD Flow Control and Coordinated Robotics Lab <http://robotics.ucs `WowWee <http://www.wowwee.com/mip/>`_, `National Instruments LabVIEW <http://www.ni.com/labview/>`_ and of course the `BeagleBoard.org Foundation <https://beagleboard.org/about>`_. -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark .. figure:: media/OSHW_mark_US000064.* @@ -27,7 +22,17 @@ and of course the `BeagleBoard.org Foundation <https://beagleboard.org/about>`_. :target: https://certification.oshwa.org/us000064.html :alt: BeagleBone Blue OSHW Mark + .. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleboard/beaglebone-blue + + +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beaglebone/index.rst b/boards/beaglebone/index.rst index 5a4e348c8e5862d15f24ecec371e144699593f07..780dc00a5bb05990b82619951e2702b250052296 100644 --- a/boards/beaglebone/index.rst +++ b/boards/beaglebone/index.rst @@ -22,12 +22,12 @@ with links to their latest PDF-formatted System Reference Manual and the latest included both here and in the downloadable beagleboard-docs.pdf linked on the bottom-left of your screen. -.. admonition:: Contributors +.. note:: This work is licensed under a `Creative Commons Attribution-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ -.. note:: +.. tip:: Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beagleconnect/freedom/index.rst b/boards/beagleconnect/freedom/index.rst index c55b3f3f20cf7db3a200f946a952303158dc895c..68bcadf251aa70ec37739398a436e57c6d8b71a3 100644 --- a/boards/beagleconnect/freedom/index.rst +++ b/boards/beagleconnect/freedom/index.rst @@ -17,22 +17,26 @@ over-the-air upgrades (OTA) capability. This MCU provides flexible support for m :alt: BeagleConnect™ Freedom board .. important:: + This is a work in progress, for latest documentation please visit https://docs.beagleboard.org/latest/ -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark .. figure:: media/OSHW_mark_US002175.* :width: 200 :target: https://certification.oshwa.org/us002175.html :alt: BeagleConnect™ Freedom OSHW Mark - + .. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleconnect/freedom + +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beagleconnect/index.rst b/boards/beagleconnect/index.rst index 0ebaa334019fce75af8c21ab4fdd0583bc8d63d8..137bd541805cf17f9cf9b801f237a61739d84032 100644 --- a/boards/beagleconnect/index.rst +++ b/boards/beagleconnect/index.rst @@ -7,12 +7,13 @@ BeagleConnect Currently under development -.. admonition:: Contributors +.. note:: This work is licensed under a `Creative Commons Attribution-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ -.. note:: +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beagleplay/05-demos.rst b/boards/beagleplay/05-demos.rst index 4501442468961174c9e87c9ff7123f05ef158989..948ce50a8536a05e070a58f768fe8b02696cc5af 100644 --- a/boards/beagleplay/05-demos.rst +++ b/boards/beagleplay/05-demos.rst @@ -115,6 +115,16 @@ Demos and tutorials intermediate +.. card:: + :link: greybus-host + :link-type: ref + + **Bealgplay Greybus Host** + +++ + .. admonition:: Complexity level + + intermediate + .. raw:: latex \end{comment} @@ -132,3 +142,4 @@ Demos and tutorials demos-and-tutorials/using-csi demos-and-tutorials/zephyr-cc1352-development demos-and-tutorials/play-kernel-development + demos-and-tutorials/greybus-host diff --git a/boards/beagleplay/demos-and-tutorials/greybus-host.rst b/boards/beagleplay/demos-and-tutorials/greybus-host.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ddba16d220bca8ee77b9bbece022b0444220589 --- /dev/null +++ b/boards/beagleplay/demos-and-tutorials/greybus-host.rst @@ -0,0 +1,331 @@ +.. _greybus-host: + +BeagleConnect™ Greybus demo using BeagleConnect™ Freedom and BeaglePlay +####################################################################### + +BeaglePlay CC1352 Firmware +************************** + +Build (Download and Setup Zephyr for BeaglePlay) +================================================ + +#. Install prerequisites + + .. code-block:: bash + + cd + sudo apt update + sudo apt install --no-install-recommends -y \ + gperf \ + ccache dfu-util \ + libsdl2-dev \ + libxml2-dev libxslt1-dev libssl-dev libjpeg62-turbo-dev libmagic1 \ + libtool-bin autoconf automake libusb-1.0-0-dev \ + python3-tk python3-virtualenv + +#. Download the latest Zephyr Release, extract it and cleanup + + .. code-block:: bash + + sudo wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.3/zephyr-sdk-0.16.3_linux-aarch64_minimal.tar.xz + tar xf zephyr-sdk-0.16.3_linux-aarch64_minimal.tar.xz + rm zephyr-sdk-0.16.3_linux-aarch64_minimal.tar.xz + + +#. Run the Zephyr SDK Setup Script + + .. code-block:: bash + + ./zephyr-sdk-0.16.3/setup.sh -t arm-zephyr-eabi -c + +#. Download and Initialize `West <https://docs.zephyrproject.org/latest/develop/west/index.html/>`_. (Zephyr's meta-tool) + + .. note:: + + You may want to add `/home/debian/.local/bin` to your `.bashrc` file to make the West command available after a reboot + + .. code-block:: bash + + pip3 install --user -U west + export PATH="/home/debian/.local/bin:$PATH" + west init -m https://git.beagleboard.org/beagleconnect/zephyr/zephyr --mr sdk-next zephyr-beagle-cc1352-sdk + cd $HOME/zephyr-beagle-cc1352-sdk + + +#. Setup a Python Virtual Environment and add our PATH Variables + + .. code-block:: bash + + virtualenv zephyr-beagle-cc1352-env + echo "export ZEPHYR_TOOLCHAIN_VARIANT=zephyr" >> $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + echo "export ZEPHYR_SDK_INSTALL_DIR=$HOME/zephyr-sdk-0.16.3" >> $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + echo "export ZEPHYR_BASE=$HOME/zephyr-beagle-cc1352-sdk/zephyr" >> $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + echo 'export PATH=$HOME/zephyr-beagle-cc1352-sdk/zephyr/scripts:$PATH' >> $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + echo "export BOARD=beagleplay_cc1352" >> $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + source $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + + +#. Update West + + .. code-block:: bash + + west update + west zephyr-export + +#. Install Python Prerequisites + + .. code-block:: bash + + pip3 install -r zephyr/scripts/requirements-base.txt + +#. Activate the Zephyr build environment + + NOTE - If you exit and come back, you'll need to reactivate your Zephyr build environment. + + .. code-block:: bash + + source $HOME/zephyr-beagle-cc1352-sdk/zephyr-beagle-cc1352-env/bin/activate + +#. Verify Zephyr setup for BeaglePlay + + .. code-block:: shell-session + + (zephyr-beagle-cc1352-env) debian@BeaglePlay:~$ cmake --version + cmake version 3.22.1 + + CMake suite maintained and supported by Kitware (kitware.com/cmake). + + (zephyr-beagle-cc1352-env) debian@BeaglePlay:~$ python3 --version + Python 3.9.2 + + (zephyr-beagle-cc1352-env) debian@BeaglePlay:~$ dtc --version + Version: DTC 1.6.0 + + (zephyr-beagle-cc1352-env) debian@BeaglePlay:~$ west --version + West version: v0.14.0 + + (zephyr-beagle-cc1352-env) debian@BeaglePlay:~$ ./zephyr-sdk-0.16.3/arm-zephyr-eabi/bin/arm-zephyr-eabi-gcc --version + arm-zephyr-eabi-gcc (Zephyr SDK 0.16.3) 12.1.0 + + Copyright (C) 2022 Free Software Foundation, Inc. + This is free software; see the source for copying conditions. There is NO + warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + +#. Clone CC1352 Firmware at top level: https://git.beagleboard.org/gsoc/greybus/cc1352-firmware + + .. code-block:: bash + + cd ~ + git clone https://git.beagleboard.org/gsoc/greybus/cc1352-firmware + +#. Build the Firmware + + .. code-block:: bash + + west build -b beagleplay_cc1352 -p always cc1352-firmware + +#. You can now find the built firmware at `build/zephyr/zephyr.bin` + +Flash +===== +#. Ensure the `gb-beagleplay` driver isn't blocking the serial port. + + .. code-block:: shell-session + + debian@BeaglePlay:~$ echo " fdtoverlays /overlays/k3-am625-beagleplay-bcfserial-no-firmware.dtbo" | sudo tee -a /boot/firmware/extlinux/extlinux.conf + debian@BeaglePlay:~$ sudo shutdown -r now + + .. note:: + + The default password is `temppwd`. + +#. Clone cc1352-flasher + + .. code-block:: bash + + cd + git clone https://git.beagleboard.org/beagleconnect/cc1352-flasher.git + +#. Flash Firmware + + .. code-block:: bash + + python $HOME/cc1352-flasher --beagleplay $HOME/zephyr-beagle-cc1352-sdk/build/zephyr/zephyr.bin + +#. Ensure the `gb-beagleplay` driver is set to load. + + .. code-block:: bash + + sudo sed -e '/bcfserial-no-firmware/ s/^#*/#/' -i /boot/firmware/extlinux/extlinux.conf + sudo shutdown -r now + +Building gb-beagleplay Kernel Module +************************************** + +.. note:: + + `gb-beagleplay` is still not merged upstream and thus needs to be built seperately. This should not be required in the future. + +#. Disable bcfserial driver. Add ``quiet module_blacklist=bcfserial`` to kernel parameters at ``/boot/firmware/extlinux/extlinux.conf`` (line 2) as shown below. + + .. callout:: + + .. code-block:: shell-session + + label Linux eMMC + kernel /Image + append root=/dev/mmcblk0p2 ro rootfstype=ext4 rootwait net.ifnames=0 quiet module_blacklist=bcfserial <1> + fdtdir / + #fdtoverlays /overlays/<file>.dtbo + #fdtoverlays /overlays/k3-am625-beagleplay-bcfserial-no-firmware.dtbo + fdtoverlays /overlays/k3-am625-beagleplay-release-mikrobus.dtbo + initrd /initrd.img + + .. annotations:: + + <1> ``quiet module_blacklist=bcfserial`` has been added to this line + +#. Reboot + + .. code-block:: shell-session + + debian@BeaglePlay:~$ sudo shutdown -r now + +#. Download the upstream module + + .. code-block:: shell-session + + debian@BeaglePlay:~$ git clone https://git.beagleboard.org/gsoc/greybus/beagleplay-greybus-driver.git + debian@BeaglePlay:~$ cd beagleplay-greybus-driver + +#. Install dependencies + + .. code-block:: shell-session + + debian@BeaglePlay:~$ sudo apt install linux-headers-$(uname -r) + +#. Build Kernel moudle + + .. code-block:: shell-session + + debian@BeaglePlay:~/beagleplay-greybus-driver$ make + make -C /lib/modules/5.10.168-ti-arm64-r111/build M=/home/debian/beagleplay-greybus-driver modules + make[1]: Entering directory '/usr/src/linux-headers-5.10.168-ti-arm64-r111' + CC [M] /home/debian/beagleplay-greybus-driver/gb-beagleplay.o + MODPOST /home/debian/beagleplay-greybus-driver/Module.symvers + CC [M] /home/debian/beagleplay-greybus-driver/gb-beagleplay.mod.o + LD [M] /home/debian/beagleplay-greybus-driver/gb-beagleplay.ko + make[1]: Leaving directory '/usr/src/linux-headers-5.10.168-ti-arm64-r111' + +Flashing BeagleConnect Freedom Greybus Firmware +*********************************************** +#. Connect BeagleConnect Freedom to BeaglePlay +#. Build the BeagleConnect Freedom firmware + + .. code-block:: bash + + west build -b beagleconnect_freedom modules/greybus/samples/subsys/greybus/net/ -p -- -DOVERLAY_CONFIG=overlay-802154-subg.conf + +#. Flash the BeagleConnect Freedom + + .. code-block:: bash + + west flash + +Run the Demo +************* + +#. Connect BeagleConnect Freedom. +#. See shell output using `tio` + + .. code-block:: bash + + tio /dev/ACM0 + +#. Press the Reset button on BeagleConnect Freedom + +#. Verify that greybus is working by checking the `tio` output. It should look as follows: + + .. code-block:: shell-session + + [00:00:00.000,976] <dbg> greybus_platform_bus: greybus_init: probed greybus: 0 major: 0 minor: 1 + [00:00:00.001,068] <dbg> greybus_platform_string: greybus_string_init: probed greybus string 4: hdc2010 + [00:00:00.001,129] <dbg> greybus_platform_string: greybus_string_init: probed greybus string 3: opt3001 + [00:00:00.001,190] <dbg> greybus_platform_string: greybus_string_init: probed greybus string 2: Greybus Service Sample Application + [00:00:00.001,251] <dbg> greybus_platform_string: greybus_string_init: probed greybus string 1: Zephyr Project RTOS + [00:00:00.001,251] <dbg> greybus_platform_interface: greybus_interface_init: probed greybus interface 0 + [00:00:00.001,281] <dbg> greybus_platform_bundle: greybus_bundle_init: probed greybus bundle 1: class: 10 + [00:00:00.001,312] <dbg> greybus_platform_bundle: greybus_bundle_init: probed greybus bundle 0: class: 0 + [00:00:00.001,342] <dbg> greybus_platform_control: greybus_control_init: probed cport 0: bundle: 0 protocol: 0 + [00:00:00.001,434] <dbg> greybus_platform: gb_add_cport_device_mapping: added mapping between cport 1 and device gpio@40022000 + [00:00:00.001,464] <dbg> greybus_platform_gpio_control: greybus_gpio_control_init: probed cport 1: bundle: 1 protocol: 2 + [00:00:00.001,556] <dbg> greybus_platform: gb_add_cport_device_mapping: added mapping between cport 2 and device sensor-switch + [00:00:00.001,556] <dbg> greybus_platform_i2c_control: greybus_i2c_control_init: probed cport 2: bundle: 1 protocol: 3 + *** Booting Zephyr OS build bcf-sdk-0.2.1-3384-ge76584f824c8 *** + [00:00:00.009,704] <dbg> greybus_service: greybus_service_init: Greybus initializing.. + [00:00:00.009,765] <dbg> greybus_manifest: identify_descriptor: cport_id = 0 + [00:00:00.009,796] <dbg> greybus_manifest: identify_descriptor: cport_id = 1 + [00:00:00.009,826] <dbg> greybus_manifest: identify_descriptor: cport_id = 2 + [00:00:00.009,857] <dbg> greybus_transport_tcpip: gb_transport_backend_init: Greybus TCP/IP Transport initializing.. + [00:00:00.010,101] <inf> greybus_transport_tcpip: CPort 0 mapped to TCP/IP port 4242 + [00:00:00.014,709] <inf> greybus_transport_tcpip: CPort 1 mapped to TCP/IP port 4243 + [00:00:00.014,953] <inf> greybus_transport_tcpip: CPort 2 mapped to TCP/IP port 4244 + [00:00:00.015,075] <inf> greybus_transport_tcpip: Greybus TCP/IP Transport initialized + [00:00:00.015,136] <inf> greybus_manifest: Registering CONTROL greybus driver. + [00:00:00.015,167] <dbg> greybus: _gb_register_driver: Registering Greybus driver on CP0 + [00:00:00.015,411] <inf> greybus_manifest: Registering GPIO greybus driver. + [00:00:00.015,411] <dbg> greybus: _gb_register_driver: Registering Greybus driver on CP1 + [00:00:00.015,625] <inf> greybus_manifest: Registering I2C greybus driver. + [00:00:00.015,625] <dbg> greybus: _gb_register_driver: Registering Greybus driver on CP2 + [00:00:00.015,777] <inf> greybus_service: Greybus is active + +#. Load gb-beagleplay + + .. code-block:: shell-session + + debian@BeaglePlay:~$ sudo insmod $HOME/beagleplay-greybus-driver/gb-beagleplay.ko + +#. Check `iio_device` to verify that greybus node has been detected: + + .. code-block:: shell-session + + debian@BeaglePlay:~$ iio_info + Library version: 0.24 (git tag: v0.24) + Compiled with backends: local xml ip usb + IIO context created with local backend. + Backend version: 0.24 (git tag: v0.24) + Backend description string: Linux BeaglePlay 5.10.168-ti-arm64-r111 #1bullseye SMP Tue Sep 26 14:22:20 UTC 2023 aarch64 + IIO context has 2 attributes: + local,kernel: 5.10.168-ti-arm64-r111 + uri: local: + IIO context has 2 devices: + iio:device0: adc102s051 + 2 channels found: + voltage1: (input) + 2 channel-specific attributes found: + attr 0: raw value: 4068 + attr 1: scale value: 0.805664062 + voltage0: (input) + 2 channel-specific attributes found: + attr 0: raw value: 0 + attr 1: scale value: 0.805664062 + No trigger on this device + iio:device1: hdc2010 + 3 channels found: + temp: (input) + 4 channel-specific attributes found: + attr 0: offset value: -15887.515151 + attr 1: peak_raw value: 28928 + attr 2: raw value: 28990 + attr 3: scale value: 2.517700195 + humidityrelative: (input) + 3 channel-specific attributes found: + attr 0: peak_raw value: 43264 + attr 1: raw value: 41892 + attr 2: scale value: 1.525878906 + current: (output) + 2 channel-specific attributes found: + attr 0: heater_raw value: 0 + attr 1: heater_raw_available value: 0 1 + No trigger on this device + diff --git a/boards/beagleplay/index.rst b/boards/beagleplay/index.rst index b18cfc49cddb1b1635ad8223252fecc0a51a0459..c59c12c5874fe4381c873efef52ce4fdbad4053a 100644 --- a/boards/beagleplay/index.rst +++ b/boards/beagleplay/index.rst @@ -7,11 +7,6 @@ BeaglePlay This is a work in progress, for latest documentation please visit https://docs.beagleboard.org/latest/ -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark .. figure:: images/OSHW_mark_US002174.* @@ -31,7 +26,15 @@ BeaglePlay | :alt: BeaglePlay | :alt: BeaglePlay | +----------------------------------------------------+---------------------------------------------------------+ -.. note:: +.. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleplay/beagleplay + +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/beaglev/ahead/index.rst b/boards/beaglev/ahead/index.rst index d1d6dbcf360df7a9ae540c4741d4291b3c87ab2d..654841b0b08b09f19766df50e2a9b20eb9afe122 100644 --- a/boards/beaglev/ahead/index.rst +++ b/boards/beaglev/ahead/index.rst @@ -11,11 +11,6 @@ BeagleV-Ahead This is a work in progress, for latest documentation please visit https://docs.beagleboard.org/latest/ -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - .. admonition:: OSHWA Certification mark .. figure:: media/OSHW_mark_US002535.* @@ -23,7 +18,15 @@ BeagleV-Ahead :target: https://certification.oshwa.org/us002535.html :alt: BeagleV-Ahead OSHW Mark -.. note:: +.. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beaglev-ahead/beaglev-ahead + +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/index.rst b/boards/index.rst index ed22495725d4903fd6dd021caaeb336214fda971..0aec9f1de91954f3274e75cd197279aa623327ed 100644 --- a/boards/index.rst +++ b/boards/index.rst @@ -25,12 +25,13 @@ options that enable almost endless sensing and actuation expansion. :ref:`BeagleBoard <beagleboard-boards-home>` is a family of ARM-based, Linux-capable boards where this project started. -.. admonition:: Contributors +.. note:: This work is licensed under a `Creative Commons Attribution-ShareAlike 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ -.. note:: +.. tip:: + Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/boards/pocketbeagle/original/index.rst b/boards/pocketbeagle/original/index.rst index 6e38371600e0510fe6945a50055ec6e533a4a9c4..2d2a40a360adf5f35d0bf708df01c516513fec23 100644 --- a/boards/pocketbeagle/original/index.rst +++ b/boards/pocketbeagle/original/index.rst @@ -3,14 +3,6 @@ PocketBeagle ################### -.. admonition:: Contributors - - This work is licensed under a `Creative Commons Attribution-ShareAlike - 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ - - - Maintaining author: `Jason Kridner <jkridner@beagleboard.org>`_ - - Contributing Editor: `Cathy Wicks <cathy@beagleboard.org>`_ - .. admonition:: OSHWA Certification mark .. figure:: images/OSHW_mark_US000083.* @@ -19,6 +11,13 @@ PocketBeagle :alt: PocketBeagle OSHW mark .. note:: + + This work is licensed under a `Creative Commons Attribution-ShareAlike + 4.0 International License <http://creativecommons.org/licenses/by-sa/4.0/>`__ + + Hardware design files can be found at https://git.beagleboard.org/beagleboard/pocketbeagle + +.. tip:: Make sure to read and accept all the terms & condition provided in the :ref:`boards-terms-and-conditions` page. Use of either the boards or the design materials constitutes agreement to the T&C including any diff --git a/books/pru-cookbook/02start/start.rst b/books/pru-cookbook/02start/start.rst index c108038517162a88744e72243a328fa726ab6594..dc5f3c450c6d9ee8f6e428a81ab304c9c6ff662d 100644 --- a/books/pru-cookbook/02start/start.rst +++ b/books/pru-cookbook/02start/start.rst @@ -252,7 +252,7 @@ Another route to take is to apply this command to boot the service called bb-cod If you want the files in your home directory to appear in the tree structure click the settings gear and select *Show Home in Favorites* -as shown in :ref:`start_c9_show_home`. +as shown in :ref:`start_vsc`. .. _start_vsc: diff --git a/index.rst b/index.rst index 2696bea737efbe0756043f5a3eabfc465943c4a8..b20cdc894a6af96cfc3153184ff94ad63e34c933 100644 --- a/index.rst +++ b/index.rst @@ -34,6 +34,7 @@ Get started engaging the BeagleBoard.org developer community by reading our :ref /intro/support/index /intro/beagle101/index /intro/contribution/index + CONTRIB Boards