Socket APIs
Macros | Functions
Socket register access functions

These are functions to access socket registers. More...

Collaboration diagram for Socket register access functions:

Macros

#define setSn_MR(sn, mr)   WIZCHIP_WRITE(Sn_MR(sn),mr)
 Set Sn_MR register. More...
 
#define getSn_MR(sn)   WIZCHIP_READ(Sn_MR(sn))
 Get Sn_MR register. More...
 
#define setSn_CR(sn, cr)   WIZCHIP_WRITE(Sn_CR(sn), cr)
 Set Sn_CR register. More...
 
#define getSn_CR(sn)   WIZCHIP_READ(Sn_CR(sn))
 Get Sn_CR register. More...
 
#define setSn_IR(sn, ir)   WIZCHIP_WRITE(Sn_IR(sn), (ir & 0x1F))
 Set Sn_IR register. More...
 
#define getSn_IR(sn)   (WIZCHIP_READ(Sn_IR(sn)) & 0x1F)
 Get Sn_IR register. More...
 
#define setSn_IMR(sn, imr)   WIZCHIP_WRITE(Sn_IMR(sn), (imr & 0x1F))
 Set Sn_IMR register. More...
 
#define getSn_IMR(sn)   (WIZCHIP_READ(Sn_IMR(sn)) & 0x1F)
 Get Sn_IMR register. More...
 
#define getSn_SR(sn)   WIZCHIP_READ(Sn_SR(sn))
 Get Sn_SR register. More...
 
#define setSn_PORT(sn, port)
 Set Sn_PORT register. More...
 
#define getSn_PORT(sn)   ((WIZCHIP_READ(Sn_PORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_PORT(sn),1)))
 Get Sn_PORT register. More...
 
#define setSn_DHAR(sn, dhar)   WIZCHIP_WRITE_BUF(Sn_DHAR(sn), dhar, 6)
 Set Sn_DHAR register. More...
 
#define getSn_DHAR(sn, dhar)   WIZCHIP_READ_BUF(Sn_DHAR(sn), dhar, 6)
 Get Sn_MR register. More...
 
#define setSn_DIPR(sn, dipr)   WIZCHIP_WRITE_BUF(Sn_DIPR(sn), dipr, 4)
 Set Sn_DIPR register. More...
 
#define getSn_DIPR(sn, dipr)   WIZCHIP_READ_BUF(Sn_DIPR(sn), dipr, 4)
 Get Sn_DIPR register. More...
 
#define setSn_DPORT(sn, dport)
 Set Sn_DPORT register. More...
 
#define getSn_DPORT(sn)   ((WIZCHIP_READ(Sn_DPORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_DPORT(sn),1)))
 Get Sn_DPORT register. More...
 
#define setSn_MSSR(sn, mss)
 Set Sn_MSSR register. More...
 
#define getSn_MSSR(sn)   ((WIZCHIP_READ(Sn_MSSR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_MSSR(sn),1)))
 Get Sn_MSSR register. More...
 
#define setSn_TOS(sn, tos)   WIZCHIP_WRITE(Sn_TOS(sn), tos)
 Set Sn_TOS register. More...
 
#define getSn_TOS(sn)   WIZCHIP_READ(Sn_TOS(sn))
 Get Sn_TOS register. More...
 
#define setSn_TTL(sn, ttl)   WIZCHIP_WRITE(Sn_TTL(sn), ttl)
 Set Sn_TTL register. More...
 
#define getSn_TTL(sn)   WIZCHIP_READ(Sn_TTL(sn))
 Get Sn_TTL register. More...
 
#define setSn_RXBUF_SIZE(sn, rxbufsize)   WIZCHIP_WRITE(Sn_RXBUF_SIZE(sn),rxbufsize)
 Set Sn_RXBUF_SIZE register. More...
 
#define getSn_RXBUF_SIZE(sn)   WIZCHIP_READ(Sn_RXBUF_SIZE(sn))
 Get Sn_RXBUF_SIZE register. More...
 
#define setSn_TXBUF_SIZE(sn, txbufsize)   WIZCHIP_WRITE(Sn_TXBUF_SIZE(sn), txbufsize)
 Set Sn_TXBUF_SIZE register. More...
 
#define getSn_TXBUF_SIZE(sn)   WIZCHIP_READ(Sn_TXBUF_SIZE(sn))
 Get Sn_TXBUF_SIZE register. More...
 
#define getSn_TX_RD(sn)   ((WIZCHIP_READ(Sn_TX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_RD(sn),1)))
 Get Sn_TX_RD register. More...
 
#define setSn_TX_WR(sn, txwr)
 Set Sn_TX_WR register. More...
 
#define getSn_TX_WR(sn)   ((WIZCHIP_READ(Sn_TX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_WR(sn),1)))
 Get Sn_TX_WR register. More...
 
