ZEReader/doxygen/sd_8h_source.html

/*

 * SPDX-FileCopyrightText: 2025 Anna-Lena Marx <mail@marx.engineer>

 *

 * SPDX-License-Identifier: MPL-2.0

 */


#ifndef _SD_H_

#define _SD_H_


#include <stddef.h>

#include <zephyr/fs/fs.h>


#define SD_MOUNTPOINT "/SD:"

#define SD_ROOTPATH "/SD:/"


char *sd_build_full_path(const char *folder, const char *filename, int *error);


int sd_initialize(void);


int sd_open(char const *const path, struct fs_file_t *f_obj);


int sd_close(struct fs_file_t *f_obj);


int sd_read(struct fs_file_t *f_obj, char *buffer, size_t *size);


int sd_read_chunk(char const *const path, size_t *offset, char *const buffer, size_t *size);


// int sd_write();


int sd_write_chunk(char const *const path, char const *const data, size_t *size);


int sd_list_directories(char const *const path, char *buffer, size_t *size);


int sd_tell_end_offset(char const *const path, size_t *offset);


#endif

sd_open
int sd_open(char const *const path, struct fs_file_t *f_obj)
Open a file on a SD card.

sd_list_directories
int sd_list_directories(char const *const path, char *buffer, size_t *size)
List the directories on the SD card.

sd_read
int sd_read(struct fs_file_t *f_obj, char *buffer, size_t *size)
Read from a file on a SD card.

sd_close
int sd_close(struct fs_file_t *f_obj)
Close a file on a SD card.

sd_read_chunk
int sd_read_chunk(char const *const path, size_t *offset, char *const buffer, size_t *size)
Open, read from a file on SD card and close it.

sd_initialize
int sd_initialize(void)
Initializes the SD card communication.

sd_write_chunk
int sd_write_chunk(char const *const path, char const *const data, size_t *size)
Open, write to a file on SD card and close it.

sd_tell_end_offset
int sd_tell_end_offset(char const *const path, size_t *offset)
Get the current location of the file pointer inside the file.

sd_build_full_path
char * sd_build_full_path(const char *folder, const char *filename, int *error)
Returns a char pointer on the fully built-up SD card path.