You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2021/03/22 07:48:35 UTC

[GitHub] [incubator-nuttx] Ouss4 commented on a change in pull request #3126: risc-v/esp32-c3: Add support to SPI Flash

Ouss4 commented on a change in pull request #3126:
URL: https://github.com/apache/incubator-nuttx/pull/3126#discussion_r598482459



##########
File path: arch/risc-v/src/esp32c3/esp32c3_spiflash.h
##########
@@ -0,0 +1,251 @@
+/****************************************************************************
+ * arch/risc-v/src/esp32c3/esp32c3_spiflash.h
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.  The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+#ifndef __ARCH_RISCV_SRC_ESP32C3_ESP32C3_SPIFLASH_H
+#define __ARCH_RISCV_SRC_ESP32C3_ESP32C3_SPIFLASH_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <sys/types.h>
+#include <stdint.h>
+#include <nuttx/mtd/mtd.h>
+
+#ifndef __ASSEMBLY__
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C"
+{
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: esp32c3_spiflash_mtd
+ *
+ * Description:
+ *   Get ESP32-C3 SPI Flash MTD.
+ *
+ * Input Parameters:
+ *   None
+ *
+ * Returned Value:
+ *   ESP32-C3 SPI Flash MTD pointer.
+ *
+ ****************************************************************************/
+
+struct mtd_dev_s *esp32c3_spiflash_mtd(void);
+
+/****************************************************************************
+ * Name: esp32c3_spiflash_alloc_mtdpart
+ *
+ * Description:
+ *   Alloc ESP32-C3 SPI Flash MTD
+ *
+ * Input Parameters:
+ *   None
+ *
+ * Returned Value:
+ *   ESP32-C3 SPI Flash MTD data pointer if success or NULL if fail
+ *
+ ****************************************************************************/
+
+FAR struct mtd_dev_s *esp32c3_spiflash_alloc_mtdpart(void);
+
+/****************************************************************************
+ * Name: esp32c3_spiflash_encrypt_mtd
+ *
+ * Description:
+ *   Get ESP32-C3 SPI Flash encryption MTD.
+ *
+ * Input Parameters:
+ *   None
+ *
+ * Returned Value:
+ *   ESP32-C3 SPI Flash encryption MTD pointer.
+ *
+ ****************************************************************************/
+
+struct mtd_dev_s *esp32c3_spiflash_encrypt_mtd(void);
+
+/****************************************************************************
+ * Name: spi_flash_write_encrypted
+ *
+ * Description:
+ *   Write data encrypted to Flash.
+ *
+ *   Flash encryption must be enabled for this function to work.
+ *
+ *   Flash encryption must be enabled when calling this function.
+ *   If flash encryption is disabled, the function returns
+ *   ESP_ERR_INVALID_STATE.  Use esp_flash_encryption_enabled()
+ *   function to determine if flash encryption is enabled.
+ *
+ *   Both dest_addr and size must be multiples of 16 bytes. For
+ *   absolute best performance, both dest_addr and size arguments should
+ *   be multiples of 32 bytes.
+ *
+ * Input Parameters:
+ *   dest_addr - Destination address in Flash. Must be a multiple of 16
+ *               bytes.
+ *   src       - Pointer to the source buffer.
+ *   size      - Length of data, in bytes. Must be a multiple of 16 bytes.
+ *
+ * Returned Values:
+ *   Zero (OK) is returned or a negative error.
+ *
+ ****************************************************************************/
+
+int spi_flash_write_encrypted(uint32_t dest_addr, const void *src,

Review comment:
       The following group of functions are public and thus have to be prefixed with `esp32c3_`, however I don't see them used anywhere, what do they do?

##########
File path: boards/risc-v/esp32c3/esp32c3-devkit/src/esp32c3_spiflash.c
##########
@@ -0,0 +1,262 @@
+/****************************************************************************
+ * boards/risc-v/esp32c3/esp32c3-devkit/src/esp32c3_spiflash.c
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.  The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <sys/mount.h>
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <errno.h>
+#include <debug.h>
+
+#include <nuttx/kmalloc.h>
+#include <nuttx/spi/spi.h>
+#include <nuttx/mtd/mtd.h>
+#include <nuttx/fs/nxffs.h>
+
+#include "esp32c3_spiflash.h"
+#include "esp32c3-devkit.h"
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: esp32c3_spiflash_init
+ *
+ * Description:
+ *   Initialize the SPIFLASH and register the MTD device.
+ ****************************************************************************/
+
+int esp32c3_spiflash_init(void)
+{
+  FAR struct mtd_dev_s *mtd;
+  int ret = ERROR;
+
+  mtd = esp32c3_spiflash_alloc_mtdpart();
+
+#if defined (CONFIG_ESP32C3_SPIFLASH_SMARTFS)
+  ret = smart_initialize(0, mtd, NULL);
+  if (ret < 0)
+    {
+      finfo("smart_initialize failed, Trying to erase first...\n");
+      ret = mtd->ioctl(mtd, MTDIOC_BULKERASE, 0);
+      if (ret < 0)
+        {
+          ferr("ERROR: ioctl(BULKERASE) failed: %d\n", ret);
+          return ret;
+        }
+
+      finfo("Erase successful, initializing it again.\n");
+      ret = smart_initialize(0, mtd, NULL);
+      if (ret < 0)
+        {
+          ferr("ERROR: smart_initialize failed: %d\n", ret);
+          return ret;
+        }
+    }
+
+#elif defined (CONFIG_ESP32C3_SPIFLASH_NXFFS)
+  ret = nxffs_initialize(mtd);
+  if (ret < 0)
+    {
+      ferr("ERROR: NXFFS init failed: %d\n", ret);
+      return ret;
+    }
+
+#else
+  ret = register_mtddriver("/dev/esp32flash", mtd, 0755, NULL);

Review comment:
       ```suggestion
     ret = register_mtddriver("/dev/esp32c3flash", mtd, 0755, NULL);
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org