HAL for I2C is horribly broken

Hi,

I've used the HAL I2C Drivers with a couple of different I2C devices namely the Bosch BME280 Barometric Pressure sensor and the Vishay VCNL4010 Proximity and Light Intensity sensor.

I always use DMA along with FreeRTOS using deferred interrupts, i.e. binary semaphores.

I always set the pins to high speed.

I have had no problems at all although I never use the callbacks embedded in the HAL Interrupt handlers I put anything I need in the interrupt handler directly. This avoids spaghetti code with unnecessary pointer etc. I often delete the call back code from the HAL drivers. I know this makes them non-standard, but I don't care I just want the project to work efficiently. I like the HAL Drivers, but I am always prepared to modify them to meet my needs. I do think they need to do a lot more testing and they desperately need a decent bug reporting and followup system. It also annoys me the version numbers aren't in the file headers.

I use an I2C Re-drivers: PCA9601 and am driving the VCN410 with a clock frequency of 833 KHz over a 1 meter piece of flat phone cable.

Bosch and Vishay both supply drivers for there devices which only require pointers to the I2C low level driver commands, read write etc.

I wrote a driver that can use blocking commands or DMA deferred interrupt processing. I have never used the blocking commands as I always use FeeRTOS unless the project is a trivial real time system where speed is the priority and there are no complex comms.

I use the same low level HAL driver code with both devices.

The HAL Section of the I2C Driver for the the VCNL4010 is shown below:

#ifdef USE_DMA_I2C_1_ON
/**************************** I2C Helper Functions *****************************/
 
/* Non Blocking functions for use with FreeRTOS */
/********************************* Write To Prox Probe *****************************/
 /*	\Brief: The function is used as I2C bus write
 *	\Return : Status of the I2C write
 *	\param dev_addr : The device address of the sensor
 *	\param reg_addr : Address of the first register, will data is going to be written
 *	\param reg_data : Data to be written
 *	\param cnt : The no of bytes of data to write
 */
__attribute__((section(".Tim2itcm"))) void I2C_Write_DMA(uint8_t i2C_address, char *txBuff, uint16_t Size)
{
	osSemaphoreAcquire(i2c_Prox_Tx_IRQSemHandle, 0);
	#if PRINTF_ON == 1 & INC_PROXTASKHANDLER_H_DEBUG == 1
	c1++;
 printf("I2C_Write_DMA: c1 = %d\n", c1);
	#endif
 
	while (__HAL_I2C_GET_FLAG(&I2C_HAND_1, I2C_FLAG_BUSY) == SET)
	{
		i2cWriteDelayCount++;
	}
 
	
	#if USE_DCACHE_ON == 1 && USE_DCACHE_WITH_I2C1 == 1
	SCB_CleanDCache_by_Addr((uint32_t *)&txBuff, Size);
	#endif
	
 
	/* Write I2C data */
	if (HAL_I2C_Master_Transmit_DMA(&I2C_HAND_1, (uint16_t)i2C_address, (uint8_t*)txBuff, (uint16_t)Size) != HAL_OK)
	{
		return; // HAL_I2C_ERR;
	}		
	
	if (osSemaphoreAcquire(i2c_Prox_Tx_IRQSemHandle, 10 * portTICK_PERIOD_MS) == osErrorTimeout)
	{
		return; // I2C_Error;
	}
}
 
 
/********************************* Read From VCNL40x0 *****************************/
 /*	\Brief: The function is used as I2C bus read
 *	\Return : Status of the I2C read
 *	\param dev_addr : The device address of the sensor
 *	\param reg_addr : Address of the first register, will data is going to be read
 *	\param reg_data : Pointer to data buffer
 *	\param cnt : Size Amount of data to be read
 */
__attribute__((section(".Tim2itcm"))) void I2C_Read_DMA(uint8_t i2C_address, char *rxBuff, uint16_t Size)
{
 
	osSemaphoreAcquire(i2c_Prox_Rx_IRQSemHandle, 0);
	
	#if PRINTF_ON == 1
 printf("Start I2C Read\n");
	#endif
	
	I2C_TimeoutCount = 2;
	I2C_TimeoutError = 0;
 
 
	while (__HAL_I2C_GET_FLAG(&I2C_HAND_1, I2C_FLAG_BUSY) == SET)
	{
		i2cReadDelayCount++;
	}
 
	/* Read from Prox Probe */
	if (HAL_I2C_Master_Receive_DMA(&I2C_HAND_1, (uint16_t)i2C_address, (uint8_t*)rxBuff, (uint16_t)Size) != HAL_OK)
	{
		#if PRINTF_ON == 1
	 printf("HAL Master Receive Error\n");
		#endif
		return; // DEVICE_E_COMM_FAIL;
	}
	
	
	if (osSemaphoreAcquire(i2c_Prox_Rx_IRQSemHandle, 1000 * portTICK_PERIOD_MS) == osErrorTimeout)
	{
		#if PRINTF_ON == 1
		printf("i2c_Prox_Rx_IRQSemHandle Sem Timeout\n");
		#endif
		return; // I2C_Error;
	}
	#if PRINTF_ON == 1
	printf("Start I2C Read\n");
	#endif
}
#else

I have attached my source files for both devices as zips.

I am in the process of removing the CMSIS OS calls and moving to native FreeRTOS so there's a bit of a mixture in the example above.

Anyway I hope this helps.

Best regards

Rob