Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major changes on DTS and board level to fix nightly QA integration tests #126

Merged
merged 7 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions boards/arm/arduino_zero/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,11 @@ USB Device Port

The SAMD21 MCU has a (native) USB device port that can be used to communicate
with a host PC. See the :ref:`zephyr:usb-samples` sample applications for more,
such as the :ref:`zephyr:usb_cdc-acm` sample which sets up a virtual serial port
that echos characters back to the host PC. As an alternative to the default
Zephyr console on serial port the special board revision ``usbcons`` can be used
to enable :ref:`zephyr:usb_device_cdc_acm` and switch the console to USB::
such as the :doc:`zephyr:samples/subsys/usb/cdc_acm/README` sample which sets
up a virtual serial port that echos characters back to the host PC. As an
alternative to the default Zephyr console on serial port the special board
revision ``usbcons`` can be used to enable :ref:`zephyr:usb_device_cdc_acm`
and switch the console to USB::

USB device idVendor=2341, idProduct=804d, bcdDevice= 3.03
USB device strings: Mfr=1, Product=2, SerialNumber=3
Expand Down
9 changes: 5 additions & 4 deletions boards/arm/seeed_xiao_samd21/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,11 @@ USB Device Port

The SAMD21 MCU has a (native) USB device port that can be used to communicate
with a host PC. See the :ref:`zephyr:usb-samples` sample applications for more,
such as the :ref:`zephyr:usb_cdc-acm` sample which sets up a virtual serial port
that echos characters back to the host PC. As an alternative to the default
Zephyr console on serial port the special board revision ``usbcons`` can be used
to enable :ref:`zephyr:usb_device_cdc_acm` and switch the console to USB::
such as the :doc:`zephyr:samples/subsys/usb/cdc_acm/README` sample which sets
up a virtual serial port that echos characters back to the host PC. As an
alternative to the default Zephyr console on serial port the special board
revision ``usbcons`` can be used to enable :ref:`zephyr:usb_device_cdc_acm`
and switch the console to USB::

USB device idVendor=2886, idProduct=802f, bcdDevice= 3.03
USB device strings: Mfr=1, Product=2, SerialNumber=3
Expand Down
9 changes: 5 additions & 4 deletions boards/arm/seeeduino_lotus/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -341,10 +341,11 @@ USB Device Port

The SAMD21 MCU has a (native) USB device port that can be used to communicate
with a host PC. See the :ref:`zephyr:usb-samples` sample applications for more,
such as the :ref:`zephyr:usb_cdc-acm` sample which sets up a virtual serial port
that echos characters back to the host PC. As an alternative to the default
Zephyr console on serial port the special board revision ``usbcons`` can be used
to enable :ref:`zephyr:usb_device_cdc_acm` and switch the console to USB::
such as the :doc:`zephyr:samples/subsys/usb/cdc_acm/README` sample which sets
up a virtual serial port that echos characters back to the host PC. As an
alternative to the default Zephyr console on serial port the special board
revision ``usbcons`` can be used to enable :ref:`zephyr:usb_device_cdc_acm`
and switch the console to USB::

USB device idVendor=2886, idProduct=8026, bcdDevice= 3.03
USB device strings: Mfr=1, Product=2, SerialNumber=3
Expand Down
13 changes: 7 additions & 6 deletions boards/arm/tiac_magpie/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -271,14 +271,15 @@ controllers, wherein the firstly enumerated is considered to be primarily.
The bus timing is defined by the DTS and is preset to 1000 kBit/s. The
calculation was verified with the help of the `CAN Bit Time Calculation Sheet`_
and can also assume smaller bit rates according to the following table. Note
that the value of **Prescaler** will be calculated on demand by the driver.
that the value of **Prescaler**, **Seg 1** and **Seg 2** will be calculated on
demand by the Zephyr :ref:`zephyr:can_api` API together with the driver.

.. list-table:: CAN bus timing calculation
:class: longtable
:align: center
:widths: 10, 10, 10, 35, 35
:header-rows: 1
:stub-columns: 3
:stub-columns: 2

* - Bit Rate
- Sample Point at
Expand Down Expand Up @@ -868,7 +869,7 @@ The DTS binding following the :dtcompatible:`st,stm32-otgfs` and
CAN Busses with DTS Bindings
============================

The DTS binding following the :dtcompatible:`st,stm32-can` specification.
The DTS binding following the :dtcompatible:`st,stm32-bxcan` specification.

