Use new MIPI DSI _multi() calls for better error handling

Not all of the functions exist upstream yet, e.g.

 - mipi_dsi_dcs_set_tear_off_multi()
 - mipi_dsi_shutdown_peripheral_multi()

are currently missing. These will need to be added upstream.

Author: stephan-gh

driver.py

@@ -103,6 +103,19 @@ def msleep(m: int) -> str:
 		return f"usleep_range({u}, {u + 1000})"
 
 
+# msleep(< 20) will possibly sleep up to 20ms
+# In this case, usleep_range should be used
+def dsi_msleep(m: int) -> str:
+	if m >= 20:
+		return f"mipi_dsi_msleep(&dsi_ctx, {m})"
+	else:
+		# It's hard to say what a good range would be...
+		# Downstream uses usleep_range(m * 1000, m * 1000) but that doesn't quite sound great
+		# Sleep for up to 1ms longer for now
+		u = m * 1000
+		return f"mipi_dsi_usleep_range(&dsi_ctx, {u}, {u + 1000})"
+
+
 def generate_reset(p: Panel, options: Options) -> str:
 	if not p.reset_seq:
 		return ''
@@ -126,21 +139,14 @@ def generate_commands(p: Panel, options: Options, cmd_name: str) -> str:
 	s = f'''\
 static int {p.short_id}_{cmd_name}(struct {p.short_id} *ctx)
 {{
+	struct mipi_dsi_multi_context dsi_ctx = {{ .dsi = ctx->dsi }};
 '''
-	variables = ['struct mipi_dsi_device *dsi = ctx->dsi']
-	if '(dev, ' in cmd.generated:
-		variables.append('struct device *dev = &dsi->dev')
-	if 'ret = ' in cmd.generated:
-		variables.append('int ret')
-
-	for v in variables:
-		s += f'\t{v};\n'
 
 	if p.cmds['on'].state != p.cmds['off'].state:
 		if cmd.state == CommandSequence.State.LP_MODE:
-			s += '\n\tdsi->mode_flags |= MIPI_DSI_MODE_LPM;\n'
+			s += '\n\tctx->dsi->mode_flags |= MIPI_DSI_MODE_LPM;\n'
 		elif cmd.state == CommandSequence.State.HS_MODE:
-			s += '\n\tdsi->mode_flags &= ~MIPI_DSI_MODE_LPM;\n'
+			s += '\n\tctx->dsi->mode_flags &= ~MIPI_DSI_MODE_LPM;\n'
 
 	block = True
 	for c in cmd.seq:
@@ -150,10 +156,10 @@ def generate_commands(p: Panel, options: Options, cmd_name: str) -> str:
 
 		s += c.generated + '\n'
 		if c.wait and c.wait > options.ignore_wait:
-			s += f'\t{msleep(c.wait)};\n'
+			s += f'\t{dsi_msleep(c.wait)};\n'
 
 	s += '''
-	return 0;
+	return dsi_ctx.accum_err;
 }
 '''
 	return s

mipi.py

@@ -62,8 +62,8 @@ def get_params(b: bytes) -> List[str]:
 # MIPI DCS commands
 @unique
 class DCSCommand(Enum):
-	NOP = 0x00, 0, 'mipi_dsi_dcs_nop'
-	SOFT_RESET = 0x01, 0, 'mipi_dsi_dcs_soft_reset'
+	NOP = 0x00, 0, 'mipi_dsi_dcs_nop_multi'
+	SOFT_RESET = 0x01, 0, 'mipi_dsi_dcs_soft_reset_multi'
 	# GET_COMPRESSION_MODE = 0x03,
 	# GET_DISPLAY_ID = 0x04,
 	# GET_ERROR_COUNT_ON_DSI = 0x05,
@@ -77,40 +77,40 @@ class DCSCommand(Enum):
 	# GET_DISPLAY_MODE = 0x0D,
 	# GET_SIGNAL_MODE = 0x0E,
 	# GET_DIAGNOSTIC_RESULT = 0x0F,
