no-OS
Macros | Enumerations | Functions | Variables
axi_jesd204_rx.c File Reference

Driver for the Analog Devices AXI-JESD204-RX peripheral. More...

#include <stdlib.h>
#include <stdio.h>
#include <inttypes.h>
#include "no_os_error.h"
#include "no_os_delay.h"
#include "no_os_util.h"
#include "axi_jesd204_rx.h"
#include "no_os_axi_io.h"
Include dependency graph for axi_jesd204_rx.c:

Macros

#define JESD204_RX_REG_VERSION   0x00
 
#define JESD204_RX_REG_MAGIC   0x0c
 
#define JESD204_RX_REG_SYNTH_NUM_LANES   0x10
 
#define JESD204_RX_REG_SYNTH_DATA_PATH_WIDTH   0x14
 
#define JESD204_RX_REG_SYNTH_REG_1   0x18
 
#define JESD204_RX_ENCODER_MASK   NO_OS_GENMASK(9, 8)
 
#define JESD204_RX_ENCODER_GET(x)   no_os_field_get(JESD204_RX_ENCODER_MASK, x)
 
#define JESD204_RX_REG_LINK_DISABLE   0xc0
 
#define JESD204_RX_REG_LINK_STATE   0xc4
 
#define JESD204_RX_REG_LINK_CLK_RATIO   0xc8
 
#define JESD204_RX_REG_SYSREF_CONF   0x100
 
#define JESD204_RX_REG_SYSREF_CONF_SYSREF_DISABLE   NO_OS_BIT(0)
 
#define JESD204_RX_REG_SYSREF_STATUS   0x108
 
#define JESD204_RX_REG_LINK_CONF0   0x210
 
#define JESD204_RX_REG_LINK_CONF4   0x21C
 
#define JESD204_RX_REG_LINK_CONF2   0x240
 
#define JESD204_RX_LINK_CONF2_BUFFER_EARLY_RELEASE   NO_OS_BIT(16)
 
#define JESD204_RX_REG_LINK_STATUS   0x280
 
#define JESD204_RX_REG_LANE_STATUS(x)   (((x) * 32) + 0x300)
 
#define JESD204_EMB_STATE_MASK   NO_OS_GENMASK(10, 8)
 
#define JESD204_EMB_STATE_GET(x)   no_os_field_get(JESD204_EMB_STATE_MASK, x)
 
#define JESD204_RX_REG_LANE_LATENCY(x)   (((x) * 32) + 0x304)
 
#define JESD204_RX_REG_LANE_ERRORS(x)   (((x) * 32) + 0x308)
 
#define JESD204_RX_REG_ILAS(x, y)   (((x) * 32 + (y) * 4) + 0x310)
 
#define JESD204_TX_REG_ILAS(x, y)   (((x) * 32 + (y) * 4) + 0x310)
 
#define JESD204_RX_MAGIC   (('2' << 24) | ('0' << 16) | ('4' << 8) | ('R'))
 
#define JESD204_SYNTH_DATA_PATH_WIDTH_MASK   NO_OS_GENMASK(7, 0)
 
#define JESD204_SYNTH_DATA_PATH_WIDTH_GET(x)   no_os_field_get(JESD204_SYNTH_DATA_PATH_WIDTH_MASK, x)
 
#define JESD204_TPL_DATA_PATH_WIDTH_MASK   NO_OS_GENMASK(15, 8)
 
#define JESD204_TPL_DATA_PATH_WIDTH_GET(x)   no_os_field_get(JESD204_TPL_DATA_PATH_WIDTH_MASK, x)
 
#define ADI_AXI_PCORE_VER(major, minor, patch)   (((major) << 16) | ((minor) << 8) | (patch))
 
#define PCORE_VERSION_MAJOR(x)   ((x) >> 16)
 
#define PCORE_VERSION_MINOR(x)   (((x) >> 8) & 0xff)
 
#define PCORE_VERSION_PATCH(x)   ((x) & 0xff)
 

Enumerations

enum  {
  JESD204_EMB_STATE_INIT = 1,
  JESD204_EMB_STATE_HUNT,
  JESD204_EMB_STATE_LOCK = 4
}
 

Functions

