From ab03b538d4ea6a01b2f228e9b590c3bed74c4d5d Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Tue, 17 Mar 2020 12:53:52 +0100 Subject: [PATCH] doc: reference: Add GNA API entry Add an entry for the GNA API. Signed-off-by: Carles Cufi --- doc/reference/peripherals/gna.rst | 23 +++++++++++++++++++++++ doc/reference/peripherals/index.rst | 1 + include/drivers/gna.h | 16 +++++++++++++--- 3 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 doc/reference/peripherals/gna.rst diff --git a/doc/reference/peripherals/gna.rst b/doc/reference/peripherals/gna.rst new file mode 100644 index 00000000000..fcade26c8bf --- /dev/null +++ b/doc/reference/peripherals/gna.rst @@ -0,0 +1,23 @@ +.. _gna_api: + +GNA +### + +Overview +******** + +The GNA API provides access to Intel's Gaussian Mixture Model and Neural Network +Accelerator (GNA). + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_INTEL_GNA` + +API Reference +************* + +.. doxygengroup:: gna_interface + :project: Zephyr diff --git a/doc/reference/peripherals/index.rst b/doc/reference/peripherals/index.rst index 7b69a723d99..3e9f4989e6c 100644 --- a/doc/reference/peripherals/index.rst +++ b/doc/reference/peripherals/index.rst @@ -12,6 +12,7 @@ Peripherals eeprom.rst entropy.rst flash.rst + gna.rst gpio.rst i2c_eeprom_slave.rst i2c.rst diff --git a/include/drivers/gna.h b/include/drivers/gna.h index b31d432f6df..49d660cbc94 100644 --- a/include/drivers/gna.h +++ b/include/drivers/gna.h @@ -9,14 +9,20 @@ /** * @file * @brief Public API header file for Intel GNA driver - * - * This file contains the driver APIs for Intel's - * Gaussian Mixture Model and Neural Network Accelerator (GNA) */ #ifndef __INCLUDE_GNA__ #define __INCLUDE_GNA__ +/** + * @defgroup gna_interface GNA Interface + * @ingroup io_interfaces + * @{ + * + * This file contains the driver APIs for Intel's + * Gaussian Mixture Model and Neural Network Accelerator (GNA) + */ + #ifdef __cplusplus extern "C" { #endif @@ -213,4 +219,8 @@ static inline int gna_infer(struct device *dev, struct gna_inference_req *req, } #endif +/** + * @} + */ + #endif /* __INCLUDE_GNA__ */