ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include "esp_err.h"
#include "esp_event_base.h"
#include "hal/eth_types.h"
#include "esp_eth_spec.h"
#define ETH_CMD_CUSTOM_MAC_CMDS_OFFSET
#define ETH_CMD_CUSTOM_PHY_CMDS_OFFSET
esp_eth_state_t
esp_eth_mediator_s
esp_eth_mediator_s
eth_event_t
ETH_EVENT;
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_eth/include/esp_eth_com.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include "esp_err.h" #include "esp_event_base.h" #include "hal/eth_types.h" #include "esp_eth_spec.h" #ifdef __cplusplus extern "C" { #endif /** * @brief Offset for start of MAC custom ioctl commands * *//* ... */ #define ETH_CMD_CUSTOM_MAC_CMDS_OFFSET 0x0FFF /** * @brief Offset for start of PHY custom ioctl commands * *//* ... */ #define ETH_CMD_CUSTOM_PHY_CMDS_OFFSET 0x1FFF /** * @brief Ethernet driver state * *//* ... */ typedef enum { ETH_STATE_LLINIT, /*!< Lowlevel init done */ ETH_STATE_DEINIT, /*!< Deinit done */ ETH_STATE_LINK, /*!< Link status changed */ ETH_STATE_SPEED, /*!< Speed updated */ ETH_STATE_DUPLEX, /*!< Duplex updated */ ETH_STATE_PAUSE, /*!< Pause ability updated */ }{ ... } esp_eth_state_t; /** * @brief Ethernet mediator * *//* ... */ typedef struct esp_eth_mediator_s esp_eth_mediator_t; /** * @brief Ethernet mediator * *//* ... */ struct esp_eth_mediator_s { /** * @brief Read PHY register * * @param[in] eth: mediator of Ethernet driver * @param[in] phy_addr: PHY Chip address (0~31) * @param[in] phy_reg: PHY register index code * @param[out] reg_value: PHY register value * * @return * - ESP_OK: read PHY register successfully * - ESP_FAIL: read PHY register failed because some error occurred * *//* ... */ esp_err_t (*phy_reg_read)(esp_eth_mediator_t *eth, uint32_t phy_addr, uint32_t phy_reg, uint32_t *reg_value); /** * @brief Write PHY register * * @param[in] eth: mediator of Ethernet driver * @param[in] phy_addr: PHY Chip address (0~31) * @param[in] phy_reg: PHY register index code * @param[in] reg_value: PHY register value * * @return * - ESP_OK: write PHY register successfully * - ESP_FAIL: write PHY register failed because some error occurred *//* ... */ esp_err_t (*phy_reg_write)(esp_eth_mediator_t *eth, uint32_t phy_addr, uint32_t phy_reg, uint32_t reg_value); /** * @brief Deliver packet to upper stack * * @param[in] eth: mediator of Ethernet driver * @param[in] buffer: packet buffer * @param[in] length: length of the packet * * @return * - ESP_OK: deliver packet to upper stack successfully * - ESP_FAIL: deliver packet failed because some error occurred * *//* ... */ esp_err_t (*stack_input)(esp_eth_mediator_t *eth, uint8_t *buffer, uint32_t length); /** * @brief Callback on Ethernet state changed * * @param[in] eth: mediator of Ethernet driver * @param[in] state: new state * @param[in] args: optional argument for the new state * * @return * - ESP_OK: process the new state successfully * - ESP_FAIL: process the new state failed because some error occurred * *//* ... */ esp_err_t (*on_state_changed)(esp_eth_mediator_t *eth, esp_eth_state_t state, void *args); }{ ... }; /** * @brief Ethernet event declarations * *//* ... */ typedef enum { ETHERNET_EVENT_START, /*!< Ethernet driver start */ ETHERNET_EVENT_STOP, /*!< Ethernet driver stop */ ETHERNET_EVENT_CONNECTED, /*!< Ethernet got a valid link */ ETHERNET_EVENT_DISCONNECTED, /*!< Ethernet lost a valid link */ }{ ... } eth_event_t; /** * @brief Ethernet event base declaration * *//* ... */ ESP_EVENT_DECLARE_BASE(ETH_EVENT); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: