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

#include <stdlib.h>
#include <stdio.h>
#include <inttypes.h>
#include "no_os_clk.h"
#include "no_os_error.h"
#include "no_os_util.h"
#include "no_os_alloc.h"
#include "axi_jesd204_tx.h"
#include "no_os_axi_io.h"
#include "no_os_delay.h"
#include "no_os_print_log.h"

Include dependency graph for axi_jesd204_tx.c:

Classes
struct	axi_jesd204_tx_jesd204_priv

Macros
#define	JESD204_TX_REG_VERSION 0x00

#define	JESD204_TX_REG_MAGIC 0x0c

#define	JESD204_TX_REG_CONF_NUM_LANES 0x10

#define	JESD204_TX_REG_CONF_DATA_PATH_WIDTH 0x14

#define	JESD204_TX_REG_SYNTH_REG_1 0x18

#define	JESD204_TX_ENCODER_MASK NO_OS_GENMASK(9, 8)

#define	JESD204_TX_ENCODER_GET(x) no_os_field_get(JESD204_TX_ENCODER_MASK, x)

#define	JESD204_TX_REG_LINK_DISABLE 0xc0

#define	JESD204_TX_REG_LINK_STATE 0xc4

#define	JESD204_TX_REG_LINK_CLK_RATIO 0xc8

#define	JESD204_TX_REG_SYSREF_CONF 0x100

#define	JESD204_TX_REG_SYSREF_CONF_SYSREF_DISABLE NO_OS_BIT(0)

#define	JESD204_TX_REG_SYSREF_LMFC_OFFSET 0x104

#define	JESD204_TX_REG_SYSREF_STATUS 0x108

#define	JESD204_TX_REG_CONF0 0x210

#define	JESD204_TX_REG_LINK_CONF4 0x21C

#define	JESD204_TX_REG_LINK_STATUS 0x280

#define	JESD204_LINK_STATUS_DATA 3

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

#define	JESD204_TX_MAGIC (('2' << 24) \| ('0' << 16) \| ('4' << 8) \| ('T'))

#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)

Functions
int32_t	axi_jesd204_tx_write (struct axi_jesd204_tx *jesd, uint32_t reg_addr, uint32_t reg_val)
	JESD204 TX AXI Data Write. More...

int32_t	axi_jesd204_tx_read (struct axi_jesd204_tx jesd, uint32_t reg_addr, uint32_t reg_val)
	JESD204 TX AXI Data Read. More...

int32_t	axi_jesd204_tx_lane_clk_enable (struct axi_jesd204_tx *jesd)
	JESD204 TX Lane Clock Enable. More...

int32_t	axi_jesd204_tx_lane_clk_disable (struct axi_jesd204_tx *jesd)
	JESD204 TX Lane Clock Disable. More...

uint32_t	axi_jesd204_tx_status_read (struct axi_jesd204_tx *jesd)
	Read status of the JESD204 Transmit Peripherial. More...

uint32_t	axi_jesd204_tx_calc_ilas_chksum_legacy (const struct jesd204_tx_config *config)
	Compute the JESD204 TX ILAS checksum. More...

void	axi_jesd204_tx_set_lane_ilas_legacy (struct axi_jesd204_tx jesd, struct jesd204_tx_config config, uint32_t lane)
	Set the JESD204 TX lane ILAS. More...

int32_t	axi_jesd204_tx_apply_config (struct axi_jesd204_tx jesd, struct jesd204_link config)
	Apply the JESD204 TX configuration. More...

int32_t	axi_jesd204_tx_apply_config_legacy (struct axi_jesd204_tx jesd, struct jesd204_tx_config config)
	Apply the JESD204 TX configuration. More...

int32_t	axi_jesd204_tx_init_legacy (struct axi_jesd204_tx *jesd204, const struct jesd204_tx_init init)
	Device initialization. More...

int32_t	axi_jesd204_tx_init (struct axi_jesd204_tx *jesd204, const struct jesd204_tx_init init)
	Device initialization. More...

int32_t	axi_jesd204_tx_remove (struct axi_jesd204_tx *jesd)
	Free resoulces allocated for JESD204 TX peripheral. More...

Variables
const char *	axi_jesd204_tx_link_status_label []

