Commit graph

296 commits

Author SHA1 Message Date
Jukka Rissanen
5ac2461339 doc: net: Fix L2 documentation
Use proper link to Zephyr source files. Fix rendering of special
options like NET_OK, NET_DROP and NET_CONTINUE.
Add reference links to network technologies documents.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-09 17:01:26 -05:00
Krzysztof Chruscinski
b0ba9c0133 doc: shell: Document logging to shell in case of early crash
In case of early crash, shell will not output logs. Added
documentation explaining how to handle such situations.

It is recommended to enable simple logger backend (RTT, UART)
which are available earlier.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2019-03-09 10:08:14 -05:00
Jukka Rissanen
319d8c7e2a doc: net: Updates to network architecture document
The architecture document contained old information and is now
updated to match the reality.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-09 10:06:55 -05:00
David B. Kinder
505cc2bb0e doc: use :zephyr_file: where appropriate
A new role :zephyr_file: is available that renders to a link to the file
or folder in GitHub.  Find appropriate references using :file: and
convert to :zephyr_file: to take advantage of its linking capability.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-09 09:50:27 -05:00
Jukka Rissanen
9a0cf4b48f doc: net: Fix VLAN documentation in doc and in sample
The VLAN documentation had double wording and proper links to files
in github was missing, which did not look good in the rendered HTML
page.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-07 20:31:04 -05:00
Jukka Rissanen
3a5f707d45 doc: net: Minor fixes to DNS documentation
Fix link to DNS Kconfig option. Add proper links to DNS files
in github. Fixed link to DNS sample application.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-07 20:29:47 -05:00
Jukka Rissanen
4e201a60e3 doc: net: Use proper github link for statistics Kconfig file
Show proper network statistics Kconfig file link.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-07 13:04:57 -06:00
Jukka Rissanen
301aeda9ef doc: net: Update the L2 documentation
The L2 documentation was describing functionality that has changed
recently. Now it should match the current reality.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-03-05 08:29:31 -05:00
Jukka Rissanen
2610c09f0f doc: net: Move net-shell to system management page
The net-shell is more logically part of system management page.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-03 23:50:17 -05:00
Jukka Rissanen
575040496d doc: net: Add table of contents to networking docs
This allows easy access to different part of the page.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-03 23:50:17 -05:00
Jukka Rissanen
35e744ff1c doc: net: Enhance LLDP documentation
The Link Layer Discovery Protocol chapter was missing Overview
and also the API reference was not populated properly.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-03-01 09:45:06 +01:00
Jukka Rissanen
4021bb3cf2 doc: net: Minor tweaks to gptp documentation
Adding OpenAVnu/gptp and linuxptp links to the doc.
Also the "Application interfaces" chapter had some style issues.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-27 08:35:50 -06:00
Jukka Rissanen
cd100899ed doc: net: Enhance Ethernet management documentation
The Ethernet management documentation was missing Overview
chapter.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-27 10:27:02 +01:00
Robert Lubos
663460cd21 doc: net: Add socket offload description
Add decription and API reference for socket offloading.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-02-26 17:26:48 -08:00
Piotr Mienkowski
40b5522058 power: doc: fix usage of 'low power state' phrase
The phrase 'low power state' is often incorrectly used to indicate
'low power' or 'deep sleep' states. This commit fixes the ambiguities
by renaming 'low power state' to 'power state' where necessary.

Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2019-02-26 02:30:13 +01:00
Piotr Mienkowski
f04a4c9deb power: rename CPU_LPS_n power states
CPU_LPS_n name used to indicate a low power state is cryptic and
incorrect. The low power states act on the whole SoC and not exclusively
on the CPU. This patch renames CPU_LPS_n states to LOW_POWER_n. Also
HAS_ pattern for Kconfig options is used in favor of a non standard
_SUPPORTED. Naming of deep sleep states was adjusted accordingly.

