lms501kf03.c 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * lms501kf03 TFT LCD panel driver.
  4. *
  5. * Copyright (c) 2012 Samsung Electronics Co., Ltd.
  6. * Author: Jingoo Han <jg1.han@samsung.com>
  7. */
  8. #include <linux/backlight.h>
  9. #include <linux/delay.h>
  10. #include <linux/fb.h>
  11. #include <linux/lcd.h>
  12. #include <linux/module.h>
  13. #include <linux/spi/spi.h>
  14. #include <linux/wait.h>
  15. #define COMMAND_ONLY 0x00
  16. #define DATA_ONLY 0x01
  17. struct lms501kf03 {
  18. struct device *dev;
  19. struct spi_device *spi;
  20. unsigned int power;
  21. struct lcd_device *ld;
  22. struct lcd_platform_data *lcd_pd;
  23. };
  24. static const unsigned char seq_password[] = {
  25. 0xb9, 0xff, 0x83, 0x69,
  26. };
  27. static const unsigned char seq_power[] = {
  28. 0xb1, 0x01, 0x00, 0x34, 0x06, 0x00, 0x14, 0x14, 0x20, 0x28,
  29. 0x12, 0x12, 0x17, 0x0a, 0x01, 0xe6, 0xe6, 0xe6, 0xe6, 0xe6,
  30. };
  31. static const unsigned char seq_display[] = {
  32. 0xb2, 0x00, 0x2b, 0x03, 0x03, 0x70, 0x00, 0xff, 0x00, 0x00,
  33. 0x00, 0x00, 0x03, 0x03, 0x00, 0x01,
  34. };
  35. static const unsigned char seq_rgb_if[] = {
  36. 0xb3, 0x09,
  37. };
  38. static const unsigned char seq_display_inv[] = {
  39. 0xb4, 0x01, 0x08, 0x77, 0x0e, 0x06,
  40. };
  41. static const unsigned char seq_vcom[] = {
  42. 0xb6, 0x4c, 0x2e,
  43. };
  44. static const unsigned char seq_gate[] = {
  45. 0xd5, 0x00, 0x05, 0x03, 0x29, 0x01, 0x07, 0x17, 0x68, 0x13,
  46. 0x37, 0x20, 0x31, 0x8a, 0x46, 0x9b, 0x57, 0x13, 0x02, 0x75,
  47. 0xb9, 0x64, 0xa8, 0x07, 0x0f, 0x04, 0x07,
  48. };
  49. static const unsigned char seq_panel[] = {
  50. 0xcc, 0x02,
  51. };
  52. static const unsigned char seq_col_mod[] = {
  53. 0x3a, 0x77,
  54. };
  55. static const unsigned char seq_w_gamma[] = {
  56. 0xe0, 0x00, 0x04, 0x09, 0x0f, 0x1f, 0x3f, 0x1f, 0x2f, 0x0a,
  57. 0x0f, 0x10, 0x16, 0x18, 0x16, 0x17, 0x0d, 0x15, 0x00, 0x04,
  58. 0x09, 0x0f, 0x38, 0x3f, 0x20, 0x39, 0x0a, 0x0f, 0x10, 0x16,
  59. 0x18, 0x16, 0x17, 0x0d, 0x15,
  60. };
  61. static const unsigned char seq_rgb_gamma[] = {
  62. 0xc1, 0x01, 0x03, 0x07, 0x0f, 0x1a, 0x22, 0x2c, 0x33, 0x3c,
  63. 0x46, 0x4f, 0x58, 0x60, 0x69, 0x71, 0x79, 0x82, 0x89, 0x92,
  64. 0x9a, 0xa1, 0xa9, 0xb1, 0xb9, 0xc1, 0xc9, 0xcf, 0xd6, 0xde,
  65. 0xe5, 0xec, 0xf3, 0xf9, 0xff, 0xdd, 0x39, 0x07, 0x1c, 0xcb,
  66. 0xab, 0x5f, 0x49, 0x80, 0x03, 0x07, 0x0f, 0x19, 0x20, 0x2a,
  67. 0x31, 0x39, 0x42, 0x4b, 0x53, 0x5b, 0x63, 0x6b, 0x73, 0x7b,
  68. 0x83, 0x8a, 0x92, 0x9b, 0xa2, 0xaa, 0xb2, 0xba, 0xc2, 0xca,
  69. 0xd0, 0xd8, 0xe1, 0xe8, 0xf0, 0xf8, 0xff, 0xf7, 0xd8, 0xbe,
  70. 0xa7, 0x39, 0x40, 0x85, 0x8c, 0xc0, 0x04, 0x07, 0x0c, 0x17,
  71. 0x1c, 0x23, 0x2b, 0x34, 0x3b, 0x43, 0x4c, 0x54, 0x5b, 0x63,
  72. 0x6a, 0x73, 0x7a, 0x82, 0x8a, 0x91, 0x98, 0xa1, 0xa8, 0xb0,
  73. 0xb7, 0xc1, 0xc9, 0xcf, 0xd9, 0xe3, 0xea, 0xf4, 0xff, 0x00,
  74. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  75. };
  76. static const unsigned char seq_sleep_out[] = {
  77. 0x11,
  78. };
  79. static const unsigned char seq_display_on[] = {
  80. 0x29,
  81. };
  82. static const unsigned char seq_display_off[] = {
  83. 0x10,
  84. };
  85. static int lms501kf03_spi_write_byte(struct lms501kf03 *lcd, int addr, int data)
  86. {
  87. u16 buf[1];
  88. struct spi_message msg;
  89. struct spi_transfer xfer = {
  90. .len = 2,
  91. .tx_buf = buf,
  92. };
  93. buf[0] = (addr << 8) | data;
  94. spi_message_init(&msg);
  95. spi_message_add_tail(&xfer, &msg);
  96. return spi_sync(lcd->spi, &msg);
  97. }
  98. static int lms501kf03_spi_write(struct lms501kf03 *lcd, unsigned char address,
  99. unsigned char command)
  100. {
  101. return lms501kf03_spi_write_byte(lcd, address, command);
  102. }
  103. static int lms501kf03_panel_send_sequence(struct lms501kf03 *lcd,
  104. const unsigned char *wbuf,
  105. unsigned int len)
  106. {
  107. int ret = 0, i = 0;
  108. while (i < len) {
  109. if (i == 0)
  110. ret = lms501kf03_spi_write(lcd, COMMAND_ONLY, wbuf[i]);
  111. else
  112. ret = lms501kf03_spi_write(lcd, DATA_ONLY, wbuf[i]);
  113. if (ret)
  114. break;
  115. i += 1;
  116. }
  117. return ret;
  118. }
  119. static int lms501kf03_ldi_init(struct lms501kf03 *lcd)
  120. {
  121. int ret, i;
  122. static const unsigned char *init_seq[] = {
  123. seq_password,
  124. seq_power,
  125. seq_display,
  126. seq_rgb_if,
  127. seq_display_inv,
  128. seq_vcom,
  129. seq_gate,
  130. seq_panel,
  131. seq_col_mod,
  132. seq_w_gamma,
  133. seq_rgb_gamma,
  134. seq_sleep_out,
  135. };
  136. static const unsigned int size_seq[] = {
  137. ARRAY_SIZE(seq_password),
  138. ARRAY_SIZE(seq_power),
  139. ARRAY_SIZE(seq_display),
  140. ARRAY_SIZE(seq_rgb_if),
  141. ARRAY_SIZE(seq_display_inv),
  142. ARRAY_SIZE(seq_vcom),
  143. ARRAY_SIZE(seq_gate),
  144. ARRAY_SIZE(seq_panel),
  145. ARRAY_SIZE(seq_col_mod),
  146. ARRAY_SIZE(seq_w_gamma),
  147. ARRAY_SIZE(seq_rgb_gamma),
  148. ARRAY_SIZE(seq_sleep_out),
  149. };
  150. for (i = 0; i < ARRAY_SIZE(init_seq); i++) {
  151. ret = lms501kf03_panel_send_sequence(lcd, init_seq[i],
  152. size_seq[i]);
  153. if (ret)
  154. break;
  155. }
  156. /*
  157. * According to the datasheet, 120ms delay time is required.
  158. * After sleep out sequence, command is blocked for 120ms.
  159. * Thus, LDI should wait for 120ms.
  160. */
  161. msleep(120);
  162. return ret;
  163. }
  164. static int lms501kf03_ldi_enable(struct lms501kf03 *lcd)
  165. {
  166. return lms501kf03_panel_send_sequence(lcd, seq_display_on,
  167. ARRAY_SIZE(seq_display_on));
  168. }
  169. static int lms501kf03_ldi_disable(struct lms501kf03 *lcd)
  170. {
  171. return lms501kf03_panel_send_sequence(lcd, seq_display_off,
  172. ARRAY_SIZE(seq_display_off));
  173. }
  174. static int lms501kf03_power_is_on(int power)
  175. {
  176. return (power) <= FB_BLANK_NORMAL;
  177. }
  178. static int lms501kf03_power_on(struct lms501kf03 *lcd)
  179. {
  180. int ret = 0;
  181. struct lcd_platform_data *pd;
  182. pd = lcd->lcd_pd;
  183. if (!pd->power_on) {
  184. dev_err(lcd->dev, "power_on is NULL.\n");
  185. return -EINVAL;
  186. }
  187. pd->power_on(lcd->ld, 1);
  188. msleep(pd->power_on_delay);
  189. if (!pd->reset) {
  190. dev_err(lcd->dev, "reset is NULL.\n");
  191. return -EINVAL;
  192. }
  193. pd->reset(lcd->ld);
  194. msleep(pd->reset_delay);
  195. ret = lms501kf03_ldi_init(lcd);
  196. if (ret) {
  197. dev_err(lcd->dev, "failed to initialize ldi.\n");
  198. return ret;
  199. }
  200. ret = lms501kf03_ldi_enable(lcd);
  201. if (ret) {
  202. dev_err(lcd->dev, "failed to enable ldi.\n");
  203. return ret;
  204. }
  205. return 0;
  206. }
  207. static int lms501kf03_power_off(struct lms501kf03 *lcd)
  208. {
  209. int ret = 0;
  210. struct lcd_platform_data *pd;
  211. pd = lcd->lcd_pd;
  212. ret = lms501kf03_ldi_disable(lcd);
  213. if (ret) {
  214. dev_err(lcd->dev, "lcd setting failed.\n");
  215. return -EIO;
  216. }
  217. msleep(pd->power_off_delay);
  218. pd->power_on(lcd->ld, 0);
  219. return 0;
  220. }
  221. static int lms501kf03_power(struct lms501kf03 *lcd, int power)
  222. {
  223. int ret = 0;
  224. if (lms501kf03_power_is_on(power) &&
  225. !lms501kf03_power_is_on(lcd->power))
  226. ret = lms501kf03_power_on(lcd);
  227. else if (!lms501kf03_power_is_on(power) &&
  228. lms501kf03_power_is_on(lcd->power))
  229. ret = lms501kf03_power_off(lcd);
  230. if (!ret)
  231. lcd->power = power;
  232. return ret;
  233. }
  234. static int lms501kf03_get_power(struct lcd_device *ld)
  235. {
  236. struct lms501kf03 *lcd = lcd_get_data(ld);
  237. return lcd->power;
  238. }
  239. static int lms501kf03_set_power(struct lcd_device *ld, int power)
  240. {
  241. struct lms501kf03 *lcd = lcd_get_data(ld);
  242. if (power != FB_BLANK_UNBLANK && power != FB_BLANK_POWERDOWN &&
  243. power != FB_BLANK_NORMAL) {
  244. dev_err(lcd->dev, "power value should be 0, 1 or 4.\n");
  245. return -EINVAL;
  246. }
  247. return lms501kf03_power(lcd, power);
  248. }
  249. static struct lcd_ops lms501kf03_lcd_ops = {
  250. .get_power = lms501kf03_get_power,
  251. .set_power = lms501kf03_set_power,
  252. };
  253. static int lms501kf03_probe(struct spi_device *spi)
  254. {
  255. struct lms501kf03 *lcd = NULL;
  256. struct lcd_device *ld = NULL;
  257. int ret = 0;
  258. lcd = devm_kzalloc(&spi->dev, sizeof(struct lms501kf03), GFP_KERNEL);
  259. if (!lcd)
  260. return -ENOMEM;
  261. /* lms501kf03 lcd panel uses 3-wire 9-bit SPI Mode. */
  262. spi->bits_per_word = 9;
  263. ret = spi_setup(spi);
  264. if (ret < 0) {
  265. dev_err(&spi->dev, "spi setup failed.\n");
  266. return ret;
  267. }
  268. lcd->spi = spi;
  269. lcd->dev = &spi->dev;
  270. lcd->lcd_pd = dev_get_platdata(&spi->dev);
  271. if (!lcd->lcd_pd) {
  272. dev_err(&spi->dev, "platform data is NULL\n");
  273. return -EINVAL;
  274. }
  275. ld = devm_lcd_device_register(&spi->dev, "lms501kf03", &spi->dev, lcd,
  276. &lms501kf03_lcd_ops);
  277. if (IS_ERR(ld))
  278. return PTR_ERR(ld);
  279. lcd->ld = ld;
  280. if (!lcd->lcd_pd->lcd_enabled) {
  281. /*
  282. * if lcd panel was off from bootloader then
  283. * current lcd status is powerdown and then
  284. * it enables lcd panel.
  285. */
  286. lcd->power = FB_BLANK_POWERDOWN;
  287. lms501kf03_power(lcd, FB_BLANK_UNBLANK);
  288. } else {
  289. lcd->power = FB_BLANK_UNBLANK;
  290. }
  291. spi_set_drvdata(spi, lcd);
  292. dev_info(&spi->dev, "lms501kf03 panel driver has been probed.\n");
  293. return 0;
  294. }
  295. static int lms501kf03_remove(struct spi_device *spi)
  296. {
  297. struct lms501kf03 *lcd = spi_get_drvdata(spi);
  298. lms501kf03_power(lcd, FB_BLANK_POWERDOWN);
  299. return 0;
  300. }
  301. #ifdef CONFIG_PM_SLEEP
  302. static int lms501kf03_suspend(struct device *dev)
  303. {
  304. struct lms501kf03 *lcd = dev_get_drvdata(dev);
  305. dev_dbg(dev, "lcd->power = %d\n", lcd->power);
  306. /*
  307. * when lcd panel is suspend, lcd panel becomes off
  308. * regardless of status.
  309. */
  310. return lms501kf03_power(lcd, FB_BLANK_POWERDOWN);
  311. }
  312. static int lms501kf03_resume(struct device *dev)
  313. {
  314. struct lms501kf03 *lcd = dev_get_drvdata(dev);
  315. lcd->power = FB_BLANK_POWERDOWN;
  316. return lms501kf03_power(lcd, FB_BLANK_UNBLANK);
  317. }
  318. #endif
  319. static SIMPLE_DEV_PM_OPS(lms501kf03_pm_ops, lms501kf03_suspend,
  320. lms501kf03_resume);
  321. static void lms501kf03_shutdown(struct spi_device *spi)
  322. {
  323. struct lms501kf03 *lcd = spi_get_drvdata(spi);
  324. lms501kf03_power(lcd, FB_BLANK_POWERDOWN);
  325. }
  326. static struct spi_driver lms501kf03_driver = {
  327. .driver = {
  328. .name = "lms501kf03",
  329. .pm = &lms501kf03_pm_ops,
  330. },
  331. .probe = lms501kf03_probe,
  332. .remove = lms501kf03_remove,
  333. .shutdown = lms501kf03_shutdown,
  334. };
  335. module_spi_driver(lms501kf03_driver);
  336. MODULE_AUTHOR("Jingoo Han <jg1.han@samsung.com>");
  337. MODULE_DESCRIPTION("lms501kf03 LCD Driver");
  338. MODULE_LICENSE("GPL");