-	ENTER_SLEEP_MODE = 0x10, 0, 'mipi_dsi_dcs_enter_sleep_mode'
-	EXIT_SLEEP_MODE = 0x11, 0, 'mipi_dsi_dcs_exit_sleep_mode'
+	ENTER_SLEEP_MODE = 0x10, 0, 'mipi_dsi_dcs_enter_sleep_mode_multi'
+	EXIT_SLEEP_MODE = 0x11, 0, 'mipi_dsi_dcs_exit_sleep_mode_multi'
 	ENTER_PARTIAL_MODE = 0x12, 0,
 	ENTER_NORMAL_MODE = 0x13, 0,
 	# GET_IMAGE_CHECKSUM_RGB = 0x14,
 	# GET_IMAGE_CHECKSUM_CT = 0x15,
 	EXIT_INVERT_MODE = 0x20, 0,
 	ENTER_INVERT_MODE = 0x21, 0,
 	SET_GAMMA_CURVE = 0x26, 1,
-	SET_DISPLAY_OFF = 0x28, 0, 'mipi_dsi_dcs_set_display_off'
-	SET_DISPLAY_ON = 0x29, 0, 'mipi_dsi_dcs_set_display_on'
-	SET_COLUMN_ADDRESS = 0x2A, 4, 'mipi_dsi_dcs_set_column_address', _get_params_int(2, 'big')
-	SET_PAGE_ADDRESS = 0x2B, 4, 'mipi_dsi_dcs_set_page_address', _get_params_int(2, 'big')
+	SET_DISPLAY_OFF = 0x28, 0, 'mipi_dsi_dcs_set_display_off_multi'
+	SET_DISPLAY_ON = 0x29, 0, 'mipi_dsi_dcs_set_display_on_multi'
+	SET_COLUMN_ADDRESS = 0x2A, 4, 'mipi_dsi_dcs_set_column_address_multi', _get_params_int(2, 'big')
+	SET_PAGE_ADDRESS = 0x2B, 4, 'mipi_dsi_dcs_set_page_address_multi', _get_params_int(2, 'big')
 	WRITE_MEMORY_START = 0x2C,
 	WRITE_LUT = 0x2D,
 	READ_MEMORY_START = 0x2E,
 	SET_PARTIAL_ROWS = 0x30,
 	SET_PARTIAL_COLUMNS = 0x31,
 	SET_SCROLL_AREA = 0x33, 6,
-	SET_TEAR_OFF = 0x34, 0, 'mipi_dsi_dcs_set_tear_off'
-	SET_TEAR_ON = 0x35, 1, 'mipi_dsi_dcs_set_tear_on', TearMode.get_params
+	SET_TEAR_OFF = 0x34, 0, 'mipi_dsi_dcs_set_tear_off_multi'
+	SET_TEAR_ON = 0x35, 1, 'mipi_dsi_dcs_set_tear_on_multi', TearMode.get_params
 	SET_ADDRESS_MODE = 0x36, 1,
 	SET_SCROLL_START = 0x37, 2,
 	EXIT_IDLE_MODE = 0x38, 0,
 	ENTER_IDLE_MODE = 0x39, 0,
-	SET_PIXEL_FORMAT = 0x3A, 1, 'mipi_dsi_dcs_set_pixel_format'
+	SET_PIXEL_FORMAT = 0x3A, 1, 'mipi_dsi_dcs_set_pixel_format_multi'
 	WRITE_MEMORY_CONTINUE = 0x3C,
 	SET_3D_CONTROL = 0x3D,
 	READ_MEMORY_CONTINUE = 0x3E,
 	# GET_3D_CONTROL = 0x3F,
 	SET_VSYNC_TIMING = 0x40
-	SET_TEAR_SCANLINE = 0x44, 2, 'mipi_dsi_dcs_set_tear_scanline', _get_params_int(2, 'big')
+	SET_TEAR_SCANLINE = 0x44, 2, 'mipi_dsi_dcs_set_tear_scanline_multi', _get_params_int(2, 'big')
 	GET_SCANLINE = 0x45,
-	SET_DISPLAY_BRIGHTNESS = 0x51, (1, 2), 'mipi_dsi_dcs_set_display_brightness', _get_params_int(2, 'little')
+	SET_DISPLAY_BRIGHTNESS = 0x51, (1, 2), 'mipi_dsi_dcs_set_display_brightness_multi', _get_params_int(2, 'little')
 	# GET_DISPLAY_BRIGHTNESS = 0x52,
 	WRITE_CONTROL_DISPLAY = 0x53, 1,
 	# GET_CONTROL_DISPLAY = 0x54,
@@ -136,13 +136,9 @@ def __new__(cls, value: int, nargs: Union[int, Tuple[int]] = (), method: str = N
 	def identifier(self):
 		return 'MIPI_DCS_' + self.name
 
-	@property
-	def description(self):
-		return self.name.lower().replace('_', ' ')
-
 	def get_params(self, b: bytes):
 		params = self._get_params(b)
-		params.insert(0, 'dsi')
+		params.insert(0, '&dsi_ctx')
 		return params
 
 	@staticmethod
@@ -178,50 +174,45 @@ def find(payload: bytes, dumb: bool) -> Optional[DCSCommand]:
 							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)}
-	if (ret < 0) {{
-		dev_err(dev, "Failed to {description}: %d\\n", ret);
-		return ret;
-	}}\
-'''
+def _generate_call(method: str, args: List[str]) -> str:
+	return wrap.join(f'\t{method}(', ',', ');', args)
 
 
 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('\tmipi_dsi_generic_write_seq(', ',', ');', params, force=2)
+	params.insert(0, '&dsi_ctx')
+	return wrap.join('\tmipi_dsi_generic_write_seq_multi(', ',', ');', params, force=2)
 
 
 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, options.dumb_dcs)
 	if dcs and dcs.method:
-		return _generate_checked_call(dcs.method, dcs.get_params(payload[1:]), dcs.description)
+		return _generate_call(dcs.method, dcs.get_params(payload[1:]))
 
 	params = _get_params_hex(payload)
 	if dcs:
 		params[0] = dcs.identifier
-	params.insert(0, 'dsi')
+	params.insert(0, '&dsi_ctx')
 
-	return wrap.join('\tmipi_dsi_dcs_write_seq(', ',', ');', params, force=2)
+	return wrap.join('\tmipi_dsi_dcs_write_seq_multi(', ',', ');', params, force=2)
 
 
 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)
+		return _generate_call('mipi_dsi_turn_on_peripheral_multi', ['&dsi_ctx'])
 	elif t == Transaction.SHUTDOWN_PERIPHERAL:
-		return _generate_checked_call('mipi_dsi_shutdown_peripheral', ['dsi'], t.description)
+		return _generate_call('mipi_dsi_shutdown_peripheral_multi', ['&dsi_ctx'])
 	else:
 		raise ValueError(t)
 
 
 def _generate_compression_mode(t: Transaction, payload: bytes, options: Options) -> str:
-	return _generate_checked_call('mipi_dsi_compression_mode', ['dsi', str(bool(payload[0])).lower()],
-								  'set compression mode')
+	return _generate_call('mipi_dsi_compression_mode_ext_multi',
+			['&dsi_ctx', str(bool(payload[0])).lower(),
+			'MIPI_DSI_COMPRESSION_DSC', '0']) # TODO: Do we need something != 0?
 
 
 def _generate_ignore(t: Transaction, payload: bytes, options: Options) -> str:
@@ -297,10 +288,6 @@ def __new__(cls, value: int, max_args: int = -1, generate=_generate_fallback) ->
 	def identifier(self):
 		return 'MIPI_DSI_' + self.name
 
-	@property
-	def description(self):
-		return self.name.lower().replace('_', ' ')
-
 	@property
 	def is_long(self):
 		# From mipi_dsi_packet_format_is_long()