seperation of I2C and SPI driver

Author: amsret1

Kbuild

@@ -1,5 +1,7 @@
 EXTRA_CFLAGS := -I$(src)/aos_tmf8829_core_library/src
 EXTRA_CFLAGS += -I$(src)
 EXTRA_CFLAGS += -Wno-unused-function # -Wextra
+#EXTRA_CFLAGS += -DUSE_I2C
+EXTRA_CFLAGS += -DUSE_SPI
 obj-$(CONFIG_SENSORS_TMF8829) += tmf8829.o
 tmf8829-y = tmf8829_driver.o ./aos_tmf8829_core_library/src/tmf8829.o ams_i2c.o tmf8829_shim.o tmf8829_hex_interpreter.o

Makefile

@@ -18,7 +18,8 @@ all:
 	dtc -@ -I dts -O dtb -o ./arch/arm/boot/dts/tmf8829-overlay-fpc-polled.dtbo ./arch/arm/boot/dts/tmf8829-overlay-fpc-polled.dts
 	dtc -@ -I dts -O dtb -o ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi.dtbo ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi.dts
 	dtc -@ -I dts -O dtb -o ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi-polled.dtbo ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi-polled.dts
-
+	dtc -@ -I dts -O dtb -o ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi-polled-fusion.dtbo ./arch/arm/boot/dts/tmf8829-overlay-fpc-spi-polled-fusion.dts
+	
 modules:
 	$(MAKE) -C $(LINUX_SRC) M=$$PWD $@
 

README.md

@@ -3,27 +3,65 @@
 ## Description
 
 This file describes the installation of the tmf8829 linux reference driver, and how to use it.
+There is also a description for using python files contained in the tmf8829_zeromq_server_linux folder.
+
+Information regarding the TMF8829 time of flight device can be found at:
+https://ams-osram.com/products/sensor-solutions/direct-time-of-flight-sensors-dtof/ams-tmf8829-48x32-multi-zone-time-of-flight-sensor
 
 ### Compilation
 
 The compilation was done with the ams-Osram provided image bookworm_4v0.
 Linux version 6.1.73-ams #1 Mon Apr 22 19:32:02 BST 2024 2024 armv6l
 
+The reference driver could be build as I2C or SPI driver.
+See EXTRA_CFLAGS in Kbuild.
+For I2C use: EXTRA_CFLAGS += -DUSE_I2C
+For SPI use: EXTRA_CFLAGS += -DUSE_SPI
+
+For compilation on the bookworm image use the command:
+- make CONFIG_SENSORS_TMF8829=m
+
+For compilation on an other image it is required to adapt the linux source path.
+The linux sources could be found in the folder "/usr/src".
+The LINUX_SRC path in the file Makefile must be adapted, or the LINUX_SRC path must be specified in the command.
+
+Examples:
+- make CONFIG_SENSORS_TMF8829=m LINUX_SRC=/usr/src/linux-$(uname -r)
+- make CONFIG_SENSORS_TMF8829=m LINUX_SRC=/usr/src/linux-headers-$(uname -r)
+- make CONFIG_SENSORS_TMF8829=m LINUX_SRC=/usr/src/linux-6.1.73-ams
+
+### Linux Driver Sources
+
+The Linux Driver Sources could be found on GITHUB:
+
+- https://github.com/ams-OSRAM/tmf8829_driver_linux
+
+with
+
+- git clone https://github.com/ams-OSRAM/tmf8829_driver_linux.git
+
+or from the TMF8829 product site.
+
 ## Files
 
-Overlay Files
+Overlay Files <br>
 The device tree overlay files for the tmf8829 prototyped on the Raspberry Pi zero.
+<br>
     - tmf8829-overlay-fpc.dts
         evm configuration with flex printed circuit, EN gpio and INT gpio, I2C
+<br>
     - tmf8829-overlay-fpc-polled.dts
         evm configuration with flex printed circuit, EN gpio and INT register polled, I2C
+<br>
     - tmf8829-overlay-fpc-spi.dts
         evm configuration with flex printed circuit, EN gpio and INT gpio, SPI
+<br>
     - tmf8829-overlay-fpc-spi-polled.dts
         evm configuration with flex printed circuit, EN gpio and INT register polled, SPI
 
 Module File
-    - tmf8829.ko
+    - tmf8829.ko for SPI
+    - tmf8829.ko for I2C
 
 ams Raspberry USB Sensorbridge
     - ams-usb-sensorbridge.service
