/source/alld_at42qt1050.c - Annotate - AMiRo-OS - Research for Cognitive Interaction

amiro-lld / source / alld_at42qt1050.c @ ef078306

History | View | Annotate | Download (7.525 KB)

-e45662e
+/*
 AMiRo-LLD is a compilation of low-level hardware drivers for the Autonomous Mini Robot (AMiRo) platform.
 Copyright (C) 2016..2019  Thomas Schöpping et al.
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 This program 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 Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 /**
  * @file    alld_at42qt1050.c
  * @brief   Touch sensor function implementations.
+ *
  * @addtogroup lld_touch
  * @{
  */
 #include <alld_at42qt1050.h>
 #if defined(AMIROLLD_CFG_USE_AT42QT1050) || defined(__DOXYGEN__)
 #include <math.h>
-            ef078306
+/******************************************************************************/
 /* LOCAL DEFINITIONS                                                          */
 /******************************************************************************/
 /******************************************************************************/
 /* EXPORTED VARIABLES                                                         */
 /******************************************************************************/
 /******************************************************************************/
 /* LOCAL TYPES                                                                */
 /******************************************************************************/
 /******************************************************************************/
 /* LOCAL VARIABLES                                                            */
 /******************************************************************************/
 /******************************************************************************/
 /* LOCAL FUNCTIONS                                                            */
 /******************************************************************************/
 /******************************************************************************/
 /* EXPORTED FUNCTIONS                                                         */
 /******************************************************************************/
-e45662e
+/**
  * @brief   Read 8bit data from any register.
+ *
  * @param[in]   at42qt1050d   The AT42QT1050 driver to use.
  * @param[in]   reg           Register address to read from.
  * @param[out]  data          Pointer to store the register data to.
  * @param[in]   timeout       Timeout for the function to return (in microseconds).
+ *
  * @return    Indicator whether the function call was successful or a timeout occurred.
  */
 inline apalExitStatus_t
 at42qt1050_lld_read_reg(const AT42QT1050Driver* at42qt1050d, const at42qt1050_lld_register_t reg, uint8_t* const data, const apalTime_t timeout)
+{
   apalDbgAssert(at42qt1050d != NULL && at42qt1050d->i2cd != NULL);
   apalDbgAssert(data != NULL);
   const uint8_t txbuf = (uint8_t)reg;
   return apalI2CMasterTransmit(at42qt1050d->i2cd, at42qt1050d->addr, &txbuf, 1, data, 1, timeout);
+}
 /**
  * @brief   Write 8bit data to any (writable) register.
+ *
  * @param[in]   at42qt1050d   The AT42QT1050 driver to use.
  * @param[in]   reg           Register address to write to.
  * @param[in]   data          Data to transmit.
  * @param[in]   timeout       Timeout for the function to return (in microseconds).
+ *
  * @return    Indicator whether the function call was successful or a timeout occurred.
  */
 inline apalExitStatus_t
 at42qt1050_lld_write_reg(const AT42QT1050Driver* at42qt1050d, const at42qt1050_lld_register_t reg, const uint8_t data, const apalTime_t timeout)
+{
   apalDbgAssert(at42qt1050d != NULL && at42qt1050d->i2cd != NULL);
   const uint8_t txbuf[2] = { (uint8_t)reg, data };
   return apalI2CMasterTransmit(at42qt1050d->i2cd, at42qt1050d->addr, txbuf, 2, NULL, 0, timeout);
+}
 /**
  * @brief   Read signal information of a key.
+ *
  * @param[in]   at42qt1050d   The AT42QT1050 driver to use.
  * @param[in]   key           Key to read the signal information of.
  * @param[out]  signal        Pointer to store the data to.
  * @param[in]   timeout       Timeout for the function to return (in microseconds).
+ *
  * @return    Indicator whether the function call was successful or a timeout occurred.
  */
 inline apalExitStatus_t
 at42qt1050_lld_read_keyssignal(const AT42QT1050Driver* at42qt1050d, const uint8_t key, uint16_t* signal, const apalTime_t timeout)
