w5500.h File Reference

#include <zrtos/vfs_module.h>
#include <zrtos/vfs/module/network/network.h>
#include <zrtos/vfs/module/w5500/lib/w5500.h>

Include dependency graph for w5500.h:

Go to the source code of this file.

Data Structures
struct	_zrtos_vfs_module_w5500_ioctl_t
struct	_zrtos_vfs_module_w5500_inode_t

Macros
#define	ZRTOS_VFS_MODULE_W5500__CFG_STARTUP_DELAY   600
#define	ZRTOS_VFS_MODULE_W5500__CFG_SPI_CLOCK_RATE   ZRTOS_VFS_MODULE_SPI_SYNC_CONTROL__CLOCK_RATE_4
#define	ZRTOS_VFS_MODULE_W5500__CFG_SPI_CONTROL
#define	ZRTOS_VFS_MODULE_W5500_IOCTL__GET(addr, len)   ((addr << 8) | (0x00 << 6) | len)
#define	ZRTOS_VFS_MODULE_W5500_IOCTL__SET(addr, len)   ((addr << 8) | (0x01 << 6) | len)

Typedefs
typedef struct _zrtos_vfs_module_w5500_ioctl_t	zrtos_vfs_module_w5500_ioctl_t
typedef struct _zrtos_vfs_module_w5500_inode_t	zrtos_vfs_module_w5500_inode_t

Enumerations
enum	zrtos_vfs_module_w5500_mode_t { ZRTOS_VFS_MODULE_W5500_MODE__RST = 0 }
enum	zrtos_vfs_module_w5500_ctl_t {   ZRTOS_VFS_MODULE_W5500_CTL__READ = 0,   ZRTOS_VFS_MODULE_W5500_CTL__WRITE = (1<<2) }

Functions
zrtos_error_t	zrtos_vfs_module_w5500__spi_transfer_uint8 (zrtos_vfs_fd_t fd, uint16_t addr, uint8_t ctl, uint8_t *val)
zrtos_error_t	zrtos_vfs_module_w5500__spi_transfer_uint16 (zrtos_vfs_fd_t fd, uint16_t addr, uint8_t ctl, uint16_t *val)
zrtos_error_t	zrtos_vfs_module_w5500__reset (zrtos_vfs_fd_t fd)
zrtos_error_t	zrtos_vfs_module_w5500__on_mount (zrtos_vfs_dentry_t *thiz)
zrtos_error_t	zrtos_vfs_module_w5500__on_umount (zrtos_vfs_dentry_t *thiz)
	ZRTOS_ASSERT__STATIC (sizeof(int) >=sizeof(uint16_t))
zrtos_error_t	zrtos_vfs_module_w5500__on_ioctl_helper (zrtos_vfs_fd_t fd, char *path, int request, va_list args, uint8_t ctl_bsb, bool(*validate)(uint16_t addr, size_t length))
bool	zrtos_vfs_module_w5500__on_ioctl_helper_validate_addr (uint16_t addr, size_t length)
zrtos_error_t	zrtos_vfs_module_w5500__on_ioctl (zrtos_vfs_file_t *thiz, char *path, int request, va_list args)
	ZRTOS_VFS_PLUGIN__INIT (w5500, ZRTOS_VFS_PLUGIN__0_ON_OPEN_DEFAULT() ZRTOS_VFS_PLUGIN__1_ON_CLOSE_DEFAULT() ZRTOS_VFS_PLUGIN__2_ON_MOUNT(zrtos_vfs_module_w5500__on_mount) ZRTOS_VFS_PLUGIN__3_ON_UMOUNT(zrtos_vfs_module_w5500__on_umount) ZRTOS_VFS_PLUGIN__4_ON_READ_DEFAULT() ZRTOS_VFS_PLUGIN__5_ON_WRITE_DEFAULT() ZRTOS_VFS_PLUGIN__6_ON_CAN_READ_DEFAULT() ZRTOS_VFS_PLUGIN__7_ON_CAN_WRITE_DEFAULT() ZRTOS_VFS_PLUGIN__8_ON_SEEK_DEFAULT() ZRTOS_VFS_PLUGIN__9_ON_IOCTL(zrtos_vfs_module_w5500__on_ioctl))

Macro Definition Documentation

ZRTOS_VFS_MODULE_W5500__CFG_SPI_CLOCK_RATE

#define ZRTOS_VFS_MODULE_W5500__CFG_SPI_CLOCK_RATE   ZRTOS_VFS_MODULE_SPI_SYNC_CONTROL__CLOCK_RATE_4

Definition at line 26 of file w5500.h.

ZRTOS_VFS_MODULE_W5500__CFG_SPI_CONTROL

#define ZRTOS_VFS_MODULE_W5500__CFG_SPI_CONTROL

Value:

