fix: align MAC address api with Arduino reference

https://www.arduino.cc/reference/en/libraries/ethernet/ethernet.macaddress/
https://www.arduino.cc/reference/en/libraries/ethernet/ethernet.setmacaddress/

Fixes #81

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

README.md

@@ -29,7 +29,7 @@ extend the default one by adding some extra configuration in a file named `lwipo
 
 ## New alternative init procedure **!!!**
 
-There are alternative inits of the Ethernetinterface with following orders:
+There are alternative inits of the Ethernet interface with following orders:
 
 	Ethernet.begin();
 	Ethernet.begin(ip);
@@ -39,16 +39,16 @@ There are alternative inits of the Ethernetinterface with following orders:
 
 This is more logical. A MAC address is no more needed and will retrieved internally by the mbed MAC address!
 
-You can get the MAC address with following function, this must done after Ethernet.Begin()
+You can get the MAC address with following function, this must be done after Ethernet.Begin()
 
 	uint8_t *mac;
 	Ethernet.begin();
-	mac = Ethernet.MACAddress();
+	Ethernet.MACAddress(mac);
 
-You can also set a new user based MAC address, this must done before Ethernet.begin()
+You can also set a new user based MAC address, this must be done before Ethernet.begin()
 
 	uint8_t newMAC[] = {0x00, 0x80, 0xE1, 0x01, 0x01, 0x01};
-	Ethernet.MACAddress(newMAC);
+	Ethernet.setMACAddress(newMAC);
 	Ethernet.begin();
 
 ## Note

keywords.txt

@@ -38,9 +38,11 @@ localPort	KEYWORD2
 maintain	KEYWORD2
 linkStatus	KEYWORD2
 MACAddress	KEYWORD2
+setMACAddress	KEYWORD2
 subnetMask	KEYWORD2
 gatewayIP	KEYWORD2
 dnsServerIP	KEYWORD2
+setDnsServerIP	KEYWORD2
 setConnectionTimeout	KEYWORD2
 
 #######################################

src/STM32Ethernet.cpp

@@ -1,14 +1,19 @@
 #include "STM32Ethernet.h"
 #include "Dhcp.h"
 
+EthernetClass::EthernetClass()
+{
+  MACAddressDefault();
+}
+
 int EthernetClass::begin(unsigned long timeout, unsigned long responseTimeout)
 {
   static DhcpClass s_dhcp;
   _dhcp = &s_dhcp;
-  stm32_eth_init(MACAddressDefault(), NULL, NULL, NULL);
+  stm32_eth_init(_mac_address, NULL, NULL, NULL);
 
   // Now try to get our config info from a DHCP server
-  int ret = _dhcp->beginWithDHCP(mac_address, timeout, responseTimeout);
+  int ret = _dhcp->beginWithDHCP(_mac_address, timeout, responseTimeout);
   if (ret == 1) {
     _dnsServerAddress = _dhcp->getDnsServerIp();
   }
@@ -39,7 +44,7 @@ void EthernetClass::begin(IPAddress local_ip, IPAddress subnet, IPAddress gatewa
 
 void EthernetClass::begin(IPAddress local_ip, IPAddress subnet, IPAddress gateway, IPAddress dns_server)
 {
-  stm32_eth_init(MACAddressDefault(), local_ip.raw_address(), gateway.raw_address(), subnet.raw_address());
+  stm32_eth_init(_mac_address, local_ip.raw_address(), gateway.raw_address(), subnet.raw_address());
   /* If there is a local DHCP informs it of our manual IP configuration to
   prevent IP conflict */
   stm32_DHCP_manual_config();
@@ -58,7 +63,7 @@ int EthernetClass::begin(uint8_t *mac_address, unsigned long timeout, unsigned l
   if (ret == 1) {
     _dnsServerAddress = _dhcp->getDnsServerIp();
   }
-  MACAddress(mac_address);
+  setMACAddress(mac_address);
   return ret;
 }
 
@@ -86,14 +91,14 @@ void EthernetClass::begin(uint8_t *mac_address, IPAddress local_ip, IPAddress dn
   begin(mac_address, local_ip, dns_server, gateway, subnet);
 }
 
-void EthernetClass::begin(uint8_t *mac, IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet)
+void EthernetClass::begin(uint8_t *mac_address, IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet)
 {
-  stm32_eth_init(mac, local_ip.raw_address(), gateway.raw_address(), subnet.raw_address());
+  stm32_eth_init(mac_address, local_ip.raw_address(), gateway.raw_address(), subnet.raw_address());
   /* If there is a local DHCP informs it of our manual IP configuration to
   prevent IP conflict */
   stm32_DHCP_manual_config();
   _dnsServerAddress = dns_server;
-  MACAddress(mac);
+  setMACAddress(mac_address);
 }
 
 EthernetLinkStatus EthernetClass::linkStatus()
@@ -135,31 +140,36 @@ void EthernetClass::schedule(void)
 
 uint8_t *EthernetClass::MACAddressDefault(void)
 {
-  if ((mac_address[0] + mac_address[1] + mac_address[2] + mac_address[3] + mac_address[4] + mac_address[5]) == 0) {
+  if ((_mac_address[0] + _mac_address[1] + _mac_address[2] + _mac_address[3] + _mac_address[4] + _mac_address[5]) == 0) {
     uint32_t baseUID = *(uint32_t *)UID_BASE;
-    mac_address[0] = 0x00;
-    mac_address[1] = 0x80;
-    mac_address[2] = 0xE1;
-    mac_address[3] = (baseUID & 0x00FF0000) >> 16;
-    mac_address[4] = (baseUID & 0x0000FF00) >> 8;
-    mac_address[5] = (baseUID & 0x000000FF);
+    _mac_address[0] = 0x00;
+    _mac_address[1] = 0x80;
+    _mac_address[2] = 0xE1;
+    _mac_address[3] = (baseUID & 0x00FF0000) >> 16;
+    _mac_address[4] = (baseUID & 0x0000FF00) >> 8;
+    _mac_address[5] = (baseUID & 0x000000FF);
   }
-  return mac_address;
+  return _mac_address;
 }
 
-void EthernetClass::MACAddress(uint8_t *mac)
+void EthernetClass::setMACAddress(const uint8_t *mac_address)
 {
-  mac_address[0] = mac[0];
-  mac_address[1] = mac[1];
-  mac_address[2] = mac[2];
-  mac_address[3] = mac[3];
-  mac_address[4] = mac[4];
-  mac_address[5] = mac[5];
+  _mac_address[0] = mac_address[0];
+  _mac_address[1] = mac_address[1];
+  _mac_address[2] = mac_address[2];
+  _mac_address[3] = mac_address[3];
+  _mac_address[4] = mac_address[4];
+  _mac_address[5] = mac_address[5];
 }
 
-uint8_t *EthernetClass::MACAddress(void)
+void EthernetClass::MACAddress(uint8_t *mac_address)
 {
-  return mac_address;
+  mac_address[0] = _mac_address[0];
+  mac_address[1] = _mac_address[1];
+  mac_address[2] = _mac_address[2];
+  mac_address[3] = _mac_address[3];
+  mac_address[4] = _mac_address[4];
+  mac_address[5] = _mac_address[5];
 }
 
 IPAddress EthernetClass::localIP()

src/STM32Ethernet.h

@@ -17,10 +17,11 @@ class EthernetClass {
   private:
     IPAddress _dnsServerAddress;
     DhcpClass *_dhcp;
-    uint8_t mac_address[6];
+    uint8_t   _mac_address[6];
     uint8_t   *MACAddressDefault(void);
 
   public:
+    EthernetClass();
     // Initialise the Ethernet with the internal provided MAC address and gain the rest of the
     // configuration through DHCP.
     // Returns 0 if the DHCP configuration failed, and 1 if it succeeded
@@ -43,13 +44,13 @@ class EthernetClass {
     int maintain();
     void schedule(void);
 
-    void MACAddress(uint8_t *mac);
-    uint8_t *MACAddress(void);
+    void MACAddress(uint8_t *mac_address);
     IPAddress localIP();
     IPAddress subnetMask();
     IPAddress gatewayIP();
     IPAddress dnsServerIP();
 
+    void setMACAddress(const uint8_t *mac_address);
     void setDnsServerIP(const IPAddress dns_server);
 
     friend class EthernetClient;