[core] Split lt_api.c into separate units

.github/workflows/docs.yml

@@ -25,7 +25,8 @@ jobs:
         run: |
           mkdir -p site/
           boardgen ltci
-          python docs/scripts/update_docs.py
+          python docs/scripts/write_boards.py
+          python docs/scripts/write_apis.py
           python docs/scripts/prepare_doxygen.py
           python docs/scripts/build_json.py
           cp *.json site/

.gitignore

@@ -264,3 +264,5 @@ docs/status/supported_*.md
 docs/status/unsupported_boards_*.md
 boards/**/*.svg
 boards/**/*.md
+# other generated files
+docs/contrib/lt-api-functions.md

SUMMARY.md

@@ -48,8 +48,9 @@
 		* [File list](ltapi/files.md)
 * 👷 Contributor's manual (WIP)
 	* [Porting new families](docs/contrib/porting.md)
-	* [📁 Project structure](docs/contrib/project-structure.md)
+	* [API functions guide](docs/contrib/lt-api.md)
 	* [C standard library](docs/contrib/stdlib.md)
+	* [📁 Project structure](docs/contrib/project-structure.md)
 	* [✈️ OTA format](docs/contrib/ota/README.md)
 		* [uf2ota.py tool](docs/contrib/ota/uf2ota.md)
 		* [uf2ota.h library](docs/contrib/ota/library.md)

builder/utils/cores.py