Detailed Description

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

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

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

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

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_LINK_STATUS_DATA

#define JESD204_LINK_STATUS_DATA 3

◆ 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_ENCODER_GET

#define JESD204_TX_ENCODER_GET ( x ) no_os_field_get(JESD204_TX_ENCODER_MASK, x)

◆ JESD204_TX_ENCODER_MASK

#define JESD204_TX_ENCODER_MASK NO_OS_GENMASK(9, 8)

◆ JESD204_TX_MAGIC

#define JESD204_TX_MAGIC (('2' << 24) | ('0' << 16) | ('4' << 8) | ('T'))

◆ JESD204_TX_REG_CONF0

#define JESD204_TX_REG_CONF0 0x210

◆ JESD204_TX_REG_CONF_DATA_PATH_WIDTH

#define JESD204_TX_REG_CONF_DATA_PATH_WIDTH 0x14

◆ JESD204_TX_REG_CONF_NUM_LANES

#define JESD204_TX_REG_CONF_NUM_LANES 0x10

◆ JESD204_TX_REG_ILAS

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

◆ JESD204_TX_REG_LINK_CLK_RATIO

#define JESD204_TX_REG_LINK_CLK_RATIO 0xc8

◆ JESD204_TX_REG_LINK_CONF4

#define JESD204_TX_REG_LINK_CONF4 0x21C

◆ JESD204_TX_REG_LINK_DISABLE

#define JESD204_TX_REG_LINK_DISABLE 0xc0

◆ JESD204_TX_REG_LINK_STATE

#define JESD204_TX_REG_LINK_STATE 0xc4

◆ JESD204_TX_REG_LINK_STATUS

#define JESD204_TX_REG_LINK_STATUS 0x280

◆ JESD204_TX_REG_MAGIC

#define JESD204_TX_REG_MAGIC 0x0c

◆ JESD204_TX_REG_SYNTH_REG_1

#define JESD204_TX_REG_SYNTH_REG_1 0x18

◆ JESD204_TX_REG_SYSREF_CONF

#define JESD204_TX_REG_SYSREF_CONF 0x100

◆ JESD204_TX_REG_SYSREF_CONF_SYSREF_DISABLE

#define JESD204_TX_REG_SYSREF_CONF_SYSREF_DISABLE NO_OS_BIT(0)

◆ JESD204_TX_REG_SYSREF_LMFC_OFFSET

#define JESD204_TX_REG_SYSREF_LMFC_OFFSET 0x104

◆ JESD204_TX_REG_SYSREF_STATUS

#define JESD204_TX_REG_SYSREF_STATUS 0x108

◆ JESD204_TX_REG_VERSION

#define JESD204_TX_REG_VERSION 0x00

◆ 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)

Function Documentation

◆ axi_jesd204_tx_apply_config()

int32_t axi_jesd204_tx_apply_config	(	struct axi_jesd204_tx *	jesd,
		struct jesd204_link *	config
	)

Apply the JESD204 TX configuration.

Parameters

jesd	- The device structure.
config	- The JESD TX configuration.

Returns: Returns 0 in case of success or negative error code otherwise.

◆ axi_jesd204_tx_apply_config_legacy()

int32_t axi_jesd204_tx_apply_config_legacy	(	struct axi_jesd204_tx *	jesd,
		struct jesd204_tx_config *	config
	)

Apply the JESD204 TX configuration.

Parameters

jesd	- The device structure.
config	- The JESD TX configuration.

Returns: Returns 0 in case of success or negative error code otherwise.

Here is the caller graph for this function:

◆ axi_jesd204_tx_calc_ilas_chksum_legacy()

uint32_t axi_jesd204_tx_calc_ilas_chksum_legacy ( const struct jesd204_tx_config * config )

Compute the JESD204 TX ILAS checksum.

Parameters

config - The JESD TX configuration

Returns: Returns 0 in case of success or negative error code otherwise.

Here is the caller graph for this function:

◆ axi_jesd204_tx_init()

