Merge pull request #8 from tobozo/1.0.3-beta

1.0.3 beta

Author: tobozo

CMakeLists.txt

@@ -0,0 +1,2 @@
+idf_component_register(SRCS "src/pfs.c" INCLUDE_DIRS "src")
+#target_compile_definitions(${COMPONENT_LIB} PUBLIC "-DLOG_LOCAL_LEVEL=ESP_LOG_VERBOSE")

component.mk

@@ -0,0 +1,8 @@
+#
+# Main Makefile. This is basically the same as a component makefile.
+#
+# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
+
+COMPONENT_SRCDIRS := src
+COMPONENT_ADD_INCLUDEDIRS := src
+#COMPONENT_DEPENDS = log

examples/esp-idf-psramvfs/.gitignore

@@ -0,0 +1,3 @@
+components
+build
+sdkconfig.old

examples/esp-idf-psramvfs/CMakeLists.txt

@@ -0,0 +1,6 @@
+# The following lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(psramvfs)

examples/esp-idf-psramvfs/Makefile

@@ -0,0 +1,8 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := psramvfs
+
+include $(IDF_PATH)/make/project.mk

examples/esp-idf-psramvfs/ReadMe.md

@@ -0,0 +1,40 @@
+## ESP-IDF PSRamFS vfs example
+
+
+1) cd to the example folder
+
+    ```console
+    foo@bar:$ cd examples/esp-idf-psramvfs
+    ```
+
+
+2) create the components folder
+
+    ```console
+    foo@bar:$ mkdir components
+    ```
+
+3) pull the library
+
+    ```console
+    foo@bar:$ git clone https://github.com/tobozo/ESP32-PsRamFS --branch=1.0.3-beta components/ESP32-PsRamFS
+    ```
+
+4) setup the project
+
+    ```console
+    foo@bar:$ idf.py set-target esp32
+    ```
+
+5) make sure psram is enabled
+
+    ```console
+    foo@bar:$ idf.py menuconfig
+    ```
+    Component config -> ESP32-specific -> Support for external, SPI-connected RAM = yes
+
+6) build and flash
+
+    ```console
+    foo@bar:$ idf.py build flash monitor
+    ```

examples/esp-idf-psramvfs/main/CMakeLists.txt

@@ -0,0 +1 @@
+idf_component_register(SRCS "psramvfs.c" INCLUDE_DIRS "")

examples/esp-idf-psramvfs/main/component.mk

@@ -0,0 +1,4 @@
+#
+# "main" pseudo-component makefile.
+#
+# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)

examples/esp-idf-psramvfs/main/psramvfs.c

@@ -0,0 +1,105 @@
+/*\
+
+ * PSRAMFS Example
+
+\*/
+#include <stdio.h>
+#include <string.h>
+#include "sdkconfig.h"
+#include "esp_log.h"
+#include "pfs.h"
+
+
+static const char TAG[] = "psramvfs_main";
+
+
+void register_psramvfs(void)
+{
+    pfs_set_partition_size( 0.5 * heap_caps_get_free_size(MALLOC_CAP_SPIRAM) );
+
+    esp_vfs_pfs_conf_t conf = {
+        .base_path = "/psram",
+        .partition_label = "psram", // ignored ?
+        .format_if_mount_failed = false
+    };
+
+    esp_err_t err = esp_vfs_pfs_register(&conf);
+
+    if(err != ESP_OK){
+        printf( "Mounting PSRAMFS failed! Error: %d\n", err);
+        return;
+    } else {
+        printf( "PSRAMFS mount successful\n" );
+    }
+
+}
+
+
+
+
+void test_psramvfs()
+{
+    const char* file_path = "/psram/blah.txt";
+    const char* data = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    size_t f_size = strlen(data);
+    char * buffer;
+
+    FILE *f = fopen(file_path, "w");
+
+    if (f == NULL) {
+        ESP_LOGE( TAG, "Failed to open file %s for writing", file_path);
+        return;
+    } else {
+        printf( "File %s opened for writing\n", file_path );
+    }
+
+    fwrite(data, sizeof(char), f_size, f);
+    fclose(f);
+
+    printf( "Successfully wrote %d bytes:\n%s\n", f_size, data );
+
+
+    f = fopen(file_path, "r");
+
+    if (f == NULL) {
+        ESP_LOGE( TAG, "Failed to open file %s for reading", file_path );
+        return;
+    } else {
+        printf( "File %s opened for reading\n", file_path );
+    }
+
+    // ftell is still broken with psramfs
+    //fseek (f , 0 , SEEK_END);
+    //f_size = ftell (f);
+    //printf( "File size: %d bytes\n", f_size );
+    //rewind (f);
+
+    // allocate memory to contain the whole file:
+    buffer = (char*) calloc (f_size+1, sizeof(char));
+    if (buffer == NULL) {
+        ESP_LOGE( TAG, "Unable to alloc %d bytes", (int)f_size+1);
+        return;
+    }
+
+    size_t result = fread ( buffer, 1, f_size, f );
+    if (result != f_size) {
+        ESP_LOGE( TAG, "Sizes mismatch (expected %d bytes, got %d bytes)", (int)f_size, result );
+        return;
+    } else {
+        printf( "Successfully read %d bytes: \n%s\n", (int)f_size, (const char*)buffer );
+    }
+
+    fclose(f);
+    free( buffer );
+}
+
+
+
+
+void app_main(void)
+{
+    //esp_log_level_set("psramvfs_main", ESP_LOG_VERBOSE);
+    //esp_log_level_set("esp_psramfs", ESP_LOG_VERBOSE);
+    register_psramvfs();
+    test_psramvfs();
+}