Common register

Common register group
It set the basic for the networking
It set the configuration such as interrupt, network information, ICMP, etc. More...

Macros
#define	MR   (_WIZCHIP_IO_BASE_ + (0x0000))
	Mode Register address(R/W) MR is used for S/W reset, ping block mode, PPPoE mode and etc. More...
#define	GAR   (_W5100_IO_BASE_ + (0x0001))
	Gateway IP Register address(R/W) More...
#define	SUBR   (_W5100_IO_BASE_ + (0x0005))
	Subnet mask Register address(R/W) More...
#define	SHAR   (_W5100_IO_BASE_ + (0x0009))
	Source MAC Register address(R/W) More...
#define	SIPR   (_W5100_IO_BASE_ + (0x000F))
	Source IP Register address(R/W) More...
#define	IR   (_W5100_IO_BASE_ + (0x0015))
	Interrupt Register(R/W) More...
#define	_IMR_   (_W5100_IO_BASE_ + (0x0016))
	Socket Interrupt Mask Register(R/W) More...
#define	_RTR_   (_W5100_IO_BASE_ + (0x0017))
	Timeout register address( 1 is 100us )(R/W) More...
#define	_RCR_   (_W5100_IO_BASE_ + (0x0019))
	Retry count register(R/W) More...
#define	PATR   (_W5100_IO_BASE_ + (0x001C))
	PPP LCP Request Timer register in PPPoE mode(R) More...
#define	PTIMER   (_W5100_IO_BASE_ + (0x0028))
	PPP LCP Request Timer register in PPPoE mode(R) More...
#define	PMAGIC   (_W5100_IO_BASE_ + (0x0029))
	PPP LCP Magic number register in PPPoE mode(R) More...

Detailed Description

Common register group
It set the basic for the networking
It set the configuration such as interrupt, network information, ICMP, etc.

See also

MR : Mode register.

GAR, SUBR, SHAR, SIPR

IR, Sn_IR, IMR : Interrupt.

RTR, RCR : Data retransmission.

PTIMER, PMAGIC : PPPoE.

Macro Definition Documentation

#define MR   (_WIZCHIP_IO_BASE_ + (0x0000))

Mode Register address(R/W)
MR is used for S/W reset, ping block mode, PPPoE mode and etc.

Each bit of MR defined as follows.

7	6	5	4	3	2	1	0
RST	Reserved	WOL	PB	PPPoE	Reserved	AI	IND

• MR_RST : Reset
• MR_PB : Ping block
• MR_PPPOE : PPPoE mode
• MR_AI : Address Auto-Increment in Indirect Bus Interface
• MR_IND : Indirect Bus Interface mode

Definition at line 202 of file w5100.h.

#define GAR   (_W5100_IO_BASE_ + (0x0001))

Gateway IP Register address(R/W)

GAR configures the default gateway address.

Definition at line 212 of file w5100.h.

#define SUBR   (_W5100_IO_BASE_ + (0x0005))

Subnet mask Register address(R/W)

SUBR configures the subnet mask address.

Definition at line 219 of file w5100.h.

#define SHAR   (_W5100_IO_BASE_ + (0x0009))

Source MAC Register address(R/W)

SHAR configures the source hardware address.

Definition at line 226 of file w5100.h.

#define SIPR   (_W5100_IO_BASE_ + (0x000F))

Source IP Register address(R/W)

SIPR configures the source IP address.

Definition at line 233 of file w5100.h.

#define IR   (_W5100_IO_BASE_ + (0x0015))

Interrupt Register(R/W)

IR indicates the interrupt status. Each bit of IR will be still until the bit will be written to by the host. If IR is not equal to x00 INTn PIN is asserted to low until it is x00

Each bit of IR defined as follows.

7	6	5	4	3	2	1	0
CONFLICT	UNREACH	PPPoE	Reserved	S3_INT	S2_INT	S1_INT	S0_INT

• IR_CONFLICT : IP conflict
• IR_UNREACH : Destination unreachable
• IR_PPPoE : PPPoE connection close
• IR_SOCK(3) : SOCKET 3 Interrupt
• IR_SOCK(2) : SOCKET 2 Interrupt
• IR_SOCK(1) : SOCKET 1 Interrupt
• IR_SOCK(0) : SOCKET 0 Interrupt

Definition at line 256 of file w5100.h.

#define _IMR_   (_W5100_IO_BASE_ + (0x0016))

Socket Interrupt Mask Register(R/W)

Each bit of IMR corresponds to each bit of IR. When a bit of IMR is and the corresponding bit of IR is set, Interrupt will be issued.

Definition at line 264 of file w5100.h.

#define _RTR_   (_W5100_IO_BASE_ + (0x0017))

Timeout register address( 1 is 100us )(R/W)

RTR configures the retransmission timeout period. The unit of timeout period is 100us and the default of RTR is x07D0or 000 And so the default timeout period is 200ms(100us X 2000). During the time configured by RTR, W5100 waits for the peer response to the packet that is transmitted by Sn_CR (CONNECT, DISCON, CLOSE, SEND, SEND_MAC, SEND_KEEP command). If the peer does not respond within the RTR time, W5100 retransmits the packet or issues timeout.

Definition at line 274 of file w5100.h.

#define _RCR_   (_W5100_IO_BASE_ + (0x0019))

Retry count register(R/W)

RCR configures the number of time of retransmission. When retransmission occurs as many as ref RCR+1 Timeout interrupt is issued (Sn_IR_TIMEOUT = '1').

Definition at line 282 of file w5100.h.

#define PATR   (_W5100_IO_BASE_ + (0x001C))

PPP LCP Request Timer register in PPPoE mode(R)

PATR notifies authentication method that has been agreed at the connection with PPPoE Server. W5100 supports two types of Authentication method - PAP and CHAP.

Definition at line 293 of file w5100.h.

#define PTIMER   (_W5100_IO_BASE_ + (0x0028))

PPP LCP Request Timer register in PPPoE mode(R)

PTIMER configures the time for sending LCP echo request. The unit of time is 25ms.

Definition at line 301 of file w5100.h.

#define PMAGIC   (_W5100_IO_BASE_ + (0x0029))

PPP LCP Magic number register in PPPoE mode(R)

PMAGIC configures the 4bytes magic number to be used in LCP negotiation.

Definition at line 308 of file w5100.h.