Zephyr API Documentation 4.3.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
mipi_dbi.h
Go to the documentation of this file.
1/*
2 * Copyright 2023 NXP
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
21
22#ifndef ZEPHYR_INCLUDE_DRIVERS_MIPI_DBI_H_
23#define ZEPHYR_INCLUDE_DRIVERS_MIPI_DBI_H_
24
33
34#include <zephyr/device.h>
37#include <zephyr/drivers/spi.h>
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
45#define MIPI_DBI_DT_SPI_DEV(node_id) \
46 DT_PHANDLE(DT_PARENT(node_id), spi_dev)
47
48#define MIPI_DBI_SPI_CS_GPIOS_DT_SPEC_GET(node_id) \
49 GPIO_DT_SPEC_GET_BY_IDX_OR(MIPI_DBI_DT_SPI_DEV(node_id), \
50 cs_gpios, DT_REG_ADDR_RAW(node_id), {})
51
52#define MIPI_DBI_SPI_CS_CONTROL_INIT_GPIO(node_id, delay_) \
53 .gpio = MIPI_DBI_SPI_CS_GPIOS_DT_SPEC_GET(node_id), \
54 .delay = delay_,
56
68#define MIPI_DBI_SPI_CONFIG_DT(node_id, operation_, delay_) \
69 { \
70 .frequency = DT_PROP(node_id, mipi_max_frequency), \
71 .operation = (operation_) | \
72 DT_PROP_OR(node_id, duplex, 0) | \
73 COND_CODE_1(DT_PROP(node_id, mipi_cpol), SPI_MODE_CPOL, (0)) | \
74 COND_CODE_1(DT_PROP(node_id, mipi_cpha), SPI_MODE_CPHA, (0)) | \
75 COND_CODE_1(DT_PROP(node_id, mipi_hold_cs), SPI_HOLD_ON_CS, (0)), \
76 .slave = DT_REG_ADDR(node_id), \
77 .cs = { \
78 COND_CODE_1(DT_SPI_HAS_CS_GPIOS(MIPI_DBI_DT_SPI_DEV(node_id)), \
79 (MIPI_DBI_SPI_CS_CONTROL_INIT_GPIO(node_id, delay_)), \
80 (SPI_CS_CONTROL_INIT_NATIVE(node_id))) \
81 .cs_is_gpio = DT_SPI_HAS_CS_GPIOS(MIPI_DBI_DT_SPI_DEV(node_id)),\
82 }, \
83 }
84
95#define MIPI_DBI_SPI_CONFIG_DT_INST(inst, operation_, delay_) \
96 MIPI_DBI_SPI_CONFIG_DT(DT_DRV_INST(inst), operation_, delay_)
97
110#define MIPI_DBI_CONFIG_DT(node_id, operation_, delay_) \
111 { \
112 .mode = DT_STRING_UPPER_TOKEN(node_id, mipi_mode), \
113 .config = MIPI_DBI_SPI_CONFIG_DT(node_id, operation_, delay_), \
114 }
115
125#define MIPI_DBI_CONFIG_DT_INST(inst, operation_, delay_) \
126 MIPI_DBI_CONFIG_DT(DT_DRV_INST(inst), operation_, delay_)
127
137#define MIPI_DBI_TE_MODE_DT(node_id, edge_prop) \
138 DT_STRING_UPPER_TOKEN(node_id, edge_prop)
139
149#define MIPI_DBI_TE_MODE_DT_INST(inst, edge_prop) \
150 DT_STRING_UPPER_TOKEN(DT_DRV_INST(inst), edge_prop)
151
163
164
166__subsystem struct mipi_dbi_driver_api {
167 int (*command_write)(const struct device *dev,
168 const struct mipi_dbi_config *config, uint8_t cmd,
169 const uint8_t *data, size_t len);
170 int (*command_read)(const struct device *dev,
171 const struct mipi_dbi_config *config, uint8_t *cmds,
172 size_t num_cmds, uint8_t *response, size_t len);
173 int (*write_display)(const struct device *dev,
174 const struct mipi_dbi_config *config,
175 const uint8_t *framebuf,
176 struct display_buffer_descriptor *desc,
177 enum display_pixel_format pixfmt);
178 int (*reset)(const struct device *dev, k_timeout_t delay);
179 int (*release)(const struct device *dev,
180 const struct mipi_dbi_config *config);
181 int (*configure_te)(const struct device *dev,
182 uint8_t edge,
183 k_timeout_t delay);
184};
185
206static inline int mipi_dbi_command_write(const struct device *dev,
207 const struct mipi_dbi_config *config,
208 uint8_t cmd, const uint8_t *data,
209 size_t len)
210{
211 const struct mipi_dbi_driver_api *api =
212 (const struct mipi_dbi_driver_api *)dev->api;
213
214 if (api->command_write == NULL) {
215 return -ENOSYS;
216 }
217 return api->command_write(dev, config, cmd, data, len);
218}
219
237static inline int mipi_dbi_command_read(const struct device *dev,
238 const struct mipi_dbi_config *config,
239 uint8_t *cmds, size_t num_cmd,
240 uint8_t *response, size_t len)
241{
242 const struct mipi_dbi_driver_api *api =
243 (const struct mipi_dbi_driver_api *)dev->api;
244
245 if (api->command_read == NULL) {
246 return -ENOSYS;
247 }
248 return api->command_read(dev, config, cmds, num_cmd, response, len);
249}
250
270static inline int mipi_dbi_write_display(const struct device *dev,
271 const struct mipi_dbi_config *config,
272 const uint8_t *framebuf,
273 struct display_buffer_descriptor *desc,
274 enum display_pixel_format pixfmt)
275{
276 const struct mipi_dbi_driver_api *api =
277 (const struct mipi_dbi_driver_api *)dev->api;
278
279 if (api->write_display == NULL) {
280 return -ENOSYS;
281 }
282 return api->write_display(dev, config, framebuf, desc, pixfmt);
283}
284
296static inline int mipi_dbi_reset(const struct device *dev, uint32_t delay_ms)
297{
298 const struct mipi_dbi_driver_api *api =
299 (const struct mipi_dbi_driver_api *)dev->api;
300
301 if (api->reset == NULL) {
302 return -ENOSYS;
303 }
304 return api->reset(dev, K_MSEC(delay_ms));
305}
306
324static inline int mipi_dbi_release(const struct device *dev,
325 const struct mipi_dbi_config *config)
326{
327 const struct mipi_dbi_driver_api *api =
328 (const struct mipi_dbi_driver_api *)dev->api;
329
330 if (api->release == NULL) {
331 return -ENOSYS;
332 }
333 return api->release(dev, config);
334}
335
362static inline int mipi_dbi_configure_te(const struct device *dev,
363 uint8_t edge,
364 uint32_t delay_us)
365{
366 const struct mipi_dbi_driver_api *api =
367 (const struct mipi_dbi_driver_api *)dev->api;
368
369 if (api->configure_te == NULL) {
370 return -ENOSYS;
371 }
372 return api->configure_te(dev, edge, K_USEC(delay_us));
373}
374
375#ifdef __cplusplus
376}
377#endif
378
382
383#endif /* ZEPHYR_INCLUDE_DRIVERS_MIPI_DBI_H_ */
Main header file for display driver API.
Main header file for SPI (Serial Peripheral Interface) driver API.
#define K_MSEC(ms)
Generate timeout delay from milliseconds.
Definition kernel.h:1497
#define K_USEC(t)
Generate timeout delay from microseconds.
Definition kernel.h:1461
display_pixel_format
Display pixel formats.
Definition display.h:43
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition ft8xx_reference_api.h:153
static int mipi_dbi_reset(const struct device *dev, uint32_t delay_ms)
Resets attached display controller.
Definition mipi_dbi.h:296
static int mipi_dbi_write_display(const struct device *dev, const struct mipi_dbi_config *config, const uint8_t *framebuf, struct display_buffer_descriptor *desc, enum display_pixel_format pixfmt)
Write a display buffer to the display controller.
Definition mipi_dbi.h:270
static int mipi_dbi_configure_te(const struct device *dev, uint8_t edge, uint32_t delay_us)
Configures MIPI DBI tearing effect signal.
Definition mipi_dbi.h:362
static int mipi_dbi_command_write(const struct device *dev, const struct mipi_dbi_config *config, uint8_t cmd, const uint8_t *data, size_t len)
Write a command to the display controller.
Definition mipi_dbi.h:206
static int mipi_dbi_release(const struct device *dev, const struct mipi_dbi_config *config)
Releases a locked MIPI DBI device.
Definition mipi_dbi.h:324
static int mipi_dbi_command_read(const struct device *dev, const struct mipi_dbi_config *config, uint8_t *cmds, size_t num_cmd, uint8_t *response, size_t len)
Read a command response from the display controller.
Definition mipi_dbi.h:237
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
Display definitions for MIPI devices.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
void * data
Address of the device instance private data.
Definition device.h:520
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
const void * config
Address of device instance config information.
Definition device.h:514
Structure to describe display data buffer layout.
Definition display.h:147
Kernel timeout type.
Definition clock.h:65
MIPI DBI controller configuration.
Definition mipi_dbi.h:157
uint8_t mode
MIPI DBI mode.
Definition mipi_dbi.h:159
struct spi_config config
SPI configuration.
Definition mipi_dbi.h:161
MIPI-DBI host driver API.
Definition mipi_dbi.h:166
int(* reset)(const struct device *dev, k_timeout_t delay)
Definition mipi_dbi.h:178
int(* release)(const struct device *dev, const struct mipi_dbi_config *config)
Definition mipi_dbi.h:179
int(* command_read)(const struct device *dev, const struct mipi_dbi_config *config, uint8_t *cmds, size_t num_cmds, uint8_t *response, size_t len)
Definition mipi_dbi.h:170
int(* command_write)(const struct device *dev, const struct mipi_dbi_config *config, uint8_t cmd, const uint8_t *data, size_t len)
Definition mipi_dbi.h:167
int(* write_display)(const struct device *dev, const struct mipi_dbi_config *config, const uint8_t *framebuf, struct display_buffer_descriptor *desc, enum display_pixel_format pixfmt)
Definition mipi_dbi.h:173
int(* configure_te)(const struct device *dev, uint8_t edge, k_timeout_t delay)
Definition mipi_dbi.h:181
SPI controller configuration structure.
Definition spi.h:438