Diff: inc/admw_api.h

Revision:

6:9d393a9677f4

Parent:

5:0728bde67bdb

Child:

13:97cb32670539

diff -r 0728bde67bdb -r 9d393a9677f4 inc/admw_api.h
--- a/inc/admw_api.h	Wed Jun 05 05:39:15 2019 +0000
+++ b/inc/admw_api.h	Sat Jun 15 14:30:49 2019 +0000
@@ -1,5 +1,5 @@
 /*
-Copyright 2017 (c) Analog Devices, Inc.
+Copyright 2019 (c) Analog Devices, Inc.
 
 All rights reserved.
 
@@ -33,15 +33,15 @@
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
-/*
+/*!
  ******************************************************************************
  * @file:   admw_api.h
  * @brief:  ADMW Host Library Application Programming Interface (API)
  *-----------------------------------------------------------------------------
  */
 
-#ifndef __ADMW_API_H__
-#define __ADMW_API_H__
+#ifndef _ADMW_API_H__
+#define _ADMW_API_H__
 
 #include "inc/admw_types.h"
 #include "inc/admw_config_types.h"
@@ -101,20 +101,12 @@
     /*!< Indicates that a configuration error condition has been detected by the device */
     ADMW_DEVICE_STATUS_LUT_ERROR    = (1 << 6),
     /*!< Indicates that a look-up table error condition has been detected by the device */
-    ADMW_DEVICE_STATUS_EXT_FLASH_ERROR = (1 << 7),
-    /*!< Indicates that an external flash memory error condition has been detected by the device */
 } ADMW_DEVICE_STATUS_FLAGS;
 
 /*! Bit masks (flags) for the different diagnostics status indicators. */
 typedef enum {
     ADMW_DIAGNOSTICS_STATUS_CHECKSUM_ERROR       = (1 << 0),
     /*!< Indicates Error on Internal Checksum Calculations */
-    ADMW_DIAGNOSTICS_STATUS_COMMS_ERROR          = (1 << 1),
-    /*!< Indicates Error on Internal Device Communications */
-    ADMW_DIAGNOSTICS_STATUS_SUPPLY_MONITOR_ERROR = (1 << 2),
-    /*!< Indicates Low Voltage on Internal Supply Voltages */
-    ADMW_DIAGNOSTICS_STATUS_SUPPLY_CAP_ERROR     = (1 << 3),
-    /*!< Indicates Fault on Internal Supply Regulator Capacitor */
     ADMW_DIAGNOSTICS_STATUS_CONVERSION_ERROR     = (1 << 8),
     /*!< Indicates Error During Internal ADC Conversions */
     ADMW_DIAGNOSTICS_STATUS_CALIBRATION_ERROR    = (1 << 9),
@@ -175,7 +167,7 @@
     /*!< Device summary status snapshot when the sample was recorded */
     uint32_t                           channelId;
     /*!< The measurement channel from which this sample was obtained */
-    int32_t                            rawValue;
+    uint32_t                           rawValue;
     /*!< The raw (unprocessed) value obtained directly from the measurement
      *   channel, if available
      */
@@ -190,27 +182,17 @@
  *  @ref admw_StartMeasurement
  */
 typedef enum {
-    ADMW_MEASUREMENT_MODE_HEALTHCHECK = 1,
-    /*!< In this mode, a special health-check measurement cycle is executed,
-     *   carrying out a single conversion per channel with measurement
-     *   diagnostics enabled, intended for use as a system health check. */
-    ADMW_MEASUREMENT_MODE_NORMAL,
+    ADMW_MEASUREMENT_MODE_NORMAL = 0,
     /*!< In this mode, normal measurement cycle(s) are executed and data samples
      *   are returned with raw measurement values included. */
     ADMW_MEASUREMENT_MODE_OMIT_RAW,
     /*!< In this mode, normal measurement cycle(s) are executed and data samples
      *   are returned with raw measurement values omitted for efficiency. */
-    ADMW_MEASUREMENT_MODE_FFT,
-    /*!< In this mode, FFT mode measurement cycle(s) are executed and data
-     *   samples are returned based on FFT-specific configuration parameters. */
 } ADMW_MEASUREMENT_MODE;
 
 /*! Identifiers for the user configuration slots in persistent memory. */
 typedef enum {
     ADMW_FLASH_CONFIG_1,
-    ADMW_FLASH_CONFIG_2,
-    ADMW_FLASH_CONFIG_3,
-    ADMW_FLASH_CONFIG_4,
 } ADMW_USER_CONFIG_SLOT;
 
 
@@ -235,7 +217,7 @@
  *         - #ADMW_INVALID_DEVICE_NUM Invalid device index specified
  *
  * @details Configure and initialise the Log interface and the SPI/GPIO
- *          communication interface to the ADMW module.
+ *          communication interface to the ADISense module.
  */
 ADMW_RESULT admw_Open(
     unsigned                   const nDeviceIndex,
@@ -697,5 +679,4 @@
  * @}
  */
 
-#endif /* __ADMW_API_H__ */
-
+#endif /* _ADMW_API_H__ */