Display

Content
	Ili9341

Enumerations
enum	pi_display_ioctl_cmd_e

Functions
int	pi_display_open (struct pi_device *device)
	Open a display device. More...
void	pi_display_write (struct pi_device *device, pi_buffer_t *buffer, uint16_t x, uint16_t y, uint16_t w, uint16_t h)
	Write on a display device. Blocking API. More...
static int32_t	pi_display_ioctl (struct pi_device *device, uint32_t cmd, void *arg)
	Send display specific command. More...
static void	pi_display_write_async (struct pi_device *device, pi_buffer_t *buffer, uint16_t x, uint16_t y, uint16_t w, uint16_t h, pi_task_t *task)
	Write on a display device. Non blocking API. More...

Description

The display driver provides supprt to write and print on LCD screens.

Enumeration Type Documentation

enum pi_display_ioctl_cmd_e

Enumerator
PI_DISPLAY_IOCTL_CUSTOM

Function Documentation

static int32_t pi_display_ioctl ( struct pi_device *  device, uint32_t  cmd, void *  arg  )

inlinestatic

This function is called to send a display device specific command. Arguments for commands can be given using

Parameters

arg	parameter.
device	A pointer to the device structure of the device to open.
cmd	Command to send.
arg	Parameters/arguments to send to device for the command.

Returns

Value Depend on type of commands.

int pi_display_open

(

struct pi_device *

device

)

This function must be called before the display device can be used. It does all the needed configuration to enable displaye device.

Parameters

device

A pointer to the device structure of the device to open.

Return values

0	Device opened successfully. error code otherwise.

void pi_display_write	(	struct pi_device *	device,
		pi_buffer_t *	buffer,
		uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h
	)

This function is called to print/write a buffer on a display device. It displays a whole frame of (width * height) size on display at position (x, y).

Parameters

device	A pointer to the device structure of the device to open.
buffer	Data buffer to write on diplay.
x	X position on LCD.
y	Y position on LCD.
w	Width of buffer.
h	Height of buffer.

Note

This function is synchronous, caller can not do anything else until transfer is finished. The pending asynchronous function is below : pi_display_write_async().

static void pi_display_write_async ( struct pi_device *  device, pi_buffer_t *  buffer, uint16_t  x, uint16_t  y, uint16_t  w, uint16_t  h, pi_task_t *  task  )

inlinestatic

This function is called to print/write a buffer on a display device. It displays a whole frame of (width * height) size on display at position (x, y).

Parameters

device	A pointer to the device structure of the device to open.
buffer	Data buffer to write on diplay.
x	X position on LCD.
y	Y position on LCD.
w	Width of buffer.
h	Height of buffer.
task	Task to use to check end of transfer.

Note

This function is asynchronous, caller can do something else while transfer is enqueued The pending synchronous function is below : pi_display_write().