axi_jesd204_rx.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef AXI_JESD204_RX_H_
#define AXI_JESD204_RX_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
struct jesd204_rx_config {
    uint8_t octets_per_frame;
    uint16_t frames_per_multiframe;
    uint8_t subclass_version;
};
 
/* JESD204 Supported encoding scheme */
enum jesd204_rx_encoder {
    JESD204_RX_ENCODER_UNKNOWN,
    JESD204_RX_ENCODER_8B10B,
    JESD204_RX_ENCODER_64B66B,
    JESD204_RX_ENCODER_MAX,
};
 
struct axi_jesd204_rx {
    const char *name;
    uint32_t base;
    uint32_t version;
    /* Number of lanes of the peripheral */
    uint32_t num_lanes;
    uint32_t data_path_width;
    uint32_t tpl_data_path_width;
    struct jesd204_rx_config config;
    uint32_t device_clk_khz;
    uint32_t lane_clk_khz;
    enum jesd204_rx_encoder encoder;
};
 
struct jesd204_rx_init {
    const char *name;
    uint32_t base;
    uint8_t octets_per_frame;
    uint16_t frames_per_multiframe;
    uint8_t subclass;
    uint32_t device_clk_khz;
    uint32_t lane_clk_khz;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
int32_t axi_jesd204_rx_lane_clk_enable(struct axi_jesd204_rx *jesd);
int32_t axi_jesd204_rx_lane_clk_disable(struct axi_jesd204_rx *jesd);
uint32_t axi_jesd204_rx_status_read(struct axi_jesd204_rx *jesd);
int32_t axi_jesd204_rx_laneinfo_read(struct axi_jesd204_rx *jesd,
                     uint32_t lane);
int32_t axi_jesd204_rx_watchdog(struct axi_jesd204_rx *jesd);
int32_t axi_jesd204_rx_init(struct axi_jesd204_rx **jesd204,
                const struct jesd204_rx_init *init);
int32_t axi_jesd204_rx_remove(struct axi_jesd204_rx *jesd);
#endif