2 * MIPI Display Bus Interface (DBI) LCD controller support
4 * Copyright 2016 Noralf Trønnes
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #ifndef __LINUX_MIPI_DBI_H
13 #define __LINUX_MIPI_DBI_H
15 #include <linux/mutex.h>
16 #include <drm/drm_device.h>
17 #include <drm/drm_simple_kms_helper.h>
25 * struct mipi_dbi - MIPI DBI controller
27 * @enabled: Pipeline is enabled
28 * @cmdlock: Command lock
29 * @command: Bus specific callback executing commands.
30 * @read_commands: Array of read commands terminated by a zero entry.
31 * Reading is disabled if this is NULL.
32 * @dc: Optional D/C gpio.
33 * @tx_buf: Buffer used for transfer (copy clip rect area)
34 * @tx_buf9: Buffer used for Option 1 9-bit conversion
35 * @tx_buf9_len: Size of tx_buf9.
36 * @swap_bytes: Swap bytes in buffer before transfer
37 * @reset: Optional reset gpio
38 * @rotation: initial rotation in degrees Counter Clock Wise
39 * @backlight: backlight device (optional)
40 * @regulator: power regulator (optional)
46 struct drm_device drm;
49 * @pipe: Display pipe structure
51 struct drm_simple_display_pipe pipe;
53 struct spi_device *spi;
56 int (*command)(struct mipi_dbi *mipi, u8 *cmd, u8 *param, size_t num);
57 const u8 *read_commands;
63 struct gpio_desc *reset;
64 unsigned int rotation;
65 struct backlight_device *backlight;
66 struct regulator *regulator;
69 static inline struct mipi_dbi *drm_to_mipi_dbi(struct drm_device *drm)
71 return container_of(drm, struct mipi_dbi, drm);
74 int mipi_dbi_spi_init(struct spi_device *spi, struct mipi_dbi *mipi,
75 struct gpio_desc *dc);
76 int mipi_dbi_init(struct mipi_dbi *mipi,
77 const struct drm_simple_display_pipe_funcs *funcs,
78 const struct drm_display_mode *mode, unsigned int rotation);
79 void mipi_dbi_release(struct drm_device *drm);
80 void mipi_dbi_pipe_update(struct drm_simple_display_pipe *pipe,
81 struct drm_plane_state *old_state);
82 void mipi_dbi_enable_flush(struct mipi_dbi *mipi,
83 struct drm_crtc_state *crtc_state,
84 struct drm_plane_state *plan_state);
85 void mipi_dbi_pipe_disable(struct drm_simple_display_pipe *pipe);
86 void mipi_dbi_hw_reset(struct mipi_dbi *mipi);
87 bool mipi_dbi_display_is_on(struct mipi_dbi *mipi);
88 int mipi_dbi_poweron_reset(struct mipi_dbi *mipi);
89 int mipi_dbi_poweron_conditional_reset(struct mipi_dbi *mipi);
90 u32 mipi_dbi_spi_cmd_max_speed(struct spi_device *spi, size_t len);
92 int mipi_dbi_command_read(struct mipi_dbi *mipi, u8 cmd, u8 *val);
93 int mipi_dbi_command_buf(struct mipi_dbi *mipi, u8 cmd, u8 *data, size_t len);
94 int mipi_dbi_command_stackbuf(struct mipi_dbi *mipi, u8 cmd, u8 *data, size_t len);
95 int mipi_dbi_buf_copy(void *dst, struct drm_framebuffer *fb,
96 struct drm_rect *clip, bool swap);
98 * mipi_dbi_command - MIPI DCS command with optional parameter(s)
99 * @mipi: MIPI structure
101 * @seq...: Optional parameter(s)
103 * Send MIPI DCS command to the controller. Use mipi_dbi_command_read() for
107 * Zero on success, negative error code on failure.
109 #define mipi_dbi_command(mipi, cmd, seq...) \
112 mipi_dbi_command_stackbuf(mipi, cmd, d, ARRAY_SIZE(d)); \
115 #ifdef CONFIG_DEBUG_FS
116 int mipi_dbi_debugfs_init(struct drm_minor *minor);
118 #define mipi_dbi_debugfs_init NULL
121 #endif /* __LINUX_MIPI_DBI_H */