98a0ccd5c5
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>
28 lines
636 B
ReStructuredText
28 lines
636 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:
|
|
|
|
* :option:`CONFIG_HWINFO`
|
|
|
|
API Reference
|
|
*************
|
|
|
|
.. doxygengroup:: hwinfo_interface
|