Eth: STM32: Overriding HAL callbacks in stm32xx

This commit enables the Overriding of HAL callbacks and IRQHandler
in stm32xx_emac.cpp. Hence the user can have their own
implementations of callbacks and IRQHandler functions.

Signed-off-by: Kather Rafi Ibrahim <[email protected]>

Author: katherrafi

connectivity/drivers/emac/TARGET_STM/CMakeLists.txt

@@ -19,4 +19,5 @@ target_include_directories(mbed-emac
 target_sources(mbed-emac
     INTERFACE
         stm32xx_emac.cpp
+        stm32xx_eth_irq_callback.cpp
 )

connectivity/drivers/emac/TARGET_STM/stm32xx_emac.cpp

@@ -144,8 +144,8 @@ extern "C" {
 #endif
 
 void _eth_config_mac(ETH_HandleTypeDef *heth);
-void HAL_ETH_RxCpltCallback(ETH_HandleTypeDef *heth);
 void ETH_IRQHandler(void);
+MBED_WEAK void STM_HAL_ETH_Handler(ETH_HandleTypeDef *heth);
 
 #ifdef __cplusplus
 }
@@ -242,20 +242,14 @@ static void MPU_Config(void)
 
 #endif
 
-
-
 /**
- * Ethernet Rx Transfer completed callback
+ * IRQ Handler
  *
  * @param  heth: ETH handle
  * @retval None
  */
-void HAL_ETH_RxCpltCallback(ETH_HandleTypeDef *heth)
+MBED_WEAK void STM_HAL_ETH_Handler()
 {
-    STM32_EMAC &emac = STM32_EMAC::get_instance();
-    if (emac.thread) {
-        osThreadFlagsSet(emac.thread, FLAG_RX);
-    }
 }
 
 /**
@@ -266,8 +260,7 @@ void HAL_ETH_RxCpltCallback(ETH_HandleTypeDef *heth)
  */
 void ETH_IRQHandler(void)
 {
-    STM32_EMAC &emac = STM32_EMAC::get_instance();
-    HAL_ETH_IRQHandler(&emac.EthHandle);
+    STM_HAL_ETH_Handler();
 }
 
 STM32_EMAC::STM32_EMAC()

connectivity/drivers/emac/TARGET_STM/stm32xx_eth_irq_callback.cpp

@@ -0,0 +1,58 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2021, STMicroelectronics
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 3. Neither the name of STMicroelectronics nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef USE_USER_DEFINED_HAL_ETH_IRQ_CALLBACK
+
+#include "stm32xx_emac.h"
+#define FLAG_RX                 1
+
+/**
+ * Override Ethernet Rx Transfer completed callback
+ * @param  heth: ETH handle
+ * @retval None
+ */
+void HAL_ETH_RxCpltCallback(ETH_HandleTypeDef *heth)
+{
+    STM32_EMAC &emac = STM32_EMAC::get_instance();
+    if (emac.thread) {
+        osThreadFlagsSet(emac.thread, FLAG_RX);
+    }
+}
+
+/**
+ * Override the IRQ Handler
+ * @param  None
+ * @retval None
+ */
+void STM_HAL_ETH_Handler()
+{
+   STM32_EMAC &emac = STM32_EMAC::get_instance();
+   HAL_ETH_IRQHandler(&emac.EthHandle);
+}
+
+#endif /* USE_USER_DEFINED_HAL_ETH_IRQ_CALLBACK */

targets/TARGET_STM/README.md

@@ -503,6 +503,22 @@ https://github.com/ARMmbed/mbed-os/blob/master/connectivity/drivers/emac/TARGET_
 Option is also to define your own `HAL_ETH_MspInit` function,
 you then have to add **USE_USER_DEFINED_HAL_ETH_MSPINIT** macro.
 
+#### Custom IRQ Handler and Callback from user application
+To use the custom IRQ Handler and the callbacks, you need to add
+**USE_USER_DEFINED_HAL_ETH_IRQ_CALLBACK** macro
+inside any of the JASON file in either targets.json or in mbed_app.json file.
+
+For example in the targets.json,
+you need to add this line in your target:
+```"macros_add": ["USE_USER_DEFINED_HAL_ETH_IRQ_CALLBACK"],```
+or for example in the mbed_app.json, you need to add:
+``` "macros": ["USE_USER_DEFINED_HAL_ETH_IRQ_CALLBACK"]```
+
+By doing the any of the above json files, the corresponding user defined custom apis like
+HAL_ETH_RxCpltCallback() and STM_HAL_ETH_Handler() can be called from
+the user application.
+
+#### Changing default MAC address in STM32
 To change the default MAC address in STM32,
 If we have the function mbed_otp_mac_address() in the user application,the default ethernet address
 can be changed.