Add --dumb-dcs parameter to stop interpretation of DCS commands

Author: stephan-gh

driver.py

@@ -433,7 +433,7 @@ def generate_driver(p: Panel, options: Options) -> None:
 	# Generate command sequences early
 	for cmd in p.cmds.values():
 		for c in cmd.seq:
-			c.generated = c.type.generate(c.payload)
+			c.generated = c.type.generate(c.payload, options)
 			cmd.generated += c.generated
 
 	options.gpios = []

generator.py

@@ -12,3 +12,4 @@ class Options:
 	backlight: bool
 	backlight_gpio: bool
 	ignore_wait: int
+	dumb_dcs: bool

lmdpdg.py

@@ -42,6 +42,13 @@ def generate(p: Panel, options: generator.Options) -> None:
 	Some device trees add a useless 1ms wait after each command, making the driver
 	unnecessarily verbose.
 """)
+parser.add_argument('--dumb-dcs', dest='dumb_dcs', action='store_true', help="""
+	Do not attempt to interpret DCS commands. Some panels use arbitrary DCS commands
+	to write to registers, which conflict with commands specified in the MIPI DCS
+	specification. This option stops interpretation of DCS commands, except for
+	enter/exit_sleep_mode and set_display_on/off (which should be supported by
+	any panel ideally).
+""")
 args = parser.parse_args(namespace=generator.Options())
 
 for f in args.dtb:

mipi.py

@@ -15,6 +15,8 @@
 from enum import IntEnum, unique, Enum
 from typing import List, Optional, Union, Tuple
 
+from generator import Options
+
 import wrap
 
 
@@ -128,13 +130,16 @@ def get_params(self, b: bytes):
 		return params
 
 	@staticmethod
-	def find(payload: bytes) -> Optional[DCSCommand]:
+	def find(payload: bytes, dumb: bool) -> Optional[DCSCommand]:
 		try:
 			dcs = DCSCommand(payload[0])
 		except ValueError:
 			# Not a specified DCS command
 			return None
 
+		if dumb and dcs not in DCSCommand._DUMB_ALLOWED:
+			return None
+
 		if dcs.nargs and len(payload) - 1 not in dcs.nargs:
 			# Argument count does not match. Weird.
 			expected_args = " or ".join(str(i) for i in dcs.nargs)
@@ -153,6 +158,10 @@ def find(payload: bytes) -> Optional[DCSCommand]:
 		return dcs
 
 
+DCSCommand._DUMB_ALLOWED = [DCSCommand.ENTER_SLEEP_MODE, DCSCommand.EXIT_SLEEP_MODE,
+							DCSCommand.SET_DISPLAY_ON, DCSCommand.SET_DISPLAY_OFF]
+
+
 def _generate_checked_call(method: str, args: List[str], description: str) -> str:
 	return f'''\
 {wrap.join(f'	ret = {method}(', ',', ');', args)}
@@ -169,17 +178,17 @@ def _generate_checked_call(method: str, args: List[str], description: str) -> st
 }
 
 
-def _generate_generic_write(t: Transaction, payload: bytes) -> str:
+def _generate_generic_write(t: Transaction, payload: bytes, options: Options) -> str:
 	# TODO: Warn when downstream uses LONG_WRITE but mainline would use SHORT
 	params = _get_params_hex(payload)
 	params.insert(0, 'dsi')
 	return wrap.join('\tdsi_generic_write_seq(', ',', ');', params, force=2)
 
 
-def _generate_dcs_write(t: Transaction, payload: bytes) -> str:
+def _generate_dcs_write(t: Transaction, payload: bytes, options: Options) -> str:
 	# TODO: Warn when downstream uses LONG_WRITE but mainline would use SHORT
 
-	dcs = DCSCommand.find(payload)
+	dcs = DCSCommand.find(payload, options.dumb_dcs)
 	if dcs and dcs.method:
 		return _generate_checked_call(dcs.method, dcs.get_params(payload[1:]), dcs.description)
 
@@ -191,7 +200,7 @@ def _generate_dcs_write(t: Transaction, payload: bytes) -> str:
 	return wrap.join('\tdsi_dcs_write_seq(', ',', ');', params, force=2)
 
 
-def _generate_peripheral(t: Transaction, payload: bytes) -> str:
+def _generate_peripheral(t: Transaction, payload: bytes, options: Options) -> str:
 	if t == Transaction.TURN_ON_PERIPHERAL:
 		return _generate_checked_call('mipi_dsi_turn_on_peripheral', ['dsi'], t.description)
 	elif t == Transaction.SHUTDOWN_PERIPHERAL:
@@ -200,7 +209,7 @@ def _generate_peripheral(t: Transaction, payload: bytes) -> str:
 		raise ValueError(t)
 
 
-def _generate_fallback(t: Transaction, payload: bytes) -> str:
+def _generate_fallback(t: Transaction, payload: bytes, options: Options) -> str:
 	raise ValueError(t.name + ' is not supported')
 
 
@@ -270,5 +279,5 @@ def identifier(self):
 	def description(self):
 		return self.name.lower().replace('_', ' ')
 
-	def generate(self, payload: bytes) -> str:
-		return self._generate(self, payload)
+	def generate(self, payload: bytes, options: Options) -> str:
+		return self._generate(self, payload, options)