Register definitions for W5100 devices. More...

Detailed Description

Register definitions for W5100 devices.

Author: Hauke Petersen hauke.nosp@m..pet.nosp@m.ersen.nosp@m.@fu-.nosp@m.berli.nosp@m.n.de

Definition in file w5100_regs.h.

SPI commands
#define	CMD_READ (0x0f)

#define	CMD_WRITE (0xf0)

Common registers
#define	REG_MODE (0x0000)
	mode

#define	REG_GAR0 (0x0001)
	gateway address 0

#define	REG_GAR1 (0x0002)
	gateway address 1

#define	REG_GAR2 (0x0003)
	gateway address 2

#define	REG_GAR3 (0x0004)
	gateway address 3

#define	REG_SUB0 (0x0005)
	subnet mask 0

#define	REG_SUB1 (0x0006)
	subnet mask 1

#define	REG_SUB2 (0x0007)
	subnet mask 2

#define	REG_SUB3 (0x0008)
	subnet mask 3

#define	REG_SHAR0 (0x0009)
	source hardware address 0

#define	REG_SHAR1 (0x000a)
	source hardware address 1

#define	REG_SHAR2 (0x000b)
	source hardware address 2

#define	REG_SHAR3 (0x000c)
	source hardware address 3

#define	REG_SHAR4 (0x000d)
	source hardware address 4

#define	REG_SHAR5 (0x000e)
	source hardware address 5

#define	REG_SIPR0 (0x000f)
	source IP address 0

#define	REG_SIPR1 (0x0010)
	source IP address 1

#define	REG_SIPR2 (0x0011)
	source IP address 2

#define	REG_SIPR3 (0x0012)
	source IP address 3

#define	REG_IR (0x0015)
	interrupt flags

#define	REG_IMR (0x0016)
	interrupt masks

#define	REG_RTR0 (0x0017)
	retry time 0

#define	REG_RTR1 (0x0018)
	retry time 1

#define	REG_RCR (0x0019)
	retry count

#define	REG_RMSR (0x001a)
	RX memory size.

#define	REG_TMSR (0x001b)
	TX memory size.

#define	REG_PATR0 (0x001c)
	PPPoE auth type 0.

#define	REG_PATR1 (0x001d)
	PPPoE auth type 1.

#define	REG_PTIMER (0x0028)
	PPP LCP request timer.

#define	REG_PMAGIC (0x0029)
	PPP LCP magic number.

#define	REG_UIPR0 (0x002a)
	unreachable IP address 0

#define	REG_UIPR1 (0x002b)
	unreachable IP address 1

#define	REG_UIPR2 (0x002c)
	unreachable IP address 2

#define	REG_UIPR3 (0x002d)
	unreachable IP address 3

#define	REG_UPORT0 (0x00fe)
	unreachable port 0

#define	REG_UPORT1 (0x002f)
	unreachable port 1

Socket 0 registers
As we are using the device in MACRAW mode, we only need socket 0.
#define	S0_MR (0x0400)
	mode

#define	S0_CR (0x0401)
	control

#define	S0_IR (0x0402)
	interrupt flags

#define	S0_SR (0x0403)
	state

#define	S0_DHAR0 (0x0406)
	destination hardware address 0

#define	S0_DHAR1 (0x0407)
	destination hardware address 1

#define	S0_DHAR2 (0x0408)
	destination hardware address 2

#define	S0_DHAR3 (0x0409)
	destination hardware address 3

#define	S0_DHAR4 (0x040a)
	destination hardware address 4

#define	S0_DHAR5 (0x040b)
	destination hardware address 5

#define	S0_DIPR0 (0x040c)
	destination IP address 0

#define	S0_DIPR1 (0x040d)
	destination IP address 1

#define	S0_DIPR2 (0x040e)
	destination IP address 2

#define	S0_DIPR3 (0x040f)
	destination IP address 3

#define	S0_DPORT0 (0x0410)
	destination port 0

#define	S0_DPORT1 (0x0411)
	destination port 1

#define	S0_MSSR0 (0x0412)
	maximum segment size 0

#define	S0_MSSR1 (0x0413)
	maximum segment size 1

#define	S0_PROTO (0x0414)
	protocol in IP raw mode

#define	S0_TOS (0x0415)
	IP TOS.

#define	S0_TTL (0x0416)
	IP TTL.

#define	S0_TX_FSR0 (0x0420)
	TX free size 0.

