1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) STMicroelectronics SA 2017
5 * Authors: Philippe Cornu <philippe.cornu@st.com>
6 * Yannick Fertre <yannick.fertre@st.com>
10 #include <drm/drm_mipi_dsi.h>
11 #include <drm/drm_panel.h>
12 #include <linux/backlight.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/regulator/consumer.h>
15 #include <video/mipi_display.h>
17 #define OTM8009A_BACKLIGHT_DEFAULT 240
18 #define OTM8009A_BACKLIGHT_MAX 255
20 /* Manufacturer Command Set */
21 #define MCS_ADRSFT 0x0000 /* Address Shift Function */
22 #define MCS_PANSET 0xB3A6 /* Panel Type Setting */
23 #define MCS_SD_CTRL 0xC0A2 /* Source Driver Timing Setting */
24 #define MCS_P_DRV_M 0xC0B4 /* Panel Driving Mode */
25 #define MCS_OSC_ADJ 0xC181 /* Oscillator Adjustment for Idle/Normal mode */
26 #define MCS_RGB_VID_SET 0xC1A1 /* RGB Video Mode Setting */
27 #define MCS_SD_PCH_CTRL 0xC480 /* Source Driver Precharge Control */
28 #define MCS_NO_DOC1 0xC48A /* Command not documented */
29 #define MCS_PWR_CTRL1 0xC580 /* Power Control Setting 1 */
30 #define MCS_PWR_CTRL2 0xC590 /* Power Control Setting 2 for Normal Mode */
31 #define MCS_PWR_CTRL4 0xC5B0 /* Power Control Setting 4 for DC Voltage */
32 #define MCS_PANCTRLSET1 0xCB80 /* Panel Control Setting 1 */
33 #define MCS_PANCTRLSET2 0xCB90 /* Panel Control Setting 2 */
34 #define MCS_PANCTRLSET3 0xCBA0 /* Panel Control Setting 3 */
35 #define MCS_PANCTRLSET4 0xCBB0 /* Panel Control Setting 4 */
36 #define MCS_PANCTRLSET5 0xCBC0 /* Panel Control Setting 5 */
37 #define MCS_PANCTRLSET6 0xCBD0 /* Panel Control Setting 6 */
38 #define MCS_PANCTRLSET7 0xCBE0 /* Panel Control Setting 7 */
39 #define MCS_PANCTRLSET8 0xCBF0 /* Panel Control Setting 8 */
40 #define MCS_PANU2D1 0xCC80 /* Panel U2D Setting 1 */
41 #define MCS_PANU2D2 0xCC90 /* Panel U2D Setting 2 */
42 #define MCS_PANU2D3 0xCCA0 /* Panel U2D Setting 3 */
43 #define MCS_PAND2U1 0xCCB0 /* Panel D2U Setting 1 */
44 #define MCS_PAND2U2 0xCCC0 /* Panel D2U Setting 2 */
45 #define MCS_PAND2U3 0xCCD0 /* Panel D2U Setting 3 */
46 #define MCS_GOAVST 0xCE80 /* GOA VST Setting */
47 #define MCS_GOACLKA1 0xCEA0 /* GOA CLKA1 Setting */
48 #define MCS_GOACLKA3 0xCEB0 /* GOA CLKA3 Setting */
49 #define MCS_GOAECLK 0xCFC0 /* GOA ECLK Setting */
50 #define MCS_NO_DOC2 0xCFD0 /* Command not documented */
51 #define MCS_GVDDSET 0xD800 /* GVDD/NGVDD */
52 #define MCS_VCOMDC 0xD900 /* VCOM Voltage Setting */
53 #define MCS_GMCT2_2P 0xE100 /* Gamma Correction 2.2+ Setting */
54 #define MCS_GMCT2_2N 0xE200 /* Gamma Correction 2.2- Setting */
55 #define MCS_NO_DOC3 0xF5B6 /* Command not documented */
56 #define MCS_CMD2_ENA1 0xFF00 /* Enable Access Command2 "CMD2" */
57 #define MCS_CMD2_ENA2 0xFF80 /* Enable Access Orise Command2 */
61 struct drm_panel panel
;
62 struct backlight_device
*bl_dev
;
63 struct gpio_desc
*reset_gpio
;
64 struct regulator
*supply
;
69 static const struct drm_display_mode default_mode
= {
72 .hsync_start
= 480 + 120,
73 .hsync_end
= 480 + 120 + 63,
74 .htotal
= 480 + 120 + 63 + 120,
76 .vsync_start
= 800 + 12,
77 .vsync_end
= 800 + 12 + 12,
78 .vtotal
= 800 + 12 + 12 + 12,
85 static inline struct otm8009a
*panel_to_otm8009a(struct drm_panel
*panel
)
87 return container_of(panel
, struct otm8009a
, panel
);
90 static void otm8009a_dcs_write_buf(struct otm8009a
*ctx
, const void *data
,
93 struct mipi_dsi_device
*dsi
= to_mipi_dsi_device(ctx
->dev
);
95 if (mipi_dsi_dcs_write_buffer(dsi
, data
, len
) < 0)
96 DRM_WARN("mipi dsi dcs write buffer failed\n");
99 static void otm8009a_dcs_write_buf_hs(struct otm8009a
*ctx
, const void *data
,
102 struct mipi_dsi_device
*dsi
= to_mipi_dsi_device(ctx
->dev
);
104 /* data will be sent in dsi hs mode (ie. no lpm) */
105 dsi
->mode_flags
&= ~MIPI_DSI_MODE_LPM
;
107 otm8009a_dcs_write_buf(ctx
, data
, len
);
109 /* restore back the dsi lpm mode */
110 dsi
->mode_flags
|= MIPI_DSI_MODE_LPM
;
113 #define dcs_write_seq(ctx, seq...) \
115 static const u8 d[] = { seq }; \
116 otm8009a_dcs_write_buf(ctx, d, ARRAY_SIZE(d)); \
119 #define dcs_write_cmd_at(ctx, cmd, seq...) \
121 dcs_write_seq(ctx, MCS_ADRSFT, (cmd) & 0xFF); \
122 dcs_write_seq(ctx, (cmd) >> 8, seq); \
125 static int otm8009a_init_sequence(struct otm8009a
*ctx
)
127 struct mipi_dsi_device
*dsi
= to_mipi_dsi_device(ctx
->dev
);
131 dcs_write_cmd_at(ctx
, MCS_CMD2_ENA1
, 0x80, 0x09, 0x01);
133 /* Enter Orise Command2 */
134 dcs_write_cmd_at(ctx
, MCS_CMD2_ENA2
, 0x80, 0x09);
136 dcs_write_cmd_at(ctx
, MCS_SD_PCH_CTRL
, 0x30);
139 dcs_write_cmd_at(ctx
, MCS_NO_DOC1
, 0x40);
142 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL4
+ 1, 0xA9);
143 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL2
+ 1, 0x34);
144 dcs_write_cmd_at(ctx
, MCS_P_DRV_M
, 0x50);
145 dcs_write_cmd_at(ctx
, MCS_VCOMDC
, 0x4E);
146 dcs_write_cmd_at(ctx
, MCS_OSC_ADJ
, 0x66); /* 65Hz */
147 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL2
+ 2, 0x01);
148 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL2
+ 5, 0x34);
149 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL2
+ 4, 0x33);
150 dcs_write_cmd_at(ctx
, MCS_GVDDSET
, 0x79, 0x79);
151 dcs_write_cmd_at(ctx
, MCS_SD_CTRL
+ 1, 0x1B);
152 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL1
+ 2, 0x83);
153 dcs_write_cmd_at(ctx
, MCS_SD_PCH_CTRL
+ 1, 0x83);
154 dcs_write_cmd_at(ctx
, MCS_RGB_VID_SET
, 0x0E);
155 dcs_write_cmd_at(ctx
, MCS_PANSET
, 0x00, 0x01);
157 dcs_write_cmd_at(ctx
, MCS_GOAVST
, 0x85, 0x01, 0x00, 0x84, 0x01, 0x00);
158 dcs_write_cmd_at(ctx
, MCS_GOACLKA1
, 0x18, 0x04, 0x03, 0x39, 0x00, 0x00,
159 0x00, 0x18, 0x03, 0x03, 0x3A, 0x00, 0x00, 0x00);
160 dcs_write_cmd_at(ctx
, MCS_GOACLKA3
, 0x18, 0x02, 0x03, 0x3B, 0x00, 0x00,
161 0x00, 0x18, 0x01, 0x03, 0x3C, 0x00, 0x00, 0x00);
162 dcs_write_cmd_at(ctx
, MCS_GOAECLK
, 0x01, 0x01, 0x20, 0x20, 0x00, 0x00,
163 0x01, 0x02, 0x00, 0x00);
165 dcs_write_cmd_at(ctx
, MCS_NO_DOC2
, 0x00);
167 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET1
, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
168 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET2
, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
170 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET3
, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
172 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET4
, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
173 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET5
, 0, 4, 4, 4, 4, 4, 0, 0, 0, 0,
175 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET6
, 0, 0, 0, 0, 0, 0, 4, 4, 4, 4,
177 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET7
, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);
178 dcs_write_cmd_at(ctx
, MCS_PANCTRLSET8
, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
179 0xFF, 0xFF, 0xFF, 0xFF, 0xFF);
181 dcs_write_cmd_at(ctx
, MCS_PANU2D1
, 0x00, 0x26, 0x09, 0x0B, 0x01, 0x25,
182 0x00, 0x00, 0x00, 0x00);
183 dcs_write_cmd_at(ctx
, MCS_PANU2D2
, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
184 0x00, 0x00, 0x00, 0x00, 0x00, 0x26, 0x0A, 0x0C, 0x02);
185 dcs_write_cmd_at(ctx
, MCS_PANU2D3
, 0x25, 0x00, 0x00, 0x00, 0x00, 0x00,
186 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00);
187 dcs_write_cmd_at(ctx
, MCS_PAND2U1
, 0x00, 0x25, 0x0C, 0x0A, 0x02, 0x26,
188 0x00, 0x00, 0x00, 0x00);
189 dcs_write_cmd_at(ctx
, MCS_PAND2U2
, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
190 0x00, 0x00, 0x00, 0x00, 0x00, 0x25, 0x0B, 0x09, 0x01);
191 dcs_write_cmd_at(ctx
, MCS_PAND2U3
, 0x26, 0x00, 0x00, 0x00, 0x00, 0x00,
192 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00);
194 dcs_write_cmd_at(ctx
, MCS_PWR_CTRL1
+ 1, 0x66);
196 dcs_write_cmd_at(ctx
, MCS_NO_DOC3
, 0x06);
198 dcs_write_cmd_at(ctx
, MCS_GMCT2_2P
, 0x00, 0x09, 0x0F, 0x0E, 0x07, 0x10,
199 0x0B, 0x0A, 0x04, 0x07, 0x0B, 0x08, 0x0F, 0x10, 0x0A,
201 dcs_write_cmd_at(ctx
, MCS_GMCT2_2N
, 0x00, 0x09, 0x0F, 0x0E, 0x07, 0x10,
202 0x0B, 0x0A, 0x04, 0x07, 0x0B, 0x08, 0x0F, 0x10, 0x0A,
206 dcs_write_cmd_at(ctx
, MCS_CMD2_ENA1
, 0xFF, 0xFF, 0xFF);
208 ret
= mipi_dsi_dcs_nop(dsi
);
212 ret
= mipi_dsi_dcs_exit_sleep_mode(dsi
);
216 /* Wait for sleep out exit */
219 /* Default portrait 480x800 rgb24 */
220 dcs_write_seq(ctx
, MIPI_DCS_SET_ADDRESS_MODE
, 0x00);
222 ret
= mipi_dsi_dcs_set_column_address(dsi
, 0,
223 default_mode
.hdisplay
- 1);
227 ret
= mipi_dsi_dcs_set_page_address(dsi
, 0, default_mode
.vdisplay
- 1);
231 /* See otm8009a driver documentation for pixel format descriptions */
232 ret
= mipi_dsi_dcs_set_pixel_format(dsi
, MIPI_DCS_PIXEL_FMT_24BIT
|
233 MIPI_DCS_PIXEL_FMT_24BIT
<< 4);
237 /* Disable CABC feature */
238 dcs_write_seq(ctx
, MIPI_DCS_WRITE_POWER_SAVE
, 0x00);
240 ret
= mipi_dsi_dcs_set_display_on(dsi
);
244 ret
= mipi_dsi_dcs_nop(dsi
);
248 /* Send Command GRAM memory write (no parameters) */
249 dcs_write_seq(ctx
, MIPI_DCS_WRITE_MEMORY_START
);
254 static int otm8009a_disable(struct drm_panel
*panel
)
256 struct otm8009a
*ctx
= panel_to_otm8009a(panel
);
257 struct mipi_dsi_device
*dsi
= to_mipi_dsi_device(ctx
->dev
);
261 return 0; /* This is not an issue so we return 0 here */
263 backlight_disable(ctx
->bl_dev
);
265 ret
= mipi_dsi_dcs_set_display_off(dsi
);
269 ret
= mipi_dsi_dcs_enter_sleep_mode(dsi
);
275 ctx
->enabled
= false;
280 static int otm8009a_unprepare(struct drm_panel
*panel
)
282 struct otm8009a
*ctx
= panel_to_otm8009a(panel
);
287 if (ctx
->reset_gpio
) {
288 gpiod_set_value_cansleep(ctx
->reset_gpio
, 1);
292 regulator_disable(ctx
->supply
);
294 ctx
->prepared
= false;
299 static int otm8009a_prepare(struct drm_panel
*panel
)
301 struct otm8009a
*ctx
= panel_to_otm8009a(panel
);
307 ret
= regulator_enable(ctx
->supply
);
309 DRM_ERROR("failed to enable supply: %d\n", ret
);
313 if (ctx
->reset_gpio
) {
314 gpiod_set_value_cansleep(ctx
->reset_gpio
, 0);
315 gpiod_set_value_cansleep(ctx
->reset_gpio
, 1);
317 gpiod_set_value_cansleep(ctx
->reset_gpio
, 0);
321 ret
= otm8009a_init_sequence(ctx
);
325 ctx
->prepared
= true;
330 static int otm8009a_enable(struct drm_panel
*panel
)
332 struct otm8009a
*ctx
= panel_to_otm8009a(panel
);
337 backlight_enable(ctx
->bl_dev
);
344 static int otm8009a_get_modes(struct drm_panel
*panel
)
346 struct drm_display_mode
*mode
;
348 mode
= drm_mode_duplicate(panel
->drm
, &default_mode
);
350 DRM_ERROR("failed to add mode %ux%ux@%u\n",
351 default_mode
.hdisplay
, default_mode
.vdisplay
,
352 default_mode
.vrefresh
);
356 drm_mode_set_name(mode
);
358 mode
->type
= DRM_MODE_TYPE_DRIVER
| DRM_MODE_TYPE_PREFERRED
;
359 drm_mode_probed_add(panel
->connector
, mode
);
361 panel
->connector
->display_info
.width_mm
= mode
->width_mm
;
362 panel
->connector
->display_info
.height_mm
= mode
->height_mm
;
367 static const struct drm_panel_funcs otm8009a_drm_funcs
= {
368 .disable
= otm8009a_disable
,
369 .unprepare
= otm8009a_unprepare
,
370 .prepare
= otm8009a_prepare
,
371 .enable
= otm8009a_enable
,
372 .get_modes
= otm8009a_get_modes
,
376 * DSI-BASED BACKLIGHT
379 static int otm8009a_backlight_update_status(struct backlight_device
*bd
)
381 struct otm8009a
*ctx
= bl_get_data(bd
);
384 if (!ctx
->prepared
) {
385 DRM_DEBUG("lcd not ready yet for setting its backlight!\n");
389 if (bd
->props
.power
<= FB_BLANK_NORMAL
) {
390 /* Power on the backlight with the requested brightness
391 * Note We can not use mipi_dsi_dcs_set_display_brightness()
392 * as otm8009a driver support only 8-bit brightness (1 param).
394 data
[0] = MIPI_DCS_SET_DISPLAY_BRIGHTNESS
;
395 data
[1] = bd
->props
.brightness
;
396 otm8009a_dcs_write_buf_hs(ctx
, data
, ARRAY_SIZE(data
));
398 /* set Brightness Control & Backlight on */
402 /* Power off the backlight: set Brightness Control & Bl off */
406 /* Update Brightness Control & Backlight */
407 data
[0] = MIPI_DCS_WRITE_CONTROL_DISPLAY
;
408 otm8009a_dcs_write_buf_hs(ctx
, data
, ARRAY_SIZE(data
));
413 static const struct backlight_ops otm8009a_backlight_ops
= {
414 .update_status
= otm8009a_backlight_update_status
,
417 static int otm8009a_probe(struct mipi_dsi_device
*dsi
)
419 struct device
*dev
= &dsi
->dev
;
420 struct otm8009a
*ctx
;
423 ctx
= devm_kzalloc(dev
, sizeof(*ctx
), GFP_KERNEL
);
427 ctx
->reset_gpio
= devm_gpiod_get_optional(dev
, "reset", GPIOD_OUT_LOW
);
428 if (IS_ERR(ctx
->reset_gpio
)) {
429 dev_err(dev
, "cannot get reset-gpio\n");
430 return PTR_ERR(ctx
->reset_gpio
);
433 ctx
->supply
= devm_regulator_get(dev
, "power");
434 if (IS_ERR(ctx
->supply
)) {
435 ret
= PTR_ERR(ctx
->supply
);
436 dev_err(dev
, "failed to request regulator: %d\n", ret
);
440 mipi_dsi_set_drvdata(dsi
, ctx
);
445 dsi
->format
= MIPI_DSI_FMT_RGB888
;
446 dsi
->mode_flags
= MIPI_DSI_MODE_VIDEO
| MIPI_DSI_MODE_VIDEO_BURST
|
449 drm_panel_init(&ctx
->panel
);
450 ctx
->panel
.dev
= dev
;
451 ctx
->panel
.funcs
= &otm8009a_drm_funcs
;
453 ctx
->bl_dev
= devm_backlight_device_register(dev
, dev_name(dev
),
455 &otm8009a_backlight_ops
,
457 if (IS_ERR(ctx
->bl_dev
)) {
458 ret
= PTR_ERR(ctx
->bl_dev
);
459 dev_err(dev
, "failed to register backlight: %d\n", ret
);
463 ctx
->bl_dev
->props
.max_brightness
= OTM8009A_BACKLIGHT_MAX
;
464 ctx
->bl_dev
->props
.brightness
= OTM8009A_BACKLIGHT_DEFAULT
;
465 ctx
->bl_dev
->props
.power
= FB_BLANK_POWERDOWN
;
466 ctx
->bl_dev
->props
.type
= BACKLIGHT_RAW
;
468 drm_panel_add(&ctx
->panel
);
470 ret
= mipi_dsi_attach(dsi
);
472 dev_err(dev
, "mipi_dsi_attach failed. Is host ready?\n");
473 drm_panel_remove(&ctx
->panel
);
474 backlight_device_unregister(ctx
->bl_dev
);
481 static int otm8009a_remove(struct mipi_dsi_device
*dsi
)
483 struct otm8009a
*ctx
= mipi_dsi_get_drvdata(dsi
);
485 mipi_dsi_detach(dsi
);
486 drm_panel_remove(&ctx
->panel
);
491 static const struct of_device_id orisetech_otm8009a_of_match
[] = {
492 { .compatible
= "orisetech,otm8009a" },
495 MODULE_DEVICE_TABLE(of
, orisetech_otm8009a_of_match
);
497 static struct mipi_dsi_driver orisetech_otm8009a_driver
= {
498 .probe
= otm8009a_probe
,
499 .remove
= otm8009a_remove
,
501 .name
= "panel-orisetech-otm8009a",
502 .of_match_table
= orisetech_otm8009a_of_match
,
505 module_mipi_dsi_driver(orisetech_otm8009a_driver
);
507 MODULE_AUTHOR("Philippe Cornu <philippe.cornu@st.com>");
508 MODULE_AUTHOR("Yannick Fertre <yannick.fertre@st.com>");
509 MODULE_DESCRIPTION("DRM driver for Orise Tech OTM8009A MIPI DSI panel");
510 MODULE_LICENSE("GPL v2");