12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175 |
- /*
- ChibiOS - Copyright (C) 2016..2018 Rocco Marco Guglielmi
- This file is part of ChibiOS.
- ChibiOS 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.
- ChibiOS 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/>.
-
- */
- /**
- * @file lsm303dlhc.c
- * @brief LSM303DLHC MEMS interface module code.
- *
- * @addtogroup LSM303DLHC
- * @ingroup EX_ST
- * @{
- */
- #include "hal.h"
- #include "lsm303dlhc.h"
- /*===========================================================================*/
- /* Driver local definitions. */
- /*===========================================================================*/
- /*===========================================================================*/
- /* Driver exported variables. */
- /*===========================================================================*/
- /*===========================================================================*/
- /* Driver local variables and types. */
- /*===========================================================================*/
- /**
- * @brief Accelerometer and Compass Slave Address.
- */
- typedef enum {
- LSM303DLHC_SAD_ACC = 0x19, /**< SAD for accelerometer. */
- LSM303DLHC_SAD_COMP = 0x1E /**< SAD for compass. */
- } lsm303dlhc_sad_t;
- /*===========================================================================*/
- /* Driver local functions. */
- /*===========================================================================*/
- /**
- * @brief Reads registers value using I2C.
- * @pre The I2C interface must be initialized and the driver started.
- * @note IF_ADD_INC bit must be 1 in CTRL_REG8.
- *
- * @param[in] i2cp pointer to the I2C interface.
- * @param[in] sad slave address without R bit.
- * @param[in] reg first sub-register address.
- * @param[in] rxbuf receiving buffer.
- * @param[in] n size of rxbuf.
- * @return the operation status.
- */
- static msg_t lsm303dlhcI2CReadRegister(I2CDriver *i2cp, lsm303dlhc_sad_t sad,
- uint8_t reg, uint8_t *rxbuf, size_t n) {
- uint8_t txbuf = reg | LSM303DLHC_MS;
- return i2cMasterTransmitTimeout(i2cp, sad, &txbuf, 1, rxbuf, n,
- TIME_INFINITE);
- }
- /**
- * @brief Writes a value into a register using I2C.
- * @pre The I2C interface must be initialized and the driver started.
- *
- * @param[in] i2cp pointer to the I2C interface.
- * @param[in] sad slave address without R bit.
- * @param[in] txbuf buffer containing sub-address value in first position
- * and values to write.
- * @param[in] n size of txbuf less one (not considering the first
- * element).
- * @return the operation status.
- */
- static msg_t lsm303dlhcI2CWriteRegister(I2CDriver *i2cp, lsm303dlhc_sad_t sad,
- uint8_t *txbuf, size_t n) {
- if (n != 1)
- *txbuf |= LSM303DLHC_MS;
- return i2cMasterTransmitTimeout(i2cp, sad, txbuf, n + 1, NULL, 0,
- TIME_INFINITE);
- }
- /**
- * @brief Return the number of axes of the BaseAccelerometer.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- *
- * @return the number of axes.
- */
- static size_t acc_get_axes_number(void *ip) {
- (void)ip;
- return LSM303DLHC_ACC_NUMBER_OF_AXES;
- }
- /**
- * @brief Retrieves raw data from the BaseAccelerometer.
- * @note This data is retrieved from MEMS register without any algebraical
- * manipulation.
- * @note The axes array must be at least the same size of the
- * BaseAccelerometer axes number.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- * @param[out] axes a buffer which would be filled with raw data.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET if one or more I2C errors occurred, the errors can
- * be retrieved using @p i2cGetErrors().
- * @retval MSG_TIMEOUT if a timeout occurred before operation end.
- */
- static msg_t acc_read_raw(void *ip, int32_t axes[]) {
- LSM303DLHCDriver* devp;
- uint8_t buff [LSM303DLHC_ACC_NUMBER_OF_AXES * 2], i;
- int16_t tmp;
- msg_t msg;
- osalDbgCheck((ip != NULL) && (axes != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_read_raw(), invalid state");
- osalDbgAssert((devp->config->i2cp->state == I2C_READY),
- "acc_read_raw(), channel not ready");
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp,
- devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- msg = lsm303dlhcI2CReadRegister(devp->config->i2cp, LSM303DLHC_SAD_ACC,
- LSM303DLHC_AD_ACC_OUT_X_L, buff,
- LSM303DLHC_ACC_NUMBER_OF_AXES * 2);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg == MSG_OK)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- tmp = buff[2 * i] + (buff[2 * i + 1] << 8);
- axes[i] = (int32_t)tmp;
- }
- return msg;
- }
- /**
- * @brief Retrieves cooked data from the BaseAccelerometer.
- * @note This data is manipulated according to the formula
- * cooked = (raw * sensitivity) - bias.
- * @note Final data is expressed as milli-G.
- * @note The axes array must be at least the same size of the
- * BaseAccelerometer axes number.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- * @param[out] axes a buffer which would be filled with cooked data.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET if one or more I2C errors occurred, the errors can
- * be retrieved using @p i2cGetErrors().
- * @retval MSG_TIMEOUT if a timeout occurred before operation end.
- */
- static msg_t acc_read_cooked(void *ip, float axes[]) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- int32_t raw[LSM303DLHC_ACC_NUMBER_OF_AXES];
- msg_t msg;
- osalDbgCheck((ip != NULL) && (axes != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_read_cooked(), invalid state");
- msg = acc_read_raw(ip, raw);
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- axes[i] = (raw[i] * devp->accsensitivity[i]) - devp->accbias[i];
- }
- return msg;
- }
- /**
- * @brief Set bias values for the BaseAccelerometer.
- * @note Bias must be expressed as milli-G.
- * @note The bias buffer must be at least the same size of the
- * BaseAccelerometer axes number.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- * @param[in] bp a buffer which contains biases.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t acc_set_bias(void *ip, float *bp) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck((ip != NULL) && (bp != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_set_bias(), invalid state");
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- devp->accbias[i] = bp[i];
- }
- return msg;
- }
- /**
- * @brief Reset bias values for the BaseAccelerometer.
- * @note Default biases value are obtained from device datasheet when
- * available otherwise they are considered zero.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t acc_reset_bias(void *ip) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck(ip != NULL);
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_reset_bias(), invalid state");
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accbias[i] = LSM303DLHC_ACC_BIAS;
- return msg;
- }
- /**
- * @brief Set sensitivity values for the BaseAccelerometer.
- * @note Sensitivity must be expressed as milli-G/LSB.
- * @note The sensitivity buffer must be at least the same size of the
- * BaseAccelerometer axes number.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- * @param[in] sp a buffer which contains sensitivities.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t acc_set_sensivity(void *ip, float *sp) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgCheck((ip != NULL) && (sp != NULL));
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_set_sensivity(), invalid state");
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- devp->accsensitivity[i] = sp[i];
- }
- return msg;
- }
- /**
- * @brief Reset sensitivity values for the BaseAccelerometer.
- * @note Default sensitivities value are obtained from device datasheet.
- *
- * @param[in] ip pointer to @p BaseAccelerometer interface.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET otherwise.
- */
- static msg_t acc_reset_sensivity(void *ip) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck(ip != NULL);
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseAccelerometer*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_reset_sensivity(), invalid state");
- if(devp->config->accfullscale == LSM303DLHC_ACC_FS_2G)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_2G;
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_4G)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_4G;
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_8G)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_8G;
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_16G)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_16G;
- else {
- osalDbgAssert(FALSE, "acc_reset_sensivity(), accelerometer full scale issue");
- msg = MSG_RESET;
- }
- return msg;
- }
- /**
- * @brief Changes the LSM303DLHCDriver accelerometer fullscale value.
- * @note This function also rescale sensitivities and biases based on
- * previous and next fullscale value.
- * @note A recalibration is highly suggested after calling this function.
- *
- * @param[in] devp pointer to @p LSM303DLHCDriver interface.
- * @param[in] fs new fullscale value.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET otherwise.
- */
- static msg_t acc_set_full_scale(LSM303DLHCDriver *devp,
- lsm303dlhc_acc_fs_t fs) {
- float newfs, scale;
- uint8_t i, buff[2];
- msg_t msg;
- osalDbgCheck(devp != NULL);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "acc_set_full_scale(), invalid state");
- osalDbgAssert((devp->config->i2cp->state == I2C_READY),
- "acc_set_full_scale(), channel not ready");
- /* Computing new fullscale value.*/
- if(fs == LSM303DLHC_ACC_FS_2G) {
- newfs = LSM303DLHC_ACC_2G;
- }
- else if(fs == LSM303DLHC_ACC_FS_4G) {
- newfs = LSM303DLHC_ACC_4G;
- }
- else if(fs == LSM303DLHC_ACC_FS_8G) {
- newfs = LSM303DLHC_ACC_8G;
- }
- else if(fs == LSM303DLHC_ACC_FS_16G) {
- newfs = LSM303DLHC_ACC_16G;
- }
- else {
- msg = MSG_RESET;
- return msg;
- }
- if(newfs != devp->accfullscale) {
- /* Computing scale value.*/
- scale = newfs / devp->accfullscale;
- devp->accfullscale = newfs;
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp,
- devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- /* Updating register.*/
- msg = lsm303dlhcI2CReadRegister(devp->config->i2cp,
- LSM303DLHC_SAD_ACC,
- LSM303DLHC_AD_ACC_CTRL_REG4,
- &buff[1], 1);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg != MSG_OK)
- return msg;
- buff[1] &= ~(LSM303DLHC_CTRL_REG4_A_FS_MASK);
- buff[1] |= fs;
- buff[0] = LSM303DLHC_AD_ACC_CTRL_REG4;
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp, devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- msg = lsm303dlhcI2CWriteRegister(devp->config->i2cp,
- LSM303DLHC_SAD_ACC, buff, 1);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg != MSG_OK)
- return msg;
- /* Scaling sensitivity and bias. Re-calibration is suggested anyway.*/
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- devp->accsensitivity[i] *= scale;
- devp->accbias[i] *= scale;
- }
- }
- return msg;
- }
- /**
- * @brief Return the number of axes of the BaseCompass.
- *
- * @param[in] ip pointer to @p BaseCompass interface
- *
- * @return the number of axes.
- */
- static size_t comp_get_axes_number(void *ip) {
- osalDbgCheck(ip != NULL);
- return LSM303DLHC_COMP_NUMBER_OF_AXES;
- }
- /**
- * @brief Retrieves raw data from the BaseCompass.
- * @note This data is retrieved from MEMS register without any algebraical
- * manipulation.
- * @note The axes array must be at least the same size of the
- * BaseCompass axes number.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- * @param[out] axes a buffer which would be filled with raw data.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET if one or more I2C errors occurred, the errors can
- * be retrieved using @p i2cGetErrors().
- * @retval MSG_TIMEOUT if a timeout occurred before operation end.
- */
- static msg_t comp_read_raw(void *ip, int32_t axes[]) {
- LSM303DLHCDriver* devp;
- uint8_t buff [LSM303DLHC_COMP_NUMBER_OF_AXES * 2], i;
- int16_t tmp;
- msg_t msg;
- osalDbgCheck((ip != NULL) && (axes != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_read_raw(), invalid state");
- osalDbgAssert((devp->config->i2cp->state == I2C_READY),
- "comp_read_raw(), channel not ready");
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp,
- devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- msg = lsm303dlhcI2CReadRegister(devp->config->i2cp, LSM303DLHC_SAD_COMP,
- LSM303DLHC_AD_COMP_OUT_X_L, buff,
- LSM303DLHC_COMP_NUMBER_OF_AXES * 2);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg == MSG_OK)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- tmp = buff[2 * i] + (buff[2 * i + 1] << 8);
- axes[i] = (int32_t)tmp;
- }
- return msg;
- }
- /**
- * @brief Retrieves cooked data from the BaseCompass.
- * @note This data is manipulated according to the formula
- * cooked = (raw * sensitivity) - bias.
- * @note Final data is expressed as G.
- * @note The axes array must be at least the same size of the
- * BaseCompass axes number.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- * @param[out] axes a buffer which would be filled with cooked data.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET if one or more I2C errors occurred, the errors can
- * be retrieved using @p i2cGetErrors().
- * @retval MSG_TIMEOUT if a timeout occurred before operation end.
- */
- static msg_t comp_read_cooked(void *ip, float axes[]) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- int32_t raw[LSM303DLHC_COMP_NUMBER_OF_AXES];
- msg_t msg;
- osalDbgCheck((ip != NULL) && (axes != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_read_cooked(), invalid state");
- msg = comp_read_raw(ip, raw);
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES ; i++) {
- axes[i] = (raw[i] * devp->compsensitivity[i]) - devp->compbias[i];
- }
- return msg;
- }
- /**
- * @brief Set bias values for the BaseCompass.
- * @note Bias must be expressed as G.
- * @note The bias buffer must be at least the same size of the
- * BaseCompass axes number.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- * @param[in] bp a buffer which contains biases.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t comp_set_bias(void *ip, float *bp) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck((ip != NULL) && (bp != NULL));
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_set_bias(), invalid state");
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- devp->compbias[i] = bp[i];
- }
- return msg;
- }
- /**
- * @brief Reset bias values for the BaseCompass.
- * @note Default biases value are obtained from device datasheet when
- * available otherwise they are considered zero.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t comp_reset_bias(void *ip) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck(ip != NULL);
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_reset_bias(), invalid state");
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++)
- devp->compbias[i] = LSM303DLHC_COMP_BIAS;
- return msg;
- }
- /**
- * @brief Set sensitivity values for the BaseCompass.
- * @note Sensitivity must be expressed as G/LSB.
- * @note The sensitivity buffer must be at least the same size of the
- * BaseCompass axes number.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- * @param[in] sp a buffer which contains sensitivities.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- */
- static msg_t comp_set_sensivity(void *ip, float *sp) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgCheck((ip != NULL) && (sp != NULL));
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_set_sensivity(), invalid state");
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- devp->compsensitivity[i] = sp[i];
- }
- return msg;
- }
- /**
- * @brief Reset sensitivity values for the BaseCompass.
- * @note Default sensitivities value are obtained from device datasheet.
- *
- * @param[in] ip pointer to @p BaseCompass interface.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET otherwise.
- */
- static msg_t comp_reset_sensivity(void *ip) {
- LSM303DLHCDriver* devp;
- uint32_t i;
- msg_t msg = MSG_OK;
- osalDbgCheck(ip != NULL);
- /* Getting parent instance pointer.*/
- devp = objGetInstance(LSM303DLHCDriver*, (BaseCompass*)ip);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_reset_sensivity(), invalid state");
- if(devp->config->compfullscale == LSM303DLHC_COMP_FS_1P3GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_1P3GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_1P3GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_1P9GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_1P9GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_1P9GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_2P5GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_2P5GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_2P5GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_4P0GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_4P0GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_4P0GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_4P7GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_4P7GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_4P7GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_5P6GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_5P6GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_5P6GA;
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_8P1GA)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_8P1GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_8P1GA;
- }
- }
- else {
- osalDbgAssert(FALSE, "comp_reset_sensivity(), compass full scale issue");
- msg = MSG_RESET;
- }
- return msg;
- }
- /**
- * @brief Changes the LSM303DLHCDriver compass fullscale value.
- * @note This function also rescale sensitivities and biases based on
- * previous and next fullscale value.
- * @note A recalibration is highly suggested after calling this function.
- *
- * @param[in] devp pointer to @p LSM303DLHCDriver interface.
- * @param[in] fs new fullscale value.
- *
- * @return The operation status.
- * @retval MSG_OK if the function succeeded.
- * @retval MSG_RESET otherwise.
- */
- static msg_t comp_set_full_scale(LSM303DLHCDriver *devp,
- lsm303dlhc_comp_fs_t fs) {
- float newfs, scale;
- uint8_t i, buff[2];
- msg_t msg;
- osalDbgCheck(devp != NULL);
- osalDbgAssert((devp->state == LSM303DLHC_READY),
- "comp_set_full_scale(), invalid state");
- osalDbgAssert((devp->config->i2cp->state == I2C_READY),
- "comp_set_full_scale(), channel not ready");
- /* Computing new fullscale value.*/
- if(fs == LSM303DLHC_COMP_FS_1P3GA) {
- newfs = LSM303DLHC_COMP_1P3GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_1P9GA) {
- newfs = LSM303DLHC_COMP_1P9GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_2P5GA) {
- newfs = LSM303DLHC_COMP_2P5GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_4P0GA) {
- newfs = LSM303DLHC_COMP_4P0GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_4P7GA) {
- newfs = LSM303DLHC_COMP_4P7GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_5P6GA) {
- newfs = LSM303DLHC_COMP_5P6GA;
- }
- else if(fs == LSM303DLHC_COMP_FS_8P1GA) {
- newfs = LSM303DLHC_COMP_8P1GA;
- }
- else {
- msg = MSG_RESET;
- return msg;
- }
- if(newfs != devp->compfullscale) {
- /* Computing scale value.*/
- scale = newfs / devp->compfullscale;
- devp->compfullscale = newfs;
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp, devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- /* Updating register.*/
- msg = lsm303dlhcI2CReadRegister(devp->config->i2cp, LSM303DLHC_SAD_COMP,
- LSM303DLHC_AD_COMP_CRB_REG, &buff[1], 1);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg != MSG_OK)
- return msg;
- buff[1] &= ~(LSM303DLHC_CRB_REG_M_GN_MASK);
- buff[1] |= fs;
- buff[0] = LSM303DLHC_AD_COMP_CRB_REG;
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus(devp->config->i2cp);
- i2cStart(devp->config->i2cp, devp->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- msg = lsm303dlhcI2CWriteRegister(devp->config->i2cp, LSM303DLHC_SAD_COMP,
- buff, 1);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus(devp->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(msg != MSG_OK)
- return msg;
- /* Scaling sensitivity and bias. Re-calibration is suggested anyway.*/
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- devp->compsensitivity[i] *= scale;
- devp->compbias[i] *= scale;
- }
- }
- return msg;
- }
- static const struct LSM303DLHCVMT vmt_device = {
- (size_t)0,
- acc_set_full_scale, comp_set_full_scale
- };
- static const struct BaseAccelerometerVMT vmt_accelerometer = {
- sizeof(struct LSM303DLHCVMT*),
- acc_get_axes_number, acc_read_raw, acc_read_cooked,
- acc_set_bias, acc_reset_bias, acc_set_sensivity, acc_reset_sensivity
- };
- static const struct BaseCompassVMT vmt_compass = {
- sizeof(struct LSM303DLHCVMT*) + sizeof(BaseAccelerometer),
- comp_get_axes_number, comp_read_raw, comp_read_cooked,
- comp_set_bias, comp_reset_bias, comp_set_sensivity, comp_reset_sensivity
- };
- /*===========================================================================*/
- /* Driver exported functions. */
- /*===========================================================================*/
- /**
- * @brief Initializes an instance.
- *
- * @param[out] devp pointer to the @p LSM303DLHCDriver object
- *
- * @init
- */
- void lsm303dlhcObjectInit(LSM303DLHCDriver *devp) {
- devp->vmt = &vmt_device;
- devp->acc_if.vmt = &vmt_accelerometer;
- devp->comp_if.vmt = &vmt_compass;
- devp->config = NULL;
- devp->accaxes = LSM303DLHC_ACC_NUMBER_OF_AXES;
- devp->compaxes = LSM303DLHC_COMP_NUMBER_OF_AXES;
- devp->state = LSM303DLHC_STOP;
- }
- /**
- * @brief Configures and activates LSM303DLHC Complex Driver peripheral.
- *
- * @param[in] devp pointer to the @p LSM303DLHCDriver object
- * @param[in] config pointer to the @p LSM303DLHCConfig object
- *
- * @api
- */
- void lsm303dlhcStart(LSM303DLHCDriver *devp, const LSM303DLHCConfig *config) {
- uint32_t i;
- uint8_t cr[6];
- osalDbgCheck((devp != NULL) && (config != NULL));
- osalDbgAssert((devp->state == LSM303DLHC_STOP) ||
- (devp->state == LSM303DLHC_READY),
- "lsm303dlhcStart(), invalid state");
- devp->config = config;
- /* Configuring Accelerometer subsystem.*/
- /* Multiple write starting address.*/
- cr[0] = LSM303DLHC_AD_ACC_CTRL_REG1;
- /* Control register 1 configuration block.*/
- {
- cr[1] = LSM303DLHC_CTRL_REG1_A_XEN | LSM303DLHC_CTRL_REG1_A_YEN |
- LSM303DLHC_CTRL_REG1_A_ZEN | devp->config->accoutdatarate;
- #if LSM303DLHC_USE_ADVANCED || defined(__DOXYGEN__)
- cr[1] |= devp->config->acclowpower;
- #endif
- }
- /* Control register 2 configuration block.*/
- {
- cr[2] = 0;
- }
- /* Control register 3 configuration block.*/
- {
- cr[3] = 0;
- }
- /* Control register 4 configuration block.*/
- {
- cr[4] = devp->config->accfullscale;
- #if LSM303DLHC_USE_ADVANCED || defined(__DOXYGEN__)
- cr[4] |= devp->config->accendianess |
- devp->config->accblockdataupdate |
- devp->config->acchighresmode;
- #endif
- }
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus((devp)->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- i2cStart((devp)->config->i2cp, (devp)->config->i2ccfg);
- lsm303dlhcI2CWriteRegister(devp->config->i2cp, LSM303DLHC_SAD_ACC, cr, 4);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus((devp)->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- /* Storing sensitivity according to user settings */
- if(devp->config->accfullscale == LSM303DLHC_ACC_FS_2G) {
- devp->accfullscale = LSM303DLHC_ACC_2G;
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- if(devp->config->accsensitivity == NULL)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_2G;
- else
- devp->accsensitivity[i] = devp->config->accsensitivity[i];
- }
- }
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_4G) {
- devp->accfullscale = LSM303DLHC_ACC_4G;
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- if(devp->config->accsensitivity == NULL)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_4G;
- else
- devp->accsensitivity[i] = devp->config->accsensitivity[i];
- }
- }
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_8G) {
- devp->accfullscale = LSM303DLHC_ACC_8G;
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- if(devp->config->accsensitivity == NULL)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_8G;
- else
- devp->accsensitivity[i] = devp->config->accsensitivity[i];
- }
- }
- else if(devp->config->accfullscale == LSM303DLHC_ACC_FS_16G) {
- devp->accfullscale = LSM303DLHC_ACC_16G;
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++) {
- if(devp->config->accsensitivity == NULL)
- devp->accsensitivity[i] = LSM303DLHC_ACC_SENS_16G;
- else
- devp->accsensitivity[i] = devp->config->accsensitivity[i];
- }
- }
- else
- osalDbgAssert(FALSE, "lsm303dlhcStart(), accelerometer full scale issue");
- /* Storing bias information */
- if(devp->config->accbias != NULL)
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accbias[i] = devp->config->accbias[i];
- else
- for(i = 0; i < LSM303DLHC_ACC_NUMBER_OF_AXES; i++)
- devp->accbias[i] = LSM303DLHC_ACC_BIAS;
- /* Configuring Compass subsystem */
- /* Multiple write starting address.*/
- cr[0] = LSM303DLHC_AD_COMP_CRA_REG;
- /* Control register A configuration block.*/
- {
- cr[1] = devp->config->compoutputdatarate;
- }
- /* Control register B configuration block.*/
- {
- cr[2] = devp->config->compfullscale;
- }
- /* Mode register configuration block.*/
- {
- cr[3] = 0;
- #if LSM303DLHC_USE_ADVANCED || defined(__DOXYGEN__)
- cr[3] |= devp->config->compmode;
- #endif
- }
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus((devp)->config->i2cp);
- i2cStart((devp)->config->i2cp, (devp)->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- lsm303dlhcI2CWriteRegister(devp->config->i2cp, LSM303DLHC_SAD_COMP,
- cr, 3);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus((devp)->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- if(devp->config->compfullscale == LSM303DLHC_COMP_FS_1P3GA) {
- devp->compfullscale = LSM303DLHC_COMP_1P3GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_1P3GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_1P3GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_1P9GA) {
- devp->compfullscale = LSM303DLHC_COMP_1P9GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_1P9GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_1P9GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_2P5GA) {
- devp->compfullscale = LSM303DLHC_COMP_2P5GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_2P5GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_2P5GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_4P0GA) {
- devp->compfullscale = LSM303DLHC_COMP_4P0GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_4P0GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_4P0GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_4P7GA) {
- devp->compfullscale = LSM303DLHC_COMP_4P7GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_4P7GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_4P7GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_5P6GA) {
- devp->compfullscale = LSM303DLHC_COMP_5P6GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_5P6GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_5P6GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else if(devp->config->compfullscale == LSM303DLHC_COMP_FS_8P1GA) {
- devp->compfullscale = LSM303DLHC_COMP_8P1GA;
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++) {
- if(devp->config->compsensitivity == NULL) {
- if(i != 2) {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_XY_8P1GA;
- }
- else {
- devp->compsensitivity[i] = LSM303DLHC_COMP_SENS_Z_8P1GA;
- }
- }
- else {
- devp->compsensitivity[i] = devp->config->compsensitivity[i];
- }
- }
- }
- else
- osalDbgAssert(FALSE, "lsm303dlhcStart(), compass full scale issue");
- /* Storing bias information */
- if(devp->config->compbias != NULL)
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++)
- devp->compbias[i] = devp->config->compbias[i];
- else
- for(i = 0; i < LSM303DLHC_COMP_NUMBER_OF_AXES; i++)
- devp->compbias[i] = LSM303DLHC_COMP_BIAS;
- /* This is the MEMS transient recovery time */
- osalThreadSleepMilliseconds(5);
- devp->state = LSM303DLHC_READY;
- }
- /**
- * @brief Deactivates the LSM303DLHC Complex Driver peripheral.
- *
- * @param[in] devp pointer to the @p LSM303DLHCDriver object
- *
- * @api
- */
- void lsm303dlhcStop(LSM303DLHCDriver *devp) {
- uint8_t cr[2];
- osalDbgCheck(devp != NULL);
- osalDbgAssert((devp->state == LSM303DLHC_STOP) ||
- (devp->state == LSM303DLHC_READY),
- "lsm303dlhcStop(), invalid state");
- if (devp->state == LSM303DLHC_READY) {
- #if LSM303DLHC_SHARED_I2C
- i2cAcquireBus((devp)->config->i2cp);
- i2cStart((devp)->config->i2cp, (devp)->config->i2ccfg);
- #endif /* LSM303DLHC_SHARED_I2C */
- /* Disabling accelerometer. */
- cr[0] = LSM303DLHC_AD_ACC_CTRL_REG1;
- cr[1] = LSM303DLHC_ACC_AE_DISABLED | LSM303DLHC_ACC_ODR_PD;
- lsm303dlhcI2CWriteRegister(devp->config->i2cp, LSM303DLHC_SAD_ACC,
- cr, 1);
- /* Disabling compass. */
- cr[0] = LSM303DLHC_AD_COMP_MR_REG;
- cr[1] = LSM303DLHC_COMP_MD_SLEEP;
- lsm303dlhcI2CWriteRegister(devp->config->i2cp, LSM303DLHC_SAD_COMP,
- cr, 1);
- i2cStop((devp)->config->i2cp);
- #if LSM303DLHC_SHARED_I2C
- i2cReleaseBus((devp)->config->i2cp);
- #endif /* LSM303DLHC_SHARED_I2C */
- }
- devp->state = LSM303DLHC_STOP;
- }
- /** @} */
|