Code formatted, minor fixes (#466)
This commit is contained in:
parent
8a474d749d
commit
5fa48d0298
28 changed files with 623 additions and 608 deletions
|
@ -52,24 +52,24 @@ static const float gain_values [] = {
|
|||
static float current_gain;
|
||||
static hmc5883l_operating_mode_t current_mode;
|
||||
|
||||
static inline void write_register(i2c_dev_t* dev, uint8_t reg, uint8_t val)
|
||||
static inline void write_register(i2c_dev_t *dev, uint8_t reg, uint8_t val)
|
||||
{
|
||||
i2c_slave_write(dev->bus, dev->addr, ®, &val, 1);
|
||||
}
|
||||
|
||||
static inline uint8_t read_register(i2c_dev_t* dev, uint8_t reg)
|
||||
static inline uint8_t read_register(i2c_dev_t *dev, uint8_t reg)
|
||||
{
|
||||
uint8_t res;
|
||||
i2c_slave_read(dev->bus, dev->addr, ®, &res, 1);
|
||||
return res;
|
||||
}
|
||||
|
||||
static inline void update_register(i2c_dev_t* dev, uint8_t reg, uint8_t mask, uint8_t val)
|
||||
static inline void update_register(i2c_dev_t *dev, uint8_t reg, uint8_t mask, uint8_t val)
|
||||
{
|
||||
write_register(dev, reg, (read_register(dev, reg) & mask) | val);
|
||||
}
|
||||
|
||||
bool hmc5883l_init(i2c_dev_t* dev)
|
||||
bool hmc5883l_init(i2c_dev_t *dev)
|
||||
{
|
||||
if (hmc5883l_get_id(dev) != HMC5883L_ID)
|
||||
return false;
|
||||
|
@ -78,7 +78,7 @@ bool hmc5883l_init(i2c_dev_t* dev)
|
|||
return true;
|
||||
}
|
||||
|
||||
uint32_t hmc5883l_get_id(i2c_dev_t* dev)
|
||||
uint32_t hmc5883l_get_id(i2c_dev_t *dev)
|
||||
{
|
||||
uint32_t res = 0;
|
||||
uint8_t reg = REG_ID_A;
|
||||
|
@ -86,70 +86,70 @@ uint32_t hmc5883l_get_id(i2c_dev_t* dev)
|
|||
return res;
|
||||
}
|
||||
|
||||
hmc5883l_operating_mode_t hmc5883l_get_operating_mode(i2c_dev_t* dev)
|
||||
hmc5883l_operating_mode_t hmc5883l_get_operating_mode(i2c_dev_t *dev)
|
||||
{
|
||||
uint8_t res = read_register(dev, REG_MODE) & MASK_MD;
|
||||
return res == 0 ? HMC5883L_MODE_CONTINUOUS : HMC5883L_MODE_SINGLE;
|
||||
}
|
||||
|
||||
void hmc5883l_set_operating_mode(i2c_dev_t* dev, hmc5883l_operating_mode_t mode)
|
||||
void hmc5883l_set_operating_mode(i2c_dev_t *dev, hmc5883l_operating_mode_t mode)
|
||||
{
|
||||
write_register(dev, REG_MODE, mode);
|
||||
current_mode = mode;
|
||||
}
|
||||
|
||||
hmc5883l_samples_averaged_t hmc5883l_get_samples_averaged(i2c_dev_t* dev)
|
||||
hmc5883l_samples_averaged_t hmc5883l_get_samples_averaged(i2c_dev_t *dev)
|
||||
{
|
||||
return (read_register(dev, REG_CR_A) & MASK_MA) >> BIT_MA;
|
||||
}
|
||||
|
||||
void hmc5883l_set_samples_averaged(i2c_dev_t* dev, hmc5883l_samples_averaged_t samples)
|
||||
void hmc5883l_set_samples_averaged(i2c_dev_t *dev, hmc5883l_samples_averaged_t samples)
|
||||
{
|
||||
update_register(dev, REG_CR_A, MASK_MA, samples << BIT_MA);
|
||||
}
|
||||
|
||||
hmc5883l_data_rate_t hmc5883l_get_data_rate(i2c_dev_t* dev)
|
||||
hmc5883l_data_rate_t hmc5883l_get_data_rate(i2c_dev_t *dev)
|
||||
{
|
||||
return (read_register(dev, REG_CR_A) & MASK_DO) >> BIT_DO;
|
||||
}
|
||||
|
||||
void hmc5883l_set_data_rate(i2c_dev_t* dev, hmc5883l_data_rate_t rate)
|
||||
void hmc5883l_set_data_rate(i2c_dev_t *dev, hmc5883l_data_rate_t rate)
|
||||
{
|
||||
update_register(dev, REG_CR_A, MASK_DO, rate << BIT_DO);
|
||||
}
|
||||
|
||||
hmc5883l_bias_t hmc5883l_get_bias(i2c_dev_t* dev)
|
||||
hmc5883l_bias_t hmc5883l_get_bias(i2c_dev_t *dev)
|
||||
{
|
||||
return read_register(dev, REG_CR_A) & MASK_MS;
|
||||
}
|
||||
|
||||
void hmc5883l_set_bias(i2c_dev_t* dev, hmc5883l_bias_t bias)
|
||||
void hmc5883l_set_bias(i2c_dev_t *dev, hmc5883l_bias_t bias)
|
||||
{
|
||||
update_register(dev, REG_CR_A, MASK_MS, bias);
|
||||
}
|
||||
|
||||
hmc5883l_gain_t hmc5883l_get_gain(i2c_dev_t* dev)
|
||||
hmc5883l_gain_t hmc5883l_get_gain(i2c_dev_t *dev)
|
||||
{
|
||||
return read_register(dev, REG_CR_B) >> BIT_GN;
|
||||
}
|
||||
|
||||
void hmc5883l_set_gain(i2c_dev_t* dev, hmc5883l_gain_t gain)
|
||||
void hmc5883l_set_gain(i2c_dev_t *dev, hmc5883l_gain_t gain)
|
||||
{
|
||||
write_register(dev, REG_CR_B, gain << BIT_GN);
|
||||
current_gain = gain_values[gain];
|
||||
}
|
||||
|
||||
bool hmc5883l_data_is_locked(i2c_dev_t* dev)
|
||||
bool hmc5883l_data_is_locked(i2c_dev_t *dev)
|
||||
{
|
||||
return read_register(dev, REG_STAT) & MASK_DL;
|
||||
}
|
||||
|
||||
bool hmc5883l_data_is_ready(i2c_dev_t* dev)
|
||||
bool hmc5883l_data_is_ready(i2c_dev_t *dev)
|
||||
{
|
||||
return read_register(dev, REG_STAT) & MASK_DR;
|
||||
}
|
||||
|
||||
bool hmc5883l_get_raw_data(i2c_dev_t* dev, hmc5883l_raw_data_t *data)
|
||||
bool hmc5883l_get_raw_data(i2c_dev_t *dev, hmc5883l_raw_data_t *data)
|
||||
{
|
||||
if (current_mode == HMC5883L_MODE_SINGLE)
|
||||
{
|
||||
|
@ -179,7 +179,7 @@ void hmc5883l_raw_to_mg(const hmc5883l_raw_data_t *raw, hmc5883l_data_t *mg)
|
|||
mg->z = raw->z * current_gain;
|
||||
}
|
||||
|
||||
bool hmc5883l_get_data(i2c_dev_t* dev, hmc5883l_data_t *data)
|
||||
bool hmc5883l_get_data(i2c_dev_t *dev, hmc5883l_data_t *data)
|
||||
{
|
||||
hmc5883l_raw_data_t raw;
|
||||
|
||||
|
|
|
@ -104,82 +104,82 @@ typedef struct
|
|||
* \brief Init device
|
||||
* \return false if error occured
|
||||
*/
|
||||
bool hmc5883l_init(i2c_dev_t* dev);
|
||||
bool hmc5883l_init(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Get device ID
|
||||
* Always returns 0x00333448 if IC functioning properly.
|
||||
* \return Device ID
|
||||
*/
|
||||
uint32_t hmc5883l_get_id(i2c_dev_t* dev);
|
||||
uint32_t hmc5883l_get_id(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Get operating mode
|
||||
* \return Measurement mode
|
||||
*/
|
||||
hmc5883l_operating_mode_t hmc5883l_get_operating_mode(i2c_dev_t* dev);
|
||||
hmc5883l_operating_mode_t hmc5883l_get_operating_mode(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Set operating mode
|
||||
* \param mode Measurement mode
|
||||
*/
|
||||
void hmc5883l_set_operating_mode(i2c_dev_t* dev, hmc5883l_operating_mode_t mode);
|
||||
void hmc5883l_set_operating_mode(i2c_dev_t *dev, hmc5883l_operating_mode_t mode);
|
||||
|
||||
/**
|
||||
* \brief Get number of samples averaged per measurement output
|
||||
* \return Number of samples
|
||||
*/
|
||||
hmc5883l_samples_averaged_t hmc5883l_get_samples_averaged(i2c_dev_t* dev);
|
||||
hmc5883l_samples_averaged_t hmc5883l_get_samples_averaged(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Set number of samples averaged per measurement output
|
||||
* \param samples Number of samples
|
||||
*/
|
||||
void hmc5883l_set_samples_averaged(i2c_dev_t* dev, hmc5883l_samples_averaged_t samples);
|
||||
void hmc5883l_set_samples_averaged(i2c_dev_t *dev, hmc5883l_samples_averaged_t samples);
|
||||
|
||||
/**
|
||||
* \brief Get data output rate in continuous measurement mode
|
||||
* \return Data output rate
|
||||
*/
|
||||
hmc5883l_data_rate_t hmc5883l_get_data_rate(i2c_dev_t* dev);
|
||||
hmc5883l_data_rate_t hmc5883l_get_data_rate(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Set data output rate in continuous measurement mode
|
||||
* \param rate Data output rate
|
||||
*/
|
||||
void hmc5883l_set_data_rate(i2c_dev_t* dev, hmc5883l_data_rate_t rate);
|
||||
void hmc5883l_set_data_rate(i2c_dev_t *dev, hmc5883l_data_rate_t rate);
|
||||
|
||||
/**
|
||||
* \brief Get measurement mode (bias of the axes)
|
||||
* See datasheet for self test description
|
||||
* \return Bias
|
||||
*/
|
||||
hmc5883l_bias_t hmc5883l_get_bias(i2c_dev_t* dev);
|
||||
hmc5883l_bias_t hmc5883l_get_bias(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Set measurement mode (bias of the axes)
|
||||
* See datasheet for self test description
|
||||
* \param bias Bias
|
||||
*/
|
||||
void hmc5883l_set_bias(i2c_dev_t* dev, hmc5883l_bias_t bias);
|
||||
void hmc5883l_set_bias(i2c_dev_t *dev, hmc5883l_bias_t bias);
|
||||
|
||||
/**
|
||||
* \brief Get device gain
|
||||
* \return Current gain
|
||||
*/
|
||||
hmc5883l_gain_t hmc5883l_get_gain(i2c_dev_t* dev);
|
||||
hmc5883l_gain_t hmc5883l_get_gain(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Set device gain
|
||||
* \param gain Gain
|
||||
*/
|
||||
void hmc5883l_set_gain(i2c_dev_t* dev, hmc5883l_gain_t gain);
|
||||
void hmc5883l_set_gain(i2c_dev_t *dev, hmc5883l_gain_t gain);
|
||||
|
||||
/**
|
||||
* \brief Get data state
|
||||
* \return true when data is written to all six data registers
|
||||
*/
|
||||
bool hmc5883l_data_is_ready(i2c_dev_t* dev);
|
||||
bool hmc5883l_data_is_ready(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Get lock state.
|
||||
|
@ -191,14 +191,14 @@ bool hmc5883l_data_is_ready(i2c_dev_t* dev);
|
|||
* 4. power is reset.
|
||||
* \return true when data registers is locked
|
||||
*/
|
||||
bool hmc5883l_data_is_locked(i2c_dev_t* dev);
|
||||
bool hmc5883l_data_is_locked(i2c_dev_t *dev);
|
||||
|
||||
/**
|
||||
* \brief Get raw magnetic data
|
||||
* \param data Pointer to the struct to write raw data
|
||||
* \return false if error occured in single measurement mode, always true in continuous mode
|
||||
*/
|
||||
bool hmc5883l_get_raw_data(i2c_dev_t* dev, hmc5883l_raw_data_t *data);
|
||||
bool hmc5883l_get_raw_data(i2c_dev_t *dev, hmc5883l_raw_data_t *data);
|
||||
|
||||
/**
|
||||
* \brief Convert raw magnetic data to milligausses
|
||||
|
@ -212,7 +212,7 @@ void hmc5883l_raw_to_mg(const hmc5883l_raw_data_t *raw, hmc5883l_data_t *mg);
|
|||
* \param data Pointer to the struct to write data
|
||||
* \return false if error occured in single measurement mode, always true in continuous mode
|
||||
*/
|
||||
bool hmc5883l_get_data(i2c_dev_t* dev, hmc5883l_data_t *data);
|
||||
bool hmc5883l_get_data(i2c_dev_t *dev, hmc5883l_data_t *data);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue