Loading...
1/*
2 * MIPI DSI Bus
3 *
4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
5 * Andrzej Hajda <a.hajda@samsung.com>
6 *
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:
14 *
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
17 * of the Software.
18 *
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.
26 */
27
28#include <drm/drm_mipi_dsi.h>
29
30#include <linux/device.h>
31#include <linux/module.h>
32#include <linux/of_device.h>
33#include <linux/pm_runtime.h>
34#include <linux/slab.h>
35
36#include <video/mipi_display.h>
37
38/**
39 * DOC: dsi helpers
40 *
41 * These functions contain some common logic and helpers to deal with MIPI DSI
42 * peripherals.
43 *
44 * Helpers are provided for a number of standard MIPI DSI command as well as a
45 * subset of the MIPI DCS command set.
46 */
47
48static int mipi_dsi_device_match(struct device *dev, struct device_driver *drv)
49{
50 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
51
52 /* attempt OF style match */
53 if (of_driver_match_device(dev, drv))
54 return 1;
55
56 /* compare DSI device and driver names */
57 if (!strcmp(dsi->name, drv->name))
58 return 1;
59
60 return 0;
61}
62
63static int mipi_dsi_uevent(struct device *dev, struct kobj_uevent_env *env)
64{
65 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
66 int err;
67
68 err = of_device_uevent_modalias(dev, env);
69 if (err != -ENODEV)
70 return err;
71
72 add_uevent_var(env, "MODALIAS=%s%s", MIPI_DSI_MODULE_PREFIX,
73 dsi->name);
74
75 return 0;
76}
77
78static const struct dev_pm_ops mipi_dsi_device_pm_ops = {
79 .runtime_suspend = pm_generic_runtime_suspend,
80 .runtime_resume = pm_generic_runtime_resume,
81 .suspend = pm_generic_suspend,
82 .resume = pm_generic_resume,
83 .freeze = pm_generic_freeze,
84 .thaw = pm_generic_thaw,
85 .poweroff = pm_generic_poweroff,
86 .restore = pm_generic_restore,
87};
88
89static struct bus_type mipi_dsi_bus_type = {
90 .name = "mipi-dsi",
91 .match = mipi_dsi_device_match,
92 .uevent = mipi_dsi_uevent,
93 .pm = &mipi_dsi_device_pm_ops,
94};
95
96static int of_device_match(struct device *dev, void *data)
97{
98 return dev->of_node == data;
99}
100
101/**
102 * of_find_mipi_dsi_device_by_node() - find the MIPI DSI device matching a
103 * device tree node
104 * @np: device tree node
105 *
106 * Return: A pointer to the MIPI DSI device corresponding to @np or NULL if no
107 * such device exists (or has not been registered yet).
108 */
109struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np)
110{
111 struct device *dev;
112
113 dev = bus_find_device(&mipi_dsi_bus_type, NULL, np, of_device_match);
114
115 return dev ? to_mipi_dsi_device(dev) : NULL;
116}
117EXPORT_SYMBOL(of_find_mipi_dsi_device_by_node);
118
119static void mipi_dsi_dev_release(struct device *dev)
120{
121 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
122
123 of_node_put(dev->of_node);
124 kfree(dsi);
125}
126
127static const struct device_type mipi_dsi_device_type = {
128 .release = mipi_dsi_dev_release,
129};
130
131static struct mipi_dsi_device *mipi_dsi_device_alloc(struct mipi_dsi_host *host)
132{
133 struct mipi_dsi_device *dsi;
134
135 dsi = kzalloc(sizeof(*dsi), GFP_KERNEL);
136 if (!dsi)
137 return ERR_PTR(-ENOMEM);
138
139 dsi->host = host;
140 dsi->dev.bus = &mipi_dsi_bus_type;
141 dsi->dev.parent = host->dev;
142 dsi->dev.type = &mipi_dsi_device_type;
143
144 device_initialize(&dsi->dev);
145
146 return dsi;
147}
148
149static int mipi_dsi_device_add(struct mipi_dsi_device *dsi)
150{
151 struct mipi_dsi_host *host = dsi->host;
152
153 dev_set_name(&dsi->dev, "%s.%d", dev_name(host->dev), dsi->channel);
154
155 return device_add(&dsi->dev);
156}
157
158#if IS_ENABLED(CONFIG_OF)
159static struct mipi_dsi_device *
160of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
161{
162 struct device *dev = host->dev;
163 struct mipi_dsi_device_info info = { };
164 int ret;
165 u32 reg;
166
167 if (of_modalias_node(node, info.type, sizeof(info.type)) < 0) {
168 dev_err(dev, "modalias failure on %pOF\n", node);
169 return ERR_PTR(-EINVAL);
170 }
171
172 ret = of_property_read_u32(node, "reg", ®);
173 if (ret) {
174 dev_err(dev, "device node %pOF has no valid reg property: %d\n",
175 node, ret);
176 return ERR_PTR(-EINVAL);
177 }
178
179 info.channel = reg;
180 info.node = of_node_get(node);
181
182 return mipi_dsi_device_register_full(host, &info);
183}
184#else
185static struct mipi_dsi_device *
186of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
187{
188 return ERR_PTR(-ENODEV);
189}
190#endif
191
192/**
193 * mipi_dsi_device_register_full - create a MIPI DSI device
194 * @host: DSI host to which this device is connected
195 * @info: pointer to template containing DSI device information
196 *
197 * Create a MIPI DSI device by using the device information provided by
198 * mipi_dsi_device_info template
199 *
200 * Returns:
201 * A pointer to the newly created MIPI DSI device, or, a pointer encoded
202 * with an error
203 */
204struct mipi_dsi_device *
205mipi_dsi_device_register_full(struct mipi_dsi_host *host,
206 const struct mipi_dsi_device_info *info)
207{
208 struct mipi_dsi_device *dsi;
209 struct device *dev = host->dev;
210 int ret;
211
212 if (!info) {
213 dev_err(dev, "invalid mipi_dsi_device_info pointer\n");
214 return ERR_PTR(-EINVAL);
215 }
216
217 if (info->channel > 3) {
218 dev_err(dev, "invalid virtual channel: %u\n", info->channel);
219 return ERR_PTR(-EINVAL);
220 }
221
222 dsi = mipi_dsi_device_alloc(host);
223 if (IS_ERR(dsi)) {
224 dev_err(dev, "failed to allocate DSI device %ld\n",
225 PTR_ERR(dsi));
226 return dsi;
227 }
228
229 dsi->dev.of_node = info->node;
230 dsi->channel = info->channel;
231 strlcpy(dsi->name, info->type, sizeof(dsi->name));
232
233 ret = mipi_dsi_device_add(dsi);
234 if (ret) {
235 dev_err(dev, "failed to add DSI device %d\n", ret);
236 kfree(dsi);
237 return ERR_PTR(ret);
238 }
239
240 return dsi;
241}
242EXPORT_SYMBOL(mipi_dsi_device_register_full);
243
244/**
245 * mipi_dsi_device_unregister - unregister MIPI DSI device
246 * @dsi: DSI peripheral device
247 */
248void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi)
249{
250 device_unregister(&dsi->dev);
251}
252EXPORT_SYMBOL(mipi_dsi_device_unregister);
253
254static DEFINE_MUTEX(host_lock);
255static LIST_HEAD(host_list);
256
257/**
258 * of_find_mipi_dsi_host_by_node() - find the MIPI DSI host matching a
259 * device tree node
260 * @node: device tree node
261 *
262 * Returns:
263 * A pointer to the MIPI DSI host corresponding to @node or NULL if no
264 * such device exists (or has not been registered yet).
265 */
266struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node)
267{
268 struct mipi_dsi_host *host;
269
270 mutex_lock(&host_lock);
271
272 list_for_each_entry(host, &host_list, list) {
273 if (host->dev->of_node == node) {
274 mutex_unlock(&host_lock);
275 return host;
276 }
277 }
278
279 mutex_unlock(&host_lock);
280
281 return NULL;
282}
283EXPORT_SYMBOL(of_find_mipi_dsi_host_by_node);
284
285int mipi_dsi_host_register(struct mipi_dsi_host *host)
286{
287 struct device_node *node;
288
289 for_each_available_child_of_node(host->dev->of_node, node) {
290 /* skip nodes without reg property */
291 if (!of_find_property(node, "reg", NULL))
292 continue;
293 of_mipi_dsi_device_add(host, node);
294 }
295
296 mutex_lock(&host_lock);
297 list_add_tail(&host->list, &host_list);
298 mutex_unlock(&host_lock);
299
300 return 0;
301}
302EXPORT_SYMBOL(mipi_dsi_host_register);
303
304static int mipi_dsi_remove_device_fn(struct device *dev, void *priv)
305{
306 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
307
308 mipi_dsi_device_unregister(dsi);
309
310 return 0;
311}
312
313void mipi_dsi_host_unregister(struct mipi_dsi_host *host)
314{
315 device_for_each_child(host->dev, NULL, mipi_dsi_remove_device_fn);
316
317 mutex_lock(&host_lock);
318 list_del_init(&host->list);
319 mutex_unlock(&host_lock);
320}
321EXPORT_SYMBOL(mipi_dsi_host_unregister);
322
323/**
324 * mipi_dsi_attach - attach a DSI device to its DSI host
325 * @dsi: DSI peripheral
326 */
327int mipi_dsi_attach(struct mipi_dsi_device *dsi)
328{
329 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
330
331 if (!ops || !ops->attach)
332 return -ENOSYS;
333
334 return ops->attach(dsi->host, dsi);
335}
336EXPORT_SYMBOL(mipi_dsi_attach);
337
338/**
339 * mipi_dsi_detach - detach a DSI device from its DSI host
340 * @dsi: DSI peripheral
341 */
342int mipi_dsi_detach(struct mipi_dsi_device *dsi)
343{
344 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
345
346 if (!ops || !ops->detach)
347 return -ENOSYS;
348
349 return ops->detach(dsi->host, dsi);
350}
351EXPORT_SYMBOL(mipi_dsi_detach);
352
353static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,
354 struct mipi_dsi_msg *msg)
355{
356 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
357
358 if (!ops || !ops->transfer)
359 return -ENOSYS;
360
361 if (dsi->mode_flags & MIPI_DSI_MODE_LPM)
362 msg->flags |= MIPI_DSI_MSG_USE_LPM;
363
364 return ops->transfer(dsi->host, msg);
365}
366
367/**
368 * mipi_dsi_packet_format_is_short - check if a packet is of the short format
369 * @type: MIPI DSI data type of the packet
370 *
371 * Return: true if the packet for the given data type is a short packet, false
372 * otherwise.
373 */
374bool mipi_dsi_packet_format_is_short(u8 type)
375{
376 switch (type) {
377 case MIPI_DSI_V_SYNC_START:
378 case MIPI_DSI_V_SYNC_END:
379 case MIPI_DSI_H_SYNC_START:
380 case MIPI_DSI_H_SYNC_END:
381 case MIPI_DSI_END_OF_TRANSMISSION:
382 case MIPI_DSI_COLOR_MODE_OFF:
383 case MIPI_DSI_COLOR_MODE_ON:
384 case MIPI_DSI_SHUTDOWN_PERIPHERAL:
385 case MIPI_DSI_TURN_ON_PERIPHERAL:
386 case MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM:
387 case MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM:
388 case MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM:
389 case MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM:
390 case MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM:
391 case MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM:
392 case MIPI_DSI_DCS_SHORT_WRITE:
393 case MIPI_DSI_DCS_SHORT_WRITE_PARAM:
394 case MIPI_DSI_DCS_READ:
395 case MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE:
396 return true;
397 }
398
399 return false;
400}
401EXPORT_SYMBOL(mipi_dsi_packet_format_is_short);
402
403/**
404 * mipi_dsi_packet_format_is_long - check if a packet is of the long format
405 * @type: MIPI DSI data type of the packet
406 *
407 * Return: true if the packet for the given data type is a long packet, false
408 * otherwise.
409 */
410bool mipi_dsi_packet_format_is_long(u8 type)
411{
412 switch (type) {
413 case MIPI_DSI_NULL_PACKET:
414 case MIPI_DSI_BLANKING_PACKET:
415 case MIPI_DSI_GENERIC_LONG_WRITE:
416 case MIPI_DSI_DCS_LONG_WRITE:
417 case MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20:
418 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24:
419 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16:
420 case MIPI_DSI_PACKED_PIXEL_STREAM_30:
421 case MIPI_DSI_PACKED_PIXEL_STREAM_36:
422 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12:
423 case MIPI_DSI_PACKED_PIXEL_STREAM_16:
424 case MIPI_DSI_PACKED_PIXEL_STREAM_18:
425 case MIPI_DSI_PIXEL_STREAM_3BYTE_18:
426 case MIPI_DSI_PACKED_PIXEL_STREAM_24:
427 return true;
428 }
429
430 return false;
431}
432EXPORT_SYMBOL(mipi_dsi_packet_format_is_long);
433
434/**
435 * mipi_dsi_create_packet - create a packet from a message according to the
436 * DSI protocol
437 * @packet: pointer to a DSI packet structure
438 * @msg: message to translate into a packet
439 *
440 * Return: 0 on success or a negative error code on failure.
441 */
442int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
443 const struct mipi_dsi_msg *msg)
444{
445 if (!packet || !msg)
446 return -EINVAL;
447
448 /* do some minimum sanity checking */
449 if (!mipi_dsi_packet_format_is_short(msg->type) &&
450 !mipi_dsi_packet_format_is_long(msg->type))
451 return -EINVAL;
452
453 if (msg->channel > 3)
454 return -EINVAL;
455
456 memset(packet, 0, sizeof(*packet));
457 packet->header[0] = ((msg->channel & 0x3) << 6) | (msg->type & 0x3f);
458
459 /* TODO: compute ECC if hardware support is not available */
460
461 /*
462 * Long write packets contain the word count in header bytes 1 and 2.
463 * The payload follows the header and is word count bytes long.
464 *
465 * Short write packets encode up to two parameters in header bytes 1
466 * and 2.
467 */
468 if (mipi_dsi_packet_format_is_long(msg->type)) {
469 packet->header[1] = (msg->tx_len >> 0) & 0xff;
470 packet->header[2] = (msg->tx_len >> 8) & 0xff;
471
472 packet->payload_length = msg->tx_len;
473 packet->payload = msg->tx_buf;
474 } else {
475 const u8 *tx = msg->tx_buf;
476
477 packet->header[1] = (msg->tx_len > 0) ? tx[0] : 0;
478 packet->header[2] = (msg->tx_len > 1) ? tx[1] : 0;
479 }
480
481 packet->size = sizeof(packet->header) + packet->payload_length;
482
483 return 0;
484}
485EXPORT_SYMBOL(mipi_dsi_create_packet);
486
487/**
488 * mipi_dsi_shutdown_peripheral() - sends a Shutdown Peripheral command
489 * @dsi: DSI peripheral device
490 *
491 * Return: 0 on success or a negative error code on failure.
492 */
493int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)
494{
495 struct mipi_dsi_msg msg = {
496 .channel = dsi->channel,
497 .type = MIPI_DSI_SHUTDOWN_PERIPHERAL,
498 .tx_buf = (u8 [2]) { 0, 0 },
499 .tx_len = 2,
500 };
501 int ret = mipi_dsi_device_transfer(dsi, &msg);
502
503 return (ret < 0) ? ret : 0;
504}
505EXPORT_SYMBOL(mipi_dsi_shutdown_peripheral);
506
507/**
508 * mipi_dsi_turn_on_peripheral() - sends a Turn On Peripheral command
509 * @dsi: DSI peripheral device
510 *
511 * Return: 0 on success or a negative error code on failure.
512 */
513int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi)
514{
515 struct mipi_dsi_msg msg = {
516 .channel = dsi->channel,
517 .type = MIPI_DSI_TURN_ON_PERIPHERAL,
518 .tx_buf = (u8 [2]) { 0, 0 },
519 .tx_len = 2,
520 };
521 int ret = mipi_dsi_device_transfer(dsi, &msg);
522
523 return (ret < 0) ? ret : 0;
524}
525EXPORT_SYMBOL(mipi_dsi_turn_on_peripheral);
526
527/*
528 * mipi_dsi_set_maximum_return_packet_size() - specify the maximum size of the
529 * the payload in a long packet transmitted from the peripheral back to the
530 * host processor
531 * @dsi: DSI peripheral device
532 * @value: the maximum size of the payload
533 *
534 * Return: 0 on success or a negative error code on failure.
535 */
536int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
537 u16 value)
538{
539 u8 tx[2] = { value & 0xff, value >> 8 };
540 struct mipi_dsi_msg msg = {
541 .channel = dsi->channel,
542 .type = MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE,
543 .tx_len = sizeof(tx),
544 .tx_buf = tx,
545 };
546 int ret = mipi_dsi_device_transfer(dsi, &msg);
547
548 return (ret < 0) ? ret : 0;
549}
550EXPORT_SYMBOL(mipi_dsi_set_maximum_return_packet_size);
551
552/**
553 * mipi_dsi_generic_write() - transmit data using a generic write packet
554 * @dsi: DSI peripheral device
555 * @payload: buffer containing the payload
556 * @size: size of payload buffer
557 *
558 * This function will automatically choose the right data type depending on
559 * the payload length.
560 *
561 * Return: The number of bytes transmitted on success or a negative error code
562 * on failure.
563 */
564ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
565 size_t size)
566{
567 struct mipi_dsi_msg msg = {
568 .channel = dsi->channel,
569 .tx_buf = payload,
570 .tx_len = size
571 };
572
573 switch (size) {
574 case 0:
575 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM;
576 break;
577
578 case 1:
579 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM;
580 break;
581
582 case 2:
583 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM;
584 break;
585
586 default:
587 msg.type = MIPI_DSI_GENERIC_LONG_WRITE;
588 break;
589 }
590
591 return mipi_dsi_device_transfer(dsi, &msg);
592}
593EXPORT_SYMBOL(mipi_dsi_generic_write);
594
595/**
596 * mipi_dsi_generic_read() - receive data using a generic read packet
597 * @dsi: DSI peripheral device
598 * @params: buffer containing the request parameters
599 * @num_params: number of request parameters
600 * @data: buffer in which to return the received data
601 * @size: size of receive buffer
602 *
603 * This function will automatically choose the right data type depending on
604 * the number of parameters passed in.
605 *
606 * Return: The number of bytes successfully read or a negative error code on
607 * failure.
608 */
609ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
610 size_t num_params, void *data, size_t size)
611{
612 struct mipi_dsi_msg msg = {
613 .channel = dsi->channel,
614 .tx_len = num_params,
615 .tx_buf = params,
616 .rx_len = size,
617 .rx_buf = data
618 };
619
620 switch (num_params) {
621 case 0:
622 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM;
623 break;
624
625 case 1:
626 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM;
627 break;
628
629 case 2:
630 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM;
631 break;
632
633 default:
634 return -EINVAL;
635 }
636
637 return mipi_dsi_device_transfer(dsi, &msg);
638}
639EXPORT_SYMBOL(mipi_dsi_generic_read);
640
641/**
642 * mipi_dsi_dcs_write_buffer() - transmit a DCS command with payload
643 * @dsi: DSI peripheral device
644 * @data: buffer containing data to be transmitted
645 * @len: size of transmission buffer
646 *
647 * This function will automatically choose the right data type depending on
648 * the command payload length.
649 *
650 * Return: The number of bytes successfully transmitted or a negative error
651 * code on failure.
652 */
653ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
654 const void *data, size_t len)
655{
656 struct mipi_dsi_msg msg = {
657 .channel = dsi->channel,
658 .tx_buf = data,
659 .tx_len = len
660 };
661
662 switch (len) {
663 case 0:
664 return -EINVAL;
665
666 case 1:
667 msg.type = MIPI_DSI_DCS_SHORT_WRITE;
668 break;
669
670 case 2:
671 msg.type = MIPI_DSI_DCS_SHORT_WRITE_PARAM;
672 break;
673
674 default:
675 msg.type = MIPI_DSI_DCS_LONG_WRITE;
676 break;
677 }
678
679 return mipi_dsi_device_transfer(dsi, &msg);
680}
681EXPORT_SYMBOL(mipi_dsi_dcs_write_buffer);
682
683/**
684 * mipi_dsi_dcs_write() - send DCS write command
685 * @dsi: DSI peripheral device
686 * @cmd: DCS command
687 * @data: buffer containing the command payload
688 * @len: command payload length
689 *
690 * This function will automatically choose the right data type depending on
691 * the command payload length.
692 *
693 * Return: The number of bytes successfully transmitted or a negative error
694 * code on failure.
695 */
696ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
697 const void *data, size_t len)
698{
699 ssize_t err;
700 size_t size;
701 u8 *tx;
702
703 if (len > 0) {
704 size = 1 + len;
705
706 tx = kmalloc(size, GFP_KERNEL);
707 if (!tx)
708 return -ENOMEM;
709
710 /* concatenate the DCS command byte and the payload */
711 tx[0] = cmd;
712 memcpy(&tx[1], data, len);
713 } else {
714 tx = &cmd;
715 size = 1;
716 }
717
718 err = mipi_dsi_dcs_write_buffer(dsi, tx, size);
719
720 if (len > 0)
721 kfree(tx);
722
723 return err;
724}
725EXPORT_SYMBOL(mipi_dsi_dcs_write);
726
727/**
728 * mipi_dsi_dcs_read() - send DCS read request command
729 * @dsi: DSI peripheral device
730 * @cmd: DCS command
731 * @data: buffer in which to receive data
732 * @len: size of receive buffer
733 *
734 * Return: The number of bytes read or a negative error code on failure.
735 */
736ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
737 size_t len)
738{
739 struct mipi_dsi_msg msg = {
740 .channel = dsi->channel,
741 .type = MIPI_DSI_DCS_READ,
742 .tx_buf = &cmd,
743 .tx_len = 1,
744 .rx_buf = data,
745 .rx_len = len
746 };
747
748 return mipi_dsi_device_transfer(dsi, &msg);
749}
750EXPORT_SYMBOL(mipi_dsi_dcs_read);
751
752/**
753 * mipi_dsi_dcs_nop() - send DCS nop packet
754 * @dsi: DSI peripheral device
755 *
756 * Return: 0 on success or a negative error code on failure.
757 */
758int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi)
759{
760 ssize_t err;
761
762 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_NOP, NULL, 0);
763 if (err < 0)
764 return err;
765
766 return 0;
767}
768EXPORT_SYMBOL(mipi_dsi_dcs_nop);
769
770/**
771 * mipi_dsi_dcs_soft_reset() - perform a software reset of the display module
772 * @dsi: DSI peripheral device
773 *
774 * Return: 0 on success or a negative error code on failure.
775 */
776int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi)
777{
778 ssize_t err;
779
780 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SOFT_RESET, NULL, 0);
781 if (err < 0)
782 return err;
783
784 return 0;
785}
786EXPORT_SYMBOL(mipi_dsi_dcs_soft_reset);
787
788/**
789 * mipi_dsi_dcs_get_power_mode() - query the display module's current power
790 * mode
791 * @dsi: DSI peripheral device
792 * @mode: return location for the current power mode
793 *
794 * Return: 0 on success or a negative error code on failure.
795 */
796int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode)
797{
798 ssize_t err;
799
800 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_POWER_MODE, mode,
801 sizeof(*mode));
802 if (err <= 0) {
803 if (err == 0)
804 err = -ENODATA;
805
806 return err;
807 }
808
809 return 0;
810}
811EXPORT_SYMBOL(mipi_dsi_dcs_get_power_mode);
812
813/**
814 * mipi_dsi_dcs_get_pixel_format() - gets the pixel format for the RGB image
815 * data used by the interface
816 * @dsi: DSI peripheral device
817 * @format: return location for the pixel format
818 *
819 * Return: 0 on success or a negative error code on failure.
820 */
821int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format)
822{
823 ssize_t err;
824
825 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_PIXEL_FORMAT, format,
826 sizeof(*format));
827 if (err <= 0) {
828 if (err == 0)
829 err = -ENODATA;
830
831 return err;
832 }
833
834 return 0;
835}
836EXPORT_SYMBOL(mipi_dsi_dcs_get_pixel_format);
837
838/**
839 * mipi_dsi_dcs_enter_sleep_mode() - disable all unnecessary blocks inside the
840 * display module except interface communication
841 * @dsi: DSI peripheral device
842 *
843 * Return: 0 on success or a negative error code on failure.
844 */
845int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi)
846{
847 ssize_t err;
848
849 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_SLEEP_MODE, NULL, 0);
850 if (err < 0)
851 return err;
852
853 return 0;
854}
855EXPORT_SYMBOL(mipi_dsi_dcs_enter_sleep_mode);
856
857/**
858 * mipi_dsi_dcs_exit_sleep_mode() - enable all blocks inside the display
859 * module
860 * @dsi: DSI peripheral device
861 *
862 * Return: 0 on success or a negative error code on failure.
863 */
864int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi)
865{
866 ssize_t err;
867
868 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_EXIT_SLEEP_MODE, NULL, 0);
869 if (err < 0)
870 return err;
871
872 return 0;
873}
874EXPORT_SYMBOL(mipi_dsi_dcs_exit_sleep_mode);
875
876/**
877 * mipi_dsi_dcs_set_display_off() - stop displaying the image data on the
878 * display device
879 * @dsi: DSI peripheral device
880 *
881 * Return: 0 on success or a negative error code on failure.
882 */
883int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi)
884{
885 ssize_t err;
886
887 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_OFF, NULL, 0);
888 if (err < 0)
889 return err;
890
891 return 0;
892}
893EXPORT_SYMBOL(mipi_dsi_dcs_set_display_off);
894
895/**
896 * mipi_dsi_dcs_set_display_on() - start displaying the image data on the
897 * display device
898 * @dsi: DSI peripheral device
899 *
900 * Return: 0 on success or a negative error code on failure
901 */
902int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi)
903{
904 ssize_t err;
905
906 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_ON, NULL, 0);
907 if (err < 0)
908 return err;
909
910 return 0;
911}
912EXPORT_SYMBOL(mipi_dsi_dcs_set_display_on);
913
914/**
915 * mipi_dsi_dcs_set_column_address() - define the column extent of the frame
916 * memory accessed by the host processor
917 * @dsi: DSI peripheral device
918 * @start: first column of frame memory
919 * @end: last column of frame memory
920 *
921 * Return: 0 on success or a negative error code on failure.
922 */
923int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
924 u16 end)
925{
926 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
927 ssize_t err;
928
929 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_COLUMN_ADDRESS, payload,
930 sizeof(payload));
931 if (err < 0)
932 return err;
933
934 return 0;
935}
936EXPORT_SYMBOL(mipi_dsi_dcs_set_column_address);
937
938/**
939 * mipi_dsi_dcs_set_page_address() - define the page extent of the frame
940 * memory accessed by the host processor
941 * @dsi: DSI peripheral device
942 * @start: first page of frame memory
943 * @end: last page of frame memory
944 *
945 * Return: 0 on success or a negative error code on failure.
946 */
947int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
948 u16 end)
949{
950 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
951 ssize_t err;
952
953 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PAGE_ADDRESS, payload,
954 sizeof(payload));
955 if (err < 0)
956 return err;
957
958 return 0;
959}
960EXPORT_SYMBOL(mipi_dsi_dcs_set_page_address);
961
962/**
963 * mipi_dsi_dcs_set_tear_off() - turn off the display module's Tearing Effect
964 * output signal on the TE signal line
965 * @dsi: DSI peripheral device
966 *
967 * Return: 0 on success or a negative error code on failure
968 */
969int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi)
970{
971 ssize_t err;
972
973 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_OFF, NULL, 0);
974 if (err < 0)
975 return err;
976
977 return 0;
978}
979EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_off);
980
981/**
982 * mipi_dsi_dcs_set_tear_on() - turn on the display module's Tearing Effect
983 * output signal on the TE signal line.
984 * @dsi: DSI peripheral device
985 * @mode: the Tearing Effect Output Line mode
986 *
987 * Return: 0 on success or a negative error code on failure
988 */
989int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
990 enum mipi_dsi_dcs_tear_mode mode)
991{
992 u8 value = mode;
993 ssize_t err;
994
995 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_ON, &value,
996 sizeof(value));
997 if (err < 0)
998 return err;
999
1000 return 0;
1001}
1002EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_on);
1003
1004/**
1005 * mipi_dsi_dcs_set_pixel_format() - sets the pixel format for the RGB image
1006 * data used by the interface
1007 * @dsi: DSI peripheral device
1008 * @format: pixel format
1009 *
1010 * Return: 0 on success or a negative error code on failure.
1011 */
1012int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format)
1013{
1014 ssize_t err;
1015
1016 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PIXEL_FORMAT, &format,
1017 sizeof(format));
1018 if (err < 0)
1019 return err;
1020
1021 return 0;
1022}
1023EXPORT_SYMBOL(mipi_dsi_dcs_set_pixel_format);
1024
1025/**
1026 * mipi_dsi_dcs_set_tear_scanline() - set the scanline to use as trigger for
1027 * the Tearing Effect output signal of the display module
1028 * @dsi: DSI peripheral device
1029 * @scanline: scanline to use as trigger
1030 *
1031 * Return: 0 on success or a negative error code on failure
1032 */
1033int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)
1034{
1035 u8 payload[3] = { MIPI_DCS_SET_TEAR_SCANLINE, scanline >> 8,
1036 scanline & 0xff };
1037 ssize_t err;
1038
1039 err = mipi_dsi_generic_write(dsi, payload, sizeof(payload));
1040 if (err < 0)
1041 return err;
1042
1043 return 0;
1044}
1045EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_scanline);
1046
1047/**
1048 * mipi_dsi_dcs_set_display_brightness() - sets the brightness value of the
1049 * display
1050 * @dsi: DSI peripheral device
1051 * @brightness: brightness value
1052 *
1053 * Return: 0 on success or a negative error code on failure.
1054 */
1055int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
1056 u16 brightness)
1057{
1058 u8 payload[2] = { brightness & 0xff, brightness >> 8 };
1059 ssize_t err;
1060
1061 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1062 payload, sizeof(payload));
1063 if (err < 0)
1064 return err;
1065
1066 return 0;
1067}
1068EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness);
1069
1070/**
1071 * mipi_dsi_dcs_get_display_brightness() - gets the current brightness value
1072 * of the display
1073 * @dsi: DSI peripheral device
1074 * @brightness: brightness value
1075 *
1076 * Return: 0 on success or a negative error code on failure.
1077 */
1078int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
1079 u16 *brightness)
1080{
1081 ssize_t err;
1082
1083 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1084 brightness, sizeof(*brightness));
1085 if (err <= 0) {
1086 if (err == 0)
1087 err = -ENODATA;
1088
1089 return err;
1090 }
1091
1092 return 0;
1093}
1094EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness);
1095
1096static int mipi_dsi_drv_probe(struct device *dev)
1097{
1098 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1099 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1100
1101 return drv->probe(dsi);
1102}
1103
1104static int mipi_dsi_drv_remove(struct device *dev)
1105{
1106 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1107 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1108
1109 return drv->remove(dsi);
1110}
1111
1112static void mipi_dsi_drv_shutdown(struct device *dev)
1113{
1114 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1115 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1116
1117 drv->shutdown(dsi);
1118}
1119
1120/**
1121 * mipi_dsi_driver_register_full() - register a driver for DSI devices
1122 * @drv: DSI driver structure
1123 * @owner: owner module
1124 *
1125 * Return: 0 on success or a negative error code on failure.
1126 */
1127int mipi_dsi_driver_register_full(struct mipi_dsi_driver *drv,
1128 struct module *owner)
1129{
1130 drv->driver.bus = &mipi_dsi_bus_type;
1131 drv->driver.owner = owner;
1132
1133 if (drv->probe)
1134 drv->driver.probe = mipi_dsi_drv_probe;
1135 if (drv->remove)
1136 drv->driver.remove = mipi_dsi_drv_remove;
1137 if (drv->shutdown)
1138 drv->driver.shutdown = mipi_dsi_drv_shutdown;
1139
1140 return driver_register(&drv->driver);
1141}
1142EXPORT_SYMBOL(mipi_dsi_driver_register_full);
1143
1144/**
1145 * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1146 * @drv: DSI driver structure
1147 *
1148 * Return: 0 on success or a negative error code on failure.
1149 */
1150void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv)
1151{
1152 driver_unregister(&drv->driver);
1153}
1154EXPORT_SYMBOL(mipi_dsi_driver_unregister);
1155
1156static int __init mipi_dsi_bus_init(void)
1157{
1158 return bus_register(&mipi_dsi_bus_type);
1159}
1160postcore_initcall(mipi_dsi_bus_init);
1161
1162MODULE_AUTHOR("Andrzej Hajda <a.hajda@samsung.com>");
1163MODULE_DESCRIPTION("MIPI DSI Bus");
1164MODULE_LICENSE("GPL and additional rights");
1/*
2 * MIPI DSI Bus
3 *
4 * Copyright (C) 2012-2013, Samsung Electronics, Co., Ltd.
5 * Andrzej Hajda <a.hajda@samsung.com>
6 *
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:
14 *
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
17 * of the Software.
18 *
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.
26 */
27
28#include <linux/device.h>
29#include <linux/module.h>
30#include <linux/of_device.h>
31#include <linux/pm_runtime.h>
32#include <linux/slab.h>
33
34#include <drm/display/drm_dsc.h>
35#include <drm/drm_mipi_dsi.h>
36#include <drm/drm_print.h>
37
38#include <video/mipi_display.h>
39
40/**
41 * DOC: dsi helpers
42 *
43 * These functions contain some common logic and helpers to deal with MIPI DSI
44 * peripherals.
45 *
46 * Helpers are provided for a number of standard MIPI DSI command as well as a
47 * subset of the MIPI DCS command set.
48 */
49
50static int mipi_dsi_device_match(struct device *dev, struct device_driver *drv)
51{
52 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
53
54 /* attempt OF style match */
55 if (of_driver_match_device(dev, drv))
56 return 1;
57
58 /* compare DSI device and driver names */
59 if (!strcmp(dsi->name, drv->name))
60 return 1;
61
62 return 0;
63}
64
65static int mipi_dsi_uevent(struct device *dev, struct kobj_uevent_env *env)
66{
67 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
68 int err;
69
70 err = of_device_uevent_modalias(dev, env);
71 if (err != -ENODEV)
72 return err;
73
74 add_uevent_var(env, "MODALIAS=%s%s", MIPI_DSI_MODULE_PREFIX,
75 dsi->name);
76
77 return 0;
78}
79
80static const struct dev_pm_ops mipi_dsi_device_pm_ops = {
81 .runtime_suspend = pm_generic_runtime_suspend,
82 .runtime_resume = pm_generic_runtime_resume,
83 .suspend = pm_generic_suspend,
84 .resume = pm_generic_resume,
85 .freeze = pm_generic_freeze,
86 .thaw = pm_generic_thaw,
87 .poweroff = pm_generic_poweroff,
88 .restore = pm_generic_restore,
89};
90
91static struct bus_type mipi_dsi_bus_type = {
92 .name = "mipi-dsi",
93 .match = mipi_dsi_device_match,
94 .uevent = mipi_dsi_uevent,
95 .pm = &mipi_dsi_device_pm_ops,
96};
97
98/**
99 * of_find_mipi_dsi_device_by_node() - find the MIPI DSI device matching a
100 * device tree node
101 * @np: device tree node
102 *
103 * Return: A pointer to the MIPI DSI device corresponding to @np or NULL if no
104 * such device exists (or has not been registered yet).
105 */
106struct mipi_dsi_device *of_find_mipi_dsi_device_by_node(struct device_node *np)
107{
108 struct device *dev;
109
110 dev = bus_find_device_by_of_node(&mipi_dsi_bus_type, np);
111
112 return dev ? to_mipi_dsi_device(dev) : NULL;
113}
114EXPORT_SYMBOL(of_find_mipi_dsi_device_by_node);
115
116static void mipi_dsi_dev_release(struct device *dev)
117{
118 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
119
120 of_node_put(dev->of_node);
121 kfree(dsi);
122}
123
124static const struct device_type mipi_dsi_device_type = {
125 .release = mipi_dsi_dev_release,
126};
127
128static struct mipi_dsi_device *mipi_dsi_device_alloc(struct mipi_dsi_host *host)
129{
130 struct mipi_dsi_device *dsi;
131
132 dsi = kzalloc(sizeof(*dsi), GFP_KERNEL);
133 if (!dsi)
134 return ERR_PTR(-ENOMEM);
135
136 dsi->host = host;
137 dsi->dev.bus = &mipi_dsi_bus_type;
138 dsi->dev.parent = host->dev;
139 dsi->dev.type = &mipi_dsi_device_type;
140
141 device_initialize(&dsi->dev);
142
143 return dsi;
144}
145
146static int mipi_dsi_device_add(struct mipi_dsi_device *dsi)
147{
148 struct mipi_dsi_host *host = dsi->host;
149
150 dev_set_name(&dsi->dev, "%s.%d", dev_name(host->dev), dsi->channel);
151
152 return device_add(&dsi->dev);
153}
154
155#if IS_ENABLED(CONFIG_OF)
156static struct mipi_dsi_device *
157of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
158{
159 struct mipi_dsi_device_info info = { };
160 int ret;
161 u32 reg;
162
163 if (of_modalias_node(node, info.type, sizeof(info.type)) < 0) {
164 drm_err(host, "modalias failure on %pOF\n", node);
165 return ERR_PTR(-EINVAL);
166 }
167
168 ret = of_property_read_u32(node, "reg", ®);
169 if (ret) {
170 drm_err(host, "device node %pOF has no valid reg property: %d\n",
171 node, ret);
172 return ERR_PTR(-EINVAL);
173 }
174
175 info.channel = reg;
176 info.node = of_node_get(node);
177
178 return mipi_dsi_device_register_full(host, &info);
179}
180#else
181static struct mipi_dsi_device *
182of_mipi_dsi_device_add(struct mipi_dsi_host *host, struct device_node *node)
183{
184 return ERR_PTR(-ENODEV);
185}
186#endif
187
188/**
189 * mipi_dsi_device_register_full - create a MIPI DSI device
190 * @host: DSI host to which this device is connected
191 * @info: pointer to template containing DSI device information
192 *
193 * Create a MIPI DSI device by using the device information provided by
194 * mipi_dsi_device_info template
195 *
196 * Returns:
197 * A pointer to the newly created MIPI DSI device, or, a pointer encoded
198 * with an error
199 */
200struct mipi_dsi_device *
201mipi_dsi_device_register_full(struct mipi_dsi_host *host,
202 const struct mipi_dsi_device_info *info)
203{
204 struct mipi_dsi_device *dsi;
205 int ret;
206
207 if (!info) {
208 drm_err(host, "invalid mipi_dsi_device_info pointer\n");
209 return ERR_PTR(-EINVAL);
210 }
211
212 if (info->channel > 3) {
213 drm_err(host, "invalid virtual channel: %u\n", info->channel);
214 return ERR_PTR(-EINVAL);
215 }
216
217 dsi = mipi_dsi_device_alloc(host);
218 if (IS_ERR(dsi)) {
219 drm_err(host, "failed to allocate DSI device %ld\n",
220 PTR_ERR(dsi));
221 return dsi;
222 }
223
224 dsi->dev.of_node = info->node;
225 dsi->channel = info->channel;
226 strlcpy(dsi->name, info->type, sizeof(dsi->name));
227
228 ret = mipi_dsi_device_add(dsi);
229 if (ret) {
230 drm_err(host, "failed to add DSI device %d\n", ret);
231 kfree(dsi);
232 return ERR_PTR(ret);
233 }
234
235 return dsi;
236}
237EXPORT_SYMBOL(mipi_dsi_device_register_full);
238
239/**
240 * mipi_dsi_device_unregister - unregister MIPI DSI device
241 * @dsi: DSI peripheral device
242 */
243void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi)
244{
245 device_unregister(&dsi->dev);
246}
247EXPORT_SYMBOL(mipi_dsi_device_unregister);
248
249static void devm_mipi_dsi_device_unregister(void *arg)
250{
251 struct mipi_dsi_device *dsi = arg;
252
253 mipi_dsi_device_unregister(dsi);
254}
255
256/**
257 * devm_mipi_dsi_device_register_full - create a managed MIPI DSI device
258 * @dev: device to tie the MIPI-DSI device lifetime to
259 * @host: DSI host to which this device is connected
260 * @info: pointer to template containing DSI device information
261 *
262 * Create a MIPI DSI device by using the device information provided by
263 * mipi_dsi_device_info template
264 *
265 * This is the managed version of mipi_dsi_device_register_full() which
266 * automatically calls mipi_dsi_device_unregister() when @dev is
267 * unbound.
268 *
269 * Returns:
270 * A pointer to the newly created MIPI DSI device, or, a pointer encoded
271 * with an error
272 */
273struct mipi_dsi_device *
274devm_mipi_dsi_device_register_full(struct device *dev,
275 struct mipi_dsi_host *host,
276 const struct mipi_dsi_device_info *info)
277{
278 struct mipi_dsi_device *dsi;
279 int ret;
280
281 dsi = mipi_dsi_device_register_full(host, info);
282 if (IS_ERR(dsi))
283 return dsi;
284
285 ret = devm_add_action_or_reset(dev,
286 devm_mipi_dsi_device_unregister,
287 dsi);
288 if (ret)
289 return ERR_PTR(ret);
290
291 return dsi;
292}
293EXPORT_SYMBOL_GPL(devm_mipi_dsi_device_register_full);
294
295static DEFINE_MUTEX(host_lock);
296static LIST_HEAD(host_list);
297
298/**
299 * of_find_mipi_dsi_host_by_node() - find the MIPI DSI host matching a
300 * device tree node
301 * @node: device tree node
302 *
303 * Returns:
304 * A pointer to the MIPI DSI host corresponding to @node or NULL if no
305 * such device exists (or has not been registered yet).
306 */
307struct mipi_dsi_host *of_find_mipi_dsi_host_by_node(struct device_node *node)
308{
309 struct mipi_dsi_host *host;
310
311 mutex_lock(&host_lock);
312
313 list_for_each_entry(host, &host_list, list) {
314 if (host->dev->of_node == node) {
315 mutex_unlock(&host_lock);
316 return host;
317 }
318 }
319
320 mutex_unlock(&host_lock);
321
322 return NULL;
323}
324EXPORT_SYMBOL(of_find_mipi_dsi_host_by_node);
325
326int mipi_dsi_host_register(struct mipi_dsi_host *host)
327{
328 struct device_node *node;
329
330 for_each_available_child_of_node(host->dev->of_node, node) {
331 /* skip nodes without reg property */
332 if (!of_find_property(node, "reg", NULL))
333 continue;
334 of_mipi_dsi_device_add(host, node);
335 }
336
337 mutex_lock(&host_lock);
338 list_add_tail(&host->list, &host_list);
339 mutex_unlock(&host_lock);
340
341 return 0;
342}
343EXPORT_SYMBOL(mipi_dsi_host_register);
344
345static int mipi_dsi_remove_device_fn(struct device *dev, void *priv)
346{
347 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
348
349 mipi_dsi_detach(dsi);
350 mipi_dsi_device_unregister(dsi);
351
352 return 0;
353}
354
355void mipi_dsi_host_unregister(struct mipi_dsi_host *host)
356{
357 device_for_each_child(host->dev, NULL, mipi_dsi_remove_device_fn);
358
359 mutex_lock(&host_lock);
360 list_del_init(&host->list);
361 mutex_unlock(&host_lock);
362}
363EXPORT_SYMBOL(mipi_dsi_host_unregister);
364
365/**
366 * mipi_dsi_attach - attach a DSI device to its DSI host
367 * @dsi: DSI peripheral
368 */
369int mipi_dsi_attach(struct mipi_dsi_device *dsi)
370{
371 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
372
373 if (!ops || !ops->attach)
374 return -ENOSYS;
375
376 return ops->attach(dsi->host, dsi);
377}
378EXPORT_SYMBOL(mipi_dsi_attach);
379
380/**
381 * mipi_dsi_detach - detach a DSI device from its DSI host
382 * @dsi: DSI peripheral
383 */
384int mipi_dsi_detach(struct mipi_dsi_device *dsi)
385{
386 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
387
388 if (!ops || !ops->detach)
389 return -ENOSYS;
390
391 return ops->detach(dsi->host, dsi);
392}
393EXPORT_SYMBOL(mipi_dsi_detach);
394
395static void devm_mipi_dsi_detach(void *arg)
396{
397 struct mipi_dsi_device *dsi = arg;
398
399 mipi_dsi_detach(dsi);
400}
401
402/**
403 * devm_mipi_dsi_attach - Attach a MIPI-DSI device to its DSI Host
404 * @dev: device to tie the MIPI-DSI device attachment lifetime to
405 * @dsi: DSI peripheral
406 *
407 * This is the managed version of mipi_dsi_attach() which automatically
408 * calls mipi_dsi_detach() when @dev is unbound.
409 *
410 * Returns:
411 * 0 on success, a negative error code on failure.
412 */
413int devm_mipi_dsi_attach(struct device *dev,
414 struct mipi_dsi_device *dsi)
415{
416 int ret;
417
418 ret = mipi_dsi_attach(dsi);
419 if (ret)
420 return ret;
421
422 ret = devm_add_action_or_reset(dev, devm_mipi_dsi_detach, dsi);
423 if (ret)
424 return ret;
425
426 return 0;
427}
428EXPORT_SYMBOL_GPL(devm_mipi_dsi_attach);
429
430static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,
431 struct mipi_dsi_msg *msg)
432{
433 const struct mipi_dsi_host_ops *ops = dsi->host->ops;
434
435 if (!ops || !ops->transfer)
436 return -ENOSYS;
437
438 if (dsi->mode_flags & MIPI_DSI_MODE_LPM)
439 msg->flags |= MIPI_DSI_MSG_USE_LPM;
440
441 return ops->transfer(dsi->host, msg);
442}
443
444/**
445 * mipi_dsi_packet_format_is_short - check if a packet is of the short format
446 * @type: MIPI DSI data type of the packet
447 *
448 * Return: true if the packet for the given data type is a short packet, false
449 * otherwise.
450 */
451bool mipi_dsi_packet_format_is_short(u8 type)
452{
453 switch (type) {
454 case MIPI_DSI_V_SYNC_START:
455 case MIPI_DSI_V_SYNC_END:
456 case MIPI_DSI_H_SYNC_START:
457 case MIPI_DSI_H_SYNC_END:
458 case MIPI_DSI_COMPRESSION_MODE:
459 case MIPI_DSI_END_OF_TRANSMISSION:
460 case MIPI_DSI_COLOR_MODE_OFF:
461 case MIPI_DSI_COLOR_MODE_ON:
462 case MIPI_DSI_SHUTDOWN_PERIPHERAL:
463 case MIPI_DSI_TURN_ON_PERIPHERAL:
464 case MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM:
465 case MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM:
466 case MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM:
467 case MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM:
468 case MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM:
469 case MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM:
470 case MIPI_DSI_DCS_SHORT_WRITE:
471 case MIPI_DSI_DCS_SHORT_WRITE_PARAM:
472 case MIPI_DSI_DCS_READ:
473 case MIPI_DSI_EXECUTE_QUEUE:
474 case MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE:
475 return true;
476 }
477
478 return false;
479}
480EXPORT_SYMBOL(mipi_dsi_packet_format_is_short);
481
482/**
483 * mipi_dsi_packet_format_is_long - check if a packet is of the long format
484 * @type: MIPI DSI data type of the packet
485 *
486 * Return: true if the packet for the given data type is a long packet, false
487 * otherwise.
488 */
489bool mipi_dsi_packet_format_is_long(u8 type)
490{
491 switch (type) {
492 case MIPI_DSI_NULL_PACKET:
493 case MIPI_DSI_BLANKING_PACKET:
494 case MIPI_DSI_GENERIC_LONG_WRITE:
495 case MIPI_DSI_DCS_LONG_WRITE:
496 case MIPI_DSI_PICTURE_PARAMETER_SET:
497 case MIPI_DSI_COMPRESSED_PIXEL_STREAM:
498 case MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20:
499 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24:
500 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16:
501 case MIPI_DSI_PACKED_PIXEL_STREAM_30:
502 case MIPI_DSI_PACKED_PIXEL_STREAM_36:
503 case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12:
504 case MIPI_DSI_PACKED_PIXEL_STREAM_16:
505 case MIPI_DSI_PACKED_PIXEL_STREAM_18:
506 case MIPI_DSI_PIXEL_STREAM_3BYTE_18:
507 case MIPI_DSI_PACKED_PIXEL_STREAM_24:
508 return true;
509 }
510
511 return false;
512}
513EXPORT_SYMBOL(mipi_dsi_packet_format_is_long);
514
515/**
516 * mipi_dsi_create_packet - create a packet from a message according to the
517 * DSI protocol
518 * @packet: pointer to a DSI packet structure
519 * @msg: message to translate into a packet
520 *
521 * Return: 0 on success or a negative error code on failure.
522 */
523int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
524 const struct mipi_dsi_msg *msg)
525{
526 if (!packet || !msg)
527 return -EINVAL;
528
529 /* do some minimum sanity checking */
530 if (!mipi_dsi_packet_format_is_short(msg->type) &&
531 !mipi_dsi_packet_format_is_long(msg->type))
532 return -EINVAL;
533
534 if (msg->channel > 3)
535 return -EINVAL;
536
537 memset(packet, 0, sizeof(*packet));
538 packet->header[0] = ((msg->channel & 0x3) << 6) | (msg->type & 0x3f);
539
540 /* TODO: compute ECC if hardware support is not available */
541
542 /*
543 * Long write packets contain the word count in header bytes 1 and 2.
544 * The payload follows the header and is word count bytes long.
545 *
546 * Short write packets encode up to two parameters in header bytes 1
547 * and 2.
548 */
549 if (mipi_dsi_packet_format_is_long(msg->type)) {
550 packet->header[1] = (msg->tx_len >> 0) & 0xff;
551 packet->header[2] = (msg->tx_len >> 8) & 0xff;
552
553 packet->payload_length = msg->tx_len;
554 packet->payload = msg->tx_buf;
555 } else {
556 const u8 *tx = msg->tx_buf;
557
558 packet->header[1] = (msg->tx_len > 0) ? tx[0] : 0;
559 packet->header[2] = (msg->tx_len > 1) ? tx[1] : 0;
560 }
561
562 packet->size = sizeof(packet->header) + packet->payload_length;
563
564 return 0;
565}
566EXPORT_SYMBOL(mipi_dsi_create_packet);
567
568/**
569 * mipi_dsi_shutdown_peripheral() - sends a Shutdown Peripheral command
570 * @dsi: DSI peripheral device
571 *
572 * Return: 0 on success or a negative error code on failure.
573 */
574int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)
575{
576 struct mipi_dsi_msg msg = {
577 .channel = dsi->channel,
578 .type = MIPI_DSI_SHUTDOWN_PERIPHERAL,
579 .tx_buf = (u8 [2]) { 0, 0 },
580 .tx_len = 2,
581 };
582 int ret = mipi_dsi_device_transfer(dsi, &msg);
583
584 return (ret < 0) ? ret : 0;
585}
586EXPORT_SYMBOL(mipi_dsi_shutdown_peripheral);
587
588/**
589 * mipi_dsi_turn_on_peripheral() - sends a Turn On Peripheral command
590 * @dsi: DSI peripheral device
591 *
592 * Return: 0 on success or a negative error code on failure.
593 */
594int mipi_dsi_turn_on_peripheral(struct mipi_dsi_device *dsi)
595{
596 struct mipi_dsi_msg msg = {
597 .channel = dsi->channel,
598 .type = MIPI_DSI_TURN_ON_PERIPHERAL,
599 .tx_buf = (u8 [2]) { 0, 0 },
600 .tx_len = 2,
601 };
602 int ret = mipi_dsi_device_transfer(dsi, &msg);
603
604 return (ret < 0) ? ret : 0;
605}
606EXPORT_SYMBOL(mipi_dsi_turn_on_peripheral);
607
608/*
609 * mipi_dsi_set_maximum_return_packet_size() - specify the maximum size of
610 * the payload in a long packet transmitted from the peripheral back to the
611 * host processor
612 * @dsi: DSI peripheral device
613 * @value: the maximum size of the payload
614 *
615 * Return: 0 on success or a negative error code on failure.
616 */
617int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
618 u16 value)
619{
620 u8 tx[2] = { value & 0xff, value >> 8 };
621 struct mipi_dsi_msg msg = {
622 .channel = dsi->channel,
623 .type = MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE,
624 .tx_len = sizeof(tx),
625 .tx_buf = tx,
626 };
627 int ret = mipi_dsi_device_transfer(dsi, &msg);
628
629 return (ret < 0) ? ret : 0;
630}
631EXPORT_SYMBOL(mipi_dsi_set_maximum_return_packet_size);
632
633/**
634 * mipi_dsi_compression_mode() - enable/disable DSC on the peripheral
635 * @dsi: DSI peripheral device
636 * @enable: Whether to enable or disable the DSC
637 *
638 * Enable or disable Display Stream Compression on the peripheral using the
639 * default Picture Parameter Set and VESA DSC 1.1 algorithm.
640 *
641 * Return: 0 on success or a negative error code on failure.
642 */
643ssize_t mipi_dsi_compression_mode(struct mipi_dsi_device *dsi, bool enable)
644{
645 /* Note: Needs updating for non-default PPS or algorithm */
646 u8 tx[2] = { enable << 0, 0 };
647 struct mipi_dsi_msg msg = {
648 .channel = dsi->channel,
649 .type = MIPI_DSI_COMPRESSION_MODE,
650 .tx_len = sizeof(tx),
651 .tx_buf = tx,
652 };
653 int ret = mipi_dsi_device_transfer(dsi, &msg);
654
655 return (ret < 0) ? ret : 0;
656}
657EXPORT_SYMBOL(mipi_dsi_compression_mode);
658
659/**
660 * mipi_dsi_picture_parameter_set() - transmit the DSC PPS to the peripheral
661 * @dsi: DSI peripheral device
662 * @pps: VESA DSC 1.1 Picture Parameter Set
663 *
664 * Transmit the VESA DSC 1.1 Picture Parameter Set to the peripheral.
665 *
666 * Return: 0 on success or a negative error code on failure.
667 */
668ssize_t mipi_dsi_picture_parameter_set(struct mipi_dsi_device *dsi,
669 const struct drm_dsc_picture_parameter_set *pps)
670{
671 struct mipi_dsi_msg msg = {
672 .channel = dsi->channel,
673 .type = MIPI_DSI_PICTURE_PARAMETER_SET,
674 .tx_len = sizeof(*pps),
675 .tx_buf = pps,
676 };
677 int ret = mipi_dsi_device_transfer(dsi, &msg);
678
679 return (ret < 0) ? ret : 0;
680}
681EXPORT_SYMBOL(mipi_dsi_picture_parameter_set);
682
683/**
684 * mipi_dsi_generic_write() - transmit data using a generic write packet
685 * @dsi: DSI peripheral device
686 * @payload: buffer containing the payload
687 * @size: size of payload buffer
688 *
689 * This function will automatically choose the right data type depending on
690 * the payload length.
691 *
692 * Return: The number of bytes transmitted on success or a negative error code
693 * on failure.
694 */
695ssize_t mipi_dsi_generic_write(struct mipi_dsi_device *dsi, const void *payload,
696 size_t size)
697{
698 struct mipi_dsi_msg msg = {
699 .channel = dsi->channel,
700 .tx_buf = payload,
701 .tx_len = size
702 };
703
704 switch (size) {
705 case 0:
706 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM;
707 break;
708
709 case 1:
710 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM;
711 break;
712
713 case 2:
714 msg.type = MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM;
715 break;
716
717 default:
718 msg.type = MIPI_DSI_GENERIC_LONG_WRITE;
719 break;
720 }
721
722 return mipi_dsi_device_transfer(dsi, &msg);
723}
724EXPORT_SYMBOL(mipi_dsi_generic_write);
725
726/**
727 * mipi_dsi_generic_read() - receive data using a generic read packet
728 * @dsi: DSI peripheral device
729 * @params: buffer containing the request parameters
730 * @num_params: number of request parameters
731 * @data: buffer in which to return the received data
732 * @size: size of receive buffer
733 *
734 * This function will automatically choose the right data type depending on
735 * the number of parameters passed in.
736 *
737 * Return: The number of bytes successfully read or a negative error code on
738 * failure.
739 */
740ssize_t mipi_dsi_generic_read(struct mipi_dsi_device *dsi, const void *params,
741 size_t num_params, void *data, size_t size)
742{
743 struct mipi_dsi_msg msg = {
744 .channel = dsi->channel,
745 .tx_len = num_params,
746 .tx_buf = params,
747 .rx_len = size,
748 .rx_buf = data
749 };
750
751 switch (num_params) {
752 case 0:
753 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM;
754 break;
755
756 case 1:
757 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM;
758 break;
759
760 case 2:
761 msg.type = MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM;
762 break;
763
764 default:
765 return -EINVAL;
766 }
767
768 return mipi_dsi_device_transfer(dsi, &msg);
769}
770EXPORT_SYMBOL(mipi_dsi_generic_read);
771
772/**
773 * mipi_dsi_dcs_write_buffer() - transmit a DCS command with payload
774 * @dsi: DSI peripheral device
775 * @data: buffer containing data to be transmitted
776 * @len: size of transmission buffer
777 *
778 * This function will automatically choose the right data type depending on
779 * the command payload length.
780 *
781 * Return: The number of bytes successfully transmitted or a negative error
782 * code on failure.
783 */
784ssize_t mipi_dsi_dcs_write_buffer(struct mipi_dsi_device *dsi,
785 const void *data, size_t len)
786{
787 struct mipi_dsi_msg msg = {
788 .channel = dsi->channel,
789 .tx_buf = data,
790 .tx_len = len
791 };
792
793 switch (len) {
794 case 0:
795 return -EINVAL;
796
797 case 1:
798 msg.type = MIPI_DSI_DCS_SHORT_WRITE;
799 break;
800
801 case 2:
802 msg.type = MIPI_DSI_DCS_SHORT_WRITE_PARAM;
803 break;
804
805 default:
806 msg.type = MIPI_DSI_DCS_LONG_WRITE;
807 break;
808 }
809
810 return mipi_dsi_device_transfer(dsi, &msg);
811}
812EXPORT_SYMBOL(mipi_dsi_dcs_write_buffer);
813
814/**
815 * mipi_dsi_dcs_write() - send DCS write command
816 * @dsi: DSI peripheral device
817 * @cmd: DCS command
818 * @data: buffer containing the command payload
819 * @len: command payload length
820 *
821 * This function will automatically choose the right data type depending on
822 * the command payload length.
823 *
824 * Return: The number of bytes successfully transmitted or a negative error
825 * code on failure.
826 */
827ssize_t mipi_dsi_dcs_write(struct mipi_dsi_device *dsi, u8 cmd,
828 const void *data, size_t len)
829{
830 ssize_t err;
831 size_t size;
832 u8 stack_tx[8];
833 u8 *tx;
834
835 size = 1 + len;
836 if (len > ARRAY_SIZE(stack_tx) - 1) {
837 tx = kmalloc(size, GFP_KERNEL);
838 if (!tx)
839 return -ENOMEM;
840 } else {
841 tx = stack_tx;
842 }
843
844 /* concatenate the DCS command byte and the payload */
845 tx[0] = cmd;
846 if (data)
847 memcpy(&tx[1], data, len);
848
849 err = mipi_dsi_dcs_write_buffer(dsi, tx, size);
850
851 if (tx != stack_tx)
852 kfree(tx);
853
854 return err;
855}
856EXPORT_SYMBOL(mipi_dsi_dcs_write);
857
858/**
859 * mipi_dsi_dcs_read() - send DCS read request command
860 * @dsi: DSI peripheral device
861 * @cmd: DCS command
862 * @data: buffer in which to receive data
863 * @len: size of receive buffer
864 *
865 * Return: The number of bytes read or a negative error code on failure.
866 */
867ssize_t mipi_dsi_dcs_read(struct mipi_dsi_device *dsi, u8 cmd, void *data,
868 size_t len)
869{
870 struct mipi_dsi_msg msg = {
871 .channel = dsi->channel,
872 .type = MIPI_DSI_DCS_READ,
873 .tx_buf = &cmd,
874 .tx_len = 1,
875 .rx_buf = data,
876 .rx_len = len
877 };
878
879 return mipi_dsi_device_transfer(dsi, &msg);
880}
881EXPORT_SYMBOL(mipi_dsi_dcs_read);
882
883/**
884 * mipi_dsi_dcs_nop() - send DCS nop packet
885 * @dsi: DSI peripheral device
886 *
887 * Return: 0 on success or a negative error code on failure.
888 */
889int mipi_dsi_dcs_nop(struct mipi_dsi_device *dsi)
890{
891 ssize_t err;
892
893 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_NOP, NULL, 0);
894 if (err < 0)
895 return err;
896
897 return 0;
898}
899EXPORT_SYMBOL(mipi_dsi_dcs_nop);
900
901/**
902 * mipi_dsi_dcs_soft_reset() - perform a software reset of the display module
903 * @dsi: DSI peripheral device
904 *
905 * Return: 0 on success or a negative error code on failure.
906 */
907int mipi_dsi_dcs_soft_reset(struct mipi_dsi_device *dsi)
908{
909 ssize_t err;
910
911 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SOFT_RESET, NULL, 0);
912 if (err < 0)
913 return err;
914
915 return 0;
916}
917EXPORT_SYMBOL(mipi_dsi_dcs_soft_reset);
918
919/**
920 * mipi_dsi_dcs_get_power_mode() - query the display module's current power
921 * mode
922 * @dsi: DSI peripheral device
923 * @mode: return location for the current power mode
924 *
925 * Return: 0 on success or a negative error code on failure.
926 */
927int mipi_dsi_dcs_get_power_mode(struct mipi_dsi_device *dsi, u8 *mode)
928{
929 ssize_t err;
930
931 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_POWER_MODE, mode,
932 sizeof(*mode));
933 if (err <= 0) {
934 if (err == 0)
935 err = -ENODATA;
936
937 return err;
938 }
939
940 return 0;
941}
942EXPORT_SYMBOL(mipi_dsi_dcs_get_power_mode);
943
944/**
945 * mipi_dsi_dcs_get_pixel_format() - gets the pixel format for the RGB image
946 * data used by the interface
947 * @dsi: DSI peripheral device
948 * @format: return location for the pixel format
949 *
950 * Return: 0 on success or a negative error code on failure.
951 */
952int mipi_dsi_dcs_get_pixel_format(struct mipi_dsi_device *dsi, u8 *format)
953{
954 ssize_t err;
955
956 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_PIXEL_FORMAT, format,
957 sizeof(*format));
958 if (err <= 0) {
959 if (err == 0)
960 err = -ENODATA;
961
962 return err;
963 }
964
965 return 0;
966}
967EXPORT_SYMBOL(mipi_dsi_dcs_get_pixel_format);
968
969/**
970 * mipi_dsi_dcs_enter_sleep_mode() - disable all unnecessary blocks inside the
971 * display module except interface communication
972 * @dsi: DSI peripheral device
973 *
974 * Return: 0 on success or a negative error code on failure.
975 */
976int mipi_dsi_dcs_enter_sleep_mode(struct mipi_dsi_device *dsi)
977{
978 ssize_t err;
979
980 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_ENTER_SLEEP_MODE, NULL, 0);
981 if (err < 0)
982 return err;
983
984 return 0;
985}
986EXPORT_SYMBOL(mipi_dsi_dcs_enter_sleep_mode);
987
988/**
989 * mipi_dsi_dcs_exit_sleep_mode() - enable all blocks inside the display
990 * module
991 * @dsi: DSI peripheral device
992 *
993 * Return: 0 on success or a negative error code on failure.
994 */
995int mipi_dsi_dcs_exit_sleep_mode(struct mipi_dsi_device *dsi)
996{
997 ssize_t err;
998
999 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_EXIT_SLEEP_MODE, NULL, 0);
1000 if (err < 0)
1001 return err;
1002
1003 return 0;
1004}
1005EXPORT_SYMBOL(mipi_dsi_dcs_exit_sleep_mode);
1006
1007/**
1008 * mipi_dsi_dcs_set_display_off() - stop displaying the image data on the
1009 * display device
1010 * @dsi: DSI peripheral device
1011 *
1012 * Return: 0 on success or a negative error code on failure.
1013 */
1014int mipi_dsi_dcs_set_display_off(struct mipi_dsi_device *dsi)
1015{
1016 ssize_t err;
1017
1018 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_OFF, NULL, 0);
1019 if (err < 0)
1020 return err;
1021
1022 return 0;
1023}
1024EXPORT_SYMBOL(mipi_dsi_dcs_set_display_off);
1025
1026/**
1027 * mipi_dsi_dcs_set_display_on() - start displaying the image data on the
1028 * display device
1029 * @dsi: DSI peripheral device
1030 *
1031 * Return: 0 on success or a negative error code on failure
1032 */
1033int mipi_dsi_dcs_set_display_on(struct mipi_dsi_device *dsi)
1034{
1035 ssize_t err;
1036
1037 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_ON, NULL, 0);
1038 if (err < 0)
1039 return err;
1040
1041 return 0;
1042}
1043EXPORT_SYMBOL(mipi_dsi_dcs_set_display_on);
1044
1045/**
1046 * mipi_dsi_dcs_set_column_address() - define the column extent of the frame
1047 * memory accessed by the host processor
1048 * @dsi: DSI peripheral device
1049 * @start: first column of frame memory
1050 * @end: last column of frame memory
1051 *
1052 * Return: 0 on success or a negative error code on failure.
1053 */
1054int mipi_dsi_dcs_set_column_address(struct mipi_dsi_device *dsi, u16 start,
1055 u16 end)
1056{
1057 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1058 ssize_t err;
1059
1060 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_COLUMN_ADDRESS, payload,
1061 sizeof(payload));
1062 if (err < 0)
1063 return err;
1064
1065 return 0;
1066}
1067EXPORT_SYMBOL(mipi_dsi_dcs_set_column_address);
1068
1069/**
1070 * mipi_dsi_dcs_set_page_address() - define the page extent of the frame
1071 * memory accessed by the host processor
1072 * @dsi: DSI peripheral device
1073 * @start: first page of frame memory
1074 * @end: last page of frame memory
1075 *
1076 * Return: 0 on success or a negative error code on failure.
1077 */
1078int mipi_dsi_dcs_set_page_address(struct mipi_dsi_device *dsi, u16 start,
1079 u16 end)
1080{
1081 u8 payload[4] = { start >> 8, start & 0xff, end >> 8, end & 0xff };
1082 ssize_t err;
1083
1084 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PAGE_ADDRESS, payload,
1085 sizeof(payload));
1086 if (err < 0)
1087 return err;
1088
1089 return 0;
1090}
1091EXPORT_SYMBOL(mipi_dsi_dcs_set_page_address);
1092
1093/**
1094 * mipi_dsi_dcs_set_tear_off() - turn off the display module's Tearing Effect
1095 * output signal on the TE signal line
1096 * @dsi: DSI peripheral device
1097 *
1098 * Return: 0 on success or a negative error code on failure
1099 */
1100int mipi_dsi_dcs_set_tear_off(struct mipi_dsi_device *dsi)
1101{
1102 ssize_t err;
1103
1104 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_OFF, NULL, 0);
1105 if (err < 0)
1106 return err;
1107
1108 return 0;
1109}
1110EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_off);
1111
1112/**
1113 * mipi_dsi_dcs_set_tear_on() - turn on the display module's Tearing Effect
1114 * output signal on the TE signal line.
1115 * @dsi: DSI peripheral device
1116 * @mode: the Tearing Effect Output Line mode
1117 *
1118 * Return: 0 on success or a negative error code on failure
1119 */
1120int mipi_dsi_dcs_set_tear_on(struct mipi_dsi_device *dsi,
1121 enum mipi_dsi_dcs_tear_mode mode)
1122{
1123 u8 value = mode;
1124 ssize_t err;
1125
1126 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_ON, &value,
1127 sizeof(value));
1128 if (err < 0)
1129 return err;
1130
1131 return 0;
1132}
1133EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_on);
1134
1135/**
1136 * mipi_dsi_dcs_set_pixel_format() - sets the pixel format for the RGB image
1137 * data used by the interface
1138 * @dsi: DSI peripheral device
1139 * @format: pixel format
1140 *
1141 * Return: 0 on success or a negative error code on failure.
1142 */
1143int mipi_dsi_dcs_set_pixel_format(struct mipi_dsi_device *dsi, u8 format)
1144{
1145 ssize_t err;
1146
1147 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_PIXEL_FORMAT, &format,
1148 sizeof(format));
1149 if (err < 0)
1150 return err;
1151
1152 return 0;
1153}
1154EXPORT_SYMBOL(mipi_dsi_dcs_set_pixel_format);
1155
1156/**
1157 * mipi_dsi_dcs_set_tear_scanline() - set the scanline to use as trigger for
1158 * the Tearing Effect output signal of the display module
1159 * @dsi: DSI peripheral device
1160 * @scanline: scanline to use as trigger
1161 *
1162 * Return: 0 on success or a negative error code on failure
1163 */
1164int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)
1165{
1166 u8 payload[2] = { scanline >> 8, scanline & 0xff };
1167 ssize_t err;
1168
1169 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_SCANLINE, payload,
1170 sizeof(payload));
1171 if (err < 0)
1172 return err;
1173
1174 return 0;
1175}
1176EXPORT_SYMBOL(mipi_dsi_dcs_set_tear_scanline);
1177
1178/**
1179 * mipi_dsi_dcs_set_display_brightness() - sets the brightness value of the
1180 * display
1181 * @dsi: DSI peripheral device
1182 * @brightness: brightness value
1183 *
1184 * Return: 0 on success or a negative error code on failure.
1185 */
1186int mipi_dsi_dcs_set_display_brightness(struct mipi_dsi_device *dsi,
1187 u16 brightness)
1188{
1189 u8 payload[2] = { brightness & 0xff, brightness >> 8 };
1190 ssize_t err;
1191
1192 err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1193 payload, sizeof(payload));
1194 if (err < 0)
1195 return err;
1196
1197 return 0;
1198}
1199EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness);
1200
1201/**
1202 * mipi_dsi_dcs_get_display_brightness() - gets the current brightness value
1203 * of the display
1204 * @dsi: DSI peripheral device
1205 * @brightness: brightness value
1206 *
1207 * Return: 0 on success or a negative error code on failure.
1208 */
1209int mipi_dsi_dcs_get_display_brightness(struct mipi_dsi_device *dsi,
1210 u16 *brightness)
1211{
1212 ssize_t err;
1213
1214 err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1215 brightness, sizeof(*brightness));
1216 if (err <= 0) {
1217 if (err == 0)
1218 err = -ENODATA;
1219
1220 return err;
1221 }
1222
1223 return 0;
1224}
1225EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness);
1226
1227static int mipi_dsi_drv_probe(struct device *dev)
1228{
1229 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1230 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1231
1232 return drv->probe(dsi);
1233}
1234
1235static int mipi_dsi_drv_remove(struct device *dev)
1236{
1237 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1238 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1239
1240 drv->remove(dsi);
1241
1242 return 0;
1243}
1244
1245static void mipi_dsi_drv_shutdown(struct device *dev)
1246{
1247 struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1248 struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1249
1250 drv->shutdown(dsi);
1251}
1252
1253/**
1254 * mipi_dsi_driver_register_full() - register a driver for DSI devices
1255 * @drv: DSI driver structure
1256 * @owner: owner module
1257 *
1258 * Return: 0 on success or a negative error code on failure.
1259 */
1260int mipi_dsi_driver_register_full(struct mipi_dsi_driver *drv,
1261 struct module *owner)
1262{
1263 drv->driver.bus = &mipi_dsi_bus_type;
1264 drv->driver.owner = owner;
1265
1266 if (drv->probe)
1267 drv->driver.probe = mipi_dsi_drv_probe;
1268 if (drv->remove)
1269 drv->driver.remove = mipi_dsi_drv_remove;
1270 if (drv->shutdown)
1271 drv->driver.shutdown = mipi_dsi_drv_shutdown;
1272
1273 return driver_register(&drv->driver);
1274}
1275EXPORT_SYMBOL(mipi_dsi_driver_register_full);
1276
1277/**
1278 * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1279 * @drv: DSI driver structure
1280 *
1281 * Return: 0 on success or a negative error code on failure.
1282 */
1283void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv)
1284{
1285 driver_unregister(&drv->driver);
1286}
1287EXPORT_SYMBOL(mipi_dsi_driver_unregister);
1288
1289static int __init mipi_dsi_bus_init(void)
1290{
1291 return bus_register(&mipi_dsi_bus_type);
1292}
1293postcore_initcall(mipi_dsi_bus_init);
1294
1295MODULE_AUTHOR("Andrzej Hajda <a.hajda@samsung.com>");
1296MODULE_DESCRIPTION("MIPI DSI Bus");
1297MODULE_LICENSE("GPL and additional rights");