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:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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. More...
int32_t	display_remove (struct display_dev *device)
	Frees the resources allocated by display_init(). More...
int32_t	display_on (struct display_dev *device)
	Turns display on. More...
int32_t	display_off (struct display_dev *device)
	Turns display off. More...
int32_t	display_move_cursor (struct display_dev *device, uint8_t row, uint8_t column)
	Moves cursor to desired position. More...
int32_t	display_clear (struct display_dev *device)
	Clears data on display. More...
int32_t	display_print_string (struct display_dev *device, char *msg, uint8_t row, uint8_t column)
	Prints char string at selected position. More...
int32_t	display_print_char (struct display_dev *device, char chr, uint8_t row, uint8_t column)
	Prints single char at selected position. More...

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.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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.