elbear_arduino_bsp/libraries/Wire/src/utility/twi.c
klassents 8f0a5b0a94 dev0.2_halRevision (#1)
- Реализация части функций в библиотеках hal перенесена в заголовочный файл, функции определены как inline.
- В модулях Tone, SPI, Wire работа с регистрами вынесена в библиотеку hal или в платозависимые файлы pins_arduino.h, variants.c
- В модуле wiring_analog при отключении работы ШИМ сначала проверяется, включен ли ШИМ на указанной ноге. Если включен, вывод после отключения таймера конфигурируется на вход.

Reviewed-on: #1
2024-09-11 10:50:22 +03:00

365 lines
11 KiB
C

#include <stdlib.h>
#include <inttypes.h>
#include "Arduino.h"
#include "twi.h"
#include "mik32_hal_i2c.h"
#include "mik32_hal_irq.h"
#define TIMEOUT_TICKS 1000000
#define TWI_FREQ_DEF WIRE_FREQ_100K // default is 100 kHz
static void (*twi_onSlaveTransmit)(void);
static void (*twi_onSlaveReceive)(uint8_t*, int);
static uint8_t twi_rxBuffer[TWI_BUFFER_LENGTH];
static volatile uint8_t twi_rxBufferIndex;
I2C_HandleTypeDef hi2c;
static uint32_t CurrentFrequency = TWI_FREQ_DEF;
static bool twiIsOn = false;
// ---------------------------------------------------------------- //
/*
* Function twi_init
* Desc readys twi pins and sets twi bitrate
* Input slaveAddress - address of Arduino if working in slave mode
* Output none
*/
uint8_t twi_init(uint8_t slaveAddress)
{
// Common settings
uint32_t EPICmask;
#if I2C_NUM == 0
hi2c.Instance = I2C_0;
EPICmask = HAL_EPIC_I2C_0_MASK;
#elif I2C_NUM == 1
hi2c.Instance = I2C_1;
EPICmask = HAL_EPIC_I2C_1_MASK;
#else
#error "Unsupported I2C_NUM value in pins_arduino.h"
#endif
hi2c.Init.DigitalFilter = I2C_DIGITALFILTER_2CLOCKCYCLES;
hi2c.Init.AnalogFilter = I2C_ANALOGFILTER_DISABLE;
if (slaveAddress == 0) // if there is no address - master mode
{
hi2c.Init.Mode = HAL_I2C_MODE_MASTER;
hi2c.Init.AutoEnd = I2C_AUTOEND_ENABLE;
}
else
{
// 7-bit address without any additional bits
hi2c.Init.Mode = HAL_I2C_MODE_SLAVE;
hi2c.Init.NoStretchMode = I2C_NOSTRETCH_DISABLE; // stretch is used
hi2c.Init.OwnAddress1 = slaveAddress;
}
// set the frequency
if (hi2c.Init.Mode == HAL_I2C_MODE_MASTER)
twi_setFrequency(CurrentFrequency, true);
else
twi_setFrequency(0, true);
if (HAL_I2C_Init(&hi2c) != HAL_OK)
return I2C_ERROR;
// enable interrupts for slave mode
if (hi2c.Init.Mode == HAL_I2C_MODE_SLAVE)
{
// enable interrupts for addressing, byte reception and transfer completion
HAL_I2C_InterruptDisable(&hi2c, I2C_INTMASK);
HAL_I2C_InterruptEnable(&hi2c, I2C_CR1_ADDRIE_M | I2C_CR1_RXIE_M | I2C_CR1_STOPIE_M);
// enable interrupt from i2c
HAL_EPIC_MaskLevelSet(EPICmask);
}
twiIsOn = true;
return I2C_OK;
}
/*
* Function twi_deinit
* Desc disables twi pins
* Input none
* Output none
*/
void twi_deinit(void)
{
uint32_t EPICmask;
#if I2C_NUM == 0
hi2c.Instance = I2C_0;
EPICmask = HAL_EPIC_I2C_0_MASK;
#elif I2C_NUM == 1
hi2c.Instance = I2C_1;
EPICmask = HAL_EPIC_I2C_1_MASK;
#else
#error "Unsupported I2C_NUM value in pins_arduino.h"
#endif
HAL_I2C_Deinit(&hi2c);
// for slave mode disable interrupts from i2c
if (hi2c.Init.Mode == HAL_I2C_MODE_SLAVE)
HAL_EPIC_MaskLevelClear(EPICmask);
twiIsOn = false;
}
/*
* Function twi_setClock
* Desc sets twi bit rate
* Input Clock Frequency - 100000 / 400000 / 1000000,
* onInit = true only if function is called from twi_init()
* Output I2C_OK - frequency changed, I2C_ERROR - frequency didn't change
*/
uint8_t twi_setFrequency(uint32_t frequency, bool onInit)
{
uint8_t ret = I2C_OK;
// change the frequency only during or after bus initialization
if (twiIsOn || onInit)
{
// You can change the frequency only when the interface is turned off
HAL_I2C_Disable(&hi2c);
if (frequency == WIRE_FREQ_100K) // 100 kHz
{
hi2c.Clock.PRESC = 2;
hi2c.Clock.SCLDEL = 8;
hi2c.Clock.SDADEL = 2;
hi2c.Clock.SCLH = 49;
hi2c.Clock.SCLL = 49;
CurrentFrequency = WIRE_FREQ_100K;
}
else if (frequency == WIRE_FREQ_400K) // 400 kHz
{
hi2c.Clock.PRESC = 0;
hi2c.Clock.SCLDEL = 3;
hi2c.Clock.SDADEL = 2;
hi2c.Clock.SCLH = 30;
hi2c.Clock.SCLL = 30;
CurrentFrequency = WIRE_FREQ_400K;
}
else if (frequency == WIRE_FREQ_1000K)// 1000 kHz
{
hi2c.Clock.PRESC = 0;
hi2c.Clock.SCLDEL = 1;
hi2c.Clock.SDADEL = 2;
hi2c.Clock.SCLH = 6;
hi2c.Clock.SCLL = 6;
CurrentFrequency = WIRE_FREQ_1000K;
}
else if (frequency == 0) // slave mode
{
hi2c.Clock.PRESC = 0;
hi2c.Clock.SCLDEL = 0;
hi2c.Clock.SDADEL = 2;
hi2c.Clock.SCLH = 0;
hi2c.Clock.SCLL = 0;
}
else
// frequency does not change
ret = I2C_ERROR;
// write the timings to the register if everything is OK
if (ret == I2C_OK)
HAL_I2C_SetClockSpeed(&hi2c);
//turn the interface back only if initialization has already passed
if (twiIsOn)
HAL_I2C_Enable(&hi2c);
}
else
ret = I2C_ERROR;
return ret;
}
/*
* Function twi_masterReadFrom
* Desc attempts to become twi bus master and read a
* series of bytes from a device on the bus
* Input address: 7bit i2c device address
* data: pointer to byte array
* length: number of bytes to read into array
* sendStop: Boolean indicating whether to send a stop at the end
* Output number of bytes read
*/
uint8_t twi_masterReadFrom(uint8_t address, uint8_t* data, uint8_t length, uint8_t sendStop)
{
uint8_t ret = 0;
// if there are errors left from previous transactions, you need to restart
// the interface for correct operation
if (hi2c.ErrorCode != I2C_ERROR_NONE)
HAL_I2C_Reset(&hi2c);
if (sendStop) hi2c.Init.AutoEnd = 1;
else hi2c.Init.AutoEnd = 0;
// put the data directly into the external buffer
if (HAL_I2C_Master_Receive(&hi2c, address, data, length, TIMEOUT_TICKS) == HAL_OK)
ret = length;
return ret;
}
/*
* Function twi_masterWriteTo
* Desc attempts to become twi bus master and write a
* series of bytes to a device on the bus
* Input address: 7bit i2c device address
* data: pointer to byte array
* length: number of bytes in array
* sendStop: boolean indicating whether or not to send a stop at the end
* Output 0 .. success
* 1 .. length to long for buffer
* 2 .. address send, NACK received
* 3 .. data send, NACK received
* 4 .. other twi error (lost bus arbitration, bus error, ..)
* 5 .. timeout
*/
uint8_t twi_masterWriteTo(uint8_t address, uint8_t* data, uint8_t length, uint8_t sendStop)
{
uint8_t ret = I2C_OK;
// if there are errors left from previous transactions, you need to restart
// the interface for correct operation
if (hi2c.ErrorCode != I2C_ERROR_NONE)
HAL_I2C_Reset(&hi2c);
if (sendStop) hi2c.Init.AutoEnd = 1;
else hi2c.Init.AutoEnd = 0;
// take data from an external buffer
HAL_I2C_Master_Transmit(&hi2c, address, data, length, TIMEOUT_TICKS);
// parse errors
// check separately, because in hal libraries not all functions look at this
if (HAL_I2C_Get_Interrupts_Status(&hi2c) & I2C_ISR_NACKF_M)
hi2c.ErrorCode = I2C_ERROR_NACK;
if (hi2c.ErrorCode == (HAL_I2C_ErrorTypeDef)I2C_ERROR_TIMEOUT) ret = I2C_TIMEOUT; // timeout
else if (hi2c.ErrorCode == (HAL_I2C_ErrorTypeDef)I2C_ERROR_NACK) ret = I2C_NACK_DATA; // didn't receive ACK
else if (hi2c.ErrorCode != (HAL_I2C_ErrorTypeDef)I2C_OK) ret = I2C_ERROR; // any other error
return ret;
}
/*
* Function twi_slaveWrite
* Desc attempts to become twi bus slave and write a
* series of bytes to a master after it asks
* Input txData: pointer to byte array
* bytesNum: number of bytes in array
* Output 0 .. success
* 5 .. timeout
*/
i2c_status_e twi_slaveWrite(uint8_t *txData, uint8_t bytesNum)
{
if ((hi2c.ErrorCode != I2C_ERROR_NONE))
HAL_I2C_Reset(&hi2c);
// send data
HAL_StatusTypeDef error_code = HAL_OK;
HAL_I2C_Clear_Reload(&hi2c);
if (!(HAL_I2C_Get_CR1_Content(&hi2c) & I2C_CR1_NOSTRETCH_M)) // NOSTRETCH = 0
HAL_I2C_Reset_TXDR_Content(&hi2c);
HAL_I2C_Write_TXDR(&hi2c, txData[0]); // first recording is made in advance
// write byte
for (uint32_t tx_count = 1; tx_count < bytesNum; tx_count++)
{
if ((error_code = HAL_I2C_Slave_WaitTXIS(&hi2c, TIMEOUT_TICKS)) != HAL_OK)
{
// failed to write
HAL_I2C_Reset_TXDR_Content(&hi2c);
HAL_I2C_Reset_Interrupt_Flag(&hi2c, I2C_ICR_STOPCF_M); // Clear the STOP detection flag on the bus
HAL_I2C_Reset(&hi2c);
return I2C_TIMEOUT;
}
HAL_I2C_Write_TXDR(&hi2c, txData[tx_count]);
}
if ((error_code = HAL_I2C_WaitBusy(&hi2c, TIMEOUT_TICKS)) != HAL_OK)
{
// failed to complete transaction
HAL_I2C_Reset(&hi2c);
return I2C_TIMEOUT;
}
HAL_I2C_Reset_TXDR_Content(&hi2c);
HAL_I2C_Reset_Interrupt_Flag(&hi2c, I2C_ICR_STOPCF_M); // Clear the STOP detection flag on the bus
return I2C_OK;
}
/*
* Function twi_attachSlaveRxEvent
* Desc sets function called before a slave read operation
* Input function: callback function to use
* Output none
*/
void twi_attachSlaveRxEvent( void (*function)(uint8_t*, int) )
{
twi_onSlaveReceive = function;
}
/*
* Function twi_attachSlaveTxEvent
* Desc sets function called before a slave write operation
* Input function: callback function to use
* Output none
*/
void twi_attachSlaveTxEvent( void (*function)(void) )
{
twi_onSlaveTransmit = function;
}
/*
* Function twi_interruptHandler
* Desc handles an interrupts from twi
* Input none
* Output none
*/
void twi_interruptHandler(void)
{
uint32_t int_mask = HAL_I2C_Get_CR1_Content(&hi2c) & I2C_INTMASK; // interrupts allowed
uint32_t interrupt_status = HAL_I2C_Get_Interrupts_Status(&hi2c); // current flags
// master calls by address, device in slave mode
if ((interrupt_status & I2C_ISR_ADDR_M) && (int_mask & I2C_CR1_ADDRIE_M))
{
// reset ADDR flag
HAL_I2C_Reset_Interrupt_Flag(&hi2c, I2C_ICR_ADDRCF_M);
// look at the transmission direction and respond to the request
if (interrupt_status & I2C_ISR_DIR_M) // master reads, slave sends
twi_onSlaveTransmit(); // slave send data
else // master writes, slave reads
{
twi_rxBufferIndex = 0; // write from the beginning of the buffer
hi2c.State = HAL_I2C_STATE_BUSY;
HAL_I2C_Clear_Reload(&hi2c);
// wait for interrupts by receiving a byte or a stop condition
}
}
// new byte of data received
if ((interrupt_status & I2C_ISR_RXNE_M) && (int_mask & I2C_CR1_RXIE_M))
{
// put new byte into buffer
twi_rxBuffer[twi_rxBufferIndex++] = HAL_I2C_Get_RXDR(&hi2c);
}
// master sent a STOP to the bus
if ((interrupt_status & I2C_ISR_STOPF_M) && (int_mask & I2C_CR1_STOPIE_M))
{
hi2c.State = HAL_I2C_STATE_END;
HAL_I2C_Reset_TXDR_Content(&hi2c);
HAL_I2C_Reset_Interrupt_Flag(&hi2c, I2C_ICR_STOPCF_M); // Clear the STOP detection flag on the bus
// pass the received data to callback function
twi_onSlaveReceive(twi_rxBuffer, twi_rxBufferIndex);
}
}