#define	S0_TX_FSR1 (0x0421)
	TX free size 1.

#define	S0_TX_RD0 (0x0422)
	TX read pointer 0.

#define	S0_TX_RD1 (0x0423)
	TX read pointer 1.

#define	S0_TX_WR0 (0x0424)
	TX write pointer 0.

#define	S0_TX_WR1 (0x0425)
	TX write pointer 1.

#define	S0_RX_RSR0 (0x0426)
	RX receive size 0.

#define	S0_RX_RSR1 (0x0427)
	RX receive size 1.

#define	S0_RX_RD0 (0x0428)
	RX read pointer 0.

#define	S0_RX_RD1 (0x0429)
	RX read pointer 1.

Some selected bitfield definitions
#define	MODE_RESET (0x80)
	device mode: reset

#define	RMSR_8KB_TO_S0 (0x03)
	receive memory size: 8kib

#define	TMSR_8KB_TO_S0 (0x03)
	transmit memory size: 8kib

#define	IMR_S0_INT (0x01)
	global socket 0 interrupt mask

#define	MR_UDP (0x02)
	socket mode: UDP

#define	MR_MACRAW (0x04)
	socket mode: raw Ethernet

#define	CR_OPEN (0x01)
	socket command: open

#define	CR_CLOSE (0x10)
	socket command: close

#define	CR_SEND_MAC (0x21)
	socket command: send raw

#define	CR_RECV (0x40)
	socket command: receive new data

#define	IR_SEND_OK (0x10)
	socket interrupt: send ok

#define	IR_RECV (0x04)
	socket interrupt: data received

Macro Definition Documentation

◆ CMD_READ

#define CMD_READ (0x0f)

Definition at line 30 of file w5100_regs.h.

◆ CMD_WRITE

#define CMD_WRITE (0xf0)

Definition at line 31 of file w5100_regs.h.

◆ CR_CLOSE

#define CR_CLOSE (0x10)

socket command: close

Definition at line 130 of file w5100_regs.h.

◆ CR_OPEN

#define CR_OPEN (0x01)

socket command: open

Definition at line 129 of file w5100_regs.h.

◆ CR_RECV

#define CR_RECV (0x40)

socket command: receive new data

Definition at line 132 of file w5100_regs.h.

◆ CR_SEND_MAC

#define CR_SEND_MAC (0x21)

socket command: send raw

Definition at line 131 of file w5100_regs.h.

◆ IMR_S0_INT

#define IMR_S0_INT (0x01)

global socket 0 interrupt mask

Definition at line 124 of file w5100_regs.h.

◆ IR_RECV

#define IR_RECV (0x04)

socket interrupt: data received

Definition at line 135 of file w5100_regs.h.

◆ IR_SEND_OK

#define IR_SEND_OK (0x10)

socket interrupt: send ok

Definition at line 134 of file w5100_regs.h.

◆ MODE_RESET

#define MODE_RESET (0x80)

device mode: reset

Definition at line 119 of file w5100_regs.h.

◆ MR_MACRAW

#define MR_MACRAW (0x04)

socket mode: raw Ethernet

Definition at line 127 of file w5100_regs.h.

◆ MR_UDP

#define MR_UDP (0x02)

socket mode: UDP

Definition at line 126 of file w5100_regs.h.

◆ REG_GAR0

#define REG_GAR0 (0x0001)

gateway address 0

Definition at line 39 of file w5100_regs.h.

◆ REG_GAR1

#define REG_GAR1 (0x0002)

gateway address 1

Definition at line 40 of file w5100_regs.h.

◆ REG_GAR2

#define REG_GAR2 (0x0003)

gateway address 2

Definition at line 41 of file w5100_regs.h.

◆ REG_GAR3

#define REG_GAR3 (0x0004)

gateway address 3

Definition at line 42 of file w5100_regs.h.

◆ REG_IMR

#define REG_IMR (0x0016)

interrupt masks

Definition at line 58 of file w5100_regs.h.

◆ REG_IR

#define REG_IR (0x0015)

interrupt flags

Definition at line 57 of file w5100_regs.h.

◆ REG_MODE

#define REG_MODE (0x0000)

mode

Definition at line 38 of file w5100_regs.h.

◆ REG_PATR0

#define REG_PATR0 (0x001c)

PPPoE auth type 0.

Definition at line 64 of file w5100_regs.h.

◆ REG_PATR1

#define REG_PATR1 (0x001d)

