axi_jesd204_rx.h File Reference

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

#include <stdint.h>
#include <stdbool.h>
#include "jesd204.h"
#include "no_os_clk.h"
#include "no_os_gpio.h"

Include dependency graph for axi_jesd204_rx.h:

Classes
struct	jesd204_rx_config
struct	axi_jesd204_rx
struct	jesd204_rx_init
	JESD204B/C Receive Peripheral Initialization Structure. More...

Functions
int32_t	axi_jesd204_rx_lane_clk_enable (struct axi_jesd204_rx *jesd)
	JESD204 RX Lane Clock Enable.
int32_t	axi_jesd204_rx_lane_clk_disable (struct axi_jesd204_rx *jesd)
	JESD204 RX Lane Clock Disable.
uint32_t	axi_jesd204_rx_status_read (struct axi_jesd204_rx *jesd)
	Read status of the JESD204 Receive Peripherial.
int32_t	axi_jesd204_rx_laneinfo_read (struct axi_jesd204_rx *jesd, uint32_t lane)
	Read JESD204 RX Lane Info.
int32_t	axi_jesd204_rx_watchdog (struct axi_jesd204_rx *jesd)
	JESD204 RX Watchdog.
int32_t	axi_jesd204_rx_init_legacy (struct axi_jesd204_rx **jesd204, const struct jesd204_rx_init *init)
	Device initialization.
int32_t	axi_jesd204_rx_init (struct axi_jesd204_rx **jesd204, const struct jesd204_rx_init *init)
	Device initialization, JESD FSM ON.
int32_t	axi_jesd204_rx_remove (struct axi_jesd204_rx *jesd)
	Free resoulces allocated for JESD204 RX peripheral.

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.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

axi_jesd204_rx_init()

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

Device initialization, JESD FSM ON.

Device initialization, JESD FSM ON

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.

axi_jesd204_rx_init_legacy()

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

Device initialization.

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.

axi_jesd204_rx_lane_clk_disable()

int32_t axi_jesd204_rx_lane_clk_disable

(

struct axi_jesd204_rx *

jesd

)

JESD204 RX Lane Clock Disable.

JESD204 RX Lane Clock Disable

Parameters

jesd	- The device structure.

Returns

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

axi_jesd204_rx_lane_clk_enable()

int32_t axi_jesd204_rx_lane_clk_enable

(

struct axi_jesd204_rx *

jesd

)

JESD204 RX Lane Clock Enable.

JESD204 RX Lane Clock Enable

Parameters

jesd	- The device structure.

Returns

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

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.

JESD204 RX Lane Info read

Parameters

jesd	- The device structure.
lane	- Lane ID.

Returns

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

axi_jesd204_rx_remove()

int32_t axi_jesd204_rx_remove

(

struct axi_jesd204_rx *

jesd

)

Free resoulces allocated for JESD204 RX peripheral.

Resources Deallocation

Parameters

jesd	- The device structure.

Returns

Returns 0 in case of success or negative error code.

axi_jesd204_rx_status_read()

uint32_t axi_jesd204_rx_status_read

(

struct axi_jesd204_rx *

jesd

)

Read status of the JESD204 Receive Peripherial.

JESD204 RX Status Read

Parameters

jesd	- The device structure.

Returns

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

axi_jesd204_rx_watchdog()

int32_t axi_jesd204_rx_watchdog

(

struct axi_jesd204_rx *

jesd

)

JESD204 RX Watchdog.

JESD204 RX Watchdog

Parameters

jesd	- The device structure.

Returns

Returns 0 in case of success or positive value otherwise.