4  * SPDX-License-Identifier: Apache-2.0
9  * @brief Public APIs for MIPI-DBI drivers
11  * MIPI-DBI defines the following 3 interfaces:
25  * @brief MIPI-DBI driver APIs
26  * @defgroup mipi_dbi_interface MIPI-DBI driver APIs
37 #include <zephyr/dt-bindings/mipi_dbi/mipi_dbi.h>
51  * @param delay_ the desired delay field in the struct spi_config's
68 			.delay = (delay_),				\
79  * @param delay_ the desired delay field in the struct spi_config's
94  * @param delay_ the desired delay field in the struct spi_config's
109  * @param delay_ the desired delay field in the struct spi_config's
152 /** MIPI-DBI host driver API */
165 	int (*reset)(const struct device *dev, k_timeout_t delay);
170 			    k_timeout_t delay);
188  * @retval -EIO I/O error
189  * @retval -ETIMEDOUT transfer timed out
190  * @retval -EBUSY controller is busy
191  * @retval -ENOSYS not implemented
199 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_command_write()
201 	if (api->command_write == NULL) {  in mipi_dbi_command_write()
202 		return -ENOSYS;  in mipi_dbi_command_write()
204 	return api->command_write(dev, config, cmd, data, len);  in mipi_dbi_command_write()
219  * @retval -EIO I/O error
220  * @retval -ETIMEDOUT transfer timed out
221  * @retval -EBUSY controller is busy
222  * @retval -ENOSYS not implemented
230 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_command_read()
232 	if (api->command_read == NULL) {  in mipi_dbi_command_read()
233 		return -ENOSYS;  in mipi_dbi_command_read()
235 	return api->command_read(dev, config, cmds, num_cmd, response, len);  in mipi_dbi_command_read()
252  * @retval -EIO I/O error
253  * @retval -ETIMEDOUT transfer timed out
254  * @retval -EBUSY controller is busy
255  * @retval -ENOSYS not implemented
264 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_write_display()
266 	if (api->write_display == NULL) {  in mipi_dbi_write_display()
267 		return -ENOSYS;  in mipi_dbi_write_display()
269 	return api->write_display(dev, config, framebuf, desc, pixfmt);  in mipi_dbi_write_display()
279  * @retval -EIO I/O error
280  * @retval -ENOSYS not implemented
281  * @retval -ENOTSUP not supported
286 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_reset()
288 	if (api->reset == NULL) {  in mipi_dbi_reset()
289 		return -ENOSYS;  in mipi_dbi_reset()
291 	return api->reset(dev, K_MSEC(delay_ms));  in mipi_dbi_reset()
307  * @retval -EIO I/O error
308  * @retval -ENOSYS not implemented
309  * @retval -ENOTSUP not supported
315 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_release()
317 	if (api->release == NULL) {  in mipi_dbi_release()
318 		return -ENOSYS;  in mipi_dbi_release()
320 	return api->release(dev, config);  in mipi_dbi_release()
328  * used by the MCU to determine when to transmit a new frame so that the
330  * MCU. This function configures the MIPI DBI controller to delay transmitting
333  * The delay will occur on the on each call to @ref mipi_dbi_write_display
336  * in this call is the first buffer of a new frame.
345  * @retval -EIO I/O error
346  * @retval -ENOSYS not implemented
347  * @retval -ENOTSUP not supported
354 		(const struct mipi_dbi_driver_api *)dev->api;  in mipi_dbi_configure_te()
356 	if (api->configure_te == NULL) {  in mipi_dbi_configure_te()
357 		return -ENOSYS;  in mipi_dbi_configure_te()
359 	return api->configure_te(dev, edge, K_USEC(delay_us));  in mipi_dbi_configure_te()