[J-u-boot.git] / include / video_bridge.h

/*
 * Copyright (C) 2015 Google, Inc
 * Written by Simon Glass <[email protected]>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef __VIDEO_BRIDGE
#define __VIDEO_BRIDGE

#include <asm/gpio.h>

/**
 * struct video_bridge_priv - uclass information for video bridges
 *
 * @sleep:	GPIO to assert to power down the bridge
 * @reset:	GPIO to assert to reset the bridge
 * @hotplug:	Optional GPIO to check if bridge is connected
 */
struct video_bridge_priv {
	struct gpio_desc sleep;
	struct gpio_desc reset;
	struct gpio_desc hotplug;
};

/**
 * Operations for video bridges
 */
struct video_bridge_ops {
	/**
	 * attach() - attach a video bridge
	 *
	 * @return 0 if OK, -ve on error
	 */
	int (*attach)(struct udevice *dev);

	/**
	 * check_attached() - check if a bridge is correctly attached
	 *
	 * This method is optional - if not provided then the hotplug GPIO
	 * will be checked instead.
	 *
	 * @dev:	Device to check
	 * @return 0 if attached, -EENOTCONN if not, or other -ve error
	 */
	int (*check_attached)(struct udevice *dev);

	/**
	 * set_backlight() - Set the backlight brightness
	 *
	 * @dev:	device to adjust
	 * @percent:	brightness percentage (0=off, 100=full brightness)
	 * @return 0 if OK, -ve on error
	 */
	int (*set_backlight)(struct udevice *dev, int percent);
};

#define video_bridge_get_ops(dev) \
		((struct video_bridge_ops *)(dev)->driver->ops)

/**
 * video_bridge_attach() - attach a video bridge
 *
 * @return 0 if OK, -ve on error
 */
int video_bridge_attach(struct udevice *dev);

/**
 * video_bridge_set_backlight() - Set the backlight brightness
 *
 * @percent:	brightness percentage (0=off, 100=full brightness)
 * @return 0 if OK, -ve on error
 */
int video_bridge_set_backlight(struct udevice *dev, int percent);

/**
 * video_bridge_set_active() - take the bridge in/out of reset/powerdown
 *
 * @dev:	Device to adjust
 * @active:	true to power up and reset, false to power down
 */
int video_bridge_set_active(struct udevice *dev, bool active);

/**
 * check_attached() - check if a bridge is correctly attached
 *
 * @dev:	Device to check
 * @return 0 if attached, -EENOTCONN if not, or other -ve error
 */
int video_bridge_check_attached(struct udevice *dev);

#endif
Commit	Line	Data
801ab9e9 SG	1	/*
	2	* Copyright (C) 2015 Google, Inc
	3	* Written by Simon Glass <[email protected]>
	4	*
	5	* SPDX-License-Identifier: GPL-2.0+
	6	*/
	7
	8	#ifndef __VIDEO_BRIDGE
	9	#define __VIDEO_BRIDGE
	10
	11	#include <asm/gpio.h>
	12
	13	/**
	14	* struct video_bridge_priv - uclass information for video bridges
	15	*
	16	* @sleep: GPIO to assert to power down the bridge
	17	* @reset: GPIO to assert to reset the bridge
	18	* @hotplug: Optional GPIO to check if bridge is connected
	19	*/
	20	struct video_bridge_priv {
	21	struct gpio_desc sleep;
	22	struct gpio_desc reset;
	23	struct gpio_desc hotplug;
	24	};
	25
	26	/**
	27	* Operations for video bridges
	28	*/
	29	struct video_bridge_ops {
	30	/**
	31	* attach() - attach a video bridge
	32	*
	33	* @return 0 if OK, -ve on error
	34	*/
	35	int (attach)(struct udevice dev);
	36
	37	/**
	38	* check_attached() - check if a bridge is correctly attached
	39	*
	40	* This method is optional - if not provided then the hotplug GPIO
	41	* will be checked instead.
	42	*
	43	* @dev: Device to check
	44	* @return 0 if attached, -EENOTCONN if not, or other -ve error
	45	*/
	46	int (check_attached)(struct udevice dev);
	47
	48	/**
	49	* set_backlight() - Set the backlight brightness
	50	*
	51	* @dev: device to adjust
	52	* @percent: brightness percentage (0=off, 100=full brightness)
	53	* @return 0 if OK, -ve on error
	54	*/
	55	int (set_backlight)(struct udevice dev, int percent);
	56	};
	57
	58	#define video_bridge_get_ops(dev) \
	59	((struct video_bridge_ops *)(dev)->driver->ops)
	60
	61	/**
	62	* video_bridge_attach() - attach a video bridge
	63	*
	64	* @return 0 if OK, -ve on error
65	*/
66	int video_bridge_attach(struct udevice *dev);
67
68	/**
69	* video_bridge_set_backlight() - Set the backlight brightness
70	*
71	* @percent: brightness percentage (0=off, 100=full brightness)
72	* @return 0 if OK, -ve on error
73	*/
74	int video_bridge_set_backlight(struct udevice *dev, int percent);
75
76	/**
77	* video_bridge_set_active() - take the bridge in/out of reset/powerdown
78	*
79	* @dev: Device to adjust
80	* @active: true to power up and reset, false to power down
81	*/
82	int video_bridge_set_active(struct udevice *dev, bool active);
83
84	/**
85	* check_attached() - check if a bridge is correctly attached
86	*
87	* @dev: Device to check
88	* @return 0 if attached, -EENOTCONN if not, or other -ve error
89	*/
90	int video_bridge_check_attached(struct udevice *dev);
91
92	#endif