vfs_fd.h File Reference

#include <zrtos/bitfield.h>
#include <zrtos/vfs_file.h>

Include dependency graph for vfs_fd.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_vfs_fd_t
struct	_zrtos_vfs_fd_set_t

Macros
#define	ZRTOS_VFS_FD_SET__EACH_BEGIN(thiz, fd_)
#define	ZRTOS_VFS_FD_SET__EACH_END   }

Typedefs
typedef struct _zrtos_vfs_fd_t	zrtos_vfs_fd_t
typedef struct _zrtos_vfs_fd_set_t	zrtos_vfs_fd_set_t

Functions
void	zrtos_vfs_fd_set__clear (zrtos_vfs_fd_set_t *thiz, zrtos_vfs_fd_t fd)
bool	zrtos_vfs_fd_set__is_set (zrtos_vfs_fd_set_t *thiz, zrtos_vfs_fd_t fd)
void	zrtos_vfs_fd_set__set (zrtos_vfs_fd_set_t *thiz, zrtos_vfs_fd_t fd)
void	zrtos_vfs_fd_set__zero (zrtos_vfs_fd_set_t *thiz)
void	zrtos_vfs_fd_set__copy (zrtos_vfs_fd_set_t *thiz, zrtos_vfs_fd_set_t *src)
bool	zrtos_vfs_fd_set__init (zrtos_vfs_fd_set_t *thiz)
zrtos_error_t	zrtos_vfs_fd__open (char *path, zrtos_vfs_fd_t *thiz, void *file_ctx)
zrtos_error_t	zrtos_vfs_fd__close (zrtos_vfs_fd_t thiz)
zrtos_error_t	zrtos_vfs_fd__read (zrtos_vfs_fd_t thiz, char *path, void *buffer, size_t len, size_t offset, size_t *outlen)
zrtos_error_t	zrtos_vfs_fd__spi_transfer (zrtos_vfs_fd_t fd, size_t len,...)
bool	zrtos_vfs_fd__is_sync_again_error (zrtos_error_t ret)
zrtos_error_t	zrtos_vfs_fd__read_sync (zrtos_vfs_fd_t thiz, char *path, void *buffer, size_t len, size_t offset)
zrtos_error_t	zrtos_vfs_fd__write (zrtos_vfs_fd_t thiz, char *path, void *buffer, size_t len, size_t offset, size_t *outlen)
zrtos_error_t	zrtos_vfs_fd__write_sync (zrtos_vfs_fd_t thiz, char *path, void *buffer, size_t len, size_t offset)
zrtos_error_t	zrtos_vfs_fd__ioctl (zrtos_vfs_fd_t thiz, char *path, int request,...)
zrtos_error_t	zrtos_vfs_fd__can_read (zrtos_vfs_fd_t thiz)
zrtos_error_t	zrtos_vfs_fd__can_write (zrtos_vfs_fd_t thiz)
size_t	zrtos_vfs_fd__select (zrtos_vfs_fd_set_t *readfds, zrtos_vfs_fd_set_t *writefds)

Macro Definition Documentation

ZRTOS_VFS_FD_SET__EACH_BEGIN

#define ZRTOS_VFS_FD_SET__EACH_BEGIN	(		thiz,
			fd_
	)

Value:

