espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-03 20:54:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/deprecate_esp_eth_receive' into 'master'

Browse Source 
esp_eth: deprecate esp_eth_receive

Closes IDF-1065 and IDFGH-4657

See merge request espressif/esp-idf!12176
This commit is contained in:
David Čermák
2021-01-28 02:14:42 +08:00
parent 9ff04b2e79 0208810eca
commit 445b1a6717
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
components/esp_eth/include/esp_eth.h
View File

@@ -195,7 +195,8 @@ esp_err_t esp_eth_update_input_path(
esp_err_t esp_eth_transmit(esp_eth_handle_t hdl, void *buf, size_t length); esp_err_t esp_eth_transmit(esp_eth_handle_t hdl, void *buf, size_t length);
/** /**
* @brief General Receive * @brief General Receive is deprecated and shall not be accessed from app code,
* as polling is not supported by Ethernet.
* *
* @param[in] hdl: handle of Ethernet driver * @param[in] hdl: handle of Ethernet driver
* @param[out] buf: buffer to preserve the received packet * @param[out] buf: buffer to preserve the received packet
@@ -203,6 +204,9 @@ esp_err_t esp_eth_transmit(esp_eth_handle_t hdl, void *buf, size_t length);
* *
* @note Before this function got invoked, the value of "length" should set by user, equals the size of buffer. * @note Before this function got invoked, the value of "length" should set by user, equals the size of buffer.
* After the function returned, the value of "length" means the real length of received data. * After the function returned, the value of "length" means the real length of received data.
* @note This API was exposed by accident, users should not use this API in their applications.
* Ethernet driver is interrupt driven, and doesn't support polling mode.
* Instead, users should register input callback with ``esp_eth_update_input_path``.
* *
* @return * @return
* - ESP_OK: receive frame buffer successfully * - ESP_OK: receive frame buffer successfully
@@ -211,7 +215,7 @@ esp_err_t esp_eth_transmit(esp_eth_handle_t hdl, void *buf, size_t length);
* in this case, value of returned "length" indicates the real size of incoming data. * in this case, value of returned "length" indicates the real size of incoming data.
* - ESP_FAIL: receive frame buffer failed because some other error occurred * - ESP_FAIL: receive frame buffer failed because some other error occurred
*/ */
esp_err_t esp_eth_receive(esp_eth_handle_t hdl, uint8_t *buf, uint32_t *length); esp_err_t esp_eth_receive(esp_eth_handle_t hdl, uint8_t *buf, uint32_t *length) __attribute__((deprecated("Ethernet driver is interrupt driven only, please register input callback with esp_eth_update_input_path")));
/** /**
* @brief Misc IO function of Etherent driver * @brief Misc IO function of Etherent driver

6
components/esp_eth/src/esp_eth_phy_lan8720.c
View File

@@ -109,7 +109,7 @@ typedef union {
struct { struct {
uint32_t reserved1 : 1; /* Reserved */ uint32_t reserved1 : 1; /* Reserved */
uint32_t auto_nego_page_received : 1; /* Auto-Negotiation Page Received */ uint32_t auto_nego_page_received : 1; /* Auto-Negotiation Page Received */
uint32_t parallel_detect_falut : 1; /* Parallel Detection Fault */ uint32_t parallel_detect_fault : 1; /* Parallel Detection Fault */
uint32_t auto_nego_lp_acknowledge : 1; /* Auto-Negotiation LP Acknowledge */ uint32_t auto_nego_lp_acknowledge : 1; /* Auto-Negotiation LP Acknowledge */
uint32_t link_down : 1; /* Link Down */ uint32_t link_down : 1; /* Link Down */
uint32_t remote_fault_detect : 1; /* Remote Fault Detect */ uint32_t remote_fault_detect : 1; /* Remote Fault Detect */
@@ -129,12 +129,12 @@ typedef union {
struct { struct {
uint32_t reserved1 : 1; /* Reserved */ uint32_t reserved1 : 1; /* Reserved */
uint32_t auto_nego_page_received : 1; /* Auto-Negotiation Page Received */ uint32_t auto_nego_page_received : 1; /* Auto-Negotiation Page Received */
uint32_t parallel_detect_falut : 1; /* Parallel Detection Fault */ uint32_t parallel_detect_fault : 1; /* Parallel Detection Fault */
uint32_t auto_nego_lp_acknowledge : 1; /* Auto-Negotiation LP Acknowledge */ uint32_t auto_nego_lp_acknowledge : 1; /* Auto-Negotiation LP Acknowledge */
uint32_t link_down : 1; /* Link Down */ uint32_t link_down : 1; /* Link Down */
uint32_t remote_fault_detect : 1; /* Remote Fault Detect */ uint32_t remote_fault_detect : 1; /* Remote Fault Detect */
uint32_t auto_nego_complete : 1; /* Auto-Negotiation Complete */ uint32_t auto_nego_complete : 1; /* Auto-Negotiation Complete */
uint32_t energy_on_generate : 1; /* ENERYON generated */ uint32_t energy_on_generate : 1; /* ENERGY ON generated */
uint32_t reserved2 : 8; /* Reserved */ uint32_t reserved2 : 8; /* Reserved */
}; };
uint32_t val; uint32_t val;