@@ -66,6 +104,7 @@ Configuration of Raspberry Pi zero:
      - tmf8829-overlay-fpc-spi.dtbo for spi communication
      - tmf8829-overlay-fpc-polled.dtbo for i2c communication and int register polling
      - tmf8829-overlay-fpc-spi-polled.dtbo for spi communication and int register polling
+     - tmf8829-overlay-fpc-spi-polled-fusion.dts special overlay file
 
    - Hex File ( if required )
 
@@ -91,14 +130,18 @@ Configuration of Raspberry Pi zero:
    <br>or
    - ./tmf8829_install_spi_polled_int.sh
 
-7. Optional:<br> If the python zmq server sources will be installed
+7. for I2C driver:
+   - open /boot/firmware/config.txt
+   uncomment line dtoverlay=gpio-ir-tx,gpio_pin=25
+
+8. Optional:<br> If the python zmq server sources will be installed
    and the server should be started at boot time, enable the zmq service.
 
    - systemctl enable tmf8829_zmq_server.service
 
-8. sync
+9. sync
 
-9. reboot (reboot system)
+10. reboot (reboot system)
 
 ## General commands on the Raspberry Pi
 
@@ -143,11 +186,7 @@ Configuration of Raspberry Pi zero:
 
     - ps -ef
 
-8. Makefile command for TMF8829
-
-    - make CONFIG_SENSORS_TMF8829=m
-
-9. The overlay file could be changed
+8. The overlay file could be changed
 
     - copy overlay file to boot directory
 
@@ -167,24 +206,25 @@ Configuration of Raspberry Pi zero:
 
     - echo "dtoverlay=tmf8829-overlay" >> /boot/firmware/config.txt
 
-10. Change and see log level
+9. Change and see log level
 
     - echo <level> > /proc/sys/kernel/printk
     - cat /proc/sys/kernel/printk
 
-11. See temperature and cpu frequency
+10. See temperature and cpu frequency
 
     - vcgencmd measure_temp
     - vcgencmd measure_clock arm
 
-12. Change raspberry configuration
+11. Change raspberry configuration
 
     - sudo raspi-config
 
-13. see the running services
+12. see the running services
 
     - systemctl
-14. start / stop the running tmf8829 zmq service
+
+13. start / stop the running tmf8829 zmq service
 
     - systemctl start tmf8829_zmq_server.service
     - systemctl stop tmf8829_zmq_server.service
@@ -202,7 +242,9 @@ https://www.raspberrypi.com/documentation/computers/raspberry-pi.html
 
 ## System File System
 
-- I2C Bus 0 (fpc): /sys/class/i2c-adapter/i2c-0/0-0041/
+File System location:
+- I2C Driver: I2C Bus 0 (fpc): /sys/class/i2c-adapter/i2c-0/0-0041/
+- SPI Driver: SPI Dev 0: /sys/class/spi_master/spi0/spi0.0/
 
 ### Common Attributes (tmf8829_common)
 
@@ -366,7 +408,7 @@ Attributes:
     - FrameID:
         - TMF8829_COM_RESULT__measurement_res_frame  0xAA /**< measurement result frame */
         - TMF8829_COM_RESULT__measurement_hist_frame 0xBB /**< measurement histogram frame */
-        - TMF8829_COM_RESULT__measurement_header      0xFD /**< measurement frame header only; for debug only should never occur in result frame */
+        - TMF8829_COM_RESULT__measurement_header     0xFD /**< measurement frame header only; for debug only should never occur in result frame */
         - TMF8829_COM_RESULT__error_frame            0xFE /**< error frame */
         - TMF8829_COM_RESULT__no_frame               0xFF /**< no frame / unhandled interrupt */
     -  The clock correction factor is only available for result frames in Q1.15 numbering format.
