mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
ae2da1e235
Resolved possible race conditions when accessing registers in different banks. Added Tx ready semaphore when requesting packet to transmit (ENC is slow => access to it needs to be controlled). Added setting of CS hold time based on Data sheet. Added option to set the ENC28J60 to Full Duplex mode. Addressed several ENC28J60 Erratas. Restructured ENC28J60 example folder structure so the driver could be easily linked from different projects. Extended the README to guide users of how to properly use the ENC28J60 chip. Extended iperf example to include ENC28J60. Closes https://github.com/espressif/esp-idf/issues/4747 Closes https://github.com/espressif/esp-idf/issues/7117 Closes https://github.com/espressif/esp-idf/issues/7156
126 lines
3.5 KiB
C
126 lines
3.5 KiB
C
// Copyright 2021 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "esp_eth_phy.h"
|
|
#include "esp_eth_mac.h"
|
|
#include "driver/spi_master.h"
|
|
|
|
#define CS_HOLD_TIME_MIN_NS 210
|
|
|
|
/**
|
|
* @brief ENC28J60 specific configuration
|
|
*
|
|
*/
|
|
typedef struct {
|
|
spi_device_handle_t spi_hdl; /*!< Handle of SPI device driver */
|
|
int int_gpio_num; /*!< Interrupt GPIO number */
|
|
} eth_enc28j60_config_t;
|
|
|
|
/**
|
|
* @brief ENC28J60 Supported Revisions
|
|
*
|
|
*/
|
|
typedef enum {
|
|
ENC28J60_REV_B1 = 0b00000010,
|
|
ENC28J60_REV_B4 = 0b00000100,
|
|
ENC28J60_REV_B5 = 0b00000101,
|
|
ENC28J60_REV_B7 = 0b00000110
|
|
} eth_enc28j60_rev_t;
|
|
|
|
/**
|
|
* @brief Default ENC28J60 specific configuration
|
|
*
|
|
*/
|
|
#define ETH_ENC28J60_DEFAULT_CONFIG(spi_device) \
|
|
{ \
|
|
.spi_hdl = spi_device, \
|
|
.int_gpio_num = 4, \
|
|
}
|
|
|
|
/**
|
|
* @brief Compute amount of SPI bit-cycles the CS should stay active after the transmission
|
|
* to meet ENC28J60 CS Hold Time specification.
|
|
*
|
|
* @param clock_speed_mhz SPI Clock frequency in MHz (valid range is <1, 20>)
|
|
* @return uint8_t
|
|
*/
|
|
static inline uint8_t enc28j60_cal_spi_cs_hold_time(int clock_speed_mhz)
|
|
{
|
|
if (clock_speed_mhz <= 0 || clock_speed_mhz > 20) {
|
|
return 0;
|
|
}
|
|
int temp = clock_speed_mhz * CS_HOLD_TIME_MIN_NS;
|
|
uint8_t cs_posttrans = temp / 1000;
|
|
if (temp % 1000) {
|
|
cs_posttrans += 1;
|
|
}
|
|
|
|
return cs_posttrans;
|
|
}
|
|
|
|
/**
|
|
* @brief Create ENC28J60 Ethernet MAC instance
|
|
*
|
|
* @param[in] enc28j60_config: ENC28J60 specific configuration
|
|
* @param[in] mac_config: Ethernet MAC configuration
|
|
*
|
|
* @return
|
|
* - instance: create MAC instance successfully
|
|
* - NULL: create MAC instance failed because some error occurred
|
|
*/
|
|
esp_eth_mac_t *esp_eth_mac_new_enc28j60(const eth_enc28j60_config_t *enc28j60_config, const eth_mac_config_t *mac_config);
|
|
|
|
/**
|
|
* @brief Create a PHY instance of ENC28J60
|
|
*
|
|
* @param[in] config: configuration of PHY
|
|
*
|
|
* @return
|
|
* - instance: create PHY instance successfully
|
|
* - NULL: create PHY instance failed because some error occurred
|
|
*/
|
|
esp_eth_phy_t *esp_eth_phy_new_enc28j60(const eth_phy_config_t *config);
|
|
|
|
// todo: the below functions should be accessed through ioctl in the future
|
|
/**
|
|
* @brief Set ENC28J60 Duplex mode. It sets Duplex mode first to the PHY and then
|
|
* MAC is set based on what PHY indicates.
|
|
*
|
|
* @param phy ENC28J60 PHY Handle
|
|
* @param duplex Duplex mode
|
|
*
|
|
* @return esp_err_t
|
|
* - ESP_OK when PHY registers were correctly written.
|
|
*/
|
|
esp_err_t enc28j60_set_phy_duplex(esp_eth_phy_t *phy, eth_duplex_t duplex);
|
|
|
|
/**
|
|
* @brief Get ENC28J60 silicon revision ID
|
|
*
|
|
* @param mac ENC28J60 MAC Handle
|
|
* @return eth_enc28j60_rev_t
|
|
* - returns silicon revision ID read during initialization
|
|
*/
|
|
eth_enc28j60_rev_t emac_enc28j60_get_chip_info(esp_eth_mac_t *mac);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|