driver_mag3110.h

Go to the documentation of this file.

 
#ifndef DRIVER_MAG3110_H
#define DRIVER_MAG3110_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    MAG3110_BOOL_FALSE = 0x00,        
    MAG3110_BOOL_TRUE  = 0x01,        
} mag3110_bool_t;

typedef enum
{
    MAG3110_STATUS_ZYX_OVERWRITE = (1 << 7),        
    MAG3110_STATUS_Z_OVERWRITE   = (1 << 6),        
    MAG3110_STATUS_Y_OVERWRITE   = (1 << 5),        
    MAG3110_STATUS_X_OVERWRITE   = (1 << 4),        
    MAG3110_STATUS_ZYX_READY     = (1 << 3),        
    MAG3110_STATUS_Z_READY       = (1 << 2),        
    MAG3110_STATUS_Y_READY       = (1 << 1),        
    MAG3110_STATUS_X_READY       = (1 << 0),        
} mag3110_status_t;

typedef enum
{
    MAG3110_MODE_STATUS_STANDBY        = 0x00,        
    MAG3110_MODE_STATUS_ACTIVE_RAW     = 0x01,        
    MAG3110_MODE_STATUS_ACTIVE_NON_RAW = 0x02,        
} mag3110_mode_status_t;

typedef enum
{
    MAG3110_MODE_STANDBY = 0x00,        
    MAG3110_MODE_ACTIVE  = 0x01,        
} mag3110_mode_t;

typedef enum
{
    MAG3110_RATE_80HZ_OVER_SAMPLE_16    = 0x00,        
    MAG3110_RATE_40HZ_OVER_SAMPLE_32    = 0x01,        
    MAG3110_RATE_20HZ_OVER_SAMPLE_64    = 0x02,        
    MAG3110_RATE_10HZ_OVER_SAMPLE_128   = 0x03,        
    MAG3110_RATE_40HZ_OVER_SAMPLE_16    = 0x04,        
    MAG3110_RATE_20HZ_OVER_SAMPLE_32    = 0x05,        
    MAG3110_RATE_10HZ_OVER_SAMPLE_64    = 0x06,        
    MAG3110_RATE_5HZ_OVER_SAMPLE_128    = 0x07,        
    MAG3110_RATE_20HZ_OVER_SAMPLE_16    = 0x08,        
    MAG3110_RATE_10HZ_OVER_SAMPLE_32    = 0x09,        
    MAG3110_RATE_5HZ_OVER_SAMPLE_64     = 0x0A,        
    MAG3110_RATE_2P5HZ_OVER_SAMPLE_128  = 0x0B,        
    MAG3110_RATE_10HZ_OVER_SAMPLE_16    = 0x0C,        
    MAG3110_RATE_5HZ_OVER_SAMPLE_32     = 0x0D,        
    MAG3110_RATE_2P5HZ_OVER_SAMPLE_64   = 0x0E,        
    MAG3110_RATE_1P25HZ_OVER_SAMPLE_128 = 0x0F,        
    MAG3110_RATE_5HZ_OVER_SAMPLE_16     = 0x10,        
    MAG3110_RATE_2P5HZ_OVER_SAMPLE_32   = 0x11,        
    MAG3110_RATE_1P25HZ_OVER_SAMPLE_64  = 0x12,        
    MAG3110_RATE_0P63HZ_OVER_SAMPLE_128 = 0x13,        
    MAG3110_RATE_2P5HZ_OVER_SAMPLE_16   = 0x14,        
    MAG3110_RATE_1P25HZ_OVER_SAMPLE_32  = 0x15,        
    MAG3110_RATE_0P63HZ_OVER_SAMPLE_64  = 0x16,        
    MAG3110_RATE_0P31HZ_OVER_SAMPLE_128 = 0x17,        
    MAG3110_RATE_1P25HZ_OVER_SAMPLE_16  = 0x18,        
    MAG3110_RATE_0P63HZ_OVER_SAMPLE_32  = 0x19,        
    MAG3110_RATE_0P31HZ_OVER_SAMPLE_64  = 0x1A,        
    MAG3110_RATE_0P16HZ_OVER_SAMPLE_128 = 0x1B,        
    MAG3110_RATE_0P63HZ_OVER_SAMPLE_16  = 0x1C,        
    MAG3110_RATE_0P31HZ_OVER_SAMPLE_32  = 0x1D,        
    MAG3110_RATE_0P16HZ_OVER_SAMPLE_64  = 0x1E,        
    MAG3110_RATE_0P08HZ_OVER_SAMPLE_128 = 0x1F,        
} mag3110_rate_over_sample_t;