.. list-table:: CAN Busses Pin Binding
:class: longtable
Expand All @@ -892,7 +893,7 @@ The DTS binding following the :dtcompatible:`st,stm32-can` specification.
:stub-columns: 1
.. :include: {3: '(CAN1)'} <-- doesn't work

- :dtcompatible:`st,stm32-can` configuration:
- :dtcompatible:`st,stm32-bxcan` configuration:

.. literalinclude:: ../tiac_magpie.dts
:caption: tiac_magpie.dts
Expand Down Expand Up @@ -924,7 +925,7 @@ The DTS binding following the :dtcompatible:`st,stm32-can` specification.
:stub-columns: 1
.. :include: {3: '(CAN2)'} <-- doesn't work

- :dtcompatible:`st,stm32-can` configuration:
- :dtcompatible:`st,stm32-bxcan` configuration:

.. literalinclude:: ../tiac_magpie.dts
:caption: tiac_magpie.dts
Expand Down Expand Up @@ -1496,4 +1497,4 @@ References
https://www.st.com/en/development-tools/stm32cubemx.html

.. _`CAN Bit Time Calculation Sheet`:
http://www.bittiming.can-wiki.info/?ctype=bxCAN&calc=1&CLK=54&SamplePoint=87.5&SJW=1
http://www.bittiming.can-wiki.info/?ctype=bxCAN&calc=1&CLK=54&SamplePoint=88.9&SJW=1
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/samples/usb/mass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USB Mass Storage
Overview
********

See :ref:`zephyr:usb_mass` for the original description.
See :doc:`zephyr:samples/subsys/usb/mass/README` for the original description.

.. _tiac_magpie_usb_mass-sample-requirements:

Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/arch/arm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/adc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/can.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/counter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
4 changes: 2 additions & 2 deletions boards/arm/tiac_magpie/doc/tests/drivers/entropy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Drivers

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down Expand Up @@ -85,7 +85,7 @@ Cryptography

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/gpio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/hwinfo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/i2c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/pwm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/spi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/uart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/drivers/watchdog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/os/bridle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
2 changes: 1 addition & 1 deletion boards/arm/tiac_magpie/doc/tests/os/kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Building and Running

.. code-block:: console

$ ./zephyr/scripts/twister \
$ west twister \
--verbose --jobs 4 --inline-logs \
--enable-size-report --platform-reports \
--device-testing --hardware-map map.yaml \
Expand Down
10 changes: 2 additions & 8 deletions boards/arm/tiac_magpie/tiac_magpie.dts
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,7 @@
pinctrl-0 = <&can1_rx_ph14 /* CAN_RX1 */
&can1_tx_ph13>; /* CAN_TX1 */
bus-speed = <1000000>;
sjw = <1>;
prop-seg = <0>;
phase-seg1 = <15>;
phase-seg2 = <2>;
sample-point = <889>;
}; // can1

&can2 {
Expand All @@ -145,10 +142,7 @@
pinctrl-0 = <&can2_rx_pb12 /* CAN_RX2 */
&can2_tx_pb13>; /* CAN_TX2 */
bus-speed = <1000000>;
sjw = <1>;
prop-seg = <0>;
phase-seg1 = <15>;
phase-seg2 = <2>;
sample-point = <889>;
}; // can2

