# Source code for pynq.lib.iic

#   Copyright (c) 2018, Xilinx, 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 the copyright holder 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR
#   CONTRIBUTORS 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.

__author__ = "Peter Ogden"
__email__ = "pynq_support@xilinx.com"

import cffi
import os
from pynq import DefaultIP

LIB_SEARCH_PATH = os.path.dirname(os.path.realpath(__file__))

unsigned char *BufferPtr, unsigned ByteCount, unsigned char Option);

unsigned char *BufferPtr, unsigned ByteCount, unsigned char Option);

"""

_lib_location = os.path.join(LIB_SEARCH_PATH, 'libiic.so')

[docs]class AxiIIC(DefaultIP):
"""Driver for the AXI IIC controller

"""
_lib = None
_ffi = None

REPEAT_START = 1

@staticmethod
def _initialise_lib():
AxiIIC._ffi = cffi.FFI()
AxiIIC._lib = AxiIIC._ffi.dlopen(_lib_location)

def __init__(self, description):
"""Create a new instance of the driver

Parameters
----------
description : dict
Entry in the ip_dict for the IP

"""
if AxiIIC._lib is None:
AxiIIC._initialise_lib()

super().__init__(description)

[docs]    def send(self, address, data, length, option=0):
"""Send data to an attached IIC slave

Parameters
----------
data : bytes-like
Data to send
length : int
Length of data
option : int
Optionally REPEAT_START to keep hold of the bus
between transactions

"""
sent = AxiIIC._lib.XIic_Send(
if sent == 0:
raise RuntimeError("Could not send I2C data")
return sent

"""Receive data from an attached IIC slave

Parameters
----------
data : bytes-like
length : int
option : int
Optionally REPEAT_START to keep hold of the bus
between transactions

"""
raise RuntimeError("Could not receive I2C data")

[docs]    def wait(self):
"""Wait for the transaction to complete

"""
if timed_out: