DisplayHost.h File Reference

Detailed Description

Display driver for printf-like output.

============================================================================

Driver include

The header file should be included in an application as follows:

#include <ti/display/Display.h>
#include <ti/display/DisplayHost.h>

Below is an example configuration to use the HOST display.

#include <ti/display/Display.h>
#include <ti/display/DisplayHost.h>

#define MAXPRINTLEN 1024

DisplayHost_Object displayHostObject;
static char displayBuf[MAXPRINTLEN];

const DisplayHost_HWAttrs displayHostHWAttrs = {
    .strBuf = displayBuf,
    .strBufLen = MAXPRINTLEN
};

const Display_Config Display_config[] = {
    {
        .fxnTablePtr = &DisplayHost_fxnTable,
        .object = &displayHostObject,
        .hwAttrs = &displayHostHWAttrs
    }
};

const uint8_t Display_count = sizeof(Display_config) / sizeof(Display_Config);

Calling Context

For TIRTOS based applications, the Display_HOST interface is only callable from Task context. The Display_HOST interface is callable from any context for FreeRTOS based applications.

---

#include <ti/display/Display.h>

Include dependency graph for DisplayHost.h:

Go to the source code of this file.

Data Structures
struct	DisplayHost_HWAttrs
	DisplayHost Attributes. More...
struct	DisplayHost_Object
	DisplayHost Object. More...

Typedefs
typedef struct DisplayHost_HWAttrs	DisplayHost_HWAttrs
	DisplayHost Attributes. More...
typedef struct DisplayHost_Object	DisplayHost_Object
	DisplayHost Object. More...
typedef struct DisplayHost_Object *	DisplayHost_Handle

Functions
void	DisplayHost_init (Display_Handle handle)
Display_Handle	DisplayHost_open (Display_Handle, Display_Params *params)
void	DisplayHost_clear (Display_Handle handle)
void	DisplayHost_clearLines (Display_Handle handle, uint8_t fromLine, uint8_t toLine)
void	DisplayHost_vprintf (Display_Handle handle, uint8_t line, uint8_t column, const char *fmt, va_list va)
void	DisplayHost_close (Display_Handle)
int	DisplayHost_control (Display_Handle handle, unsigned int cmd, void *arg)
unsigned int	DisplayHost_getType (void)

Variables
const Display_FxnTable	DisplayHost_fxnTable

Typedef Documentation

DisplayHost_HWAttrs

typedef struct DisplayHost_HWAttrs DisplayHost_HWAttrs

DisplayHost Attributes.

The DisplayHost driver uses a buffer for formatting messages, which is then passed to an fwrite() function. The location and size of the buffer are specified in a DisplayHost_HWAttrs structure.

DisplayHost_Object

typedef struct DisplayHost_Object DisplayHost_Object

DisplayHost Object.

The application must not access any member variables of this structure!

DisplayHost_Handle

typedef struct DisplayHost_Object * DisplayHost_Handle

Function Documentation

DisplayHost_init()

void DisplayHost_init

(

Display_Handle

handle

)

DisplayHost_open()

Display_Handle DisplayHost_open	(	Display_Handle	,
		Display_Params *	params
	)

DisplayHost_clear()

void DisplayHost_clear

(

Display_Handle

handle

)

DisplayHost_clearLines()

void DisplayHost_clearLines	(	Display_Handle	handle,
		uint8_t	fromLine,
		uint8_t	toLine
	)

DisplayHost_vprintf()

void DisplayHost_vprintf	(	Display_Handle	handle,
		uint8_t	line,
		uint8_t	column,
		const char *	fmt,
		va_list	va
	)

DisplayHost_close()

void DisplayHost_close

(

Display_Handle

)

DisplayHost_control()

int DisplayHost_control	(	Display_Handle	handle,
		unsigned int	cmd,
		void *	arg
	)

DisplayHost_getType()

unsigned int DisplayHost_getType

(

void

)

Variable Documentation

DisplayHost_fxnTable

const Display_FxnTable DisplayHost_fxnTable