driver_bmm150.h

Go to the documentation of this file.

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



typedef enum
{
    BMM150_INTERFACE_IIC = 0x00,        
    BMM150_INTERFACE_SPI = 0x01,        
} bmm150_interface_t;

typedef enum
{
    BMM150_ADDRESS_CSB_SDO_00 = (0x10 << 1),        
    BMM150_ADDRESS_CSB_SDO_01 = (0x11 << 1),        
    BMM150_ADDRESS_CSB_SDO_10 = (0x12 << 1),        
    BMM150_ADDRESS_CSB_SDO_11 = (0x13 << 1),        
} bmm150_address_t;

typedef enum
{
    BMM150_BOOL_FALSE = 0x00,        
    BMM150_BOOL_TRUE  = 0x01,        
} bmm150_bool_t;

typedef enum
{
    BMM150_INTERRUPT_STATUS_DATA_OVERRUN     = 7,        
    BMM150_INTERRUPT_STATUS_OVERFLOW         = 6,        
    BMM150_INTERRUPT_STATUS_HIGH_THRESHOLD_Z = 5,        
    BMM150_INTERRUPT_STATUS_HIGH_THRESHOLD_Y = 4,        
    BMM150_INTERRUPT_STATUS_HIGH_THRESHOLD_X = 3,        
    BMM150_INTERRUPT_STATUS_LOW_THRESHOLD_Z  = 2,        
    BMM150_INTERRUPT_STATUS_LOW_THRESHOLD_Y  = 1,        
    BMM150_INTERRUPT_STATUS_LOW_THRESHOLD_X  = 0,        
} bmm150_interrupt_status_t;

typedef enum
{
    BMM150_SPI_WIRE_4 = 0x00,        
    BMM150_SPI_WIRE_3 = 0x01,        
} bmm150_spi_wire_t;

typedef enum
{
    BMM150_ADVANCED_SELF_TEST_NORMAL   = 0x00,        
    BMM150_ADVANCED_SELF_TEST_NEGATIVE = 0x02,        
    BMM150_ADVANCED_SELF_TEST_POSITIVE = 0x03,        
} bmm150_advanced_self_test_t;

typedef enum
{
    BMM150_DATA_RATE_10HZ = 0x00,        
    BMM150_DATA_RATE_2HZ  = 0x01,        
    BMM150_DATA_RATE_6HZ  = 0x02,        
    BMM150_DATA_RATE_8HZ  = 0x03,        
    BMM150_DATA_RATE_15HZ = 0x04,        
    BMM150_DATA_RATE_20HZ = 0x05,        
    BMM150_DATA_RATE_25HZ = 0x06,        
    BMM150_DATA_RATE_30HZ = 0x07,        
} bmm150_data_rate_t;

typedef enum
{
    BMM150_MODE_NORMAL = 0x00,        
    BMM150_MODE_FORCED = 0x01,        
    BMM150_MODE_SLEEP  = 0x03,        
} bmm150_mode_t;

typedef enum
{
    BMM150_DATA_READY_PIN_POLARITY_LOW  = 0x00,        
    BMM150_DATA_READY_PIN_POLARITY_HIGH = 0x01,        
} bmm150_data_ready_pin_polarity_t;

typedef enum
{
    BMM150_INTERRUPT_PIN_POLARITY_LOW  = 0x00,        
    BMM150_INTERRUPT_PIN_POLARITY_HIGH = 0x01,        
} bmm150_interrupt_pin_polarity_t;

typedef struct bmm150_handle_s
{
    uint8_t iic_addr;                                                                   
    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);        
    uint8_t (*spi_init)(void);                                                          
    uint8_t (*spi_deinit)(void);                                                        
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);                       
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);                      
    void (*receive_callback)(uint8_t type);                                             
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t inited;                                                                     
    uint8_t iic_spi;                                                                    
    int8_t dig_x1;                                                                      
    int8_t dig_y1;                                                                      
    int8_t dig_x2;                                                                      
    int8_t dig_y2;                                                                      
    uint16_t dig_z1;                                                                    
    int16_t dig_z2;                                                                     
    int16_t dig_z3;                                                                     
    int16_t dig_z4;                                                                     
    uint8_t dig_xy1;                                                                    
    int8_t dig_xy2;                                                                     
    uint16_t dig_xyz1;                                                                  
} bmm150_handle_t;

typedef struct bmm150_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;           
} bmm150_info_t;



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

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

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

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

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

#define DRIVER_BMM150_LINK_SPI_INIT(HANDLE, FUC)          (HANDLE)->spi_init = FUC

#define DRIVER_BMM150_LINK_SPI_DEINIT(HANDLE, FUC)        (HANDLE)->spi_deinit = FUC

#define DRIVER_BMM150_LINK_SPI_READ(HANDLE, FUC)          (HANDLE)->spi_read = FUC

#define DRIVER_BMM150_LINK_SPI_WRITE(HANDLE, FUC)         (HANDLE)->spi_write = FUC

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

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

#define DRIVER_BMM150_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC



uint8_t bmm150_info(bmm150_info_t *info);

uint8_t bmm150_set_interface(bmm150_handle_t *handle, bmm150_interface_t interface);

uint8_t bmm150_get_interface(bmm150_handle_t *handle, bmm150_interface_t *interface);

uint8_t bmm150_set_addr_pin(bmm150_handle_t *handle, bmm150_address_t addr_pin);

uint8_t bmm150_get_addr_pin(bmm150_handle_t *handle, bmm150_address_t *addr_pin);

uint8_t bmm150_irq_handler(bmm150_handle_t *handle);

uint8_t bmm150_init(bmm150_handle_t *handle);

uint8_t bmm150_deinit(bmm150_handle_t *handle);

uint8_t bmm150_read(bmm150_handle_t *handle, int16_t raw[3], float ut[3]);

uint8_t bmm150_get_self_test_x(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_get_self_test_y(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_get_self_test_z(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_get_data_ready_status(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_get_interrupt_status(bmm150_handle_t *handle, bmm150_interrupt_status_t status, bmm150_bool_t *enable);

uint8_t bmm150_soft_reset(bmm150_handle_t *handle);

uint8_t bmm150_set_power_on(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_power_on(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_spi_wire(bmm150_handle_t *handle, bmm150_spi_wire_t wire);

uint8_t bmm150_get_spi_wire(bmm150_handle_t *handle, bmm150_spi_wire_t *wire);

uint8_t bmm150_set_advanced_self_test(bmm150_handle_t *handle, bmm150_advanced_self_test_t test);

uint8_t bmm150_get_advanced_self_test(bmm150_handle_t *handle, bmm150_advanced_self_test_t *test);

uint8_t bmm150_set_data_rate(bmm150_handle_t *handle, bmm150_data_rate_t rate);

uint8_t bmm150_get_data_rate(bmm150_handle_t *handle, bmm150_data_rate_t *rate);

uint8_t bmm150_set_mode(bmm150_handle_t *handle, bmm150_mode_t mode);

uint8_t bmm150_get_mode(bmm150_handle_t *handle, bmm150_mode_t *mode);

uint8_t bmm150_set_self_test(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_self_test(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_interrupt(bmm150_handle_t *handle, bmm150_interrupt_status_t status, bmm150_bool_t enable);

uint8_t bmm150_get_interrupt(bmm150_handle_t *handle, bmm150_interrupt_status_t status, bmm150_bool_t *enable);

uint8_t bmm150_set_data_ready_pin(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_data_ready_pin(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_interrupt_pin(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_interrupt_pin(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_channel_z(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_channel_z(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_channel_y(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_channel_y(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_channel_x(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_channel_x(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_data_ready_pin_polarity(bmm150_handle_t *handle, bmm150_data_ready_pin_polarity_t polarity);

uint8_t bmm150_get_data_ready_pin_polarity(bmm150_handle_t *handle, bmm150_data_ready_pin_polarity_t *polarity);

uint8_t bmm150_set_interrupt_latch(bmm150_handle_t *handle, bmm150_bool_t enable);

uint8_t bmm150_get_interrupt_latch(bmm150_handle_t *handle, bmm150_bool_t *enable);

uint8_t bmm150_set_interrupt_pin_polarity(bmm150_handle_t *handle, bmm150_interrupt_pin_polarity_t polarity);

uint8_t bmm150_get_interrupt_pin_polarity(bmm150_handle_t *handle, bmm150_interrupt_pin_polarity_t *polarity);

uint8_t bmm150_set_low_threshold(bmm150_handle_t *handle, int8_t threshold);

uint8_t bmm150_get_low_threshold(bmm150_handle_t *handle, int8_t *threshold);

uint8_t bmm150_set_high_threshold(bmm150_handle_t *handle, int8_t threshold);

uint8_t bmm150_get_high_threshold(bmm150_handle_t *handle, int8_t *threshold);

uint8_t bmm150_set_repxy_number(bmm150_handle_t *handle, uint8_t number);

uint8_t bmm150_get_repxy_number(bmm150_handle_t *handle, uint8_t *number);

uint8_t bmm150_set_repz_number(bmm150_handle_t *handle, uint8_t number);

uint8_t bmm150_get_repz_number(bmm150_handle_t *handle, uint8_t *number);

uint8_t bmm150_interrupt_threshold_convert_to_register(bmm150_handle_t *handle, float ut, int8_t *reg);

uint8_t bmm150_interrupt_threshold_convert_to_data(bmm150_handle_t *handle, int8_t reg, float *ut);



uint8_t bmm150_set_reg(bmm150_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t bmm150_get_reg(bmm150_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif