espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-15 15:00:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix some typos related to ethernet documentation and Kconfig. Closes https://github.com/espressif/esp-idf/pull/2642

Browse Source
This commit is contained in:
Peter Meerwald-Stadler
2018-10-27 15:03:27 +02:00
committed by krzychb
parent 618236d8ff
commit 6a197d305f
4 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
components/ethernet/Kconfig
View File

@@ -27,7 +27,7 @@ config EMAC_L2_TO_L3_RX_BUF_MODE
passing it from the Ethernet MAC (L2) to the IP stack (L3). Otherwise, IP stack
will receive pointers to the DMA buffers used by Ethernet MAC.
When Ethernet MAC doesn't have any unused buffers left, it will drop incomming
When Ethernet MAC doesn't have any unused buffers left, it will drop incoming
packets (flow control may help with this problem, to some extent).
The buffers for the IP stack are allocated from the heap, so the total number of

32
components/ethernet/include/esp_eth.h
View File

@@ -115,7 +115,7 @@ typedef struct {
/**
* @brief Init ethernet mac
*
* @note config can not be NULL,and phy chip must be suitable to phy init func.
* @note config can not be NULL, and phy chip must be suitable to phy init func.
*
* @param[in] config mac init data.
*
@@ -144,7 +144,7 @@ esp_err_t esp_eth_deinit(void);
* This function may be called, if you only need to initialize the Ethernet
* driver without having to use the network stack on top.
*
* @note config can not be NULL,and phy chip must be suitable to phy init func.
* @note config can not be NULL, and phy chip must be suitable to phy init func.
* @param[in] config mac init data.
*
* @return
@@ -156,7 +156,7 @@ esp_err_t esp_eth_init_internal(eth_config_t *config);
/**
* @brief Send packet from tcp/ip to mac
*
* @note buf can not be NULL,size must be less than 1580
* @note buf can not be NULL, size must be less than 1580
*
* @param[in] buf: start address of packet data.
*
@@ -171,7 +171,7 @@ esp_err_t esp_eth_tx(uint8_t *buf, uint16_t size);
/**
* @brief Enable ethernet interface
*
* @note Shout be called after esp_eth_init
* @note Should be called after esp_eth_init
*
* @return
* - ESP_OK
@@ -182,7 +182,7 @@ esp_err_t esp_eth_enable(void);
/**
* @brief Disable ethernet interface
*
* @note Shout be called after esp_eth_init
* @note Should be called after esp_eth_init
*
* @return
* - ESP_OK
@@ -200,24 +200,24 @@ esp_err_t esp_eth_disable(void);
void esp_eth_get_mac(uint8_t mac[6]);
/**
* @brief Read phy reg with smi interface.
* @brief Write PHY reg with SMI interface.
*
* @note phy base addr must be right.
* @note PHY base addr must be right.
*
* @param[in] reg_num: phy reg num.
* @param[in] reg_num: PHY reg num.
*
* @param[in] value: value which write to phy reg.
* @param[in] value: value which is written to PHY reg.
*/
void esp_eth_smi_write(uint32_t reg_num, uint16_t value);
/**
* @brief Read phy reg with smi interface.
* @brief Read PHY reg with SMI interface.
*
* @note phy base addr must be right.
* @note PHY base addr must be right.
*
* @param[in] reg_num: phy reg num.
* @param[in] reg_num: PHY reg num.
*
* @return value what read from phy reg
* @return value that is read from PHY reg
*/
uint16_t esp_eth_smi_read(uint32_t reg_num);
@@ -254,9 +254,9 @@ static inline esp_err_t esp_eth_smi_wait_set(uint32_t reg_num, uint16_t value_ma
/**
* @brief Free emac rx buf.
*
* @note buf can not be null,and it is tcpip input buf.
* @note buf can not be null, and it is tcpip input buf.
*
* @param[in] buf: start address of recevie packet data.
* @param[in] buf: start address of received packet data.
*
*/
void esp_eth_free_rx_buf(void *buf);
@@ -264,7 +264,7 @@ void esp_eth_free_rx_buf(void *buf);
/**
* @brief Set mac of ethernet interface.
*
* @note user can call this function after emac_init,and the new mac address will be enabled after emac_enable.
* @note user can call this function after emac_init, and the new mac address will be enabled after emac_enable.
*
* @param[in] mac: the Mac address.
*