Mbed library for ENC28J60 Ethernet modules. Full support for TCP/IP and UDP Server, Client and HTTP server (webserver). DHCP and DNS is included.

Dependents:   mBuino_ENC28_MQTT Nucleo_Web_ENC28J60 Nucleo_Web_ENC28J60_ADC Serial_over_Ethernet ... more

Library for ENC28J60 Ethernet modules.

/media/uploads/hudakz/enc28j60_module01.jpg

Ported to mbed from Norbert Truchsess's UIPEthernet library for Arduino. Thank you Norbert!

  • Full support for persistent (streaming) TCP/IP and UDP connections Client and Server each, ARP, ICMP, DHCP and DNS.
  • Works with both Mbed OS 2 and Mbed OS 5.

Usage:

  • Import the library into your project.
  • Add #include "UipEthernet.h" to main.cpp
  • Create one instance of the UipEthernet class initialized with the MAC address you'd like to use and SPI pins of the connected Mbed board.

Example programs:

Import programWebSwitch_ENC28J60

HTTP Server serving a simple webpage which enables to remotely turn a digital output on/off. Compile, download, run and type 'IP_address/secret/' (don't forget the last '/') into your web browser and hit ENTER.

Import programHTTPServer_Echo_ENC28J60

A simple HTTP server echoing received requests. Ethernet connection is over an ENC28J60 board. Usage: Type the server's IP address into you web browser and hit <ENTER>.

Import programTcpServer_ENC28J60

Simple TCP/IP Server using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programTcpClient_ENC28J60

Simple TCP/IP Client using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programUdpServer_ENC28J60

Simple UDP Server using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programUdpClient_ENC28J60

Simple UDP Client using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programMQTT_Hello_ENC28J60

MQTT Client example program. Ethernet connection is via an ENC28J60 module.

Committer:
hudakz
Date:
Fri Jun 05 15:21:49 2020 +0000
Revision:
17:1123c3fe86ca
Parent:
15:53715cc81c63
Library for the ENC28J60 Ethernet modules.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hudakz 3:5b17e4656dd0 1 /*****************************************************************************
hudakz 3:5b17e4656dd0 2 *
hudakz 3:5b17e4656dd0 3 * Title : Microchip ENC28J60 Ethernet Interface Driver
hudakz 3:5b17e4656dd0 4 * Author : Pascal Stang (c)2005
hudakz 3:5b17e4656dd0 5 * Modified by Norbert Truchsess
hudakz 3:5b17e4656dd0 6 * Copyright: GPL V2
hudakz 3:5b17e4656dd0 7 *
hudakz 3:5b17e4656dd0 8 *This driver provides initialization and transmit/receive
hudakz 3:5b17e4656dd0 9 *functions for the Microchip ENC28J60 10Mb Ethernet Controller and PHY.
hudakz 3:5b17e4656dd0 10 *This chip is novel in that it is a full MAC+PHY interface all in a 28-pin
hudakz 3:5b17e4656dd0 11 *chip, using an SPI interface to the host processor.
hudakz 3:5b17e4656dd0 12 *
hudakz 3:5b17e4656dd0 13 *
hudakz 3:5b17e4656dd0 14 *****************************************************************************/
hudakz 4:d774541a34da 15
hudakz 3:5b17e4656dd0 16 #ifndef ENC28J60_H
hudakz 4:d774541a34da 17 #define ENC28J60_H
hudakz 4:d774541a34da 18 #include <inttypes.h>
hudakz 3:5b17e4656dd0 19
hudakz 3:5b17e4656dd0 20 // ENC28J60 Control Registers
hudakz 3:5b17e4656dd0 21 // Control register definitions are a combination of address,
hudakz 3:5b17e4656dd0 22 // bank number, and Ethernet/MAC/PHY indicator bits.
hudakz 3:5b17e4656dd0 23 // - Register address (bits 0-4)
hudakz 3:5b17e4656dd0 24 // - Bank number (bits 5-6)
hudakz 3:5b17e4656dd0 25 // - MAC/PHY indicator (bit 7)
hudakz 4:d774541a34da 26 #define ADDR_MASK 0x1F
hudakz 4:d774541a34da 27 #define BANK_MASK 0x60
hudakz 4:d774541a34da 28 #define SPRD_MASK 0x80
hudakz 3:5b17e4656dd0 29 // All-bank registers
hudakz 4:d774541a34da 30 #define EIE 0x1B
hudakz 4:d774541a34da 31 #define EIR 0x1C
hudakz 4:d774541a34da 32 #define ESTAT 0x1D
hudakz 4:d774541a34da 33 #define ECON2 0x1E
hudakz 4:d774541a34da 34 #define ECON1 0x1F
hudakz 3:5b17e4656dd0 35 // Bank 0 registers
hudakz 4:d774541a34da 36 #define ERDPTL (0x00|0x00)
hudakz 4:d774541a34da 37 #define ERDPTH (0x01|0x00)
hudakz 4:d774541a34da 38 #define EWRPTL (0x02|0x00)
hudakz 4:d774541a34da 39 #define EWRPTH (0x03|0x00)
hudakz 4:d774541a34da 40 #define ETXSTL (0x04|0x00)
hudakz 4:d774541a34da 41 #define ETXSTH (0x05|0x00)
hudakz 4:d774541a34da 42 #define ETXNDL (0x06|0x00)
hudakz 4:d774541a34da 43 #define ETXNDH (0x07|0x00)
hudakz 4:d774541a34da 44 #define ERXSTL (0x08|0x00)
hudakz 4:d774541a34da 45 #define ERXSTH (0x09|0x00)
hudakz 4:d774541a34da 46 #define ERXNDL (0x0A|0x00)
hudakz 4:d774541a34da 47 #define ERXNDH (0x0B|0x00)
hudakz 4:d774541a34da 48 #define ERXRDPTL (0x0C|0x00)
hudakz 4:d774541a34da 49 #define ERXRDPTH (0x0D|0x00)
hudakz 4:d774541a34da 50 #define ERXWRPTL (0x0E|0x00)
hudakz 4:d774541a34da 51 #define ERXWRPTH (0x0F|0x00)
hudakz 4:d774541a34da 52 #define EDMASTL (0x10|0x00)
hudakz 4:d774541a34da 53 #define EDMASTH (0x11|0x00)
hudakz 4:d774541a34da 54 #define EDMANDL (0x12|0x00)
hudakz 4:d774541a34da 55 #define EDMANDH (0x13|0x00)
hudakz 4:d774541a34da 56 #define EDMADSTL (0x14|0x00)
hudakz 4:d774541a34da 57 #define EDMADSTH (0x15|0x00)
hudakz 4:d774541a34da 58 #define EDMACSL (0x16|0x00)
hudakz 4:d774541a34da 59 #define EDMACSH (0x17|0x00)
hudakz 3:5b17e4656dd0 60 // Bank 1 registers
hudakz 4:d774541a34da 61 #define EHT0 (0x00|0x20)
hudakz 4:d774541a34da 62 #define EHT1 (0x01|0x20)
hudakz 4:d774541a34da 63 #define EHT2 (0x02|0x20)
hudakz 4:d774541a34da 64 #define EHT3 (0x03|0x20)
hudakz 4:d774541a34da 65 #define EHT4 (0x04|0x20)
hudakz 4:d774541a34da 66 #define EHT5 (0x05|0x20)
hudakz 4:d774541a34da 67 #define EHT6 (0x06|0x20)
hudakz 4:d774541a34da 68 #define EHT7 (0x07|0x20)
hudakz 4:d774541a34da 69 #define EPMM0 (0x08|0x20)
hudakz 4:d774541a34da 70 #define EPMM1 (0x09|0x20)
hudakz 4:d774541a34da 71 #define EPMM2 (0x0A|0x20)
hudakz 4:d774541a34da 72 #define EPMM3 (0x0B|0x20)
hudakz 4:d774541a34da 73 #define EPMM4 (0x0C|0x20)
hudakz 4:d774541a34da 74 #define EPMM5 (0x0D|0x20)
hudakz 4:d774541a34da 75 #define EPMM6 (0x0E|0x20)
hudakz 4:d774541a34da 76 #define EPMM7 (0x0F|0x20)
hudakz 4:d774541a34da 77 #define EPMCSL (0x10|0x20)
hudakz 4:d774541a34da 78 #define EPMCSH (0x11|0x20)
hudakz 4:d774541a34da 79 #define EPMOL (0x14|0x20)
hudakz 4:d774541a34da 80 #define EPMOH (0x15|0x20)
hudakz 4:d774541a34da 81 #define EWOLIE (0x16|0x20)
hudakz 4:d774541a34da 82 #define EWOLIR (0x17|0x20)
hudakz 4:d774541a34da 83 #define ERXFCON (0x18|0x20)
hudakz 4:d774541a34da 84 #define EPKTCNT (0x19|0x20)
hudakz 3:5b17e4656dd0 85 // Bank 2 registers
hudakz 4:d774541a34da 86 #define MACON1 (0x00|0x40|0x80)
hudakz 4:d774541a34da 87 #define MACON2 (0x01|0x40|0x80)
hudakz 4:d774541a34da 88 #define MACON3 (0x02|0x40|0x80)
hudakz 4:d774541a34da 89 #define MACON4 (0x03|0x40|0x80)
hudakz 4:d774541a34da 90 #define MABBIPG (0x04|0x40|0x80)
hudakz 4:d774541a34da 91 #define MAIPGL (0x06|0x40|0x80)
hudakz 4:d774541a34da 92 #define MAIPGH (0x07|0x40|0x80)
hudakz 4:d774541a34da 93 #define MACLCON1 (0x08|0x40|0x80)
hudakz 4:d774541a34da 94 #define MACLCON2 (0x09|0x40|0x80)
hudakz 4:d774541a34da 95 #define MAMXFLL (0x0A|0x40|0x80)
hudakz 4:d774541a34da 96 #define MAMXFLH (0x0B|0x40|0x80)
hudakz 4:d774541a34da 97 #define MAPHSUP (0x0D|0x40|0x80)
hudakz 4:d774541a34da 98 #define MICON (0x11|0x40|0x80)
hudakz 4:d774541a34da 99 #define MICMD (0x12|0x40|0x80)
hudakz 4:d774541a34da 100 #define MIREGADR (0x14|0x40|0x80)
hudakz 4:d774541a34da 101 #define MIWRL (0x16|0x40|0x80)
hudakz 4:d774541a34da 102 #define MIWRH (0x17|0x40|0x80)
hudakz 4:d774541a34da 103 #define MIRDL (0x18|0x40|0x80)
hudakz 4:d774541a34da 104 #define MIRDH (0x19|0x40|0x80)
hudakz 3:5b17e4656dd0 105 // Bank 3 registers
hudakz 4:d774541a34da 106 #define MAADR1 (0x00|0x60|0x80)
hudakz 4:d774541a34da 107 #define MAADR0 (0x01|0x60|0x80)
hudakz 4:d774541a34da 108 #define MAADR3 (0x02|0x60|0x80)
hudakz 4:d774541a34da 109 #define MAADR2 (0x03|0x60|0x80)
hudakz 4:d774541a34da 110 #define MAADR5 (0x04|0x60|0x80)
hudakz 4:d774541a34da 111 #define MAADR4 (0x05|0x60|0x80)
hudakz 4:d774541a34da 112 #define EBSTSD (0x06|0x60)
hudakz 4:d774541a34da 113 #define EBSTCON (0x07|0x60)
hudakz 4:d774541a34da 114 #define EBSTCSL (0x08|0x60)
hudakz 4:d774541a34da 115 #define EBSTCSH (0x09|0x60)
hudakz 4:d774541a34da 116 #define MISTAT (0x0A|0x60|0x80)
hudakz 4:d774541a34da 117 #define EREVID (0x12|0x60)
hudakz 4:d774541a34da 118 #define ECOCON (0x15|0x60)
hudakz 4:d774541a34da 119 #define EFLOCON (0x17|0x60)
hudakz 4:d774541a34da 120 #define EPAUSL (0x18|0x60)
hudakz 4:d774541a34da 121 #define EPAUSH (0x19|0x60)
hudakz 3:5b17e4656dd0 122 // PHY registers
hudakz 4:d774541a34da 123 #define PHCON1 0x00
hudakz 4:d774541a34da 124 #define PHSTAT1 0x01
hudakz 4:d774541a34da 125 #define PHHID1 0x02
hudakz 4:d774541a34da 126 #define PHHID2 0x03
hudakz 4:d774541a34da 127 #define PHCON2 0x10
hudakz 4:d774541a34da 128 #define PHSTAT2 0x11
hudakz 4:d774541a34da 129 #define PHIE 0x12
hudakz 4:d774541a34da 130 #define PHIR 0x13
hudakz 4:d774541a34da 131 #define PHLCON 0x14
hudakz 3:5b17e4656dd0 132
hudakz 3:5b17e4656dd0 133 // ENC28J60 ERXFCON Register Bit Definitions
hudakz 4:d774541a34da 134 #define ERXFCON_UCEN 0x80
hudakz 4:d774541a34da 135 #define ERXFCON_ANDOR 0x40
hudakz 4:d774541a34da 136 #define ERXFCON_CRCEN 0x20
hudakz 4:d774541a34da 137 #define ERXFCON_PMEN 0x10
hudakz 4:d774541a34da 138 #define ERXFCON_MPEN 0x08
hudakz 4:d774541a34da 139 #define ERXFCON_HTEN 0x04
hudakz 4:d774541a34da 140 #define ERXFCON_MCEN 0x02
hudakz 4:d774541a34da 141 #define ERXFCON_BCEN 0x01
hudakz 3:5b17e4656dd0 142 // ENC28J60 EIE Register Bit Definitions
hudakz 4:d774541a34da 143 #define EIE_INTIE 0x80
hudakz 4:d774541a34da 144 #define EIE_PKTIE 0x40
hudakz 4:d774541a34da 145 #define EIE_DMAIE 0x20
hudakz 4:d774541a34da 146 #define EIE_LINKIE 0x10
hudakz 4:d774541a34da 147 #define EIE_TXIE 0x08
hudakz 4:d774541a34da 148 #define EIE_WOLIE 0x04
hudakz 4:d774541a34da 149 #define EIE_TXERIE 0x02
hudakz 4:d774541a34da 150 #define EIE_RXERIE 0x01
hudakz 3:5b17e4656dd0 151 // ENC28J60 EIR Register Bit Definitions
hudakz 4:d774541a34da 152 #define EIR_PKTIF 0x40
hudakz 4:d774541a34da 153 #define EIR_DMAIF 0x20
hudakz 4:d774541a34da 154 #define EIR_LINKIF 0x10
hudakz 4:d774541a34da 155 #define EIR_TXIF 0x08
hudakz 4:d774541a34da 156 #define EIR_WOLIF 0x04
hudakz 4:d774541a34da 157 #define EIR_TXERIF 0x02
hudakz 4:d774541a34da 158 #define EIR_RXERIF 0x01
hudakz 3:5b17e4656dd0 159 // ENC28J60 ESTAT Register Bit Definitions
hudakz 4:d774541a34da 160 #define ESTAT_INT 0x80
hudakz 4:d774541a34da 161 #define ESTAT_LATECOL 0x10
hudakz 4:d774541a34da 162 #define ESTAT_RXBUSY 0x04
hudakz 4:d774541a34da 163 #define ESTAT_TXABRT 0x02
hudakz 4:d774541a34da 164 #define ESTAT_CLKRDY 0x01
hudakz 3:5b17e4656dd0 165 // ENC28J60 ECON2 Register Bit Definitions
hudakz 4:d774541a34da 166 #define ECON2_AUTOINC 0x80
hudakz 4:d774541a34da 167 #define ECON2_PKTDEC 0x40
hudakz 4:d774541a34da 168 #define ECON2_PWRSV 0x20
hudakz 4:d774541a34da 169 #define ECON2_VRPS 0x08
hudakz 3:5b17e4656dd0 170 // ENC28J60 ECON1 Register Bit Definitions
hudakz 4:d774541a34da 171 #define ECON1_TXRST 0x80
hudakz 4:d774541a34da 172 #define ECON1_RXRST 0x40
hudakz 4:d774541a34da 173 #define ECON1_DMAST 0x20
hudakz 4:d774541a34da 174 #define ECON1_CSUMEN 0x10
hudakz 4:d774541a34da 175 #define ECON1_TXRTS 0x08
hudakz 4:d774541a34da 176 #define ECON1_RXEN 0x04
hudakz 4:d774541a34da 177 #define ECON1_BSEL1 0x02
hudakz 4:d774541a34da 178 #define ECON1_BSEL0 0x01
hudakz 3:5b17e4656dd0 179 // ENC28J60 MACON1 Register Bit Definitions
hudakz 4:d774541a34da 180 #define MACON1_LOOPBK 0x10
hudakz 4:d774541a34da 181 #define MACON1_TXPAUS 0x08
hudakz 4:d774541a34da 182 #define MACON1_RXPAUS 0x04
hudakz 4:d774541a34da 183 #define MACON1_PASSALL 0x02
hudakz 4:d774541a34da 184 #define MACON1_MARXEN 0x01
hudakz 3:5b17e4656dd0 185 // ENC28J60 MACON2 Register Bit Definitions
hudakz 4:d774541a34da 186 #define MACON2_MARST 0x80
hudakz 4:d774541a34da 187 #define MACON2_RNDRST 0x40
hudakz 4:d774541a34da 188 #define MACON2_MARXRST 0x08
hudakz 4:d774541a34da 189 #define MACON2_RFUNRST 0x04
hudakz 4:d774541a34da 190 #define MACON2_MATXRST 0x02
hudakz 4:d774541a34da 191 #define MACON2_TFUNRST 0x01
hudakz 3:5b17e4656dd0 192 // ENC28J60 MACON3 Register Bit Definitions
hudakz 4:d774541a34da 193 #define MACON3_PADCFG2 0x80
hudakz 4:d774541a34da 194 #define MACON3_PADCFG1 0x40
hudakz 4:d774541a34da 195 #define MACON3_PADCFG0 0x20
hudakz 4:d774541a34da 196 #define MACON3_TXCRCEN 0x10
hudakz 4:d774541a34da 197 #define MACON3_PHDRLEN 0x08
hudakz 4:d774541a34da 198 #define MACON3_HFRMLEN 0x04
hudakz 4:d774541a34da 199 #define MACON3_FRMLNEN 0x02
hudakz 4:d774541a34da 200 #define MACON3_FULDPX 0x01
hudakz 3:5b17e4656dd0 201 // ENC28J60 MICMD Register Bit Definitions
hudakz 4:d774541a34da 202 #define MICMD_MIISCAN 0x02
hudakz 4:d774541a34da 203 #define MICMD_MIIRD 0x01
hudakz 3:5b17e4656dd0 204 // ENC28J60 MISTAT Register Bit Definitions
hudakz 4:d774541a34da 205 #define MISTAT_NVALID 0x04
hudakz 4:d774541a34da 206 #define MISTAT_SCAN 0x02
hudakz 4:d774541a34da 207 #define MISTAT_BUSY 0x01
hudakz 3:5b17e4656dd0 208 // ENC28J60 PHY PHCON1 Register Bit Definitions
hudakz 4:d774541a34da 209 #define PHCON1_PRST 0x8000
hudakz 4:d774541a34da 210 #define PHCON1_PLOOPBK 0x4000
hudakz 4:d774541a34da 211 #define PHCON1_PPWRSV 0x0800
hudakz 4:d774541a34da 212 #define PHCON1_PDPXMD 0x0100
hudakz 3:5b17e4656dd0 213 // ENC28J60 PHY PHSTAT1 Register Bit Definitions
hudakz 4:d774541a34da 214 #define PHSTAT1_PFDPX 0x1000
hudakz 4:d774541a34da 215 #define PHSTAT1_PHDPX 0x0800
hudakz 4:d774541a34da 216 #define PHSTAT1_LLSTAT 0x0004
hudakz 4:d774541a34da 217 #define PHSTAT1_JBSTAT 0x0002
hudakz 3:5b17e4656dd0 218 // ENC28J60 PHY PHCON2 Register Bit Definitions
hudakz 4:d774541a34da 219 #define PHCON2_FRCLINK 0x4000
hudakz 4:d774541a34da 220 #define PHCON2_TXDIS 0x2000
hudakz 4:d774541a34da 221 #define PHCON2_JABBER 0x0400
hudakz 4:d774541a34da 222 #define PHCON2_HDLDIS 0x0100
hudakz 3:5b17e4656dd0 223
hudakz 3:5b17e4656dd0 224 // ENC28J60 Packet Control Byte Bit Definitions
hudakz 11:647d53d146f1 225 #define PKTCTRL_PHUGEEN 0x08
hudakz 11:647d53d146f1 226 #define PKTCTRL_PPADEN 0x04
hudakz 11:647d53d146f1 227 #define PKTCTRL_PCRCEN 0x02
hudakz 11:647d53d146f1 228 #define PKTCTRL_POVERRIDE 0x01
hudakz 3:5b17e4656dd0 229
hudakz 3:5b17e4656dd0 230 // SPI operation codes
hudakz 11:647d53d146f1 231 #define ENC28J60_READ_CTRL_REG 0x00
hudakz 11:647d53d146f1 232 #define ENC28J60_READ_BUF_MEM 0x3A
hudakz 11:647d53d146f1 233 #define ENC28J60_WRITE_CTRL_REG 0x40
hudakz 11:647d53d146f1 234 #define ENC28J60_WRITE_BUF_MEM 0x7A
hudakz 11:647d53d146f1 235 #define ENC28J60_BIT_FIELD_SET 0x80
hudakz 11:647d53d146f1 236 #define ENC28J60_BIT_FIELD_CLR 0xA0
hudakz 11:647d53d146f1 237 #define ENC28J60_SOFT_RESET 0xFF
hudakz 3:5b17e4656dd0 238
hudakz 3:5b17e4656dd0 239
hudakz 11:647d53d146f1 240 // The RXSTART_INIT should be zero. See Silicon Errata:
hudakz 11:647d53d146f1 241 // Sometimes, when ERXST or ERXND is written to, the exact value, 0000h, is stored in the Internal
hudakz 11:647d53d146f1 242 // Receive Write Pointer instead of the ERXST address.
hudakz 15:53715cc81c63 243 // Work around:
hudakz 11:647d53d146f1 244 // Use the lower segment of the buffer memory for the receive buffer, starting at address 0000h.
hudakz 11:647d53d146f1 245 // For example, use the range (0000h to n) for the receive buffer, and ((n + 1) to 8191) for the transmit buffer.
hudakz 11:647d53d146f1 246 #define RXSTART_INIT 0x0
hudakz 11:647d53d146f1 247 // Receive buffer end. Make sure this is an odd value (See Rev. B1,B4,B5,B7 Silicon Errata 'Memory (Ethernet Buffer)')
hudakz 15:53715cc81c63 248 #define RXEND_INIT (0x1FFF - 0x1800) // 0x1800 = 512 * 12
hudakz 11:647d53d146f1 249 // Start TX buffer RXEND_INIT + 1
hudakz 11:647d53d146f1 250 #define TXSTART_INIT RXEND_INIT + 1
hudakz 11:647d53d146f1 251 // end TX buffer at end of mem
hudakz 11:647d53d146f1 252 #define TXEND_INIT 0x1FFF
hudakz 3:5b17e4656dd0 253 //
hudakz 11:647d53d146f1 254 // Max frame length which the conroller will accept:
hudakz 11:647d53d146f1 255 #define MAX_FRAMELEN 1518 // (note: maximum ethernet frame length is 1518)
hudakz 3:5b17e4656dd0 256
hudakz 3:5b17e4656dd0 257 #endif