/* SPDX-License-Identifier: GPL-2.0+ */ /* Copyright (C) 2013 Noralf Tronnes */ #ifndef __LINUX_FBTFT_H #define __LINUX_FBTFT_H #include <linux/fb.h> #include <linux/spinlock.h> #include <linux/spi/spi.h> #include <linux/platform_device.h> #define FBTFT_ONBOARD_BACKLIGHT … #define FBTFT_GPIO_NO_MATCH … #define FBTFT_GPIO_NAME_SIZE … #define FBTFT_MAX_INIT_SEQUENCE … #define FBTFT_GAMMA_MAX_VALUES_TOTAL … #define FBTFT_OF_INIT_CMD … #define FBTFT_OF_INIT_DELAY … /** * struct fbtft_gpio - Structure that holds one pinname to gpio mapping * @name: pinname (reset, dc, etc.) * @gpio: GPIO number * */ struct fbtft_gpio { … }; struct fbtft_par; /** * struct fbtft_ops - FBTFT operations structure * @write: Writes to interface bus * @read: Reads from interface bus * @write_vmem: Writes video memory to display * @write_reg: Writes to controller register * @set_addr_win: Set the GRAM update window * @reset: Reset the LCD controller * @mkdirty: Marks display lines for update * @update_display: Updates the display * @init_display: Initializes the display * @blank: Blank the display (optional) * @request_gpios_match: Do pinname to gpio matching * @request_gpios: Request gpios from the kernel * @free_gpios: Free previously requested gpios * @verify_gpios: Verify that necessary gpios is present (optional) * @register_backlight: Used to register backlight device (optional) * @unregister_backlight: Unregister backlight device (optional) * @set_var: Configure LCD with values from variables like @rotate and @bgr * (optional) * @set_gamma: Set Gamma curve (optional) * * Most of these operations have default functions assigned to them in * fbtft_framebuffer_alloc() */ struct fbtft_ops { … }; /** * struct fbtft_display - Describes the display properties * @width: Width of display in pixels * @height: Height of display in pixels * @regwidth: LCD Controller Register width in bits * @buswidth: Display interface bus width in bits * @backlight: Backlight type. * @fbtftops: FBTFT operations provided by driver or device (platform_data) * @bpp: Bits per pixel * @fps: Frames per second * @txbuflen: Size of transmit buffer * @init_sequence: Pointer to LCD initialization array * @gamma: String representation of Gamma curve(s) * @gamma_num: Number of Gamma curves * @gamma_len: Number of values per Gamma curve * @debug: Initial debug value * * This structure is not stored by FBTFT except for init_sequence. */ struct fbtft_display { … }; /** * struct fbtft_platform_data - Passes display specific data to the driver * @display: Display properties * @gpios: Pointer to an array of pinname to gpio mappings * @rotate: Display rotation angle * @bgr: LCD Controller BGR bit * @fps: Frames per second (this will go away, use @fps in @fbtft_display) * @txbuflen: Size of transmit buffer * @startbyte: When set, enables use of Startbyte in transfers * @gamma: String representation of Gamma curve(s) * @extra: A way to pass extra info */ struct fbtft_platform_data { … }; /** * struct fbtft_par - Main FBTFT data structure * * This structure holds all relevant data to operate the display * * See sourcefile for documentation since nested structs is not * supported by kernel-doc. * */ /* @spi: Set if it is a SPI device * @pdev: Set if it is a platform device * @info: Pointer to framebuffer fb_info structure * @pdata: Pointer to platform data * @ssbuf: Not used * @pseudo_palette: Used by fb_set_colreg() * @txbuf.buf: Transmit buffer * @txbuf.len: Transmit buffer length * @buf: Small buffer used when writing init data over SPI * @startbyte: Used by some controllers when in SPI mode. * Format: 6 bit Device id + RS bit + RW bit * @fbtftops: FBTFT operations provided by driver or device (platform_data) * @dirty_lock: Protects dirty_lines_start and dirty_lines_end * @dirty_lines_start: Where to begin updating display * @dirty_lines_end: Where to end updating display * @gpio.reset: GPIO used to reset display * @gpio.dc: Data/Command signal, also known as RS * @gpio.rd: Read latching signal * @gpio.wr: Write latching signal * @gpio.latch: Bus latch signal, eg. 16->8 bit bus latch * @gpio.cs: LCD Chip Select with parallel interface bus * @gpio.db[16]: Parallel databus * @gpio.led[16]: Led control signals * @gpio.aux[16]: Auxiliary signals, not used by core * @init_sequence: Pointer to LCD initialization array * @gamma.lock: Mutex for Gamma curve locking * @gamma.curves: Pointer to Gamma curve array * @gamma.num_values: Number of values per Gamma curve * @gamma.num_curves: Number of Gamma curves * @debug: Pointer to debug value * @current_debug: * @first_update_done: Used to only time the first display update * @update_time: Used to calculate 'fps' in debug output * @bgr: BGR mode/\n * @extra: Extra info needed by driver */ struct fbtft_par { … }; #define NUMARGS(...) … #define write_reg(par, ...) … /* fbtft-core.c */ int fbtft_write_buf_dc(struct fbtft_par *par, void *buf, size_t len, int dc); __printf(5, 6) void fbtft_dbg_hex(const struct device *dev, int groupsize, const void *buf, size_t len, const char *fmt, ...); struct fb_info *fbtft_framebuffer_alloc(struct fbtft_display *display, struct device *dev, struct fbtft_platform_data *pdata); void fbtft_framebuffer_release(struct fb_info *info); int fbtft_register_framebuffer(struct fb_info *fb_info); int fbtft_unregister_framebuffer(struct fb_info *fb_info); void fbtft_register_backlight(struct fbtft_par *par); void fbtft_unregister_backlight(struct fbtft_par *par); int fbtft_init_display(struct fbtft_par *par); int fbtft_probe_common(struct fbtft_display *display, struct spi_device *sdev, struct platform_device *pdev); void fbtft_remove_common(struct device *dev, struct fb_info *info); /* fbtft-io.c */ int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len); int fbtft_write_spi_emulate_9(struct fbtft_par *par, void *buf, size_t len); int fbtft_read_spi(struct fbtft_par *par, void *buf, size_t len); int fbtft_write_gpio8_wr(struct fbtft_par *par, void *buf, size_t len); int fbtft_write_gpio16_wr(struct fbtft_par *par, void *buf, size_t len); int fbtft_write_gpio16_wr_latched(struct fbtft_par *par, void *buf, size_t len); /* fbtft-bus.c */ int fbtft_write_vmem8_bus8(struct fbtft_par *par, size_t offset, size_t len); int fbtft_write_vmem16_bus16(struct fbtft_par *par, size_t offset, size_t len); int fbtft_write_vmem16_bus8(struct fbtft_par *par, size_t offset, size_t len); int fbtft_write_vmem16_bus9(struct fbtft_par *par, size_t offset, size_t len); void fbtft_write_reg8_bus8(struct fbtft_par *par, int len, ...); void fbtft_write_reg8_bus9(struct fbtft_par *par, int len, ...); void fbtft_write_reg16_bus8(struct fbtft_par *par, int len, ...); void fbtft_write_reg16_bus16(struct fbtft_par *par, int len, ...); #define FBTFT_DT_TABLE(_compatible) … #define FBTFT_SPI_DRIVER(_name, _compatible, _display, _spi_ids) … #define FBTFT_REGISTER_DRIVER(_name, _compatible, _display) … #define FBTFT_REGISTER_SPI_DRIVER(_name, _comp_vend, _comp_dev, _display) … /* Debug macros */ /* shorthand debug levels */ #define DEBUG_LEVEL_1 … #define DEBUG_LEVEL_2 … #define DEBUG_LEVEL_3 … #define DEBUG_LEVEL_4 … #define DEBUG_LEVEL_5 … #define DEBUG_LEVEL_6 … #define DEBUG_LEVEL_7 … #define DEBUG_DRIVER_INIT_FUNCTIONS … #define DEBUG_TIME_FIRST_UPDATE … #define DEBUG_TIME_EACH_UPDATE … #define DEBUG_DEFERRED_IO … #define DEBUG_FBTFT_INIT_FUNCTIONS … /* fbops */ #define DEBUG_FB_READ … #define DEBUG_FB_WRITE … #define DEBUG_FB_FILLRECT … #define DEBUG_FB_COPYAREA … #define DEBUG_FB_IMAGEBLIT … #define DEBUG_FB_SETCOLREG … #define DEBUG_FB_BLANK … #define DEBUG_SYSFS … /* fbtftops */ #define DEBUG_BACKLIGHT … #define DEBUG_READ … #define DEBUG_WRITE … #define DEBUG_WRITE_VMEM … #define DEBUG_WRITE_REGISTER … #define DEBUG_SET_ADDR_WIN … #define DEBUG_RESET … #define DEBUG_MKDIRTY … #define DEBUG_UPDATE_DISPLAY … #define DEBUG_INIT_DISPLAY … #define DEBUG_BLANK … #define DEBUG_REQUEST_GPIOS … #define DEBUG_FREE_GPIOS … #define DEBUG_REQUEST_GPIOS_MATCH … #define DEBUG_VERIFY_GPIOS … #define fbtft_init_dbg(dev, format, arg...) … #define fbtft_par_dbg(level, par, format, arg...) … #define fbtft_par_dbg_hex(level, par, dev, type, buf, num, format, arg...) … #endif /* __LINUX_FBTFT_H */
Codebase Browser
linux