drivers: flash: flash_rpi_pico: fix indentation and remove unused variables

Cleaned up the flash_rpi_pico driver to improve code readability and
compliance with Zephyr coding standards. Fixed inconsistent indentation
across the file and removed variables that were declared but not used.

A few improvements are credited to Manu3l0us.

Signed-off-by: Hanan Arshad <[email protected]>

Author: hanan619

drivers/flash/flash_rpi_pico.c

@@ -31,10 +31,10 @@ LOG_MODULE_REGISTER(flash_rpi_pico, CONFIG_FLASH_LOG_LEVEL);
 
 #define DT_DRV_COMPAT raspberrypi_pico_flash_controller
 
-#define PAGE_SIZE 256
+#define PAGE_SIZE   256
 #define SECTOR_SIZE DT_PROP(DT_CHOSEN(zephyr_flash), erase_block_size)
 #define ERASE_VALUE 0xff
-#define FLASH_SIZE KB(CONFIG_FLASH_SIZE)
+#define FLASH_SIZE  KB(CONFIG_FLASH_SIZE)
 
 static const struct flash_parameters flash_rpi_parameters = {
 	.write_block_size = 1,
@@ -43,15 +43,16 @@ static const struct flash_parameters flash_rpi_parameters = {
 
 /**
  * Low level flash functions are based on:
- * github.com/raspberrypi/pico-bootrom/blob/master/bootrom/program_flash_generic.c
+ * github.com/raspberrypi/pico-bootrom/blob/master/bootrom/program_flash_generic.c,
+ * github.com/raspberrypi/pico-bootrom-rp2350/blob/master/src/main/arm/varm_generic_flash.c
  * and
  * github.com/raspberrypi/pico-sdk/blob/master/src/rp2_common/hardware_flash/flash.c
  */
 
 #define FLASHCMD_PAGE_PROGRAM 0x02
-#define FLASHCMD_READ_STATUS 0x05
+#define FLASHCMD_READ_STATUS  0x05
 #define FLASHCMD_WRITE_ENABLE 0x06
-#define BOOT2_SIZE_WORDS 64
+#define BOOT2_SIZE_WORDS      64
 
 enum outover {
 	OUTOVER_NORMAL = 0,
@@ -83,7 +84,7 @@ static void __no_inline_not_in_flash_func(flash_init_boot2_copyout)(void)
 
 static void __no_inline_not_in_flash_func(flash_enable_xip_via_boot2)(void)
 {
-	((void (*)(void))((uint32_t)boot2_copyout+1))();
+	((void (*)(void))((uint32_t)boot2_copyout + 1))();
 }
 
 #if PICO_RP2350
@@ -106,38 +107,39 @@ static void __no_inline_not_in_flash_func(flash_rp2350_restore_qmi_cs1)(
 {
 	if (flash_devinfo_get_cs_size(1) == FLASH_DEVINFO_SIZE_NONE) {
 		/* Case 1: The RP2350 ROM sets QMI to a clean (03h read) configuration
-		during flash_exit_xip(), even though when CS1 is not enabled via
-		FLASH_DEVINFO it does not issue an XIP exit sequence to CS1. In
-		this case, restore the original register config for CS1 as it is
-		still the correct config. */
+		 * during flash_exit_xip(), even though when CS1 is not enabled via
+		 * FLASH_DEVINFO it does not issue an XIP exit sequence to CS1. In
+		 * this case, restore the original register config for CS1 as it is
+		 * still the correct config.
+		 */
 		qmi_hw->m[1].timing = state->timing;
 		qmi_hw->m[1].rcmd = state->rcmd;
 		qmi_hw->m[1].rfmt = state->rfmt;
 	} else {
 		/* Case 2: If RAM is attached to CS1, and the ROM has issued an XIP
-		exit sequence to it, then the ROM re-initialisation of the QMI
-		registers has actually not gone far enough. The old XIP write mode
-		is no longer valid when the QSPI RAM is returned to a serial
-		command state. Restore the default 02h serial write command config.
-			*/
+		 * exit sequence to it, then the ROM re-initialisation of the QMI
+		 * registers has actually not gone far enough. The old XIP write mode
+		 * is no longer valid when the QSPI RAM is returned to a serial
+		 * command state. Restore the default 02h serial write command config.
+		 */
 		qmi_hw->m[1].wfmt = QMI_M1_WFMT_RESET;
 		qmi_hw->m[1].wcmd = QMI_M1_WCMD_RESET;
 	}
 }
 #else
 void __no_inline_not_in_flash_func(flash_cs_force)(enum outover over)
 {
-	io_rw_32 *reg = (io_rw_32 *) (IO_QSPI_BASE + IO_QSPI_GPIO_QSPI_SS_CTRL_OFFSET);
-	*reg = (*reg & ~IO_QSPI_GPIO_QSPI_SS_CTRL_OUTOVER_BITS)
-		| (over << IO_QSPI_GPIO_QSPI_SS_CTRL_OUTOVER_LSB);
-	(void) *reg;
+	io_rw_32 *reg = (io_rw_32 *)(IO_QSPI_BASE + IO_QSPI_GPIO_QSPI_SS_CTRL_OFFSET);
+	*reg = (*reg & ~IO_QSPI_GPIO_QSPI_SS_CTRL_OUTOVER_BITS) |
+	       (over << IO_QSPI_GPIO_QSPI_SS_CTRL_OUTOVER_LSB);
+	(void)*reg;
 }
 #endif
 
 int __no_inline_not_in_flash_func(flash_was_aborted)()
 {
-	return *(io_rw_32 *) (IO_QSPI_BASE + IO_QSPI_GPIO_QSPI_SD1_CTRL_OFFSET)
-		   & IO_QSPI_GPIO_QSPI_SD1_CTRL_INOVER_BITS;
+	return *(io_rw_32 *)(IO_QSPI_BASE + IO_QSPI_GPIO_QSPI_SD1_CTRL_OFFSET) &
+	       IO_QSPI_GPIO_QSPI_SD1_CTRL_INOVER_BITS;
 }
 
 #if PICO_RP2350
@@ -151,14 +153,17 @@ uint __no_inline_not_in_flash_func(flash_put_get)(uint cs, const uint8_t *tx, ui
 
 	size_t tx_count = count;
 	size_t rx_count = count;
+
 	while (tx_count || rx_count) {
 		uint32_t status = qmi_hw->direct_csr;
+
 		if (tx_count && !(status & QMI_DIRECT_CSR_TXFULL_BITS)) {
 			qmi_hw->direct_tx = (uint32_t)(tx ? *tx++ : 0);
 			--tx_count;
 		}
 		if (rx_count && !(status & QMI_DIRECT_CSR_RXEMPTY_BITS)) {
 			uint8_t rxbyte = (uint8_t)qmi_hw->direct_rx;
+
 			if (rx) {
 				*rx++ = rxbyte;
 			}
@@ -167,16 +172,16 @@ uint __no_inline_not_in_flash_func(flash_put_get)(uint cs, const uint8_t *tx, ui
 	}
 
 	/* Wait for BUSY as there may be no RX data at all, e.g. for single-byte SPI commands */
-	while (qmi_hw->direct_csr & QMI_DIRECT_CSR_BUSY_BITS)
-		;
+	while (qmi_hw->direct_csr & QMI_DIRECT_CSR_BUSY_BITS) {
+	}
 
 	/* Disable direct-mode interface and deassert chip select */
 	hw_xor_bits(&qmi_hw->direct_csr, csr_toggle_mask);
 	return cs;
 }
 #else
 void __no_inline_not_in_flash_func(flash_put_get)(const uint8_t *tx, uint8_t *rx, size_t count,
-						size_t rx_skip)
+						  size_t rx_skip)
 {
 	const uint max_in_flight = 16 - 2;
 	size_t tx_count = count;
@@ -225,7 +230,7 @@ uint __no_inline_not_in_flash_func(flash_put_get_wrapper)(uint cs, uint8_t cmd,
 }
 #else
 void __no_inline_not_in_flash_func(flash_put_get_wrapper)(uint8_t cmd, const uint8_t *tx,
-					uint8_t *rx, size_t count)
+							  uint8_t *rx, size_t count)
 {
 	flash_cs_force(OUTOVER_LOW);
 	ssi_hw->dr0 = cmd;
@@ -244,7 +249,7 @@ static ALWAYS_INLINE uint flash_wait_ready(uint cs)
 	return cs;
 }
 #else
-static ALWAYS_INLINE void flash_wait_ready()
+static ALWAYS_INLINE void flash_wait_ready(void)
 {
 	uint8_t status_reg;
 
@@ -261,7 +266,7 @@ static ALWAYS_INLINE uint flash_enable_write(uint cs)
 	return flash_put_get(cs, NULL, NULL, 0);
 }
 #else
-static ALWAYS_INLINE void flash_enable_write()
+static ALWAYS_INLINE void flash_enable_write(void)
 {
 	flash_put_get_wrapper(FLASHCMD_WRITE_ENABLE, NULL, NULL, 0);
 }
@@ -286,10 +291,11 @@ static ALWAYS_INLINE void flash_put_cmd_addr(uint8_t cmd, uint32_t addr)
 }
 
 void __no_inline_not_in_flash_func(flash_write_partial_internal)(uint32_t addr, const uint8_t *data,
-					size_t size)
+								 size_t size)
 {
 #if PICO_RP2350
 	uint cs = (addr >> 24) & 0x1u;
+
 	cs = flash_enable_write(cs);
 	flash_put_cmd_addr(FLASHCMD_PAGE_PROGRAM, addr);
 	flash_put_get(cs, data, NULL, size);
@@ -305,16 +311,18 @@ void __no_inline_not_in_flash_func(flash_write_partial_internal)(uint32_t addr,
 void __no_inline_not_in_flash_func(flash_write_partial)(uint32_t flash_offs, const uint8_t *data,
 							size_t count)
 {
-	rom_connect_internal_flash_fn connect_internal_flash = (rom_connect_internal_flash_fn)
-					rom_func_lookup_inline(ROM_FUNC_CONNECT_INTERNAL_FLASH);
-	rom_flash_exit_xip_fn exit_xip = (rom_flash_exit_xip_fn)
-						rom_func_lookup_inline(ROM_FUNC_FLASH_EXIT_XIP);
-	rom_flash_flush_cache_fn flush_cache = (rom_flash_flush_cache_fn)
-						rom_func_lookup_inline(ROM_FUNC_FLASH_FLUSH_CACHE);
+	rom_connect_internal_flash_fn connect_internal_flash =
+		(rom_connect_internal_flash_fn)rom_func_lookup_inline(
+			ROM_FUNC_CONNECT_INTERNAL_FLASH);
+	rom_flash_exit_xip_fn exit_xip =
+		(rom_flash_exit_xip_fn)rom_func_lookup_inline(ROM_FUNC_FLASH_EXIT_XIP);
+	rom_flash_flush_cache_fn flush_cache =
+		(rom_flash_flush_cache_fn)rom_func_lookup_inline(ROM_FUNC_FLASH_FLUSH_CACHE);
 
 	flash_init_boot2_copyout();
 #if PICO_RP2350
 	flash_rp2350_qmi_save_state_t qmi_save;
+
 	flash_rp2350_save_qmi_cs1(&qmi_save);
 #endif
 
@@ -337,6 +345,8 @@ static bool is_valid_range(off_t offset, uint32_t size)
 
 static int flash_rpi_read(const struct device *dev, off_t offset, void *data, size_t size)
 {
+	ARG_UNUSED(dev);
+
 	if (size == 0) {
 		return 0;
 	}
@@ -357,13 +367,15 @@ static int flash_rpi_write(const struct device *dev, off_t offset, const void *d
 	size_t bytes_to_write;
 	uint8_t *data_pointer = (uint8_t *)data;
 
+	ARG_UNUSED(dev);
+
 	if (size == 0) {
 		return 0;
 	}
 
 	if (!is_valid_range(offset, size)) {
-		LOG_ERR("Write range exceeds the flash boundaries. Offset=%#lx, Size=%u",
-				offset, size);
+		LOG_ERR("Write range exceeds the flash boundaries. Offset=%#lx, Size=%u", offset,
+			size);
 		return -EINVAL;
 	}
 
@@ -406,14 +418,14 @@ static int flash_rpi_erase(const struct device *dev, off_t offset, size_t size)
 	}
 
 	if (!is_valid_range(offset, size)) {
-		LOG_ERR("Erase range exceeds the flash boundaries. Offset=%#lx, Size=%u",
-				offset, size);
+		LOG_ERR("Erase range exceeds the flash boundaries. Offset=%#lx, Size=%u", offset,
+			size);
 		return -EINVAL;
 	}
 
 	if ((offset % SECTOR_SIZE) || (size % SECTOR_SIZE)) {
 		LOG_ERR("Erase range is not a multiple of the sector size. Offset=%#lx, Size=%u",
-				offset, size);
+			offset, size);
 		return -EINVAL;
 	}
 
@@ -441,7 +453,7 @@ static const struct flash_pages_layout flash_rpi_pages_layout = {
 };
 
 void flash_rpi_page_layout(const struct device *dev, const struct flash_pages_layout **layout,
-				size_t *layout_size)
+			   size_t *layout_size)
 {
 	*layout = &flash_rpi_pages_layout;
 	*layout_size = 1;
@@ -459,5 +471,5 @@ static DEVICE_API(flash, flash_rpi_driver_api) = {
 #endif /* CONFIG_FLASH_PAGE_LAYOUT */
 };
 
-DEVICE_DT_INST_DEFINE(0, NULL, NULL, NULL, NULL, POST_KERNEL,
-		      CONFIG_FLASH_INIT_PRIORITY, &flash_rpi_driver_api);
+DEVICE_DT_INST_DEFINE(0, NULL, NULL, NULL, NULL, POST_KERNEL, CONFIG_FLASH_INIT_PRIORITY,
+		      &flash_rpi_driver_api);