chipone,co5300 (on spi bus)

Overview

Name:

chipone,co5300

Vendor:

ChipOne

Used in:

List of boards using this compatible

Driver:

drivers/display/display_co5300.c

Description

Chipone CO5300 Display Controller

Chipone CO5300 display controller on SPI bus.

The CO5300's SPI protocol uses opcode/address framing: a fixed
instruction byte (0x02) followed by a 3-byte address encoding the DCS
command ({8'h00, CMD[7:0], 8'h00}), followed by the command's
parameters or pixel data, all shifted out over a single data line.

Examples

#include <zephyr/dt-bindings/display/panel.h>

co5300_display: co5300-display@0 {
  /* ... */

  pixel-format = <PANEL_PIXEL_FORMAT_RGB_565>;
};

Properties

Node specific propertiesDeprecated node specific propertiesBase properties

Properties not inherited from the base binding file.

Name	Type	Details
pixel-format	int	Initial Pixel format of this controller's output data. This property is required. Legal values: 1, 16
spi-max-frequency	int	Maximum clock frequency of device's SPI interface in Hz This property is required.
duplex	int	Duplex mode, full or half. By default it's always full duplex thus 0 as this is, by far, the most common mode. Use the macros not the actual enum value, here is the concordance list (see dt-bindings/spi/spi.h) 0 SPI_FULL_DUPLEX 2048 SPI_HALF_DUPLEX Default value: 0 Legal values: 0, 2048
frame-format	int	Motorola or TI frame format. By default it's always Motorola's, thus 0 as this is, by far, the most common format. Use the macros not the actual enum value, here is the concordance list (see dt-bindings/spi/spi.h) 0 SPI_FRAME_FORMAT_MOTOROLA 32768 SPI_FRAME_FORMAT_TI Default value: 0 Legal values: 0, 32768
spi-cpol	boolean	SPI clock polarity which indicates the clock idle state. If it is used, the clock idle state is logic high; otherwise, low.
spi-cpha	boolean	SPI clock phase that indicates on which edge data is sampled. If it is used, data is sampled on the second edge; otherwise, on the first edge.
spi-lsb-first	boolean	The device requires least significant bit first data mode.
spi-hold-cs	boolean	In some cases, it is necessary for the controller to manage SPI chip select under software control, so that multiple spi transactions can be performed without releasing it. A typical use case is variable length SPI packets where the first spi transaction reads the length and the second spi transaction reads length bytes.
spi-cs-high	boolean	The device requires the chip select to be active high.
spi-interframe-delay-ns	int	Delay in nanoseconds between SPI words. Default of 0 is special value which will assume to mean half of the SCK period. Default value: 0
spi-cs-setup-delay-ns	int	Delay in nanoseconds to be introduced by the controller after CS is asserted. Also known as enable lead time.
spi-cs-hold-delay-ns	int	Delay in nanoseconds to be introduced by the controller before the CS is de-asserted. Also known as enable lag time.
supply-gpios	phandle-array	GPIO specifier that controls power to the device. This property should be provided when the device has a dedicated switch that controls power to the device. The supply state is entirely the responsibility of the device driver. Contrast with vin-supply.
vin-supply	phandle	Reference to the regulator that controls power to the device. The referenced devicetree node must have a regulator compatible. This property should be provided when device power is supplied by a shared regulator. The supply state is dependent on the request status of all devices fed by the regulator. Contrast with supply-gpios. If both properties are provided then the regulator must be requested before the supply GPIOS is set to an active state, and the supply GPIOS must be set to an inactive state before releasing the regulator.
reset-gpios	phandle-array	The RESETn pin is asserted to disable the controller causing a hard reset. The controller receives this as an active-low signal.
backlight-gpios	phandle-array	The BLn pin is asserted to control the backlight of the panel. The controller receives this as an active-high signal.
tear-effect-gpios	phandle-array	The tearing effect pin is asserted by the controller at a display VSYNC interval. This permits the controller to send new display data during a VSYNC interval, removing tearing.
red-blue-swap	boolean	Some panel variants require the red and blue color channels to be swapped. Enable this property when the panel controller expects BGR color channel order instead of RGB.
height	int	Height of the panel driven by the controller, with the units in pixels. This property is required.
width	int	Width of the panel driven by the controller, with the units in pixels. This property is required.