jesd204.h

Go to the documentation of this file.

 
#ifndef _JESD204_H_
#define _JESD204_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
struct jesd204_dev;
 
enum jesd204_subclass {
    JESD204_SUBCLASS_0,
    JESD204_SUBCLASS_1,
    JESD204_SUBCLASS_2,
};
 
enum jesd204_version {
    JESD204_VERSION_A,
    JESD204_VERSION_B,
    JESD204_VERSION_C,
};
 
/* JESD204C Supported encoding scheme */
enum jesd204_encoder {
    JESD204_ENCODER_UNKNOWN,
    JESD204_ENCODER_8B10B,
    JESD204_ENCODER_64B66B,
    JESD204_ENCODER_64B80B,
 
    JESD204_ENCODER_MAX
};
 
enum jesd204_sysref_mode {
    JESD204_SYSREF_DISABLED,
    JESD204_SYSREF_CONTINUOUS,
    JESD204_SYSREF_ONESHOT,
};
 
enum jesd204_state_change_result {
    JESD204_STATE_CHANGE_ERROR = -1,
    JESD204_STATE_CHANGE_DEFER = 0,
    JESD204_STATE_CHANGE_DONE,
};
 
#define JESD204_LINKS_ALL       ((unsigned int)(-1))
 
#define JESD204_LMFC_OFFSET_UNINITIALIZED   ((uint16_t)-1)
 
struct jesd204_sysref {
    enum jesd204_sysref_mode    mode;
    uint8_t             capture_falling_edge;
    uint8_t             valid_falling_edge;
    uint16_t            lmfc_offset;
};
 
struct jesd204_link {
    uint32_t link_id;
    int error;
 
    uint64_t sample_rate;
    uint32_t sample_rate_div;
 
    bool is_transmit;
 
    uint8_t num_lanes;
    uint8_t num_converters;
    uint8_t octets_per_frame;
    uint16_t frames_per_multiframe;
    uint8_t num_of_multiblocks_in_emb; /* E */
 
    uint8_t bits_per_sample;
 
    uint8_t converter_resolution;
    uint8_t jesd_version;
    uint8_t jesd_encoder;
    uint8_t subclass;
 
    uint8_t device_id;
    uint8_t bank_id;
 
    uint8_t scrambling;
    uint8_t high_density;
 
    uint8_t ctrl_words_per_frame_clk;
    uint8_t ctrl_bits_per_sample;
    uint8_t samples_per_conv_frame;
 
    uint8_t *lane_ids;
 
    struct jesd204_sysref sysref;
 
    /* Subclass 2 only */
    uint8_t dac_adj_resolution_steps;
    uint8_t dac_adj_direction;
    uint8_t dac_phase_adj;
};
 
enum jesd204_state_op_reason {
    JESD204_STATE_OP_REASON_INIT,
    JESD204_STATE_OP_REASON_UNINIT,
};
 
static inline const char *jesd204_state_op_reason_str(enum
        jesd204_state_op_reason reason)
{
    switch (reason) {
    case JESD204_STATE_OP_REASON_INIT:
        return "initialization";
    case JESD204_STATE_OP_REASON_UNINIT:
        return "uninitialization";
    default:
        return "unknown";
    }
}
 
typedef int (*jesd204_sysref_cb)(struct jesd204_dev *jdev);
 
typedef int (*jesd204_dev_cb)(struct jesd204_dev *jdev,
                  enum jesd204_state_op_reason reason);
 
typedef int (*jesd204_link_cb)(struct jesd204_dev *jdev,
                   enum jesd204_state_op_reason,
                   struct jesd204_link *lnk);
 
enum jesd204_state_op_mode {
    JESD204_STATE_OP_MODE_PER_LINK,
    JESD204_STATE_OP_MODE_PER_DEVICE,
};
 
struct jesd204_state_op {
    enum jesd204_state_op_mode  mode;
    jesd204_dev_cb          per_device;
    jesd204_link_cb         per_link;
    bool                post_state_sysref;
};
 
enum jesd204_dev_op {
    JESD204_OP_DEVICE_INIT,
    JESD204_OP_LINK_INIT,
    JESD204_OP_LINK_SUPPORTED,
    JESD204_OP_LINK_PRE_SETUP,
    JESD204_OP_CLK_SYNC_STAGE1,
    JESD204_OP_CLK_SYNC_STAGE2,
    JESD204_OP_CLK_SYNC_STAGE3,
    JESD204_OP_LINK_SETUP,
    JESD204_OP_OPT_SETUP_STAGE1,
    JESD204_OP_OPT_SETUP_STAGE2,
    JESD204_OP_OPT_SETUP_STAGE3,
    JESD204_OP_OPT_SETUP_STAGE4,
    JESD204_OP_OPT_SETUP_STAGE5,
    JESD204_OP_CLOCKS_ENABLE,
    JESD204_OP_LINK_ENABLE,
    JESD204_OP_LINK_RUNNING,
    JESD204_OP_OPT_POST_RUNNING_STAGE,
 
    __JESD204_MAX_OPS,
};
 
struct jesd204_dev_data {
    jesd204_sysref_cb           sysref_cb;
    size_t                  sizeof_priv;
    unsigned int                max_num_links;
    unsigned int                num_retries;
    struct jesd204_state_op         state_ops[__JESD204_MAX_OPS];
};
 
/* no-OS specific */
#define JESD204_MAX_TOPOLOGY_LINKS  16
 
/* no-OS specific */
struct jesd204_topology_dev {
    struct jesd204_dev  *jdev;
    bool            is_top_device;
    bool            is_sysref_provider;
    unsigned int        link_ids[JESD204_MAX_TOPOLOGY_LINKS];
    unsigned int        links_number;
};
 
/* no-OS specific */
struct jesd204_topology {
    struct jesd204_dev_top      *dev_top;
    struct jesd204_topology_dev *devs;
    unsigned int            devs_number;
};
 
/* no-OS specific */
int jesd204_dev_register(struct jesd204_dev **jdev,
             const struct jesd204_dev_data *dev_data);
 
/* no-OS specific */
int jesd204_dev_unregister(struct jesd204_dev *jdev);
 
/* no-OS specific */
int jesd204_topology_init(struct jesd204_topology **topology,
              struct jesd204_topology_dev *devs,
              unsigned int devs_number);
 
/* no-OS specific */
int jesd204_topology_remove(struct jesd204_topology *topology);
 
/* no-OS specific */
int jesd204_fsm_start(struct jesd204_topology *topology, unsigned int link_idx);
 
/* no-OS specific */
int jesd204_fsm_stop(struct jesd204_topology *topology, unsigned int link_idx);
 
void *jesd204_dev_priv(struct jesd204_dev *jdev);
 
int jesd204_link_get_lmfc_lemc_rate(struct jesd204_link *lnk,
                    unsigned long *rate_hz);
 
int jesd204_link_get_rate_khz(struct jesd204_link *lnk,
                  unsigned long *lane_rate_khz);
 
int jesd204_link_get_device_clock(struct jesd204_link *lnk,
                  unsigned long *device_clock);
 
int jesd204_sysref_async(struct jesd204_dev *jdev);
 
int jesd204_sysref_async_force(struct jesd204_dev *jdev);
 
bool jesd204_dev_is_top(struct jesd204_dev *jdev);
 
void jesd204_copy_link_params(struct jesd204_link *dst,
                  const struct jesd204_link *src);
 
#endif