/** @addtogroup i2c_file I2C peripheral API
*
* @brief Access functions for the I2C Controller
*
* @ingroup peripheral_apis
* LGPL License Terms @ref lgpl_license
* @author @htmlonly © @endhtmlonly 2016
* Maxim Sloyko
*
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2017-2018 Unicore MX project
* Copyright (C) 2021 Eduard Drusa
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see .
*/
#include
/**@{*/
/** @brief Enable I2C peripheral
*
* @param[in] i2c uint32_t i2c peripheral base
*/
void i2c_enable(uint32_t i2c)
{
I2C_ENABLE(i2c) = I2C_ENABLE_VALUE;
}
/** @brief Disable I2C peripheral
*
* @param[in] i2c uint32_t i2c peripheral base
*/
void i2c_disable(uint32_t i2c)
{
I2C_ENABLE(i2c) = 0;
}
/** @brief Start I2C transmission.
*
* @param[in] i2c uint32_t i2c peripheral base.
* @param[in] data uint8_t the first byte to send.
*/
void i2c_start_tx(uint32_t i2c, uint8_t data)
{
PERIPH_TRIGGER_TASK(I2C_TASK_STARTTX(i2c));
I2C_TXD(i2c) = data;
}
/** @brief Start I2C reception.
*
* @param[in] i2c uint32_t i2c peripheral base.
*/
void i2c_start_rx(uint32_t i2c)
{
PERIPH_TRIGGER_TASK(I2C_TASK_STARTRX(i2c));
}
/** @brief Signal stop on I2C line.
*
* @param[in] i2c uint32_t i2c peripheral base.
*/
void i2c_send_stop(uint32_t i2c)
{
PERIPH_TRIGGER_TASK(I2C_TASK_STOP(i2c));
}
/** @brief Select Fast (400kHz) mode.
*
* @param[in] i2c uint32_t i2c peripheral base.
*/
void i2c_set_fast_mode(uint32_t i2c)
{
I2C_FREQUENCY(i2c) = I2C_FREQUENCY_400K;
}
/** @brief Select Standard (100kHz) mode.
*
* @param[in] i2c uint32_t i2c peripheral base.
*/
void i2c_set_standard_mode(uint32_t i2c)
{
I2C_FREQUENCY(i2c) = I2C_FREQUENCY_100K;
}
/** @brief Set I2C frequency.
*
* In addition to Standard (100kHz) and Fast (400kHz) modes
* this peripheral also supports 250kHz mode.
*
* @param[in] i2c uint32_t i2c peripheral base.
* @param[in] freq uint32_t frequency constant. See defines for details
* and note that this is not actually a frequency in Hz or kHz.
*/
void i2c_set_frequency(uint32_t i2c, uint32_t freq)
{
I2C_FREQUENCY(i2c) = freq;
}
/** @brief Write Data to TXD register to be sent.
*
* @param[in] i2c uint32_t i2c peripheral base.
* @param[in] data uint8_t byte to send next.
*/
void i2c_send_data(uint32_t i2c, uint8_t data)
{
I2C_TXD(i2c) = data;
}
/** @brief Read Data from RXD register.
*
* @param[in] i2c uint32_t i2c peripheral base.
* @returns uint8_t data from RXD register.
*/
uint8_t i2c_get_data(uint32_t i2c)
{
return (uint8_t)I2C_RXD(i2c);
}
/** @brief Select GPIO pins to be used by this peripheral.
*
* This needs to be configured when no transaction is in progress.
*
* @param[in] i2c i2c peripheral base.
* @param[in] scl_pin SCL pin. Use GPIO defines in @ref gpio_pin_id or GPIO_UNCONNECTED
* if signal shall not be connected to any pin.
* @param[in] sda_pin SDA pin. Use GPIO defines in @ref gpio_pin_id or GPIO_UNCONNECTED
* if signal shall not be connected to any pin.
*/
void i2c_select_pins(uint32_t i2c, uint32_t scl_pin, uint32_t sda_pin)
{
if (scl_pin != GPIO_UNCONNECTED) {
I2C_PSELSCL(i2c) = __GPIO2PIN(scl_pin);
} else {
I2C_PSELSCL(i2c) = scl_pin;
}
if (sda_pin != GPIO_UNCONNECTED) {
I2C_PSELSDA(i2c) = __GPIO2PIN(sda_pin);
} else {
I2C_PSELSDA(i2c) = sda_pin;
}
}
/** @brief Set 7bit I2C address of the device you wish to communicate with.
*
* @param[in] i2c uint32_t i2c peripheral base.
* @param[in] addr uint8_t device address (7bit).
*/
void i2c_set_address(uint32_t i2c, uint8_t addr)
{
I2C_ADDRESS(i2c) = addr;
}
/** @brief Resume I2C transaction.
*
* This function is unusual, but required to implement
* i2c exchange with this peripheral.
*
* @param[in] i2c uint32_t i2c peripheral base.
*/
void i2c_resume(uint32_t i2c)
{
PERIPH_TRIGGER_TASK(I2C_TASK_RESUME(i2c));
}
/**@}*/