Connect Ethernet controller with PIC Code

• receive buffer start address : 0x0000.
• receive buffer end address : 0x19AD.
• transmit buffer start address: 0x19AE.
• transmit buffer end address : 0x1FFF.
• RAM buffer read/write pointers in auto-increment mode.
• receive filters set to default: CRC + MAC Unicast + MAC Broadcast in OR mode.
• flow control with TX and RX pause frames in full duplex mode.
• frames are padded to 60 bytes + CRC.
• maximum packet size is set to 1518.
• Back-to-Back Inter-Packet Gap: 0x15 in full duplex mode; 0x12 in half duplex mode.
• Non-Back-to-Back Inter-Packet Gap: 0x0012 in full duplex mode; 0x0C12 in half duplex mode.
• Collision window is set to 63 in half duplex mode to accomodate some ENC28J60 revisions silicon bugs.
• CLKOUT output is disabled to reduce EMI generation.
• half duplex loopback disabled.
• LED configuration: default (LEDA-link status, LEDB-link activity).

Parameters:

• mac: RAM buffer containing valid MAC address.
• ip: RAM buffer containing valid IP address.
• fullDuplex: ethernet duplex mode switch. Valid values: 0 (half duplex mode) and 1 (full duplex mode).

• SPI_Ethernet_CS: Chip Select line
• SPI_Ethernet_CS_Direction: Direction of the Chip Select pin
• SPI_Ethernet_RST: Reset line
• SPI_Ethernet_RST_Direction: Direction of the Reset pin

must be defined before using this function.
The SPI module needs to be initialized. See the SPIx_Init and SPIx_Init_Advanced routines.

#define SPI_Ethernet_HALFDUPLEX     0
#define SPI_Ethernet_FULLDUPLEX     1

// mE ethernet NIC pinout
sfr sbit SPI_Ethernet_Rst at RC0_bit;
sfr sbit SPI_Ethernet_CS  at RC1_bit;
sfr sbit SPI_Ethernet_Rst_Direction at TRISC0_bit;
sfr sbit SPI_Ethernet_CS_Direction  at TRISC1_bit;
// end ethernet NIC definitions

unsigned char myMacAddr[6] = {0x00, 0x14, 0xA5, 0x76, 0x19, 0x3f}; // my MAC address 
unsigned char myIpAddr     = {192, 168,   1, 60 };  // my IP addr

SPI1_Init(); 
SPI_Ethernet_Init(myMacAddr, myIpAddr, SPI_Ethernet_FULLDUPLEX);

• enFlt: network traffic/receive filter flags. Each bit corresponds to the appropriate network traffic/receive filter:
  

  Bit	Mask	Description	Predefined library const
  0	0x01	MAC Broadcast traffic/receive filter flag. When set, MAC broadcast traffic will be enabled.	_SPI_Ethernet_BROADCAST
  1	0x02	MAC Multicast traffic/receive filter flag. When set, MAC multicast traffic will be enabled.	_SPI_Ethernet_MULTICAST
  2	0x04	not used	none
  3	0x08	not used	none
  4	0x10	not used	none
  5	0x20	CRC check flag. When set, packets with invalid CRC field will be discarded.	_SPI_Ethernet_CRC
  6	0x40	not used	none
  7	0x80	MAC Unicast traffic/receive filter flag. When set, MAC unicast traffic will be enabled.	_SPI_Ethernet_UNICAST

    Note :

  • Advanced filtering available in the ENC28J60 module such as Pattern Match, Magic Packet and Hash Table can not be enabled by this routine. Additionaly, all filters, except CRC, enabled with this routine will work in OR mode, which means that packet will be received if any of the enabled filters accepts it.
  • This routine will change receive filter configuration on-the-fly. It will not, in any way, mess with enabling/disabling receive/transmit logic or any other part of the ENC28J60 module. The ENC28J60 module should be properly cofigured by the means of SPI_Ethernet_Init routine.

SPI_Ethernet_Enable(_SPI_Ethernet_CRC | _SPI_Ethernet_UNICAST); // enable CRC checking and Unicast traffic

• disFlt: network traffic/receive filter flags. Each bit corresponds to the appropriate network traffic/receive filter:
  

  Bit	Mask	Description	Predefined library const
  0	0x01	MAC Broadcast traffic/receive filter flag. When set, MAC broadcast traffic will be disabled.	_SPI_Ethernet_BROADCAST
  1	0x02	MAC Multicast traffic/receive filter flag. When set, MAC multicast traffic will be disabled.	_SPI_Ethernet_MULTICAST
  2	0x04	not used	none
  3	0x08	not used	none
  4	0x10	not used	none
  5	0x20	CRC check flag. When set, CRC check will be disabled and packets with invalid CRC field will be accepted.	_SPI_Ethernet_CRC
  6	0x40	not used	none
  7	0x80	MAC Unicast traffic/receive filter flag. When set, MAC unicast traffic will be disabled.	_SPI_Ethernet_UNICAST

    Note :

  • Advanced filtering available in the ENC28J60 module such as Pattern Match, Magic Packet and Hash Table can not be disabled by this routine.
  • This routine will change receive filter configuration on-the-fly. It will not, in any way, mess with enabling/disabling receive/transmit logic or any other part of the ENC28J60 module.
  • The ENC28J60 module should be properly cofigured by the means of SPI_Ethernet_Init routine.

