/*******************************************************************************
 *   @file   xilinx/xilinx_i2c.h
 *   @brief  Header containing types used in the i2c driver.
 *   @author scuciurean (sergiu.cuciurean@analog.com)
********************************************************************************
 * Copyright 2019(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 XILINX_I2C_H_
#define XILINX_I2C_H_

/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/

#include <stdint.h>

/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/

/**
 * @enum xil_i2c_type
 * @brief Xilinx platform architecture sections
 */
enum xil_i2c_type {
	/** Programmable Logic */
	IIC_PL,
	/** Processing System */
	IIC_PS
};

/**
 * @struct xil_i2c_init
 * @brief Structure holding the initialization parameters for Xilinx platform
 * specific I2C parameters.
 */
struct xil_i2c_init_param {
	/** Xilinx architecture */
	enum xil_i2c_type	type;
	/** Device ID */
	uint32_t		device_id;
};

/**
 * @struct xil_i2c_desc
 * @brief Xilinx platform specific I2C descriptor
 */
struct xil_i2c_desc {
	/** Xilinx architecture */
	enum xil_i2c_type	type;
	/** Device ID */
	uint32_t		device_id;
	/** Xilinx I2C configuration */
	void			*config;
	/** Xilinx I2C Instance */
	void			*instance;
};

/**
 * @brief Xilinx platform specific i2c platform ops structure
 */
extern const struct i2c_platform_ops xil_i2c_ops;

/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/

/* Initialize the I2C communication peripheral. */
int32_t xil_i2c_init(struct i2c_desc **desc,
		     const struct i2c_init_param *param);

/* Free the resources allocated by i2c_init(). */
int32_t xil_i2c_remove(struct i2c_desc *desc);

/* I2C Write data */
int32_t xil_i2c_write(struct i2c_desc *desc, uint8_t *data,
		      uint8_t bytes_number, uint8_t stop_bit);

/* I2C Read data. */
int32_t xil_i2c_read(struct i2c_desc *desc, uint8_t *data,
		     uint8_t bytes_number, uint8_t stop_bit);

#endif // XILINX_I2C_H_