refactor: Zephyr codestyle alignment (onomondo#89)

Author: benjaminbruun

.editorconfig

@@ -1,3 +1,7 @@
+# Copied from Zephyr: https://github.com/zephyrproject-rtos/zephyr/blob/main/.editorconfig
+
+# EditorConfig: https://editorconfig.org/
+
 # top-most EditorConfig file
 root = true
 
@@ -7,6 +11,7 @@ charset = utf-8
 end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
+max_line_length = 100
 
 # Assembly
 [*.S]
@@ -23,12 +28,67 @@ indent_size = 8
 indent_style = tab
 indent_size = 8
 
+# Linker Script
+[*.ld]
+indent_style = tab
+indent_size = 8
+
+# Python
+[*.py]
+indent_style = space
+indent_size = 4
+
+# Perl
+[*.pl]
+indent_style = tab
+indent_size = 8
+
+# reStructuredText
+[*.rst]
+indent_style = space
+indent_size = 3
+
 # YAML
 [*.{yml,yaml}]
 indent_style = space
 indent_size = 2
 
+# Shell Script
+[*.sh]
+indent_style = space
+indent_size = 4
+
+# Windows Command Script
+[*.cmd]
+end_of_line = crlf
+indent_style = tab
+indent_size = 8
+
+# Valgrind Suppression File
+[*.supp]
+indent_style = space
+indent_size = 3
+
 # CMake
 [{CMakeLists.txt,*.cmake}]
 indent_style = space
 indent_size = 2
+
+# Makefile
+[Makefile]
+indent_style = tab
+indent_size = 8
+
+# Device tree
+[*.{dts,dtsi,overlay}]
+indent_style = tab
+indent_size = 8
+
+# Git commit messages
+[COMMIT_EDITMSG]
+max_line_length = 75
+
+# Kconfig
+[Kconfig*]
+indent_style = tab
+indent_size = 8

.gitignore

@@ -62,6 +62,9 @@ lib/onomondo
 !lib/libuicc.a
 !lib/libstorage.a
 
+.*project
+.settings
+.envrc
 .vscode
 *debug*
 .DS_Store

lib/build_asserts.c

@@ -5,20 +5,20 @@
 #define EXPECTED_MIN_HEAP_SIZE 30000
 
 BUILD_ASSERT(CONFIG_HEAP_MEM_POOL_SIZE >= EXPECTED_MIN_HEAP_SIZE,
-             "SoftSIM: "
-             "Heap memory pool size is not valid. "
-             "Please reconfigure the project.");
+		"SoftSIM: "
+		"Heap memory pool size is not valid. "
+		"Please reconfigure the project.");
 
 /* In NCS, when NVS backend for Settings is chosen, `nvs_partition` partition is not included by
  * the Partition Manager.
- * `nvs_storage`partition is required by SoftSIM. FCB backend for Settings should be used instead
+ * `nvs_storage` partition is required by SoftSIM. FCB backend for Settings should be used instead
  * of NVS backend.
  */
 #if CONFIG_SETTINGS_NVS
-BUILD_ASSERT(0, "Softsim: Please disable CONFIG_SETTINGS_NVS. Choose CONFIG_SETTINGS_FCB instead.");
+BUILD_ASSERT(0, "SoftSIM: Please disable CONFIG_SETTINGS_NVS. Choose CONFIG_SETTINGS_FCB instead.");
 #else
 BUILD_ASSERT(CONFIG_PM_PARTITION_SIZE_NVS_STORAGE == EXPECTED_PARTITION_SIZE,
-             "SoftSIM: "
-             "nvs_partition size is not valid. "
-             "Please reconfigure the project.");
+		"SoftSIM: "
+		"nvs_partition size is not valid. "
+		"Please reconfigure the project.");
 #endif

lib/include/nrf_softsim.h

@@ -1,36 +1,37 @@
-#ifndef _NRF_SOFTSIM_H_
-#define _NRF_SOFTSIM_H_
+#ifndef _NRF_SOFTSIM_H
+#define _NRF_SOFTSIM_H
+
 #include <stddef.h>
