Skip to content

Commit

Permalink
release: add draft notes for upcoming 3.6.0
Browse files Browse the repository at this point in the history
Signed-off-by: Stephan Linz <[email protected]>
  • Loading branch information
rexut committed Nov 22, 2023
1 parent 4cddafe commit 336298a
Show file tree
Hide file tree
Showing 2 changed files with 244 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/bridle/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ information about specific |BRIDLE| releases.
:caption: Releases
:maxdepth: 1

releases/release-notes-3.6.0
releases/release-notes-3.5.1
releases/release-notes-3.5.0
releases/release-notes-3.4.1
Expand Down
243 changes: 243 additions & 0 deletions doc/bridle/releases/release-notes-3.6.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@
.. _bridle_release_notes_360:

|BRIDLE| 3.6.0 Release Notes (Working draft)
############################################

This project demonstrate the integration of |TIAC| support in open
source projects, like the Zephyr RTOS, with libraries and source code
for applications. It is not yet intended or supported by |TIAC| for
product development.

Highlights
**********

* :brd:`NOT YET, tbd.`

* Add the u-blox library (**ubxlib**) and provide a simple GNSS example.
* Add *Raspberry Pi Pico* **TEST** *and* **LCD** *Shields*.
* Use board extensions.

.. note:: See the changelog and readme files in the component repositories
for a detailed description of changes.

Repositories
************

For more details, see: :ref:`repos_and_revs`.

.. list-table::
:header-rows: 1

* - Component
- Imports
- Branch
- Tag
* - `tiac-bridle`_
-
- main
-
* - | `tiac-ubxlib`_
| (`u-blox-ubxlib`_)
- | geographiclib
- | tiacsys/main
| (main)
-
* - | `tiac-zephyr`_
| (`zephyr-core`_)
- | canopennode
| chre
| cmsis
| edtt
| fatfs
| hal_altera
| hal_atmel
| hal_espressif
| hal_gigadevice
| hal_infineon
| hal_microchip
| hal_nordic
| hal_nuvoton
| hal_nxp
| hal_openisa
| hal_quicklogic
| hal_renesas
| hal_rpi_pico
| hal_silabs
| hal_st
| hal_stm32
| hal_telink
| hal_ti
| hal_xtensa
| libmetal
| liblc3
| littlefs
| loramac-node
| lvgl
| mbedtls
| mcuboot
| mipi-sys-t
| net-tools
| open-amp
| openthread
| picolibc
| psa-arch-tests
| segger
| tf-m-tests
| tinycrypt
| trusted-firmware-a
| trusted-firmware-m
- | tiacsys/main
| (main)
-

Supported boards
****************

:brd:`NOT YET, tbd.`

* Arduino/Genuino Zero
* NXP MIMXRT1010-EVK
* NXP MIMXRT1060-EVK
* ST Nucleo F3xxxx
* ST Nucleo F4xxxx / L4xxxx
* ST Nucleo F7xxxx
* Raspberry Pi Pico and Pico W
* Seeed Studio XIAO SAMD21 (Seeeduino XIAO)
* Seeeduino Cortex-M0+
* Seeeduino Lotus Cortex-M0+
* TiaC Magpie STM32F777NIHx
* Waveshare RP2040 (series of mini and pico sized boards)

Supported shields
*****************

:brd:`NOT YET, tbd.`

* Seeed Studio Grove Interconnect Shields
* Grove Button Shields
* Grove LED Shields
* Raspberry Pi Pico LCD Shields
* Raspberry Pi Pico TEST Shields

Supported snippets
******************

:brd:`NOT YET, tbd.`

* USB Console Snippet (usb-console)
* CAN timing adjustments (can-timing-adj)

Change log
**********

:brd:`NOT YET, tbd.`

* Use *Board extensions* to extended Zephyr upstream board configurations.
In some situations, certain hardware description or choices can not be added
in the upstream Zephyr repository, but they can be in a downstream project,
where custom bindings or driver classes can also be created. This feature may
also be useful in development phases, when the board skeleton lives upstream,
but other features are developed in a downstream module. Thus the extensions
spinned around in different shields or snippets were centraliced as board
extensions, e.g. the special *Raspberry Pi Pico R3 edge connector binding*.
* Remove special board extensions for Nucleo F303RE/F401RE, NXP MIMXRT1010-EVK,
and RPi Pico from the *Grove Interconnect Shield*.
* Add more boards to the *USB Console Snippet (usb-console)*:

* NXP MIMXRT1010-EVK
* NXP MIMXRT1060-EVK
* Raspberry Pi Pico (W)
* Waveshare RP2040-Geek

* Add more shields:

* *Raspberry Pi Pico TEST Shields*:

* **Pico ALL GPIO TEST** shield by Spotpear

* *Raspberry Pi Pico LCD Shields*:

* **Pico LCD 1.14** shield by Waveshare
* **Pico LCD 2** shield by Waveshare

* New Zephyr module: support u-blox portable C API **ubxlib** with GNSS sample.

The following sections provide detailed lists of changes by component.

* PROJECT UPDATE to `Zephyr Project`_ v3.6

Build Infrastructure
====================

Take over the new build principles from Zephyr:

:brd:`NOT YET, tbd.`

* tbd.
* tbd.
* tbd.

Documentation
=============

:brd:`NOT YET, tbd.`

1. Update all output messages in documentation to be in sync with the upcoming
Bridle version v3.6.0, based on Zephyr v3.6 (samples and tests).

Issue Related Items
*******************

These GitHub issues were addressed since project bootstrapping:

* :github:`163` - [FER] USB console support for NXP MIMXRT1010-EVK and MIMXRT1060-EVK
* :github:`162` - [HW] Raspberry Pi Pico TEST Shields
* :github:`161` - [HW] Raspberry Pi Pico LCD Shields
* :github:`160` - [HW] Waveshare RP2040-Geek
* :github:`156` - [FCR] Add the u-blox library (ubxlib) as Zephyr module
* :github:`155` - [FCR] Use board extensions to fix upstream declarations
* :github:`152` - [FER] Support filtering by board vendor
* :github:`151` - [FER] Harmonize Grove PWM mapping over all SAMD21 based Arduino boards
* :github:`148` - [HW] Seeeduino Cortex-M0+ board support
* :github:`137` - [FCR] Bump to Zephyr v3.5
* :github:`139` - [FER] Bump to Doxygen v1.9.8
* :github:`136` - [FCR] Bump to Zephyr SDK 0.16.3
* :github:`128` - [FER] Provide USB console by snippets instead of specific board revision
* :github:`127` - [FER] Provide CAN timing tweak for TiaC Magpie by snippets instead of a shield
* :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
* :github:`115` - [BUG] Bridle Common (core) Testing fails since v3.4
* :github:`113` - [FER] Use sub-manifests for 3rd party projects
* :github:`112` - [FCR] Support Renesas HAL
* :github:`106` - [FER] Snippets
* :github:`105` - [FCR] Bump to Zephyr v3.4
* :github:`104` - [BUG] Bridle CMake Package not usable in Freestanding mode
* :github:`96` - [HW] Grove Interconnect Shields for Seeeduino XIAO
* :github:`90` - [HW] Grove Interconnect Shields for Arduino/Genuino Zero
* :github:`87` - [HW] Seeeduino Lotus Cortex-M0+ board support
* :github:`85` - [BUG] Zephyr counter driver test fails
* :github:`83` - [FCR] Support Grove System Shields
* :github:`80` - [FCR] Support ST HAL
* :github:`79` - [FCR] Support NXP HAL
* :github:`78` - [FCR] Support Raspberry Pi Pico HAL
* :github:`77` - [FCR] Support Atmel HAL
* :github:`76` - [FCR] Bump to Zephyr (bleeding edge) main line
* :github:`73` - [BUG] reduced setup time of clang-format in workflow
* :github:`72` - [FCR] Bump to Zephyr v3.3
* :github:`68` - [BUG] Upgrade to Sphinx 5.x
* :github:`60` - [FCR] Bump to Zephyr v3.2
* :github:`64` - [FCR] Backporting new feature enhancements to v3.0
* :github:`59` - [FCR] Bump to Zephyr v3.1
* :github:`54` - [FCR] Bump to Zephyr v3.0
* :github:`53` - [FCR] Bump to Zephyr v2.7
* :github:`49` - Can't rebuild documentation
* :github:`39` - [FCR] Bump to Zephyr v2.6
* :github:`30` - [FER] Bridle version definition
* :github:`21` - Change all copyright strings
* :github:`7` - Missing CI build and test for all supported boards
* :github:`5` - Improve documentation environment
* :github:`4` - Zephyr does not know F777
* :github:`3` - Missing TiaC Magpie STM32F777NIHx

0 comments on commit 336298a

Please sign in to comment.