Commit Graph

4610 Commits

Author SHA1 Message Date
Robert Lubos
daefce6943 doc: release_notes: 3.3: Add net_pkt stable API change
Document the stable API change in the net_pkt API along with the
expected action from the existing applications.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2022-11-19 07:39:32 -05:00
Carles Cufi
3fea29d7c5 readme: Add support for light/dark modes in the logo
Use the mechanism described here:
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to

to provide different logos for light and dark mode, so that the "Zephyr"
text is clearly visible in both.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-11-18 08:58:59 +01:00
Dominik Ermel
a0380aabff doc/release/3.3: Notes on changes in MCUmgr subsystem tree
Added notes on changes in MCUmgr subsystem tree.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-11-17 15:31:17 +01:00
Dominik Ermel
7048383362 doc: Move SMP transport documentation under doc/services
The commit moves MCUmgr SMP transport documentation from
subsys/mgmt/mcumgr/lib to doc/services/device_mgmt.
Documentation have been rewritten for that purpose.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-11-17 15:31:17 +01:00
Gerard Marull-Paretas
a76c1cf41b doc: build: dts: mention it is allowed to include at any level
This feature was not mentioned, even though it is supported.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-11-17 06:57:46 -06:00
Emil Gydesen
ecb7591d6b Bluetooth: Audio: Rename BASS and BASS client
Rename BASS to BAP Scan Delegator and BASS Client
to BAP Broadcast Assistant. This is the first step towards
integrating the BASS with the rest of BAP.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2022-11-16 11:17:52 +01:00
Henrik Brix Andersen
2ade879de2 doc: develop: test: ztest: mention the newly added fake EEPROM driver
Mention the newly added FFF-based fake EEPROM driver in the test
documentation.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-11-15 09:43:42 -06:00
Gregers Gram Rygg
f9b5138097 drivers: flash: spi_nor: add macronix high performance mode
Add property mxicy,mx25r-power-mode to jedec,spi-nor binding for
controlling low power/high performance mode on Macronix MX25R* Ultra Low
Power flash devices.

- "low-power" configures the flash in ultra low power mode.
- "high-performance" configures the flash in high performance mode.

Signed-off-by: Gregers Gram Rygg <gregers.gram.rygg@nordicsemi.no>
2022-11-15 14:58:26 +01:00
Rodrigo Peixoto
b8ecbfaa57 zbus: Add message bus subsystem to Zephyr
Add zbus message bus as a Zephyr subsystem. No message bus
or communication abstraction other than the usual (message queues,
mailboxes, etc.) enabled developers to implement event-driven systems in
Zephyr quickly. Zbus would fill that gap by providing the community with
a lightweight and flexible message bus. The implementation tries to be
closest as possible to the existing ones. We use the claim/finish
approach, and the API for publishing and reading channels are similar
in message queues. Zbus is about channels, messages, and observers.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2022-11-14 17:25:29 -05:00
Gerard Marull-Paretas
a236138baa doc: release-notes: inform about regulator APIs relocation
consumer.h APIs are now part of regulator.h.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-11-14 16:59:05 +01:00
Benjamin Lindqvist
85c6de4335 lorawan: enable run-time config of region/freq
This commit adds support for compiling in support for several different
regions/frequencies and dynamically choosing which to use in run-time.
This commit introduces no API breakages - if a prj.conf contains only a
single region Kconfig, the new function lorawan_set_region() does not
need to be called.

Signed-off-by: Benjamin Lindqvist <benjamin@eub.se>
2022-11-14 11:16:16 +00:00
Gaute Svanes Lunde
6acdb1b73a doc: extensions: add custom role 'module_file'
Added another custom role `module_file` which functions like
`zephyr_file` but for any module in the west manifest.

The new role must take a module as an argument. Example syntax:

```rst
:module_file:`module-name: path/within/module`
```

or with custom link text:

```rst
:module_file:`my link text <module-name: path/within/module>`
```

This change also moves the hardcoded project name and link to
github to `doc/conf.py` by adding the configuration values
`link_roles_manifest_project` and `link_roles_manifest_baseurl`

Signed-off-by: Gaute Svanes Lunde <gaute.lunde@nordicsemi.no>
2022-11-11 11:02:03 +01:00
Gaute Svanes Lunde
a8ebb26d4a doc: extension: Format link-roles.py
Formatted `link-roles.py` with Black.

