/************************************************************************************ * arch/arm/src/sam34/sam_twi.h * * Copyright (C) 2013, 2016 Gregory Nutt. All rights reserved. * Author: Gregory Nutt * * 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 NuttX 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 OWNER 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. * ************************************************************************************/ #ifndef __ARCH_ARM_SRC_SAM34_SAM_TWI_H #define __ARCH_ARM_SRC_SAM34_SAM_TWI_H /************************************************************************************ * Included Files ************************************************************************************/ #include #include #include "chip/sam_twi.h" /**************************************************************************** * Public Function Prototypes ****************************************************************************/ /**************************************************************************** * Name: sam_i2cbus_initialize * * Description: * Initialize the selected I2C port. And return a unique instance of struct * struct i2c_master_s. This function may be called to obtain multiple * instances of the interface, each of which may be set up with a * different frequency and slave address. * * Input Parameter: * Port number (for hardware that has multiple I2C interfaces) * * Returned Value: * Valid I2C device structure reference on succcess; a NULL on failure * ****************************************************************************/ FAR struct i2c_master_s *sam_i2cbus_initialize(int port); /**************************************************************************** * Name: sam_i2cbus_uninitialize * * Description: * De-initialize the selected I2C port, and power down the device. * * Input Parameter: * Device structure as returned by the sam_i2cbus_initialize() * * Returned Value: * OK on success, ERROR when internal reference count mismatch or dev * points to invalid hardware device. * ****************************************************************************/ int sam_i2cbus_uninitialize(FAR struct i2c_master_s *dev); #endif /* __ARCH_ARM_SRC_SAM34_SAM_TWI_H */