int32_t axi_jesd204_rx_write (struct axi_jesd204_rx *jesd, uint32_t reg_addr, uint32_t reg_val)
 JESD204 RX AXI Data Write. More...
 
int32_t axi_jesd204_rx_read (struct axi_jesd204_rx *jesd, uint32_t reg_addr, uint32_t *reg_val)
 JESD204 RX AXI Data Read. More...
 
int32_t axi_jesd204_rx_lane_clk_enable (struct axi_jesd204_rx *jesd)
 JESD204 RX Lane Clock Enable. More...
 
int32_t axi_jesd204_rx_lane_clk_disable (struct axi_jesd204_rx *jesd)
 JESD204 RX Lane Clock Disable. More...
 
uint32_t axi_jesd204_rx_status_read (struct axi_jesd204_rx *jesd)
 Read status of the JESD204 Receive Peripherial. More...
 
int32_t axi_jesd204_rx_get_lane_errors (struct axi_jesd204_rx *jesd, uint32_t lane, uint32_t *errors)
 Read the JESD204 RX Lane Errors. More...
 
int32_t axi_jesd204_rx_laneinfo_read (struct axi_jesd204_rx *jesd, uint32_t lane)
 Read JESD204 RX Lane Info. More...
 
bool axi_jesd204_rx_check_lane_status (struct axi_jesd204_rx *jesd, uint32_t lane)
 Check JESD204 RX Lane Status. More...
 
int32_t axi_jesd204_rx_watchdog (struct axi_jesd204_rx *jesd)
 JESD204 RX Watchdog. More...
 
int32_t axi_jesd204_rx_apply_config (struct axi_jesd204_rx *jesd, struct jesd204_rx_config *config)
 Apply the JESD204 RX configuration. More...
 
int32_t axi_jesd204_rx_init (struct axi_jesd204_rx **jesd204, const struct jesd204_rx_init *init)
 Device initialization. More...
 
int32_t axi_jesd204_rx_remove (struct axi_jesd204_rx *jesd)
 Free resoulces allocated for JESD204 RX peripheral. More...
 

Variables

const char * axi_jesd204_rx_link_status_label []
 
const char * axi_jesd204_rx_lane_status_label []
 
const char * axi_jesd204_rx_link_status_64b66b_l []
 
const char * axi_jesd204_rx_emb_state_label []
 

Detailed Description

Driver for the Analog Devices AXI-JESD204-RX peripheral.

Author
DBogdan (drago.nosp@m.s.bo.nosp@m.gdan@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2018(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ ADI_AXI_PCORE_VER

#define ADI_AXI_PCORE_VER (   major,
  minor,
  patch 
)    (((major) << 16) | ((minor) << 8) | (patch))

◆ JESD204_EMB_STATE_GET

#define JESD204_EMB_STATE_GET (   x)    no_os_field_get(JESD204_EMB_STATE_MASK, x)

◆ JESD204_EMB_STATE_MASK

#define JESD204_EMB_STATE_MASK   NO_OS_GENMASK(10, 8)

◆ JESD204_RX_ENCODER_GET

#define JESD204_RX_ENCODER_GET (   x)    no_os_field_get(JESD204_RX_ENCODER_MASK, x)

◆ JESD204_RX_ENCODER_MASK

#define JESD204_RX_ENCODER_MASK   NO_OS_GENMASK(9, 8)

◆ JESD204_RX_LINK_CONF2_BUFFER_EARLY_RELEASE

#define JESD204_RX_LINK_CONF2_BUFFER_EARLY_RELEASE   NO_OS_BIT(16)

◆ JESD204_RX_MAGIC

#define JESD204_RX_MAGIC   (('2' << 24) | ('0' << 16) | ('4' << 8) | ('R'))

◆ JESD204_RX_REG_ILAS

#define JESD204_RX_REG_ILAS (   x,
 
)    (((x) * 32 + (y) * 4) + 0x310)

◆ JESD204_RX_REG_LANE_ERRORS

#define JESD204_RX_REG_LANE_ERRORS (   x)    (((x) * 32) + 0x308)

◆ JESD204_RX_REG_LANE_LATENCY

