display.h File Reference

Header file for display Driver. More...

#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"

Include dependency graph for display.h:

Classes
struct	display_dev
	Display Device Descriptor. More...
struct	display_init_param
	Display Device Initial Parameters. More...
struct	display_controller_ops
	Structure holding display controller function pointers that point to the controller specific function. More...

Functions
int32_t	display_init (struct display_dev **device, const struct display_init_param *param)
	Initializes the display peripheral.
int32_t	display_remove (struct display_dev *device)
	Frees the resources allocated by display_init().
int32_t	display_on (struct display_dev *device)
	Turns display on.
int32_t	display_off (struct display_dev *device)
	Turns display off.
int32_t	display_move_cursor (struct display_dev *device, uint8_t row, uint8_t column)
	Moves cursor to desired position.
int32_t	display_clear (struct display_dev *device)
	Clears data on display.
int32_t	display_print_string (struct display_dev *device, char *msg, uint8_t row, uint8_t column)
	Prints char string at selected position.
int32_t	display_print_char (struct display_dev *device, char chr, uint8_t row, uint8_t column)
	Prints single char at selected position.
int32_t	display_print_buffer (struct display_dev *device, char *buffer)
	Prints entire screen buffer.

Detailed Description

Header file for display Driver.

Author

Andrei Porumb (andre.nosp@m.i.po.nosp@m.rumb@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2021(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

display_clear()

int32_t display_clear

(

struct display_dev *

device

)

Clears data on display.

Clears data on display.

Parameters

device

- The device structure.

Returns

Returns 0 in case of success or negative error code otherwise.

display_init()

int32_t display_init	(	struct display_dev **	device,
		const struct display_init_param *	param )

Initializes the display peripheral.

Initializes the display peripheral.

Parameters

device	- The device structure.
param	- The structure that contains the device initial parameters.

Returns

Returns 0 in case of success or negative error code otherwise.

display_move_cursor()

int32_t display_move_cursor	(	struct display_dev *	device,
		uint8_t	row,
		uint8_t	column )

Moves cursor to desired position.

Moves cursor to desired position.

Parameters

device	- The device structure.
row	- row
column	- column

Returns

Returns 0 in case of success or negative error code otherwise.

display_off()

int32_t display_off

(

struct display_dev *

device

)

Turns display off.

Turns display off

Parameters

device

- The device structure.

Returns

Returns 0 in case of success or negative error code otherwise.

display_on()

int32_t display_on

(

struct display_dev *

device

)

Turns display on.

Turns display on

Parameters

device

- The device structure.

Returns

Returns 0 in case of success or negative error code otherwise.

display_print_buffer()

int32_t display_print_buffer	(	struct display_dev *	device,
		char *	buffer )

Prints entire screen buffer.

Print display buffer on entire screen

Parameters

device	- The device structure.
buffer	- The buffer to be printed.

Returns

Returns 0 in case of success or negative error code otherwise.

display_print_char()

int32_t display_print_char	(	struct display_dev *	device,
		char	chr,
		uint8_t	row,
		uint8_t	column )

Prints single char at selected position.

Prints single char at selected position.

Parameters

device	- The device structure.
chr	- char to be printed
row	- row
column	- column

Returns

Returns 0 in case of success or negative error code otherwise.

display_print_string()

int32_t display_print_string	(	struct display_dev *	device,
		char *	msg,
		uint8_t	row,
		uint8_t	column )

Prints char string at selected position.

Prints char string at selected position.

Parameters

device	- The device structure.
msg	- char string pointer
row	- row
column	- column

Returns

Returns 0 in case of success or negative error code otherwise.

display_remove()

int32_t display_remove

(

struct display_dev *

device

)

Frees the resources allocated by display_init().

Parameters

device

- The device structure.

Returns

Returns 0 in case of success or negative error code otherwise.