SPI_Ethernet_Disable(_SPI_Ethernet_CRC | _SPI_Ethernet_UNICAST); // disable CRC checking and Unicast traffic

• 0 – upon successful packet processing (zero packets received or received packet processed successfully).
• 1 – upon reception error or receive buffer corruption. ENC28J60 controller needs to be restarted.
• 2 – received packet was not sent to us (not our IP, nor IP broadcast address).
• 3 – received IP packet was not IPv4.
• 4 – received packet was of type unknown to the library.

• ARP & ICMP requests are replied automatically.
• upon TCP request the SPI_Ethernet_UserTCP function is called for further processing.
• upon UDP request the SPI_Ethernet_UserUDP function is called for further processing.

if (SPI_Ethernet_doPacket() == 0)(1) {  // process received packets
  ...
}

• v: value to store

char data_;
...
SPI_Ethernet_putByte(data); // put an byte into ENC28J60 buffer

• ptr: RAM buffer containing bytes to be written into ENC28J60 RAM.
• n: number of bytes to be written.

char *buffer =  "mikroElektronika";  
...
SPI_Ethernet_putBytes(buffer, 16); // put an RAM array into ENC28J60 buffer

• ptr: const buffer containing bytes to be written into ENC28J60 RAM.
• n: number of bytes to be written.

const char *buffer =  "mikroElektronika";  
...
SPI_Ethernet_putConstBytes(buffer, 16); // put a const array into ENC28J60 buffer

• ptr: string to be written into ENC28J60 RAM.

char *buffer =  "mikroElektronika";  
...
SPI_Ethernet_putString(buffer); // put a RAM string into ENC28J60 buffer

• ptr: const string to be written into ENC28J60 RAM.

const char *buffer =  "mikroElektronika"; 
...
SPI_Ethernet_putConstString(buffer); // put a const string into ENC28J60 buffer

char buffer; 
...
buffer = SPI_Ethernet_getByte(); // read a byte from ENC28J60 buffer

• ptr: buffer for storing bytes read from ENC28J60 RAM.
• addr: ENC28J60 RAM start address. Valid values: 0..8192.
• n: number of bytes to be read.

char buffer[16];  
...
SPI_Ethernet_getBytes(buffer, 0x100, 16); // read 16 bytes, starting from address 0x100

• 0 – there should not be a reply to the request.
• Length of TCP/HTTP reply data field – otherwise.

• remoteHost: client’s IP address.
• remotePort: client’s TCP port.
• localPort: port to which the request is sent.
• reqLength: TCP/HTTP request data field length.
• flags: structure consisted of two bit fields :

  typedef struct {
    unsigned canCloseTCP: 1;  // flag which closes socket
    unsigned isBroadcast: 1;  // flag which denotes that the IP package has been received via subnet broadcast address (not used for PIC16 family)
  } TEthPktFlags;
  

• 0 – there should not be a reply to the request.
• Length of UDP reply data field – otherwise.

• remoteHost: client’s IP address.
• remotePort: client’s port.
• destPort: port to which the request is sent.
• flags: structure consisted of two bit fields :

  typedef struct {
    unsigned canCloseTCP: 1;  // flag which closes TCP socket (not relevant to UDP)
    unsigned isBroadcast: 1;  // flag which denotes that the IP package has been received via subnet broadcast address (not used for PIC16 family)
  } TEthPktFlags;
  

    Note : The function source code is provided with appropriate example projects. The code should be adjusted by the user to achieve desired reply.

unsigned char ipAddr[4];  // user IP address buffer
... 
memcpy(ipAddr, SPI_Ethernet_getIpAddress(), 4); // fetch IP address

unsigned char gwIpAddr[4];  // user gateway IP address buffer
... 
memcpy(gwIpAddr, SPI_Ethernet_getGwIpAddress(), 4); // fetch gateway IP address 

unsigned char dnsIpAddr[4];  // user DNS IP address buffer
... 
memcpy(dnsIpAddr, SPI_Ethernet_getDnsIpAddress(), 4); // fetch DNS server address 

unsigned char IpMask[4];  // user IP subnet mask buffer
... 
memcpy(IpMask, SPI_Ethernet_getIpMask(), 4); // fetch IP subnet mask

• ipMask: IP subnet mask.
• gwIpAddr gateway IP address.
• dnsIpAddr: DNS IP address.