2  * MIPI DSI Bus
42  * DOC: dsi helpers
44  * These functions contain some common logic and helpers to deal with MIPI DSI
47  * Helpers are provided for a number of standard MIPI DSI command as well as a
53 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_device_match()  local
59 	/* compare DSI device and driver names */  in mipi_dsi_device_match()
60 	if (!strcmp(dsi->name, drv->name))  in mipi_dsi_device_match()
68 	const struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_uevent()  local
76 		       dsi->name);  in mipi_dsi_uevent()
93 	.name = "mipi-dsi",
100  * of_find_mipi_dsi_device_by_node() - find the MIPI DSI device matching a
104  * Return: A pointer to the MIPI DSI device corresponding to @np or NULL if no
119 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_dev_release()  local
122 	kfree(dsi);  in mipi_dsi_dev_release()
131 	struct mipi_dsi_device *dsi;  in mipi_dsi_device_alloc()  local
133 	dsi = kzalloc(sizeof(*dsi), GFP_KERNEL);  in mipi_dsi_device_alloc()
134 	if (!dsi)  in mipi_dsi_device_alloc()
137 	dsi->host = host;  in mipi_dsi_device_alloc()
138 	dsi->dev.bus = &mipi_dsi_bus_type;  in mipi_dsi_device_alloc()
139 	dsi->dev.parent = host->dev;  in mipi_dsi_device_alloc()
140 	dsi->dev.type = &mipi_dsi_device_type;  in mipi_dsi_device_alloc()
142 	device_initialize(&dsi->dev);  in mipi_dsi_device_alloc()
144 	return dsi;  in mipi_dsi_device_alloc()
147 static int mipi_dsi_device_add(struct mipi_dsi_device *dsi)  in mipi_dsi_device_add()  argument
149 	struct mipi_dsi_host *host = dsi->host;  in mipi_dsi_device_add()
151 	dev_set_name(&dsi->dev, "%s.%d", dev_name(host->dev),  dsi->channel);  in mipi_dsi_device_add()
153 	return device_add(&dsi->dev);  in mipi_dsi_device_add()
190  * mipi_dsi_device_register_full - create a MIPI DSI device
191  * @host: DSI host to which this device is connected
192  * @info: pointer to template containing DSI device information
194  * Create a MIPI DSI device by using the device information provided by
198  * A pointer to the newly created MIPI DSI device, or, a pointer encoded
205 	struct mipi_dsi_device *dsi;  in mipi_dsi_device_register_full()  local
218 	dsi = mipi_dsi_device_alloc(host);  in mipi_dsi_device_register_full()
219 	if (IS_ERR(dsi)) {  in mipi_dsi_device_register_full()
220 		drm_err(host, "failed to allocate DSI device %ld\n",  in mipi_dsi_device_register_full()
221 			PTR_ERR(dsi));  in mipi_dsi_device_register_full()
222 		return dsi;  in mipi_dsi_device_register_full()
225 	device_set_node(&dsi->dev, of_fwnode_handle(info->node));  in mipi_dsi_device_register_full()
226 	dsi->channel = info->channel;  in mipi_dsi_device_register_full()
227 	strscpy(dsi->name, info->type, sizeof(dsi->name));  in mipi_dsi_device_register_full()
229 	ret = mipi_dsi_device_add(dsi);  in mipi_dsi_device_register_full()
231 		drm_err(host, "failed to add DSI device %d\n", ret);  in mipi_dsi_device_register_full()
232 		kfree(dsi);  in mipi_dsi_device_register_full()
236 	return dsi;  in mipi_dsi_device_register_full()
241  * mipi_dsi_device_unregister - unregister MIPI DSI device
242  * @dsi: DSI peripheral device
244 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi)  in mipi_dsi_device_unregister()  argument
246 	device_unregister(&dsi->dev);  in mipi_dsi_device_unregister()
252 	struct mipi_dsi_device *dsi = arg;  in devm_mipi_dsi_device_unregister()  local
254 	mipi_dsi_device_unregister(dsi);  in devm_mipi_dsi_device_unregister()
258  * devm_mipi_dsi_device_register_full - create a managed MIPI DSI device
259  * @dev: device to tie the MIPI-DSI device lifetime to
260  * @host: DSI host to which this device is connected
261  * @info: pointer to template containing DSI device information
263  * Create a MIPI DSI device by using the device information provided by
271  * A pointer to the newly created MIPI DSI device, or, a pointer encoded
279 	struct mipi_dsi_device *dsi;  in devm_mipi_dsi_device_register_full()  local
282 	dsi = mipi_dsi_device_register_full(host, info);  in devm_mipi_dsi_device_register_full()
283 	if (IS_ERR(dsi))  in devm_mipi_dsi_device_register_full()
284 		return dsi;  in devm_mipi_dsi_device_register_full()
288 				       dsi);  in devm_mipi_dsi_device_register_full()
292 	return dsi;  in devm_mipi_dsi_device_register_full()
300  * of_find_mipi_dsi_host_by_node() - find the MIPI DSI host matching a
305  * A pointer to the MIPI DSI host corresponding to @node or NULL if no
348 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_remove_device_fn()  local
350 	if (dsi->attached)  in mipi_dsi_remove_device_fn()
351 		mipi_dsi_detach(dsi);  in mipi_dsi_remove_device_fn()
352 	mipi_dsi_device_unregister(dsi);  in mipi_dsi_remove_device_fn()
368  * mipi_dsi_attach - attach a DSI device to its DSI host
369  * @dsi: DSI peripheral
371 int mipi_dsi_attach(struct mipi_dsi_device *dsi)  in mipi_dsi_attach()  argument
373 	const struct mipi_dsi_host_ops *ops = dsi->host->ops;  in mipi_dsi_attach()
379 	ret = ops->attach(dsi->host, dsi);  in mipi_dsi_attach()
383 	dsi->attached = true;  in mipi_dsi_attach()
390  * mipi_dsi_detach - detach a DSI device from its DSI host
391  * @dsi: DSI peripheral
393 int mipi_dsi_detach(struct mipi_dsi_device *dsi)  in mipi_dsi_detach()  argument
395 	const struct mipi_dsi_host_ops *ops = dsi->host->ops;  in mipi_dsi_detach()
397 	if (WARN_ON(!dsi->attached))  in mipi_dsi_detach()
403 	dsi->attached = false;  in mipi_dsi_detach()
405 	return ops->detach(dsi->host, dsi);  in mipi_dsi_detach()
411 	struct mipi_dsi_device *dsi = arg;  in devm_mipi_dsi_detach()  local
413 	mipi_dsi_detach(dsi);  in devm_mipi_dsi_detach()
417  * devm_mipi_dsi_attach - Attach a MIPI-DSI device to its DSI Host
418  * @dev: device to tie the MIPI-DSI device attachment lifetime to
419  * @dsi: DSI peripheral
428 			 struct mipi_dsi_device *dsi)  in devm_mipi_dsi_attach()  argument
432 	ret = mipi_dsi_attach(dsi);  in devm_mipi_dsi_attach()
436 	ret = devm_add_action_or_reset(dev, devm_mipi_dsi_detach, dsi);  in devm_mipi_dsi_attach()
444 static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,  in mipi_dsi_device_transfer()  argument
447 	const struct mipi_dsi_host_ops *ops = dsi->host->ops;  in mipi_dsi_device_transfer()
452 	if (dsi->mode_flags & MIPI_DSI_MODE_LPM)  in mipi_dsi_device_transfer()
455 	return ops->transfer(dsi->host, msg);  in mipi_dsi_device_transfer()
460  * @type: MIPI DSI data type of the packet
498  * @type: MIPI DSI data type of the packet
531  *     DSI protocol
532  * @packet: pointer to a DSI packet structure
584  * @dsi: DSI peripheral device
588 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)  in mipi_dsi_shutdown_peripheral()  argument
591 		.channel = dsi->channel,  in mipi_dsi_shutdown_peripheral()
596 	int ret = mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_shutdown_peripheral()
604  * @dsi: DSI peripheral device
608 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi)  in mipi_dsi_turn_on_peripheral()  argument
611 		.channel = dsi->channel,  in mipi_dsi_turn_on_peripheral()
616 	int ret = mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_turn_on_peripheral()
626  * @dsi: DSI peripheral device
631 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,  in mipi_dsi_set_maximum_return_packet_size()  argument
636 		.channel = dsi->channel,  in mipi_dsi_set_maximum_return_packet_size()
641 	int ret = mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_set_maximum_return_packet_size()
649  * @dsi: DSI peripheral device
657 int mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable)  in mipi_dsi_compression_mode()  argument
662 		.channel = dsi->channel,  in mipi_dsi_compression_mode()
667 	int ret = mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_compression_mode()
675  * @dsi: DSI peripheral device
682 int mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,  in mipi_dsi_picture_parameter_set()  argument
686 		.channel = dsi->channel,  in mipi_dsi_picture_parameter_set()
691 	int ret = mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_picture_parameter_set()
699  * @dsi: DSI peripheral device
709 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,  in mipi_dsi_generic_write()  argument
713 		.channel = dsi->channel,  in mipi_dsi_generic_write()
736 	return mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_generic_write()
742  * @dsi: DSI peripheral device
754 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,  in mipi_dsi_generic_read()  argument
758 		.channel = dsi->channel,  in mipi_dsi_generic_read()
782 	return mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_generic_read()
788  * @dsi: DSI peripheral device
798 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_write_buffer()  argument
802 		.channel = dsi->channel,  in mipi_dsi_dcs_write_buffer()
824 	return mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_dcs_write_buffer()
830  * @dsi: DSI peripheral device
841 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,  in mipi_dsi_dcs_write()  argument
863 	err = mipi_dsi_dcs_write_buffer(dsi, tx, size);  in mipi_dsi_dcs_write()
874  * @dsi: DSI peripheral device
881 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,  in mipi_dsi_dcs_read()  argument
885 		.channel = dsi->channel,  in mipi_dsi_dcs_read()
893 	return mipi_dsi_device_transfer(dsi, &msg);  in mipi_dsi_dcs_read()
899  * @dsi: DSI peripheral device
903 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_nop()  argument
907 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_NOP, NULL, 0);  in mipi_dsi_dcs_nop()
917  * @dsi: DSI peripheral device
921 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_soft_reset()  argument
925 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SOFT_RESET, NULL, 0);  in mipi_dsi_dcs_soft_reset()
936  * @dsi: DSI peripheral device
941 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode)  in mipi_dsi_dcs_get_power_mode()  argument
945 	err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_POWER_MODE, mode,  in mipi_dsi_dcs_get_power_mode()
961  * @dsi: DSI peripheral device
966 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format)  in mipi_dsi_dcs_get_pixel_format()  argument
970 	err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_PIXEL_FORMAT, format,  in mipi_dsi_dcs_get_pixel_format()
986  * @dsi: DSI peripheral device
990 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_enter_sleep_mode()  argument
994 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_SLEEP_MODE, NULL, 0);  in mipi_dsi_dcs_enter_sleep_mode()
1005  * @dsi: DSI peripheral device
1009 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_exit_sleep_mode()  argument
1013 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_EXIT_SLEEP_MODE, NULL, 0);  in mipi_dsi_dcs_exit_sleep_mode()
1024  * @dsi: DSI peripheral device
1028 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_set_display_off()  argument
1032 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_OFF, NULL, 0);  in mipi_dsi_dcs_set_display_off()
1043  * @dsi: DSI peripheral device
1047 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_set_display_on()  argument
1051 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_ON, NULL, 0);  in mipi_dsi_dcs_set_display_on()
1062  * @dsi: DSI peripheral device
1068 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,  in mipi_dsi_dcs_set_column_address()  argument
1074 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_COLUMN_ADDRESS, payload,  in mipi_dsi_dcs_set_column_address()
1086  * @dsi: DSI peripheral device
1092 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,  in mipi_dsi_dcs_set_page_address()  argument
1098 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PAGE_ADDRESS, payload,  in mipi_dsi_dcs_set_page_address()
1110  * @dsi: DSI peripheral device
1114 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi)  in mipi_dsi_dcs_set_tear_off()  argument
1118 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_OFF, NULL, 0);  in mipi_dsi_dcs_set_tear_off()
1129  * @dsi: DSI peripheral device
1134 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_set_tear_on()  argument
1140 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_ON, &value,  in mipi_dsi_dcs_set_tear_on()
1152  * @dsi: DSI peripheral device
1157 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format)  in mipi_dsi_dcs_set_pixel_format()  argument
1161 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PIXEL_FORMAT, &format,  in mipi_dsi_dcs_set_pixel_format()
1173  * @dsi: DSI peripheral device
1178 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)  in mipi_dsi_dcs_set_tear_scanline()  argument
1183 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_SCANLINE, payload,  in mipi_dsi_dcs_set_tear_scanline()
1195  * @dsi: DSI peripheral device
1200 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_set_display_brightness()  argument
1206 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,  in mipi_dsi_dcs_set_display_brightness()
1218  * @dsi: DSI peripheral device
1223 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_get_display_brightness()  argument
1228 	err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,  in mipi_dsi_dcs_get_display_brightness()
1244  * @dsi: DSI peripheral device
1249 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_set_display_brightness_large()  argument
1255 	err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,  in mipi_dsi_dcs_set_display_brightness_large()
1267  * @dsi: DSI peripheral device
1272 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,  in mipi_dsi_dcs_get_display_brightness_large()  argument
1278 	err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,  in mipi_dsi_dcs_get_display_brightness_large()
1296 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_drv_probe()  local
1298 	return drv->probe(dsi);  in mipi_dsi_drv_probe()
1304 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_drv_remove()  local
1306 	drv->remove(dsi);  in mipi_dsi_drv_remove()
1314 	struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);  in mipi_dsi_drv_shutdown()  local
1316 	drv->shutdown(dsi);  in mipi_dsi_drv_shutdown()
1320  * mipi_dsi_driver_register_full() - register a driver for DSI devices
1321  * @drv: DSI driver structure
1344  * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1345  * @drv: DSI driver structure
1362 MODULE_DESCRIPTION("MIPI DSI Bus");