Repair RTC for preload

Author: masonova1

src/time/engine_rtc.c

@@ -5,8 +5,10 @@
 
 #if defined(__arm__)
     #include "../lib/bm8563/bm8563.h"
+    #include "pico/stdlib.h"
     #include "hardware/gpio.h"
     #include "hardware/i2c.h"
+    #include "pico/time.h"
 
     bm8563_t bm;
 
@@ -15,13 +17,18 @@
 
     // Custom I2C reader/writer functions for bm8563 library to call
     int32_t custom_i2c_read(void *handle, uint8_t address, uint8_t reg, uint8_t *buffer, uint16_t size){
-        if(i2c_write_blocking(i2c0, address, &reg, 1, true) == PICO_ERROR_GENERIC){
+        // Write register we want to read from
+        int ret = i2c_write_timeout_us(i2c0, address, &reg, 1, true, 500000);
+        if(ret == PICO_ERROR_GENERIC || ret == PICO_ERROR_TIMEOUT){
             return BM8563_ERROR_NOTTY;
         }
 
-        if(i2c_read_blocking(i2c0, address, buffer, size, false) == PICO_ERROR_GENERIC){
+        // Read what was returned by the write
+        ret = i2c_read_timeout_us(i2c0, address, buffer, size, false, 500000);
+        if(ret == PICO_ERROR_GENERIC || ret == PICO_ERROR_TIMEOUT){
             return BM8563_ERROR_NOTTY;
         }
+
         return BM8563_OK;
     }
 
@@ -30,9 +37,12 @@
         data[0] = reg;
         memcpy(data+1, buffer, size);
 
-        if(i2c_write_blocking(i2c0, address, data, size+1, false) == PICO_ERROR_GENERIC){
+        // Write the data
+        int ret = i2c_write_timeout_us(i2c0, address, data, size+1, false, 500000);
+        if(ret == PICO_ERROR_GENERIC || ret == PICO_ERROR_TIMEOUT){
             return BM8563_ERROR_NOTTY;
         }
+
         return BM8563_OK;
     }
 #endif
@@ -41,10 +51,10 @@
 void engine_rtc_init(){
     #if defined(__arm__)
         // Setup I2C instance and pins: https://github.com/micropython/micropython/blob/ba98533454eef5ab5783039f9929351c8f54d005/ports/rp2/machine_i2c.c#L136-L146
-        // https://www.lcsc.com/datasheet/lcsc_datasheet_2308181040_GATEMODE-BM8563EMA_C269878.pdf <- actual part 
+        // https://www.lcsc.com/datasheet/lcsc_datasheet_2308181040_GATEMODE-BM8563EMA_C269878.pdf <- actual part
         // https://static.chipdip.ru/lib/031/DOC043031000.pdf
         // https://www.nxp.com/docs/en/data-sheet/PCF8563.pdf
-        i2c_init(i2c0, 400000);
+        i2c_init(i2c0, 100000);  // Reduced from 400kHz to 100kHz because of I2C errors and freezing due to pull up resistor values
         gpio_set_function(RTC_I2C_SCL_GPIO, GPIO_FUNC_I2C);
         gpio_set_function(RTC_I2C_SDA_GPIO, GPIO_FUNC_I2C);
         gpio_set_pulls(RTC_I2C_SCL_GPIO, true, 0);
@@ -59,10 +69,18 @@ void engine_rtc_init(){
 }
 
 
-bool engine_rtc_check_compromised(){
+int engine_rtc_check_compromised(){
     #if defined(__arm__)
         struct tm rtc;
-        if(bm8563_read(&bm, &rtc) == BM8563_ERR_LOW_VOLTAGE) return true;
+
+        bm8563_err_t status = bm8563_read(&bm, &rtc);
+
+        if(status == BM8563_ERR_LOW_VOLTAGE){
+            return true;
+        }else if(status == BM8563_ERROR_NOTTY){
+            return ENGINE_RTC_I2C_ERROR;
+        }
+
     #endif
 
     return false;
@@ -101,4 +119,4 @@ int engine_rtc_set_datetime(struct tm *rtc){
     #endif
 
     return ENGINE_RTC_OK;
-}
+}

src/time/engine_rtc.h

@@ -14,12 +14,12 @@ void engine_rtc_init();
 
 // Checks if the RTC may have gone below voltage and lost time.
 // Returns true of compromised
-bool engine_rtc_check_compromised();
+int engine_rtc_check_compromised();
 
 // Get the broken down time
 int engine_rtc_get_datetime(struct tm *rtc);
 
 // Set the broken down time
 int engine_rtc_set_datetime(struct tm *rtc);
 
-#endif  // ENGINE_RTC_H
+#endif  // ENGINE_RTC_H

src/time/engine_time_module.c

@@ -67,11 +67,11 @@ int engine_time_set(mp_obj_t input_tuple){
 /*  --- doc ---
     NAME: datetime
     ID: datetime
-    DESC: Returns a datetime tuple representing the current date down to the second (based on the RTC clock that may lose time if it/Thumby Color fully loses power) 
+    DESC: Returns a datetime tuple representing the current date down to the second (based on the RTC clock that may lose time if it/Thumby Color fully loses power)
     PARAM: [type=tuple]   [name=time]  [value=tuple of ints in format (year, month, mday, hour, min, sec, wday{optional & unused}, yday{optional & unused}) (optional)]
     RETURN: RTC_OK, RTC_I2C_ERROR or tuple (year, month, mday, hour, min, sec, wday, yday)
 */
-static mp_obj_t engine_time_datetime(mp_uint_t n_args, const mp_obj_t *args){
+static mp_obj_t engine_time_datetime(size_t n_args, const mp_obj_t *args){
     int status = 0;
 
     if(n_args == 0){
@@ -96,10 +96,17 @@ MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(engine_time_datetime_obj, 0, 1, engine_time_
     NAME: is_compromised
     ID: is_compromised
     DESC: Returns True if the RTC clock detected a low voltage that meant it lost power or was very close
-    RETURN: True or False
+    RETURN: True, False, or RTC_I2C_ERROR
 */
-static mp_obj_t engine_time_is_compromised(mp_uint_t n_args, const mp_obj_t *args){
-    return mp_obj_new_bool(engine_rtc_check_compromised());
+static mp_obj_t engine_time_is_compromised(size_t n_args, const mp_obj_t *args){
+    int status = engine_rtc_check_compromised();
+
+    if(status == true || status == false){
+        mp_obj_new_bool(status);
+    }
+
+    // RTC_I2C_ERROR at this point
+    return mp_obj_new_int(status);
 }
 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(engine_time_is_compromised_obj, 0, 1, engine_time_is_compromised);
 

src/time/engine_time_module.h

@@ -3,4 +3,4 @@
 
 
 
-#endif  // ENGINE_TIME_MODULE_H
+#endif  // ENGINE_TIME_MODULE_H