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

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

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

Go to the source code of this file.

Classes

struct  jesd204_tx_config
 
struct  axi_jesd204_tx
 
struct  jesd204_tx_init
 JESD204B/C Transmit Peripheral Initialization Structure. More...
 

Enumerations

enum  jesd204_tx_encoder {
  JESD204_TX_ENCODER_UNKNOWN,
  JESD204_TX_ENCODER_8B10B,
  JESD204_TX_ENCODER_64B66B,
  JESD204_TX_ENCODER_MAX
}
 

Functions

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

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)

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_tx_encoder

Enumerator
JESD204_TX_ENCODER_UNKNOWN 
JESD204_TX_ENCODER_8B10B 
JESD204_TX_ENCODER_64B66B 
JESD204_TX_ENCODER_MAX 

Function Documentation

◆ axi_jesd204_tx_init()

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

int32_t axi_jesd204_tx_lane_clk_disable ( struct axi_jesd204_tx jesd)

JESD204 TX Lane Clock Disable.

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.

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_remove()

int32_t axi_jesd204_tx_remove ( struct axi_jesd204_tx jesd)

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

uint32_t axi_jesd204_tx_status_read ( struct axi_jesd204_tx jesd)

Read status of the JESD204 Transmit Peripherial.

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