Auxiliary Display Driver Backend API

Data Structures
struct	auxdisplay_driver_api
	Driver Operations Auxiliary Display driver operations More...

Typedefs
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.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Auxiliary Display driver.

Typedef Documentation

auxdisplay_backlight_get_t

typedef int(* auxdisplay_backlight_get_t) (const struct device *dev, uint8_t *backlight)

#include <zephyr/drivers/auxdisplay.h>

Callback API to get the current and supported backlight settings.

See auxdisplay_backlight_get() for argument description.

auxdisplay_backlight_set_t

typedef int(* auxdisplay_backlight_set_t) (const struct device *dev, uint8_t backlight)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set the backlight level.

See auxdisplay_backlight_set() for argument description.

auxdisplay_brightness_get_t

typedef int(* auxdisplay_brightness_get_t) (const struct device *dev, uint8_t *brightness)

#include <zephyr/drivers/auxdisplay.h>

Callback API to get the current and supported brightness settings.

See auxdisplay_brightness_get() for argument description.

auxdisplay_brightness_set_t

typedef int(* auxdisplay_brightness_set_t) (const struct device *dev, uint8_t brightness)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set the brightness of the display.

See auxdisplay_brightness_set() for argument description.

auxdisplay_capabilities_get_t

typedef int(* auxdisplay_capabilities_get_t) (const struct device *dev, struct auxdisplay_capabilities *capabilities)

#include <zephyr/drivers/auxdisplay.h>

Callback API to get display capabilities.

See auxdisplay_capabilities_get() for argument description.

auxdisplay_clear_t

typedef int(* auxdisplay_clear_t) (const struct device *dev)

#include <zephyr/drivers/auxdisplay.h>

Callback API to clear the contents of the display.

See auxdisplay_clear() for argument description.

auxdisplay_cursor_position_get_t

typedef int(* auxdisplay_cursor_position_get_t) (const struct device *dev, int16_t *x, int16_t *y)

#include <zephyr/drivers/auxdisplay.h>

Callback API to get the cursor position.

See auxdisplay_cursor_position_get() for argument description.

auxdisplay_cursor_position_set_t

typedef int(* auxdisplay_cursor_position_set_t) (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set the cursor position.

See auxdisplay_cursor_position_set() for argument description.

auxdisplay_cursor_set_enabled_t

typedef int(* auxdisplay_cursor_set_enabled_t) (const struct device *dev, bool enabled)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set display cursor visibility on or off.

See auxdisplay_cursor_set_enabled() for argument description.

auxdisplay_cursor_shift_set_t

typedef int(* auxdisplay_cursor_shift_set_t) (const struct device *dev, uint8_t direction, bool display_shift)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set how the cursor shifts after a character is written.

See auxdisplay_cursor_shift_set() for argument description.

auxdisplay_custom_character_set_t

typedef int(* auxdisplay_custom_character_set_t) (const struct device *dev, struct auxdisplay_character *character)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set a custom character on the display.

See auxdisplay_custom_character_set() for argument description.

auxdisplay_custom_command_t

typedef int(* auxdisplay_custom_command_t) (const struct device *dev, struct auxdisplay_custom_data *command)

#include <zephyr/drivers/auxdisplay.h>

Callback API to send a custom command to the display.

See auxdisplay_custom_command() for argument description.

auxdisplay_display_off_t

typedef int(* auxdisplay_display_off_t) (const struct device *dev)

#include <zephyr/drivers/auxdisplay.h>

Callback API to turn display off.

See auxdisplay_display_off() for argument description.

auxdisplay_display_on_t

typedef int(* auxdisplay_display_on_t) (const struct device *dev)

#include <zephyr/drivers/auxdisplay.h>

Callback API to turn display on.

See auxdisplay_display_on() for argument description.

auxdisplay_display_position_get_t

typedef int(* auxdisplay_display_position_get_t) (const struct device *dev, int16_t *x, int16_t *y)

#include <zephyr/drivers/auxdisplay.h>

Callback API to get the current position of the display.

See auxdisplay_display_position_get() for argument description.

auxdisplay_display_position_set_t

typedef int(* auxdisplay_display_position_set_t) (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set the current position of the display.

See auxdisplay_display_position_set() for argument description.

auxdisplay_is_busy_t

typedef int(* auxdisplay_is_busy_t) (const struct device *dev)

#include <zephyr/drivers/auxdisplay.h>

Callback API to check if the display is busy with an operation.

See auxdisplay_is_busy() for argument description.

auxdisplay_position_blinking_set_enabled_t

typedef int(* auxdisplay_position_blinking_set_enabled_t) (const struct device *dev, bool enabled)

#include <zephyr/drivers/auxdisplay.h>

Callback API to set the current position blinking on or off.

See auxdisplay_position_blinking_set_enabled() for argument description.

auxdisplay_write_t

typedef int(* auxdisplay_write_t) (const struct device *dev, const uint8_t *data, uint16_t len)

#include <zephyr/drivers/auxdisplay.h>

Callback API to write text to the display.

See auxdisplay_write() for argument description.