driver_lan8720.h

Go to the documentation of this file.

 
#ifndef DRIVER_LAN8720_H
#define DRIVER_LAN8720_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    LAN8720_BOOL_FALSE = 0x00,        
    LAN8720_BOOL_TRUE  = 0x01,        
} lan8720_bool_t;

typedef enum
{
    LAN8720_SPEED_10M  = 0x00,        
    LAN8720_SPEED_100M = 0x01,        
} lan8720_speed_t;

typedef enum
{
    LAN8720_DUPLEX_HALF = 0x00,        
    LAN8720_DUPLEX_FULL = 0x01,        
} lan8720_duplex_t;

typedef enum
{
    LAN8720_LINK_DOWN = 0x00,        
    LAN8720_LINK_UP   = 0x01,        
} lan8720_link_t;



typedef enum
{
    LAN8720_PAUSE_NO         = 0x00,        
    LAN8720_PAUSE_SYMMETRIC  = 0x01,        
    LAN8720_PAUSE_ASYMMETRIC = 0x02,        
    LAN8720_PAUSE_BOTH       = 0x03,        
} lan8720_pause_t;

typedef enum
{
    LAN8720_MODE_10BASE_T_HALF_DUPLEX              = 0x00,        
    LAN8720_MODE_10BASE_T_FULL_DUPLEX              = 0x01,        
    LAN8720_MODE_100BASE_TX_HALF_DUPLEX            = 0x02,        
    LAN8720_MODE_100BASE_TX_FULL_DUPLEX            = 0x03,        
    LAN8720_MODE_100BASE_TX_HALF_DUPLEX_ADVERTISED = 0x04,        
    LAN8720_MODE_REPEATER_MODE                     = 0x05,        
    LAN8720_MODE_POWER_DOWN_MODE                   = 0x06,        
    LAN8720_MODE_ALL_CAPABLE                       = 0x07,        
} lan8720_mode_t;

typedef enum
{
    LAN8720_MANUAL_CHANNEL_SELECT_MDI  = 0x00,        
    LAN8720_MANUAL_CHANNEL_SELECT_MDIX = 0x01,        
} lan8720_manual_channel_select_t;

typedef enum
{
    LAN8720_POLARITY_NORMAL   = 0x00,        
    LAN8720_POLARITY_REVERSED = 0x01,        
} lan8720_polarity_t;

typedef enum
{
    LAN8720_INTERRUPT_ENERGY_ON                      = 7,        
    LAN8720_INTERRUPT_AUTO_NEGOTIATION_COMPLETE      = 6,        
    LAN8720_INTERRUPT_REMOTE_FAULT                   = 5,        
    LAN8720_INTERRUPT_LINK_DOWN                      = 4,        
    LAN8720_INTERRUPT_AUTO_NEGOTIATION_LP_ACK        = 3,        
    LAN8720_INTERRUPT_PARALLEL_DETECTION_FAULT       = 2,        
    LAN8720_INTERRUPT_AUTO_NEGOTIATION_PAGE_RECEIVED = 1,        
} lan8720_interrupt_t;

typedef enum
{
    LAN8720_SPEED_INDICATION_10BASE_T_HALF_DUPLEX   = 0x01,        
    LAN8720_SPEED_INDICATION_10BASE_T_FULL_DUPLEX   = 0x05,        
    LAN8720_SPEED_INDICATION_100BASE_TX_HALF_DUPLEX = 0x02,        
    LAN8720_SPEED_INDICATION_100BASE_TX_FULL_DUPLEX = 0x06,        
} lan8720_speed_indication_t;

typedef struct lan8720_handle_s
{
    uint8_t smi_addr;                                                      
    uint8_t (*smi_init)(void);                                             
    uint8_t (*smi_deinit)(void);                                           
    uint8_t (*smi_read)(uint8_t addr, uint8_t reg, uint16_t *data);        
    uint8_t (*smi_write)(uint8_t addr, uint8_t reg, uint16_t data);        
    uint8_t (*reset_gpio_init)(void);                                      
    uint8_t (*reset_gpio_deinit)(void);                                    
    uint8_t (*reset_gpio_write)(uint8_t level);                            
    void (*delay_ms)(uint32_t ms);                                         
    void (*debug_print)(const char *const fmt, ...);                       
    uint8_t inited;                                                        
} lan8720_handle_t;

typedef struct lan8720_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[16];                
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} lan8720_info_t;



#define DRIVER_LAN8720_LINK_INIT(HANDLE, STRUCTURE)           memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_LAN8720_LINK_SMI_INIT(HANDLE, FUC)            (HANDLE)->smi_init = FUC

#define DRIVER_LAN8720_LINK_SMI_DEINIT(HANDLE, FUC)          (HANDLE)->smi_deinit = FUC

#define DRIVER_LAN8720_LINK_SMI_READ(HANDLE, FUC)            (HANDLE)->smi_read = FUC

#define DRIVER_LAN8720_LINK_SMI_WRITE(HANDLE, FUC)           (HANDLE)->smi_write = FUC

#define DRIVER_LAN8720_LINK_RESET_GPIO_INIT(HANDLE, FUC)     (HANDLE)->reset_gpio_init = FUC

#define DRIVER_LAN8720_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)   (HANDLE)->reset_gpio_deinit = FUC

#define DRIVER_LAN8720_LINK_RESET_GPIO_WRITE(HANDLE, FUC)    (HANDLE)->reset_gpio_write = FUC

#define DRIVER_LAN8720_LINK_DELAY_MS(HANDLE, FUC)            (HANDLE)->delay_ms = FUC

