OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/hardware/peripherals/hwinfo.rst

29 lines
652 B
ReStructuredText
Raw Normal View History

doc: reference: Add hwinfo API Add the hwinfo API to the reference documentation. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-03-17 22:00:25 +08:00
.. _hwinfo_api:
Hardware Information
####################
Overview
********
The HW Info API provides access to hardware information such as device
drivers: hwinfo: Add reset cause support Add `hwinfo_get_reset_cause` and `hwinfo_clear_reset_cause` to retrieve and to clear cause of system reset on supported platforms. Different platforms can provide different causes of reset, however there is a great deal of overlap. `enum reset_cause` can be expanded in the future to support additional reasons, as additional platforms are supported. Signed-off-by: Arvin Farahmand <arvinf@ip-logix.com>
2020-05-01 10:32:52 +08:00
identifiers and reset cause flags.
doc: fix C domain reference usage THis patch fixes multiple issues when referencing to the C domain. In some cases there were typos (e.g. missing :), in some others no domain syntax was used for referencing, etc. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-10-22 22:16:56 +08:00
Reset cause flags can be used to determine why the device was reset; for
example due to a watchdog timeout or due to power cycling. Different devices
support different subset of flags. Use
:c:func:`hwinfo_get_supported_reset_cause` to retrieve the flags that are
supported by that device.
doc: reference: Add hwinfo API Add the hwinfo API to the reference documentation. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-03-17 22:00:25 +08:00
Configuration Options
*********************
Related configuration options:
doc: use :kconfig:option: domain role Kconfig options now belong to the Kconfig domain, therefore, the :kconfig:option: role needs to be used. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-08 00:27:43 +08:00
* :kconfig:option:`CONFIG_HWINFO`
doc: reference: Add hwinfo API Add the hwinfo API to the reference documentation. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-03-17 22:00:25 +08:00
API Reference
*************
.. doxygengroup:: hwinfo_interface