&i2c2 {
Expand Down
42 changes: 11 additions & 31 deletions boards/arm/waveshare_rp2040/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -448,11 +448,11 @@ USB Device Port

The `RP2040 <RP2040 SoC>`_ MCU has a (native) USB device port that can be
used to communicate with a host PC. See the :ref:`zephyr:usb-samples` sample
applications for more, such as the :ref:`zephyr:usb_cdc-acm` sample which sets
up a virtual serial port that echos characters back to the host PC. As an
alternative to the default Zephyr console on serial port the special board
revision ``usbcons`` can be used to enable :ref:`zephyr:usb_device_cdc_acm`
and switch the console to USB::
applications for more, such as the :doc:`zephyr:samples/subsys/usb/cdc_acm/README`
sample which sets up a virtual serial port that echos characters back to the
host PC. As an alternative to the default Zephyr console on serial port the
special board revision ``usbcons`` can be used to enable
:ref:`zephyr:usb_device_cdc_acm` and switch the console to USB::

USB device idVendor=2e8a, idProduct=000a, bcdDevice= 3.04
USB device strings: Mfr=1, Product=2, SerialNumber=3
Expand Down Expand Up @@ -705,26 +705,6 @@ You can then start debugging the board.
More Samples
************

LCD Orientation and Bit Order Test
==================================

This sample and test application is only applicable on the |RP2040-LCD-0.96|
board. See also Zephyr sample: :ref:`zephyr:display-sample`.

.. zephyr-app-commands::
:app: zephyr/samples/drivers/display
:board: waveshare_rp2040_lcd_0_96
:build-dir: waveshare_rp2040
:west-args: -p
:goals: flash
:compact:

.. rubric:: Using UF2 for flashing by pico-bootrom

.. code-block:: bash

cp build/waveshare_rp2040/zephyr/zephyr.uf2 /media/__USER__/RPI-RP2/

LED Blinky and Fade
===================

Expand All @@ -734,7 +714,7 @@ LED Blinky and Fade

.. rubric:: WS2812 LED Test Pattern by PIO

See also Zephyr sample: :ref:`zephyr:led_ws2812_sample`
See also Zephyr sample: :doc:`zephyr:samples/drivers/led_ws2812/README`

.. image:: /boards/arm/waveshare_rp2040/doc/rp2040-one/ws2812b.gif
:align: right
Expand Down Expand Up @@ -764,7 +744,7 @@ LED Blinky and Fade

.. rubric:: WS2812 LED Test Pattern by PIO

See also Zephyr sample: :ref:`zephyr:led_ws2812_sample`
See also Zephyr sample: :doc:`zephyr:samples/drivers/led_ws2812/README`

.. image:: /boards/arm/waveshare_rp2040/doc/rp2040-zero/ws2812b.gif
:align: right
Expand Down Expand Up @@ -794,7 +774,7 @@ LED Blinky and Fade

.. rubric:: WS2812 LED Test Pattern by PIO

See also Zephyr sample: :ref:`zephyr:led_ws2812_sample`
See also Zephyr sample: :doc:`zephyr:samples/drivers/led_ws2812/README`

.. image:: /boards/arm/waveshare_rp2040/doc/rp2040-matrix/ws2812b-5x5.gif
:align: right
Expand Down Expand Up @@ -824,7 +804,7 @@ LED Blinky and Fade

.. rubric:: WS2812 LED Test Pattern by PIO

See also Zephyr sample: :ref:`zephyr:led_ws2812_sample`
See also Zephyr sample: :doc:`zephyr:samples/drivers/led_ws2812/README`

.. image:: /boards/arm/waveshare_rp2040/doc/rp2040-tiny/ws2812b.gif
:align: right
Expand Down Expand Up @@ -854,7 +834,7 @@ LED Blinky and Fade

.. rubric:: WS2812 LED Test Pattern by PIO

See also Zephyr sample: :ref:`zephyr:led_ws2812_sample`
See also Zephyr sample: :doc:`zephyr:samples/drivers/led_ws2812/README`

.. image:: /boards/arm/waveshare_rp2040/doc/rp2040-eth/ws2812b.gif
:align: right
Expand Down Expand Up @@ -1117,7 +1097,7 @@ LCD Orientation and Bit Order Test
==================================

This sample and test application is only applicable on the |RP2040-LCD-0.96|
board. See also Zephyr sample: :ref:`zephyr:display-sample`.
board. See also Zephyr sample: :doc:`zephyr:samples/drivers/display/README`.

.. list-table::
:align: center
Expand Down
3 changes: 3 additions & 0 deletions doc/bridle/releases/release-notes-3.5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ Take over the new build principles from Zephyr:
That are the boards: arduino_zero, seeed_xiao_samd21, seeeduino_lotus
* Restruct and refactor the integration test cases for the ``helloshell``
sample.
* Rename CAN driver: ``stm32-can`` to ``stm32-bxcan``.

Documentation
=============
Expand All @@ -154,6 +155,8 @@ Issue Related Items

These GitHub issues were addressed since project bootstrapping:

* :github:`125` - [BUG] Nightly QA integration test fails (convert to ``stm32-bxcan``)
* :github:`122` - [HW] Waveshare RP2040
* :github:`120` - [BUG] Nightly QA integration test fails
* :github:`118` - [BUG] QA Integration Test fails
* :github:`116` - [BUG] Grove Shields DTS Binding test suites fail for seeeduino_lotus@usbcons
Expand Down
Loading