From fd9f97b5f46c28253de261e9968eed5b628c5007 Mon Sep 17 00:00:00 2001
From: Ondrej Kosta <ondrej.kosta@espressif.com>
Date: Wed, 5 Jan 2022 16:26:37 +0100
Subject: [PATCH] emac_hal_start/stop function description added

---
 components/hal/include/hal/emac_hal.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/components/hal/include/hal/emac_hal.h b/components/hal/include/hal/emac_hal.h
index fd99b584be..4f332811ab 100644
--- a/components/hal/include/hal/emac_hal.h
+++ b/components/hal/include/hal/emac_hal.h
@@ -212,8 +212,22 @@ uint32_t emac_hal_get_phy_data(emac_hal_context_t *hal);
 
 void emac_hal_set_address(emac_hal_context_t *hal, uint8_t *mac_addr);
 
+/**
+ * @brief Starts EMAC Transmission & Reception
+ *
+ * @param hal EMAC HAL context infostructure
+ */
 void emac_hal_start(emac_hal_context_t *hal);
 
+/**
+ * @brief Stops EMAC Transmission & Reception
+ *
+ * @param hal EMAC HAL context infostructure
+ * @return
+ *     - ESP_OK: succeed
+  *    - ESP_ERR_INVALID_STATE: previous frame transmission is not completed. When this error occurs,
+  *      wait and reapeat the EMAC stop again.
+ */
 esp_err_t emac_hal_stop(emac_hal_context_t *hal);
 
 uint32_t emac_hal_get_tx_desc_owner(emac_hal_context_t *hal);