2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-12-30 06:53:09 +00:00
u-boot/include/display.h
Heinrich Schuchardt 185f812c41 doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.

find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-01-19 18:11:34 +01:00

97 lines
2.3 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright 2014 Google Inc.
*/
#ifndef _DISPLAY_H
#define _DISPLAY_H
struct udevice;
struct display_timing;
/**
* Display uclass platform data for each device
*
* @source_id: ID for the source of the display data, typically a video
* controller
* @src_dev: Source device providing the video
* @in_use: Display is being used
*/
struct display_plat {
int source_id;
struct udevice *src_dev;
bool in_use;
};
/**
* display_read_timing() - Read timing information
*
* @dev: Device to read from
* Return: 0 if OK, -ve on error
*/
int display_read_timing(struct udevice *dev, struct display_timing *timing);
/**
* display_port_enable() - Enable a display port device
*
* @dev: Device to enable
* @panel_bpp: Number of bits per pixel for panel
* @timing: Display timings
* Return: 0 if OK, -ve on error
*/
int display_enable(struct udevice *dev, int panel_bpp,
const struct display_timing *timing);
/**
* display_in_use() - Check if a display is in use by any device
*
* Return: true if the device is in use (display_enable() has been called
* successfully), else false
*/
bool display_in_use(struct udevice *dev);
struct dm_display_ops {
/**
* read_timing() - Read information directly
*
* @dev: Device to read from
* @timing: Display timings
* @return 0 if OK, -ve on error
*/
int (*read_timing)(struct udevice *dev, struct display_timing *timing);
/**
* read_edid() - Read information from EDID
*
* @dev: Device to read from
* @buf: Buffer to read into (should be EDID_SIZE bytes)
* @buf_size: Buffer size (should be EDID_SIZE)
* @return number of bytes read, <=0 for error
*/
int (*read_edid)(struct udevice *dev, u8 *buf, int buf_size);
/**
* enable() - Enable the display port device
*
* @dev: Device to enable
* @panel_bpp: Number of bits per pixel for panel
* @timing: Display timings
* @return 0 if OK, -ve on error
*/
int (*enable)(struct udevice *dev, int panel_bpp,
const struct display_timing *timing);
/**
* mode_valid() - Check if mode is supported
*
* @dev: Device to enable
* @timing: Display timings
* @return true if supported, false if not
*/
bool (*mode_valid)(struct udevice *dev,
const struct display_timing *timing);
};
#define display_get_ops(dev) ((struct dm_display_ops *)(dev)->driver->ops)
#endif