Complete SPI API, added display ILI9341, added spi bme280, updated i2c bme280

lib/smooth/application/display/ILI9341.cpp

@@ -26,11 +26,9 @@ using namespace smooth::core::io::spi;
 
 namespace smooth::application::display
 {
-    static const char TAG[] = "ILI9314:";
+    static const char* TAG = "ILI9314";
     static const bool PIN_HIGH = true;
     static const bool PIN_LOW = false;
-    static const bool GOOD = true;
-    static const gpio_num_t CHIP_SELECT_NOT_USED = static_cast<gpio_num_t>(-1);
 
     ILI9341::ILI9341(std::mutex& guard,
                      gpio_num_t chip_select_pin,
@@ -72,7 +70,7 @@ namespace smooth::application::display
     bool ILI9341::init(spi_host_device_t host)
     {
         // spi_transaction will not control chip select
-        bool res = initialize(host, CHIP_SELECT_NOT_USED);
+        bool res = initialize(host, GPIO_NUM_NC);
 
         return res;
     }

lib/smooth/application/io/i2c/BME280.cpp

@@ -23,7 +23,7 @@ using namespace smooth::core::logging;
 
 namespace smooth::application::sensor
 {
-    static const char TAG[] = "BME280SPI:";
+    static const char* TAG = "BME280SPI";
 
     BME280::BME280(i2c_port_t port, uint8_t address, std::mutex& guard)
             : I2CMasterDevice(port, address, guard)
@@ -95,9 +95,9 @@ namespace smooth::application::sensor
         core::util::FixedBuffer<uint8_t, 1> rest;
         core::util::FixedBuffer<uint8_t, 1> config;
 
-        auto res = read(address, BME280Core::CTRL_HUM_REG, hum) &&
-                   read(address, BME280Core::CTRL_MEAS_REG, rest) &&
-                   read(address, BME280Core::CONFIG_REG, config);
+        auto res = read(address, BME280Core::CTRL_HUM_REG, hum)
+                   && read(address, BME280Core::CTRL_MEAS_REG, rest)
+                   && read(address, BME280Core::CONFIG_REG, config);
 
         if (res)
         {
@@ -125,8 +125,8 @@ namespace smooth::application::sensor
             core::util::FixedBuffer<uint8_t, 26> calib00_calib25_data;    // 0x88-0xA1
             core::util::FixedBuffer<uint8_t, 7> calib26_calib32_data;     // 0xE1-0xE7
 
-            trimming_read = read(address, BME280Core::CALIB00_REG, calib00_calib25_data) &&
-                            read(address, BME280Core::CALIB26_REG, calib26_calib32_data);
+            trimming_read = read(address, BME280Core::CALIB00_REG, calib00_calib25_data)
+                            && read(address, BME280Core::CALIB26_REG, calib26_calib32_data);
 
             if (trimming_read)
             {
@@ -165,8 +165,8 @@ namespace smooth::application::sensor
         pressure = 0;
         temperature = 0;
 
-        bool res = read_trimming_parameters();
-        res = res && read(address, BME280Core::PRESS_MSB_REG, measurement_data);
+        bool res = read_trimming_parameters()
+                   && read(address, BME280Core::PRESS_MSB_REG, measurement_data);
 
         if (res)
         {

lib/smooth/application/io/spi/BME280SPI.cpp

@@ -24,7 +24,7 @@ using namespace smooth::core::io::spi;
 
 namespace smooth::application::sensor
 {
-    static const char TAG[] = "BME280SPI:";
+    static const char* TAG = "BME280SPI";
 
     BME280SPI::BME280SPI(std::mutex& guard,
                          gpio_num_t chip_select_pin,
@@ -94,7 +94,12 @@ namespace smooth::application::sensor
 
     uint8_t BME280SPI::read_id()
     {
-        alignas(4) std::array<uint8_t, 4> rxdata;
+        std::array<uint8_t, 4> rxdata;
+
+        // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.
+        // see esp-idf/components/driver/spi_master.c line 865
+        //static_assert(&rxdata % 4 == 0, "Error:c rxdata not 32 bit aligned ");
+
         auto res = read(BME280Core::ID_REG, rxdata.data(), 2);
 
         return res ? rxdata.at(1) : 0;
@@ -116,8 +121,11 @@ namespace smooth::application::sensor
 
     bool BME280SPI::read_status(bool& is_measuring, bool& updating_from_nvm)
     {
+        std::array<uint8_t, 4> rxdata;
+
         // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.
-        alignas(4) std::array<uint8_t, 4> rxdata;
+        // see esp-idf/components/driver/spi_master.c line 865
+        //static_assert(&rxdata % 4 == 0, "Error: rxdata not 32 bit aligned ");
 
         auto res = read(BME280Core::STATUS_REG, rxdata.data(), 2);
 
@@ -164,17 +172,26 @@ namespace smooth::application::sensor
                                        BME280Core::FilterCoeff& filter,
                                        BME280Core::SpiInterface& spi_interface)
     {
-        // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.c
-        alignas(4) core::util::FixedBuffer<uint8_t, 4> ctrl_hum_data;
-        alignas(4) core::util::FixedBuffer<uint8_t, 4> ctrl_meas_data;
-        alignas(4) core::util::FixedBuffer<uint8_t, 4> config_data;
+        core::util::FixedBuffer<uint8_t, 4> ctrl_hum_data;
+        core::util::FixedBuffer<uint8_t, 4> ctrl_meas_data;
+        core::util::FixedBuffer<uint8_t, 4> config_data;
+
+        // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.
+        // see esp-idf/components/driver/spi_master.c line 865
+        //static_assert(ctrl_hum_data % 4 == 0, "Error: ctrl_hum_data not 32 bit aligned");
+        //static_assert(ctrl_meas_data % 4 == 0, "Error: ctrl_meas_data not 32 bit aligned");
+        //static_assert(config_data % 4 == 0, "Error: config_data not 32 bit aligned");
 
-        auto res = read(BME280Core::CTRL_HUM_REG, ctrl_hum_data.data(), 2) &&
-                   read(BME280Core::CTRL_MEAS_REG, ctrl_meas_data.data(), 2) &&
-                   read(BME280Core::CONFIG_REG, config_data.data(), 2);
+        auto res = read(BME280Core::CTRL_HUM_REG, ctrl_hum_data.data(), 2)
+                   && read(BME280Core::CTRL_MEAS_REG, ctrl_meas_data.data(), 2)
+                   && read(BME280Core::CONFIG_REG, config_data.data(), 2);
 
         if (res)
         {
+            // Since we are using 4-line spi (full duplex) the sck clocks both data out
+            // and data in at the same time.  The first byte going out is the register we want
+            // to read and so the first byte received is garbage or dummy byte.  So we
+            // will pass the 2nd byte received to get_configuration_settings.
             bme280_core.get_configuration_settings(ctrl_hum_data[1],
                                                    ctrl_meas_data[1],
                                                    config_data[1],
@@ -194,17 +211,25 @@ namespace smooth::application::sensor
     {
         if (!trimming_read)
         {
+            core::util::FixedBuffer<uint8_t, 32> calib00_calib25_data;    // 0x88-0xA1
+            core::util::FixedBuffer<uint8_t, 8> calib26_calib32_data;     // 0xE1-0xE7
+
             // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.
-            alignas(4) core::util::FixedBuffer<uint8_t, 32> calib00_calib25_data;    // 0x88-0xA1
-            alignas(4) core::util::FixedBuffer<uint8_t, 8> calib26_calib32_data;     // 0xE1-0xE7
+            // see esp-idf/components/driver/spi_master.c line 865
+            //static_assert(calib00_calib25_data % 4 == 0, "Error: calib00_calib25_data not 32 bit aligned");
+            //static_assert(calib26_calib32_data % 4 == 0, "Error: calib26_calib32_data not 32 bit aligned");
+
             core::util::FixedBuffer<uint8_t, 32> calibration_data;
 
-            trimming_read = read(BME280Core::CALIB00_REG, calib00_calib25_data.data(), 27) &&
-                            read(BME280Core::CALIB26_REG, calib26_calib32_data.data(), 8);
+            trimming_read = read(BME280Core::CALIB00_REG, calib00_calib25_data.data(), 27)
+                            && read(BME280Core::CALIB26_REG, calib26_calib32_data.data(), 8);
 
             if (trimming_read)
             {
-                // don't copy dummy byte but copy 0x88-0x9F into calibration_data
+                // Since we are using 4-line spi (full duplex) the sck clocks both data out
+                // and data in at the same time.  The first byte going out is the register we want
+                // to read and so the first byte received is garbage or dummy byte.  So we
+                // don't want to copy the dummy byte but copy 0x88-0x9F into calibration_data
                 for (size_t i = 0; i < 24; i++)
                 {
                     calibration_data[i] = calib00_calib25_data[i + 1];
@@ -232,17 +257,23 @@ namespace smooth::application::sensor
 
     bool BME280SPI::read_measurements(float& humidity, float& pressure, float& temperature)
     {
+        core::util::FixedBuffer<uint8_t, 12> temp_data{};
+
         // The spi rx buffer need to be length of multiples of 32 bits to avoid heap corruption.
-        alignas(4) core::util::FixedBuffer<uint8_t, 12> temp_data{};
-        core::util::FixedBuffer<uint8_t, 8> measurement_data;
+        // see esp-idf/components/driver/spi_master.c line 865
+        //static_assert(temp_data % 4 == 0, "Error: "temp_data not 32 bit aligned");
 
-        bool res = read_trimming_parameters();
+        core::util::FixedBuffer<uint8_t, 8> measurement_data;
 
-        res = res && read(BME280Core::PRESS_MSB_REG, temp_data.data(), 9);
+        bool res = read_trimming_parameters()
+                   && read(BME280Core::PRESS_MSB_REG, temp_data.data(), 9);
 
         if (res)
         {
-            // don't copy dummy byte but copy actual data into measurement_data
+            // Since we are using 4-line spi (full duplex) the sck clocks both data out
+            // and data in at the same time.  The first byte going out is the register we want
+            // to read and so the first byte received is garbage or dummy byte.  So we
+            // don't want to copy the dummy byte but copy actual data into measurement_data
             for (size_t i = 0; i < 8; i++)
             {
                 measurement_data[i] = temp_data[i + 1];

lib/smooth/include/smooth/application/display/ILI9341.h

@@ -28,9 +28,9 @@ limitations under the License.
    16MHz but data sheet recommends 10MHz.
 
    NOTE 3: Most applications will not need the ability to read regsiters and are
-   only writing to the display.  In this case MISO can be set to -1.  Also the spi
-   clock speed can be increased to either 26MHz or 40MHz.  The 2 displays I tested
-   this driver with operated at 40MHz with no problem.
+   only writing to the display.  In this case MISO can be set to GPIO_NUM_NC.  Also
+   the spi clock speed can be increased to either 26MHz or 40MHz.  The 2 displays I
+   tested this driver with operated at 40MHz with no problem.
   ************************************************************************************/
 #pragma once