#define DRIVER_LAN8720_LINK_DEBUG_PRINT(HANDLE, FUC)         (HANDLE)->debug_print = FUC



uint8_t lan8720_info(lan8720_info_t *info);

uint8_t lan8720_set_address(lan8720_handle_t *handle, uint8_t addr);

uint8_t lan8720_get_address(lan8720_handle_t *handle, uint8_t *addr);

uint8_t lan8720_init(lan8720_handle_t *handle);

uint8_t lan8720_deinit(lan8720_handle_t *handle);

uint8_t lan8720_set_soft_reset(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_soft_reset(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_loop_back(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_loop_back(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_speed_select(lan8720_handle_t *handle, lan8720_speed_t speed);

uint8_t lan8720_get_speed_select(lan8720_handle_t *handle, lan8720_speed_t *speed);

uint8_t lan8720_set_auto_negotiation(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_power_down(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_power_down(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_electrical_isolation(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_electrical_isolation(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_restart_auto_negotiate(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_restart_auto_negotiate(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_duplex_mode(lan8720_handle_t *handle, lan8720_duplex_t mode);

uint8_t lan8720_get_duplex_mode(lan8720_handle_t *handle, lan8720_duplex_t *mode);

uint8_t lan8720_get_100base_t4(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_100base_tx_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_100base_tx_half_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_10base_t_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_10base_t_half_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_100base_t2_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_100base_t2_half_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_extended_status_information(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiate_complete(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_remote_fault(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiate_ability(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_link_status(lan8720_handle_t *handle, lan8720_link_t *status);

uint8_t lan8720_get_jabber_detect(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_extended_capabilities(lan8720_handle_t *handle, lan8720_bool_t *enable);



uint8_t lan8720_set_identifier(lan8720_handle_t *handle, uint32_t phy_id, 
                               uint8_t model_number, uint8_t revision_number);

uint8_t lan8720_get_identifier(lan8720_handle_t *handle, uint32_t *phy_id, 
                               uint8_t *model_number, uint8_t *revision_number);

uint8_t lan8720_set_auto_negotiation_advertisement_remote_fault(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation_advertisement_remote_fault(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_auto_negotiation_advertisement_pause(lan8720_handle_t *handle, lan8720_pause_t pause);

uint8_t lan8720_get_auto_negotiation_advertisement_pause(lan8720_handle_t *handle, lan8720_pause_t *pause);

uint8_t lan8720_set_auto_negotiation_advertisement_100base_tx_full_duplex(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation_advertisement_100base_tx_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_auto_negotiation_advertisement_100base_tx(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation_advertisement_100base_tx(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_auto_negotiation_advertisement_10base_t_full_duplex(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation_advertisement_10base_t_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_auto_negotiation_advertisement_10base_t(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_negotiation_advertisement_10base_t(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_auto_negotiation_advertisement_selector_field(lan8720_handle_t *handle, uint8_t selector);

uint8_t lan8720_get_auto_negotiation_advertisement_selector_field(lan8720_handle_t *handle, uint8_t *selector);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_next_page(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_acknowledge(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_remote_fault(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_pause(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_t4(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_tx_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_100base_tx(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_10base_t_full_duplex(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_10base_t(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_link_partner_ability_selector_field(lan8720_handle_t *handle, uint8_t *selector);

uint8_t lan8720_get_auto_negotiation_expansion_parallel_detection_fault(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_expansion_link_partner_next_page_able(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_expansion_next_page_able(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_expansion_page_received(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_expansion_link_partner_auto_negotiation_able(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_energy_detect_power_down_mode(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_energy_detect_power_down_mode(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_far_loop_back(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_far_loop_back(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_alternate_interrupt_mode(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_alternate_interrupt_mode(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_energy_detected(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_mode(lan8720_handle_t *handle, lan8720_mode_t mode);

uint8_t lan8720_get_mode(lan8720_handle_t *handle, lan8720_mode_t *mode);

uint8_t lan8720_set_phy_address(lan8720_handle_t *handle, uint8_t addr);

uint8_t lan8720_get_phy_address(lan8720_handle_t *handle, uint8_t *addr);

uint8_t lan8720_get_symbol_error_counter(lan8720_handle_t *handle, uint16_t *cnt);

uint8_t lan8720_set_auto_mdix(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_auto_mdix(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_manual_channel_select(lan8720_handle_t *handle, lan8720_manual_channel_select_t select);

uint8_t lan8720_get_manual_channel_select(lan8720_handle_t *handle, lan8720_manual_channel_select_t *select);

uint8_t lan8720_set_sqe_test_off(lan8720_handle_t *handle, lan8720_bool_t enable);

uint8_t lan8720_get_sqe_test_off(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_set_polarity(lan8720_handle_t *handle, lan8720_polarity_t polarity);

uint8_t lan8720_get_polarity(lan8720_handle_t *handle, lan8720_polarity_t *polarity);

uint8_t lan8720_get_interrupt_flag(lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t *enable);

uint8_t lan8720_set_interrupt_mask(lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t enable);

uint8_t lan8720_get_interrupt_mask(lan8720_handle_t *handle, lan8720_interrupt_t interrupt, lan8720_bool_t *enable);

uint8_t lan8720_get_auto_negotiation_done(lan8720_handle_t *handle, lan8720_bool_t *enable);

uint8_t lan8720_get_speed_indication(lan8720_handle_t *handle, lan8720_speed_indication_t *speed);



uint8_t lan8720_set_reg(lan8720_handle_t *handle, uint8_t reg, uint16_t value);

uint8_t lan8720_get_reg(lan8720_handle_t *handle, uint8_t reg, uint16_t *value);


 
#ifdef __cplusplus
}
#endif
 
#endif