PPPoE auth type 1.

Definition at line 65 of file w5100_regs.h.

◆ REG_PMAGIC

#define REG_PMAGIC (0x0029)

PPP LCP magic number.

Definition at line 67 of file w5100_regs.h.

◆ REG_PTIMER

#define REG_PTIMER (0x0028)

PPP LCP request timer.

Definition at line 66 of file w5100_regs.h.

◆ REG_RCR

#define REG_RCR (0x0019)

retry count

Definition at line 61 of file w5100_regs.h.

◆ REG_RMSR

#define REG_RMSR (0x001a)

RX memory size.

Definition at line 62 of file w5100_regs.h.

◆ REG_RTR0

#define REG_RTR0 (0x0017)

retry time 0

Definition at line 59 of file w5100_regs.h.

◆ REG_RTR1

#define REG_RTR1 (0x0018)

retry time 1

Definition at line 60 of file w5100_regs.h.

◆ REG_SHAR0

#define REG_SHAR0 (0x0009)

source hardware address 0

Definition at line 47 of file w5100_regs.h.

◆ REG_SHAR1

#define REG_SHAR1 (0x000a)

source hardware address 1

Definition at line 48 of file w5100_regs.h.

◆ REG_SHAR2

#define REG_SHAR2 (0x000b)

source hardware address 2

Definition at line 49 of file w5100_regs.h.

◆ REG_SHAR3

#define REG_SHAR3 (0x000c)

source hardware address 3

Definition at line 50 of file w5100_regs.h.

◆ REG_SHAR4

#define REG_SHAR4 (0x000d)

source hardware address 4

Definition at line 51 of file w5100_regs.h.

◆ REG_SHAR5

#define REG_SHAR5 (0x000e)

source hardware address 5

Definition at line 52 of file w5100_regs.h.

◆ REG_SIPR0

#define REG_SIPR0 (0x000f)

source IP address 0

Definition at line 53 of file w5100_regs.h.

◆ REG_SIPR1

#define REG_SIPR1 (0x0010)

source IP address 1

Definition at line 54 of file w5100_regs.h.

◆ REG_SIPR2

#define REG_SIPR2 (0x0011)

source IP address 2

Definition at line 55 of file w5100_regs.h.

◆ REG_SIPR3

#define REG_SIPR3 (0x0012)

source IP address 3

Definition at line 56 of file w5100_regs.h.

◆ REG_SUB0

#define REG_SUB0 (0x0005)

subnet mask 0

Definition at line 43 of file w5100_regs.h.

◆ REG_SUB1

#define REG_SUB1 (0x0006)

subnet mask 1

Definition at line 44 of file w5100_regs.h.

◆ REG_SUB2

#define REG_SUB2 (0x0007)

subnet mask 2

Definition at line 45 of file w5100_regs.h.

◆ REG_SUB3

#define REG_SUB3 (0x0008)

subnet mask 3

Definition at line 46 of file w5100_regs.h.

◆ REG_TMSR

#define REG_TMSR (0x001b)

TX memory size.

Definition at line 63 of file w5100_regs.h.

◆ REG_UIPR0

#define REG_UIPR0 (0x002a)

unreachable IP address 0

Definition at line 68 of file w5100_regs.h.

◆ REG_UIPR1

#define REG_UIPR1 (0x002b)

unreachable IP address 1

Definition at line 69 of file w5100_regs.h.

◆ REG_UIPR2

#define REG_UIPR2 (0x002c)

unreachable IP address 2

Definition at line 70 of file w5100_regs.h.

◆ REG_UIPR3

#define REG_UIPR3 (0x002d)

unreachable IP address 3

Definition at line 71 of file w5100_regs.h.

◆ REG_UPORT0

#define REG_UPORT0 (0x00fe)

unreachable port 0

Definition at line 72 of file w5100_regs.h.

◆ REG_UPORT1

#define REG_UPORT1 (0x002f)

unreachable port 1

Definition at line 73 of file w5100_regs.h.

◆ RMSR_8KB_TO_S0

#define RMSR_8KB_TO_S0 (0x03)

receive memory size: 8kib

Definition at line 121 of file w5100_regs.h.

◆ S0_CR

#define S0_CR (0x0401)

control

Definition at line 83 of file w5100_regs.h.

◆ S0_DHAR0

#define S0_DHAR0 (0x0406)

destination hardware address 0

Definition at line 86 of file w5100_regs.h.