ZRTOS_BITFIELD__EACH(\
         (thiz)->fds_bits\
        ,ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX / ZRTOS_BITFIELD__NFDBITS\
        ,pos\
    ){\
        zrtos_vfs_fd_t fd_ = {.fd = pos};

Definition at line 341 of file vfs_fd.h.

ZRTOS_VFS_FD_SET__EACH_END

#define ZRTOS_VFS_FD_SET__EACH_END   }

Definition at line 349 of file vfs_fd.h.

Typedef Documentation

zrtos_vfs_fd_set_t

typedef struct _zrtos_vfs_fd_set_t zrtos_vfs_fd_set_t

zrtos_vfs_fd_t

typedef struct _zrtos_vfs_fd_t zrtos_vfs_fd_t

Function Documentation

zrtos_vfs_fd__can_read()

zrtos_error_t zrtos_vfs_fd__can_read

(

zrtos_vfs_fd_t

thiz

)

Definition at line 278 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;

    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__can_read(
             &zrtos_vfs_file__index[fd]
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__can_write()

zrtos_error_t zrtos_vfs_fd__can_write

(

zrtos_vfs_fd_t

thiz

)

Definition at line 293 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;

    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__can_write(
             &zrtos_vfs_file__index[fd]
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__close()

zrtos_error_t zrtos_vfs_fd__close

(

zrtos_vfs_fd_t

thiz

)

Definition at line 77 of file vfs_fd.h.

                                                      {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;

    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__close(&zrtos_vfs_file__index[fd]);
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__ioctl()

zrtos_error_t zrtos_vfs_fd__ioctl	(	zrtos_vfs_fd_t	thiz,
		char *	path,
		int	request,
			...
	)

Definition at line 254 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;
    va_list       args;

    va_start(args,request);
    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__ioctl_va(
             &zrtos_vfs_file__index[fd]
            ,path
            ,request
            ,args
        );
    }
    va_end(args);

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__is_sync_again_error()

bool zrtos_vfs_fd__is_sync_again_error

(

zrtos_error_t

ret

)

Definition at line 163 of file vfs_fd.h.

                                                         {
    return ret == ZRTOS_ERROR__AGAIN
        || ret == ZRTOS_ERROR__WOULDBLOCK
    ;
}

Here is the caller graph for this function:

zrtos_vfs_fd__open()

zrtos_error_t zrtos_vfs_fd__open	(	char *	path,
		zrtos_vfs_fd_t *	thiz,
		void *	file_ctx
	)

Definition at line 70 of file vfs_fd.h.

                                                                                {
    zrtos_vfs_file_t *file;
    zrtos_error_t ret = zrtos_vfs_file__open(path,&file,file_ctx);
    thiz->fd = file - (&zrtos_vfs_file__index[0]);
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__read()

zrtos_error_t zrtos_vfs_fd__read	(	zrtos_vfs_fd_t	thiz,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset,
		size_t *	outlen
	)

Definition at line 88 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;

    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__read(
             &zrtos_vfs_file__index[fd]
            ,path
            ,buffer
            ,len
            ,offset
            ,outlen
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__read_sync()

zrtos_error_t zrtos_vfs_fd__read_sync	(	zrtos_vfs_fd_t	thiz,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset
	)

Definition at line 169 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__AGAIN;
    size_t outlen;
    uint8_t *data = ZRTOS_CAST(uint8_t*,buffer);

    while(len && zrtos_vfs_fd__is_sync_again_error(ret)){
        ret = zrtos_vfs_fd__read(
             thiz
            ,path
            ,data
            ,len
            ,offset
            ,&outlen
        );
        if(zrtos_error__is_success(ret)){
            len -= outlen;
            offset += outlen;
            data += outlen;
        }
    }

    return ret;
}

Here is the call graph for this function:

zrtos_vfs_fd__select()

size_t zrtos_vfs_fd__select	(	zrtos_vfs_fd_set_t *	readfds,
		zrtos_vfs_fd_set_t *	writefds
	)

Definition at line 308 of file vfs_fd.h.

 {
    size_t ret = 0;
    ZRTOS_TYPES__TYPEOF(zrtos_vfs_fd__can_read) callback = zrtos_vfs_fd__can_read;
    zrtos_bitfield_t *bitfield = readfds->fds_bits;
    size_t l = 1;

    while(l--){
        ZRTOS_BITFIELD__EACH(
             bitfield
            ,ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX / ZRTOS_BITFIELD__NFDBITS
            ,pos
        ){
            zrtos_vfs_fd_t fd = {.fd = pos};
            if(ZRTOS_ERROR__AGAIN == callback(fd)){
                zrtos_bitfield__set(
                     bitfield
                    ,fd.fd
                    ,false
                );
            }else{
                ret++;
            }
        }
        callback = zrtos_vfs_fd__can_write;
        bitfield = writefds->fds_bits;
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__spi_transfer()

zrtos_error_t zrtos_vfs_fd__spi_transfer	(	zrtos_vfs_fd_t	fd,
		size_t	len,
			...
	)

Definition at line 113 of file vfs_fd.h.

 {
    size_t l = 0;
    uint8_t ll;
    zrtos_error_t ret = ZRTOS_ERROR__SUCCESS;
    zrtos_va_t args1;
    zrtos_va_t args2;
    size_t outlen;

    zrtos_va__start(len,args1);
    zrtos_va__copy(args2,args1);

    while(len--){
        zrtos_va__arg_ptr(args2,void*);
        l += zrtos_va__arg(args2,size_t);
    }

    ll = l;

    ret = zrtos_vfs_fd__read(
         fd
        ,(char*)""
        ,&ll
        ,1
        ,0
        ,&outlen
    );

    while(zrtos_error__is_success(ret) && len--){
        void *buffer = zrtos_va__arg_ptr(args,void*);
        size_t length = zrtos_va__arg(args,size_t);
        ret = zrtos_vfs_fd__read(
             fd
            ,(char*)""
            ,buffer
            ,length
            ,0
            ,&outlen
        );
    }

    zrtos_va__end(args1);
    zrtos_va__end(args2);

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__write()

zrtos_error_t zrtos_vfs_fd__write	(	zrtos_vfs_fd_t	thiz,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset,
		size_t *	outlen
	)

Definition at line 199 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__INVAL;
    ZRTOS_TYPES__TYPEOF(thiz.fd) fd = thiz.fd;

    if(fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX){
        ret = zrtos_vfs_file__write(
             &zrtos_vfs_file__index[fd]
            ,path
            ,buffer
            ,len
            ,offset
            ,outlen
        );
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd__write_sync()

zrtos_error_t zrtos_vfs_fd__write_sync	(	zrtos_vfs_fd_t	thiz,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset
	)

Definition at line 224 of file vfs_fd.h.

 {
    zrtos_error_t ret = ZRTOS_ERROR__AGAIN;
    size_t outlen;
    uint8_t *data = ZRTOS_CAST(uint8_t*,buffer);

    while(len && zrtos_vfs_fd__is_sync_again_error(ret)){
        ret = zrtos_vfs_fd__write(
             thiz
            ,path
            ,data
            ,len
            ,offset
            ,&outlen
        );
        if(zrtos_error__is_success(ret)){
            len -= outlen;
            offset += outlen;
            data += outlen;
        }
    }

    return ret;
}

Here is the call graph for this function:

zrtos_vfs_fd_set__clear()

void zrtos_vfs_fd_set__clear	(	zrtos_vfs_fd_set_t *	thiz,
		zrtos_vfs_fd_t	fd
	)

Definition at line 27 of file vfs_fd.h.

                                                                        {
    zrtos_bitfield__set(
         thiz->fds_bits
        ,fd.fd
        ,false
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd_set__copy()

void zrtos_vfs_fd_set__copy	(	zrtos_vfs_fd_set_t *	thiz,
		zrtos_vfs_fd_set_t *	src
	)

Definition at line 57 of file vfs_fd.h.

                                                                             {
    zrtos_bitfield__copy(
         thiz->fds_bits
        ,src->fds_bits
        ,ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX / ZRTOS_BITFIELD__NFDBITS
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd_set__init()

bool zrtos_vfs_fd_set__init

(

zrtos_vfs_fd_set_t *

thiz

)

Definition at line 65 of file vfs_fd.h.

                                                     {
    zrtos_vfs_fd_set__zero(thiz);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd_set__is_set()

bool zrtos_vfs_fd_set__is_set	(	zrtos_vfs_fd_set_t *	thiz,
		zrtos_vfs_fd_t	fd
	)

Definition at line 35 of file vfs_fd.h.

                                                                         {
    return zrtos_bitfield__get(
         thiz->fds_bits
        ,fd.fd
    );
}

Here is the call graph for this function:

zrtos_vfs_fd_set__set()

void zrtos_vfs_fd_set__set	(	zrtos_vfs_fd_set_t *	thiz,
		zrtos_vfs_fd_t	fd
	)

Definition at line 42 of file vfs_fd.h.

                                                                      {
    zrtos_bitfield__set(
         thiz->fds_bits
        ,fd.fd
        ,true
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_fd_set__zero()

void zrtos_vfs_fd_set__zero

(

zrtos_vfs_fd_set_t *

thiz

)

Definition at line 50 of file vfs_fd.h.

                                                     {
    zrtos_bitfield__zero(
         thiz->fds_bits
        ,ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX / ZRTOS_BITFIELD__NFDBITS
    );
}

Here is the call graph for this function:

Here is the caller graph for this function: