4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
5 * Andrzej Hajda <a.hajda@samsung.com>
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 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);
350 mipi_dsi_detach(dsi);
351 mipi_dsi_device_unregister(dsi);
356 void mipi_dsi_host_unregister(struct mipi_dsi_host *host)
358 device_for_each_child(host->dev, NULL, mipi_dsi_remove_device_fn);
360 mutex_lock(&host_lock);
361 list_del_init(&host->list);
362 mutex_unlock(&host_lock);
364 EXPORT_SYMBOL(mipi_dsi_host_unregister);
367 * mipi_dsi_attach - attach a DSI device to its DSI host
368 * @dsi: DSI peripheral
370 int mipi_dsi_attach(struct mipi_dsi_device *dsi)
372 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
374 if (!ops || !ops->attach)
377 return ops->attach(dsi->host, dsi);
379 EXPORT_SYMBOL(mipi_dsi_attach);
382 * mipi_dsi_detach - detach a DSI device from its DSI host
383 * @dsi: DSI peripheral
385 int mipi_dsi_detach(struct mipi_dsi_device *dsi)
387 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
389 if (!ops || !ops->detach)
392 return ops->detach(dsi->host, dsi);
394 EXPORT_SYMBOL(mipi_dsi_detach);
396 static void devm_mipi_dsi_detach(void *arg)
398 struct mipi_dsi_device *dsi = arg;
400 mipi_dsi_detach(dsi);
404 * devm_mipi_dsi_attach - Attach a MIPI-DSI device to its DSI Host
405 * @dev: device to tie the MIPI-DSI device attachment lifetime to
406 * @dsi: DSI peripheral
408 * This is the managed version of mipi_dsi_attach() which automatically
409 * calls mipi_dsi_detach() when @dev is unbound.
412 * 0 on success, a negative error code on failure.
414 int devm_mipi_dsi_attach(struct device *dev,
415 struct mipi_dsi_device *dsi)
419 ret = mipi_dsi_attach(dsi);
423 ret = devm_add_action_or_reset(dev, devm_mipi_dsi_detach, dsi);
429 EXPORT_SYMBOL_GPL(devm_mipi_dsi_attach);
431 static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,
432 struct mipi_dsi_msg *msg)
434 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
436 if (!ops || !ops->transfer)
439 if (dsi->mode_flags & MIPI_DSI_MODE_LPM)
440 msg->flags |= MIPI_DSI_MSG_USE_LPM;
442 return ops->transfer(dsi->host, msg);
446 * mipi_dsi_packet_format_is_short - check if a packet is of the short format
447 * @type: MIPI DSI data type of the packet
449 * Return: true if the packet for the given data type is a short packet, false
452 bool mipi_dsi_packet_format_is_short(u8 type)
455 case MIPI_DSI_V_SYNC_START:
456 case MIPI_DSI_V_SYNC_END:
457 case MIPI_DSI_H_SYNC_START:
458 case MIPI_DSI_H_SYNC_END:
459 case MIPI_DSI_COMPRESSION_MODE:
460 case MIPI_DSI_END_OF_TRANSMISSION:
461 case MIPI_DSI_COLOR_MODE_OFF:
462 case MIPI_DSI_COLOR_MODE_ON:
463 case MIPI_DSI_SHUTDOWN_PERIPHERAL:
464 case MIPI_DSI_TURN_ON_PERIPHERAL:
465 case MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM:
466 case MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM:
467 case MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM:
468 case MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM:
469 case MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM:
470 case MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM:
471 case MIPI_DSI_DCS_SHORT_WRITE:
472 case MIPI_DSI_DCS_SHORT_WRITE_PARAM:
473 case MIPI_DSI_DCS_READ:
474 case MIPI_DSI_EXECUTE_QUEUE:
475 case MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE:
481 EXPORT_SYMBOL(mipi_dsi_packet_format_is_short);
484 * mipi_dsi_packet_format_is_long - check if a packet is of the long format
485 * @type: MIPI DSI data type of the packet
487 * Return: true if the packet for the given data type is a long packet, false
490 bool mipi_dsi_packet_format_is_long(u8 type)
493 case MIPI_DSI_NULL_PACKET:
494 case MIPI_DSI_BLANKING_PACKET:
495 case MIPI_DSI_GENERIC_LONG_WRITE:
496 case MIPI_DSI_DCS_LONG_WRITE:
497 case MIPI_DSI_PICTURE_PARAMETER_SET:
498 case MIPI_DSI_COMPRESSED_PIXEL_STREAM:
499 case MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20:
500 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24:
501 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16:
502 case MIPI_DSI_PACKED_PIXEL_STREAM_30:
503 case MIPI_DSI_PACKED_PIXEL_STREAM_36:
504 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12:
505 case MIPI_DSI_PACKED_PIXEL_STREAM_16:
506 case MIPI_DSI_PACKED_PIXEL_STREAM_18:
507 case MIPI_DSI_PIXEL_STREAM_3BYTE_18:
508 case MIPI_DSI_PACKED_PIXEL_STREAM_24:
514 EXPORT_SYMBOL(mipi_dsi_packet_format_is_long);
517 * mipi_dsi_create_packet - create a packet from a message according to the
519 * @packet: pointer to a DSI packet structure
520 * @msg: message to translate into a packet
522 * Return: 0 on success or a negative error code on failure.
524 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
525 const struct mipi_dsi_msg *msg)
530 /* do some minimum sanity checking */
531 if (!mipi_dsi_packet_format_is_short(msg->type) &&
532 !mipi_dsi_packet_format_is_long(msg->type))
535 if (msg->channel > 3)
538 memset(packet, 0, sizeof(*packet));
539 packet->header[0] = ((msg->channel & 0x3) << 6) | (msg->type & 0x3f);
541 /* TODO: compute ECC if hardware support is not available */
544 * Long write packets contain the word count in header bytes 1 and 2.
545 * The payload follows the header and is word count bytes long.
547 * Short write packets encode up to two parameters in header bytes 1
550 if (mipi_dsi_packet_format_is_long(msg->type)) {
551 packet->header[1] = (msg->tx_len >> 0) & 0xff;
552 packet->header[2] = (msg->tx_len >> 8) & 0xff;
554 packet->payload_length = msg->tx_len;
555 packet->payload = msg->tx_buf;
557 const u8 *tx = msg->tx_buf;
559 packet->header[1] = (msg->tx_len > 0) ? tx[0] : 0;
560 packet->header[2] = (msg->tx_len > 1) ? tx[1] : 0;
563 packet->size = sizeof(packet->header) + packet->payload_length;
567 EXPORT_SYMBOL(mipi_dsi_create_packet);
570 * mipi_dsi_shutdown_peripheral() - sends a Shutdown Peripheral command
571 * @dsi: DSI peripheral device
573 * Return: 0 on success or a negative error code on failure.
575 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)
577 struct mipi_dsi_msg msg = {
578 .channel = dsi->channel,
579 .type = MIPI_DSI_SHUTDOWN_PERIPHERAL,
580 .tx_buf = (u8 [2]) { 0, 0 },
583 int ret = mipi_dsi_device_transfer(dsi, &msg);
585 return (ret < 0) ? ret : 0;
587 EXPORT_SYMBOL(mipi_dsi_shutdown_peripheral);
590 * mipi_dsi_turn_on_peripheral() - sends a Turn On Peripheral command
591 * @dsi: DSI peripheral device
593 * Return: 0 on success or a negative error code on failure.
595 int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi)
597 struct mipi_dsi_msg msg = {
598 .channel = dsi->channel,
599 .type = MIPI_DSI_TURN_ON_PERIPHERAL,
600 .tx_buf = (u8 [2]) { 0, 0 },
603 int ret = mipi_dsi_device_transfer(dsi, &msg);
605 return (ret < 0) ? ret : 0;
607 EXPORT_SYMBOL(mipi_dsi_turn_on_peripheral);
610 * mipi_dsi_set_maximum_return_packet_size() - specify the maximum size of
611 * the payload in a long packet transmitted from the peripheral back to the
613 * @dsi: DSI peripheral device
614 * @value: the maximum size of the payload
616 * Return: 0 on success or a negative error code on failure.
618 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
621 u8 tx[2] = { value & 0xff, value >> 8 };
622 struct mipi_dsi_msg msg = {
623 .channel = dsi->channel,
624 .type = MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE,
625 .tx_len = sizeof(tx),
628 int ret = mipi_dsi_device_transfer(dsi, &msg);
630 return (ret < 0) ? ret : 0;
632 EXPORT_SYMBOL(mipi_dsi_set_maximum_return_packet_size);
635 * mipi_dsi_compression_mode() - enable/disable DSC on the peripheral
636 * @dsi: DSI peripheral device
637 * @enable: Whether to enable or disable the DSC
639 * Enable or disable Display Stream Compression on the peripheral using the
640 * default Picture Parameter Set and VESA DSC 1.1 algorithm.
642 * Return: 0 on success or a negative error code on failure.
644 ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable)
646 /* Note: Needs updating for non-default PPS or algorithm */
647 u8 tx[2] = { enable << 0, 0 };
648 struct mipi_dsi_msg msg = {
649 .channel = dsi->channel,
650 .type = MIPI_DSI_COMPRESSION_MODE,
651 .tx_len = sizeof(tx),
654 int ret = mipi_dsi_device_transfer(dsi, &msg);
656 return (ret < 0) ? ret : 0;
658 EXPORT_SYMBOL(mipi_dsi_compression_mode);
661 * mipi_dsi_picture_parameter_set() - transmit the DSC PPS to the peripheral
662 * @dsi: DSI peripheral device
663 * @pps: VESA DSC 1.1 Picture Parameter Set
665 * Transmit the VESA DSC 1.1 Picture Parameter Set to the peripheral.
667 * Return: 0 on success or a negative error code on failure.
669 ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
670 const struct drm_dsc_picture_parameter_set *pps)
672 struct mipi_dsi_msg msg = {
673 .channel = dsi->channel,
674 .type = MIPI_DSI_PICTURE_PARAMETER_SET,
675 .tx_len = sizeof(*pps),
678 int ret = mipi_dsi_device_transfer(dsi, &msg);
680 return (ret < 0) ? ret : 0;
682 EXPORT_SYMBOL(mipi_dsi_picture_parameter_set);
685 * mipi_dsi_generic_write() - transmit data using a generic write packet
686 * @dsi: DSI peripheral device
687 * @payload: buffer containing the payload
688 * @size: size of payload buffer
690 * This function will automatically choose the right data type depending on
691 * the payload length.
693 * Return: The number of bytes transmitted on success or a negative error code
696 ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
699 struct mipi_dsi_msg msg = {
700 .channel = dsi->channel,
707 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM;
711 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM;
715 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM;
719 msg.type = MIPI_DSI_GENERIC_LONG_WRITE;
723 return mipi_dsi_device_transfer(dsi, &msg);
725 EXPORT_SYMBOL(mipi_dsi_generic_write);
728 * mipi_dsi_generic_read() - receive data using a generic read packet
729 * @dsi: DSI peripheral device
730 * @params: buffer containing the request parameters
731 * @num_params: number of request parameters
732 * @data: buffer in which to return the received data
733 * @size: size of receive buffer
735 * This function will automatically choose the right data type depending on
736 * the number of parameters passed in.
738 * Return: The number of bytes successfully read or a negative error code on
741 ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
742 size_t num_params, void *data, size_t size)
744 struct mipi_dsi_msg msg = {
745 .channel = dsi->channel,
746 .tx_len = num_params,
752 switch (num_params) {
754 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM;
758 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM;
762 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM;
769 return mipi_dsi_device_transfer(dsi, &msg);
771 EXPORT_SYMBOL(mipi_dsi_generic_read);
774 * mipi_dsi_dcs_write_buffer() - transmit a DCS command with payload
775 * @dsi: DSI peripheral device
776 * @data: buffer containing data to be transmitted
777 * @len: size of transmission buffer
779 * This function will automatically choose the right data type depending on
780 * the command payload length.
782 * Return: The number of bytes successfully transmitted or a negative error
785 ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
786 const void *data, size_t len)
788 struct mipi_dsi_msg msg = {
789 .channel = dsi->channel,
799 msg.type = MIPI_DSI_DCS_SHORT_WRITE;
803 msg.type = MIPI_DSI_DCS_SHORT_WRITE_PARAM;
807 msg.type = MIPI_DSI_DCS_LONG_WRITE;
811 return mipi_dsi_device_transfer(dsi, &msg);
813 EXPORT_SYMBOL(mipi_dsi_dcs_write_buffer);
816 * mipi_dsi_dcs_write() - send DCS write command
817 * @dsi: DSI peripheral device
819 * @data: buffer containing the command payload
820 * @len: command payload length
822 * This function will automatically choose the right data type depending on
823 * the command payload length.
825 * Return: The number of bytes successfully transmitted or a negative error
828 ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
829 const void *data, size_t len)
837 if (len > ARRAY_SIZE(stack_tx) - 1) {
838 tx = kmalloc(size, GFP_KERNEL);
845 /* concatenate the DCS command byte and the payload */
848 memcpy(&tx[1], data, len);
850 err = mipi_dsi_dcs_write_buffer(dsi, tx, size);
857 EXPORT_SYMBOL(mipi_dsi_dcs_write);
860 * mipi_dsi_dcs_read() - send DCS read request command
861 * @dsi: DSI peripheral device
863 * @data: buffer in which to receive data
864 * @len: size of receive buffer
866 * Return: The number of bytes read or a negative error code on failure.
868 ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
871 struct mipi_dsi_msg msg = {
872 .channel = dsi->channel,
873 .type = MIPI_DSI_DCS_READ,
880 return mipi_dsi_device_transfer(dsi, &msg);
882 EXPORT_SYMBOL(mipi_dsi_dcs_read);
885 * mipi_dsi_dcs_nop() - send DCS nop packet
886 * @dsi: DSI peripheral device
888 * Return: 0 on success or a negative error code on failure.
890 int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi)
894 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_NOP, NULL, 0);
900 EXPORT_SYMBOL(mipi_dsi_dcs_nop);
903 * mipi_dsi_dcs_soft_reset() - perform a software reset of the display module
904 * @dsi: DSI peripheral device
906 * Return: 0 on success or a negative error code on failure.
908 int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi)
912 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SOFT_RESET, NULL, 0);
918 EXPORT_SYMBOL(mipi_dsi_dcs_soft_reset);
921 * mipi_dsi_dcs_get_power_mode() - query the display module's current power
923 * @dsi: DSI peripheral device
924 * @mode: return location for the current power mode
926 * Return: 0 on success or a negative error code on failure.
928 int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode)
932 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_POWER_MODE, mode,
943 EXPORT_SYMBOL(mipi_dsi_dcs_get_power_mode);
946 * mipi_dsi_dcs_get_pixel_format() - gets the pixel format for the RGB image
947 * data used by the interface
948 * @dsi: DSI peripheral device
949 * @format: return location for the pixel format
951 * Return: 0 on success or a negative error code on failure.
953 int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format)
957 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_PIXEL_FORMAT, format,
968 EXPORT_SYMBOL(mipi_dsi_dcs_get_pixel_format);
971 * mipi_dsi_dcs_enter_sleep_mode() - disable all unnecessary blocks inside the
972 * display module except interface communication
973 * @dsi: DSI peripheral device
975 * Return: 0 on success or a negative error code on failure.
977 int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi)
981 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_SLEEP_MODE, NULL, 0);
987 EXPORT_SYMBOL(mipi_dsi_dcs_enter_sleep_mode);
990 * mipi_dsi_dcs_exit_sleep_mode() - enable all blocks inside the display
992 * @dsi: DSI peripheral device
994 * Return: 0 on success or a negative error code on failure.
996 int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi)
1000 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_EXIT_SLEEP_MODE, NULL, 0);
1006 EXPORT_SYMBOL(mipi_dsi_dcs_exit_sleep_mode);
1009 * mipi_dsi_dcs_set_display_off() - stop displaying the image data on the
1011 * @dsi: DSI peripheral device
1013 * Return: 0 on success or a negative error code on failure.
1015 int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi)
1019 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_OFF, NULL, 0);
1025 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_off);
1028 * mipi_dsi_dcs_set_display_on() - start displaying the image data on the
1030 * @dsi: DSI peripheral device
1032 * Return: 0 on success or a negative error code on failure
1034 int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi)
1038 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_ON, NULL, 0);
1044 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_on);
1047 * mipi_dsi_dcs_set_column_address() - define the column extent of the frame
1048 * memory accessed by the host processor
1049 * @dsi: DSI peripheral device
1050 * @start: first column of frame memory
1051 * @end: last column of frame memory
1053 * Return: 0 on success or a negative error code on failure.
1055 int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
1058 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1061 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_COLUMN_ADDRESS, payload,
1068 EXPORT_SYMBOL(mipi_dsi_dcs_set_column_address);
1071 * mipi_dsi_dcs_set_page_address() - define the page extent of the frame
1072 * memory accessed by the host processor
1073 * @dsi: DSI peripheral device
1074 * @start: first page of frame memory
1075 * @end: last page of frame memory
1077 * Return: 0 on success or a negative error code on failure.
1079 int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
1082 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1085 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PAGE_ADDRESS, payload,
1092 EXPORT_SYMBOL(mipi_dsi_dcs_set_page_address);
1095 * mipi_dsi_dcs_set_tear_off() - turn off the display module's Tearing Effect
1096 * output signal on the TE signal line
1097 * @dsi: DSI peripheral device
1099 * Return: 0 on success or a negative error code on failure
1101 int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi)
1105 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_OFF, NULL, 0);
1111 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_off);
1114 * mipi_dsi_dcs_set_tear_on() - turn on the display module's Tearing Effect
1115 * output signal on the TE signal line.
1116 * @dsi: DSI peripheral device
1117 * @mode: the Tearing Effect Output Line mode
1119 * Return: 0 on success or a negative error code on failure
1121 int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
1122 enum mipi_dsi_dcs_tear_mode mode)
1127 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_ON, &value,
1134 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_on);
1137 * mipi_dsi_dcs_set_pixel_format() - sets the pixel format for the RGB image
1138 * data used by the interface
1139 * @dsi: DSI peripheral device
1140 * @format: pixel format
1142 * Return: 0 on success or a negative error code on failure.
1144 int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format)
1148 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PIXEL_FORMAT, &format,
1155 EXPORT_SYMBOL(mipi_dsi_dcs_set_pixel_format);
1158 * mipi_dsi_dcs_set_tear_scanline() - set the scanline to use as trigger for
1159 * the Tearing Effect output signal of the display module
1160 * @dsi: DSI peripheral device
1161 * @scanline: scanline to use as trigger
1163 * Return: 0 on success or a negative error code on failure
1165 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)
1167 u8 payload[2] = { scanline >> 8, scanline & 0xff };
1170 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_SCANLINE, payload,
1177 EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_scanline);
1180 * mipi_dsi_dcs_set_display_brightness() - sets the brightness value of the
1182 * @dsi: DSI peripheral device
1183 * @brightness: brightness value
1185 * Return: 0 on success or a negative error code on failure.
1187 int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
1190 u8 payload[2] = { brightness & 0xff, brightness >> 8 };
1193 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1194 payload, sizeof(payload));
1200 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness);
1203 * mipi_dsi_dcs_get_display_brightness() - gets the current brightness value
1205 * @dsi: DSI peripheral device
1206 * @brightness: brightness value
1208 * Return: 0 on success or a negative error code on failure.
1210 int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
1215 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1216 brightness, sizeof(*brightness));
1226 EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness);
1229 * mipi_dsi_dcs_set_display_brightness_large() - sets the 16-bit brightness value
1231 * @dsi: DSI peripheral device
1232 * @brightness: brightness value
1234 * Return: 0 on success or a negative error code on failure.
1236 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
1239 u8 payload[2] = { brightness >> 8, brightness & 0xff };
1242 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1243 payload, sizeof(payload));
1249 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness_large);
1252 * mipi_dsi_dcs_get_display_brightness_large() - gets the current 16-bit
1253 * brightness value of the display
1254 * @dsi: DSI peripheral device
1255 * @brightness: brightness value
1257 * Return: 0 on success or a negative error code on failure.
1259 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
1262 u8 brightness_be[2];
1265 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1266 brightness_be, sizeof(brightness_be));
1274 *brightness = (brightness_be[0] << 8) | brightness_be[1];
1278 EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness_large);
1280 static int mipi_dsi_drv_probe(struct device *dev)
1282 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1283 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1285 return drv->probe(dsi);
1288 static int mipi_dsi_drv_remove(struct device *dev)
1290 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1291 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1298 static void mipi_dsi_drv_shutdown(struct device *dev)
1300 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1301 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1307 * mipi_dsi_driver_register_full() - register a driver for DSI devices
1308 * @drv: DSI driver structure
1309 * @owner: owner module
1311 * Return: 0 on success or a negative error code on failure.
1313 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *drv,
1314 struct module *owner)
1316 drv->driver.bus = &mipi_dsi_bus_type;
1317 drv->driver.owner = owner;
1320 drv->driver.probe = mipi_dsi_drv_probe;
1322 drv->driver.remove = mipi_dsi_drv_remove;
1324 drv->driver.shutdown = mipi_dsi_drv_shutdown;
1326 return driver_register(&drv->driver);
1328 EXPORT_SYMBOL(mipi_dsi_driver_register_full);
1331 * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1332 * @drv: DSI driver structure
1334 * Return: 0 on success or a negative error code on failure.
1336 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv)
1338 driver_unregister(&drv->driver);
1340 EXPORT_SYMBOL(mipi_dsi_driver_unregister);
1342 static int __init mipi_dsi_bus_init(void)
1344 return bus_register(&mipi_dsi_bus_type);
1346 postcore_initcall(mipi_dsi_bus_init);
1348 MODULE_AUTHOR("Andrzej Hajda <a.hajda@samsung.com>");
1349 MODULE_DESCRIPTION("MIPI DSI Bus");
1350 MODULE_LICENSE("GPL and additional rights");