Using macros for T1S class object instantiation.

arduino-libraries · Dec 2, 2024 · 9bc3d51 · 9bc3d51
1 parent e0c1bfc
commit 9bc3d51
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 64 deletions.
diff --git a/examples/UDP_Client/UDP_Client.ino b/examples/UDP_Client/UDP_Client.ino
@@ -34,16 +34,11 @@ static uint16_t const UDP_SERVER_PORT = 8888;
  * GLOBAL VARIABLES
  **************************************************************************************/
 
-TC6::TC6_Io tc6_io(
 #if defined(ARDUINO_GIGA) || defined(ARDUINO_PORTENTA_C33)
-  SPI1
+  Arduino_10BASE_T1S_PHY_TC6(SPI1, CS_PIN, RESET_PIN, IRQ_PIN);
 #else
-  SPI
+  Arduino_10BASE_T1S_PHY_TC6(SPI, CS_PIN, RESET_PIN, IRQ_PIN);
 #endif
-  , CS_PIN
-  , RESET_PIN
-  , IRQ_PIN);
-TC6::TC6_Arduino_10BASE_T1S tc6_inst(tc6_io);
 Arduino_10BASE_T1S_UDP udp_client;
 
 /**************************************************************************************
@@ -61,19 +56,19 @@ void setup()
    */
   pinMode(IRQ_PIN, INPUT_PULLUP);
   attachInterrupt(digitalPinToInterrupt(IRQ_PIN),
-                  []() { tc6_io.onInterrupt(); },
+                  []() { t1s_io.onInterrupt(); },
                   FALLING);
 
   /* Initialize IO module. */
-  if (!tc6_io.begin())
+  if (!t1s_io.begin())
   {
     Serial.println("'TC6_Io::begin(...)' failed.");
     for (;;) { }
   }
 
   MacAddress const mac_addr = MacAddress::create_from_uid();
 