#define setSn_RX_RD(sn, rxrd)
 Set Sn_RX_RD register. More...
 
#define getSn_RX_RD(sn)   ((WIZCHIP_READ(Sn_RX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_RD(sn),1)))
 Get Sn_RX_RD register. More...
 
#define getSn_RX_WR(sn)   ((WIZCHIP_READ(Sn_RX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_WR(sn),1)))
 Get Sn_RX_WR register. More...
 
#define setSn_FRAG(sn, frag)
 Set Sn_FRAG register. More...
 
#define getSn_FRAG(sn)   ((WIZCHIP_READ(Sn_FRAG(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_FRAG(sn),1)))
 Get Sn_FRAG register. More...
 
#define setSn_KPALVTR(sn, kpalvt)   WIZCHIP_WRITE(Sn_KPALVTR(sn), kpalvt)
 Set Sn_KPALVTR register. More...
 
#define getSn_KPALVTR(sn)   WIZCHIP_READ(Sn_KPALVTR(sn))
 Get Sn_KPALVTR register. More...
 

Functions

uint16_t getSn_TX_FSR (uint8_t sn)
 Get Sn_TX_FSR register. More...
 
uint16_t getSn_RX_RSR (uint8_t sn)
 Get Sn_RX_RSR register. More...
 

Detailed Description

These are functions to access socket registers.

Macro Definition Documentation

#define setSn_MR (   sn,
  mr 
)    WIZCHIP_WRITE(Sn_MR(sn),mr)

Set Sn_MR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)mrValue to set Sn_MR
See Also
getSn_MR()

Definition at line 1595 of file w5500.h.

Referenced by socket().

#define getSn_MR (   sn)    WIZCHIP_READ(Sn_MR(sn))

Get Sn_MR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_MR.
See Also
setSn_MR()

Definition at line 1605 of file w5500.h.

Referenced by getsockopt(), recvfrom(), and sendto().

#define setSn_CR (   sn,
  cr 
)    WIZCHIP_WRITE(Sn_CR(sn), cr)

Set Sn_CR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)crValue to set Sn_CR
See Also
getSn_CR()

Definition at line 1615 of file w5500.h.

Referenced by close(), connect(), disconnect(), listen(), recv(), recvfrom(), send(), sendto(), setsockopt(), and socket().

#define getSn_CR (   sn)    WIZCHIP_READ(Sn_CR(sn))

Get Sn_CR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_CR.
See Also
setSn_CR()

Definition at line 1625 of file w5500.h.

Referenced by close(), connect(), disconnect(), listen(), recv(), recvfrom(), send(), sendto(), setsockopt(), and socket().

#define setSn_IR (   sn,
  ir 
)    WIZCHIP_WRITE(Sn_IR(sn), (ir & 0x1F))

Set Sn_IR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)irValue to set Sn_IR
See Also
getSn_IR()

Definition at line 1635 of file w5500.h.

Referenced by close(), connect(), ctlsocket(), send(), sendto(), and setsockopt().

#define getSn_IR (   sn)    (WIZCHIP_READ(Sn_IR(sn)) & 0x1F)

Get Sn_IR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_IR.
See Also
setSn_IR()

Definition at line 1645 of file w5500.h.

Referenced by connect(), ctlsocket(), disconnect(), send(), sendto(), and setsockopt().

#define setSn_IMR (   sn,
  imr 
)    WIZCHIP_WRITE(Sn_IMR(sn), (imr & 0x1F))

Set Sn_IMR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)imrValue to set Sn_IMR
See Also
getSn_IMR()

Definition at line 1655 of file w5500.h.

Referenced by ctlsocket().

#define getSn_IMR (   sn)    (WIZCHIP_READ(Sn_IMR(sn)) & 0x1F)

Get Sn_IMR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_IMR.
See Also
setSn_IMR()

Definition at line 1665 of file w5500.h.

Referenced by ctlsocket().

#define getSn_SR (   sn)    WIZCHIP_READ(Sn_SR(sn))

Get Sn_SR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_SR.

Definition at line 1674 of file w5500.h.

Referenced by close(), connect(), disconnect(), getsockopt(), listen(), recv(), recvfrom(), send(), sendto(), and socket().

#define setSn_PORT (   sn,
  port 
)
Value:
{ \
WIZCHIP_WRITE(Sn_PORT(sn), (uint8_t)(port >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_PORT(sn),1), (uint8_t) port); \
}

Set Sn_PORT register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)portValue to set Sn_PORT.
See Also
getSn_PORT()

Definition at line 1684 of file w5500.h.

Referenced by socket().

#define getSn_PORT (   sn)    ((WIZCHIP_READ(Sn_PORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_PORT(sn),1)))

Get Sn_PORT register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_PORT.
See Also
setSn_PORT()

Definition at line 1696 of file w5500.h.