Following is a detailed list of string replacements used:
s/SYS_POWER_STATE_CPU_LPS_(\d)_SUPPORTED/HAS_STATE_LOW_POWER_$1/
s/SYS_POWER_STATE_CPU_LPS_(\d)/SYS_POWER_STATE_LOW_POWER_$1/
s/SYS_POWER_STATE_DEEP_SLEEP_(\d)_SUPPORTED/HAS_STATE_DEEP_SLEEP_$1/

Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2019-02-26 02:30:13 +01:00
Jukka Rissanen
985c5d72a5 doc: net: Add documentation for net-shell
Simple page describing net-shell commands.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-26 02:24:45 +01:00
Jukka Rissanen
c30f6c38d5 doc: net: Enhance Ethernet documentation
Add Overview chapter + info about IEEE 802.1Qav (credit based
shaper).

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-26 02:07:36 +01:00
Robert Lubos
b48f968f65 doc: net: Add Thread protocol description
Add a documentation page for Thread with a brief description.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-02-26 01:46:18 +01:00
Andrew Boie
4ce652e4b2 userspace: remove APP_SHARED_MEM Kconfig
This is an integral part of userspace and cannot be used
on its own. Fold into the main userspace configuration.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2019-02-23 07:43:55 -05:00
Jukka Rissanen
fd6aa0a508 doc: net: Add overview chapter to IPv4/6 helper doc
Overview chapter was missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-22 13:54:14 -05:00
Jukka Rissanen
1d43377db9 doc: net: Move networking reference document chapters around
Group the networking chapters for reference document so that the
layout is more logical and easier to read.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-22 13:32:09 -05:00
Ravi kumar Veeramally
37b8ec6acb doc: Add CoAP high-level description
Add high-level documentation for CoAP library.

Signed-off-by: Ravi kumar Veeramally <ravikumar.veeramally@linux.intel.com>
2019-02-21 17:49:07 -05:00
Jukka Rissanen
edb01e229f doc: net: context: Add comment to use BSD socket API instead
The net_context API is being phased out.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:59:24 -05:00
Jukka Rissanen
9146237fa3 doc: net: Enhance net_timeout API documentation
Add overview to net_timeout API documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:39:20 -05:00
Jukka Rissanen
b364cf4b12 doc: net: Enhance promiscuous mode documentation
Added overview and sample usage for promiscuous mode documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:38:13 -05:00
Jukka Rissanen
9191bf3a0b doc: net: Enhance network statistics documentation
Add information how to collect network statistics in the system.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:37:56 -05:00
Jukka Rissanen
db45ed716f doc: net: Hide UDP API documentation
The UDP API functions are for Zephyr internal use only so do
not generate documentation for them.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:37:43 -05:00
Jukka Rissanen
8c9bff57a0 doc: net: Enhance network offloading API documentation
Add small overview what network offloading means.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 16:37:26 -05:00
Laczen JMS
7989801966 fs/nvs: Improve init speed and remove fs->locked
This patch removes the free space calculation from nvs initialization.
The available space can be calculated if required using the routine
nvs_calc_free_space.

This patch also removes the locked state of nvs, it is not possible to
get in a locked state.

Changes:

Removed locked state and free_space from the nvs structure.

nvs_reinit(): has been replaced with by an internal only function
_nvs_startup().

nvs_write(): removed the possibility to place the file system in a
locked state, if to many gc operations are required it will return
-ENOSPC.

ssize_t nvs_calc_free_space(): introduced, calculates the free space
that is available in the nvs file system.

Signed-off-by: Laczen JMS <laczenjms@gmail.com>
2019-02-21 09:32:52 -05:00
Jukka Rissanen
5e83e919e3 doc: net: Enhance DHCPv4 documentation
Add short overview for DHCPv4. Do not add dhcpv4 library internal
state in the documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-21 08:01:51 -05:00
Jukka Rissanen
f820062475 doc: net: Enhance network interface documentation
Add overview to network interface API documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 19:42:30 -05:00
Jukka Rissanen
9e4d147e44 doc: net: Enhance network hostname configuration documentation
Add overview how to use the network hostname API.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 19:42:13 -05:00
Jukka Rissanen
65208bda28 doc: net: Enhance network configuration library documentation
Add overview and sample usage for the config library.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 19:41:59 -05:00
Jukka Rissanen
c17d302321 doc: net: Enhance DNS resolver documentation
Add more information about DNS resolver to documentation. Move
generic DNS information from the sample application into DNS
resolver documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 19:41:47 -05:00
Jukka Rissanen
bf2eb7b65c doc: net: Enhance Trickle algorithm documentation
Add overview chapter.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 17:28:11 -05:00
Jukka Rissanen
d9b891941b doc: net: Enhance PTP time format documentation
Added overview for PTP time format documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 17:27:40 -05:00
Jukka Rissanen
707e2294b6 doc: net: Enhance IEEE 802.15.4 documentation
Add a simple overview chapter to IEEE 802.15.4 documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-20 13:30:59 -05:00
Krzysztof Chruscinski
a5efcc2c53 shell: Add cpp-friendly shell macro for subcommands creation
Add macro for creating subcommand set in a way that is
accepted by C++ (SHELL_STATIC_SUBCMD_SET_CREATE). Currently,
it exists along with SHELL_CREATE_STATIC_SUBCMD_SET which is
used in the tree but it is not liked by cpp.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2019-02-20 07:31:35 -05:00
Paul Sokolovsky
4ff21f631a doc: sockets: Update to the current state of affairs
1. There's now proper fdtable, pointer casting to "fd" is gone.
2. select() was implemented.
3. Enumerate implemented functions more thoroughly, so users can
fulltext-search them.

Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2019-02-19 17:29:44 -05:00
Jukka Rissanen
3a93b33c99 doc: net: Enhance core API documentation
Add information about net_recv_data() and net_send_data()
functions.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-19 15:21:01 -05:00
Jukka Rissanen
94f3091e08 doc: net: Enhance link layer address documentation
Add overview chapter to link layer address documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2019-02-19 15:07:41 -05:00
Piotr Zięcik
9cc63e07e4 power: Fix naming of Kconfig options controlling deep sleep states
This commit changes the names of SYS_POWER_DEEP_SLEEP* Kconfig
options in order to match SYS_POWER_LOW_POWER_STATE* naming
scheme.

Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-12 07:46:32 -05:00
Piotr Zięcik
7a49356c77 power: Fix naming of Kconfig options controlling low power states
The SYS_POWER_LOW_POWER_STATE_SUPPORTED and SYS_POWER_LOW_POWER_STATE
suggests one low power state but these options control multiple
low power state. This commit uses plural in the names to indicate
that.

Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-12 07:46:32 -05:00
Carles Cufi
47b781e1a0 doc: bluetooth: Add reference to Bluetooth API
Add a general reference to the Bluetooth API pages.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-02-11 07:54:27 -05:00
Piotr Zięcik
994ef5c3c4 power: Move part of Power Management API to correct group
Part of Power Management API was incorrecty documented under
"Power Management Hook Interface" section. This commit fixes
that problem by introducing "System Power Management APIs".

Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-11 07:52:12 -05:00
Robert Lubos
d942c1d718 doc: Add MQTT high-level description
Add high-level documentation for MQTT library.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2019-02-09 09:39:03 -05:00
David Brown
f8b838d404 jwt: Add JSON web token library
This patch adds a JSON web token library that adds the capability
to sign JSON tokens.  This was located in subsys due to the dependency
on MBEDTLS, which resides in /ext.

Signed-off-by: David Brown <david.brown@linaro.org>
Signed-off-by: Andy Gross <andy.gross@linaro.org>
2019-02-08 15:32:58 -06:00
Piotr Zięcik
d02e3ebd4c power: Eliminate SYS_PM_* power states.
The power management framework used two different abstractions
to describe power states. The SYS_PM_* given coarse information
what kind of power state (low power or deep sleep) was used,
while the SYS_POWER_STATE_* abstraction provided information
about particular power mode.

This commit removes the SYS_PM_* abstraction as the same
information is already carried in SYS_POWER_STATE_*.

Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2019-02-08 09:07:00 -05:00
Andrew Boie
41f6011c36 userspace: remove APPLICATION_MEMORY feature
This was never a long-term solution, more of a gross hack
to get test cases working until we could figure out a good
end-to-end solution for memory domains that generated
appropriate linker sections. Now that we have this with
the app shared memory feature, and have converted all tests
to remove it, delete this feature.

To date all userspace APIs have been tagged as 'experimental'
which sidesteps deprecation policies.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2019-02-08 07:04:30 -05:00