Diff: DS4424.h

Revision:

5:fc75fced724f

Parent:

4:3824afaf0d61

diff -r 3824afaf0d61 -r fc75fced724f DS4424.h
--- a/DS4424.h	Sun Oct 07 22:13:14 2018 +0000
+++ b/DS4424.h	Wed Jan 23 00:43:09 2019 +0000
@@ -1,6 +1,6 @@
 /*******************************************************************************
 * @file DS4424.h
-* Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+* Copyright (C) 2018-2019 Maxim Integrated Products, Inc., All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
@@ -46,9 +46,14 @@
 #define DS4424_SOURCE_I     1
 #define DS4424_SINK_I       0
 
+#define DS4424_MAX_RFS 160000
+#define DS4424_MIN_RFS  40000
+#define DS4424_IFS_SCALE 61000 /* 61000*100= 6100000 = 100,000,000 * .976/16 */
+#define DS4424_MAX_PICOAMPS 200000000
+
 /**
  * @brief Four/two Channel I2C Sink/Source Current DAC
- * @version 1.0000.3
+ * @version 1.0000.301
  *
  * @details The DS4424/DS422 contains four/two I2C
  * programmable current DACs. This driver enables
@@ -152,30 +157,72 @@
     ~DS4424();
     
     /** 
-     * @brief Read raw value of a channel. Negative values are sink; Positive values are source.
+     * @brief Read raw value of a channel using two's complement.
      * @param result - Value that is read from the register
+     *      Negative values are sink; Positive values are source.
      * @param chan_addr - Channel 0 to 3
      * @return 0 on success, negative number on failure
      */
     int read_raw(int32_t &result, ChannelRegAddr_e chan_addr);
     
     /** 
-     * @brief Write raw value to a channel.
-     * @param value - Value that is stored to the register
+     * @brief Read raw value of a channel, using the hardware format
+     * @param *result - Value that is read from the register.
+     *      MSb is 0 for sink; MSb is 1 for source.
+     * @param chan_addr - Channel 0 to 3
+     * @return 0 on success, negative number on failure
+     */
+    int read_hw_raw(uint8_t &result, ChannelRegAddr_e chan_addr);
+    
+    /** 
+     * @brief Write two's complement raw value to a channel.
+     * @param value - Two's complement value that is stored to the register.
+     *      Sink values are negative.
      * @param chan_addr - Channel 0 to 3
      * @return 0 on success, negative number on failure
      */
     int write_raw(int32_t value, ChannelRegAddr_e chan_addr);
+    
+    /** 
+     * @brief Write raw value to a channel, using the hardware format
+     * @param value - Value that is stored to the register
+     *      MSb is 0 for sink; MSb is 1 for source.
+     * @param chan_addr - Channel 0 to 3
+     * @return 0 on success, negative number on failure
+     */
+    int write_hw_raw(uint8_t value, ChannelRegAddr_e chan_addr);
+    
+        /** 
+     * @brief Convert picoAmps to raw values
+     * @param *val_out - 8-bit raw value
+     * @param picoAmps - signed value in picoAmps
+     *      Negative values are sink; Positive values are source.
+     * @param rfs_resistor - external resistor values in Ohms
+     * @return 0 on success, negative number on failure
+     */
+    int convert_picoAmps_to_hw_raw(uint8_t *val_out,
+        int32_t picoAmps, uint32_t rfs_resistor);
+
+    /** 
+     * @brief Convert raw values to picoAmps
+     * @param *val_out - value in picoAmps
+     * @param raw_in - 8 bit raw value, two's complement
+     *      Negative values are sink; Positive values are source.
+     * @param rfs_resistor - external resistor values in Ohms
+     * @return 0 on success, negative number on failure
+     */
+    int convert_raw_to_picoAmps(int32_t *val_out,
+        int8_t raw_in, uint32_t rfs_resistor);
 
 protected:
 
     /**
      * @brief  Read register of device at slave address
+     * @param[out] value - Read data on success
      * @param reg - Register address
-     * @param[out] value - Read data on success
      * @return 0 on success, negative number on failure
      */
-    int read_register(ChannelRegAddr_e reg, uint8_t &value);
+    int read_register(uint8_t &value, ChannelRegAddr_e reg);
 
     /** 
      * @brief Write register of device at slave address