int32_t axi_jesd204_tx_init	(	struct axi_jesd204_tx **	jesd204,
		const struct jesd204_tx_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_tx_init_legacy()

int32_t axi_jesd204_tx_init_legacy	(	struct axi_jesd204_tx **	jesd204,
		const struct jesd204_tx_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_tx_lane_clk_disable()

int32_t axi_jesd204_tx_lane_clk_disable ( struct axi_jesd204_tx * jesd )

JESD204 TX 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_tx_lane_clk_enable()

int32_t axi_jesd204_tx_lane_clk_enable ( struct axi_jesd204_tx * jesd )

JESD204 TX 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_tx_read()

int32_t axi_jesd204_tx_read	(	struct axi_jesd204_tx *	jesd,
		uint32_t	reg_addr,
		uint32_t *	reg_val
	)

JESD204 TX 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_tx_remove()

int32_t axi_jesd204_tx_remove ( struct axi_jesd204_tx * jesd )

Free resoulces allocated for JESD204 TX 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_tx_set_lane_ilas_legacy()

void axi_jesd204_tx_set_lane_ilas_legacy	(	struct axi_jesd204_tx *	jesd,
		struct jesd204_tx_config *	config,
		uint32_t	lane
	)

Set the JESD204 TX lane ILAS.

Parameters

jesd	- The device structure.
config	- The JESD TX configuration.
lane	- The lane ID.

Here is the caller graph for this function:

◆ axi_jesd204_tx_status_read()

uint32_t axi_jesd204_tx_status_read ( struct axi_jesd204_tx * jesd )

Read status of the JESD204 Transmit 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_tx_write()

int32_t axi_jesd204_tx_write	(	struct axi_jesd204_tx *	jesd,
		uint32_t	reg_addr,
		uint32_t	reg_val
	)

JESD204 TX 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_tx_link_status_label

const char* axi_jesd204_tx_link_status_label[]

Initial value:

= {
    "WAIT",
    "CGS",
    "ILAS",
    "DATA"
}

Classes

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ADI_AXI_PCORE_VER

◆ JESD204_LINK_STATUS_DATA

◆ JESD204_SYNTH_DATA_PATH_WIDTH_GET

◆ JESD204_SYNTH_DATA_PATH_WIDTH_MASK

◆ JESD204_TPL_DATA_PATH_WIDTH_GET

◆ JESD204_TPL_DATA_PATH_WIDTH_MASK

◆ JESD204_TX_ENCODER_GET

◆ JESD204_TX_ENCODER_MASK

◆ JESD204_TX_MAGIC

◆ JESD204_TX_REG_CONF0

◆ JESD204_TX_REG_CONF_DATA_PATH_WIDTH

◆ JESD204_TX_REG_CONF_NUM_LANES

◆ JESD204_TX_REG_ILAS

◆ JESD204_TX_REG_LINK_CLK_RATIO

◆ JESD204_TX_REG_LINK_CONF4

◆ JESD204_TX_REG_LINK_DISABLE

◆ JESD204_TX_REG_LINK_STATE

◆ JESD204_TX_REG_LINK_STATUS

◆ JESD204_TX_REG_MAGIC

◆ JESD204_TX_REG_SYNTH_REG_1

◆ JESD204_TX_REG_SYSREF_CONF

◆ JESD204_TX_REG_SYSREF_CONF_SYSREF_DISABLE

◆ JESD204_TX_REG_SYSREF_LMFC_OFFSET

◆ JESD204_TX_REG_SYSREF_STATUS

◆ JESD204_TX_REG_VERSION

◆ PCORE_VERSION_MAJOR

◆ PCORE_VERSION_MINOR

◆ PCORE_VERSION_PATCH

Function Documentation

◆ axi_jesd204_tx_apply_config()

◆ axi_jesd204_tx_apply_config_legacy()

◆ axi_jesd204_tx_calc_ilas_chksum_legacy()

◆ axi_jesd204_tx_init()

◆ axi_jesd204_tx_init_legacy()

◆ axi_jesd204_tx_lane_clk_disable()

◆ axi_jesd204_tx_lane_clk_enable()

◆ axi_jesd204_tx_read()

◆ axi_jesd204_tx_remove()

◆ axi_jesd204_tx_set_lane_ilas_legacy()

◆ axi_jesd204_tx_status_read()

◆ axi_jesd204_tx_write()

Variable Documentation

◆ axi_jesd204_tx_link_status_label