Rename Irukagotchi to Dolphin. Add basic game state structures. (#268)

* Rename Irukagotchi to Dolphin. Add basic game state structures.
* Dolphin: state, counters, api. BT: shared access to flash. Flash: write api.
* add fake -1 deeds, example of changing icounter

Co-authored-by: coreglitch <mail@s3f.ru>

firmware/targets/api-hal-include/api-hal-bt.h

@@ -16,6 +16,12 @@ void api_hal_bt_dump_state(string_t buffer);
 /* Get BT/BLE system component state */
 bool api_hal_bt_is_alive();
 
+/* Lock shared access to flash controller */
+void api_hal_bt_lock_flash();
+
+/* Unlock shared access to flash controller */
+void api_hal_bt_unlock_flash();
+
 #ifdef __cplusplus
 }
 #endif

firmware/targets/api-hal-include/api-hal.h

@@ -14,3 +14,4 @@ template <unsigned int N> struct STOP_EXTERNING_ME {};
 #include "api-hal-vcp.h"
 #include "api-hal-uid.h"
 #include "api-hal-bt.h"
+#include "api-hal-flash.h"

firmware/targets/f4/api-hal/api-hal-bt.c

@@ -1,6 +1,9 @@
 #include <api-hal-bt.h>
 #include <app_entry.h>
 #include <ble.h>
+#include <stm32wbxx.h>
+#include <shci.h>
+#include <cmsis_os2.h>
 
 void api_hal_bt_init() {
     // Explicitly tell that we are in charge of CLK48 domain
@@ -31,7 +34,39 @@ void api_hal_bt_dump_state(string_t buffer) {
     }
 }
 
-
 bool api_hal_bt_is_alive() {
     return APPE_Status() == BleGlueStatusStarted;
-}
+}
+
+bool api_hal_bt_wait_transition() {
+    if (APPE_Status() == BleGlueStatusUninitialized) {
+        return false;
+    }
+    while (APPE_Status() != BleGlueStatusStarted) {
+        osDelay(1);
+    }
+    return true;
+}
+
+void api_hal_bt_lock_flash() {
+    if (!api_hal_bt_wait_transition()) {
+        HAL_FLASH_Unlock();
+        return;
+    }
+    while (HAL_HSEM_FastTake(CFG_HW_FLASH_SEMID) != HAL_OK) {
+        osDelay(1);
+    }
+    SHCI_C2_FLASH_EraseActivity(ERASE_ACTIVITY_ON);
+    HAL_FLASH_Unlock();
+    while(LL_FLASH_IsOperationSuspended()) {};
+}
+
+void api_hal_bt_unlock_flash() {
+    if (!api_hal_bt_wait_transition()) {
+        HAL_FLASH_Lock();
+        return;
+    }
+    SHCI_C2_FLASH_EraseActivity(ERASE_ACTIVITY_OFF);
+    HAL_FLASH_Lock();
+    HAL_HSEM_Release(CFG_HW_FLASH_SEMID, HSEM_CPU1_COREID);
+}

firmware/targets/f4/api-hal/api-hal-flash.c

@@ -0,0 +1,15 @@
+#include <api-hal-flash.h>
+#include <api-hal-bt.h>
+#include <stm32wbxx.h>
+
+void api_hal_flash_write_dword(size_t address, uint64_t data) {
+    api_hal_bt_lock_flash();
+    HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, address, data);
+    api_hal_bt_unlock_flash();
+}
+
+void api_hal_flash_write_row(size_t address, size_t source_address) {
+    api_hal_bt_lock_flash();
+    HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, address, source_address);
+    api_hal_bt_unlock_flash();
+}

firmware/targets/f4/api-hal/api-hal-flash.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <stdint.h>
+#include <stddef.h>
+
+/*
+ * Write double word (64 bits)
+ * Locking operation, uses HSEM to manage shared access.
+ * @param address - destination address, must be double word aligned.
+ * @param data - data to write
+ */
+void api_hal_flash_write_dword(size_t address, uint64_t data);
+
+/*
+ * Write page (4096 bytes or 64 rows of double words).
+ * Locking operation, uses HSEM to manage shared access.
+ * @param address - destination address, must be page aligned
+ * @param source_address - source address
+ */
+void api_hal_flash_write_page(size_t address, size_t source_address);