fsaccess.h File Reference

#include <stdio.h>
#include "file.h"
#include "navigation.h"
#include "ctrl_access.h"

Macros
#define	O_APPEND   0x0008
#define	O_CREAT   0x0200
#define	O_RDONLY   0
#define	O_RDWR   0x0002
#define	O_WRONLY   0x0001

Typedefs
typedef signed int	ssize_t

Functions
bool	b_fsaccess_init (void)
	This function initializes mutex and navigators. More...
int	close (int fd)
	This function closes a file. More...
long	fsaccess_alloc_nav_id (void)
	This function returns a free navigator id. More...
size_t	fsaccess_file_get_size (int fd)
	This function returns the opened file size. More...
void	fsaccess_free_nav_id (int fd)
	This function frees a navigator id. More...
void	fsaccess_give_mutex (void)
	This function frees the mutex. More...
int8_t	fsaccess_IsDirPresent (const char *pcStringDirName)
	Is a directory present? More...
void	fsaccess_take_mutex (void)
	This function gives the mutex to the caller. More...
int	open (const char *pathname, int flags,...)
	This function opens a file. More...
ssize_t	read (int fd, void *buf, size_t count)
	This function reads from a file. More...
ssize_t	write (int fd, const void *buf, size_t count)
	This function writes to a file. More...

#define O_APPEND   0x0008

Referenced by main(), open(), and prv_xopen_current_logfile().

#define O_CREAT   0x0200

Referenced by main(), open(), and prv_xopen_current_logfile().

#define O_RDONLY   0

Referenced by config_file_get_value(), config_file_set_value(), fsaccess_example_read(), fsaccess_example_write(), and init_mparams().

#define O_RDWR   0x0002

Referenced by open().

#define O_WRONLY   0x0001

Referenced by config_file_set_value(), open(), and prv_xopen_current_logfile().

typedef signed int ssize_t

bool b_fsaccess_init

(

void

)

This function initializes mutex and navigators.

References nav_reset(), NULL, and vSemaphoreCreateBinary.

Referenced by main().

int close

(

int

fd

)

This function closes a file.

Parameters

fd	file descriptor.

Returns

int : -1 if error, 0 otherwise

References file_close(), fsaccess_free_nav_id(), fsaccess_give_mutex(), fsaccess_take_mutex(), and nav_select().

Referenced by config_file_get_value(), config_file_set_value(), fsaccess_example_read(), fsaccess_example_write(), init_mparams(), prv_vsave_logs(), and prv_xopen_current_logfile().

long fsaccess_alloc_nav_id

(

void

)

This function returns a free navigator id.

Returns

long : Id navigator allocated or -1 if none free

References FS_NB_NAVIGATOR, FS_NB_RESERVED_NAV, j, pvNavUsed, Set_bits, and Tst_bits.

Referenced by fsaccess_IsDirPresent(), open(), portTASK_FUNCTION(), and vStartCom1Shell().

size_t fsaccess_file_get_size

(

int

fd

)

This function returns the opened file size.

Parameters

fd	file descriptor.

Returns

size_t : size of the file pointed to by the descriptor

References fsaccess_give_mutex(), fsaccess_take_mutex(), nav_file_lgt(), and nav_select().

Referenced by config_file_get_value(), config_file_set_value(), fsaccess_example_read(), fsaccess_example_write(), prv_cat(), and prv_xopen_current_logfile().

void fsaccess_free_nav_id

(

int

fd

)

This function frees a navigator id.

Parameters

fd	file descriptor.

References Clr_bits, and pvNavUsed.

Referenced by close(), fsaccess_IsDirPresent(), and open().

void fsaccess_give_mutex

(

void

)

This function frees the mutex.

References xSemaphoreGive.

Referenced by close(), e_fscmds_cd(), e_fscmds_format(), e_fscmds_mount(), e_fscmds_rm(), e_fscmds_rm_all(), e_fscmds_shell_fat(), e_fscmds_shell_goto(), e_fscmds_shell_mark(), e_fscmds_shell_mkdir(), e_fscmds_shell_mv(), e_fscmds_shell_pwd(), e_fscmds_touch(), fsaccess_file_get_size(), fsaccess_IsDirPresent(), host_mass_storage_task_sync_drives(), open(), portTASK_FUNCTION(), prv_append(), prv_cat(), prv_cp(), prv_df(), prv_ls(), prvCommonErrorLeave(), read(), v_com1shell_mount_local_drive(), vStartCom1Shell(), and write().

