zephyr/doc/hardware/peripherals/hwinfo.rst
Anas Nashif df033b28de doc: create new Hardware Support section
Add new hardware section and move all related content from old
structure.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00

29 lines
652 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
:c:func:`hwinfo_get_supported_reset_cause` to retrieve the flags that are
supported by that device.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_HWINFO`
API Reference
*************
.. doxygengroup:: hwinfo_interface