no-OS
Classes | Enumerations | Functions
axi_jesd204_rx.h File Reference

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

#include <stdint.h>
#include <stdbool.h>
Include dependency graph for axi_jesd204_rx.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

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

Enumerations

enum  jesd204_rx_encoder {
  JESD204_RX_ENCODER_UNKNOWN,
  JESD204_RX_ENCODER_8B10B,
  JESD204_RX_ENCODER_64B66B,
  JESD204_RX_ENCODER_MAX
}
 

Functions

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_laneinfo_read (struct axi_jesd204_rx *jesd, uint32_t lane)
 Read JESD204 RX Lane Info. More...
 
int32_t axi_jesd204_rx_watchdog (struct axi_jesd204_rx *jesd)
 JESD204 RX Watchdog. 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...
 

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.

Enumeration Type Documentation

◆ jesd204_rx_encoder

Enumerator
JESD204_RX_ENCODER_UNKNOWN 
JESD204_RX_ENCODER_8B10B 
JESD204_RX_ENCODER_64B66B 
JESD204_RX_ENCODER_MAX 

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.

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.

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.

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.

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.
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.

JESD204 RX Status Read

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.

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: