]> git.itanic.dy.fi Git - BME280_driver/blobdiff - selftest/bme280_selftest.c
Added a wait until the NVM copy was complete.
[BME280_driver] / selftest / bme280_selftest.c
index 4e8ccf0034919cafe74948ea971a8794a6d1d69b..5cbe0316e332d745d700ae41343e131541df3676 100644 (file)
-/**\mainpage
- * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * Neither the name of the copyright holder nor the names of the
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
- * OR CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
- *
- * The information provided is believed to be accurate and reliable.
- * The copyright holder assumes no responsibility
- * for the consequences of use
- * of such information nor for any infringement of patents or
- * other rights of third parties which may result from its use.
- * No license is granted by implication or otherwise under any patent or
- * patent rights of the copyright holder.
- *
- * File     bme280_selftest.c
- * Date     08 Mar 2019
- * Version  3.3.6
- *
- */
-
-#include "bme280_selftest.h"
-
-#define BME280_CRC_DATA_ADDR   UINT8_C(0xE8)
-#define BME280_CRC_DATA_LEN    UINT8_C(1)
-#define BME280_CRC_CALIB1_ADDR UINT8_C(0x88)
-#define BME280_CRC_CALIB1_LEN  UINT8_C(26)
-#define BME280_CRC_CALIB2_ADDR UINT8_C(0xE1)
-#define BME280_CRC_CALIB2_LEN  UINT8_C(7)
-
-/*!
- * @brief This API calculates the CRC
- *
- * @param[in] mem_values : reg_data parameter to calculate CRC
- * @param[in] mem_length : Parameter to calculate CRC
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static uint8_t crc_calculate(uint8_t *mem_values, uint8_t mem_length);
-
-/*!
- * @brief This API reads the stored CRC and then compare with calculated CRC
- *
- * @param[in] dev : Structure instance of bme280_dev.
- *
- * @return Result of API execution status
- * @retval zero -> self test success / +ve value -> warning(self test fail)
- */
-int8_t bme280_crc_selftest(const struct bme280_dev *dev)
-{
-    int8_t rslt;
-    uint8_t reg_addr;
-    uint8_t reg_data[64];
-    uint8_t stored_crc = 0;
-    uint8_t calculated_crc = 0;
-
-    /* Read stored crc value from register */
-    reg_addr = BME280_CRC_DATA_ADDR;
-    rslt = bme280_get_regs(reg_addr, reg_data, BME280_CRC_DATA_LEN, dev);
-    if (rslt == BME280_OK)
-    {
-        stored_crc = reg_data[0];
-
-        /* Calculated CRC value with calibration register */
-        reg_addr = BME280_CRC_CALIB1_ADDR;
-        rslt = bme280_get_regs(reg_addr, &reg_data[0], BME280_CRC_CALIB1_LEN, dev);
-        if (rslt == BME280_OK)
-        {
-            reg_addr = BME280_CRC_CALIB2_ADDR;
-            rslt = bme280_get_regs(reg_addr, &reg_data[BME280_CRC_CALIB1_LEN], BME280_CRC_CALIB2_LEN, dev);
-            if (rslt == BME280_OK)
-            {
-                calculated_crc = crc_calculate(reg_data, BME280_CRC_CALIB1_LEN + BME280_CRC_CALIB2_LEN);
-
-                /* Validate CRC */
-                if (stored_crc == calculated_crc)
-                {
-                    rslt = BME280_OK;
-                }
-                else
-                {
-                    rslt = BME280_W_SELF_TEST_FAIL;
-                }
-            }
-        }
-    }
-
-    return rslt;
-}
-
-/*!
- * @brief This API calculates the CRC
- *
- * @param[in] mem_values : reg_data parameter to calculate CRC
- * @param[in] mem_length : Parameter to calculate CRC
- *
- * @return Result of API execution status
- * @retval zero -> Success / +ve value -> Warning / -ve value -> Error
- */
-static uint8_t crc_calculate(uint8_t *mem_values, uint8_t mem_length)
-{
-    uint32_t crc_reg = 0xFF;
-    uint8_t polynomial = 0x1D;
-    uint8_t bitNo, index;
-    uint8_t din = 0;
-
-    for (index = 0; index < mem_length; index++)
-    {
-        for (bitNo = 0; bitNo < 8; bitNo++)
-        {
-            if (((crc_reg & 0x80) > 0) != ((mem_values[index] & 0x80) > 0))
-            {
-                din = 1;
-            }
-            else
-            {
-                din = 0;
-            }
-
-            /* Truncate 8th bit for crc_reg and mem_values */
-            crc_reg = (uint32_t)((crc_reg & 0x7F) << 1);
-            mem_values[index] = (uint8_t)((mem_values[index] & 0x7F) << 1);
-            crc_reg = (uint32_t)(crc_reg ^ (polynomial * din));
-        }
-    }
-
-    return (uint8_t)(crc_reg ^ 0xFF);
-}
+/**\mainpage\r
+ * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH\r
+ *\r
+ * Redistribution and use in source and binary forms, with or without\r
+ * modification, are permitted provided that the following conditions are met:\r
+ *\r
+ * Redistributions of source code must retain the above copyright\r
+ * notice, this list of conditions and the following disclaimer.\r
+ *\r
+ * Redistributions in binary form must reproduce the above copyright\r
+ * notice, this list of conditions and the following disclaimer in the\r
+ * documentation and/or other materials provided with the distribution.\r
+ *\r
+ * Neither the name of the copyright holder nor the names of the\r
+ * contributors may be used to endorse or promote products derived from\r
+ * this software without specific prior written permission.\r
+ *\r
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR\r
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
+ * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER\r
+ * OR CONTRIBUTORS BE LIABLE FOR ANY\r
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,\r
+ * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,\r
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
+ * ANY WAY OUT OF THE USE OF THIS\r
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\r
+ *\r
+ * The information provided is believed to be accurate and reliable.\r
+ * The copyright holder assumes no responsibility\r
+ * for the consequences of use\r
+ * of such information nor for any infringement of patents or\r
+ * other rights of third parties which may result from its use.\r
+ * No license is granted by implication or otherwise under any patent or\r
+ * patent rights of the copyright holder.\r
+ *\r
+ * File     bme280_selftest.c\r
+ * Date     26 Aug 2019\r
+ * Version  3.3.7\r
+ *\r
+ */\r
+\r
+#include "bme280_selftest.h"\r
+\r
+#define BME280_CRC_DATA_ADDR   UINT8_C(0xE8)\r
+#define BME280_CRC_DATA_LEN    UINT8_C(1)\r
+#define BME280_CRC_CALIB1_ADDR UINT8_C(0x88)\r
+#define BME280_CRC_CALIB1_LEN  UINT8_C(26)\r
+#define BME280_CRC_CALIB2_ADDR UINT8_C(0xE1)\r
+#define BME280_CRC_CALIB2_LEN  UINT8_C(7)\r
+\r
+/*!\r
+ * @brief This API calculates the CRC\r
+ *\r
+ * @param[in] mem_values : reg_data parameter to calculate CRC\r
+ * @param[in] mem_length : Parameter to calculate CRC\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static uint8_t crc_calculate(uint8_t *mem_values, uint8_t mem_length);\r
+\r
+/*!\r
+ * @brief This API reads the stored CRC and then compare with calculated CRC\r
+ *\r
+ * @param[in] dev : Structure instance of bme280_dev.\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> self test success / +ve value -> warning(self test fail)\r
+ */\r
+int8_t bme280_crc_selftest(const struct bme280_dev *dev)\r
+{\r
+    int8_t rslt;\r
+    uint8_t reg_addr;\r
+    uint8_t reg_data[64];\r
+    uint8_t stored_crc = 0;\r
+    uint8_t calculated_crc = 0;\r
+\r
+    /* Read stored crc value from register */\r
+    reg_addr = BME280_CRC_DATA_ADDR;\r
+    rslt = bme280_get_regs(reg_addr, reg_data, BME280_CRC_DATA_LEN, dev);\r
+    if (rslt == BME280_OK)\r
+    {\r
+        stored_crc = reg_data[0];\r
+\r
+        /* Calculated CRC value with calibration register */\r
+        reg_addr = BME280_CRC_CALIB1_ADDR;\r
+        rslt = bme280_get_regs(reg_addr, &reg_data[0], BME280_CRC_CALIB1_LEN, dev);\r
+        if (rslt == BME280_OK)\r
+        {\r
+            reg_addr = BME280_CRC_CALIB2_ADDR;\r
+            rslt = bme280_get_regs(reg_addr, &reg_data[BME280_CRC_CALIB1_LEN], BME280_CRC_CALIB2_LEN, dev);\r
+            if (rslt == BME280_OK)\r
+            {\r
+                calculated_crc = crc_calculate(reg_data, BME280_CRC_CALIB1_LEN + BME280_CRC_CALIB2_LEN);\r
+\r
+                /* Validate CRC */\r
+                if (stored_crc == calculated_crc)\r
+                {\r
+                    rslt = BME280_OK;\r
+                }\r
+                else\r
+                {\r
+                    rslt = BME280_W_SELF_TEST_FAIL;\r
+                }\r
+            }\r
+        }\r
+    }\r
+\r
+    return rslt;\r
+}\r
+\r
+/*!\r
+ * @brief This API calculates the CRC\r
+ *\r
+ * @param[in] mem_values : reg_data parameter to calculate CRC\r
+ * @param[in] mem_length : Parameter to calculate CRC\r
+ *\r
+ * @return Result of API execution status\r
+ * @retval zero -> Success / +ve value -> Warning / -ve value -> Error\r
+ */\r
+static uint8_t crc_calculate(uint8_t *mem_values, uint8_t mem_length)\r
+{\r
+    uint32_t crc_reg = 0xFF;\r
+    uint8_t polynomial = 0x1D;\r
+    uint8_t bitNo, index;\r
+    uint8_t din = 0;\r
+\r
+    for (index = 0; index < mem_length; index++)\r
+    {\r
+        for (bitNo = 0; bitNo < 8; bitNo++)\r
+        {\r
+            if (((crc_reg & 0x80) > 0) != ((mem_values[index] & 0x80) > 0))\r
+            {\r
+                din = 1;\r
+            }\r
+            else\r
+            {\r
+                din = 0;\r
+            }\r
+\r
+            /* Truncate 8th bit for crc_reg and mem_values */\r
+            crc_reg = (uint32_t)((crc_reg & 0x7F) << 1);\r
+            mem_values[index] = (uint8_t)((mem_values[index] & 0x7F) << 1);\r
+            crc_reg = (uint32_t)(crc_reg ^ (polynomial * din));\r
+        }\r
+    }\r
+\r
+    return (uint8_t)(crc_reg ^ 0xFF);\r
+}\r