michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: reference: Add hwinfo API

Browse source 
Add the hwinfo API to the reference documentation.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-03-17 15:00:25 +01:00 • committed by Carles Cufí
commit 46f108519d
3 changed files with 31 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/reference/peripherals/hwinfo.rst Normal file
View file

@ -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

1
doc/reference/peripherals/index.rst
View file

@ -14,6 +14,7 @@ Peripherals
flash.rst flash.rst
gna.rst gna.rst
gpio.rst gpio.rst
hwinfo.rst
i2c_eeprom_slave.rst i2c_eeprom_slave.rst
i2c.rst i2c.rst
i2s.rst i2s.rst

13
include/drivers/hwinfo.h
View file

@ -13,6 +13,13 @@
#ifndef ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_ #ifndef ZEPHYR_INCLUDE_DRIVERS_HWINFO_H_
#define 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 <zephyr/types.h> #include <zephyr/types.h>
#include <sys/types.h> #include <sys/types.h>
#include <stddef.h> #include <stddef.h>
@ -23,12 +30,6 @@
extern "C" { extern "C" {
#endif #endif
/**
* @brief Device ID
* @{
*/
/** /**
* @brief Copy the device id to a buffer * @brief Copy the device id to a buffer
* *