ra8_rmac_phy.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_ra8_rmac_phy_lsi_default    = 0U, 
  k_ra8_rmac_phy_lsi_ksz8091rnb = 1U, 
  k_ra8_rmac_phy_lsi_ksz8041    = 2U, 
  k_ra8_rmac_phy_lsi_dp83620    = 3U, 
  k_ra8_rmac_phy_lsi_ics1894    = 4U, 
  k_ra8_rmac_phy_lsi_gpy111     = 5U, 
  k_ra8_rmac_phy_lsi_vsc8541    = 6U, 
  k_ra8_rmac_phy_lsi_custom     = 7U, 
  k_ra8_rmac_phy_lsi_count      = 8U, 
} ra8_rmac_phy_lsi_t;

typedef enum : uint8_t {
  k_ra8_rmac_phy_speed_no_link = 0U, 
  k_ra8_rmac_phy_speed_10h     = 1U, 
  k_ra8_rmac_phy_speed_10f     = 2U, 
  k_ra8_rmac_phy_speed_100h    = 3U, 
  k_ra8_rmac_phy_speed_100f    = 4U, 
  k_ra8_rmac_phy_speed_1000h   = 5U, 
  k_ra8_rmac_phy_speed_1000f   = 6U, 
} ra8_rmac_phy_speed_t;

typedef enum : uint8_t {
  k_ra8_rmac_phy_addr_max = 31U, 
  k_ra8_rmac_phy_reg_max  = 31U, 
} ra8_rmac_phy_addr_limit_t;

typedef struct {
  ra8_err_t (*read)(void*     ctx,
                    uint8_t   phy_addr,
                    uint8_t   reg_addr,
                    uint16_t* out_data);                                            
  ra8_err_t (*write)(void* ctx, uint8_t phy_addr, uint8_t reg_addr, uint16_t data); 
  void* ctx;                                                                        
} ra8_rmac_phy_io_t;

typedef struct {
  uint8_t              link_up;         
  uint8_t              auto_neg_done;   
  ra8_rmac_phy_speed_t speed;           
  uint16_t             bmsr;            
  uint16_t             partner_ability; 
} ra8_rmac_phy_link_t;

typedef struct {
  ra8_rmac_phy_io_t  io;              
  ra8_rmac_phy_lsi_t lsi_type;        
  uint8_t            phy_address;     
  uint16_t           reset_poll_max;  
  uint16_t           local_advertise; 
  uint16_t           gbit_advertise;  
} ra8_rmac_phy_cfg_t;

[[nodiscard]] ra8_err_t ra8_rmac_phy_open(const ra8_rmac_phy_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_rmac_phy_close(void);

[[nodiscard]] ra8_err_t ra8_rmac_phy_mdio_read(uint8_t reg_addr, uint16_t* out_data);

[[nodiscard]] ra8_err_t ra8_rmac_phy_mdio_write(uint8_t reg_addr, uint16_t data);

[[nodiscard]] ra8_err_t ra8_rmac_phy_auto_negotiate_start(void);

[[nodiscard]] ra8_err_t ra8_rmac_phy_link_status_get(ra8_rmac_phy_link_t* out);

[[nodiscard]] ra8_err_t ra8_rmac_phy_lsi_get(ra8_rmac_phy_lsi_t* out);
 
#ifdef __cplusplus
}
#endif