Backported Ethernet library from 1.5.x

arduino · cmaglie · Dec 2, 2014 · Oct 14, 2014 · Oct 15, 2014 · Oct 17, 2014
commit b9b0fcdadc04a6a2d6954611b49aa1f7a6422e80
diff --git a/libraries/Ethernet/Dhcp.cpp b/libraries/Ethernet/Dhcp.cpp
@@ -1,13 +1,13 @@
 // DHCP Library v0.3 - April 25, 2009
 // Author: Jordan Terrell - blog.jordanterrell.com
 
-#include "w5100.h"
+#include "utility/w5100.h"
 
 #include <string.h>
 #include <stdlib.h>
 #include "Dhcp.h"
 #include "Arduino.h"
-#include "util.h"
+#include "utility/util.h"
 
 int DhcpClass::beginWithDHCP(uint8_t *mac, unsigned long timeout, unsigned long responseTimeout)
 {

diff --git a/libraries/Ethernet/Dhcp.h b/libraries/Ethernet/Dhcp.h
diff --git a/libraries/Ethernet/Dns.cpp b/libraries/Ethernet/Dns.cpp
@@ -2,9 +2,9 @@
 // (c) Copyright 2009-2010 MCQN Ltd.
 // Released under Apache License, version 2.0
 
-#include "w5100.h"
+#include "utility/w5100.h"
 #include "EthernetUdp.h"
-#include "util.h"
+#include "utility/util.h"
 
 #include "Dns.h"
 #include <string.h>

diff --git a/libraries/Ethernet/Ethernet.cpp b/libraries/Ethernet/Ethernet.cpp
@@ -1,4 +1,4 @@
-#include "w5100.h"
+#include "utility/w5100.h"
 #include "Ethernet.h"
 #include "Dhcp.h"
 
@@ -16,18 +16,22 @@ int EthernetClass::begin(uint8_t *mac_address)
 
   // Initialise the basic info
   W5100.init();
+  SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
   W5100.setMACAddress(mac_address);
   W5100.setIPAddress(IPAddress(0,0,0,0).raw_address());
+  SPI.endTransaction();
 
   // Now try to get our config info from a DHCP server
   int ret = _dhcp->beginWithDHCP(mac_address);
   if(ret == 1)
   {
     // We've successfully found a DHCP server and got our configuration info, so set things
     // accordingly
+    SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
     W5100.setIPAddress(_dhcp->getLocalIp().raw_address());
     W5100.setGatewayIp(_dhcp->getGatewayIp().raw_address());
     W5100.setSubnetMask(_dhcp->getSubnetMask().raw_address());
+    SPI.endTransaction();
     _dnsServerAddress = _dhcp->getDnsServerIp();
   }
 
@@ -61,10 +65,12 @@ void EthernetClass::begin(uint8_t *mac_address, IPAddress local_ip, IPAddress dn
 void EthernetClass::begin(uint8_t *mac, IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet)
 {
   W5100.init();
+  SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
   W5100.setMACAddress(mac);
-  W5100.setIPAddress(local_ip._address);
-  W5100.setGatewayIp(gateway._address);
-  W5100.setSubnetMask(subnet._address);
+  W5100.setIPAddress(local_ip.raw_address());
+  W5100.setGatewayIp(gateway.raw_address());
+  W5100.setSubnetMask(subnet.raw_address());
+  SPI.endTransaction();
   _dnsServerAddress = dns_server;
 }
 
@@ -80,9 +86,11 @@ int EthernetClass::maintain(){
       case DHCP_CHECK_RENEW_OK:
       case DHCP_CHECK_REBIND_OK:
         //we might have got a new IP.
+        SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
         W5100.setIPAddress(_dhcp->getLocalIp().raw_address());
         W5100.setGatewayIp(_dhcp->getGatewayIp().raw_address());
         W5100.setSubnetMask(_dhcp->getSubnetMask().raw_address());
+        SPI.endTransaction();
         _dnsServerAddress = _dhcp->getDnsServerIp();
         break;
       default:
@@ -96,21 +104,27 @@ int EthernetClass::maintain(){
 IPAddress EthernetClass::localIP()
 {
   IPAddress ret;
+  SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
   W5100.getIPAddress(ret.raw_address());
+  SPI.endTransaction();
   return ret;
 }
 
 IPAddress EthernetClass::subnetMask()
 {
   IPAddress ret;
+  SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
   W5100.getSubnetMask(ret.raw_address());
+  SPI.endTransaction();
   return ret;
 }
 
 IPAddress EthernetClass::gatewayIP()
 {
   IPAddress ret;
+  SPI.beginTransaction(SPI_ETHERNET_SETTINGS);
   W5100.getGatewayIp(ret.raw_address());
+  SPI.endTransaction();
   return ret;
 }
 

diff --git a/libraries/Ethernet/EthernetClient.cpp b/libraries/Ethernet/EthernetClient.cpp
@@ -1,5 +1,5 @@
-#include "w5100.h"
-#include "socket.h"
+#include "utility/w5100.h"
+#include "utility/socket.h"
 
 extern "C" {
   #include "string.h"
@@ -40,7 +40,7 @@ int EthernetClient::connect(IPAddress ip, uint16_t port) {
     return 0;
 
   for (int i = 0; i < MAX_SOCK_NUM; i++) {
-    uint8_t s = W5100.readSnSR(i);
+    uint8_t s = socketStatus(i);
     if (s == SnSR::CLOSED || s == SnSR::FIN_WAIT || s == SnSR::CLOSE_WAIT) {
       _sock = i;
       break;
@@ -88,7 +88,7 @@ size_t EthernetClient::write(const uint8_t *buf, size_t size) {
 
 int EthernetClient::available() {
   if (_sock != MAX_SOCK_NUM)
-    return W5100.getRXReceivedSize(_sock);
+    return recvAvailable(_sock);
   return 0;
 }
 
@@ -120,8 +120,7 @@ int EthernetClient::peek() {
 }
 
 void EthernetClient::flush() {
-  while (available())
-    read();
+  ::flush(_sock);
 }
 
 void EthernetClient::stop() {
@@ -154,7 +153,7 @@ uint8_t EthernetClient::connected() {
 
 uint8_t EthernetClient::status() {
   if (_sock == MAX_SOCK_NUM) return SnSR::CLOSED;
-  return W5100.readSnSR(_sock);
+  return socketStatus(_sock);
 }
 
 // the next function allows us to use the client returned by

diff --git a/libraries/Ethernet/EthernetServer.cpp b/libraries/Ethernet/EthernetServer.cpp
@@ -1,5 +1,5 @@
-#include "w5100.h"
-#include "socket.h"
+#include "utility/w5100.h"
+#include "utility/socket.h"
 extern "C" {
 #include "string.h"
 }

diff --git a/libraries/Ethernet/EthernetUdp.cpp b/libraries/Ethernet/EthernetUdp.cpp
@@ -26,8 +26,8 @@
  * bjoern@cs.stanford.edu 12/30/2008
  */
 
-#include "w5100.h"
-#include "socket.h"
+#include "utility/w5100.h"
+#include "utility/socket.h"
 #include "Ethernet.h"
 #include "Udp.h"
 #include "Dns.h"
@@ -41,7 +41,7 @@ uint8_t EthernetUDP::begin(uint16_t port) {
     return 0;
 
   for (int i = 0; i < MAX_SOCK_NUM; i++) {
-    uint8_t s = W5100.readSnSR(i);
+    uint8_t s = socketStatus(i);
     if (s == SnSR::CLOSED || s == SnSR::FIN_WAIT) {
       _sock = i;
       break;
@@ -120,7 +120,7 @@ int EthernetUDP::parsePacket()
   // discard any remaining bytes in the last packet
   flush();
 
-  if (W5100.getRXReceivedSize(_sock) > 0)
+  if (recvAvailable(_sock) > 0)
   {
     //HACK - hand-parse the UDP packet using TCP recv method
     uint8_t tmpBuf[8];

diff --git a/libraries/Ethernet/examples/BarometricPressureWebServer/BarometricPressureWebServer.ino b/libraries/Ethernet/examples/BarometricPressureWebServer/BarometricPressureWebServer.ino
@@ -1,22 +1,22 @@
 /*
   SCP1000 Barometric Pressure Sensor Display
- 
+
  Serves the output of a Barometric Pressure Sensor as a web page.
  Uses the SPI library. For details on the sensor, see:
  http://www.sparkfun.com/commerce/product_info.php?products_id=8161
  http://www.vti.fi/en/support/obsolete_products/pressure_sensors/
- 
+
  This sketch adapted from Nathan Seidle's SCP1000 example for PIC:
  http://www.sparkfun.com/datasheets/Sensors/SCP1000-Testing.zip
- 
+
  Circuit:
  SCP1000 sensor attached to pins 6,7, and 11 - 13:
  DRDY: pin 6
  CSB: pin 7
  MOSI: pin 11
  MISO: pin 12
  SCK: pin 13
- 
+
  created 31 July 2010
  by Tom Igoe
  */
@@ -28,16 +28,17 @@
 
 // assign a MAC address for the ethernet controller.
 // fill in your address here:
-byte mac[] = { 
-  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED};
+byte mac[] = {
+  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
+};
 // assign an IP address for the controller:
-IPAddress ip(192,168,1,20);
-IPAddress gateway(192,168,1,1);	
+IPAddress ip(192, 168, 1, 20);
+IPAddress gateway(192, 168, 1, 1);
 IPAddress subnet(255, 255, 255, 0);
 
 
 // Initialize the Ethernet server library
-// with the IP address and port you want to use 
+// with the IP address and port you want to use
 // (port 80 is default for HTTP):
 EthernetServer server(80);
 
@@ -49,7 +50,7 @@ const int TEMPERATURE = 0x21;   //16 bit temperature reading
 
 // pins used for the connection with the sensor
 // the others you need are controlled by the SPI library):
-const int dataReadyPin = 6; 
+const int dataReadyPin = 6;
 const int chipSelectPin = 7;
 
 float temperature = 0.0;
@@ -83,9 +84,9 @@ void setup() {
 
 }
 
-void loop() { 
+void loop() {
   // check for a reading no more than once a second.
-  if (millis() - lastReadingTime > 1000){
+  if (millis() - lastReadingTime > 1000) {
     // if there's a reading ready, read it:
     // don't do anything until the data ready pin is high:
     if (digitalRead(dataReadyPin) == HIGH) {
@@ -109,13 +110,13 @@ void getData() {
   temperature = (float)tempData / 20.0;
 
   //Read the pressure data highest 3 bits:
-  byte  pressureDataHigh = readRegister(0x1F, 1);   
+  byte  pressureDataHigh = readRegister(0x1F, 1);
   pressureDataHigh &= 0b00000111; //you only needs bits 2 to 0
 
   //Read the pressure data lower 16 bits:
-  unsigned int pressureDataLow = readRegister(0x20, 2);    
+  unsigned int pressureDataLow = readRegister(0x20, 2);
   //combine the two parts into one 19-bit number:
-  pressure = ((pressureDataHigh << 16) | pressureDataLow)/4;
+  pressure = ((pressureDataHigh << 16) | pressureDataLow) / 4;
 
   Serial.print("Temperature: ");
   Serial.print(temperature);
@@ -149,13 +150,13 @@ void listenForEthernetClients() {
           client.println("<br />");
           client.print("Pressure: " + String(pressure));
           client.print(" Pa");
-          client.println("<br />");  
+          client.println("<br />");
           break;
         }
         if (c == '\n') {
           // you're starting a new line
           currentLineIsBlank = true;
-        } 
+        }
         else if (c != '\r') {
           // you've gotten a character on the current line
           currentLineIsBlank = false;
@@ -167,7 +168,7 @@ void listenForEthernetClients() {
     // close the connection:
     client.stop();
   }
-} 
+}
 
 
 //Send a write command to SCP1000
@@ -179,20 +180,20 @@ void writeRegister(byte registerName, byte registerValue) {
   registerName |= 0b00000010; //Write command
 
   // take the chip select low to select the device:
-  digitalWrite(chipSelectPin, LOW); 
+  digitalWrite(chipSelectPin, LOW);
 
   SPI.transfer(registerName); //Send register location
   SPI.transfer(registerValue); //Send value to record into register
 
   // take the chip select high to de-select:
-  digitalWrite(chipSelectPin, HIGH); 
+  digitalWrite(chipSelectPin, HIGH);
 }
 
 
 //Read register from the SCP1000:
 unsigned int readRegister(byte registerName, int numBytes) {
   byte inByte = 0;           // incoming from  the SPI read
-  unsigned int result = 0;   // result to return 
+  unsigned int result = 0;   // result to return
 
   // SCP1000 expects the register name in the upper 6 bits
   // of the byte:
@@ -201,22 +202,22 @@ unsigned int readRegister(byte registerName, int numBytes) {
   registerName &= 0b11111100; //Read command
 
   // take the chip select low to select the device:
-  digitalWrite(chipSelectPin, LOW); 
+  digitalWrite(chipSelectPin, LOW);
   // send the device the register you want to read:
-  int command = SPI.transfer(registerName); 
+  int command = SPI.transfer(registerName);
   // send a value of 0 to read the first byte returned:
-  inByte = SPI.transfer(0x00); 
-  
+  inByte = SPI.transfer(0x00);
+
   result = inByte;
-  // if there's more than one byte returned, 
+  // if there's more than one byte returned,
   // shift the first byte then get the second byte:
-  if (numBytes > 1){
+  if (numBytes > 1) {
     result = inByte << 8;
-    inByte = SPI.transfer(0x00); 
-    result = result |inByte;
+    inByte = SPI.transfer(0x00);
+    result = result | inByte;
   }
   // take the chip select high to de-select:
-  digitalWrite(chipSelectPin, HIGH); 
+  digitalWrite(chipSelectPin, HIGH);

2851
   // return the result:
   return(result);
 }