typedef struct mag3110_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t inited;                                                                     
} mag3110_handle_t;

typedef struct mag3110_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} mag3110_info_t;



#define DRIVER_MAG3110_LINK_INIT(HANDLE, STRUCTURE)   memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_MAG3110_LINK_IIC_INIT(HANDLE, FUC)    (HANDLE)->iic_init = FUC

#define DRIVER_MAG3110_LINK_IIC_DEINIT(HANDLE, FUC)  (HANDLE)->iic_deinit = FUC

#define DRIVER_MAG3110_LINK_IIC_READ(HANDLE, FUC)    (HANDLE)->iic_read = FUC

#define DRIVER_MAG3110_LINK_IIC_WRITE(HANDLE, FUC)   (HANDLE)->iic_write = FUC

#define DRIVER_MAG3110_LINK_DELAY_MS(HANDLE, FUC)    (HANDLE)->delay_ms = FUC

#define DRIVER_MAG3110_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC



uint8_t mag3110_info(mag3110_info_t *info);

uint8_t mag3110_init(mag3110_handle_t *handle);

uint8_t mag3110_deinit(mag3110_handle_t *handle);

uint8_t mag3110_read(mag3110_handle_t *handle, int16_t raw[3], float ut[3]);

uint8_t mag3110_reset(mag3110_handle_t *handle);

uint8_t mag3110_read_die_temperature(mag3110_handle_t *handle, int8_t *raw, float *degree);

uint8_t mag3110_get_data_ready_status(mag3110_handle_t *handle, uint8_t *status);

uint8_t mag3110_get_mode_status(mag3110_handle_t *handle, mag3110_mode_status_t *mode);

uint8_t mag3110_set_offset_x(mag3110_handle_t *handle, uint16_t offset);

uint8_t mag3110_get_offset_x(mag3110_handle_t *handle, uint16_t *offset);

uint8_t mag3110_set_offset_y(mag3110_handle_t *handle, uint16_t offset);

uint8_t mag3110_get_offset_y(mag3110_handle_t *handle, uint16_t *offset);

uint8_t mag3110_set_offset_z(mag3110_handle_t *handle, uint16_t offset);

uint8_t mag3110_get_offset_z(mag3110_handle_t *handle, uint16_t *offset);

uint8_t mag3110_set_rate_over_sample(mag3110_handle_t *handle, mag3110_rate_over_sample_t rate_over_sample);

uint8_t mag3110_get_rate_over_sample(mag3110_handle_t *handle, mag3110_rate_over_sample_t *rate_over_sample);

uint8_t mag3110_set_fast_read_mode(mag3110_handle_t *handle, mag3110_bool_t enable);

uint8_t mag3110_get_fast_read_mode(mag3110_handle_t *handle, mag3110_bool_t *enable);

uint8_t mag3110_set_trigger_mode(mag3110_handle_t *handle, mag3110_bool_t enable);

uint8_t mag3110_get_trigger_mode(mag3110_handle_t *handle, mag3110_bool_t *enable);

uint8_t mag3110_set_mode(mag3110_handle_t *handle, mag3110_mode_t mode);

uint8_t mag3110_get_mode(mag3110_handle_t *handle, mag3110_mode_t *mode);

uint8_t mag3110_set_automatic_magnetic_sensor_reset(mag3110_handle_t *handle, mag3110_bool_t enable);

uint8_t mag3110_set_disable_offset_correction(mag3110_handle_t *handle, mag3110_bool_t enable);

uint8_t mag3110_get_disable_offset_correction(mag3110_handle_t *handle, mag3110_bool_t *enable);

uint8_t mag3110_offset_convert_to_register(mag3110_handle_t *handle, float ut, uint16_t *reg);

uint8_t mag3110_offset_convert_to_data(mag3110_handle_t *handle, uint16_t reg, float *ut);



uint8_t mag3110_set_reg(mag3110_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t mag3110_get_reg(mag3110_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif