qmc5883l.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2019 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"

#define QMC5883L_ADDR           (0x0d)

enum {
    QMC5883L_OK,            
    QMC5883L_NODATA,        
    QMC5883L_OVERFLOW,      
    QMC5883L_BUSERR,        
    QMC5883L_NOCFG,         
};

typedef enum {
    QMC5883L_ODR_10HZ  = (0u << 2),     
    QMC5883L_ODR_50HZ  = (1u << 2),     
    QMC5883L_ODR_100HZ = (2u << 2),     
    QMC5883L_ODR_200HZ = (3u << 2),     
} qmc5883l_odr_t;

typedef enum {
    QMC5883L_RNG_2G = (0u << 4),        
    QMC5883L_RNG_8G = (1u << 4),        
} qmc5883l_rng_t;

typedef enum {
    QMC5883L_OSR_512 = (0u << 6),       
    QMC5883L_OSR_256 = (1u << 6),       
    QMC5883L_OSR_128 = (2u << 6),       
    QMC5883L_OSR_64  = (3u << 6),       
} qmc5883l_osr_t;

typedef struct {
    i2c_t i2c;              
    gpio_t pin_drdy;        
    qmc5883l_odr_t odr;     
    qmc5883l_rng_t rng;     
    qmc5883l_osr_t osr;     
} qmc5883l_params_t;

typedef struct {
    i2c_t i2c;              
    gpio_t pin_drdy;        
    uint8_t cfg;            
} qmc5883l_t;

int qmc5883l_init(qmc5883l_t *dev, const qmc5883l_params_t *params);

int qmc5883l_data_ready(const qmc5883l_t *dev);

int qmc5883l_read(const qmc5883l_t *dev, int16_t *data_out);

int qmc5883l_read_raw(const qmc5883l_t *dev, int16_t *data_out);

int qmc5883l_poweron(const qmc5883l_t *dev);

int qmc5883l_poweroff(const qmc5883l_t *dev);
 
#if defined(MODULE_QMC5883L_INT) || defined(DOXYGEN)

int qmc5883l_init_int(const qmc5883l_t *dev, gpio_cb_t cb, void *arg);

int qmc5883l_irq_enable(const qmc5883l_t *dev);

int qmc5883l_irq_disable(const qmc5883l_t *dev);
#endif /* defined(MODULE_QMC5883L_INT) || defined(DOXYGEN) */
 
#ifdef __cplusplus
}
#endif