+{
   apalDbgAssert(at42qt1050d != NULL && at42qt1050d->i2cd != NULL);
   apalDbgAssert(key < AT42QT1050_LLD_NUM_KEYS);
   apalDbgAssert(signal != NULL);
   const uint8_t txbuf = AT42QT1050_LLD_REG_KEYSIGNAL_0 + (2*key) + ((key > 1) ? 1 : 0);
   uint8_t rxbuf[2];
   const apalExitStatus_t status = apalI2CMasterTransmit(at42qt1050d->i2cd, at42qt1050d->addr, &txbuf, 1, rxbuf, 2, timeout);
   *signal = (rxbuf[0] << 8) | rxbuf[1];
   return status;
+}
 /**
  * @brief   Read reference data of a key.
+ *
  * @param[in]   at42qt1050d   The AT42QT1050 driver to use.
  * @param[in]   key           Key to read the signal information of.
  * @param[out]  refdata       Pointer to store the data to.
  * @param[in]   timeout       Timeout for the function to return (in microseconds).
+ *
  * @return    Indicator whether the function call was successful or a timeout occurred.
  */
 inline apalExitStatus_t
 at42qt1050_lld_read_referencedata(const AT42QT1050Driver* at42qt1050d, const uint8_t key, uint16_t* refdata, const apalTime_t timeout)
+{
   apalDbgAssert(at42qt1050d != NULL && at42qt1050d->i2cd != NULL);
   apalDbgAssert(key < AT42QT1050_LLD_NUM_KEYS);
   apalDbgAssert(refdata != NULL);
   const uint8_t txbuf = AT42QT1050_LLD_REG_REFERENCEDATA_0 + (2*key) + ((key > 1) ? 1 : 0);
   uint8_t rxbuf[2];
   const apalExitStatus_t status = apalI2CMasterTransmit(at42qt1050d->i2cd, at42qt1050d->addr, &txbuf, 1, rxbuf, 2, timeout);
   *refdata = (rxbuf[0] << 8) | rxbuf[1];
   return status;
+}
 /**
  * @brief   Convert a 4 bit pulse value to the representing number of samples.
  * @details Calculation: <#samples> = 2^(<pulse value>)
+ *
  * @param[in]   pulse   Pulse value.
+ *
  * @return    Resulting sample count.
  */
 inline uint16_t
 at42qt1050_lld_pulse2samples(const uint8_t pulse)
+{
   apalDbgAssert(pulse <= 0x0Fu);
   return (1 << pulse);
+}
 /**
  * @brief   Convert a desired number of samples to the according (theoretical) pulse value.
  * @details Calculation: <pulse value> = log2(<#samples>)
+ *
  * @param[in]   samples   Desired number of samples.
+ *
  * @return    The (theoretical) value to set to the pulse register.
  */
 inline float
 at42qt1050_lld_samples2pulse(const uint16_t samples)
+{
   return log2f(samples);
+}
 /**
  * @brief   Convert a 4 bit scale value to the accoring scaling factor.
  * @details Calculation: <scaling factor> = 2^(<scale value>)
+ *
  * @param[in]   scale   Scale value.
+ *
  * @return    Resulting scaling factor.
  */
 inline uint16_t
 at42qt1050_lld_scale2scaling(const uint8_t scale)
+{
   apalDbgAssert(scale <= 0x0Fu);
   return (1 << scale);
+}
 /**
  * @brief   Convert a desired scaling factor to the according (theoretical) scale value.
  * @details Calculation: <scale value> = log2(<scaling factor>
  * )
  * @param[in]   factor    Desired scaling factor.
+ *
  * @return    The (theoretcial) value to set to the scale register.
  */
 inline float
 at42qt1050_lld_scaling2scale(const uint16_t factor)
+{
   return log2f(factor);
+}
 #endif /* defined(AMIROLLD_CFG_USE_AT42QT1050) */
 /** @} */