pios_hmc5983.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 */

#ifndef PIOS_HMC5983_H
#define PIOS_HMC5983_H

#include <pios.h>

/* HMC5983 Addresses */
#define PIOS_HMC5983_I2C_ADDR                   0x1E
#define PIOS_HMC5983_I2C_READ_ADDR              0x3D
#define PIOS_HMC5983_I2C_WRITE_ADDR             0x3C
#define PIOS_HMC5983_CONFIG_REG_A               (uint8_t)0x00
#define PIOS_HMC5983_CONFIG_REG_B               (uint8_t)0x01
#define PIOS_HMC5983_MODE_REG                   (uint8_t)0x02
#define PIOS_HMC5983_DATAOUT_XMSB_REG           0x03
#define PIOS_HMC5983_DATAOUT_XLSB_REG           0x04
#define PIOS_HMC5983_DATAOUT_ZMSB_REG           0x05
#define PIOS_HMC5983_DATAOUT_ZLSB_REG           0x06
#define PIOS_HMC5983_DATAOUT_YMSB_REG           0x07
#define PIOS_HMC5983_DATAOUT_YLSB_REG           0x08
#define PIOS_HMC5983_DATAOUT_STATUS_REG         0x09
#define PIOS_HMC5983_DATAOUT_IDA_REG            0x0A
#define PIOS_HMC5983_DATAOUT_IDB_REG            0x0B
#define PIOS_HMC5983_DATAOUT_IDC_REG            0x0C
#define PIOS_HMC5983_DATAOUT_TEMPMSB_REG        0x31
#define PIOS_HMC5983_DATAOUT_TEMPLSB_REG        0x32

/* Output Data Rate */
#define PIOS_HMC5983_ODR_0_75           0x00
#define PIOS_HMC5983_ODR_1_5            0x04
#define PIOS_HMC5983_ODR_3                      0x08
#define PIOS_HMC5983_ODR_7_5            0x0C
#define PIOS_HMC5983_ODR_15                     0x10
#define PIOS_HMC5983_ODR_30                     0x14
#define PIOS_HMC5983_ODR_75                     0x18
#define PIOS_HMC5983_ODR_220            0x1c

/* Measure configuration */
#define PIOS_HMC5983_MEASCONF_NORMAL            0x00
#define PIOS_HMC5983_MEASCONF_BIAS_POS          0x01
#define PIOS_HMC5983_MEASCONF_BIAS_NEG          0x02

/* Gain settings */
#define PIOS_HMC5983_GAIN_0_88                  0x00
#define PIOS_HMC5983_GAIN_1_3                   0x20
#define PIOS_HMC5983_GAIN_1_9                   0x40
#define PIOS_HMC5983_GAIN_2_5                   0x60
#define PIOS_HMC5983_GAIN_4_0                   0x80
#define PIOS_HMC5983_GAIN_4_7                   0xA0
#define PIOS_HMC5983_GAIN_5_6                   0xC0
#define PIOS_HMC5983_GAIN_8_1                   0xE0

/* Modes */
#define PIOS_HMC5983_MODE_CONTINUOUS    0x00
#define PIOS_HMC5983_MODE_SINGLE                0x01
#define PIOS_HMC5983_MODE_IDLE                  0x02
#define PIOS_HMC5983_MODE_SLEEP                 0x03

/* Sensitivity Conversion Values */
#define PIOS_HMC5983_Sensitivity_0_88Ga         1370    // LSB/Ga
#define PIOS_HMC5983_Sensitivity_1_3Ga          1090    // LSB/Ga
#define PIOS_HMC5983_Sensitivity_1_9Ga          820     // LSB/Ga
#define PIOS_HMC5983_Sensitivity_2_5Ga          660     // LSB/Ga
#define PIOS_HMC5983_Sensitivity_4_0Ga          440     // LSB/Ga
#define PIOS_HMC5983_Sensitivity_4_7Ga          390     // LSB/Ga
#define PIOS_HMC5983_Sensitivity_5_6Ga          330     // LSB/Ga
#define PIOS_HMC5983_Sensitivity_8_1Ga          230     // LSB/Ga  --> NOT RECOMMENDED

#define PIOS_HMC5983_AVERAGING_1                        0x00
#define PIOS_HMC5983_AVERAGING_2                        0x20
#define PIOS_HMC5983_AVERAGING_4                        0x40
#define PIOS_HMC5983_AVERAGING_8                        0x60

#define PIOS_HMC5983_READ_MODE                          0xC0
#define PIOS_HMC5983_ENABLE_TEMP_SENSOR         0x80

enum pios_hmc5983_orientation {
        // clockwise rotation from board forward while looking at top side
        // 0 degree is chip mark on upper left corner
        PIOS_HMC5983_TOP_0DEG,
        PIOS_HMC5983_TOP_90DEG,
        PIOS_HMC5983_TOP_180DEG,
        PIOS_HMC5983_TOP_270DEG,
        // clockwise rotation from board forward while looking at bottom side
        // 0 degree is chip mark on upper left corner
        PIOS_HMC5983_BOTTOM_0DEG,
        PIOS_HMC5983_BOTTOM_90DEG,
        PIOS_HMC5983_BOTTOM_180DEG,
        PIOS_HMC5983_BOTTOM_270DEG
};

struct pios_hmc5983_cfg {
        const struct pios_exti_cfg * exti_cfg; /* Pointer to the EXTI configuration */
        uint8_t M_ODR;          /* OUTPUT DATA RATE --> here below the relative define (See datasheet page 11 for more details) */
        uint8_t Meas_Conf;      /* Measurement Configuration,: Normal, positive bias, or negative bias --> here below the relative define */
        uint8_t Gain;           /* Gain Configuration, select the full scale --> here below the relative define (See datasheet page 11 for more details) */
        uint8_t Averaging;      /* Averaging configuration */
        uint8_t Mode;
        enum pios_hmc5983_orientation Orientation;
};

/* Public Functions */
extern int32_t PIOS_HMC5983_Init(pios_spi_t spi_id, uint32_t slave_num, const struct pios_hmc5983_cfg *cfg);
extern bool PIOS_HMC5983_IRQHandler(void);

#if defined(PIOS_INCLUDE_HMC5983_I2C)
int32_t PIOS_HMC5983_I2C_Init(pios_i2c_t i2c_id,
                const struct pios_hmc5983_cfg *cfg);
extern int32_t PIOS_HMC5983_Test(void);
extern int32_t PIOS_HMC5983_SetOrientation(enum pios_hmc5983_orientation orientation);
#endif /* PIOS_INCLUDE_HMC5983_I2C */


#endif /* PIOS_HMC5983_H */