-  if (!tc6_inst.begin(ip_addr
+  if (!t1s_phy.begin(ip_addr
     , network_mask
     , gateway
     , mac_addr
@@ -104,7 +99,7 @@ void loop()
   /* Services the hardware and the protocol stack.
    * Must be called cyclic. The faster the better.
    */
-  tc6_inst.service();
+  t1s_phy.service();
 
   static unsigned long prev_beacon_check = 0;
   static unsigned long prev_udp_packet_sent = 0;
@@ -114,7 +109,7 @@ void loop()
   if ((now - prev_beacon_check) > 1000)
   {
     prev_beacon_check = now;
-    if (!tc6_inst.getPlcaStatus(OnPlcaStatus))
+    if (!t1s_phy.getPlcaStatus(OnPlcaStatus))
       Serial.println("getPlcaStatus(...) failed");
   }
 
@@ -189,6 +184,6 @@ static void OnPlcaStatus(bool success, bool plcaStatus)
     Serial.println("PLCA Mode active");
   else {
     Serial.println("CSMA/CD fallback");
-    tc6_inst.enablePlca();
+    t1s_phy.enablePlca();
   }
 }
diff --git a/examples/UDP_Server/UDP_Server.ino b/examples/UDP_Server/UDP_Server.ino
@@ -38,16 +38,11 @@ static uint16_t const UDP_SERVER_LOCAL_PORT = 8888;
  * GLOBAL VARIABLES
  **************************************************************************************/
 
-TC6::TC6_Io tc6_io(
 #if defined(ARDUINO_GIGA) || defined(ARDUINO_PORTENTA_C33)
-  SPI1
+  Arduino_10BASE_T1S_PHY_TC6(SPI1, CS_PIN, RESET_PIN, IRQ_PIN);
 #else
-  SPI
+  Arduino_10BASE_T1S_PHY_TC6(SPI, CS_PIN, RESET_PIN, IRQ_PIN);
 #endif
-  , CS_PIN
-  , RESET_PIN
-  , IRQ_PIN);
-TC6::TC6_Arduino_10BASE_T1S tc6_inst(tc6_io);
 Arduino_10BASE_T1S_UDP udp_server;
 
 /**************************************************************************************
@@ -65,19 +60,19 @@ void setup()
    */
   pinMode(IRQ_PIN, INPUT_PULLUP);
   attachInterrupt(digitalPinToInterrupt(IRQ_PIN),
-                  []() { tc6_io.onInterrupt(); },
+                  []() { t1s_io.onInterrupt(); },
                   FALLING);
 
   /* Initialize IO module. */
-  if (!tc6_io.begin())
+  if (!t1s_io.begin())
   {
     Serial.println("'TC6_Io::begin(...)' failed.");
     for (;;) { }
   }
 
   MacAddress const mac_addr = MacAddress::create_from_uid();
 
-  if (!tc6_inst.begin(ip_addr
+  if (!t1s_phy.begin(ip_addr
     , network_mask
     , gateway
     , mac_addr
@@ -108,7 +103,7 @@ void loop()
   /* Services the hardware and the protocol stack.
    * Must be called cyclic. The faster the better.
    */
-  tc6_inst.service();
+  t1s_phy.service();
 
   static unsigned long prev_beacon_check = 0;
 
@@ -117,7 +112,7 @@ void loop()
   if ((now - prev_beacon_check) > 1000)
   {
     prev_beacon_check = now;
-    if (!tc6_inst.getPlcaStatus(OnPlcaStatus))
+    if (!t1s_phy.getPlcaStatus(OnPlcaStatus))
       Serial.println("getPlcaStatus(...) failed");
   }
 
@@ -180,6 +175,6 @@ static void OnPlcaStatus(bool success, bool plcaStatus)
     Serial.println("PLCA Mode active");
   else {
     Serial.println("CSMA/CD fallback");
-    tc6_inst.enablePlca();
+    t1s_phy.enablePlca();
   }
 }
diff --git a/examples/tools/Control-DIOx/Control-DIOx.ino b/examples/tools/Control-DIOx/Control-DIOx.ino
@@ -35,16 +35,11 @@ static auto const DIO_PIN = TC6::DIO::A0;
  * GLOBAL VARIABLES
  **************************************************************************************/
 
-TC6::TC6_Io tc6_io(
 #if defined(ARDUINO_GIGA) || defined(ARDUINO_PORTENTA_C33)
-  SPI1
+  Arduino_10BASE_T1S_PHY_TC6(SPI1, CS_PIN, RESET_PIN, IRQ_PIN);
 #else
-  SPI
+  Arduino_10BASE_T1S_PHY_TC6(SPI, CS_PIN, RESET_PIN, IRQ_PIN);
 #endif
-  , CS_PIN
-  , RESET_PIN
-  , IRQ_PIN);
-TC6::TC6_Arduino_10BASE_T1S tc6_inst(tc6_io);
 
 /**************************************************************************************
  * SETUP/LOOP
@@ -61,19 +56,19 @@ void setup()
    */
   pinMode(IRQ_PIN, INPUT_PULLUP);
   attachInterrupt(digitalPinToInterrupt(IRQ_PIN),
-                  []() { tc6_io.onInterrupt(); },
+                  []() { t1s_io.onInterrupt(); },
                   FALLING);
 
   /* Initialize IO module. */
-  if (!tc6_io.begin())
+  if (!t1s_io.begin())
   {
     Serial.println("'TC6_Io::begin(...)' failed.");
     for (;;) { }
   }
 
   MacAddress const mac_addr = MacAddress::create_from_uid();
 
-  if (!tc6_inst.begin(ip_addr
+  if (!t1s_phy.begin(ip_addr
     , network_mask
     , gateway
     , mac_addr
@@ -96,7 +91,7 @@ void loop()
   /* Services the hardware and the protocol stack.
    * Must be called cyclic. The faster the better.
    */
-  tc6_inst.service();
+  t1s_phy.service();
 
   static unsigned long prev_dio_toogle = 0;
   auto const now = millis();
@@ -112,7 +107,7 @@ void loop()
     Serial.print(" = ");
     Serial.println(dio_val);
 
-    tc6_inst.digitalWrite(DIO_PIN, dio_val);
+    t1s_phy.digitalWrite(DIO_PIN, dio_val);
     dio_val = !dio_val;
   }
 }

diff --git a/examples/tools/PoDL-Sink-Auto-TurnOff/PoDL-Sink-Auto-TurnOff.ino b/examples/tools/PoDL-Sink-Auto-TurnOff/PoDL-Sink-Auto-TurnOff.ino
@@ -32,16 +32,11 @@ static T1SMacSettings const t1s_default_mac_settings;
  * GLOBAL VARIABLES
  **************************************************************************************/
 
-TC6::TC6_Io tc6_io(
 #if defined(ARDUINO_GIGA) || defined(ARDUINO_PORTENTA_C33)
-  SPI1
+  Arduino_10BASE_T1S_PHY_TC6(SPI1, CS_PIN, RESET_PIN, IRQ_PIN);
 #else
-  SPI
+  Arduino_10BASE_T1S_PHY_TC6(SPI, CS_PIN, RESET_PIN, IRQ_PIN);
 #endif
-  , CS_PIN
-  , RESET_PIN
-  , IRQ_PIN);
-TC6::TC6_Arduino_10BASE_T1S tc6_inst(tc6_io);
 
 /**************************************************************************************
  * SETUP/LOOP
@@ -58,19 +53,19 @@ void setup()
    */
   pinMode(IRQ_PIN, INPUT_PULLUP);
   attachInterrupt(digitalPinToInterrupt(IRQ_PIN),
-                  []() { tc6_io.onInterrupt(); },
+                  []() { t1s_io.onInterrupt(); },
                   FALLING);
 
   /* Initialize IO module. */
-  if (!tc6_io.begin())
+  if (!t1s_io.begin())
   {
     Serial.println("'TC6_Io::begin(...)' failed.");
     for (;;) { }
   }
 
   MacAddress const mac_addr = MacAddress::create_from_uid();
 
-  if (!tc6_inst.begin(ip_addr
+  if (!t1s_phy.begin(ip_addr
     , network_mask
     , gateway
     , mac_addr
@@ -88,9 +83,9 @@ void setup()
   Serial.println(t1s_default_mac_settings);
 
   /* A0 -> LOCAL_ENABLE -> DO NOT feed power from board to network. */
-  tc6_inst.digitalWrite(TC6::DIO::A0, false);
+  t1s_phy.digitalWrite(TC6::DIO::A0, false);
   /* A1 -> T1S_DISABLE -> Open the switch connecting network to board by pulling EN LOW. */
-  tc6_inst.digitalWrite(TC6::DIO::A1, true);
+  t1s_phy.digitalWrite(TC6::DIO::A1, true);
 
   Serial.println("PoDL-Sink-Auto-TurnOff");
 }
@@ -100,5 +95,5 @@ void loop()
   /* Services the hardware and the protocol stack.
    * Must be called cyclic. The faster the better.
    */
-  tc6_inst.service();
+  t1s_phy.service();
 }
diff --git a/examples/tools/PoDL-Source/PoDL-Source.ino b/examples/tools/PoDL-Source/PoDL-Source.ino
@@ -32,16 +32,11 @@ static T1SMacSettings const t1s_default_mac_settings;
  * GLOBAL VARIABLES
  **************************************************************************************/
 
-TC6::TC6_Io tc6_io(
 #if defined(ARDUINO_GIGA) || defined(ARDUINO_PORTENTA_C33)
-  SPI1
+  Arduino_10BASE_T1S_PHY_TC6(SPI1, CS_PIN, RESET_PIN, IRQ_PIN);
 #else
-  SPI
+  Arduino_10BASE_T1S_PHY_TC6(SPI, CS_PIN, RESET_PIN, IRQ_PIN);
 #endif
-  , CS_PIN
-  , RESET_PIN
-  , IRQ_PIN);
-TC6::TC6_Arduino_10BASE_T1S tc6_inst(tc6_io);
 
 /**************************************************************************************
  * SETUP/LOOP
@@ -58,19 +53,19 @@ void setup()
    */
   pinMode(IRQ_PIN, INPUT_PULLUP);
   attachInterrupt(digitalPinToInterrupt(IRQ_PIN),
-                  []() { tc6_io.onInterrupt(); },
+                  []() { t1s_io.onInterrupt(); },
                   FALLING);
 
   /* Initialize IO module. */
-  if (!tc6_io.begin())
+  if (!t1s_io.begin())
   {
     Serial.println("'TC6_Io::begin(...)' failed.");
     for (;;) { }
   }
 
   MacAddress const mac_addr = MacAddress::create_from_uid();
 
-  if (!tc6_inst.begin(ip_addr
+  if (!t1s_phy.begin(ip_addr
     , network_mask
     , gateway
     , mac_addr
@@ -88,9 +83,9 @@ void setup()
   Serial.println(t1s_default_mac_settings);
 
   /* A0 -> LOCAL_ENABLE -> feed power from board to network. */
-  tc6_inst.digitalWrite(TC6::DIO::A0, true);
+  t1s_phy.digitalWrite(TC6::DIO::A0, true);
   /* A1 -> T1S_DISABLE -> close the switch connecting network to board. */
-  tc6_inst.digitalWrite(TC6::DIO::A1, true);
+  t1s_phy.digitalWrite(TC6::DIO::A1, true);
 
   Serial.println("PoDL-Source");
 }
@@ -100,5 +95,5 @@ void loop()
   /* Services the hardware and the protocol stack.
    * Must be called cyclic. The faster the better.
    */
-  tc6_inst.service();
+  t1s_phy.service();
 }
diff --git a/src/Arduino_10BASE_T1S.h b/src/Arduino_10BASE_T1S.h
@@ -53,3 +53,11 @@ static int const RESET_PIN =  -1;
 static int const IRQ_PIN   =  -1;
 # warning "No pins defined for your board"
 #endif
+
+/**************************************************************************************
+ * MACROS
+ **************************************************************************************/
+
+#define Arduino_10BASE_T1S_PHY_TC6(__SPI, __CS_PIN, __RESET_PIN, __IRQ_PIN) \
+  TC6::TC6_Io t1s_io(__SPI, __CS_PIN, __RESET_PIN, __IRQ_PIN);              \
+  TC6::TC6_Arduino_10BASE_T1S t1s_phy(t1s_io);