From 46f108519d8b1e0e5d443822a563015834e9b34a Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Tue, 17 Mar 2020 15:00:25 +0100 Subject: [PATCH] doc: reference: Add hwinfo API Add the hwinfo API to the reference documentation. Signed-off-by: Carles Cufi --- doc/reference/peripherals/hwinfo.rst | 23 +++++++++++++++++++++++ doc/reference/peripherals/index.rst | 1 + include/drivers/hwinfo.h | 13 +++++++------ 3 files changed, 31 insertions(+), 6 deletions(-) create mode 100644 doc/reference/peripherals/hwinfo.rst diff --git a/doc/reference/peripherals/hwinfo.rst b/doc/reference/peripherals/hwinfo.rst new file mode 100644 index 00000000000..d7c2c8568b8 --- /dev/null +++ b/doc/reference/peripherals/hwinfo.rst @@ -0,0 +1,23 @@ +.. _hwinfo_api: + +Hardware Information +#################### + +Overview +******** + +The HW Info API provides access to hardware information such as device +identifiers. + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_HWINFO` + +API Reference +************* + +.. doxygengroup:: hwinfo_interface + :project: Zephyr diff --git a/doc/reference/peripherals/index.rst b/doc/reference/peripherals/index.rst index 3e9f4989e6c..c58e4341256 100644 --- a/doc/reference/peripherals/index.rst +++ b/doc/reference/peripherals/index.rst @@ -14,6 +14,7 @@ Peripherals flash.rst gna.rst gpio.rst + hwinfo.rst i2c_eeprom_slave.rst i2c.rst i2s.rst diff --git a/include/drivers/hwinfo.h b/include/drivers/hwinfo.h index fde8f220cb2..baf1bf17e1e 100644 --- a/include/drivers/hwinfo.h +++ b/include/drivers/hwinfo.h @@ -13,6 +13,13 @@ #ifndef ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_ #define ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_ +/** + * @brief Hardware Information Interface + * @defgroup hwinfo_interface Hardware Info Interface + * @ingroup io_interfaces + * @{ + */ + #include #include #include @@ -23,12 +30,6 @@ extern "C" { #endif -/** - * @brief Device ID - * @{ - */ - - /** * @brief Copy the device id to a buffer *