SAMx7x I2C driver + more I2C EEPROM support

README.md

@@ -365,7 +365,7 @@ Please [discover modm's peripheral drivers for your specific device][discover].
 <td align="center">✅</td>
 <td align="center">○</td>
 <td align="center">○</td>
-<td align="center">○</td>
+<td align="center">✅</td>
 <td align="center">○</td>
 <td align="center">✅</td>
 <td align="center">✅</td>
@@ -692,93 +692,94 @@ you specific needs.
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ads816x">ADS816x</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ams5915">AMS5915</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-apa102">APA102</a></td>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-at24mac402">AT24MAC402</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-block-device-spi-flash">SPI Flash</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-bme280">BME280</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-bme280">BME280</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-bmp085">BMP085</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-bno055">BNO055</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-cat24aa">CAT24AA</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-drv832x_spi">DRV832X</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ds1302">DS1302</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-ds1631">DS1631</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-ds1631">DS1631</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ds18b20">DS18B20</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ea_dog">EA-DOG</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-encoder_input">Encoder Input</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-encoder_input-bitbang">Encoder Input BitBang</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-encoder_output-bitbang">Encoder Output BitBang</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-ft245">FT245</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-ft245">FT245</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ft6x06">FT6x06</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-gpio_sampler">Gpio Sampler</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-hclax">HCLAx</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-hd44780">HD44780</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-hmc58x">HMC58x</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-hmc6343">HMC6343</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-hmc6343">HMC6343</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-hx711">HX711</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-i2c-eeprom">I2C-EEPROM</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ili9341">ILI9341</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-is31fl3733">IS31FL3733</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-itg3200">ITG3200</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-l3gd20">L3GD20</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-l3gd20">L3GD20</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lan8720a">LAN8720A</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lawicel">LAWICEL</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lis302dl">LIS302DL</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lis3dsh">LIS3DSH</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lis3mdl">LIS3MDL</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-lm75">LM75</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-lm75">LM75</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lp503x">LP503x</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lsm303a">LSM303A</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lsm6ds33">LSM6DS33</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-lsm6dso">LSM6DSO</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ltc2984">LTC2984</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-max31855">MAX31855</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-max31855">MAX31855</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-max6966">MAX6966</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-max7219">MAX7219</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-mcp23x17">MCP23x17</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-mcp2515">MCP2515</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-mcp7941x">MCP7941x</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-mcp990x">MCP990X</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-mcp990x">MCP990X</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-mmc5603">MMC5603</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ms5611">MS5611</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ms5837">MS5837</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-nokia5110">NOKIA5110</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-nrf24">NRF24</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-parallel_tft_display">TFT-DISPLAY</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-parallel_tft_display">TFT-DISPLAY</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-pat9125el">PAT9125EL</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-pca8574">PCA8574</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-pca9535">PCA9535</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-pca9548a">PCA9548A</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-pca9685">PCA9685</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-sh1106">SH1106</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-sh1106">SH1106</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-siemens_s65">SIEMENS-S65</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-siemens_s75">SIEMENS-S75</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-sk6812">SK6812</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-sk9822">SK9822</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ssd1306">SSD1306</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-st7586s">ST7586S</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-st7586s">ST7586S</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-st7789">ST7789</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-stts22h">STTS22H</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-stusb4500">STUSB4500</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-sx1276">SX1276</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-tcs3414">TCS3414</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-tcs3472">TCS3472</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-tcs3472">TCS3472</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-tlc594x">TLC594x</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp102">TMP102</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp12x">TMP12x</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-tmp175">TMP175</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-touch2046">TOUCH2046</a></td>
-<td align="center"><a href="https://modm.io/reference/module/modm-driver-vl53l0">VL53L0</a></td>
 </tr><tr>
+<td align="center"><a href="https://modm.io/reference/module/modm-driver-vl53l0">VL53L0</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-vl6180">VL6180</a></td>
 <td align="center"><a href="https://modm.io/reference/module/modm-driver-ws2812">WS2812</a></td>
 </tr>

examples/samv71_xplained_ultra/i2c-eeprom/at24mac402/main.cpp

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2023, Christopher Durand
+ *
+ * This file is part of the modm project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+// ----------------------------------------------------------------------------
+
+#include <modm/board.hpp>
+#include <modm/driver/storage/at24mac402.hpp>
+#include <array>
+
+using namespace Board;
+using namespace modm::literals;
+
+// On board AT24MAC402 EEPROM driver example
+int main()
+{
+	Board::initialize();
+
+	MODM_LOG_INFO << "AT24MAC402 Test" << modm::endl;
+
+	/* Defined in board support package:
+	 * using Sda = GpioA3;
+	 * using Scl = GpioA4;
+	 * using I2c = I2cMaster0;
+	 */
+	I2c::connect<Sda::Twd, Scl::Twck>();
+	I2c::initialize<SystemClock, 400_kHz>();
+
+	// address 0x57 = 1 0 1 0 A0 A1 A2
+	// with A0 = A1 = A2 = 1 connected to 3.3V
+	modm::At24Mac402<I2c> eeprom{0x57};
+
+	MODM_LOG_INFO << "EEPROM detected: " << RF_CALL_BLOCKING(eeprom.ping()) << "\n\n";
+
+	std::array<uint8_t, 6> buffer{};
+
+	// Read pre-programmed MAC address
+	bool readSuccess = RF_CALL_BLOCKING(eeprom.readMac(buffer));
+	if (readSuccess)
+	{
+		MODM_LOG_INFO.printf("MAC: %02x:%02x:%02x:%02x:%02x:%02x\n\n",
+							 buffer[0], buffer[1], buffer[2],
+							 buffer[3], buffer[4], buffer[5]);
+
+	}
+	else
+	{
+		MODM_LOG_INFO << "Reading MAC address from EEPROM failed!\n";
+	}
+
+	// Write 4 data bytes to address 0x80
+	/*constexpr std::array<uint8_t, 4> data = {0xAA, 0xBB, 0xCC, 0xDD};
+	const bool writeSuccess = RF_CALL_BLOCKING(eeprom.write(0x80, data.data(), 4));
+	MODM_LOG_INFO << "write successful: " << writeSuccess << "\n\n";*/
+
+	// Read 4 data bytes from address 0x80
+	// retry read until device responds after finishing previous write
+	readSuccess = false;
+	while (!readSuccess)
+	{
+		readSuccess = RF_CALL_BLOCKING(eeprom.read(0x80, buffer.data(), buffer.size()));
+	}
+	MODM_LOG_INFO.printf("data: 0x%02x 0x%02x 0x%02x 0x%02x\n\n",
+						 buffer[0], buffer[1], buffer[2], buffer[3]);
+
+	while (true)
+	{
+		Led0::toggle();
+		Led1::toggle();
+		modm::delay(500ms);
+	}
+
+	return 0;
+}

examples/samv71_xplained_ultra/i2c-eeprom/at24mac402/project.xml

@@ -0,0 +1,11 @@
+<library>
+  <extends>modm:samv71-xplained-ultra</extends>
+  <options>
+    <option name="modm:build:build.path">../../../../build/samv71_xplained_ultra/i2c_eeprom_at24mac402</option>
+  </options>
+  <modules>
+    <module>modm:build:scons</module>
+    <module>modm:driver:at24mac402</module>
+    <module>modm:platform:i2c:0</module>
+  </modules>
+</library>

examples/samv71_xplained_ultra/i2c-eeprom/generic/main.cpp

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2023, Christopher Durand
+ *
+ * This file is part of the modm project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+// ----------------------------------------------------------------------------
+
+#include <modm/board.hpp>
+#include <modm/driver/storage/i2c_eeprom.hpp>
+#include <array>
+
+using namespace Board;
+using namespace modm::literals;
+
+// Generic I2C EEPROM driver example using on-board 2 kBit AT24MAC402 EEPROM
+// For extended AT24MAC402 functionality see specific example and documentation.
+int main()
+{
+	Board::initialize();
+
+	MODM_LOG_INFO << "I2C EEPROM Test" << modm::endl;
+
+	/* Defined in board support package:
+	 * using Sda = GpioA3;
+	 * using Scl = GpioA4;
+	 * using I2c = I2cMaster0;
+	 */
+	I2c::connect<Sda::Twd, Scl::Twck>();
+	I2c::initialize<SystemClock, 400_kHz>();
+
+	// address 0x57 = 1 0 1 0 A0 A1 A2
+	// with A0 = A1 = A2 = 1 connected to 3.3V
+	// 8 bit address width
+	constexpr auto AddressWidth = 1; // use 2 for 16 bit address EEPROMs
+	modm::I2cEeprom<I2c, AddressWidth> eeprom{0x57};
+
+	MODM_LOG_INFO << "EEPROM detected: " << RF_CALL_BLOCKING(eeprom.ping()) << "\n\n";
+
+	// Write 4 data bytes to address 0x80
+	/*constexpr std::array<uint8_t, 4> data = {0xAA, 0xBB, 0xCC, 0xDD};
+	const bool writeSuccess = RF_CALL_BLOCKING(eeprom.write(0x80, data.data(), 4));
+	MODM_LOG_INFO << "write successful: " << writeSuccess << "\n\n";*/
+
+	// Read 4 data bytes from address 0x80
+	std::array<uint8_t, 4> buffer{};
+	bool readSuccess = false;
+	// retry read until device responds after finishing previous write
+	while (!readSuccess)
+	{
+		readSuccess = RF_CALL_BLOCKING(eeprom.read(0x80, buffer.data(), buffer.size()));
+	}
+	MODM_LOG_INFO << "read successful: " << readSuccess << "\n";
+	MODM_LOG_INFO.printf("data: 0x%02x 0x%02x 0x%02x 0x%02x\n\n", buffer[0], buffer[1], buffer[2], buffer[3]);
+
+	while (true)
+	{
+		Led0::toggle();
+		Led1::toggle();
+		modm::delay(500ms);
+	}
+
+	return 0;
+}

examples/samv71_xplained_ultra/i2c-eeprom/generic/project.xml

@@ -0,0 +1,11 @@
+<library>
+  <extends>modm:samv71-xplained-ultra</extends>
+  <options>
+    <option name="modm:build:build.path">../../../../build/samv71_xplained_ultra/i2c_eeprom_generic</option>
+  </options>
+  <modules>
+    <module>modm:build:scons</module>
+    <module>modm:driver:i2c.eeprom</module>
+    <module>modm:platform:i2c:0</module>
+  </modules>
+</library>

src/modm/board/samv71_xplained_ultra/board.hpp

@@ -31,6 +31,7 @@ struct SystemClock
 	static constexpr uint32_t Mck = Frequency / 2;  // 150 MHz max.
 	static constexpr uint32_t Usart1 = Mck;
 	static constexpr uint32_t Spi0 = Mck;
+	static constexpr uint32_t Twihs0 = Mck;
 //	static constexpr uint32_t Usb = 48_MHz;
 
 	static bool inline
@@ -62,6 +63,10 @@ struct Debug
 	using UartRx = GpioA21;
 };
 
+using I2c = I2cMaster0;
+using Sda = GpioA3;
+using Scl = GpioA4;
+
 using LoggerDevice = modm::IODeviceWrapper<Debug::Uart, modm::IOBuffer::BlockIfFull>;
 
 inline void

src/modm/board/samv71_xplained_ultra/module.lb

@@ -19,7 +19,7 @@ def prepare(module, options):
     if not options[":target"].partname == "samv71q21b-aab":
         return False
 
-    module.depends(":debug", ":platform:clockgen", ":platform:gpio", ":platform:core", ":platform:usart:1") #, ":platform:usb")
+    module.depends(":debug", ":platform:clockgen", ":platform:gpio", ":platform:core", ":platform:usart:1", ":platform:i2c:0") #, ":platform:usb")
     return True
 
 def build(env):