/***************************************************************************//**
 *   @file   iio_adf4382.h
 *   @brief  Implementation of IIO ADF4382 Driver.
 *   @authors Ciprian Hegbeli (ciprian.hegbeli@analog.com)
 *            Jude Osemene (jude.osemene@analog.com)
********************************************************************************
 * Copyright 2024(c) Analog Devices, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, 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.
*******************************************************************************/
#ifndef IIO_ADF4382_H
#define IIO_ADF4382_H

#include "iio.h"

struct adf4382_iio_dev {
	struct adf4382_dev *adf4382_dev;
	struct iio_device *iio_dev;
};

struct adf4382_iio_dev_init_param {
	struct adf4382_init_param *adf4382_dev_init;
};

enum adf4382_iio_ch_attr_id {
	ADF4382_IIO_CH_ATTR_EN,
	ADF4382_IIO_CH_ATTR_FREQ,
	ADF4382_IIO_CH_ATTR_OPWR,
	ADF4382_IIO_CH_ATTR_PHASE_ADJ,
};

enum adf4382_iio_dev_attr_id {
	ADF4382_IIO_DEV_ATTR_REF_FREQ,
	ADF4382_IIO_DEV_ATTR_BLEED_CURRENT,
	ADF4382_IIO_DEV_ATTR_CHARGE_PUMP_CURRENT,
	ADF4382_IIO_DEV_ATTR_CHARGE_PUMP_AVAILABLE,
	ADF4382_IIO_DEV_ATTR_REF_DIVIDER,
	ADF4382_IIO_DEV_ATTR_REF_DOUBLER_EN,
	ADF4382_IIO_DEV_ATTR_SW_SYNC,
	ADF4382_IIO_DEV_ATTR_EZ_SYNC,
	ADF4382_IIO_DEV_ATTR_TIMED_SYNC,
	ADF4382_IIO_DEV_ATTR_FASTCAL_EN,
	ADF4382_IIO_DEV_ATTR_FASTCAL_LUT_EN,
	ADF4382_IIO_DEV_ATTR_FASTCAL_CHANGE_FREQ,
	ADF4382_IIO_DEV_ATTR_FASTCAL_START_CALIBRATION,
};

int adf4382_iio_init(struct adf4382_iio_dev **iio_dev,
		     struct adf4382_iio_dev_init_param *init_param);

int adf4382_iio_remove(struct adf4382_iio_dev *desc);

#endif