drm/sitronix/st7571-i2c: move common structures to st7571.h

Move all structures that will be common for all interfaces (SPI/I2C) to
a separate header file.

Reviewed-by: Javier Martinez Canillas <javierm@redhat.com>
Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
Link: https://patch.msgid.link/20251215-st7571-split-v3-3-d5f3205c3138@gmail.com
Signed-off-by: Javier Martinez Canillas <javierm@redhat.com>
This commit is contained in:
Marcus Folkesson 2025-12-15 10:46:45 +01:00 committed by Javier Martinez Canillas
parent bc12f3e1a8
commit d93a435468
No known key found for this signature in database
GPG Key ID: C751E590D63F3D69
3 changed files with 111 additions and 89 deletions

View File

@ -8201,6 +8201,7 @@ S: Maintained
F: Documentation/devicetree/bindings/display/sitronix,st7567.yaml
F: Documentation/devicetree/bindings/display/sitronix,st7571.yaml
F: drivers/gpu/drm/sitronix/st7571-i2c.c
F: drivers/gpu/drm/sitronix/st7571.h
DRM DRIVER FOR SITRONIX ST7701 PANELS
M: Jagan Teki <jagan@amarulasolutions.com>

View File

@ -35,6 +35,8 @@
#include <video/display_timing.h>
#include <video/of_display_timing.h>
#include "st7571.h"
#define ST7571_COMMAND_MODE (0x00)
#define ST7571_DATA_MODE (0x40)
@ -78,95 +80,6 @@
#define DRIVER_MAJOR 1
#define DRIVER_MINOR 0
enum st7571_color_mode {
ST7571_COLOR_MODE_GRAY = 0,
ST7571_COLOR_MODE_BLACKWHITE = 1,
};
struct st7571_device;
struct st7571_panel_constraints {
u32 min_nlines;
u32 max_nlines;
u32 min_ncols;
u32 max_ncols;
bool support_grayscale;
};
struct st7571_panel_data {
int (*init)(struct st7571_device *st7571);
int (*parse_dt)(struct st7571_device *st7571);
struct st7571_panel_constraints constraints;
};
struct st7571_panel_format {
void (*prepare_buffer)(struct st7571_device *st7571,
const struct iosys_map *vmap,
struct drm_framebuffer *fb,
struct drm_rect *rect,
struct drm_format_conv_state *fmtcnv_state);
int (*update_rect)(struct drm_framebuffer *fb, struct drm_rect *rect);
enum st7571_color_mode mode;
const u8 nformats;
const u32 formats[];
};
struct st7571_device {
struct drm_device drm;
struct device *dev;
struct drm_plane primary_plane;
struct drm_crtc crtc;
struct drm_encoder encoder;
struct drm_connector connector;
struct drm_display_mode mode;
const struct st7571_panel_format *pformat;
const struct st7571_panel_data *pdata;
struct i2c_client *client;
struct gpio_desc *reset;
struct regmap *regmap;
/*
* Depending on the hardware design, the acknowledge signal may be hard to
* recognize as a valid logic "0" level.
* Therefor, ignore NAK if possible to stay compatible with most hardware designs
* and off-the-shelf panels out there.
*
* From section 6.4 MICROPOCESSOR INTERFACE section in the datasheet:
*
* "By connecting SDA_OUT to SDA_IN externally, the SDA line becomes fully
* I2C interface compatible.
* Separating acknowledge-output from serial data
* input is advantageous for chip-on-glass (COG) applications. In COG
* applications, the ITO resistance and the pull-up resistor will form a
* voltage divider, which affects acknowledge-signal level. Larger ITO
* resistance will raise the acknowledged-signal level and system cannot
* recognize this level as a valid logic 0 level. By separating SDA_IN from
* SDA_OUT, the IC can be used in a mode that ignores the acknowledge-bit.
* For applications which check acknowledge-bit, it is necessary to minimize
* the ITO resistance of the SDA_OUT trace to guarantee a valid low level."
*
*/
bool ignore_nak;
bool grayscale;
bool inverted;
u32 height_mm;
u32 width_mm;
u32 startline;
u32 nlines;
u32 ncols;
u32 bpp;
/* Intermediate buffer in LCD friendly format */
u8 *hwbuf;
/* Row of (transformed) pixels ready to be written to the display */
u8 *row;
};
static inline struct st7571_device *drm_to_st7571(struct drm_device *drm)
{
return container_of(drm, struct st7571_device, drm);

View File

@ -0,0 +1,108 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* Header file for:
* Driver for Sitronix ST7571, a 4 level gray scale dot matrix LCD controller
*
* Copyright (C) 2025 Marcus Folkesson <marcus.folkesson@gmail.com>
*/
#ifndef __ST7571_H__
#define __ST7571_H__
#include <drm/drm_connector.h>
#include <drm/drm_crtc.h>
#include <drm/drm_drv.h>
#include <drm/drm_encoder.h>
#include <linux/regmap.h>
enum st7571_color_mode {
ST7571_COLOR_MODE_GRAY = 0,
ST7571_COLOR_MODE_BLACKWHITE = 1,
};
struct st7571_device;
struct st7571_panel_constraints {
u32 min_nlines;
u32 max_nlines;
u32 min_ncols;
u32 max_ncols;
bool support_grayscale;
};
struct st7571_panel_data {
int (*init)(struct st7571_device *st7571);
int (*parse_dt)(struct st7571_device *st7571);
struct st7571_panel_constraints constraints;
};
struct st7571_panel_format {
void (*prepare_buffer)(struct st7571_device *st7571,
const struct iosys_map *vmap,
struct drm_framebuffer *fb,
struct drm_rect *rect,
struct drm_format_conv_state *fmtcnv_state);
int (*update_rect)(struct drm_framebuffer *fb, struct drm_rect *rect);
enum st7571_color_mode mode;
const u8 nformats;
const u32 formats[];
};
struct st7571_device {
struct drm_device drm;
struct device *dev;
struct drm_plane primary_plane;
struct drm_crtc crtc;
struct drm_encoder encoder;
struct drm_connector connector;
struct drm_display_mode mode;
const struct st7571_panel_format *pformat;
const struct st7571_panel_data *pdata;
struct i2c_client *client;
struct gpio_desc *reset;
struct regmap *regmap;
/*
* Depending on the hardware design, the acknowledge signal may be hard to
* recognize as a valid logic "0" level.
* Therefor, ignore NAK if possible to stay compatible with most hardware designs
* and off-the-shelf panels out there.
*
* From section 6.4 MICROPOCESSOR INTERFACE section in the datasheet:
*
* "By connecting SDA_OUT to SDA_IN externally, the SDA line becomes fully
* I2C interface compatible.
* Separating acknowledge-output from serial data
* input is advantageous for chip-on-glass (COG) applications. In COG
* applications, the ITO resistance and the pull-up resistor will form a
* voltage divider, which affects acknowledge-signal level. Larger ITO
* resistance will raise the acknowledged-signal level and system cannot
* recognize this level as a valid logic 0 level. By separating SDA_IN from
* SDA_OUT, the IC can be used in a mode that ignores the acknowledge-bit.
* For applications which check acknowledge-bit, it is necessary to minimize
* the ITO resistance of the SDA_OUT trace to guarantee a valid low level."
*
*/
bool ignore_nak;
bool grayscale;
bool inverted;
u32 height_mm;
u32 width_mm;
u32 startline;
u32 nlines;
u32 ncols;
u32 bpp;
/* Intermediate buffer in LCD friendly format */
u8 *hwbuf;
/* Row of (transformed) pixels ready to be written to the display */
u8 *row;
};
#endif /* __ST7571_H__ */