ra8_eth_gptp.h

Go to the documentation of this file.

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

typedef enum : uint32_t {
  k_ra8_gptp_ns_per_sec = 1000000000UL, 
  k_ra8_gptp_nsec_max   = 999999999UL,  
} ra8_eth_gptp_limit_t;

typedef enum : uint64_t {
  k_ra8_gptp_sec_max = 0xFFFFFFFFFFFFULL, 
} ra8_eth_gptp_sec_limit_t;

typedef struct {
  uint32_t clk_hz; 
} ra8_eth_gptp_cfg_t;

[[nodiscard]] ra8_err_t ra8_eth_gptp_init(const ra8_eth_gptp_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_eth_gptp_deinit(void);

[[nodiscard]] ra8_err_t ra8_eth_gptp_ip_version(uint32_t* out_version);

[[nodiscard]] ra8_err_t ra8_eth_gptp_tiv_from_hz(uint32_t clk_hz, uint32_t* out_tiv);

[[nodiscard]] ra8_err_t ra8_eth_gptp_timer_enable(ra8_gptp_timer_idx_t timer);

[[nodiscard]] ra8_err_t ra8_eth_gptp_timer_disable(ra8_gptp_timer_idx_t timer);

[[nodiscard]] ra8_err_t ra8_eth_gptp_timer_is_enabled(ra8_gptp_timer_idx_t timer,
                                                      bool*                out_enabled);

[[nodiscard]] ra8_err_t ra8_eth_gptp_set_increment(ra8_gptp_timer_idx_t timer, uint32_t tiv);

[[nodiscard]] ra8_err_t ra8_eth_gptp_get_increment(ra8_gptp_timer_idx_t timer, uint32_t* out_tiv);

[[nodiscard]] ra8_err_t
ra8_eth_gptp_set_offset(ra8_gptp_timer_idx_t timer, uint64_t sec, uint32_t nsec);

[[nodiscard]] ra8_err_t
ra8_eth_gptp_get_time(ra8_gptp_timer_idx_t timer, uint64_t* out_sec, uint32_t* out_nsec);

[[nodiscard]] ra8_err_t ra8_eth_gptp_get_avtp_ns(ra8_gptp_timer_idx_t timer, uint64_t* out_ns);

[[nodiscard]] ra8_err_t ra8_eth_gptp_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_eth_gptp_exit_stop(void);
 
#ifdef __cplusplus
}
#endif