iio_ad405x.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   iio_ad405x.h
 *   @brief  Header file of IIO AD405X Driver.
 *   @author George Mois (george.mois@analog.com)
********************************************************************************
 * Copyright 2025(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:
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  - 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.
 *  - 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.
 *  - The use of this software may or may not infringe the patent rights
 *    of one or more patent holders.  This license does not release you
 *    from the requirement that you obtain separate licenses from these
 *    patent holders to use this software.
 *  - Use of the software either in source or binary form, must be run
 *    on or directly connected to an Analog Devices Inc. component.
 *
 * 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.
*******************************************************************************/
#ifndef IIO_AD405X_H
#define IIO_AD405X_H
 
#include "iio.h"

enum ad405x_iio_debug_attrs {
    AD405X_DEBUG_SAMPLE_RATE,
    AD405X_DEBUG_AVG_FILTER_LEN
};

struct ad405x_iio_dev {
    struct ad405x_dev *ad405x_dev;
    struct iio_device *iio_dev;
    uint32_t active_channels;
    uint8_t no_of_active_channels;
};

struct ad405x_iio_dev_init_param {
    struct ad405x_init_param *ad405x_dev_init;
};

int ad405x_iio_read_debug_attrs(void *dev, char *buf, uint32_t len,
                const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_write_debug_attrs(void *dev, char *buf, uint32_t len,
                 const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_write_sample_rate(void *dev, char *buf,
                 uint32_t len, const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_read_sample_rate(void *dev, char *buf, uint32_t len,
                const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_write_avg_filter_length(void *dev, char *buf,
                       uint32_t len, const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_read_avg_filter_length(void *dev, char *buf, uint32_t len,
                      const struct iio_ch_info *channel, intptr_t priv);
int ad405x_iio_init(struct ad405x_iio_dev **iio_dev,
            struct ad405x_iio_dev_init_param *init_param);
int ad405x_iio_remove(struct ad405x_iio_dev *desc);
 
#endif