Signed-off-by: Gaute Svanes Lunde <gaute.lunde@nordicsemi.no>
2022-11-11 11:02:03 +01:00
Gerard Marull-Paretas
9c806440ba doc: doxygen: remove unused DT_DOXYGEN predefinition
The predefinition is no longer used, so remove it.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-11-11 11:00:26 +01:00
Gerard Marull-Paretas
8d0eb6ce10 devicetree: remove deprecated DT_CHOSEN_*_LABEL macros
DT_CHOSEN_ZEPHYR_FLASH_CONTROLLER_LABEL and
DT_CHOSEN_ZEPHYR_ENTROPY_LABEL were deprecated a couple of releases ago,
so it is time to remove them. Note that the zephyr/devicetree/zephyr.h
is also removed, since both macros were its last content.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-11-11 11:00:26 +01:00
Jamie McCrae
4b70d4337f doc: release: 3.3: Add mcumgr stable API change
Adds details of the stable API change to mcumgr's callback system,
including a link to the migration guide.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 12:34:39 +01:00
Jamie McCrae
d5693ed464 doc: device_mgmt: callbacks: Add initial documentation
Adds the initial documentation describing the mcumgr callback
system and how to use it, including API reference and samples.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 12:34:39 +01:00
Guillaume Gautier
3352c2d42f doc: releases: Update release notes with stm32 rtc modification
Update release notes 3.3 with the different modifications brought
to the STM32 RTC counter including new functionality, deprecated
and removed Kconfig

Signed-off-by: Guillaume Gautier <guillaume.gautier-ext@st.com>
2022-11-10 11:27:49 +00:00
Jamie McCrae
82258f6c5c doc: release: 3.3: Add note on MCUmgr changes
Adds a note on changes needed to applications to update them for
changes introduced into MCUmgr.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 11:54:46 +01:00
Jamie McCrae
f85eafe02c doc: release: 3.3: Add note on new fs_mgmt feature
Adds a note on the new fs_mgmt feature to query supported
hash/checksum types.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 11:10:03 +01:00
Jamie McCrae
7f56c06ea8 doc: guides: device_mgmt: smp: fs: Add supported hash/checksum info
Adds information on the supported hash/checksum mcumgr command.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-10 11:10:03 +01:00
Uma Praseeda
90577ee5d8 doc: Add reference labels in getting started doc
Add reference labels in getting_started/index.rst

Signed-off-by: Uma Praseeda <uma.praseeda@nordicsemi.no>
2022-11-09 14:42:45 +01:00
René Beckmann
835976917a doc: net: mqtt-sn: Add documentation for MQTT-SN library
Add a page explaining the usage of the MQTT-SN library, the client
and the UDP transport, and add it to the `protocols` index page
next to MQTT.

Signed-off-by: René Beckmann <rene.beckmann@grandcentrix.net>
2022-11-09 10:43:00 +01:00
Jamie McCrae
51e4d7bc56 doc: release: 3.3: Add note on IPv4 fragmentation support
Adds a note that IPv4 fragmentation support is now available.

Signed-off-by: Jamie McCrae <spam@helper3000.net>
2022-11-05 19:58:26 +01:00
Evgeniy Paltsev
85076baf7b ARC: update port status
Update ARC port status page about XY DSP support for EM (WIP)
and single-thread kernel support added.

Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
Signed-off-by: Evgeniy Paltsev <PaltsevEvgeniy@gmail.com>
2022-11-05 19:57:17 +01:00
Stephanos Ioannidis
8073115b4c doc: languages: cpp: Add notes about C++ main()
This commit adds notes about the C++ main() function prototype in the
C++ documentation.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-11-05 16:41:45 +09:00
Elvar Tresnak
53666831d5 doc: POSIX arch: Add link to POSIX OS abstraction
In the note about the relationship between the POSIX arch
and the POSIX OS abstraction, add a link.

Signed-off-by: Elvar Tresnak <Elvar.Tresnak@gmail.com>
2022-11-05 08:41:24 +01:00
Emil Obalski
2e9992f3c8 doc: Add IPC service documentation
Adding IPC service documentation for ICMSg backend.