@@ -439,7 +481,7 @@ The logger description README.md in the folder /home/ams/tmf8829_zeromq_server_l
  python ./tmf8829_zeromq_client.py
  ```
 
-
 ### GUI
 
 The TMF8829 EVM GUI could be used to see the results on a pc.
+This software could be downloaded from the product site. See section "Software".

ReleaseNotes.txt

@@ -2,6 +2,21 @@
 Release Notes TMF8829 Linux Driver
 ===================================================
 ---------------------------------------------------
+- 2v4
+---------------------------------------------------
+- separation of I2C and SPI driver.
+  In Kbuild the flag USE_I2C or DUSE_SPI is used
+- In probe function, the Irq Error is not reported anymore.
+  This error does not have an impact on the driver and is misleading.
+---------------------------------------------------
+- 2v3
+---------------------------------------------------
+- in probe do tof_register_spi_driver earlier.
+- Stop Measurement check for standby-timed mode
+- powerup_select to RAM option at tmf8829DownloadFirmware
+- wakeup with wait time and cpu ready check
+- Int polling mode fix
+---------------------------------------------------
 - 2v2
 ---------------------------------------------------
 - new hex file

aos_tmf8829_core_library/src/tmf8829.c

@@ -496,7 +496,7 @@ int8_t tmf8829BootloaderCmdI2cOff ( tmf8829Driver * driver )
 }
 
 // execute command to set the RAM address pointer for RAM read/writes
-static int8_t tmf8829BootloaderSetRamAddr ( tmf8829Driver * driver, uint32_t addr )
+int8_t tmf8829BootloaderSetRamAddr ( tmf8829Driver * driver, uint32_t addr )
 {
   driver->dataBuffer[0] = TMF8829_COM_BL_CMD_STAT_ADDR_RAM;
   driver->dataBuffer[1] = 4; // payload
@@ -510,7 +510,7 @@ static int8_t tmf8829BootloaderSetRamAddr ( tmf8829Driver * driver, uint32_t add
 }
 
 // writes to both CPU RAMs in parallel
-static int8_t tmf8829BootloaderWriteRamBoth ( tmf8829Driver * driver, uint8_t len )
+int8_t tmf8829BootloaderWriteRamBoth ( tmf8829Driver * driver, uint8_t len )
 {
   driver->dataBuffer[0] = TMF8829_COM_BL_CMD_STAT_W_RAM_BOTH;
   driver->dataBuffer[1] = len; // payload
@@ -535,13 +535,34 @@ static int8_t tmf8829BootloaderWriteFifoBoth ( tmf8829Driver * driver, uint32_t
 }
 
 //to start the down-loaded measurement application
-static int8_t tmf8829BootloaderStartRamApp ( tmf8829Driver * driver )
+int8_t tmf8829BootloaderStartRamApp ( tmf8829Driver * driver )
 { 
   driver->dataBuffer[0] = TMF8829_COM_BL_CMD_STAT_START_RAM_APP;
   txReg( driver, driver->i2cSlaveAddress, TMF8829_COM_REG_CMD_STAT, 1, driver->dataBuffer );
   return tmf8829CheckRegister( driver, TMF8829_COM_REG_APP_ID, TMF8829_COM_APP_ID__application, 1, BL_CMD_START_RAM_APP_MS );
 }
 
+int8_t tmf8829BootloaderStartRamAppAndPowerOn ( tmf8829Driver * driver )
+{
+  int8_t stat = BL_SUCCESS_OK;
+  stat = tmf8829BootloaderStartRamApp( driver );
+  if ( stat == BL_SUCCESS_OK )
+  {
+    if ( driver->logLevel >=TMF8829_LOG_LEVEL_INFO )
+    {
+      PRINT_STR( "Ram started" );
+      PRINT_LN( );
+    }
+    // Enable Register with RAM in powerup_select
+    driver->dataBuffer[0] = 0; // clear before reading
+    rxReg( driver, driver->i2cSlaveAddress, ENABLE, 1, driver->dataBuffer );
+    driver->dataBuffer[0] = driver->dataBuffer[0] & ( ~TMF8829_ENABLE__powerup_select__MASK ); // clear powerup_select
+    driver->dataBuffer[0] = driver->dataBuffer[0] | ( ENABLE__powerup_select__RAM << ENABLE__powerup_select__SHIFT ); // select RAM
+    txReg( driver, driver->i2cSlaveAddress, ENABLE, 1, driver->dataBuffer ); // set PON bit in enable register
+  }
+  return stat;
+}
+
 int8_t tmf8829DownloadFirmware ( tmf8829Driver * driver, uint32_t imageStartAddress, const uint8_t * image, int32_t imageSizeInBytes, uint8_t useFifo )
 {
   uint32_t idx = 0;
@@ -726,7 +747,7 @@ static void tmf8829ClockCorrectionAddPair ( tmf8829Driver * driver, uint32_t hos
     PRINT_LN( );                              
   }                                             
 
-}  
+}
 
 int8_t tmf8829ReadDeviceInfo ( tmf8829Driver * driver )
 {

aos_tmf8829_core_library/src/tmf8829.h

@@ -313,6 +313,20 @@ int8_t tmf8829BootloaderCmdSpiOff( tmf8829Driver * driver );
  */ 
 int8_t tmf8829BootloaderCmdI2cOff( tmf8829Driver * driver );
 
+/** @brief Function set ram address to write
+ * @param driver ... pointer to an instance of the tmf8829 driver data structure
+ * @param addr ..... ram address to write
+ * @return Function returns APP_SUCCESS_OK if successfully set ram address, else  it returns an error APP_ERROR_TIMEOUT
+ */
+int8_t tmf8829BootloaderSetRamAddr ( tmf8829Driver * driver, uint32_t addr );
+
+/** @brief Function writes data to both CPU RAMs in parallel
+ * @param driver ... pointer to an instance of the tmf8829 driver data structure
+ * @param len ...... number of bytes to write
+ * @return Function returns APP_SUCCESS_OK if successfully write data to ram, else  it returns an error APP_ERROR_TIMEOUT
+ */
+int8_t tmf8829BootloaderWriteRamBoth ( tmf8829Driver * driver, uint8_t len );
+
 // ------------------------------- convenience functions --------------------------------------------
 
 /** @brief Convert 4 bytes in little endian format into an uint32_t
@@ -335,6 +349,18 @@ void tmf8829SetUint16( uint16_t value, uint8_t * data );
 
 // ------------------------------- bootloader functions --------------------------------------------
 
+/** @brief Function starts ram application
+ * @param driver ... pointer to an instance of the tmf8829 driver data structure
+ * @return Function returns APP_SUCCESS_OK if successfully start ram application, else  it returns an error APP_ERROR_*
+ */
+int8_t tmf8829BootloaderStartRamApp ( tmf8829Driver * driver );
+
+/** @brief Function starts ram application and enable Register with RAM in powerup_select
+ * @param driver ... pointer to an instance of the tmf8829 driver data structure
+ * @return Function returns APP_SUCCESS_OK if successfully start ram application, else  it returns an error APP_ERROR_*
+ */
+int8_t tmf8829BootloaderStartRamAppAndPowerOn ( tmf8829Driver * driver );
+
 /** @brief  Function to download the firmware image that was linked against the firmware (tmf8829_image.{h,c} files)
  * The function tmf8829BootloaderStartRamApp is executed after successful download.
  * powerup_select in the ENABLE register to RAM
@@ -350,7 +376,6 @@ int8_t tmf8829DownloadFirmware( tmf8829Driver * driver, uint32_t imageStartAddre
 // ------------------------------- application functions --------------------------------------------
 
 // Application functions are only available after a successful firmware download and a successful start of the ram app.
-
 /** @brief Function reads complete device information
  * @param driver ... pointer to an instance of the tmf8829 driver data structure
  * @return Function returns APP_SUCCESS_OK if successfully read the complete device information, else  it returns an error APP_ERROR_* 

arch/arm/boot/dts/tmf8829-overlay-fpc-spi-polled-fusion.dts

@@ -0,0 +1,70 @@
+/*
+ ************************************************************************************
+ * Copyright (c) [2025] ams-OSRAM AG                                                *
+ *                                                                                  *
+ * SPDX-License-Identifier: GPL-2.0 OR MIT                                          *
+ *                                                                                  *
+ * For the full license texts, see LICENSES-GPL-2.0.txt or LICENSES-MIT.TXT.        *
+ ************************************************************************************
+*/
+
+/* Definitions for tmf8829 time-of-flight sensor from ams AG
+ *
+ * Compile:
+ * dtc -@ -I dts -O dtb -o tmf8829-overlay-fpc_spi_polled.dtbo tmf8829-overlay-fpc_spi_polled.dts
+ */
+
+/dts-v1/;
+/plugin/;
+
+/ {
+  compatible = "brcm,bcm2835","brcm,bcm2708","brcm,bcm2709";
+
+
+  fragment@0 {
+    target = <&gpio>;
+    __overlay__ {
+      tmf8829_pins: tmf8829_pins {
+        brcm,pins = <16>; /*enable (CAM_IO1->GPIO40)*/
+        brcm,function = <1>; /*enable output*/
+        brcm,pull = <0>; /*enable pull-down on CE*/
+      };
+    };
+  };
+
+  fragment@1 {
+      target = <&spidev0>;
+      __overlay__ {
+      status = "disabled";
+      };
+  };  
+  fragment@2 {
+      target = <&spidev1>;
+      __overlay__ {
+      status = "disabled";
+      };
+  };
+
+  fragment@3 {
+    target = <&spi0>;
+    __overlay__ {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      status = "okay";
+
+      tmf8829_spi@0 {
+        compatible = "ams,tmf8829_spi";
+        reg = <0>;
+        spi-max-frequency = <5000000>;
+		
+		pinctrl-names = "default";
+        pinctrl-0 = <&tmf8829_pins>;
+        tof,tof_poll_period = <0xA>; /*poll period (100 usec)*/
+        enable-gpios = <&gpio 16 0>; /* CAM_GPIO1 on header*/
+		
+      };
+    };
+  };
+  
+};
+