1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2024-11-24 16:46:13 +01:00

Compare commits

...

7 Commits

Author SHA1 Message Date
pmantoine
ebbeea5fbb STM32F4xx native I2C driver merge 2023-09-13 16:46:36 +08:00
pmantoine
a8321fff42
Merge pull request #352 from DCC-EX/STM32_I2C_PMA_NEIL
Stm32 i2 c pma neil
2023-09-13 16:43:59 +08:00
pmantoine
e51f8e9c0a STM32 I2C Clock selection for 100/400KHz 2023-04-11 15:48:35 +08:00
Neil McKechnie
4f43a413b5 Update I2CManager_STM32.h
Remove debug code (writing to pin D2).  Update comments.  Restructure.
2023-03-30 18:30:38 +01:00
Neil McKechnie
4f56837d28 Fixes to timeout handling (due to STM32 micros() difference). 2023-03-28 18:07:52 +01:00
Neil McKechnie
cc2846d932 STM32 Native I2C first working version
Working for reads and writes, needs more testing and perhaps a polish.
2023-03-27 00:20:59 +01:00
pmantoine
83325ebf78 Initial I2C native driver 2023-03-23 08:44:25 +11:00
6 changed files with 338 additions and 142 deletions

View File

@ -92,7 +92,7 @@ void I2CManagerClass::begin(void) {
// Probe and list devices. Use standard mode // Probe and list devices. Use standard mode
// (clock speed 100kHz) for best device compatibility. // (clock speed 100kHz) for best device compatibility.
_setClock(100000); _setClock(100000);
unsigned long originalTimeout = _timeout; uint32_t originalTimeout = _timeout;
setTimeout(1000); // use 1ms timeout for probes setTimeout(1000); // use 1ms timeout for probes
#if defined(I2C_EXTENDED_ADDRESS) #if defined(I2C_EXTENDED_ADDRESS)

View File

@ -485,7 +485,7 @@ private:
// When retries are enabled, the timeout applies to each // When retries are enabled, the timeout applies to each
// try, and failure from timeout does not get retried. // try, and failure from timeout does not get retried.
// A value of 0 means disable timeout monitoring. // A value of 0 means disable timeout monitoring.
unsigned long _timeout = 100000UL; uint32_t _timeout = 100000UL;
// Finish off request block by waiting for completion and posting status. // Finish off request block by waiting for completion and posting status.
uint8_t finishRB(I2CRB *rb, uint8_t status); uint8_t finishRB(I2CRB *rb, uint8_t status);
@ -532,14 +532,15 @@ private:
uint8_t bytesToSend = 0; uint8_t bytesToSend = 0;
uint8_t bytesToReceive = 0; uint8_t bytesToReceive = 0;
uint8_t operation = 0; uint8_t operation = 0;
unsigned long startTime = 0; uint32_t startTime = 0;
uint8_t muxPhase = 0; uint8_t muxPhase = 0;
uint8_t muxAddress = 0; uint8_t muxAddress = 0;
uint8_t muxData[1]; uint8_t muxData[1];
uint8_t deviceAddress; uint8_t deviceAddress;
const uint8_t *sendBuffer; const uint8_t *sendBuffer;
uint8_t *receiveBuffer; uint8_t *receiveBuffer;
uint8_t transactionState = 0;
volatile uint32_t pendingClockSpeed = 0; volatile uint32_t pendingClockSpeed = 0;
void startTransaction(); void startTransaction();

View File

@ -172,6 +172,10 @@ void I2CManagerClass::startTransaction() {
* Function to queue a request block and initiate operations. * Function to queue a request block and initiate operations.
***************************************************************************/ ***************************************************************************/
void I2CManagerClass::queueRequest(I2CRB *req) { void I2CManagerClass::queueRequest(I2CRB *req) {
if (((req->operation & OPERATION_MASK) == OPERATION_READ) && req->readLen == 0)
return; // Ignore null read
req->status = I2C_STATUS_PENDING; req->status = I2C_STATUS_PENDING;
req->nextRequest = NULL; req->nextRequest = NULL;
ATOMIC_BLOCK() { ATOMIC_BLOCK() {
@ -184,6 +188,7 @@ void I2CManagerClass::queueRequest(I2CRB *req) {
} }
/*************************************************************************** /***************************************************************************
* Initiate a write to an I2C device (non-blocking operation) * Initiate a write to an I2C device (non-blocking operation)
***************************************************************************/ ***************************************************************************/
@ -240,8 +245,8 @@ void I2CManagerClass::checkForTimeout() {
I2CRB *t = queueHead; I2CRB *t = queueHead;
if (state==I2C_STATE_ACTIVE && t!=0 && t==currentRequest && _timeout > 0) { if (state==I2C_STATE_ACTIVE && t!=0 && t==currentRequest && _timeout > 0) {
// Check for timeout // Check for timeout
unsigned long elapsed = micros() - startTime; int32_t elapsed = micros() - startTime;
if (elapsed > _timeout) { if (elapsed > (int32_t)_timeout) {
#ifdef DIAG_IO #ifdef DIAG_IO
//DIAG(F("I2CManager Timeout on %s"), t->i2cAddress.toString()); //DIAG(F("I2CManager Timeout on %s"), t->i2cAddress.toString());
#endif #endif
@ -300,12 +305,12 @@ void I2CManagerClass::handleInterrupt() {
// Check if current request has completed. If there's a current request // Check if current request has completed. If there's a current request
// and state isn't active then state contains the completion status of the request. // and state isn't active then state contains the completion status of the request.
if (state == I2C_STATE_COMPLETED && currentRequest != NULL) { if (state == I2C_STATE_COMPLETED && currentRequest != NULL && currentRequest == queueHead) {
// Operation has completed. // Operation has completed.
if (completionStatus == I2C_STATUS_OK || ++retryCounter > MAX_I2C_RETRIES if (completionStatus == I2C_STATUS_OK || ++retryCounter > MAX_I2C_RETRIES
|| currentRequest->operation & OPERATION_NORETRY) || currentRequest->operation & OPERATION_NORETRY)
{ {
// Status is OK, or has failed and retry count exceeded, or retries disabled. // Status is OK, or has failed and retry count exceeded, or failed and retries disabled.
#if defined(I2C_EXTENDED_ADDRESS) #if defined(I2C_EXTENDED_ADDRESS)
if (muxPhase == MuxPhase_PROLOG ) { if (muxPhase == MuxPhase_PROLOG ) {
overallStatus = completionStatus; overallStatus = completionStatus;

View File

@ -26,27 +26,42 @@
#include "I2CManager.h" #include "I2CManager.h"
#include "I2CManager_NonBlocking.h" // to satisfy intellisense #include "I2CManager_NonBlocking.h" // to satisfy intellisense
//#include <avr/io.h>
//#include <avr/interrupt.h>
#include <wiring_private.h> #include <wiring_private.h>
#include "stm32f4xx_hal_rcc.h"
/*************************************************************************** /*****************************************************************************
* Interrupt handler. * STM32F4xx I2C native driver support
* IRQ handler for SERCOM3 which is the default I2C definition for Arduino Zero *
* compatible variants such as the Sparkfun SAMD21 Dev Breakout etc. * Nucleo-64 and Nucleo-144 boards all use I2C1 as the default I2C peripheral
* Later we may wish to allow use of an alternate I2C bus, or more than one I2C * Later we may wish to support other STM32 boards, allow use of an alternate
* bus on the SAMD architecture * I2C bus, or more than one I2C bus on the STM32 architecture
***************************************************************************/ *****************************************************************************/
#if defined(I2C_USE_INTERRUPTS) && defined(ARDUINO_ARCH_STM32) #if defined(I2C_USE_INTERRUPTS) && defined(ARDUINO_ARCH_STM32)
void I2C1_IRQHandler() { #if defined(ARDUINO_NUCLEO_F411RE) || defined(ARDUINO_NUCLEO_F446RE) || defined(ARDUINO_NUCLEO_F412ZG) || defined(ARDUINO_NUCLEO_F429ZI) || defined(ARDUINO_NUCLEO_F446ZE)
// Assume I2C1 for now - default I2C bus on Nucleo-F411RE and likely all Nucleo-64
// and Nucleo-144variants
I2C_TypeDef *s = I2C1;
// In init we will ask the STM32 HAL layer for the configured APB1 clock frequency in Hz
uint32_t APB1clk1; // Peripheral Input Clock speed in Hz.
uint32_t i2c_MHz; // Peripheral Input Clock speed in MHz.
// IRQ handler for I2C1, replacing the weak definition in the STM32 HAL
extern "C" void I2C1_EV_IRQHandler(void) {
I2CManager.handleInterrupt(); I2CManager.handleInterrupt();
} }
extern "C" void I2C1_ER_IRQHandler(void) {
I2CManager.handleInterrupt();
}
#else
#warning STM32 board selected is not yet supported - so I2C1 peripheral is not defined
#endif
#endif #endif
// Assume I2C1 for now - default I2C bus on Nucleo-F411RE and likely Nucleo-64 variants // Peripheral Input Clock speed in MHz.
I2C_TypeDef *s = I2C1; // For STM32F446RE, the speed is 45MHz. Ideally, this should be determined
#define I2C_IRQn I2C1_EV_IRQn // at run-time from the APB1 clock, as it can vary from STM32 family to family.
#define I2C_BUSFREQ 16 // #define I2C_PERIPH_CLK 45
// I2C SR1 Status Register #1 bit definitions for convenience // I2C SR1 Status Register #1 bit definitions for convenience
// #define I2C_SR1_SMBALERT (1<<15) // SMBus alert // #define I2C_SR1_SMBALERT (1<<15) // SMBus alert
@ -80,52 +95,55 @@ I2C_TypeDef *s = I2C1;
// #define I2C_CR1_SMBUS (1<<1) // SMBus mode, 1=SMBus, 0=I2C // #define I2C_CR1_SMBUS (1<<1) // SMBus mode, 1=SMBus, 0=I2C
// #define I2C_CR1_PE (1<<0) // I2C Peripheral enable // #define I2C_CR1_PE (1<<0) // I2C Peripheral enable
// States of the STM32 I2C driver state machine
enum {TS_IDLE,TS_START,TS_W_ADDR,TS_W_DATA,TS_W_STOP,TS_R_ADDR,TS_R_DATA,TS_R_STOP};
/*************************************************************************** /***************************************************************************
* Set I2C clock speed register. This should only be called outside of * Set I2C clock speed register. This should only be called outside of
* a transmission. The I2CManagerClass::_setClock() function ensures * a transmission. The I2CManagerClass::_setClock() function ensures
* that it is only called at the beginning of an I2C transaction. * that it is only called at the beginning of an I2C transaction.
***************************************************************************/ ***************************************************************************/
void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) { void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
// Calculate a rise time appropriate to the requested bus speed // Calculate a rise time appropriate to the requested bus speed
// Use 10x the rise time spec to enable integer divide of 62.5ns clock period // Use 10x the rise time spec to enable integer divide of 50ns clock period
uint16_t t_rise; uint16_t t_rise;
uint32_t ccr_freq; uint32_t ccr_freq;
if (i2cClockSpeed < 200000L) {
// i2cClockSpeed = 100000L; while (s->CR1 & I2C_CR1_STOP); // Prevents lockup by guarding further
t_rise = 0x11; // (1000ns /62.5ns) + 1; // writes to CR1 while STOP is being executed!
}
else if (i2cClockSpeed < 800000L) // Disable the I2C device, as TRISE can only be programmed whilst disabled
s->CR1 &= ~(I2C_CR1_PE); // Disable I2C
if (i2cClockSpeed > 100000L)
{ {
i2cClockSpeed = 400000L; if (i2cClockSpeed > 400000L)
t_rise = 0x06; // (300ns / 62.5ns) + 1; i2cClockSpeed = 400000L;
// } else if (i2cClockSpeed < 1200000L) {
// i2cClockSpeed = 1000000L; t_rise = 300; // nanoseconds
// t_rise = 120;
} }
else else
{ {
i2cClockSpeed = 100000L; i2cClockSpeed = 100000L;
t_rise = 0x11; // (1000ns /62.5ns) + 1; t_rise = 1000; // nanoseconds
} }
// Configure the rise time register
// Enable the I2C master mode s->TRISE = (t_rise / (1000 / i2c_MHz)) + 1;
s->CR1 &= ~(I2C_CR1_PE); // Enable I2C
// Software reset the I2C peripheral
// s->CR1 |= I2C_CR1_SWRST; // reset the I2C
// Release reset
// s->CR1 &= ~(I2C_CR1_SWRST); // Normal operation
// Calculate baudrate - using a rise time appropriate for the speed
ccr_freq = I2C_BUSFREQ * 1000000 / i2cClockSpeed / 2;
// Bit 15: I2C Master mode, 0=standard, 1=Fast Mode // Bit 15: I2C Master mode, 0=standard, 1=Fast Mode
// Bit 14: Duty, fast mode duty cycle // Bit 14: Duty, fast mode duty cycle (use 2:1)
// Bit 11-0: FREQR = 16MHz => TPCLK1 = 62.5ns, so CCR divisor must be 0x50 (80 * 62.5ns = 5000ns) // Bit 11-0: FREQR
s->CCR = (uint16_t)ccr_freq; if (i2cClockSpeed > 100000L) {
// In fast mode, I2C period is 3 * CCR * TPCLK1.
// Configure the rise time register //APB1clk1 / 3 / i2cClockSpeed = 38, but that results in 306KHz not 400!
s->TRISE = t_rise; // 1000 ns / 62.5 ns = 16 + 1 ccr_freq = 30; // So 30 gives 396KHz or so!
s->CCR = (uint16_t)(ccr_freq | 0x8000); // We need Fast Mode set
} else {
// In standard mode, I2C period is 2 * CCR * TPCLK1
ccr_freq = (APB1clk1 / 2 / i2cClockSpeed); // Should be 225 for 45Mhz APB1 clock
s->CCR |= (uint16_t)ccr_freq;
}
// Enable the I2C master mode // Enable the I2C master mode
s->CR1 |= I2C_CR1_PE; // Enable I2C s->CR1 |= I2C_CR1_PE; // Enable I2C
@ -136,32 +154,51 @@ void I2CManagerClass::I2C_setClock(uint32_t i2cClockSpeed) {
***************************************************************************/ ***************************************************************************/
void I2CManagerClass::I2C_init() void I2CManagerClass::I2C_init()
{ {
//Setting up the clocks // Query the clockspeed from the STM32 HAL layer
RCC->APB1ENR |= (1<<21); // Enable I2C CLOCK APB1clk1 = HAL_RCC_GetPCLK1Freq();
RCC->AHB1ENR |= (1<<1); // Enable GPIOB CLOCK for PB8/PB9 i2c_MHz = APB1clk1 / 1000000UL;
// Enable clocks
RCC->APB1ENR |= RCC_APB1ENR_I2C1EN;//(1 << 21); // Enable I2C CLOCK
// Reset the I2C1 peripheral to initial state
RCC->APB1RSTR |= RCC_APB1RSTR_I2C1RST;
RCC->APB1RSTR &= ~RCC_APB1RSTR_I2C1RST;
// Standard I2C pins are SCL on PB8 and SDA on PB9 // Standard I2C pins are SCL on PB8 and SDA on PB9
RCC->AHB1ENR |= (1<<1); // Enable GPIOB CLOCK for PB8/PB9
// Bits (17:16)= 1:0 --> Alternate Function for Pin PB8; // Bits (17:16)= 1:0 --> Alternate Function for Pin PB8;
// Bits (19:18)= 1:0 --> Alternate Function for Pin PB9 // Bits (19:18)= 1:0 --> Alternate Function for Pin PB9
GPIOB->MODER &= ~((3<<(8*2)) | (3<<(9*2))); // Clear all MODER bits for PB8 and PB9
GPIOB->MODER |= (2<<(8*2)) | (2<<(9*2)); // PB8 and PB9 set to ALT function GPIOB->MODER |= (2<<(8*2)) | (2<<(9*2)); // PB8 and PB9 set to ALT function
GPIOB->OTYPER |= (1<<8) | (1<<9); // PB8 and PB9 set to open drain output capability GPIOB->OTYPER |= (1<<8) | (1<<9); // PB8 and PB9 set to open drain output capability
GPIOB->OSPEEDR |= (3<<(8*2)) | (3<<(9*2)); // PB8 and PB9 set to High Speed mode GPIOB->OSPEEDR |= (3<<(8*2)) | (3<<(9*2)); // PB8 and PB9 set to High Speed mode
GPIOB->PUPDR &= ~((3<<(8*2)) | (3<<(9*2))); // Clear all PUPDR bits for PB8 and PB9
GPIOB->PUPDR |= (1<<(8*2)) | (1<<(9*2)); // PB8 and PB9 set to pull-up capability GPIOB->PUPDR |= (1<<(8*2)) | (1<<(9*2)); // PB8 and PB9 set to pull-up capability
// Alt Function High register routing pins PB8 and PB9 for I2C1: // Alt Function High register routing pins PB8 and PB9 for I2C1:
// Bits (3:2:1:0) = 0:1:0:0 --> AF4 for pin PB8 // Bits (3:2:1:0) = 0:1:0:0 --> AF4 for pin PB8
// Bits (7:6:5:4) = 0:1:0:0 --> AF4 for pin PB9 // Bits (7:6:5:4) = 0:1:0:0 --> AF4 for pin PB9
GPIOB->AFR[1] &= ~((15<<0) | (15<<4)); // Clear all AFR bits for PB8 on low nibble, PB9 on next nibble up
GPIOB->AFR[1] |= (4<<0) | (4<<4); // PB8 on low nibble, PB9 on next nibble up GPIOB->AFR[1] |= (4<<0) | (4<<4); // PB8 on low nibble, PB9 on next nibble up
// Software reset the I2C peripheral // Software reset the I2C peripheral
s->CR1 |= I2C_CR1_SWRST; // reset the I2C s->CR1 |= I2C_CR1_SWRST; // reset the I2C
s->CR1 &= ~(I2C_CR1_SWRST); // Normal operation asm("nop"); // wait a bit... suggestion from online!
s->CR1 &= ~(I2C_CR1_SWRST); // Normal operation
// Program the peripheral input clock in CR2 Register in order to generate correct timings // Clear all bits in I2C CR2 register except reserved bits
s->CR2 |= I2C_BUSFREQ; // PCLK1 FREQUENCY in MHz s->CR2 &= 0xE000;
// Set I2C peripheral clock frequency
// s->CR2 |= I2C_PERIPH_CLK;
s->CR2 |= i2c_MHz;
// set own address to 00 - not used in master mode
I2C1->OAR1 = (1 << 14); // bit 14 should be kept at 1 according to the datasheet
#if defined(I2C_USE_INTERRUPTS) #if defined(I2C_USE_INTERRUPTS)
// Setting NVIC // Setting NVIC
NVIC_SetPriority(I2C_IRQn, 1); // Match default priorities NVIC_SetPriority(I2C1_EV_IRQn, 1); // Match default priorities
NVIC_EnableIRQ(I2C_IRQn); NVIC_EnableIRQ(I2C1_EV_IRQn);
NVIC_SetPriority(I2C1_ER_IRQn, 1); // Match default priorities
NVIC_EnableIRQ(I2C1_ER_IRQn);
// CR2 Interrupt Settings // CR2 Interrupt Settings
// Bit 15-13: reserved // Bit 15-13: reserved
@ -172,23 +209,25 @@ void I2CManagerClass::I2C_init()
// Bit 8: ITERREN - Error interrupt enable // Bit 8: ITERREN - Error interrupt enable
// Bit 7-6: reserved // Bit 7-6: reserved
// Bit 5-0: FREQ - Peripheral clock frequency (max 50MHz) // Bit 5-0: FREQ - Peripheral clock frequency (max 50MHz)
// s->CR2 |= 0x0700; // Enable Buffer, Event and Error interrupts s->CR2 |= (I2C_CR2_ITBUFEN | I2C_CR2_ITEVTEN | I2C_CR2_ITERREN); // Enable Buffer, Event and Error interrupts
s->CR2 |= 0x0300; // Enable Event and Error interrupts
#endif #endif
// Calculate baudrate and set default rate for now // Calculate baudrate and set default rate for now
// Configure the Clock Control Register for 100KHz SCL frequency // Configure the Clock Control Register for 100KHz SCL frequency
// Bit 15: I2C Master mode, 0=standard, 1=Fast Mode // Bit 15: I2C Master mode, 0=standard, 1=Fast Mode
// Bit 14: Duty, fast mode duty cycle // Bit 14: Duty, fast mode duty cycle
// Bit 11-0: FREQR = 16MHz => TPCLK1 = 62.5ns, so CCR divisor must be 0x50 (80 * 62.5ns = 5000ns) // Bit 11-0: so CCR divisor would be clk / 2 / 100000 (where clk is in Hz)
s->CCR = 0x0050; // s->CCR = I2C_PERIPH_CLK * 5;
s->CCR &= ~(0x3000); // Clear all bits except 12 and 13 which must remain per reset value
s->CCR |= (APB1clk1 / 2 / 100000UL); // i2c_MHz * 5;
// s->CCR = i2c_MHz * 5;
// Configure the rise time register - max allowed in 1000ns // Configure the rise time register - max allowed is 1000ns, so value = 1000ns * I2C_PERIPH_CLK MHz / 1000 + 1.
s->TRISE = 0x0011; // 1000 ns / 62.5 ns = 16 + 1 // s->TRISE = I2C_PERIPH_CLK + 1; // 1000 ns / 50 ns = 20 + 1 = 21
s->TRISE = i2c_MHz + 1;
// Enable the I2C master mode // Enable the I2C master mode
s->CR1 |= I2C_CR1_PE; // Enable I2C s->CR1 |= I2C_CR1_PE; // Enable I2C
// Setting bus idle mode and wait for sync
} }
/*************************************************************************** /***************************************************************************
@ -198,49 +237,30 @@ void I2CManagerClass::I2C_sendStart() {
// Set counters here in case this is a retry. // Set counters here in case this is a retry.
rxCount = txCount = 0; rxCount = txCount = 0;
uint8_t temp;
// On a single-master I2C bus, the start bit won't be sent until the bus // On a single-master I2C bus, the start bit won't be sent until the bus
// state goes to IDLE so we can request it without waiting. On a // state goes to IDLE so we can request it without waiting. On a
// multi-master bus, the bus may be BUSY under control of another master, // multi-master bus, the bus may be BUSY under control of another master,
// in which case we can avoid some arbitration failures by waiting until // in which case we can avoid some arbitration failures by waiting until
// the bus state is IDLE. We don't do that here. // the bus state is IDLE. We don't do that here.
//while (s->SR2 & I2C_SR2_BUSY) {}
// If anything to send, initiate write. Otherwise initiate read. // Check there's no STOP still in progress. If we OR the START bit into CR1
if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) && !bytesToSend)) // and the STOP bit is already set, we could output multiple STOP conditions.
{ while (s->CR1 & I2C_CR1_STOP) {} // Wait for STOP bit to reset
// Send start for read operation
s->CR1 |= I2C_CR1_ACK; // Enable the ACK s->CR2 |= (I2C_CR2_ITEVTEN | I2C_CR2_ITERREN); // Enable interrupts
s->CR1 |= I2C_CR1_START; // Generate START s->CR2 &= ~I2C_CR2_ITBUFEN; // Don't enable buffer interupts yet.
// Send address with read flag (1) or'd in s->CR1 &= ~I2C_CR1_POS; // Clear the POS bit
s->DR = (deviceAddress << 1) | 1; // send the address s->CR1 |= (I2C_CR1_ACK | I2C_CR1_START); // Enable the ACK and generate START
while (!(s->SR1 && I2C_SR1_ADDR)); // wait for ADDR bit to set transactionState = TS_START;
// Special case for 1 byte reads!
if (bytesToReceive == 1)
{
s->CR1 &= ~I2C_CR1_ACK; // clear the ACK bit
temp = I2C1->SR1 | I2C1->SR2; // read SR1 and SR2 to clear the ADDR bit.... EV6 condition
s->CR1 |= I2C_CR1_STOP; // Stop I2C
}
else
temp = s->SR1 | s->SR2; // read SR1 and SR2 to clear the ADDR bit
}
else {
// Send start for write operation
s->CR1 |= I2C_CR1_ACK; // Enable the ACK
s->CR1 |= I2C_CR1_START; // Generate START
// Send address with write flag (0) or'd in
s->DR = (deviceAddress << 1) | 0; // send the address
while (!(s->SR1 && I2C_SR1_ADDR)); // wait for ADDR bit to set
temp = s->SR1 | s->SR2; // read SR1 and SR2 to clear the ADDR bit
}
} }
/*************************************************************************** /***************************************************************************
* Initiate a stop bit for transmission (does not interrupt) * Initiate a stop bit for transmission (does not interrupt)
***************************************************************************/ ***************************************************************************/
void I2CManagerClass::I2C_sendStop() { void I2CManagerClass::I2C_sendStop() {
s->CR1 |= I2C_CR1_STOP; // Stop I2C s->CR1 |= I2C_CR1_STOP; // Stop I2C
} }
/*************************************************************************** /***************************************************************************
@ -252,9 +272,11 @@ void I2CManagerClass::I2C_close() {
s->CR1 &= ~I2C_CR1_PE; // Disable I2C peripheral s->CR1 &= ~I2C_CR1_PE; // Disable I2C peripheral
// Should never happen, but wait for up to 500us only. // Should never happen, but wait for up to 500us only.
unsigned long startTime = micros(); unsigned long startTime = micros();
while ((s->CR1 && I2C_CR1_PE) != 0) { while ((s->CR1 & I2C_CR1_PE) != 0) {
if (micros() - startTime >= 500UL) break; if ((int32_t)(micros() - startTime) >= 500) break;
} }
NVIC_DisableIRQ(I2C1_EV_IRQn);
NVIC_DisableIRQ(I2C1_ER_IRQn);
} }
/*************************************************************************** /***************************************************************************
@ -263,50 +285,217 @@ void I2CManagerClass::I2C_close() {
* (and therefore, indirectly, from I2CRB::wait() and I2CRB::isBusy()). * (and therefore, indirectly, from I2CRB::wait() and I2CRB::isBusy()).
***************************************************************************/ ***************************************************************************/
void I2CManagerClass::I2C_handleInterrupt() { void I2CManagerClass::I2C_handleInterrupt() {
volatile uint16_t temp_sr1, temp_sr2;
if (s->SR1 && I2C_SR1_ARLO) { temp_sr1 = s->SR1;
// Arbitration lost, restart
I2C_sendStart(); // Reinitiate request // Check for errors first
} else if (s->SR1 && I2C_SR1_BERR) { if (temp_sr1 & (I2C_SR1_AF | I2C_SR1_ARLO | I2C_SR1_BERR)) {
// Bus error // Check which error flag is set
completionStatus = I2C_STATUS_BUS_ERROR; if (temp_sr1 & I2C_SR1_AF)
state = I2C_STATE_COMPLETED; {
} else if (s->SR1 && I2C_SR1_TXE) { s->SR1 &= ~(I2C_SR1_AF); // Clear AF
// Master write completed I2C_sendStop(); // Clear the bus
if (s->SR1 && (1<<10)) { transactionState = TS_IDLE;
// Nacked, send stop.
I2C_sendStop();
completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE; completionStatus = I2C_STATUS_NEGATIVE_ACKNOWLEDGE;
state = I2C_STATE_COMPLETED; state = I2C_STATE_COMPLETED;
} else if (bytesToSend) { }
// Acked, so send next byte else if (temp_sr1 & I2C_SR1_ARLO)
s->DR = sendBuffer[txCount++]; {
bytesToSend--; // Arbitration lost, restart
} else if (bytesToReceive) { s->SR1 &= ~(I2C_SR1_ARLO); // Clear ARLO
// Last sent byte acked and no more to send. Send repeated start, address and read bit. I2C_sendStart(); // Reinitiate request
// s->I2CM.ADDR.bit.ADDR = (deviceAddress << 1) | 1; transactionState = TS_START;
} else { }
// Check both TxE/BTF == 1 before generating stop else if (temp_sr1 & I2C_SR1_BERR)
while (!(s->SR1 && I2C_SR1_TXE)); // Check TxE {
while (!(s->SR1 && I2C_SR1_BTF)); // Check BTF // Bus error
// No more data to send/receive. Initiate a STOP condition and finish s->SR1 &= ~(I2C_SR1_BERR); // Clear BERR
I2C_sendStop(); I2C_sendStop(); // Clear the bus
transactionState = TS_IDLE;
completionStatus = I2C_STATUS_BUS_ERROR;
state = I2C_STATE_COMPLETED; state = I2C_STATE_COMPLETED;
} }
} else if (s->SR1 && I2C_SR1_RXNE) { }
// Master read completed without errors else {
if (bytesToReceive == 1) { // No error flags, so process event according to current state.
// s->I2CM.CTRLB.bit.ACKACT = 1; // NAK final byte switch (transactionState) {
I2C_sendStop(); // send stop case TS_START:
receiveBuffer[rxCount++] = s->DR; // Store received byte if (temp_sr1 & I2C_SR1_SB) {
bytesToReceive = 0; // Event EV5
state = I2C_STATE_COMPLETED; // Start bit has been sent successfully and we have the bus.
} else if (bytesToReceive) { // If anything to send, initiate write. Otherwise initiate read.
// s->I2CM.CTRLB.bit.ACKACT = 0; // ACK all but final byte if (operation == OPERATION_READ || ((operation == OPERATION_REQUEST) && !bytesToSend)) {
receiveBuffer[rxCount++] = s->DR; // Store received byte // Send address with read flag (1) or'd in
bytesToReceive--; s->DR = (deviceAddress << 1) | 1; // send the address
transactionState = TS_R_ADDR;
} else {
// Send address with write flag (0) or'd in
s->DR = (deviceAddress << 1) | 0; // send the address
transactionState = TS_W_ADDR;
}
}
// SB bit is cleared by writing to DR (already done).
break;
case TS_W_ADDR:
if (temp_sr1 & I2C_SR1_ADDR) {
temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
// Event EV6
// Address sent successfully, device has ack'd in response.
if (!bytesToSend) {
I2C_sendStop();
transactionState = TS_IDLE;
completionStatus = I2C_STATUS_OK;
state = I2C_STATE_COMPLETED;
} else {
// Put one byte into DR to load shift register.
s->DR = sendBuffer[txCount++];
bytesToSend--;
if (bytesToSend) {
// Put another byte to load DR
s->DR = sendBuffer[txCount++];
bytesToSend--;
}
if (!bytesToSend) {
// No more bytes to send.
// The TXE interrupt occurs when the DR is empty, and the BTF interrupt
// occurs when the shift register is also empty (one character later).
// To avoid repeated TXE interrupts during this time, we disable TXE interrupt.
s->CR2 &= ~I2C_CR2_ITBUFEN; // Wait for BTF interrupt, disable TXE interrupt
transactionState = TS_W_STOP;
} else {
// More data remaining to send after this interrupt, enable TXE interrupt.
s->CR2 |= I2C_CR2_ITBUFEN;
transactionState = TS_W_DATA;
}
}
}
break;
case TS_W_DATA:
if (temp_sr1 & I2C_SR1_TXE) {
// Event EV8_1/EV8
// Transmitter empty, write a byte to it.
if (bytesToSend) {
s->DR = sendBuffer[txCount++];
bytesToSend--;
if (!bytesToSend) {
s->CR2 &= ~I2C_CR2_ITBUFEN; // Disable TXE interrupt
transactionState = TS_W_STOP;
}
}
}
break;
case TS_W_STOP:
if (temp_sr1 & I2C_SR1_BTF) {
// Event EV8_2
// Done, last character sent. Anything to receive?
if (bytesToReceive) {
I2C_sendStart();
// NOTE: Three redundant BTF interrupts take place between the
// first BTF interrupt and the START interrupt. I've tried all sorts
// of ways to eliminate them, and the only thing that worked for
// me was to loop until the BTF bit becomes reset. Either way,
// it's a waste of processor time. Anyone got a solution?
//while (s->SR1 && I2C_SR1_BTF) {}
transactionState = TS_START;
} else {
I2C_sendStop();
transactionState = TS_IDLE;
completionStatus = I2C_STATUS_OK;
state = I2C_STATE_COMPLETED;
}
s->SR1 &= I2C_SR1_BTF; // Clear BTF interrupt
}
break;
case TS_R_ADDR:
if (temp_sr1 & I2C_SR1_ADDR) {
// Event EV6
// Address sent for receive.
// The next bit is different depending on whether there are
// 1 byte, 2 bytes or >2 bytes to be received, in accordance with the
// Programmers Reference RM0390.
if (bytesToReceive == 1) {
// Receive 1 byte
s->CR1 &= ~I2C_CR1_ACK; // Disable ack
temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
// Next step will occur after a RXNE interrupt, so enable it
s->CR2 |= I2C_CR2_ITBUFEN;
transactionState = TS_R_STOP;
} else if (bytesToReceive == 2) {
// Receive 2 bytes
s->CR1 &= ~I2C_CR1_ACK; // Disable ACK for final byte
s->CR1 |= I2C_CR1_POS; // set POS flag to delay effect of ACK flag
// Next step will occur after a BTF interrupt, so disable RXNE interrupt
s->CR2 &= ~I2C_CR2_ITBUFEN;
temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
transactionState = TS_R_STOP;
} else {
// >2 bytes, just wait for bytes to come in and ack them for the time being
// (ack flag has already been set).
// Next step will occur after a BTF interrupt, so disable RXNE interrupt
s->CR2 &= ~I2C_CR2_ITBUFEN;
temp_sr2 = s->SR2; // read SR2 to complete clearing the ADDR bit
transactionState = TS_R_DATA;
}
}
break;
case TS_R_DATA:
// Event EV7/EV7_1
if (temp_sr1 & I2C_SR1_BTF) {
// Byte received in receiver - read next byte
if (bytesToReceive == 3) {
// Getting close to the last byte, so a specific sequence is recommended.
s->CR1 &= ~I2C_CR1_ACK; // Reset ack for next byte received.
transactionState = TS_R_STOP;
}
receiveBuffer[rxCount++] = s->DR; // Store received byte
bytesToReceive--;
}
break;
case TS_R_STOP:
if (temp_sr1 & I2C_SR1_BTF) {
// Event EV7 (last one)
// When we've got here, the receiver has got the last two bytes
// (or one byte, if only one byte is being received),
// and NAK has already been sent, so we need to read from the receiver.
if (bytesToReceive) {
if (bytesToReceive > 1)
I2C_sendStop();
while(bytesToReceive) {
receiveBuffer[rxCount++] = s->DR; // Store received byte(s)
bytesToReceive--;
}
// Finish.
transactionState = TS_IDLE;
completionStatus = I2C_STATUS_OK;
state = I2C_STATE_COMPLETED;
}
} else if (temp_sr1 & I2C_SR1_RXNE) {
if (bytesToReceive == 1) {
// One byte on a single-byte transfer. Ack has already been set.
I2C_sendStop();
receiveBuffer[rxCount++] = s->DR; // Store received byte
bytesToReceive--;
// Finish.
transactionState = TS_IDLE;
completionStatus = I2C_STATUS_OK;
state = I2C_STATE_COMPLETED;
} else
s->SR1 &= I2C_SR1_RXNE; // Acknowledge interrupt
}
break;
} }
// If we've received an interrupt at any other time, we're not interested so clear it
// to prevent it recurring ad infinitum.
s->SR1 = 0;
} }
} }
#endif /* I2CMANAGER_STM32_H */ #endif /* I2CMANAGER_STM32_H */

View File

@ -144,9 +144,9 @@
#define DISABLE_EEPROM #define DISABLE_EEPROM
#endif #endif
// STM32 support for native I2C is awaiting development // STM32 support for native I2C is awaiting development
#ifndef I2C_USE_WIRE // #ifndef I2C_USE_WIRE
#define I2C_USE_WIRE // #define I2C_USE_WIRE
#endif // #endif
/* TODO when ready /* TODO when ready
#elif defined(ARDUINO_ARCH_RP2040) #elif defined(ARDUINO_ARCH_RP2040)

View File

@ -3,7 +3,8 @@
#include "StringFormatter.h" #include "StringFormatter.h"
#define VERSION "5.1.5" #define VERSION "5.1.6"
// 5.1.6 - STM32F4xx native I2C driver added
// 5.1.5 - Added turntable object and EXRAIL commands // 5.1.5 - Added turntable object and EXRAIL commands
// - <I ...>, <JO ...>, <JP ...> - turntable commands // - <I ...>, <JO ...>, <JP ...> - turntable commands
// - DCC_TURNTABLE, EXTT_TURNTABLE, IFTTPOSITION, ONROTATE, ROTATE, ROTATE_DCC, TT_ADDPOSITION, WAITFORTT EXRAIL // - DCC_TURNTABLE, EXTT_TURNTABLE, IFTTPOSITION, ONROTATE, ROTATE, ROTATE_DCC, TT_ADDPOSITION, WAITFORTT EXRAIL