Skip to content

Commit

Permalink
feat(eth): Allow setting the RX task stack size (#10003)
Browse files Browse the repository at this point in the history
* feat(eth): Allow setting the RX task stack size

Default stack size of 2K might not be enough in some cases. Increase the default to safer 4K and allow setting it to custom value.

* ci(pre-commit): Apply automatic fixes

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
  • Loading branch information
me-no-dev and pre-commit-ci-lite[bot] authored Jul 10, 2024
1 parent 60b6faa commit 0adf787
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
11 changes: 10 additions & 1 deletion libraries/Ethernet/src/ETH.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@ ETHClass::ETHClass(uint8_t eth_index)
,
_pin_mcd(-1), _pin_mdio(-1), _pin_power(-1), _pin_rmii_clock(-1)
#endif /* CONFIG_ETH_USE_ESP32_EMAC */
{
,
_task_stack_size(4096) {
}

ETHClass::~ETHClass() {}
Expand All @@ -141,6 +142,10 @@ bool ETHClass::ethDetachBus(void *bus_pointer) {
return true;
}

void ETHClass::setTaskStackSize(size_t size) {
_task_stack_size = size;
}

#if CONFIG_ETH_USE_ESP32_EMAC
bool ETHClass::begin(eth_phy_type_t type, int32_t phy_addr, int mdc, int mdio, int power, eth_clock_mode_t clock_mode) {
esp_err_t ret = ESP_OK;
Expand Down Expand Up @@ -214,6 +219,7 @@ bool ETHClass::begin(eth_phy_type_t type, int32_t phy_addr, int mdc, int mdio, i

eth_mac_config_t eth_mac_config = ETH_MAC_DEFAULT_CONFIG();
eth_mac_config.sw_reset_timeout_ms = 1000;
eth_mac_config.rx_task_stack_size = _task_stack_size;

esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&mac_config, &eth_mac_config);
if (mac == NULL) {
Expand Down Expand Up @@ -578,6 +584,9 @@ bool ETHClass::beginSPI(
__unused eth_mac_config_t eth_mac_config = ETH_MAC_DEFAULT_CONFIG();
__unused eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();

// Set RX Task Stack Size
eth_mac_config.rx_task_stack_size = _task_stack_size;

// Update PHY config based on board specific configuration
phy_config.phy_addr = phy_addr;
phy_config.reset_gpio_num = _pin_rst;
Expand Down
4 changes: 4 additions & 0 deletions libraries/Ethernet/src/ETH.h
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ class ETHClass : public NetworkInterface {

void end();

// This function must be called before `begin()`
void setTaskStackSize(size_t size);

// ETH Handle APIs
bool fullDuplex() const;
uint8_t linkSpeed() const;
Expand Down Expand Up @@ -203,6 +206,7 @@ class ETHClass : public NetworkInterface {
int8_t _pin_power;
int8_t _pin_rmii_clock;
#endif /* CONFIG_ETH_USE_ESP32_EMAC */
size_t _task_stack_size;

static bool ethDetachBus(void *bus_pointer);
bool beginSPI(
Expand Down

0 comments on commit 0adf787

Please sign in to comment.