#define setSn_DHAR (   sn,
  dhar 
)    WIZCHIP_WRITE_BUF(Sn_DHAR(sn), dhar, 6)

Set Sn_DHAR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t*)dharPointer variable to set socket n destination hardware address. It should be allocated 6 bytes.
See Also
getSn_DHAR()

Definition at line 1706 of file w5500.h.

#define getSn_DHAR (   sn,
  dhar 
)    WIZCHIP_READ_BUF(Sn_DHAR(sn), dhar, 6)

Get Sn_MR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t*)dharPointer variable to get socket n destination hardware address. It should be allocated 6 bytes.
See Also
setSn_DHAR()

Definition at line 1716 of file w5500.h.

#define setSn_DIPR (   sn,
  dipr 
)    WIZCHIP_WRITE_BUF(Sn_DIPR(sn), dipr, 4)

Set Sn_DIPR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t*)diprPointer variable to set socket n destination IP address. It should be allocated 4 bytes.
See Also
getSn_DIPR()

Definition at line 1726 of file w5500.h.

Referenced by connect(), sendto(), and setsockopt().

#define getSn_DIPR (   sn,
  dipr 
)    WIZCHIP_READ_BUF(Sn_DIPR(sn), dipr, 4)

Get Sn_DIPR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t*)diprPointer variable to get socket n destination IP address. It should be allocated 4 bytes.
See Also
SetSn_DIPR()

Definition at line 1736 of file w5500.h.

Referenced by getsockopt().

#define setSn_DPORT (   sn,
  dport 
)
Value:
{ \
WIZCHIP_WRITE(Sn_DPORT(sn), (uint8_t) (dport>>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_DPORT(sn),1), (uint8_t) dport); \
}

Set Sn_DPORT register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)dportValue to set Sn_DPORT
See Also
getSn_DPORT()

Definition at line 1746 of file w5500.h.

Referenced by connect(), sendto(), and setsockopt().

#define getSn_DPORT (   sn)    ((WIZCHIP_READ(Sn_DPORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_DPORT(sn),1)))

Get Sn_DPORT register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_DPORT.
See Also
setSn_DPORT()

Definition at line 1758 of file w5500.h.

Referenced by getsockopt().

#define setSn_MSSR (   sn,
  mss 
)
Value:
{ \
WIZCHIP_WRITE(Sn_MSSR(sn), (uint8_t)(mss>>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_MSSR(sn),1), (uint8_t) mss); \
}

Set Sn_MSSR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)mssValue to set Sn_MSSR
See Also
setSn_MSSR()

Definition at line 1768 of file w5500.h.

Referenced by setsockopt().

#define getSn_MSSR (   sn)    ((WIZCHIP_READ(Sn_MSSR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_MSSR(sn),1)))

Get Sn_MSSR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_MSSR.
See Also
setSn_MSSR()

Definition at line 1780 of file w5500.h.

Referenced by getsockopt().

#define setSn_TOS (   sn,
  tos 
)    WIZCHIP_WRITE(Sn_TOS(sn), tos)

Set Sn_TOS register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)tosValue to set Sn_TOS
See Also
getSn_TOS()

Definition at line 1790 of file w5500.h.

Referenced by setsockopt().

#define getSn_TOS (   sn)    WIZCHIP_READ(Sn_TOS(sn))

Get Sn_TOS register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_TOS.
See Also
setSn_TOS()

Definition at line 1800 of file w5500.h.

Referenced by getsockopt().

#define setSn_TTL (   sn,
  ttl 
)    WIZCHIP_WRITE(Sn_TTL(sn), ttl)

Set Sn_TTL register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)ttlValue to set Sn_TTL
See Also
getSn_TTL()

Definition at line 1810 of file w5500.h.

Referenced by setsockopt().

#define getSn_TTL (   sn)    WIZCHIP_READ(Sn_TTL(sn))

Get Sn_TTL register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_TTL.
See Also
setSn_TTL()

Definition at line 1821 of file w5500.h.

Referenced by getsockopt().

#define setSn_RXBUF_SIZE (   sn,
  rxbufsize 
)    WIZCHIP_WRITE(Sn_RXBUF_SIZE(sn),rxbufsize)

Set Sn_RXBUF_SIZE register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)rxbufsizeValue to set Sn_RXBUF_SIZE
See Also
getSn_RXBUF_SIZE()

Definition at line 1832 of file w5500.h.

Referenced by wizchip_init().

#define getSn_RXBUF_SIZE (   sn)    WIZCHIP_READ(Sn_RXBUF_SIZE(sn))

Get Sn_RXBUF_SIZE register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_RXBUF_SIZE.
See Also
setSn_RXBUF_SIZE()

Definition at line 1843 of file w5500.h.

#define setSn_TXBUF_SIZE (   sn,
  txbufsize 
)    WIZCHIP_WRITE(Sn_TXBUF_SIZE(sn), txbufsize)

