drivers/flash: stm32wb: Add driver for stm32wb

Add flash driver for stm32wb

Signed-off-by: Erwan Gouriou <[email protected]>

Author: erwango

drivers/flash/CMakeLists.txt

@@ -20,6 +20,7 @@ if(CONFIG_CLOCK_CONTROL_STM32_CUBE)
   zephyr_sources_ifdef(CONFIG_SOC_SERIES_STM32F4X flash_stm32f4x.c)
   zephyr_sources_ifdef(CONFIG_SOC_SERIES_STM32F7X flash_stm32f7x.c)
   zephyr_sources_ifdef(CONFIG_SOC_SERIES_STM32L4X flash_stm32l4x.c)
+  zephyr_sources_ifdef(CONFIG_SOC_SERIES_STM32WBX flash_stm32wbx.c)
 endif()
 
 zephyr_include_directories_ifdef(

drivers/flash/Kconfig.stm32

@@ -10,20 +10,25 @@ if SOC_FAMILY_STM32
 
 menuconfig SOC_FLASH_STM32
 	bool "STM32 flash driver"
-	depends on (SOC_SERIES_STM32F0X || SOC_SERIES_STM32F3X || SOC_SERIES_STM32F4X || SOC_SERIES_STM32F7X || SOC_SERIES_STM32L4X)
+	depends on (SOC_SERIES_STM32F0X || SOC_SERIES_STM32F3X || SOC_SERIES_STM32F4X || SOC_SERIES_STM32F7X || SOC_SERIES_STM32L4X || SOC_SERIES_STM32WBX)
 	select FLASH_HAS_DRIVER_ENABLED
+	select USE_STM32_HAL_FLASH
+	select USE_STM32_HAL_FLASH_EX
 	default y
 	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32F0X
 	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32F3X
 	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32F4X
 	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32F7X
 	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32L4X
+	select FLASH_PAGE_LAYOUT if SOC_SERIES_STM32WBX
 	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32F0X
 	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32F3X
 	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32F4X
 	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32F7X
 	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32L4X
+	select FLASH_HAS_PAGE_LAYOUT if SOC_SERIES_STM32WBX
 	help
-	 Enable STM32F0x, STM32F3x, STM32F4x, STM32F7x OR STM32L4x series flash driver.
+	 Enable STM32F0x, STM32F3x, STM32F4x, STM32F7x, STM32L4x or
+	 STM32WBx series flash driver.
 
 endif

drivers/flash/flash_stm32.c

@@ -29,6 +29,9 @@
 /* STM32L4: maximum erase time of 24.47ms for a 2K sector */
 #elif defined(CONFIG_SOC_SERIES_STM32L4X)
 #define STM32_FLASH_TIMEOUT	(K_MSEC(25))
+/* TBC: STM32WB: maximum erase time of 24.47ms for a 2K sector */
+#elif defined(CONFIG_SOC_SERIES_STM32WBX)
+#define STM32_FLASH_TIMEOUT	(K_MSEC(25))
 #endif
 
 /*
@@ -46,6 +49,7 @@ static inline void flash_stm32_sem_give(struct device *dev)
 	k_sem_give(&FLASH_STM32_PRIV(dev)->sem);
 }
 
+#if !defined(CONFIG_SOC_SERIES_STM32WBX)
 static int flash_stm32_check_status(struct device *dev)
 {
 	u32_t const error =
@@ -75,6 +79,7 @@ static int flash_stm32_check_status(struct device *dev)
 
 	return 0;
 }
+#endif /* CONFIG_SOC_SERIES_STM32L5X */
 
 int flash_stm32_wait_flash_idle(struct device *dev)
 {
@@ -86,7 +91,7 @@ int flash_stm32_wait_flash_idle(struct device *dev)
 		return -EIO;
 	}
 
-	while ((FLASH_STM32_REGS(dev)->sr & FLASH_SR_BSY)) {
+	while (__HAL_FLASH_GET_FLAG(FLASH_FLAG_BSY)) {
 		if (k_uptime_get() > timeout_time) {
 			return -EIO;
 		}
@@ -95,20 +100,25 @@ int flash_stm32_wait_flash_idle(struct device *dev)
 	return 0;
 }
 
+
 static void flash_stm32_flush_caches(struct device *dev,
 				     off_t offset, size_t len)
 {
 #if defined(CONFIG_SOC_SERIES_STM32F0X) || defined(CONFIG_SOC_SERIES_STM32F3X)
 	ARG_UNUSED(dev);
 	ARG_UNUSED(offset);
 	ARG_UNUSED(len);
-#elif defined(CONFIG_SOC_SERIES_STM32F4X) || defined(CONFIG_SOC_SERIES_STM32L4X)
+#elif defined(CONFIG_SOC_SERIES_STM32F4X) || \
+      defined(CONFIG_SOC_SERIES_STM32L4X) || \
+      defined(CONFIG_SOC_SERIES_STM32WBX)
 	ARG_UNUSED(offset);
 	ARG_UNUSED(len);
 #if defined(CONFIG_SOC_SERIES_STM32F4X)
 	struct stm32f4x_flash *regs = FLASH_STM32_REGS(dev);
 #elif defined(CONFIG_SOC_SERIES_STM32L4X)
 	struct stm32l4x_flash *regs = FLASH_STM32_REGS(dev);
+#elif defined(CONFIG_SOC_SERIES_STM32WBX)
+	struct stm32wbx_flash *regs = FLASH_STM32_REGS(dev);
 #endif
 	if (regs->acr.val & FLASH_ACR_DCEN) {
 		regs->acr.val &= ~FLASH_ACR_DCEN;
@@ -185,17 +195,6 @@ static int flash_stm32_write(struct device *dev, off_t offset,
 
 static int flash_stm32_write_protection(struct device *dev, bool enable)
 {
-#if defined(CONFIG_SOC_SERIES_STM32F4X)
-	struct stm32f4x_flash *regs = FLASH_STM32_REGS(dev);
-#elif defined(CONFIG_SOC_SERIES_STM32F7X)
-	struct stm32f7x_flash *regs = FLASH_STM32_REGS(dev);
-#elif defined(CONFIG_SOC_SERIES_STM32F0X)
-	struct stm32f0x_flash *regs = FLASH_STM32_REGS(dev);
-#elif defined(CONFIG_SOC_SERIES_STM32F3X)
-	struct stm32f3x_flash *regs = FLASH_STM32_REGS(dev);
-#elif defined(CONFIG_SOC_SERIES_STM32L4X)
-	struct stm32l4x_flash *regs = FLASH_STM32_REGS(dev);
-#endif
 	int rc = 0;
 
 	flash_stm32_sem_take(dev);
@@ -206,17 +205,9 @@ static int flash_stm32_write_protection(struct device *dev, bool enable)
 			flash_stm32_sem_give(dev);
 			return rc;
 		}
-		regs->cr |= FLASH_CR_LOCK;
+		HAL_FLASH_Lock();
 	} else {
-		if (regs->cr & FLASH_CR_LOCK) {
-			regs->keyr = FLASH_KEY1;
-#ifdef CONFIG_SOC_SERIES_STM32F3X
-			/* On STM32F3 series some time is requested */
-			/* before writing again on key register */
-			flash_stm32_wait_flash_idle(dev);
-#endif /* CONFIG_SOC_SERIES_STM32F3X */
-			regs->keyr = FLASH_KEY2;
-		}
+		HAL_FLASH_Unlock();
 	}
 
 	flash_stm32_sem_give(dev);
@@ -241,6 +232,8 @@ static struct flash_stm32_priv flash_data = {
 	.regs = (struct stm32l4x_flash *) DT_FLASH_DEV_BASE_ADDRESS,
 	.pclken = { .bus = STM32_CLOCK_BUS_AHB1,
 		    .enr = LL_AHB1_GRP1_PERIPH_FLASH },
+#elif defined(CONFIG_SOC_SERIES_STM32WBX)
+	.regs = (struct stm32wbx_flash *) DT_FLASH_DEV_BASE_ADDRESS,
 #endif
 };
 

drivers/flash/flash_stm32.h

@@ -34,6 +34,8 @@ struct flash_stm32_priv {
 	struct stm32l4x_flash *regs;
 	/* clock subsystem driving this peripheral */
 	struct stm32_pclken pclken;
+#elif defined(CONFIG_SOC_SERIES_STM32WBX)
+	struct stm32wbx_flash *regs;
 #endif
 	struct k_sem sem;
 };
@@ -64,6 +66,10 @@ int flash_stm32_block_erase_loop(struct device *dev, unsigned int offset,
 
 int flash_stm32_wait_flash_idle(struct device *dev);
 
+#ifdef CONFIG_SOC_SERIES_STM32WBX
+int flash_stm32_check_status(struct device *dev);
+#endif /* CONFIG_SOC_SERIES_STM32WBX */
+
 #ifdef CONFIG_FLASH_PAGE_LAYOUT
 void flash_stm32_page_layout(struct device *dev,
 			     const struct flash_pages_layout **layout,

drivers/flash/flash_stm32wbx.c

@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) 2019 Linaro Limited
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#define LOG_DOMAIN flash_stm32wb
+#define LOG_LEVEL CONFIG_FLASH_LOG_LEVEL
+#include <logging/log.h>
+LOG_MODULE_REGISTER(LOG_DOMAIN);
+
+#include <kernel.h>
+#include <device.h>
+#include <string.h>
+#include <flash.h>
+#include <init.h>
+#include <soc.h>
+#include <misc/__assert.h>
+
+#include "flash_stm32.h"
+
+#define STM32WBX_PAGE_SHIFT	12
+
+/* offset and len must be aligned on 8 for write
+ * , positive and not beyond end of flash */
+bool flash_stm32_valid_range(struct device *dev, off_t offset, u32_t len,
+			     bool write)
+{
+	return (!write || (offset % 8 == 0 && len % 8 == 0)) &&
+	       flash_stm32_range_exists(dev, offset, len);
+}
+
+/*
+ * Up to 255 4K pages
+ */
+static u32_t get_page(off_t offset)
+{
+	return offset >> STM32WBX_PAGE_SHIFT;
+}
+
+static int check_flash_unlock()
+{
+	int rc = 0;
+
+	/* verify Flash is unlocked */
+	if (READ_BIT(FLASH->CR, FLASH_CR_LOCK) == 0u) {
+		rc = -EIO;
+	}
+
+	return rc;
+}
+
+static int write_dword(struct device *dev, off_t offset, u64_t val)
+{
+	u32_t address = (u32_t)(offset + CONFIG_FLASH_BASE_ADDRESS);
+	HAL_StatusTypeDef rc;
+
+	/* if the control register is locked, do not fail silently */
+	if (!check_flash_unlock()) {
+		return -EIO;
+	}
+
+	flash_stm32_check_status(dev);
+	/* Perform the data write operation at the desired memory address */
+	rc = HAL_FLASH_Program(FLASH_TYPEPROGRAM_DOUBLEWORD, address, val);
+
+	if (rc != HAL_OK) {
+		return -EIO;
+	}
+
+	return 0;
+}
+
+static int erase_page(struct device *dev, u32_t page)
+{
+	int rc;
+
+	/* if the control register is locked, do not fail silently */
+	if (!check_flash_unlock()) {
+		return -EIO;
+	}
+
+	/* Check that no Flash memory operation is ongoing */
+	rc = flash_stm32_wait_flash_idle(dev);
+	if (rc < 0) {
+		return rc;
+	}
+
+	/* Check erase operation allowed */
+	if (HAL_FLASHEx_IsOperationSuspended()) {
+		return -EBUSY;
+	}
+
+	/* Proceed to erase the page */
+	MODIFY_REG(FLASH->CR, (FLASH_CR_PNB | FLASH_CR_PER), \
+		   ((page << FLASH_CR_PNB_Pos) | FLASH_CR_PER));
+
+	SET_BIT(FLASH->CR, FLASH_CR_STRT);
+
+	/* Wait for the BSY bit */
+	rc = flash_stm32_wait_flash_idle(dev);
+
+	CLEAR_BIT(FLASH->CR, FLASH_TYPEERASE_PAGES);
+
+	return rc;
+}
+
+int flash_stm32_block_erase_loop(struct device *dev, unsigned int offset,
+				 unsigned int len)
+{
+	int i, rc = 0;
+
+	i = get_page(offset);
+	for (; i <= get_page(offset + len - 1) ; ++i) {
+		rc = erase_page(dev, i);
+		if (rc < 0) {
+			break;
+		}
+	}
+
+	return rc;
+}
+
+int flash_stm32_write_range(struct device *dev, unsigned int offset,
+			    const void *data, unsigned int len)
+{
+	int i, rc = 0;
+
+	for (i = 0; i < len; i += 8, offset += 8) {
+		rc = write_dword(dev, offset,
+				UNALIGNED_GET((const u64_t *) data + (i >> 3)));
+		if (rc < 0) {
+			return rc;
+		}
+	}
+
+	return rc;
+}
+
+void flash_stm32_page_layout(struct device *dev,
+			     const struct flash_pages_layout **layout,
+			     size_t *layout_size)
+{
+	static struct flash_pages_layout stm32wb_flash_layout = {
+		.pages_count = 0,
+		.pages_size = 0,
+	};
+
+	ARG_UNUSED(dev);
+
+	if (stm32wb_flash_layout.pages_count == 0) {
+		stm32wb_flash_layout.pages_count = FLASH_SIZE / FLASH_PAGE_SIZE;
+		stm32wb_flash_layout.pages_size = FLASH_PAGE_SIZE;
+	}
+
+	*layout = &stm32wb_flash_layout;
+	*layout_size = 1;
+}
+
+int flash_stm32_check_status(struct device *dev)
+{
+	u32_t error = 0;
+
+	/* Save Flash errors */
+	error = (FLASH->SR & FLASH_FLAG_SR_ERROR);
+	error |= (FLASH->ECCR & FLASH_FLAG_ECCC);
+
+	/* TODO: Clean this */
+	if (error & FLASH_FLAG_OPTVERR) {
+		FLASH->SR |= FLASH_FLAG_SR_ERROR;
+		return 0;
+	}
+
+	if (error) {
+		return -EIO;
+	}
+
+	return 0;
+}

dts/arm/st/wb/stm32wb.dtsi

@@ -48,6 +48,9 @@
 			flash0: flash@8000000 {
 				compatible = "soc-nv-flash";
 				label = "FLASH_STM32";
+
+				write-block-size = <8>;
+				erase-block-size = <4096>;
 			};
 		};
 

dts/bindings/flash_controller/st,stm32wb-flash-controller.yaml

@@ -0,0 +1,26 @@
+---
+title: STM32 WB Flash Controller
+version: 0.1
+
+description: >
+    This binding gives a base representation of the STM32 wb Flash Controller
+
+inherits:
+    !include flash-controller.yaml
+
+properties:
+    compatible:
+      constraint: "st,stm32wb-flash-controller"
+
+    single-bank:
+      type: boolean
+      description: dual-bank mode not enabled (page erase 4096k)
+      generation: define
+      category: optionnal
+
+    dual-bank:
+      type: boolean
+      description: dual-bank mode enabled (page erase 2048k)
+      generation: define
+      category: optionnal
+...

soc/arm/st_stm32/stm32wb/dts_fixup.h

@@ -78,4 +78,8 @@
 #define DT_UART_STM32_LPUART_1_CLOCK_BITS	DT_ST_STM32_LPUART_40008000_CLOCK_BITS
 #define DT_UART_STM32_LPUART_1_CLOCK_BUS	DT_ST_STM32_LPUART_40008000_CLOCK_BUS
 
+#define DT_FLASH_DEV_BASE_ADDRESS		DT_ST_STM32WB_FLASH_CONTROLLER_58004000_BASE_ADDRESS
+#define DT_FLASH_DEV_NAME			DT_ST_STM32WB_FLASH_CONTROLLER_58004000_LABEL
+
+
 /* End of SoC Level DTS fixup file */