#define JESD204_RX_REG_LANE_LATENCY (   x)    (((x) * 32) + 0x304)

◆ JESD204_RX_REG_LANE_STATUS

#define JESD204_RX_REG_LANE_STATUS (   x)    (((x) * 32) + 0x300)

◆ JESD204_RX_REG_LINK_CLK_RATIO

#define JESD204_RX_REG_LINK_CLK_RATIO   0xc8

◆ JESD204_RX_REG_LINK_CONF0

#define JESD204_RX_REG_LINK_CONF0   0x210

◆ JESD204_RX_REG_LINK_CONF2

#define JESD204_RX_REG_LINK_CONF2   0x240

◆ JESD204_RX_REG_LINK_CONF4

#define JESD204_RX_REG_LINK_CONF4   0x21C

◆ JESD204_RX_REG_LINK_DISABLE

#define JESD204_RX_REG_LINK_DISABLE   0xc0

◆ JESD204_RX_REG_LINK_STATE

#define JESD204_RX_REG_LINK_STATE   0xc4

◆ JESD204_RX_REG_LINK_STATUS

#define JESD204_RX_REG_LINK_STATUS   0x280

◆ JESD204_RX_REG_MAGIC

#define JESD204_RX_REG_MAGIC   0x0c

◆ JESD204_RX_REG_SYNTH_DATA_PATH_WIDTH

#define JESD204_RX_REG_SYNTH_DATA_PATH_WIDTH   0x14

◆ JESD204_RX_REG_SYNTH_NUM_LANES

#define JESD204_RX_REG_SYNTH_NUM_LANES   0x10

◆ JESD204_RX_REG_SYNTH_REG_1

#define JESD204_RX_REG_SYNTH_REG_1   0x18

◆ JESD204_RX_REG_SYSREF_CONF

#define JESD204_RX_REG_SYSREF_CONF   0x100

◆ JESD204_RX_REG_SYSREF_CONF_SYSREF_DISABLE

#define JESD204_RX_REG_SYSREF_CONF_SYSREF_DISABLE   NO_OS_BIT(0)

◆ JESD204_RX_REG_SYSREF_STATUS

#define JESD204_RX_REG_SYSREF_STATUS   0x108

◆ JESD204_RX_REG_VERSION

#define JESD204_RX_REG_VERSION   0x00

◆ JESD204_SYNTH_DATA_PATH_WIDTH_GET

#define JESD204_SYNTH_DATA_PATH_WIDTH_GET (   x)    no_os_field_get(JESD204_SYNTH_DATA_PATH_WIDTH_MASK, x)

◆ JESD204_SYNTH_DATA_PATH_WIDTH_MASK

#define JESD204_SYNTH_DATA_PATH_WIDTH_MASK   NO_OS_GENMASK(7, 0)

◆ JESD204_TPL_DATA_PATH_WIDTH_GET

#define JESD204_TPL_DATA_PATH_WIDTH_GET (   x)    no_os_field_get(JESD204_TPL_DATA_PATH_WIDTH_MASK, x)

◆ JESD204_TPL_DATA_PATH_WIDTH_MASK

#define JESD204_TPL_DATA_PATH_WIDTH_MASK   NO_OS_GENMASK(15, 8)

◆ JESD204_TX_REG_ILAS

#define JESD204_TX_REG_ILAS (   x,
 
)    (((x) * 32 + (y) * 4) + 0x310)

◆ PCORE_VERSION_MAJOR

#define PCORE_VERSION_MAJOR (   x)    ((x) >> 16)

◆ PCORE_VERSION_MINOR

#define PCORE_VERSION_MINOR (   x)    (((x) >> 8) & 0xff)

◆ PCORE_VERSION_PATCH

#define PCORE_VERSION_PATCH (   x)    ((x) & 0xff)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
JESD204_EMB_STATE_INIT 
JESD204_EMB_STATE_HUNT 
JESD204_EMB_STATE_LOCK 

Function Documentation

◆ axi_jesd204_rx_apply_config()

int32_t axi_jesd204_rx_apply_config ( struct axi_jesd204_rx jesd,
struct jesd204_rx_config config 
)

Apply the JESD204 RX configuration.

