ra8_ether_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_ether_phy_speed_no_link = 0U, 
  k_ra8_ether_phy_speed_10h     = 1U, 
  k_ra8_ether_phy_speed_10f     = 2U, 
  k_ra8_ether_phy_speed_100h    = 3U, 
  k_ra8_ether_phy_speed_100f    = 4U, 
  k_ra8_ether_phy_speed_1000h   = 5U, 
  k_ra8_ether_phy_speed_1000f   = 6U, 
} ra8_ether_phy_speed_t;

typedef enum : uint8_t {
  k_ra8_ether_phy_mii   = 0U, 
  k_ra8_ether_phy_rmii  = 1U, 
  k_ra8_ether_phy_gmii  = 2U, 
  k_ra8_ether_phy_rgmii = 3U, 
} ra8_ether_phy_mii_t;

typedef enum : uint8_t {
  k_ra8_ether_phy_reg_control    = 0U, 
  k_ra8_ether_phy_reg_status     = 1U, 
  k_ra8_ether_phy_reg_id_low     = 2U, 
  k_ra8_ether_phy_reg_id_high    = 3U, 
  k_ra8_ether_phy_reg_an_advert  = 4U, 
  k_ra8_ether_phy_reg_an_partner = 5U, 
  k_ra8_ether_phy_reg_an_expand  = 6U, 
} ra8_ether_phy_clause22_reg_t;

typedef enum : uint8_t {
  k_ra8_ether_phy_addr_max = 31U, 
} ra8_ether_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_ether_phy_io_t;

typedef struct {
  uint8_t               link_up;       
  uint8_t               auto_neg_done; 
  ra8_ether_phy_speed_t speed;         
  uint16_t              bmsr;          
} ra8_ether_phy_link_t;

typedef struct {
  ra8_ether_phy_io_t  io;            
  uint8_t             phy_address;   
  ra8_ether_phy_mii_t mii_type;      
  uint16_t            reset_wait_us; 
} ra8_ether_phy_cfg_t;

[[nodiscard]] ra8_err_t ra8_ether_phy_open(const ra8_ether_phy_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_ether_phy_close(void);

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

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

[[nodiscard]] ra8_err_t ra8_ether_phy_auto_negotiate_start(void);

[[nodiscard]] ra8_err_t ra8_ether_phy_link_status_get(ra8_ether_phy_link_t* out);
 
#ifdef __cplusplus
}
#endif