PER Firmware
Loading...
Searching...
No Matches
Socket register access functions

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

Macros

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

Functions

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

Detailed Description

These are functions to access socket registers.

Macro Definition Documentation

◆ getSn_CR

#define getSn_CR ( sn)
Value:
uint8_t WIZCHIP_READ(uint32_t AddrSel)
It reads 1 byte value from a register.
Definition w5500.c:65
#define Sn_CR(N)
Socket command register(R/W)
Definition w5500.h:451

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()

◆ getSn_DHAR

#define getSn_DHAR ( sn,
dhar )
Value:
WIZCHIP_READ_BUF(Sn_DHAR(sn), dhar, 6)
void WIZCHIP_READ_BUF(uint32_t AddrSel, uint8_t *pBuf, uint16_t len)
It reads sequence data from registers.
Definition w5500.c:125
#define Sn_DHAR(N)
Peer MAC register address(R/W)
Definition w5500.h:508

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()

◆ getSn_DIPR

#define getSn_DIPR ( sn,
dipr )
Value:
WIZCHIP_READ_BUF(Sn_DIPR(sn), dipr, 4)
#define Sn_DIPR(N)
Peer IP register address(R/W)
Definition w5500.h:518

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()

◆ getSn_DPORT

#define getSn_DPORT ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_DPORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_DPORT(sn), 1)))
#define Sn_DPORT(N)
Peer port register address(R/W)
Definition w5500.h:528

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()

◆ getSn_FRAG

#define getSn_FRAG ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_FRAG(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_FRAG(sn), 1)))
#define Sn_FRAG(N)
Fragment field value in IP header register(R/W)
Definition w5500.h:667

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()

◆ getSn_IMR

#define getSn_IMR ( sn)
Value:
(WIZCHIP_READ(Sn_IMR(sn)) & 0x1F)
#define Sn_IMR(N)
socket interrupt mask register(R)
Definition w5500.h:660

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()

◆ getSn_IR

#define getSn_IR ( sn)
Value:
(WIZCHIP_READ(Sn_IR(sn)) & 0x1F)
#define Sn_IR(N)
Socket interrupt register(R)
Definition w5500.h:469

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()

◆ getSn_KPALVTR

#define getSn_KPALVTR ( sn)
Value:
#define Sn_KPALVTR(N)
Keep Alive Timer register(R/W)
Definition w5500.h:680

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()

◆ getSn_MR

#define getSn_MR ( sn)
Value:
#define Sn_MR(N)
socket Mode register(R/W)
Definition w5500.h:432

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()

◆ getSn_MSSR

#define getSn_MSSR ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_MSSR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_MSSR(sn), 1)))
#define Sn_MSSR(N)
Maximum Segment Size(Sn_MSSR0) register address(R/W)
Definition w5500.h:535

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()

◆ getSn_PORT

#define getSn_PORT ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_PORT(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_PORT(sn), 1)))
#define Sn_PORT(N)
source port register(R/W)
Definition w5500.h:500

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()

◆ getSn_RX_RD

#define getSn_RX_RD ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_RX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_RD(sn), 1)))
#define Sn_RX_RD(N)
Read point of Receive memory(R/W)
Definition w5500.h:641

Get Sn_RX_RD register.

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

◆ getSn_RX_WR

#define getSn_RX_WR ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_RX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_RX_WR(sn), 1)))
#define Sn_RX_WR(N)
Write point of Receive memory(R)
Definition w5500.h:650

Get Sn_RX_WR register.

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

◆ getSn_RXBUF_SIZE

#define getSn_RXBUF_SIZE ( sn)
Value:
#define Sn_RXBUF_SIZE(N)
Receive memory size register(R/W)
Definition w5500.h:571

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()

◆ getSn_SR

#define getSn_SR ( sn)
Value:
#define Sn_SR(N)
Socket status register(R)
Definition w5500.h:492

Get Sn_SR register.

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

◆ getSn_TOS

#define getSn_TOS ( sn)
Value:
#define Sn_TOS(N)
IP Type of Service(TOS) Register(R/W)
Definition w5500.h:545

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()

◆ getSn_TTL

#define getSn_TTL ( sn)
Value:
#define Sn_TTL(N)
IP Time to live(TTL) Register(R/W)
Definition w5500.h:552

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()

◆ getSn_TX_RD

#define getSn_TX_RD ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_TX_RD(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_RD(sn), 1)))
#define Sn_TX_RD(N)
Transmit memory read pointer register address(R)
Definition w5500.h:605

Get Sn_TX_RD register.

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

◆ getSn_TX_WR

#define getSn_TX_WR ( sn)
Value:
(((uint16_t)WIZCHIP_READ(Sn_TX_WR(sn)) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(Sn_TX_WR(sn), 1)))
#define Sn_TX_WR(N)
Transmit memory write pointer register address(R/W)
Definition w5500.h:619

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()

◆ getSn_TXBUF_SIZE

#define getSn_TXBUF_SIZE ( sn)
Value:
#define Sn_TXBUF_SIZE(N)
Transmit memory size register(R/W)
Definition w5500.h:582

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()

◆ setSn_CR

#define setSn_CR ( sn,
cr )
Value:
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.
Definition w5500.c:95

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()

◆ setSn_DHAR

#define setSn_DHAR ( sn,
dhar )
Value:
WIZCHIP_WRITE_BUF(Sn_DHAR(sn), dhar, 6)
void WIZCHIP_WRITE_BUF(uint32_t AddrSel, uint8_t *pBuf, uint16_t len)
It writes sequence data to registers.
Definition w5500.c:155

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()

◆ setSn_DIPR

#define setSn_DIPR ( sn,
dipr )
Value:
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()

◆ setSn_DPORT

#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()

◆ setSn_FRAG

#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()

◆ setSn_IMR

#define setSn_IMR ( sn,
imr )
Value:
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()

◆ setSn_IR

#define setSn_IR ( sn,
ir )
Value:
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()

◆ setSn_KPALVTR

#define setSn_KPALVTR ( sn,
kpalvt )
Value:

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()

◆ setSn_MR

#define setSn_MR ( sn,
mr )
Value:

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()

◆ setSn_MSSR

#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()

◆ setSn_PORT

#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()

◆ setSn_RX_RD

#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()

◆ setSn_RXBUF_SIZE

#define setSn_RXBUF_SIZE ( sn,
rxbufsize )
Value:
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()

◆ setSn_TOS

#define setSn_TOS ( sn,
tos )
Value:

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()

◆ setSn_TTL

#define setSn_TTL ( sn,
ttl )
Value:

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()

◆ setSn_TX_WR

#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()

◆ setSn_TXBUF_SIZE

#define setSn_TXBUF_SIZE ( sn,
txbufsize )
Value:
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()

Function Documentation

◆ getSn_RX_RSR()

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.

◆ getSn_TX_FSR()

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.