Parameters
jesd- The device structure.
config- The JESD RX configuration.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_check_lane_status()

bool axi_jesd204_rx_check_lane_status ( struct axi_jesd204_rx jesd,
uint32_t  lane 
)

Check JESD204 RX Lane Status.

Parameters
jesd- The device structure.
lane- Lane ID.
Returns
Returns 0 in case of success or positive value otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_get_lane_errors()

int32_t axi_jesd204_rx_get_lane_errors ( struct axi_jesd204_rx jesd,
uint32_t  lane,
uint32_t *  errors 
)

Read the JESD204 RX Lane Errors.

Parameters
jesd- The JESD204 RX Device Structure.
lane- The lane ID.
errors- The errors read from the device.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_init()

int32_t axi_jesd204_rx_init ( struct axi_jesd204_rx **  jesd204,
const struct jesd204_rx_init init 
)

Device initialization.

Parameters
jesd204- The device structure.
init- The structure containing the device initial parameters.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_lane_clk_disable()

int32_t axi_jesd204_rx_lane_clk_disable ( struct axi_jesd204_rx jesd)

JESD204 RX Lane Clock Disable.

Parameters
jesd- The device structure.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_lane_clk_enable()

int32_t axi_jesd204_rx_lane_clk_enable ( struct axi_jesd204_rx jesd)

JESD204 RX Lane Clock Enable.

Parameters
jesd- The device structure.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_laneinfo_read()

int32_t axi_jesd204_rx_laneinfo_read ( struct axi_jesd204_rx jesd,
uint32_t  lane 
)

Read JESD204 RX Lane Info.

Parameters
jesd- The device structure.
lane- Lane ID.
Returns
Returns 0 in case of success or negative error code otherwise.

◆ axi_jesd204_rx_read()

int32_t axi_jesd204_rx_read ( struct axi_jesd204_rx jesd,
uint32_t  reg_addr,
uint32_t *  reg_val 
)

JESD204 RX AXI Data Read.

Parameters
jesd- The device structure.
reg_addr- The register address.
reg_val- Data read from the device.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_remove()

int32_t axi_jesd204_rx_remove ( struct axi_jesd204_rx jesd)

Free resoulces allocated for JESD204 RX peripheral.

Parameters
jesd- The device structure.
Returns
Returns 0 in case of success or negative error code.
Here is the caller graph for this function:

◆ axi_jesd204_rx_status_read()

uint32_t axi_jesd204_rx_status_read ( struct axi_jesd204_rx jesd)

Read status of the JESD204 Receive Peripherial.

Parameters
jesd- The device structure.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_watchdog()

int32_t axi_jesd204_rx_watchdog ( struct axi_jesd204_rx jesd)

JESD204 RX Watchdog.

Parameters
jesd- The device structure.
Returns
Returns 0 in case of success or positive value otherwise.
Here is the caller graph for this function:

◆ axi_jesd204_rx_write()

int32_t axi_jesd204_rx_write ( struct axi_jesd204_rx jesd,
uint32_t  reg_addr,
uint32_t  reg_val 
)

JESD204 RX AXI Data Write.

Parameters
jesd- The device structure.
reg_addr- The register address.
reg_val- Data value to write.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

Variable Documentation

◆ axi_jesd204_rx_emb_state_label

const char* axi_jesd204_rx_emb_state_label[]
Initial value:
= {
"INVALID",
"EMB_INIT",
"EMB_HUNT",
"INVALID",
"EMB_LOCK",
"INVALID",
"INVALID",
"INVALID",
}

◆ axi_jesd204_rx_lane_status_label

const char* axi_jesd204_rx_lane_status_label[]
Initial value:
= {
"INIT",
"CHECK",
"DATA",
"UNKNOWN",
}

◆ axi_jesd204_rx_link_status_64b66b_l

const char* axi_jesd204_rx_link_status_64b66b_l[]
Initial value:
= {
"RESET",
"WAIT_BS",
"BLOCK_SYNC",
"DATA",
}

◆ axi_jesd204_rx_link_status_label

const char* axi_jesd204_rx_link_status_label[]
Initial value:
= {
"RESET",
"WAIT FOR PHY",
"CGS",
"DATA",
}