Nut/OS  4.10.3
API Reference
term.h File Reference

Terminal device definitions. More...

#include <sys/device.h>
Include dependency graph for term.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _WINSIZE
struct  _TERMDCB
 Terminal device control block structure. More...

Defines

#define LCD_CMDBYTE   0x0401
#define LCD_CMDWORD16   0x0402
#define LCD_CMDWORD32   0x0403
#define LCD_DATABYTE   0x0405
#define LCD_DATAWORD16   0x0406
#define LCD_DATAWORD32   0x0407
#define LCD_SETCOOKEDMODE   0x0413
 Set raw mode.
#define LCD_GETCOOKEDMODE   0x0414
 Query raw mode.
#define LCD_SET_AUTOLF   0x0415
#define LCD_GET_AUTOLF   0x0416
#define TIOCGWINSZ   0x0501
#define TIOCSWINSZ   0x0502
#define LCD_MF_CURSORON   0x00000001UL
 Cursor on flag.
#define LCD_MF_COOKEDMODE   0x00020000UL
 Control character interpretation on flag.
#define LCD_MF_AUTOLF   0x00040000UL
 Control automatic break into next line on line end.
#define LCD_MF_AUTOSCROLL   0x00080000UL
 Control automatic scrolling at end of display.
#define LCD_MF_INVERTED   0x10000000UL
#define ESC_CHAR   "\x1B"
#define ESC_POS   ESC_CHAR "Y"
#define ESC_UP   ESC_CHAR "A"
#define ESC_DOWN   ESC_CHAR "B"
#define ESC_RIGHT   ESC_CHAR "C"
#define ESC_LEFT   ESC_CHAR "D"
#define ESC_CLRHOME   ESC_CHAR "E"
#define ESC_HOME   ESC_CHAR "H"
#define ESC_CLREND   ESC_CHAR "J"
#define ESC_CLREOL   ESC_CHAR "K"
#define ESC_CLRSTART   ESC_CHAR "d"
#define ESC_CLRSOL   ESC_CHAR "o"
#define ESC_INSCHAR   ESC_CHAR "@"
#define ESC_INSLINE   ESC_CHAR "L"
#define ESC_DELCHAR   ESC_CHAR "P"
#define ESC_DELLINE   ESC_CHAR "M"
#define ESC_RLF   ESC_CHAR "I"
#define ESC_CURSORON   ESC_CHAR "e"
#define ESC_CURSOROFF   ESC_CHAR "f"
#define ESC_INVERTON   ESC_CHAR "i"
#define ESC_INVERTOFF   ESC_CHAR "n"
#define ESC_SPECIALSET   ESC_CHAR "F"
#define ESC_DEFAULTSET   ESC_CHAR "G"
#define ESC_ACTIVE   ESC_CHAR "R"
#define ESC_SLEEP   ESC_CHAR "S"
#define ESC_CLR   ESC_CLRHOME
 Deprecated, use ESC_CLRHOME.

Typedefs

typedef struct _WINSIZE WINSIZE
typedef struct _TERMDCB TERMDCB

Functions

int TermInit (NUTDEVICE *dev)
 Initialize the terminal device.
int TermIOCtl (NUTDEVICE *dev, int req, void *conf)
 Perform special LCD control functions.
int TermWrite (NUTFILE *fp, CONST void *buffer, int len)
 Write data to a terminal device.
int TermWrite_P (NUTFILE *fp, PGM_P buffer, int len)
 Write data from program space to a terminal device.
NUTFILETermOpen (NUTDEVICE *dev, CONST char *name, int mode, int acc)
 Open a terminal device.
int TermClose (NUTFILE *fp)
 Close a device or file.

Detailed Description

Terminal device definitions.

Definition in file term.h.