int8_t fsaccess_IsDirPresent

(

const char *

pcStringDirName

)

Is a directory present?

Parameters

pcStringDirName

Input. Directory name string.

Returns

1 if the directory exists, 0 if the directory doesn't exist, else -1

References false, fsaccess_alloc_nav_id(), fsaccess_free_nav_id(), fsaccess_give_mutex(), fsaccess_take_mutex(), nav_select(), and nav_setcwd().

Referenced by prv_xopen_current_logfile().

void fsaccess_take_mutex

(

void

)

This function gives the mutex to the caller.

References pdTRUE, and xSemaphoreTake.

Referenced by close(), e_fscmds_cd(), e_fscmds_format(), e_fscmds_mount(), e_fscmds_rm(), e_fscmds_rm_all(), e_fscmds_shell_fat(), e_fscmds_shell_goto(), e_fscmds_shell_mark(), e_fscmds_shell_mkdir(), e_fscmds_shell_mv(), e_fscmds_shell_pwd(), e_fscmds_touch(), fsaccess_file_get_size(), fsaccess_IsDirPresent(), host_mass_storage_task_sync_drives(), open(), portTASK_FUNCTION(), prv_append(), prv_cat(), prv_cp(), prv_df(), prv_ls(), read(), v_com1shell_mount_local_drive(), vStartCom1Shell(), and write().

int open	(	const char *	pathname,
		int	flags,
			...
	)

This function opens a file.

Parameters

pathname	path of the file to open.
flags	flags to give file access rights should be O_CREAT : create file if not exist O_APPEND : add data to the end of file O_RDONLY : Read Only O_WRONLY : Write Only O_RDWR : Read/Write

Returns

int : file descriptor (>= 0 if OK (NavID), -1 otherwise)

This function opens a file.

This function opens a file.

Parameters

pathname	path of the file to open.
flags	flags to give file access rights should be O_CREAT : create file if not exist O_APPEND : add data to the end of file O_RDONLY : Read Only O_WRONLY : Write Only O_RDWR : Read/Write

Returns

int : file descriptor (>= 0 if OK (NavID), -1 otherwise)

References error_exit(), file_open(), FOPEN_MODE_APPEND, FOPEN_MODE_R, FOPEN_MODE_R_PLUS, FOPEN_MODE_W, fsaccess_alloc_nav_id(), fsaccess_free_nav_id(), fsaccess_give_mutex(), fsaccess_take_mutex(), nav_select(), nav_setcwd(), O_APPEND, O_CREAT, O_RDWR, and O_WRONLY.

Referenced by config_file_get_value(), config_file_set_value(), fsaccess_example_read(), fsaccess_example_write(), init_mparams(), and prv_xopen_current_logfile().

ssize_t read	(	int	fd,
		void *	buf,
		size_t	count
	)

This function reads from a file.

Parameters

fd	file descriptor.
buf	pointer for data that are read.
count	amount of bytes to read

Returns

ssize_t : amount of data read (-1 if error)

References buf, file_eof(), file_read_buf(), fsaccess_give_mutex(), fsaccess_take_mutex(), and nav_select().

Referenced by config_file_get_value(), config_file_set_value(), fsaccess_example_read(), fsaccess_example_write(), init_mparams(), prv_cat(), and sensor_read().

ssize_t write	(	int	fd,
		const void *	buf,
		size_t	count
	)

This function writes to a file.

Parameters

fd	file descriptor.
buf	pointer from where data are written.
count	amount of bytes to write

Returns

ssize_t : amount of data written (-1 if error)

References buf, file_write_buf(), fsaccess_give_mutex(), fsaccess_take_mutex(), and nav_select().

Referenced by config_file_set_value(), fsaccess_example_write(), and prv_vsave_logs().