(ZRTOS_VFS_MODULE_W5500__CFG_SPI_CLOCK_RATE\
    |ZRTOS_VFS_MODULE_SPI_SYNC_CONTROL__MODE_MASTER\
    |ZRTOS_VFS_MODULE_SPI_SYNC_CONTROL__BITORDER_MSB\
    |ZRTOS_VFS_MODULE_SPI_SYNC_CONTROL__PP_0)

Definition at line 42 of file w5500.h.

ZRTOS_VFS_MODULE_W5500__CFG_STARTUP_DELAY

#define ZRTOS_VFS_MODULE_W5500__CFG_STARTUP_DELAY   600

Definition at line 20 of file w5500.h.

ZRTOS_VFS_MODULE_W5500_IOCTL__GET

#define ZRTOS_VFS_MODULE_W5500_IOCTL__GET	(		addr,
			len
	)		((addr << 8) | (0x00 << 6) | len)

Definition at line 57 of file w5500.h.

ZRTOS_VFS_MODULE_W5500_IOCTL__SET

#define ZRTOS_VFS_MODULE_W5500_IOCTL__SET	(		addr,
			len
	)		((addr << 8) | (0x01 << 6) | len)

Definition at line 59 of file w5500.h.

Typedef Documentation

zrtos_vfs_module_w5500_inode_t

typedef struct _zrtos_vfs_module_w5500_inode_t zrtos_vfs_module_w5500_inode_t

zrtos_vfs_module_w5500_ioctl_t

typedef struct _zrtos_vfs_module_w5500_ioctl_t zrtos_vfs_module_w5500_ioctl_t

Enumeration Type Documentation

zrtos_vfs_module_w5500_ctl_t

enum zrtos_vfs_module_w5500_ctl_t

Enumerator
ZRTOS_VFS_MODULE_W5500_CTL__READ
ZRTOS_VFS_MODULE_W5500_CTL__WRITE

Definition at line 52 of file w5500.h.

            {
     ZRTOS_VFS_MODULE_W5500_CTL__READ  = 0
    ,ZRTOS_VFS_MODULE_W5500_CTL__WRITE = (1<<2)
}zrtos_vfs_module_w5500_ctl_t;

zrtos_vfs_module_w5500_mode_t

enum zrtos_vfs_module_w5500_mode_t

Enumerator
ZRTOS_VFS_MODULE_W5500_MODE__RST

Definition at line 48 of file w5500.h.

            {
     ZRTOS_VFS_MODULE_W5500_MODE__RST  = 0
}zrtos_vfs_module_w5500_mode_t;

Function Documentation

ZRTOS_ASSERT__STATIC()

ZRTOS_ASSERT__STATIC

(

sizeof(int) >=sizeof(uint16_t)

)

Here is the caller graph for this function:

zrtos_vfs_module_w5500__on_ioctl()

zrtos_error_t zrtos_vfs_module_w5500__on_ioctl	(	zrtos_vfs_file_t *	thiz,
		char *	path,
		int	request,
		va_list	args
	)

Definition at line 280 of file w5500.h.

 {
    zrtos_vfs_module_w5500_inode_t *inode_data = ZRTOS_CAST(
         zrtos_vfs_module_w5500_inode_t*
        ,zrtos_vfs_file__get_inode_data(thiz)
    );
    return zrtos_vfs_module_w5500__on_ioctl_helper(
         inode_data->fd
        ,path
        ,request
        ,args
        ,0
        ,zrtos_vfs_module_w5500_socket__on_ioctl_helper_validate_addr
    );
}

Here is the call graph for this function:

zrtos_vfs_module_w5500__on_ioctl_helper()

zrtos_error_t zrtos_vfs_module_w5500__on_ioctl_helper	(	zrtos_vfs_fd_t	fd,
		char *	path,
		int	request,
		va_list	args,
		uint8_t	ctl_bsb,
		bool(*)(uint16_t addr, size_t length)	validate
	)