Signed-off-by: Emil Obalski <Emil.Obalski@nordicsemi.no>
2022-11-04 11:51:54 +01:00
Jamie McCrae
4fe3534a4f doc: release: 3.3: Add note on fixed mcumgr img_mgmt bug
Adds a note on a fixed mcumgr img_mgmt bug whereby image data could
persist when it should not.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-11-03 13:03:53 +01:00
Fabio Baltieri
2875f000b1 doc: api: drop modified version column, link to release notes
The modified version information on the API overvirew don't seem very
useful and are updated inconsistently between releases. The release
notes contains much better information about API updates already grouped
by subsystem and release, link to those instead.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-11-03 10:25:43 +01:00
Henrik Brix Andersen
10c37a3ab4 doc: develop: test: ztest: list FFF-based fake drivers
List the FFF-based fake drivers present in Zephyr.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-11-02 08:19:33 -07:00
Martí Bolívar
e041b2f5da doc: treewide change requirements
This pull request documents additional requirements for treewide
changes which were discussed at the process WG (see
issue #48886 for details).

These requirements apply to especially impactful changes. They exist
both to try to make sure the changes get enough review, and to give
users a heads-up mechanism about incoming treewide changes.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-11-02 14:33:56 +01:00
Henrik Brix Andersen
3c99a1e015 drivers: pcie: reintroduce support for I/O BARs
Reintroduce support for accessing I/O BARs which was removed in
43d84147d9.

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2022-11-01 15:22:31 -04:00
Flavio Ceolin
a61ca79041 doc: vulnerabilities: Add information about CVE-2022-2741
Add information for published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-11-01 12:01:00 +01:00
Flavio Ceolin
ea8c6dbc03 doc: vulnerabilities: Add information about CVE-2022-1041
Add information for published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-11-01 12:01:00 +01:00
Flavio Ceolin
d170982947 doc: vulnerabilities: Add information about CVE-2022-1042
Add information for published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-11-01 12:01:00 +01:00
Flavio Ceolin
01a02e6a29 doc: vulnerabilities: Add information about CVE-2022-1841
Add information for published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-11-01 12:01:00 +01:00
Ingar Kulbrandstad
7367980bea Bluetooth: Mesh: Extended advertiser as default
Setting the extended advertiser as default advertiser
to improve both preformence and reliability.

Signed-off-by: Ingar Kulbrandstad <ingar.kulbrandstad@nordicsemi.no>
2022-11-01 08:52:56 +00:00
Martin Jäger
d218fd9843 doc: develop: test: twister: remove outdated comment
The options --testcase-report and --detailed-report are not existing
anymore.

Signed-off-by: Martin Jäger <martin@libre.solar>
2022-10-31 16:14:14 -04:00
Tomasz Moń
7cfc55359a doc: release: 3.3: Add flashdisk changes
Mention removal of flashdisk Kconfig options in favor of new
zephyr,flash-disk devicetree binding.

Signed-off-by: Tomasz Moń <tomasz.mon@nordicsemi.no>
2022-10-28 12:45:58 +02:00
Tomasz Moń
ba1fdcd15d doc: storage: add flashdisk to disk documentation
Include zephyr,flash-disk devicetree sample in disk documentation.

Signed-off-by: Tomasz Moń <tomasz.mon@nordicsemi.no>
2022-10-28 12:45:58 +02:00
Emil Gydesen
cba4b1828d Bluetooth: Host: Fix missing term callback for PA syncs
When deleting a PA sync with bt_le_per_adv_sync_delete
Zephyr should call the `term` callback for the PA sync
as per the documentation for the callback.

This was not done in the case that the PA sync was
terminated by local request.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2022-10-28 07:56:41 +00:00
Fabio Baltieri
781ece7673 doc: release: note that zephyr- tags won't be used anymore
Add a note about the project not using zephyr- tags anymore.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-10-27 16:26:08 +00:00
Veijo Pesonen
59f53acd37 include: lwm2m: Brings API doc into line with the v1.1 spec
Section numbers do not match between v1.0 and v.1.1 so refer only to
those by their names which stay the same.

Signed-off-by: Veijo Pesonen <veijo.pesonen@nordicsemi.no>
2022-10-27 11:05:05 +02:00
Veijo Pesonen
8c68e01e55 doc: lwm2m: LwM2M Shell
Describes a possible scenario where to use the LwM2M shell
and how to enable it.

Signed-off-by: Veijo Pesonen <veijo.pesonen@nordicsemi.no>
2022-10-27 11:05:05 +02:00
Jamie McCrae
21c7e3ba65 doc: mgmt: mcumgr: Add SMP groups to separate heading
This adds the SMP groups to a separate heading and makes them visible
in the contents list so that they can be selected without having to
go to a specific page to find them.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-26 15:11:11 +02:00
Dominik Ermel
7fccdd170b doc/storage/flash_map: Move to FIXED_PARTITION_ API
Rework of documentation that replaces nformation on
FLASH_AREA_ macro usage with information on FIXED_PARTITION_ macros.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-10-25 17:41:50 +02:00
Jamie McCrae
8e4d30f5e6 doc: release: 3.3: Add note on fixed mcumgr bt deadlock bug fix
Adds a note about a possible deadlock with mcumgr using the
Bluetooth transport being fixed.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-25 17:37:17 +02:00
Henrik Brix Andersen
f8a88cdb27 drivers: can: use flags fields for can_frame and can_filter structs
The can_frame and can_filter structs support a number of different flags
(standard/extended CAN ID type, Remote Transmission Request, CAN-FD format,
Bit Rate Switch, ...). Each of these flags is represented as a discrete bit
in the given structure.

This design pattern requires every user of these structs to initialize all
of these flags to either 0 or 1, which does not scale well for future flag
additions.

Some of these flags have associated enumerations to be used for assignment,
some do not. CAN drivers and protocols tend to rely on the logical value of
the flag instead of using the enumeration, leading to a very fragile
API. The enumerations are used inconsistently between the can_frame and
can_filter structures, which further complicates the API.

Instead, convert these flags to bitfields with separate flag definitions
for the can_frame and can_filter structures. This API allows for future
extensions without having to revisit existing users of the two
structures. Furthermore, this allows driver to easily check for unsupported
flags in the respective API calls.

As this change leads to the "id_mask" field of the can_filter to be the
only mask present in that structure, rename it to "mask" for simplicity.

Fixes: #50776

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-10-25 16:32:10 +02:00
Jamie McCrae
1a161b9d93 doc: release: 3.3: Add note on fixed mcumgr bt sample stack overflow
Adds a note about a possible stack overflow with the smp_svr sample
application using the Bluetooth transport being fixed.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2022-10-25 16:25:13 +02:00