auxdisplay.h File Reference

Main header file for auxiliary (textual/non-graphical) display driver API. More...

#include <stdint.h>
#include <stddef.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/syscalls/auxdisplay.h>

Go to the source code of this file.

Data Structures
struct	auxdisplay_light
	Light levels for brightness and/or backlight. More...
struct	auxdisplay_capabilities
	Structure holding display capabilities. More...
struct	auxdisplay_custom_data
	Structure for a custom command. More...
struct	auxdisplay_character
	Structure for a custom character. More...
struct	auxdisplay_driver_api
	Driver Operations Auxiliary Display driver operations More...

Macros
#define	AUXDISPLAY_LIGHT_NOT_SUPPORTED   0
	Used for minimum and maximum brightness/backlight values if not supported.

Typedefs
typedef uint32_t	auxdisplay_mode_t
	Used to describe the mode of an auxiliary (text) display.
typedef int(*	auxdisplay_display_on_t) (const struct device *dev)
	Callback API to turn display on.
typedef int(*	auxdisplay_display_off_t) (const struct device *dev)
	Callback API to turn display off.
typedef int(*	auxdisplay_cursor_set_enabled_t) (const struct device *dev, bool enabled)
	Callback API to set display cursor visibility on or off.
typedef int(*	auxdisplay_position_blinking_set_enabled_t) (const struct device *dev, bool enabled)
	Callback API to set the current position blinking on or off.
typedef int(*	auxdisplay_cursor_shift_set_t) (const struct device *dev, uint8_t direction, bool display_shift)
	Callback API to set how the cursor shifts after a character is written.
typedef int(*	auxdisplay_cursor_position_set_t) (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Callback API to set the cursor position.
typedef int(*	auxdisplay_cursor_position_get_t) (const struct device *dev, int16_t *x, int16_t *y)
	Callback API to get the cursor position.
typedef int(*	auxdisplay_display_position_set_t) (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Callback API to set the current position of the display.
typedef int(*	auxdisplay_display_position_get_t) (const struct device *dev, int16_t *x, int16_t *y)
	Callback API to get the current position of the display.
typedef int(*	auxdisplay_capabilities_get_t) (const struct device *dev, struct auxdisplay_capabilities *capabilities)
	Callback API to get display capabilities.
typedef int(*	auxdisplay_clear_t) (const struct device *dev)
	Callback API to clear the contents of the display.
typedef int(*	auxdisplay_brightness_get_t) (const struct device *dev, uint8_t *brightness)
	Callback API to get the current and supported brightness settings.
typedef int(*	auxdisplay_brightness_set_t) (const struct device *dev, uint8_t brightness)
	Callback API to set the brightness of the display.
typedef int(*	auxdisplay_backlight_get_t) (const struct device *dev, uint8_t *backlight)
	Callback API to get the current and supported backlight settings.
typedef int(*	auxdisplay_backlight_set_t) (const struct device *dev, uint8_t backlight)
	Callback API to set the backlight level.
typedef int(*	auxdisplay_is_busy_t) (const struct device *dev)
	Callback API to check if the display is busy with an operation.
typedef int(*	auxdisplay_custom_character_set_t) (const struct device *dev, struct auxdisplay_character *character)
	Callback API to set a custom character on the display.
typedef int(*	auxdisplay_write_t) (const struct device *dev, const uint8_t *data, uint16_t len)
	Callback API to write text to the display.
typedef int(*	auxdisplay_custom_command_t) (const struct device *dev, struct auxdisplay_custom_data *command)
	Callback API to send a custom command to the display.

Enumerations
enum	auxdisplay_position { AUXDISPLAY_POSITION_ABSOLUTE = 0 , AUXDISPLAY_POSITION_RELATIVE , AUXDISPLAY_POSITION_RELATIVE_DIRECTION , AUXDISPLAY_POSITION_COUNT }
	Used for moving the cursor or display position. More...
enum	auxdisplay_direction { AUXDISPLAY_DIRECTION_RIGHT = 0 , AUXDISPLAY_DIRECTION_LEFT , AUXDISPLAY_DIRECTION_COUNT }
	Used for setting character append position. More...

Functions
int	auxdisplay_display_on (const struct device *dev)
	Turn display on.
int	auxdisplay_display_off (const struct device *dev)
	Turn display off.
int	auxdisplay_cursor_set_enabled (const struct device *dev, bool enabled)
	Set cursor enabled status on an auxiliary display.
int	auxdisplay_position_blinking_set_enabled (const struct device *dev, bool enabled)
	Set cursor blinking status on an auxiliary display.
int	auxdisplay_cursor_shift_set (const struct device *dev, uint8_t direction, bool display_shift)
	Set cursor shift after character write and display shift.
int	auxdisplay_cursor_position_set (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Set cursor (and write position) on an auxiliary display.
int	auxdisplay_cursor_position_get (const struct device *dev, int16_t *x, int16_t *y)
	Get current cursor on an auxiliary display.
int	auxdisplay_display_position_set (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Set display position on an auxiliary display.
int	auxdisplay_display_position_get (const struct device *dev, int16_t *x, int16_t *y)
	Get current display position on an auxiliary display.
int	auxdisplay_capabilities_get (const struct device *dev, struct auxdisplay_capabilities *capabilities)
	Fetch capabilities (and details) of auxiliary display.
int	auxdisplay_clear (const struct device *dev)
	Clear display of auxiliary display and return to home position.
int	auxdisplay_brightness_get (const struct device *dev, uint8_t *brightness)
	Get the current brightness level of an auxiliary display.
int	auxdisplay_brightness_set (const struct device *dev, uint8_t brightness)
	Update the brightness level of an auxiliary display.
int	auxdisplay_backlight_get (const struct device *dev, uint8_t *backlight)
	Get the backlight level details of an auxiliary display.
int	auxdisplay_backlight_set (const struct device *dev, uint8_t backlight)
	Update the backlight level of an auxiliary display.
int	auxdisplay_is_busy (const struct device *dev)
	Check if an auxiliary display driver is busy.
int	auxdisplay_custom_character_set (const struct device *dev, struct auxdisplay_character *character)
	Sets a custom character in the display.
int	auxdisplay_write (const struct device *dev, const uint8_t *data, uint16_t len)
	Write data to auxiliary display screen at current position.
int	auxdisplay_custom_command (const struct device *dev, struct auxdisplay_custom_data *data)
	Send a custom command to the display (if supported by driver).

Detailed Description

Main header file for auxiliary (textual/non-graphical) display driver API.