git.itanic.dy.fi Git - BME280_driver/blob - selftest/bme280_selftest.h

   1 /**\mainpage\r
   2  * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH\r
   3  *\r
   4  * Redistribution and use in source and binary forms, with or without\r
   5  * modification, are permitted provided that the following conditions are met:\r
   6  *\r
   7  * Redistributions of source code must retain the above copyright\r
   8  * notice, this list of conditions and the following disclaimer.\r
   9  *\r
  10  * Redistributions in binary form must reproduce the above copyright\r
  11  * notice, this list of conditions and the following disclaimer in the\r
  12  * documentation and/or other materials provided with the distribution.\r
  13  *\r
  14  * Neither the name of the copyright holder nor the names of the\r
  15  * contributors may be used to endorse or promote products derived from\r
  16  * this software without specific prior written permission.\r
  17  *\r
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
  19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR\r
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
  21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  22  * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER\r
  23  * OR CONTRIBUTORS BE LIABLE FOR ANY\r
  24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,\r
  25  * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,\r
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
  31  * ANY WAY OUT OF THE USE OF THIS\r
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\r
  33  *\r
  34  * The information provided is believed to be accurate and reliable.\r
  35  * The copyright holder assumes no responsibility\r
  36  * for the consequences of use\r
  37  * of such information nor for any infringement of patents or\r
  38  * other rights of third parties which may result from its use.\r
  39  * No license is granted by implication or otherwise under any patent or\r
  40  * patent rights of the copyright holder.\r
  41  *\r
  42  * File     bme280_selftest.h\r
  43  * Date     26 Aug 2019\r
  44  * Version  3.3.7\r
  45  *\r
  46  */\r
  47 \r
  48 /*!\r
  49  * @addtogroup bme280_selftest\r
  50  * @brief\r
  51  */\r
  52 \r
  53 #ifndef BME280_SELFTEST_H_\r
  54 #define BME280_SELFTEST_H_\r
  55 \r
  56 #include "bme280.h"\r
  57 \r
  58 /*! CPP guard */\r
  59 #ifdef __cplusplus\r
  60 extern "C" {\r
  61 #endif\r
  62 \r
  63 /**\name API warning code */\r
  64 #define BME280_W_SELF_TEST_FAIL INT8_C(2)\r
  65 \r
  66 /*!\r
  67  * @brief This API reads the stored CRC and then compare with calculated CRC\r
  68  *\r
  69  * @param[in] dev : Structure instance of bme280_dev.\r
  70  *\r
  71  * @return Result of API execution status\r
  72  * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
  73  */\r
  74 int8_t bme280_crc_selftest(const struct bme280_dev *dev);\r
  75 \r
  76 /*! CPP guard */\r
  77 #ifdef __cplusplus\r
  78 }\r
  79 #endif\r
  80 \r
  81 #endif /* BME280_SELFTEST_H_ */\r
  82 /** @}*/\r