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