GSMA version

Fork of FXOS8700CQ by Thomas Murphy

Revision:
2:4c2f8a3549a9
Parent:
1:3ec7e2676e48
Child:
3:2ce85aa45d7d
--- a/FXOS8700CQ.h	Wed May 28 13:40:59 2014 +0000
+++ b/FXOS8700CQ.h	Wed May 28 17:08:33 2014 +0000
@@ -15,19 +15,82 @@
 #define FXOS8700CQ_STATUS 0x00
 #define FXOS8700CQ_OUT_X_MSB 0x01
 #define FXOS8700CQ_WHOAMI 0x0D
+#define FXOS8700CQ_M_OUT_X_MSB 0x33
+
 #define FXOS8700CQ_XYZ_DATA_CFG 0x0E
+
 #define FXOS8700CQ_CTRL_REG1 0x2A
 #define FXOS8700CQ_CTRL_REG2 0x2B
 #define FXOS8700CQ_CTRL_REG3 0x2C
 #define FXOS8700CQ_CTRL_REG4 0x2D
 #define FXOS8700CQ_CTRL_REG5 0x2E
 
-#define FXOS8700CQ_M_OUT_X_MSB 0x34
-
 #define FXOS8700CQ_M_CTRL_REG1 0x5B
 #define FXOS8700CQ_M_CTRL_REG2 0x5C
 #define FXOS8700CQ_M_CTRL_REG3 0x5D
 
+// FXOS8700CQ configuration macros, per register
+
+#define FXOS8700CQ_CTRL_REG1_ASLP_RATE2(x) (x << 6) // x is 2-bit
+#define FXOS8700CQ_CTRL_REG1_DR3(x) (x << 3) // x is 3-bit
+#define FXOS8700CQ_CTRL_REG1_LNOISE (1 << 2)
+#define FXOS8700CQ_CTRL_REG1_F_READ (1 << 1)
+#define FXOS8700CQ_CTRL_REG1_ACTIVE (1 << 0)
+
+#define FXOS8700CQ_CTRL_REG2_ST (1 << 7)
+#define FXOS8700CQ_CTRL_REG2_RST (1 << 6)
+#define FXOS8700CQ_CTRL_REG2_SMODS2(x) (x << 3) // x is 2-bit
+#define FXOS8700CQ_CTRL_REG2_SLPE (1 << 2)
+#define FXOS8700CQ_CTRL_REG2_MODS2(x) (x << 0) // x is 2-bit
+
+#define FXOS8700CQ_CTRL_REG3_FIFO_GATE (1 << 7)
+#define FXOS8700CQ_CTRL_REG3_WAKE_TRANS (1 << 6)
+#define FXOS8700CQ_CTRL_REG3_WAKE_LNDPRT (1 << 5)
+#define FXOS8700CQ_CTRL_REG3_WAKE_PULSE (1 << 4)
+#define FXOS8700CQ_CTRL_REG3_WAKE_FFMT (1 << 3)
+#define FXOS8700CQ_CTRL_REG3_WAKE_A_VECM (1 << 2)
+#define FXOS8700CQ_CTRL_REG3_IPOL (1 << 1)
+#define FXOS8700CQ_CTRL_REG3_PP_OD (1 << 0)
+
+#define FXOS8700CQ_CTRL_REG4_INT_EN_ASLP (1 << 7)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_FIFO (1 << 6)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_TRANS (1 << 5)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_LNDPRT (1 << 4)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_PULSE (1 << 3)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_FFMT (1 << 2)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_A_VECM (1 << 1)
+#define FXOS8700CQ_CTRL_REG4_INT_EN_DRDY (1 << 0)
+
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_ASLP (1 << 7)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_FIFO (1 << 6)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_TRANS (1 << 5)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_LNDPRT (1 << 4)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_PULSE (1 << 3)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_FFMT (1 << 2)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_A_VECM (1 << 1)
+#define FXOS8700CQ_CTRL_REG5_INT_CFG_DRDY (1 << 0)
+
+#define FXOS8700CQ_XYZ_DATA_CFG_HPF_OUT (1 << 4)
+#define FXOS8700CQ_XYZ_DATA_CFG_FS2(x) (x << 0) // x is 2-bit
+
+#define FXOS8700CQ_M_CTRL_REG1_M_ACAL (1 << 7)
+#define FXOS8700CQ_M_CTRL_REG1_M_RST (1 << 6)
+#define FXOS8700CQ_M_CTRL_REG1_M_OST (1 << 5)
+#define FXOS8700CQ_M_CTRL_REG1_MO_OS3(x) (x << 2) // x is 3-bit
+#define FXOS8700CQ_M_CTRL_REG1_M_HMS2(x) (x << 0) // x is 2-bit
+
+#define FXOS8700CQ_M_CTRL_REG2_HYB_AUTOINC_MODE (1 << 5)
+#define FXOS8700CQ_M_CTRL_REG2_M_MAXMIN_DIS (1 << 4)
+#define FXOS8700CQ_M_CTRL_REG2_M_MAXMIN_DIS_THS (1 << 3)
+#define FXOS8700CQ_M_CTRL_REG2_M_MAXMIN_RST (1 << 2)
+#define FXOS8700CQ_M_CTRL_REG2_M_RST_CNT2(x) (x << 0) // x is 2-bit
+
+#define FXOS8700CQ_M_CTRL_REG3_M_RAW (1 << 7)
+#define FXOS8700CQ_M_CTRL_REG3_M_ASLP_OS3(x) (x << 4) // x is 3-bit
+#define FXOS8700CQ_M_CTRL_REG3_M_THS_XYZ_UPDATE (1 << 3)
+#define FXOS8700CQ_M_CTRL_REG3_M_ST_Z (1 << 2)
+#define FXOS8700CQ_M_CTRL_REG3_M_ST_XY2(x) (x << 0) // x is 2-bit
+
 // FXOS8700CQ WHOAMI production register value
 #define FXOS8700CQ_WHOAMI_VAL 0xC7
 
@@ -65,13 +128,12 @@
     * @param sdl SCL pin
     * @param addr address of the I2C peripheral in (7-bit << 1) form
     */
-
     FXOS8700CQ(PinName sda, PinName scl, int addr);
 
     /**
     * FXOS8700CQ destructor
     */
-    ~FXOS8700CQ();
+    ~FXOS8700CQ(void);
 
     void enable(void);
     void disable(void);
@@ -83,14 +145,23 @@
     *
     * @param accel_data destination XYZ accelerometer data struct
     * @param magn_data destination XYZ magnetometer data struct
+    * @return 0 on success, non-zero on failure
     */
-    void get_data(SRAWDATA *accel_data, SRAWDATA *magn_data);
+    uint8_t get_data(SRAWDATA *accel_data, SRAWDATA *magn_data);
+    
+    /**
+    * Retrieve the full-range scale value of the accelerometer
+    * 
+    * @return 2, 4, or 8, depending on part configuration; 0 on error
+    */
+    uint8_t get_accel_scale(void);
 
 
 
 private:
     I2C dev_i2c; // instance of the mbed I2C class
     uint8_t dev_addr; // Device I2C address, in (7-bit << 1) form
+    bool enabled;
 
     // I2C helper methods
     void read_regs(int reg_addr, uint8_t* data, int len);