[driver] Rename SSD1306 driver to ssd1306.i2c

Author: rleh

README.md

@@ -792,7 +792,7 @@ your specific needs.
 <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-qmc5883l">QMC5883L</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-sh1106-i2c">SH1106-I2C</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>

src/modm/driver/display/sh1106.hpp renamed to src/modm/driver/display/sh1106_i2c.hpp

@@ -11,7 +11,7 @@
 
 #pragma once
 
-#include "ssd1306.hpp"
+#include "ssd1306_i2c.hpp"
 
 namespace modm
 {
@@ -26,10 +26,10 @@ namespace modm
  * @ingroup modm_driver_sh1106
  */
 template<class I2cMaster, uint8_t Height = 64>
-class Sh1106 : public Ssd1306<I2cMaster, Height>
+class Sh1106I2c : public Ssd1306I2c<I2cMaster, Height>
 {
 public:
-	Sh1106(uint8_t address = 0x3C) : Ssd1306<I2cMaster, Height>(address) {}
+	Sh1106I2c(uint8_t address = 0x3C) : Ssd1306I2c<I2cMaster, Height>(address) {}
 
 protected:
 	modm::ResumableResult<void>
@@ -39,13 +39,10 @@ class Sh1106 : public Ssd1306<I2cMaster, Height>
 
 		this->transaction_success = true;
 
-		this->commandBuffer[0] = ssd1306::AdressingCommands::HigherColumnStartAddress;
-		this->commandBuffer[1] = 0x02;
-
 		for (page = 0; page < Height / 8; page++)
 		{
-			this->commandBuffer[2] = 0xB0 | page;
-			this->transaction_success &= RF_CALL(this->writeCommands(3));
+			this->commandBuffer[0] = uint8_t(ssd1306::AdressingCommands::PageStartAddress) | page;
+			this->transaction_success &= RF_CALL(this->writeCommands(1));
 
 			RF_WAIT_UNTIL(
 				this->transaction.configureDisplayWrite((uint8_t*)&this->buffer[page], 128));
@@ -62,14 +59,14 @@ class Sh1106 : public Ssd1306<I2cMaster, Height>
 	{
 		RF_BEGIN();
 		// Default on Power-up - can be omitted
-		this->commandBuffer[0] = ssd1306::AdressingCommands::MemoryMode;
-		this->commandBuffer[1] = ssd1306::MemoryMode::PAGE;
+		this->commandBuffer[0] = uint8_t(ssd1306::AdressingCommands::MemoryMode);
+		this->commandBuffer[1] = uint8_t(ssd1306::MemoryMode::PAGE);
 		this->transaction_success &= RF_CALL(this->writeCommands(2));
 		RF_END();
 	}
 
 private:
-	size_t page;
+	uint8_t page;
 };
 
 }  // namespace modm

src/modm/driver/display/sh1106.lb renamed to src/modm/driver/display/sh1106_i2c.lb

@@ -12,13 +12,13 @@
 
 
 def init(module):
-    module.name = ":driver:sh1106"
-    module.description = "SH1106 Display"
+    module.name = ":driver:sh1106.i2c"
+    module.description = "SH1106 Display in I2C mode"
 
 def prepare(module, options):
-    module.depends(":driver:ssd1306")
+    module.depends(":driver:ssd1306.i2c")
     return True
 
 def build(env):
     env.outbasepath = "modm/src/modm/driver/display"
-    env.copy("sh1106.hpp")
+    env.copy("sh1106_i2c.hpp")

src/modm/driver/display/ssd1306.hpp

@@ -1,7 +1,5 @@
 /*
- * Copyright (c) 2014, 2016-2017, Sascha Schade
- * Copyright (c) 2014-2016, 2018, Niklas Hauser
- * Copyright (c) 2021, Thomas Sommer
+ * Copyright (c) 2023, Raphael Lehmann
  *
  * This file is part of the modm project.
  *
@@ -11,181 +9,6 @@
  */
 // ----------------------------------------------------------------------------
 
-#ifndef MODM_SSD1306_HPP
-#define MODM_SSD1306_HPP
-
-#include <modm/architecture/interface/i2c_device.hpp>
-#include <modm/architecture/utils.hpp>
-#include <modm/processing/timer.hpp>
-#include <modm/ui/display/monochrome_graphic_display_vertical.hpp>
-
-#include "ssd1306_register.hpp"
-
-namespace modm
-{
-
-/// @ingroup modm_driver_ssd1306
-struct ssd1306 : public ssd1306_register
-{
-public:
-	enum class
-	ScrollStep : uint8_t
-	{
-		Frames2 = 0b111,
-		Frames3 = 0b100,
-		Frames4 = 0b101,
-		Frames5 = 0b000,
-		Frames25 = 0b110,
-		Frames64 = 0b001,
-		Frames128 = 0b010,
-		Frames256 = 0b011
-	};
-
-	enum class
-	ScrollDirection : uint8_t
-	{
-		Right = HorizontalScrollRight,
-		Left = HorizontalScrollLeft,
-		// RightBottom = VerticalAndHorizontalScrollRight,
-		// LeftBottom = VerticalAndHorizontalScrollLeft,
-	};
-
-	enum class
-	DisplayMode : uint8_t
-	{
-		Normal = NormalDisplay,
-		Inverted = InvertedDisplay
-	};
-
-public:
-	/// @cond
-	class Ssd1306_I2cWriteTransaction : public modm::I2cWriteTransaction
-	{
-	public:
-		Ssd1306_I2cWriteTransaction(uint8_t address);
-
-		bool
-		configureDisplayWrite(const uint8_t *buffer, std::size_t size);
-
-	protected:
-		virtual Writing
-		writing() override;
-
-		virtual void
-		detaching(modm::I2c::DetachCause cause) override;
-
-		inline bool
-		isWritable()
-		{ return !transfer_active; }
-
-	private:
-		uint8_t transfer_type;
-		bool transfer_active;
-	};
-	/// @endcond
-};  // struct ssd1306
-
-/**
- * Driver for SSD1306 based OLED-displays using I2C.
- * This display is only rated to be driven with 400kHz, which limits
- * the frame rate to about 40Hz.
- *
- * @author	Niklas Hauser
- * @author	Thomas Sommer
- * @ingroup	modm_driver_ssd1306
- */
-template<class I2cMaster, uint8_t Height = 64>
-class Ssd1306 : public ssd1306,
-				public MonochromeGraphicDisplayVertical<128, Height>,
-				public I2cDevice<I2cMaster, 3, ssd1306::Ssd1306_I2cWriteTransaction>
-{
-	static_assert((Height == 64) or (Height == 32), "Display height must be either 32 or 64 pixel!");
-
-public:
-	Ssd1306(uint8_t address = 0x3C);
-
-	/// Pings the display
-	bool inline pingBlocking()
-	{ return RF_CALL_BLOCKING(this->ping()); }
-
-	/// initializes for 3V3 with charge-pump
-	bool inline initializeBlocking()
-	{ return RF_CALL_BLOCKING(initialize()); }
-
-	/// Update the display with the content of the RAM buffer.
-	void
-	update() override
-	{ RF_CALL_BLOCKING(startWriteDisplay()); }
-
-	/// Use this method to synchronize writing to the displays buffer
-	/// to avoid tearing.
-	/// @return	`true` if the frame buffer is not being copied to the display
-	bool isWritable()
-	{ return this->transaction.isWriteable(); }
-
-	// MARK: - TASKS
-	/// initializes for 3V3 with charge-pump asynchronously
-	modm::ResumableResult<bool>
-	initialize();
-
-	// starts a frame transfer and waits for completion
-	virtual modm::ResumableResult<bool>
-	writeDisplay();
-
-	modm::ResumableResult<bool>
-	setDisplayMode(DisplayMode mode = DisplayMode::Normal)
-	{
-		commandBuffer[0] = mode;
-		return writeCommands(1);
-	}
-
-	modm::ResumableResult<bool>
-	setContrast(uint8_t contrast = 0xCE)
-	{
-		commandBuffer[0] = FundamentalCommands::ContrastControl;
-		commandBuffer[1] = contrast;
-		return writeCommands(2);
-	}
-
-	/**
-	 * \param orientation	glcd::Orientation::Landscape0 or glcd::Orientation::Landscape180
-	 */
-	modm::ResumableResult<bool>
-	setOrientation(glcd::Orientation orientation);
-
-	modm::ResumableResult<bool>
-	configureScroll(uint8_t origin, uint8_t size, ScrollDirection direction, ScrollStep steps);
-
-	modm::ResumableResult<bool>
-	enableScroll()
-	{
-		commandBuffer[0] = ScrollingCommands::EnableScroll;
-		return writeCommands(1);
-	}
-
-	modm::ResumableResult<bool>
-	disableScroll()
-	{
-		commandBuffer[0] = ScrollingCommands::DisableScroll;
-		return writeCommands(1);
-	}
-
-protected:
-	modm::ResumableResult<bool>
-	writeCommands(std::size_t length);
-
-	virtual modm::ResumableResult<void>
-	initializeMemoryMode();
-
-	virtual modm::ResumableResult<void>
-	startWriteDisplay();
-
-	uint8_t commandBuffer[7];
-	bool transaction_success;
-};
-
-}  // namespace modm
-
-#include "ssd1306_impl.hpp"
-
-#endif  // MODM_SSD1306_HPP
+// DEPRECATE 2024q4
+#warning "Use 'ssd1306_i2c.hpp' instead!"
+#include "ssd1306_i2c.hpp"