Set Sn_TXBUF_SIZE register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)txbufsizeValue to set Sn_TXBUF_SIZE
See Also
getSn_TXBUF_SIZE()

Definition at line 1853 of file w5500.h.

Referenced by wizchip_init().

#define getSn_TXBUF_SIZE (   sn)    WIZCHIP_READ(Sn_TXBUF_SIZE(sn))

Get Sn_TXBUF_SIZE register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_TXBUF_SIZE.
See Also
setSn_TXBUF_SIZE()

Definition at line 1863 of file w5500.h.

#define getSn_TX_RD (   sn)    ((WIZCHIP_READ(Sn_TX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_RD(sn),1)))

Get Sn_TX_RD register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_TX_RD.

Definition at line 1880 of file w5500.h.

Referenced by send().

#define setSn_TX_WR (   sn,
  txwr 
)
Value:
{ \
WIZCHIP_WRITE(Sn_TX_WR(sn), (uint8_t)(txwr>>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_TX_WR(sn),1), (uint8_t) txwr); \
}

Set Sn_TX_WR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)txwrValue to set Sn_TX_WR
See Also
GetSn_TX_WR()

Definition at line 1890 of file w5500.h.

Referenced by wiz_send_data().

#define getSn_TX_WR (   sn)    ((WIZCHIP_READ(Sn_TX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_WR(sn),1)))

Get Sn_TX_WR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_TX_WR.
See Also
setSn_TX_WR()

Definition at line 1902 of file w5500.h.

Referenced by wiz_send_data().

#define setSn_RX_RD (   sn,
  rxrd 
)
Value:
{ \
WIZCHIP_WRITE(Sn_RX_RD(sn), (uint8_t)(rxrd>>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_RX_RD(sn),1), (uint8_t) rxrd); \
}

Set Sn_RX_RD register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)rxrdValue to set Sn_RX_RD
See Also
getSn_RX_RD()

Definition at line 1922 of file w5500.h.

Referenced by wiz_recv_data(), and wiz_recv_ignore().

#define getSn_RX_RD (   sn)    ((WIZCHIP_READ(Sn_RX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_RD(sn),1)))

Get Sn_RX_RD register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7. uint16_t. Value of Sn_RX_RD.
See Also
setSn_RX_RD()

Definition at line 1934 of file w5500.h.

Referenced by wiz_recv_data(), and wiz_recv_ignore().

#define getSn_RX_WR (   sn)    ((WIZCHIP_READ(Sn_RX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_WR(sn),1)))

Get Sn_RX_WR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_RX_WR.

Definition at line 1943 of file w5500.h.

#define setSn_FRAG (   sn,
  frag 
)
Value:
{ \
WIZCHIP_WRITE(Sn_FRAG(sn), (uint8_t)(frag >>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(Sn_FRAG(sn),1), (uint8_t) frag); \
}

Set Sn_FRAG register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint16_t)fragValue to set Sn_FRAG
See Also
getSn_FRAD()

Definition at line 1954 of file w5500.h.

#define getSn_FRAG (   sn)    ((WIZCHIP_READ(Sn_FRAG(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_FRAG(sn),1)))

Get Sn_FRAG register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_FRAG.
See Also
setSn_FRAG()

Definition at line 1966 of file w5500.h.

#define setSn_KPALVTR (   sn,
  kpalvt 
)    WIZCHIP_WRITE(Sn_KPALVTR(sn), kpalvt)

Set Sn_KPALVTR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
(uint8_t)kpalvtValue to set Sn_KPALVTR
See Also
getSn_KPALVTR()

Definition at line 1976 of file w5500.h.

Referenced by setsockopt().

#define getSn_KPALVTR (   sn)    WIZCHIP_READ(Sn_KPALVTR(sn))

Get Sn_KPALVTR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint8_t. Value of Sn_KPALVTR.
See Also
setSn_KPALVTR()

Definition at line 1986 of file w5500.h.

Referenced by getsockopt(), and setsockopt().

Function Documentation

uint16_t getSn_TX_FSR ( uint8_t  sn)

Get Sn_TX_FSR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_TX_FSR.

Definition at line 293 of file w5500.c.

References Sn_TX_FSR, WIZCHIP_OFFSET_INC, and WIZCHIP_READ().

Referenced by getsockopt(), recv(), send(), and sendto().

uint16_t getSn_RX_RSR ( uint8_t  sn)

Get Sn_RX_RSR register.

Parameters
(uint8_t)snSocket number. It should be 0 ~ 7.
Returns
uint16_t. Value of Sn_RX_RSR.

Definition at line 310 of file w5500.c.

References Sn_RX_RSR, WIZCHIP_OFFSET_INC, and WIZCHIP_READ().

Referenced by getsockopt(), recv(), and recvfrom().