@@ -46,6 +46,7 @@ def env_add_core_sources(env: Environment, queue, name: str, path: str) -> bool:
         base_dir=path,
         srcs=[
             "+<*.c*>",
+            "+<api/*.c>",
             "+<common/*.c*>",
             "+<compat/*.c*>",
             "+<port/*.c*>",

cores/beken-72xx/base/api/lt_cpu.c

@@ -0,0 +1,13 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+lt_cpu_model_t lt_cpu_get_model() {
+	uint8_t chipId = *(uint8_t *)(SCTRL_CHIP_ID);
+	return CPU_MODEL_ENUM(FAMILY, chipId);
+}
+
+const char *lt_cpu_get_core_type() {
+	return "ARM968E-S (ARMv5TE)";
+}

cores/beken-72xx/base/api/lt_device.c

@@ -0,0 +1,41 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+void lt_get_device_mac(uint8_t *mac) {
+	cfg_load_mac(mac);
+}
+
+void lt_reboot() {
+	bk_reboot();
+}
+
+bool lt_reboot_download_mode() {
+	bk_reboot();
+	return true;
+}
+
+lt_reboot_reason_t lt_get_reboot_reason() {
+	switch (bk_misc_get_start_type()) {
+		case RESET_SOURCE_POWERON:
+			return REBOOT_REASON_POWER;
+		case RESET_SOURCE_REBOOT:
+			return REBOOT_REASON_SOFTWARE;
+		case RESET_SOURCE_WATCHDOG:
+			return REBOOT_REASON_WATCHDOG;
+		case RESET_SOURCE_CRASH_XAT0:
+		case RESET_SOURCE_CRASH_UNDEFINED:
+		case RESET_SOURCE_CRASH_PREFETCH_ABORT:
+		case RESET_SOURCE_CRASH_DATA_ABORT:
+		case RESET_SOURCE_CRASH_UNUSED:
+		case RESET_SOURCE_CRASH_PER_XAT0:
+			return REBOOT_REASON_CRASH;
+		case RESET_SOURCE_DEEPPS_GPIO:
+		case RESET_SOURCE_DEEPPS_RTC:
+		case RESET_SOURCE_DEEPPS_USB:
+			return REBOOT_REASON_SLEEP;
+		default:
+			return REBOOT_REASON_UNKNOWN;
+	}
+}

cores/beken-72xx/base/api/lt_flash.c

@@ -0,0 +1,26 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+// can't include <flash.h> as it collides with <Flash.h> on Windows -_-
+#define REG_FLASH_BASE		 0x00803000
+#define REG_FLASH_OPERATE_SW (REG_FLASH_BASE + 0 * 4)
+#define REG_FLASH_RDID		 (REG_FLASH_BASE + 4 * 4)
+#define FLASH_BUSY_SW		 (0x01UL << 31)
+#define FLASH_WP_VALUE		 (0x01UL << 30)
+#define FLASH_OP_SW			 (0x01UL << 29)
+#define FLASH_OP_TYPE_POS	 24
+#define FLASH_OP_RDID		 20
+
+lt_flash_id_t lt_flash_get_id() {
+	uint32_t data = (FLASH_OP_RDID << FLASH_OP_TYPE_POS) | FLASH_OP_SW | FLASH_WP_VALUE;
+	REG_WRITE(REG_FLASH_OPERATE_SW, data);
+	while (REG_READ(REG_FLASH_OPERATE_SW) & FLASH_BUSY_SW) {}
+	lt_flash_id_t id = {
+		.manufacturer_id = REG_RD8(REG_FLASH_RDID, 2),
+		.chip_id		 = REG_RD8(REG_FLASH_RDID, 1),
+		.chip_size_id	 = REG_RD8(REG_FLASH_RDID, 0),
+	};
+	return id;
+}

cores/beken-72xx/base/api/lt_init.c

@@ -0,0 +1,9 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+void lt_init_family() {
+	// set default UART output port
+	uart_print_port = LT_UART_DEFAULT_PORT - 1;
+}

cores/beken-72xx/base/api/lt_mem.c

@@ -0,0 +1,21 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+uint32_t lt_ram_get_size() {
+	return 256 * 1024;
+}
+
+uint32_t lt_heap_get_size() {
+#if configDYNAMIC_HEAP_SIZE
+	extern unsigned char _empty_ram;
+#if CFG_SOC_NAME == SOC_BK7231N
+	return (0x00400000 + 192 * 1024) - (uint32_t)(&_empty_ram);
+#else
+	return (0x00400000 + 256 * 1024) - (uint32_t)(&_empty_ram);
+#endif
+#else
+	return configTOTAL_HEAP_SIZE;
+#endif
+}

cores/beken-72xx/base/api/lt_ota.c

@@ -0,0 +1,39 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+lt_ota_type_t lt_ota_get_type() {
+	return OTA_TYPE_SINGLE;
+}
+
+bool lt_ota_is_valid(uint8_t index) {
+	if (index != 0)
+		return false;
+	// check download RBL
+	// TODO: maybe check header CRC or even binary hashes
+	uint32_t magic;
+	lt_flash_read(FLASH_DOWNLOAD_OFFSET, (uint8_t *)&magic, 4);
+	return magic == 0x004C4252; // "RBL\0", little-endian
+}
+
+uint8_t lt_ota_dual_get_current() {
+	return 0;
+}
+
+uint8_t lt_ota_dual_get_stored() {
+	return 0;
+}
+
+bool lt_ota_switch(bool revert) {
+	if (!lt_ota_is_valid(0))
+		// no valid "download" image
+		// - return false when trying to activate
+		// - return true when trying to revert
+		return revert;
+	if (revert) {
+		// there's a valid "download" image, which has to be removed
+		return lt_flash_erase_block(FLASH_DOWNLOAD_OFFSET);
+	}
+	return true;
+}

cores/beken-72xx/base/api/lt_wdt.c

@@ -0,0 +1,18 @@
+/* Copyright (c) Kuba Szczodrzyński 2023-02-27. */
+
+#include <libretiny.h>
+#include <sdk_private.h>
+
+bool lt_wdt_enable(uint32_t timeout) {
+	wdt_ctrl(WCMD_SET_PERIOD, &timeout);
+	wdt_ctrl(WCMD_POWER_UP, NULL);
+	return true;
+}
+
+void lt_wdt_disable() {
+	wdt_ctrl(WCMD_POWER_DOWN, NULL);
+}
+
+void lt_wdt_feed() {
+	wdt_ctrl(WCMD_RELOAD_PERIOD, NULL);
+}