4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25 * USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #include <linux/device.h>
29 #include <linux/module.h>
31 #include <linux/of_device.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/slab.h>
35 #include <drm/display/drm_dsc.h>
36 #include <drm/drm_mipi_dsi.h>
37 #include <drm/drm_print.h>
39 #include <video/mipi_display.h>
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
48 * subset of the MIPI DCS command set.
51 static int mipi_dsi_device_match(struct device *dev, struct device_driver *drv)
53 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
55 /* attempt OF style match */
56 if (of_driver_match_device(dev, drv))
59 /* compare DSI device and driver names */
60 if (!strcmp(dsi->name, drv->name))
66 static int mipi_dsi_uevent(const struct device *dev, struct kobj_uevent_env *env)
68 const struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
71 err = of_device_uevent_modalias(dev, env);
75 add_uevent_var(env, "MODALIAS=%s%s", MIPI_DSI_MODULE_PREFIX,
81 static const struct dev_pm_ops mipi_dsi_device_pm_ops = {
82 .runtime_suspend = pm_generic_runtime_suspend,
83 .runtime_resume = pm_generic_runtime_resume,
84 .suspend = pm_generic_suspend,
85 .resume = pm_generic_resume,
86 .freeze = pm_generic_freeze,
87 .thaw = pm_generic_thaw,
88 .poweroff = pm_generic_poweroff,
89 .restore = pm_generic_restore,
92 static const struct bus_type mipi_dsi_bus_type = {
94 .match = mipi_dsi_device_match,
95 .uevent = mipi_dsi_uevent,
96 .pm = &mipi_dsi_device_pm_ops,
100 * of_find_mipi_dsi_device_by_node() - find the MIPI DSI device matching a
102 * @np: device tree node
104 * Return: A pointer to the MIPI DSI device corresponding to @np or NULL if no
105 * such device exists (or has not been registered yet).
107 struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np)
111 dev = bus_find_device_by_of_node(&mipi_dsi_bus_type, np);
113 return dev ? to_mipi_dsi_device(dev) : NULL;
115 EXPORT_SYMBOL(of_find_mipi_dsi_device_by_node);
117 static void mipi_dsi_dev_release(struct device *dev)
119 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
121 of_node_put(dev->of_node);
125 static const struct device_type mipi_dsi_device_type = {
126 .release = mipi_dsi_dev_release,
129 static struct mipi_dsi_device *mipi_dsi_device_alloc(struct mipi_dsi_host *host)
131 struct mipi_dsi_device *dsi;
133 dsi = kzalloc(sizeof(*dsi), GFP_KERNEL);
135 return ERR_PTR(-ENOMEM);
138 dsi->dev.bus = &mipi_dsi_bus_type;
139 dsi->dev.parent = host->dev;
140 dsi->dev.type = &mipi_dsi_device_type;
142 device_initialize(&dsi->dev);
147 static int mipi_dsi_device_add(struct mipi_dsi_device *dsi)
149 struct mipi_dsi_host *host = dsi->host;
151 dev_set_name(&dsi->dev, "%s.%d", dev_name(host->dev), dsi->channel);
153 return device_add(&dsi->dev);
156 #if IS_ENABLED(CONFIG_OF)
157 static struct mipi_dsi_device *
158 of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
160 struct mipi_dsi_device_info info = { };
164 if (of_alias_from_compatible(node, info.type, sizeof(info.type)) < 0) {
165 drm_err(host, "modalias failure on %pOF\n", node);
166 return ERR_PTR(-EINVAL);
169 ret = of_property_read_u32(node, "reg", ®);
171 drm_err(host, "device node %pOF has no valid reg property: %d\n",
173 return ERR_PTR(-EINVAL);
177 info.node = of_node_get(node);
179 return mipi_dsi_device_register_full(host, &info);
182 static struct mipi_dsi_device *
183 of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
185 return ERR_PTR(-ENODEV);
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
195 * mipi_dsi_device_info template
198 * A pointer to the newly created MIPI DSI device, or, a pointer encoded
201 struct mipi_dsi_device *
202 mipi_dsi_device_register_full(struct mipi_dsi_host *host,
203 const struct mipi_dsi_device_info *info)
205 struct mipi_dsi_device *dsi;
209 drm_err(host, "invalid mipi_dsi_device_info pointer\n");
210 return ERR_PTR(-EINVAL);
213 if (info->channel > 3) {
214 drm_err(host, "invalid virtual channel: %u\n", info->channel);
215 return ERR_PTR(-EINVAL);
218 dsi = mipi_dsi_device_alloc(host);
220 drm_err(host, "failed to allocate DSI device %ld\n",
225 device_set_node(&dsi->dev, of_fwnode_handle(info->node));
226 dsi->channel = info->channel;
227 strscpy(dsi->name, info->type, sizeof(dsi->name));
229 ret = mipi_dsi_device_add(dsi);
231 drm_err(host, "failed to add DSI device %d\n", ret);
238 EXPORT_SYMBOL(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)
246 device_unregister(&dsi->dev);
248 EXPORT_SYMBOL(mipi_dsi_device_unregister);
250 static void devm_mipi_dsi_device_unregister(void *arg)
252 struct mipi_dsi_device *dsi = arg;
254 mipi_dsi_device_unregister(dsi);
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
264 * mipi_dsi_device_info template
266 * This is the managed version of mipi_dsi_device_register_full() which
267 * automatically calls mipi_dsi_device_unregister() when @dev is
271 * A pointer to the newly created MIPI DSI device, or, a pointer encoded
274 struct mipi_dsi_device *
275 devm_mipi_dsi_device_register_full(struct device *dev,
276 struct mipi_dsi_host *host,
277 const struct mipi_dsi_device_info *info)
279 struct mipi_dsi_device *dsi;
282 dsi = mipi_dsi_device_register_full(host, info);
286 ret = devm_add_action_or_reset(dev,
287 devm_mipi_dsi_device_unregister,
294 EXPORT_SYMBOL_GPL(devm_mipi_dsi_device_register_full);
296 static DEFINE_MUTEX(host_lock);
297 static LIST_HEAD(host_list);
300 * of_find_mipi_dsi_host_by_node() - find the MIPI DSI host matching a
302 * @node: device tree node
305 * A pointer to the MIPI DSI host corresponding to @node or NULL if no
306 * such device exists (or has not been registered yet).
308 struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node)
310 struct mipi_dsi_host *host;
312 mutex_lock(&host_lock);
314 list_for_each_entry(host, &host_list, list) {
315 if (host->dev->of_node == node) {
316 mutex_unlock(&host_lock);
321 mutex_unlock(&host_lock);
325 EXPORT_SYMBOL(of_find_mipi_dsi_host_by_node);
327 int mipi_dsi_host_register(struct mipi_dsi_host *host)
329 struct device_node *node;
331 for_each_available_child_of_node(host->dev->of_node, node) {
332 /* skip nodes without reg property */
333 if (!of_property_present(node, "reg"))
335 of_mipi_dsi_device_add(host, node);
338 mutex_lock(&host_lock);
339 list_add_tail(&host->list, &host_list);
340 mutex_unlock(&host_lock);
344 EXPORT_SYMBOL(mipi_dsi_host_register);
346 static int mipi_dsi_remove_device_fn(struct device *dev, void *priv)
348 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
351 mipi_dsi_detach(dsi);
352 mipi_dsi_device_unregister(dsi);
357 void mipi_dsi_host_unregister(struct mipi_dsi_host *host)
359 device_for_each_child(host->dev, NULL, mipi_dsi_remove_device_fn);
361 mutex_lock(&host_lock);
362 list_del_init(&host->list);
363 mutex_unlock(&host_lock);
365 EXPORT_SYMBOL(mipi_dsi_host_unregister);
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)
373 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
376 if (!ops || !ops->attach)
379 ret = ops->attach(dsi->host, dsi);
383 dsi->attached = true;
387 EXPORT_SYMBOL(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)
395 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
397 if (WARN_ON(!dsi->attached))
400 if (!ops || !ops->detach)
403 dsi->attached = false;
405 return ops->detach(dsi->host, dsi);
407 EXPORT_SYMBOL(mipi_dsi_detach);
409 static void devm_mipi_dsi_detach(void *arg)
411 struct mipi_dsi_device *dsi = arg;
413 mipi_dsi_detach(dsi);
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
421 * This is the managed version of mipi_dsi_attach() which automatically
422 * calls mipi_dsi_detach() when @dev is unbound.
425 * 0 on success, a negative error code on failure.
427 int devm_mipi_dsi_attach(struct device *dev,
428 struct mipi_dsi_device *dsi)
432 ret = mipi_dsi_attach(dsi);
436 ret = devm_add_action_or_reset(dev, devm_mipi_dsi_detach, dsi);
442 EXPORT_SYMBOL_GPL(devm_mipi_dsi_attach);
444 static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,
445 struct mipi_dsi_msg *msg)
447 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
449 if (!ops || !ops->transfer)
452 if (dsi->mode_flags & MIPI_DSI_MODE_LPM)
453 msg->flags |= MIPI_DSI_MSG_USE_LPM;
455 return ops->transfer(dsi->host, msg);
459 * mipi_dsi_packet_format_is_short - check if a packet is of the short format
460 * @type: MIPI DSI data type of the packet
462 * Return: true if the packet for the given data type is a short packet, false
465 bool mipi_dsi_packet_format_is_short(u8 type)
468 case MIPI_DSI_V_SYNC_START:
469 case MIPI_DSI_V_SYNC_END:
470 case MIPI_DSI_H_SYNC_START:
471 case MIPI_DSI_H_SYNC_END:
472 case MIPI_DSI_COMPRESSION_MODE:
473 case MIPI_DSI_END_OF_TRANSMISSION:
474 case MIPI_DSI_COLOR_MODE_OFF:
475 case MIPI_DSI_COLOR_MODE_ON:
476 case MIPI_DSI_SHUTDOWN_PERIPHERAL:
477 case MIPI_DSI_TURN_ON_PERIPHERAL:
478 case MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM:
479 case MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM:
480 case MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM:
481 case MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM:
482 case MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM:
483 case MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM:
484 case MIPI_DSI_DCS_SHORT_WRITE:
485 case MIPI_DSI_DCS_SHORT_WRITE_PARAM:
486 case MIPI_DSI_DCS_READ:
487 case MIPI_DSI_EXECUTE_QUEUE:
488 case MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE:
494 EXPORT_SYMBOL(mipi_dsi_packet_format_is_short);
497 * mipi_dsi_packet_format_is_long - check if a packet is of the long format
498 * @type: MIPI DSI data type of the packet
500 * Return: true if the packet for the given data type is a long packet, false
503 bool mipi_dsi_packet_format_is_long(u8 type)
506 case MIPI_DSI_NULL_PACKET:
507 case MIPI_DSI_BLANKING_PACKET:
508 case MIPI_DSI_GENERIC_LONG_WRITE:
509 case MIPI_DSI_DCS_LONG_WRITE:
510 case MIPI_DSI_PICTURE_PARAMETER_SET:
511 case MIPI_DSI_COMPRESSED_PIXEL_STREAM:
512 case MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20:
513 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24:
514 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16:
515 case MIPI_DSI_PACKED_PIXEL_STREAM_30:
516 case MIPI_DSI_PACKED_PIXEL_STREAM_36:
517 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12:
518 case MIPI_DSI_PACKED_PIXEL_STREAM_16:
519 case MIPI_DSI_PACKED_PIXEL_STREAM_18:
520 case MIPI_DSI_PIXEL_STREAM_3BYTE_18:
521 case MIPI_DSI_PACKED_PIXEL_STREAM_24:
527 EXPORT_SYMBOL(mipi_dsi_packet_format_is_long);
530 * mipi_dsi_create_packet - create a packet from a message according to the
532 * @packet: pointer to a DSI packet structure
533 * @msg: message to translate into a packet
535 * Return: 0 on success or a negative error code on failure.
537 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
538 const struct mipi_dsi_msg *msg)
543 /* do some minimum sanity checking */
544 if (!mipi_dsi_packet_format_is_short(msg->type) &&
545 !mipi_dsi_packet_format_is_long(msg->type))
548 if (msg->channel > 3)
551 memset(packet, 0, sizeof(*packet));
552 packet->header[0] = ((msg->channel & 0x3) << 6) | (msg->type & 0x3f);
554 /* TODO: compute ECC if hardware support is not available */
557 * Long write packets contain the word count in header bytes 1 and 2.
558 * The payload follows the header and is word count bytes long.
560 * Short write packets encode up to two parameters in header bytes 1
563 if (mipi_dsi_packet_format_is_long(msg->type)) {
564 packet->header[1] = (msg->tx_len >> 0) & 0xff;
565 packet->header[2] = (msg->tx_len >> 8) & 0xff;
567 packet->payload_length = msg->tx_len;
568 packet->payload = msg->tx_buf;
570 const u8 *tx = msg->tx_buf;
572 packet->header[1] = (msg->tx_len > 0) ? tx[0] : 0;
573 packet->header[2] = (msg->tx_len > 1) ? tx[1] : 0;
576 packet->size = sizeof(packet->header) + packet->payload_length;
580 EXPORT_SYMBOL(mipi_dsi_create_packet);
583 * mipi_dsi_shutdown_peripheral() - sends a Shutdown Peripheral command
584 * @dsi: DSI peripheral device
586 * Return: 0 on success or a negative error code on failure.
588 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)
590 struct mipi_dsi_msg msg = {
591 .channel = dsi->channel,
592 .type = MIPI_DSI_SHUTDOWN_PERIPHERAL,
593 .tx_buf = (u8 [2]) { 0, 0 },
596 int ret = mipi_dsi_device_transfer(dsi, &msg);
598 return (ret < 0) ? ret : 0;
600 EXPORT_SYMBOL(mipi_dsi_shutdown_peripheral);
603 * mipi_dsi_turn_on_peripheral() - sends a Turn On Peripheral command
604 * @dsi: DSI peripheral device
606 * Return: 0 on success or a negative error code on failure.
608 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi)
610 struct mipi_dsi_msg msg = {
611 .channel = dsi->channel,
612 .type = MIPI_DSI_TURN_ON_PERIPHERAL,
613 .tx_buf = (u8 [2]) { 0, 0 },
616 int ret = mipi_dsi_device_transfer(dsi, &msg);
618 return (ret < 0) ? ret : 0;
620 EXPORT_SYMBOL(mipi_dsi_turn_on_peripheral);
623 * mipi_dsi_set_maximum_return_packet_size() - specify the maximum size of
624 * the payload in a long packet transmitted from the peripheral back to the
626 * @dsi: DSI peripheral device
627 * @value: the maximum size of the payload
629 * Return: 0 on success or a negative error code on failure.
631 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
634 u8 tx[2] = { value & 0xff, value >> 8 };
635 struct mipi_dsi_msg msg = {
636 .channel = dsi->channel,
637 .type = MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE,
638 .tx_len = sizeof(tx),
641 int ret = mipi_dsi_device_transfer(dsi, &msg);
643 return (ret < 0) ? ret : 0;
645 EXPORT_SYMBOL(mipi_dsi_set_maximum_return_packet_size);
648 * mipi_dsi_compression_mode() - enable/disable DSC on the peripheral
649 * @dsi: DSI peripheral device
650 * @enable: Whether to enable or disable the DSC
652 * Enable or disable Display Stream Compression on the peripheral using the
653 * default Picture Parameter Set and VESA DSC 1.1 algorithm.
655 * Return: 0 on success or a negative error code on failure.
657 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable)
659 /* Note: Needs updating for non-default PPS or algorithm */
660 u8 tx[2] = { enable << 0, 0 };
661 struct mipi_dsi_msg msg = {
662 .channel = dsi->channel,
663 .type = MIPI_DSI_COMPRESSION_MODE,
664 .tx_len = sizeof(tx),
667 int ret = mipi_dsi_device_transfer(dsi, &msg);
669 return (ret < 0) ? ret : 0;
671 EXPORT_SYMBOL(mipi_dsi_compression_mode);
674 * mipi_dsi_picture_parameter_set() - transmit the DSC PPS to the peripheral
675 * @dsi: DSI peripheral device
676 * @pps: VESA DSC 1.1 Picture Parameter Set
678 * Transmit the VESA DSC 1.1 Picture Parameter Set to the peripheral.
680 * Return: 0 on success or a negative error code on failure.
682 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
683 const struct drm_dsc_picture_parameter_set *pps)
685 struct mipi_dsi_msg msg = {
686 .channel = dsi->channel,
687 .type = MIPI_DSI_PICTURE_PARAMETER_SET,
688 .tx_len = sizeof(*pps),
691 int ret = mipi_dsi_device_transfer(dsi, &msg);
693 return (ret < 0) ? ret : 0;
695 EXPORT_SYMBOL(mipi_dsi_picture_parameter_set);
698 * mipi_dsi_generic_write() - transmit data using a generic write packet
699 * @dsi: DSI peripheral device
700 * @payload: buffer containing the payload
701 * @size: size of payload buffer
703 * This function will automatically choose the right data type depending on
704 * the payload length.
706 * Return: The number of bytes transmitted on success or a negative error code
709 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
712 struct mipi_dsi_msg msg = {
713 .channel = dsi->channel,
720 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM;
724 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM;
728 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM;
732 msg.type = MIPI_DSI_GENERIC_LONG_WRITE;
736 return mipi_dsi_device_transfer(dsi, &msg);
738 EXPORT_SYMBOL(mipi_dsi_generic_write);
741 * mipi_dsi_generic_read() - receive data using a generic read packet
742 * @dsi: DSI peripheral device
743 * @params: buffer containing the request parameters
744 * @num_params: number of request parameters
745 * @data: buffer in which to return the received data
746 * @size: size of receive buffer
748 * This function will automatically choose the right data type depending on
749 * the number of parameters passed in.
751 * Return: The number of bytes successfully read or a negative error code on
754 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
755 size_t num_params, void *data, size_t size)
757 struct mipi_dsi_msg msg = {
758 .channel = dsi->channel,
759 .tx_len = num_params,
765 switch (num_params) {
767 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM;
771 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM;
775 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM;
782 return mipi_dsi_device_transfer(dsi, &msg);
784 EXPORT_SYMBOL(mipi_dsi_generic_read);
787 * mipi_dsi_dcs_write_buffer() - transmit a DCS command with payload
788 * @dsi: DSI peripheral device
789 * @data: buffer containing data to be transmitted
790 * @len: size of transmission buffer
792 * This function will automatically choose the right data type depending on
793 * the command payload length.
795 * Return: The number of bytes successfully transmitted or a negative error
798 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
799 const void *data, size_t len)
801 struct mipi_dsi_msg msg = {
802 .channel = dsi->channel,
812 msg.type = MIPI_DSI_DCS_SHORT_WRITE;
816 msg.type = MIPI_DSI_DCS_SHORT_WRITE_PARAM;
820 msg.type = MIPI_DSI_DCS_LONG_WRITE;
824 return mipi_dsi_device_transfer(dsi, &msg);
826 EXPORT_SYMBOL(mipi_dsi_dcs_write_buffer);
829 * mipi_dsi_dcs_write() - send DCS write command
830 * @dsi: DSI peripheral device
832 * @data: buffer containing the command payload
833 * @len: command payload length
835 * This function will automatically choose the right data type depending on
836 * the command payload length.
838 * Return: The number of bytes successfully transmitted or a negative error
841 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
842 const void *data, size_t len)
850 if (len > ARRAY_SIZE(stack_tx) - 1) {
851 tx = kmalloc(size, GFP_KERNEL);
858 /* concatenate the DCS command byte and the payload */
861 memcpy(&tx[1], data, len);
863 err = mipi_dsi_dcs_write_buffer(dsi, tx, size);
870 EXPORT_SYMBOL(mipi_dsi_dcs_write);
873 * mipi_dsi_dcs_read() - send DCS read request command
874 * @dsi: DSI peripheral device
876 * @data: buffer in which to receive data
877 * @len: size of receive buffer
879 * Return: The number of bytes read or a negative error code on failure.
881 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
884 struct mipi_dsi_msg msg = {
885 .channel = dsi->channel,
886 .type = MIPI_DSI_DCS_READ,
893 return mipi_dsi_device_transfer(dsi, &msg);
895 EXPORT_SYMBOL(mipi_dsi_dcs_read);
898 * mipi_dsi_dcs_nop() - send DCS nop packet
899 * @dsi: DSI peripheral device
901 * Return: 0 on success or a negative error code on failure.
903 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi)
907 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_NOP, NULL, 0);
913 EXPORT_SYMBOL(mipi_dsi_dcs_nop);
916 * mipi_dsi_dcs_soft_reset() - perform a software reset of the display module
917 * @dsi: DSI peripheral device
919 * Return: 0 on success or a negative error code on failure.
921 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi)
925 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SOFT_RESET, NULL, 0);
931 EXPORT_SYMBOL(mipi_dsi_dcs_soft_reset);
934 * mipi_dsi_dcs_get_power_mode() - query the display module's current power
936 * @dsi: DSI peripheral device
937 * @mode: return location for the current power mode
939 * Return: 0 on success or a negative error code on failure.
941 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode)
945 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_POWER_MODE, mode,
956 EXPORT_SYMBOL(mipi_dsi_dcs_get_power_mode);
959 * mipi_dsi_dcs_get_pixel_format() - gets the pixel format for the RGB image
960 * data used by the interface
961 * @dsi: DSI peripheral device
962 * @format: return location for the pixel format
964 * Return: 0 on success or a negative error code on failure.
966 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format)
970 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_PIXEL_FORMAT, format,
981 EXPORT_SYMBOL(mipi_dsi_dcs_get_pixel_format);
984 * mipi_dsi_dcs_enter_sleep_mode() - disable all unnecessary blocks inside the
985 * display module except interface communication
986 * @dsi: DSI peripheral device
988 * Return: 0 on success or a negative error code on failure.
990 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi)
994 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_SLEEP_MODE, NULL, 0);
1000 EXPORT_SYMBOL(mipi_dsi_dcs_enter_sleep_mode);
1003 * mipi_dsi_dcs_exit_sleep_mode() - enable all blocks inside the display
1005 * @dsi: DSI peripheral device
1007 * Return: 0 on success or a negative error code on failure.
1009 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi)
1013 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_EXIT_SLEEP_MODE, NULL, 0);
1019 EXPORT_SYMBOL(mipi_dsi_dcs_exit_sleep_mode);
1022 * mipi_dsi_dcs_set_display_off() - stop displaying the image data on the
1024 * @dsi: DSI peripheral device
1026 * Return: 0 on success or a negative error code on failure.
1028 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi)
1032 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_OFF, NULL, 0);
1038 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_off);
1041 * mipi_dsi_dcs_set_display_on() - start displaying the image data on the
1043 * @dsi: DSI peripheral device
1045 * Return: 0 on success or a negative error code on failure
1047 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi)
1051 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_ON, NULL, 0);
1057 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_on);
1060 * mipi_dsi_dcs_set_column_address() - define the column extent of the frame
1061 * memory accessed by the host processor
1062 * @dsi: DSI peripheral device
1063 * @start: first column of frame memory
1064 * @end: last column of frame memory
1066 * Return: 0 on success or a negative error code on failure.
1068 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
1071 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1074 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_COLUMN_ADDRESS, payload,
1081 EXPORT_SYMBOL(mipi_dsi_dcs_set_column_address);
1084 * mipi_dsi_dcs_set_page_address() - define the page extent of the frame
1085 * memory accessed by the host processor
1086 * @dsi: DSI peripheral device
1087 * @start: first page of frame memory
1088 * @end: last page of frame memory
1090 * Return: 0 on success or a negative error code on failure.
1092 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
1095 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1098 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PAGE_ADDRESS, payload,
1105 EXPORT_SYMBOL(mipi_dsi_dcs_set_page_address);
1108 * mipi_dsi_dcs_set_tear_off() - turn off the display module's Tearing Effect
1109 * output signal on the TE signal line
1110 * @dsi: DSI peripheral device
1112 * Return: 0 on success or a negative error code on failure
1114 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi)
1118 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_OFF, NULL, 0);
1124 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_off);
1127 * mipi_dsi_dcs_set_tear_on() - turn on the display module's Tearing Effect
1128 * output signal on the TE signal line.
1129 * @dsi: DSI peripheral device
1130 * @mode: the Tearing Effect Output Line mode
1132 * Return: 0 on success or a negative error code on failure
1134 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
1135 enum mipi_dsi_dcs_tear_mode mode)
1140 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_ON, &value,
1147 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_on);
1150 * mipi_dsi_dcs_set_pixel_format() - sets the pixel format for the RGB image
1151 * data used by the interface
1152 * @dsi: DSI peripheral device
1153 * @format: pixel format
1155 * Return: 0 on success or a negative error code on failure.
1157 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format)
1161 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PIXEL_FORMAT, &format,
1168 EXPORT_SYMBOL(mipi_dsi_dcs_set_pixel_format);
1171 * mipi_dsi_dcs_set_tear_scanline() - set the scanline to use as trigger for
1172 * the Tearing Effect output signal of the display module
1173 * @dsi: DSI peripheral device
1174 * @scanline: scanline to use as trigger
1176 * Return: 0 on success or a negative error code on failure
1178 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)
1180 u8 payload[2] = { scanline >> 8, scanline & 0xff };
1183 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_SCANLINE, payload,
1190 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_scanline);
1193 * mipi_dsi_dcs_set_display_brightness() - sets the brightness value of the
1195 * @dsi: DSI peripheral device
1196 * @brightness: brightness value
1198 * Return: 0 on success or a negative error code on failure.
1200 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
1203 u8 payload[2] = { brightness & 0xff, brightness >> 8 };
1206 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1207 payload, sizeof(payload));
1213 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness);
1216 * mipi_dsi_dcs_get_display_brightness() - gets the current brightness value
1218 * @dsi: DSI peripheral device
1219 * @brightness: brightness value
1221 * Return: 0 on success or a negative error code on failure.
1223 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
1228 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1229 brightness, sizeof(*brightness));
1239 EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness);
1242 * mipi_dsi_dcs_set_display_brightness_large() - sets the 16-bit brightness value
1244 * @dsi: DSI peripheral device
1245 * @brightness: brightness value
1247 * Return: 0 on success or a negative error code on failure.
1249 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
1252 u8 payload[2] = { brightness >> 8, brightness & 0xff };
1255 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1256 payload, sizeof(payload));
1262 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness_large);
1265 * mipi_dsi_dcs_get_display_brightness_large() - gets the current 16-bit
1266 * brightness value of the display
1267 * @dsi: DSI peripheral device
1268 * @brightness: brightness value
1270 * Return: 0 on success or a negative error code on failure.
1272 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
1275 u8 brightness_be[2];
1278 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1279 brightness_be, sizeof(brightness_be));
1287 *brightness = (brightness_be[0] << 8) | brightness_be[1];
1291 EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness_large);
1293 static int mipi_dsi_drv_probe(struct device *dev)
1295 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1296 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1298 return drv->probe(dsi);
1301 static int mipi_dsi_drv_remove(struct device *dev)
1303 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1304 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1311 static void mipi_dsi_drv_shutdown(struct device *dev)
1313 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1314 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1320 * mipi_dsi_driver_register_full() - register a driver for DSI devices
1321 * @drv: DSI driver structure
1322 * @owner: owner module
1324 * Return: 0 on success or a negative error code on failure.
1326 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *drv,
1327 struct module *owner)
1329 drv->driver.bus = &mipi_dsi_bus_type;
1330 drv->driver.owner = owner;
1333 drv->driver.probe = mipi_dsi_drv_probe;
1335 drv->driver.remove = mipi_dsi_drv_remove;
1337 drv->driver.shutdown = mipi_dsi_drv_shutdown;
1339 return driver_register(&drv->driver);
1341 EXPORT_SYMBOL(mipi_dsi_driver_register_full);
1344 * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1345 * @drv: DSI driver structure
1347 * Return: 0 on success or a negative error code on failure.
1349 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv)
1351 driver_unregister(&drv->driver);
1353 EXPORT_SYMBOL(mipi_dsi_driver_unregister);
1355 static int __init mipi_dsi_bus_init(void)
1357 return bus_register(&mipi_dsi_bus_type);
1359 postcore_initcall(mipi_dsi_bus_init);
1362 MODULE_DESCRIPTION("MIPI DSI Bus");
1363 MODULE_LICENSE("GPL and additional rights");