zephyr/doc/reference/peripherals/hwinfo.rst
Gerard Marull-Paretas 9dfbdf1997 doc: use kconfig role and directive
Stop using :option: for Kconfig options.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-06-29 10:26:28 -04:00

28 lines
637 B
ReStructuredText

.. _hwinfo_api:
Hardware Information
####################
Overview
********
The HW Info API provides access to hardware information such as device
identifiers and reset cause flags.
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 `hwinfo_get_supported_reset_cause` to retrieve the flags
that are supported by that device.
Configuration Options
*********************
Related configuration options:
* :kconfig:`CONFIG_HWINFO`
API Reference
*************
.. doxygengroup:: hwinfo_interface