◆ S0_DHAR1

#define S0_DHAR1 (0x0407)

destination hardware address 1

Definition at line 87 of file w5100_regs.h.

◆ S0_DHAR2

#define S0_DHAR2 (0x0408)

destination hardware address 2

Definition at line 88 of file w5100_regs.h.

◆ S0_DHAR3

#define S0_DHAR3 (0x0409)

destination hardware address 3

Definition at line 89 of file w5100_regs.h.

◆ S0_DHAR4

#define S0_DHAR4 (0x040a)

destination hardware address 4

Definition at line 90 of file w5100_regs.h.

◆ S0_DHAR5

#define S0_DHAR5 (0x040b)

destination hardware address 5

Definition at line 91 of file w5100_regs.h.

◆ S0_DIPR0

#define S0_DIPR0 (0x040c)

destination IP address 0

Definition at line 92 of file w5100_regs.h.

◆ S0_DIPR1

#define S0_DIPR1 (0x040d)

destination IP address 1

Definition at line 93 of file w5100_regs.h.

◆ S0_DIPR2

#define S0_DIPR2 (0x040e)

destination IP address 2

Definition at line 94 of file w5100_regs.h.

◆ S0_DIPR3

#define S0_DIPR3 (0x040f)

destination IP address 3

Definition at line 95 of file w5100_regs.h.

◆ S0_DPORT0

#define S0_DPORT0 (0x0410)

destination port 0

Definition at line 96 of file w5100_regs.h.

◆ S0_DPORT1

#define S0_DPORT1 (0x0411)

destination port 1

Definition at line 97 of file w5100_regs.h.

◆ S0_IR

#define S0_IR (0x0402)

interrupt flags

Definition at line 84 of file w5100_regs.h.

◆ S0_MR

#define S0_MR (0x0400)

mode

Definition at line 82 of file w5100_regs.h.

◆ S0_MSSR0

#define S0_MSSR0 (0x0412)

maximum segment size 0

Definition at line 98 of file w5100_regs.h.

◆ S0_MSSR1

#define S0_MSSR1 (0x0413)

maximum segment size 1

Definition at line 99 of file w5100_regs.h.

◆ S0_PROTO

#define S0_PROTO (0x0414)

protocol in IP raw mode

Definition at line 100 of file w5100_regs.h.

◆ S0_RX_RD0

#define S0_RX_RD0 (0x0428)

RX read pointer 0.

Definition at line 111 of file w5100_regs.h.

◆ S0_RX_RD1

#define S0_RX_RD1 (0x0429)

RX read pointer 1.

Definition at line 112 of file w5100_regs.h.

◆ S0_RX_RSR0

#define S0_RX_RSR0 (0x0426)

RX receive size 0.

Definition at line 109 of file w5100_regs.h.

◆ S0_RX_RSR1

#define S0_RX_RSR1 (0x0427)

RX receive size 1.

Definition at line 110 of file w5100_regs.h.

◆ S0_SR

#define S0_SR (0x0403)

state

Definition at line 85 of file w5100_regs.h.

◆ S0_TOS

#define S0_TOS (0x0415)

IP TOS.

Definition at line 101 of file w5100_regs.h.

◆ S0_TTL

#define S0_TTL (0x0416)

IP TTL.

Definition at line 102 of file w5100_regs.h.

◆ S0_TX_FSR0

#define S0_TX_FSR0 (0x0420)

TX free size 0.

Definition at line 103 of file w5100_regs.h.

◆ S0_TX_FSR1

#define S0_TX_FSR1 (0x0421)

TX free size 1.

Definition at line 104 of file w5100_regs.h.

◆ S0_TX_RD0

#define S0_TX_RD0 (0x0422)

TX read pointer 0.

Definition at line 105 of file w5100_regs.h.

◆ S0_TX_RD1

#define S0_TX_RD1 (0x0423)

TX read pointer 1.

Definition at line 106 of file w5100_regs.h.

◆ S0_TX_WR0

#define S0_TX_WR0 (0x0424)

TX write pointer 0.

Definition at line 107 of file w5100_regs.h.

◆ S0_TX_WR1

#define S0_TX_WR1 (0x0425)

TX write pointer 1.

Definition at line 108 of file w5100_regs.h.

◆ TMSR_8KB_TO_S0

#define TMSR_8KB_TO_S0 (0x03)

transmit memory size: 8kib

Definition at line 122 of file w5100_regs.h.