drivers/gpu/drm/drm_mipi_dsi.c

   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
  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
  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 static 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  */
 109 struct 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 }
 117 EXPORT_SYMBOL(of_find_mipi_dsi_device_by_node);
 118
 119 static 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
 127 static const struct device_type mipi_dsi_device_type = {
 128         .release = mipi_dsi_dev_release,
 129 };
 130
 131 static 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
 149 static 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)
 159 static struct mipi_dsi_device *
 160 of_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", &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
 185 static struct mipi_dsi_device *
 186 of_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  */
 204 struct mipi_dsi_device *
 205 mipi_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 }
 242 EXPORT_SYMBOL(mipi_dsi_device_register_full);
 243
 244 /**
 245  * mipi_dsi_device_unregister - unregister MIPI DSI device
 246  * @dsi: DSI peripheral device
 247  */
 248 void mipi_dsi_device_unregister(struct mipi_dsi_device *dsi)
 249 {
 250         device_unregister(&dsi->dev);
 251 }
 252 EXPORT_SYMBOL(mipi_dsi_device_unregister);
 253
 254 static DEFINE_MUTEX(host_lock);
 255 static 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  */
 266 struct 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 }
 283 EXPORT_SYMBOL(of_find_mipi_dsi_host_by_node);
 284
 285 int 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 }
 302 EXPORT_SYMBOL(mipi_dsi_host_register);
 303
 304 static 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_detach(dsi);
 309         mipi_dsi_device_unregister(dsi);
 310
 311         return 0;
 312 }
 313
 314 void mipi_dsi_host_unregister(struct mipi_dsi_host *host)
 315 {
 316         device_for_each_child(host->dev, NULL, mipi_dsi_remove_device_fn);
 317
 318         mutex_lock(&host_lock);
 319         list_del_init(&host->list);
 320         mutex_unlock(&host_lock);
 321 }
 322 EXPORT_SYMBOL(mipi_dsi_host_unregister);
 323
 324 /**
 325  * mipi_dsi_attach - attach a DSI device to its DSI host
 326  * @dsi: DSI peripheral
 327  */
 328 int mipi_dsi_attach(struct mipi_dsi_device *dsi)
 329 {
 330         const struct mipi_dsi_host_ops *ops = dsi->host->ops;
 331
 332         if (!ops || !ops->attach)
 333                 return -ENOSYS;
 334
 335         return ops->attach(dsi->host, dsi);
 336 }
 337 EXPORT_SYMBOL(mipi_dsi_attach);
 338
 339 /**
 340  * mipi_dsi_detach - detach a DSI device from its DSI host
 341  * @dsi: DSI peripheral
 342  */
 343 int mipi_dsi_detach(struct mipi_dsi_device *dsi)
 344 {
 345         const struct mipi_dsi_host_ops *ops = dsi->host->ops;
 346
 347         if (!ops || !ops->detach)
 348                 return -ENOSYS;
 349
 350         return ops->detach(dsi->host, dsi);
 351 }
 352 EXPORT_SYMBOL(mipi_dsi_detach);
 353
 354 static ssize_t mipi_dsi_device_transfer(struct mipi_dsi_device *dsi,
 355                                         struct mipi_dsi_msg *msg)
 356 {
 357         const struct mipi_dsi_host_ops *ops = dsi->host->ops;
 358
 359         if (!ops || !ops->transfer)
 360                 return -ENOSYS;
 361
 362         if (dsi->mode_flags & MIPI_DSI_MODE_LPM)
 363                 msg->flags |= MIPI_DSI_MSG_USE_LPM;
 364
 365         return ops->transfer(dsi->host, msg);
 366 }
 367
 368 /**
 369  * mipi_dsi_packet_format_is_short - check if a packet is of the short format
 370  * @type: MIPI DSI data type of the packet
 371  *
 372  * Return: true if the packet for the given data type is a short packet, false
 373  * otherwise.
 374  */
 375 bool mipi_dsi_packet_format_is_short(u8 type)
 376 {
 377         switch (type) {
 378         case MIPI_DSI_V_SYNC_START:
 379         case MIPI_DSI_V_SYNC_END:
 380         case MIPI_DSI_H_SYNC_START:
 381         case MIPI_DSI_H_SYNC_END:
 382         case MIPI_DSI_END_OF_TRANSMISSION:
 383         case MIPI_DSI_COLOR_MODE_OFF:
 384         case MIPI_DSI_COLOR_MODE_ON:
 385         case MIPI_DSI_SHUTDOWN_PERIPHERAL:
 386         case MIPI_DSI_TURN_ON_PERIPHERAL:
 387         case MIPI_DSI_GENERIC_SHORT_WRITE_0_PARAM:
 388         case MIPI_DSI_GENERIC_SHORT_WRITE_1_PARAM:
 389         case MIPI_DSI_GENERIC_SHORT_WRITE_2_PARAM:
 390         case MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM:
 391         case MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM:
 392         case MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM:
 393         case MIPI_DSI_DCS_SHORT_WRITE:
 394         case MIPI_DSI_DCS_SHORT_WRITE_PARAM:
 395         case MIPI_DSI_DCS_READ:
 396         case MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE:
 397                 return true;
 398         }
 399
 400         return false;
 401 }
 402 EXPORT_SYMBOL(mipi_dsi_packet_format_is_short);
 403
 404 /**
 405  * mipi_dsi_packet_format_is_long - check if a packet is of the long format
 406  * @type: MIPI DSI data type of the packet
 407  *
 408  * Return: true if the packet for the given data type is a long packet, false
 409  * otherwise.
 410  */
 411 bool mipi_dsi_packet_format_is_long(u8 type)
 412 {
 413         switch (type) {
 414         case MIPI_DSI_NULL_PACKET:
 415         case MIPI_DSI_BLANKING_PACKET:
 416         case MIPI_DSI_GENERIC_LONG_WRITE:
 417         case MIPI_DSI_DCS_LONG_WRITE:
 418         case MIPI_DSI_LOOSELY_PACKED_PIXEL_STREAM_YCBCR20:
 419         case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR24:
 420         case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR16:
 421         case MIPI_DSI_PACKED_PIXEL_STREAM_30:
 422         case MIPI_DSI_PACKED_PIXEL_STREAM_36:
 423         case MIPI_DSI_PACKED_PIXEL_STREAM_YCBCR12:
 424         case MIPI_DSI_PACKED_PIXEL_STREAM_16:
 425         case MIPI_DSI_PACKED_PIXEL_STREAM_18:
 426         case MIPI_DSI_PIXEL_STREAM_3BYTE_18:
 427         case MIPI_DSI_PACKED_PIXEL_STREAM_24:
 428                 return true;
 429         }
 430
 431         return false;
 432 }
 433 EXPORT_SYMBOL(mipi_dsi_packet_format_is_long);
 434
 435 /**
 436  * mipi_dsi_create_packet - create a packet from a message according to the
 437  *     DSI protocol
 438  * @packet: pointer to a DSI packet structure
 439  * @msg: message to translate into a packet
 440  *
 441  * Return: 0 on success or a negative error code on failure.
 442  */
 443 int mipi_dsi_create_packet(struct mipi_dsi_packet *packet,
 444                            const struct mipi_dsi_msg *msg)
 445 {
 446         if (!packet || !msg)
 447                 return -EINVAL;
 448
 449         /* do some minimum sanity checking */
 450         if (!mipi_dsi_packet_format_is_short(msg->type) &&
 451             !mipi_dsi_packet_format_is_long(msg->type))
 452                 return -EINVAL;
 453
 454         if (msg->channel > 3)
 455                 return -EINVAL;
 456
 457         memset(packet, 0, sizeof(*packet));
 458         packet->header[0] = ((msg->channel & 0x3) << 6) | (msg->type & 0x3f);
 459
 460         /* TODO: compute ECC if hardware support is not available */
 461
 462         /*
 463          * Long write packets contain the word count in header bytes 1 and 2.
 464          * The payload follows the header and is word count bytes long.
 465          *
 466          * Short write packets encode up to two parameters in header bytes 1
 467          * and 2.
 468          */
 469         if (mipi_dsi_packet_format_is_long(msg->type)) {
 470                 packet->header[1] = (msg->tx_len >> 0) & 0xff;
 471                 packet->header[2] = (msg->tx_len >> 8) & 0xff;
 472
 473                 packet->payload_length = msg->tx_len;
 474                 packet->payload = msg->tx_buf;
 475         } else {
 476                 const u8 *tx = msg->tx_buf;
 477
 478                 packet->header[1] = (msg->tx_len > 0) ? tx[0] : 0;
 479                 packet->header[2] = (msg->tx_len > 1) ? tx[1] : 0;
 480         }
 481
 482         packet->size = sizeof(packet->header) + packet->payload_length;
 483
 484         return 0;
 485 }
 486 EXPORT_SYMBOL(mipi_dsi_create_packet);
 487
 488 /**
 489  * mipi_dsi_shutdown_peripheral() - sends a Shutdown Peripheral command
 490  * @dsi: DSI peripheral device
 491  *
 492  * Return: 0 on success or a negative error code on failure.
 493  */
 494 int mipi_dsi_shutdown_peripheral(struct mipi_dsi_device *dsi)
 495 {
 496         struct mipi_dsi_msg msg = {
 497                 .channel = dsi->channel,
 498                 .type = MIPI_DSI_SHUTDOWN_PERIPHERAL,
 499                 .tx_buf = (u8 [2]) { 0, 0 },
 500                 .tx_len = 2,
 501         };
 502
 503         return mipi_dsi_device_transfer(dsi, &msg);
 504 }
 505 EXPORT_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  */
 513 int 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
 522         return mipi_dsi_device_transfer(dsi, &msg);
 523 }
 524 EXPORT_SYMBOL(mipi_dsi_turn_on_peripheral);
 525
 526 /*
 527  * mipi_dsi_set_maximum_return_packet_size() - specify the maximum size of the
 528  *    the payload in a long packet transmitted from the peripheral back to the
 529  *    host processor
 530  * @dsi: DSI peripheral device
 531  * @value: the maximum size of the payload
 532  *
 533  * Return: 0 on success or a negative error code on failure.
 534  */
 535 int mipi_dsi_set_maximum_return_packet_size(struct mipi_dsi_device *dsi,
 536                                             u16 value)
 537 {
 538         u8 tx[2] = { value & 0xff, value >> 8 };
 539         struct mipi_dsi_msg msg = {
 540                 .channel = dsi->channel,
 541                 .type = MIPI_DSI_SET_MAXIMUM_RETURN_PACKET_SIZE,
 542                 .tx_len = sizeof(tx),
 543                 .tx_buf = tx,
 544         };
 545
 546         return mipi_dsi_device_transfer(dsi, &msg);
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
 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  */
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  */
1031 int mipi_dsi_dcs_set_tear_scanline(struct mipi_dsi_device *dsi, u16 scanline)
1032 {
1033         u8 payload[2] = { scanline >> 8, scanline & 0xff };
1034         ssize_t err;
1035
1036         err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_TEAR_SCANLINE, payload,
1037                                  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  */
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  */
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
1094 /**
1095  * mipi_dsi_dcs_set_display_brightness_large() - sets the 16-bit brightness value
1096  *    of the display
1097  * @dsi: DSI peripheral device
1098  * @brightness: brightness value
1099  *
1100  * Return: 0 on success or a negative error code on failure.
1101  */
1102 int mipi_dsi_dcs_set_display_brightness_large(struct mipi_dsi_device *dsi,
1103                                              u16 brightness)
1104 {
1105         u8 payload[2] = { brightness >> 8, brightness & 0xff };
1106         ssize_t err;
1107
1108         err = mipi_dsi_dcs_write(dsi, MIPI_DCS_SET_DISPLAY_BRIGHTNESS,
1109                                  payload, sizeof(payload));
1110         if (err < 0)
1111                 return err;
1112
1113         return 0;
1114 }
1115 EXPORT_SYMBOL(mipi_dsi_dcs_set_display_brightness_large);
1116
1117 /**
1118  * mipi_dsi_dcs_get_display_brightness_large() - gets the current 16-bit
1119  *    brightness value of the display
1120  * @dsi: DSI peripheral device
1121  * @brightness: brightness value
1122  *
1123  * Return: 0 on success or a negative error code on failure.
1124  */
1125 int mipi_dsi_dcs_get_display_brightness_large(struct mipi_dsi_device *dsi,
1126                                              u16 *brightness)
1127 {
1128         u8 brightness_be[2];
1129         ssize_t err;
1130
1131         err = mipi_dsi_dcs_read(dsi, MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
1132                                 brightness_be, sizeof(brightness_be));
1133         if (err <= 0) {
1134                 if (err == 0)
1135                         err = -ENODATA;
1136
1137                 return err;
1138         }
1139
1140         *brightness = (brightness_be[0] << 8) | brightness_be[1];
1141
1142         return 0;
1143 }
1144 EXPORT_SYMBOL(mipi_dsi_dcs_get_display_brightness_large);
1145
1146 static int mipi_dsi_drv_probe(struct device *dev)
1147 {
1148         struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1149         struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1150
1151         return drv->probe(dsi);
1152 }
1153
1154 static int mipi_dsi_drv_remove(struct device *dev)
1155 {
1156         struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1157         struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1158
1159         return drv->remove(dsi);
1160 }
1161
1162 static void mipi_dsi_drv_shutdown(struct device *dev)
1163 {
1164         struct mipi_dsi_driver *drv = to_mipi_dsi_driver(dev->driver);
1165         struct mipi_dsi_device *dsi = to_mipi_dsi_device(dev);
1166
1167         drv->shutdown(dsi);
1168 }
1169
1170 /**
1171  * mipi_dsi_driver_register_full() - register a driver for DSI devices
1172  * @drv: DSI driver structure
1173  * @owner: owner module
1174  *
1175  * Return: 0 on success or a negative error code on failure.
1176  */
1177 int mipi_dsi_driver_register_full(struct mipi_dsi_driver *drv,
1178                                   struct module *owner)
1179 {
1180         drv->driver.bus = &mipi_dsi_bus_type;
1181         drv->driver.owner = owner;
1182
1183         if (drv->probe)
1184                 drv->driver.probe = mipi_dsi_drv_probe;
1185         if (drv->remove)
1186                 drv->driver.remove = mipi_dsi_drv_remove;
1187         if (drv->shutdown)
1188                 drv->driver.shutdown = mipi_dsi_drv_shutdown;
1189
1190         return driver_register(&drv->driver);
1191 }
1192 EXPORT_SYMBOL(mipi_dsi_driver_register_full);
1193
1194 /**
1195  * mipi_dsi_driver_unregister() - unregister a driver for DSI devices
1196  * @drv: DSI driver structure
1197  *
1198  * Return: 0 on success or a negative error code on failure.
1199  */
1200 void mipi_dsi_driver_unregister(struct mipi_dsi_driver *drv)
1201 {
1202         driver_unregister(&drv->driver);
1203 }
1204 EXPORT_SYMBOL(mipi_dsi_driver_unregister);
1205
1206 static int __init mipi_dsi_bus_init(void)
1207 {
1208         return bus_register(&mipi_dsi_bus_type);
1209 }
1210 postcore_initcall(mipi_dsi_bus_init);
1211
1212 MODULE_AUTHOR("Andrzej Hajda <a.hajda@samsung.com>");
1213 MODULE_DESCRIPTION("MIPI DSI Bus");
1214 MODULE_LICENSE("GPL and additional rights");