Definition at line 221 of file w5500.h.

 {
    zrtos_error_t ret;
    uint16_t req = ZRTOS_CAST__REINTERPRET(
         int
        ,request
    );
    uint16_t addr;
    uint8_t ctl;
    size_t length;
    void *value = zrtos_va__arg_ptr(
         args
        ,void*
    );
    size_t value_length = zrtos_va__arg_ptr(
         args
        ,size_t
    );

    length = req & 0xF;
    req >>= 4;
    ctl = req & 0xF | ctl_bsb;
    req >>= 4;
    addr = zrtos_types__htobe16(req);

    //@todo verify endianness
    if(length == value_length
    && validate(addr,length)
    ){
        ret = zrtos_vfs_fd__spi_transfer(
             fd
            ,3
            ,&addr
            ,sizeof(addr)
            ,&ctl
            ,sizeof(ctl)
            ,value
            ,value_length
        );
    }else{
        ret = ZRTOS_ERROR__INVAL;
    }

    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_module_w5500__on_ioctl_helper_validate_addr()

bool zrtos_vfs_module_w5500__on_ioctl_helper_validate_addr	(	uint16_t	addr,
		size_t	length
	)

Definition at line 273 of file w5500.h.

                                                                                       {
    return (
           (addr + length < 0x2F)
        || (addr == 0x39 && length == 1)
    );
}

zrtos_vfs_module_w5500__on_mount()

zrtos_error_t zrtos_vfs_module_w5500__on_mount

(

zrtos_vfs_dentry_t *

thiz

)

Definition at line 204 of file w5500.h.

                                                                        {
    zrtos_vfs_module_w5500_inode_t *inode_data = ZRTOS_CAST(
         zrtos_vfs_module_w5500_inode_t*
        ,zrtos_vfs_dentry__get_data(thiz)
    );
    
    zrtos_gpio__delay_milliseconds(ZRTOS_VFS_MODULE_W5500__CFG_STARTUP_DELAY);

    return zrtos_vfs_module_w5500__reset(inode_data->fd);
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_module_w5500__on_umount()

zrtos_error_t zrtos_vfs_module_w5500__on_umount

(

zrtos_vfs_dentry_t *

thiz

)

Definition at line 215 of file w5500.h.

                                                                         {
    return ZRTOS_ERROR__SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_module_w5500__reset()

zrtos_error_t zrtos_vfs_module_w5500__reset

(

zrtos_vfs_fd_t

fd

)

Definition at line 167 of file w5500.h.

 {
    zrtos_error_t ret;
    size_t llimit = 1;
    uint16_t cmd = zrtos_types__htobe16(MR);
    uint8_t ctl = _W5500_SPI_WRITE_;
    uint8_t mode = MR_RST;
    
    for(size_t l = 2;l--;){
        while(llimit-- && zrtos_error__is_success((ret = zrtos_vfs_fd__spi_transfer(
            inode_data->fd
            ,3
            ,&cmd
            ,sizeof(cmd)
            ,&ctl
            ,sizeof(ctl)
            ,&mode
            ,sizeof(mode)
        ))) && (mode & MR_RST) != 0){
            continue;
        }

        ctl = _W5500_SPI_READ_;
        llimit = ZRTOS_TYPES__SIZE_MAX;
    }

    return zrtos_error__is_success(ret)
         ? (
              (mode & MR_RST) == 0
            ? ZRTOS_ERROR__SUCCESS
            : ZRTOS_ERROR__AGAIN
         )
         : ret
    ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_module_w5500__spi_transfer_uint16()

zrtos_error_t zrtos_vfs_module_w5500__spi_transfer_uint16	(	zrtos_vfs_fd_t	fd,
		uint16_t	addr,
		uint8_t	ctl,
		uint16_t *	val
	)

Definition at line 149 of file w5500.h.

 {
    return zrtos_vfs_fd__spi_transfer(
         fd
        ,3
        ,&addr
        ,sizeof(addr)
        ,&ctl
        ,sizeof(ctl)
        ,val
        ,sizeof(*val)
    );
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_module_w5500__spi_transfer_uint8()

zrtos_error_t zrtos_vfs_module_w5500__spi_transfer_uint8	(	zrtos_vfs_fd_t	fd,
		uint16_t	addr,
		uint8_t	ctl,
		uint8_t *	val
	)

Definition at line 131 of file w5500.h.

 {
    return zrtos_vfs_fd__spi_transfer(
         fd
        ,3
        ,&addr
        ,sizeof(addr)
        ,&ctl
        ,sizeof(ctl)
        ,val
        ,sizeof(*val)
    );
}

Here is the call graph for this function:

ZRTOS_VFS_PLUGIN__INIT()

ZRTOS_VFS_PLUGIN__INIT	(	w5500	,
		ZRTOS_VFS_PLUGIN__0_ON_OPEN_DEFAULT() ZRTOS_VFS_PLUGIN__1_ON_CLOSE_DEFAULT() ZRTOS_VFS_PLUGIN__2_ON_MOUNT(zrtos_vfs_module_w5500__on_mount) ZRTOS_VFS_PLUGIN__3_ON_UMOUNT(zrtos_vfs_module_w5500__on_umount) ZRTOS_VFS_PLUGIN__4_ON_READ_DEFAULT() ZRTOS_VFS_PLUGIN__5_ON_WRITE_DEFAULT() ZRTOS_VFS_PLUGIN__6_ON_CAN_READ_DEFAULT() ZRTOS_VFS_PLUGIN__7_ON_CAN_WRITE_DEFAULT() ZRTOS_VFS_PLUGIN__8_ON_SEEK_DEFAULT() ZRTOS_VFS_PLUGIN__9_ON_IOCTL(zrtos_vfs_module_w5500__on_ioctl)
	)

Here is the caller graph for this function: