tpr12/canfd: canfd apiguide changes
authorBadri S <badri@ti.com>
Mon, 7 Dec 2020 11:56:02 +0000 (17:26 +0530)
committerBadri S <badri@ti.com>
Tue, 8 Dec 2020 09:45:49 +0000 (15:15 +0530)
canfd apiguide support

Signed-off-by: Badri S <badri@ti.com>
packages/ti/drv/canfd/canfd.h
packages/ti/drv/canfd/soc/canfd_soc.h

index 044d9ee9325491260eae9c0f32235ced7032ea47..f47e46984cf8837ce7f6466fe2c7855659293e23 100644 (file)
@@ -39,7 +39,8 @@
  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** @mainpage CANFD Driver
+/**
+ *  \defgroup DRV_CANFD_MODULE CANFD Driver
  *
  *  The CANFD driver provides functionality of transferring data between CANFD peripherals.
  *  This driver does not interpret any of the data sent to or received from using this peripheral.
  * ## Limitation #
  *  The CANFD driver does not support the DMA or power down.
  *
- *  The canfd/include/hw_mcanss.h has the register layer definitons for the CANFD controller module.
  *
  */
 
-/** @defgroup CANFD_DRIVER      CANFD Driver
- */
-
 #ifndef CANFD_H_
 #define CANFD_H_
 
@@ -103,8 +100,9 @@ extern "C" {
 
 
 /**
+
 @defgroup CANFD_DRIVER_EXTERNAL_FUNCTION     CANFD Driver External Functions
-@ingroup CANFD_DRIVER
+@ingroup DRV_CANFD_MODULE
 @brief
 *   The section has a list of all the exported API which the applications need to
 *   invoke in order to use the CANFD driver
@@ -112,18 +110,16 @@ extern "C" {
 
 /**
 @defgroup CANFD_DRIVER_EXTERNAL_DATA_STRUCTURE      CANFD Driver External Data Structures
-@ingroup CANFD_DRIVER
+@ingroup DRV_CANFD_MODULE
 @brief
 *   The section has a list of all the data structures which are exposed to the application
 */
 
 /**
 @defgroup CANFD_DRIVER_ERROR_CODE            CANFD Driver Error code
-@ingroup CANFD_DRIVER
+@ingroup DRV_CANFD_MODULE
 @brief
 *   The section has a list of all the error codes which are returned to the application.
-*   Base error code for the CANFD module is defined in the
-*  \include ti/common/mmwave_error.h
  @{ */
 
 /**
index f37bd9de12b44f78b6490240fce6a9bea01b3736..36fa5e2b4a61626a3df3aaf469bf98fb1685972e 100644 (file)
@@ -1,12 +1,5 @@
 /*!
- *   @file  canfd_soc.h
  *
- *   @brief
- *      This is an header file used by the CANFD module and has SoC specific
- *      configuration.
- *
- *  \par
- *  NOTE:
  *      (C) Copyright 2020 Texas Instruments, Inc.
  *
  *  Redistribution and use in source and binary forms, with or without
  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/**
+ *  @defgroup DRV_CANFD_SOC_MODULE CANFD SOC specific interface
+ *  @ingroup DRV_CANFD_MODULE
+ *
+ *  @brief
+ *  The section has a SoC specific interface definitions for the CANFD driver
+
+ *  @{
+ */
+
+/**
+ *   @file  canfd/soc/canfd_soc.h
+ *
+ *   @brief
+ *      This is an header file used by the CANFD module and has SoC specific
+ *      configuration.
+ */
+
 #ifndef CANFD_SOC_H
 #define CANFD_SOC_H
 
@@ -90,4 +101,5 @@ typedef struct CANFD_HwCfg_t
 }
 #endif
 
-#endif /* CANFD_INTERNAL_H */
+#endif /* CANFD_SOC_H */
+/* @} */