+#include <stdint.h>
 
 /**
- * @brief Initialize the SoftSIM library and install handlers. Only use if
- * CONFIG_NRF_SOFTSIM_AUTO_INIT is not set.
+ * @brief Initialize the SoftSIM library and install handlers
  *
+ * Only use if CONFIG_NRF_SOFTSIM_AUTO_INIT is not set.
+ * 
+ * This function initializes the SoftSIM module by calling the Onomondo
+ * initialization function. It sets up the necessary context and prepares
+ * the SoftSIM for use.
  *
  * @return 0 on success
  */
 int nrf_softsim_init(void);
 
 /**
- * @brief
- *
- * Provision a SoftSIM profile to protected storage.
- * len must be exactly 328 bytes long.
+ * @brief Provision a SoftSIM profile to protected storage
  *
+ * @param profile String representing a SoftSIM profile. This encodes IMSI, ICCID, and necessary keys
+ * @param len Length of the profile passed
  *
- * @param profile String representing a SoftSIM profile. This encodes IMSI,
- * ICCID and necessary keys.
- * @param len Length of profile passed
  * @return 0 on success
  */
 int nrf_softsim_provision(uint8_t *profile, size_t len);
 
 /**
  * @brief Check if a SoftSIM profile is provisioned in protected storage.
  *
- *
  * @return 1 if provisioned, 0 if not
  */
 int nrf_softsim_check_provisioned(void);
 
-#endif /* _NRF_SOFTSIM_H_ */
+#endif /* _NRF_SOFTSIM_H */

lib/include/onomondo/softsim/fs_port.h

@@ -5,19 +5,76 @@
 
 typedef void *port_FILE;
 
-size_t 		port_fread(void *ptr, size_t size, size_t nmemb, port_FILE fp);
-char		*port_fgets(char *str, int n, port_FILE fp);
-int 		port_fclose(port_FILE);
-port_FILE 	port_fopen(char *path, char *mode);
-int 		port_fseek(port_FILE fp, long offset, int whence);
-long 		port_ftell(port_FILE fp);
-int 		port_fputc(int c, port_FILE);
-int 		port_access(const char *path, int amode);
-size_t 		port_fwrite(const void *prt, size_t size, size_t count, port_FILE f);
-int 		port_mkdir(const char *, int);
-int 		port_remove(const char *);
-int 		port_rmdir(const char *);
-int 		ss_init_fs();
-int 		ss_deinit_fs();
+char 	*port_fgets(char *str, int n, port_FILE fp);
+int 	port_fclose(port_FILE fp);
+int 	port_fseek(port_FILE fp, long offset, int whence);
+long 	port_ftell(port_FILE fp);
+int	port_fputc(int c, port_FILE fp);
+int	port_access(const char *path, int amode);
+size_t	port_fwrite(const void *ptr, size_t size, size_t count, port_FILE fp);
+int	port_remove(const char *path);
+
+/**
+ * @brief Creates a "directory" specified by the given path
+ *
+ * @param path The full path to the "directory" to be created
+ * @param mode The mode in which the directory should be created (currently ignored)
+ *
+ * @return 0 on success
+ *
+ * @note This function is currently not implemented and always returns 0.
+ */
+int port_mkdir(const char *path, int mode); /* TODO: Evaluate if this is needed */
+
+/**
+ * @brief Removes a "directory" specified by the given path
+ *
+ * @param path The full path to the "directory" to be removed
+ *
+ * @return 0 on success
+ *
+ * @note This function is currently not implemented and always returns 0.
+ */
+int port_rmdir(const char *path); /* TODO: Evaluate if this is needed */
+
+/**
+ * @brief Provides an implementation of the standard C fopen function
+ *
+ * This function opens a file specified by the given path and returns a pointer
+ * to a file-like object. The mode parameter is currently ignored.
+ *
+ * @param path The full path to the file to be opened
+ * @param mode The mode in which the file should be opened (currently ignored)
+ *
+ * @return A pointer to a "file" represented internally by a struct cache_entry,
+ *         or NULL if the operation fails
+ */
+port_FILE port_fopen(char *path, char *mode);
+
+/**
+ * @brief Reads data from the given file into the specified memory buffer
+ *
+ * This function provides a custom implementation of the standard C fread,
+ * utilizing an internal cache for optimized performance.
+ *
+ * @param ptr Pointer to the destination memory buffer where the data will be stored
+ * @param size Size of each element to be read, in bytes
+ * @param nmemb Number of elements to be read
+ * @param fp Pointer to the file from which data is to be read
+ *
+ * @return The total number of elements successfully read, which may be less than
+ *         nmemb if an error occurs or the end of the file is reached
+ */
+size_t port_fread(void *ptr, size_t size, size_t nmemb, port_FILE fp);
+
+/**
+ * @brief Initialize SoftSIM filesystem
+ */
+int ss_init_fs(void);
+
+/**
+ * @brief Deinitialize SoftSIM filesystem
+ */
+int ss_deinit_fs(void);
 
 #endif /* FS_PORT_H */