usb_io.h File Reference

#include "ie_types.h"

Go to the source code of this file.

Classes

struct  tagBACKLIGHTINFO
struct  tagPOINT
struct  tagRECT
struct  tagINK
struct  tagLAYER
struct  tagDISPLAY
struct  tagOPTIONS
struct  tagMOUSE_REPORT
struct  tagECHO_REPORT
struct  tagDATA_FLAGS
struct  tagDATA_REPORT
struct  tagCLRSCRN_REPORT
struct  tagRESET_DEFAULTS_REPORT
struct  tagOPTIONS_REPORT
struct  tagTEST_REPORT
struct  tagLINE_REPORT
struct  tagSERIALNUM_REPORT
struct  tagSCRN_HEADER
struct  tagWRITE_SCRN_REPORT
struct  tagBITMAP_HEADER
struct  tagBITMAP_REPORT
struct  tagDISPLAY_CAL
struct  tagFILTER_CAL
struct  tagSYS_CAL
struct  tagSYSCAL_REPORT

Defines

#define WEDGE_VID   0x04df
#define WEDGE_PID   0x0030
#define LCD_WIDTH   320
#define LCD_HEIGHT   240
#define N_SCREEN_ID   4
#define BYTES_PER_SCREEN_ID   ( (INT32U)LCD_WIDTH*(INT32U)LCD_HEIGHT/8L/(INT32U)N_SCREEN_ID )
#define LCD_BYTES_PER_LINE   ( LCD_WIDTH/8 )
#define LCD_BITMAP_WIDTH   64
#define LCD_BITMAP_HEIGHT   64
#define LCD_N_LAYERS   3
#define USAGE(_x_)   _x_

Typedefs

typedef ON_OFF_AUTO ON_OFF
typedef tagBACKLIGHTINFO BACKLIGHT_INFO
typedef tagBACKLIGHTINFOPBACKLIGHT_INFO
typedef tagPOINT POINT
typedef tagPOINTPPOINT
typedef tagRECT RECT
typedef tagRECTPRECT
typedef tagINK INK_INFO
typedef tagINKPINK_INFO
typedef tagLAYER VISIBILITY
typedef tagLAYERPVISIBILITY
typedef tagDISPLAY DISPLAY
typedef tagDISPLAYPDISPLAY
typedef tagOPTIONS OPTIONS
typedef tagOPTIONSPOPTIONS
typedef INT8U T_REPORT_ID
typedef tagMOUSE_REPORT MOUSE_REPORT
typedef tagMOUSE_REPORTPMOUSE_REPORT
typedef tagECHO_REPORT ECHO_REPORT
typedef tagDATA_FLAGS DATA_FLAGS
typedef tagDATA_FLAGSPDATA_FLAGS
typedef tagDATA_REPORT DATA_REPORT
typedef tagDATA_REPORTPDATA_REPORT
typedef tagCLRSCRN_REPORT CLRSCRN_REPORT
typedef tagRESET_DEFAULTS_REPORT RESET_DEFAULTS_REPORT
typedef tagOPTIONS_REPORT OPTIONS_REPORT
typedef tagTEST_REPORT TEST_REPORT
typedef tagTEST_REPORTPTEST_REPORT
typedef tagLINE_REPORT LINE_REPORT
typedef tagLINE_REPORTPLINE_REPORT
typedef tagSERIALNUM_REPORT SERIALNUM_REPORT
typedef tagSERIALNUM_REPORTPSERIALNUM_REPORT
typedef tagSCRN_HEADER SCRN_HEADER
typedef tagWRITE_SCRN_REPORT WRITE_SCRN_REPORT
typedef tagWRITE_SCRN_REPORTPWRITE_SCRN_REPORT
typedef tagBITMAP_HEADER BITMAP_HEADER
typedef tagBITMAP_REPORT BITMAP_REPORT
typedef tagDISPLAY_CAL DISPLAY_CAL
typedef tagDISPLAY_CALPDISPLAY_CAL
typedef tagFILTER_CAL FILTER_CAL
typedef tagFILTER_CALPFILTER_CAL
typedef tagSYS_CAL SYS_CAL
typedef tagSYS_CALPSYS_CAL
typedef tagSYSCAL_REPORT SYSCAL_REPORT
typedef tagSYSCAL_REPORTPSYSCAL_REPORT

Enumerations

enum  ON_OFF_AUTO { B_OFF = 0, B_ON = 1, B_AUTO = 2 }
enum  LCD_LAYER { LAYER1 = 0x00, LAYER2 = 0x01, LAYER3 = 0x02 }
enum  PEN_COLOR { PEN_BLACK = 1, PEN_WHITE = 0 }
enum  BRIGHTNESS { BL_DIM = 0, BL_BRIGHT = 1 }
enum  LAYER_CODE {
  CURSOR_OFF = 0x00, LAYER_OFF = 0x00, LAYER_ON = 0x01, LAYER_FLASH = 0x02,
  LAYER_HALF = 0x03
}
enum  MIX_CODE { MIX_OR = 0x1C, MIX_XOR_OR = 0x1D, MIX_AND_OR = 0x1E, MIX_PRI_OR = 0x1F }
enum  REPORT_ID {
  R_DATA = 1, R_SELFTEST = 2, R_OPTIONS = 3, R_ECHO = 4,
  R_DRAWLINE = 5, R_SERIAL = 6, R_WRITESCRN = 7, R_SYSCAL = 8,
  R_CLRSCRN = 9, R_DEFAULTS = 10, R_BITMAP = 11
}
enum  TEST_RESULT { STATUS_IO_FAILURE = 0xff, STATUS_OK = 0 }


Define Documentation

#define BYTES_PER_SCREEN_ID   ( (INT32U)LCD_WIDTH*(INT32U)LCD_HEIGHT/8L/(INT32U)N_SCREEN_ID )
 

Definition at line 42 of file ePadInk/inc/usb_io.h.

#define LCD_BITMAP_HEIGHT   64
 

Definition at line 46 of file ePadInk/inc/usb_io.h.

#define LCD_BITMAP_WIDTH   64
 

Definition at line 45 of file ePadInk/inc/usb_io.h.

#define LCD_BYTES_PER_LINE   ( LCD_WIDTH/8 )
 

Definition at line 43 of file ePadInk/inc/usb_io.h.

#define LCD_HEIGHT   240
 

Definition at line 39 of file ePadInk/inc/usb_io.h.

#define LCD_N_LAYERS   3
 

Definition at line 48 of file ePadInk/inc/usb_io.h.

#define LCD_WIDTH   320
 

Definition at line 38 of file ePadInk/inc/usb_io.h.

#define N_SCREEN_ID   4
 

Definition at line 41 of file ePadInk/inc/usb_io.h.

#define USAGE _x_   )     _x_
 

Definition at line 150 of file ePadInk/inc/usb_io.h.

#define WEDGE_PID   0x0030
 

Definition at line 36 of file ePadInk/inc/usb_io.h.

#define WEDGE_VID   0x04df
 

Definition at line 35 of file ePadInk/inc/usb_io.h.


Typedef Documentation

typedef struct tagBACKLIGHTINFO BACKLIGHT_INFO
 

typedef struct tagBITMAP_HEADER BITMAP_HEADER
 

Origin must be (X,y) where X = n * 8 where 0<=n<=((LCD_WIDTH/8) - 1).

(In other words X must begin on an even byte boundary.)
Ex:

  0,8,16,...n*8

typedef struct tagBITMAP_REPORT BITMAP_REPORT
 

typedef struct tagCLRSCRN_REPORT CLRSCRN_REPORT
 

typedef struct tagDATA_FLAGS DATA_FLAGS
 

typedef struct tagDATA_REPORT DATA_REPORT
 

typedef struct tagDISPLAY DISPLAY
 

typedef struct tagDISPLAY_CAL DISPLAY_CAL
 

f(x) = x*gain + offset

typedef struct tagECHO_REPORT ECHO_REPORT
 

typedef struct tagFILTER_CAL FILTER_CAL
 

typedef struct tagINK INK_INFO
 

typedef struct tagLINE_REPORT LINE_REPORT
 

typedef struct tagMOUSE_REPORT MOUSE_REPORT
 

typedef ON_OFF_AUTO ON_OFF
 

Definition at line 56 of file ePadInk/inc/usb_io.h.

typedef struct tagOPTIONS OPTIONS
 

typedef struct tagOPTIONS_REPORT OPTIONS_REPORT
 

typedef struct tagBACKLIGHTINFO * PBACKLIGHT_INFO
 

typedef struct tagDATA_FLAGS * PDATA_FLAGS
 

typedef struct tagDATA_REPORT * PDATA_REPORT
 

typedef struct tagDISPLAY * PDISPLAY
 

typedef struct tagDISPLAY_CAL * PDISPLAY_CAL
 

f(x) = x*gain + offset

typedef struct tagFILTER_CAL * PFILTER_CAL
 

typedef struct tagINK * PINK_INFO
 

typedef struct tagLINE_REPORT * PLINE_REPORT
 

typedef struct tagMOUSE_REPORT * PMOUSE_REPORT
 

typedef struct tagPOINT POINT
 

typedef struct tagOPTIONS * POPTIONS
 

typedef struct tagPOINT * PPOINT
 

typedef struct tagRECT * PRECT
 

typedef struct tagSERIALNUM_REPORT * PSERIALNUM_REPORT
 

typedef struct tagSYS_CAL * PSYS_CAL
 

typedef struct tagSYSCAL_REPORT * PSYSCAL_REPORT
 

typedef struct tagTEST_REPORT * PTEST_REPORT
 

typedef struct tagLAYER * PVISIBILITY
 

typedef struct tagWRITE_SCRN_REPORT * PWRITE_SCRN_REPORT
 

typedef struct tagRECT RECT
 

typedef struct tagRESET_DEFAULTS_REPORT RESET_DEFAULTS_REPORT
 

typedef struct tagSCRN_HEADER SCRN_HEADER
 

Origin must be (0,n*BYTES_PER_SCREEN_ID) where 0<=n<=N_SCREEN_ID

typedef struct tagSERIALNUM_REPORT SERIALNUM_REPORT
 

typedef struct tagSYS_CAL SYS_CAL
 

typedef struct tagSYSCAL_REPORT SYSCAL_REPORT
 

typedef INT8U T_REPORT_ID
 

Definition at line 152 of file ePadInk/inc/usb_io.h.

typedef struct tagTEST_REPORT TEST_REPORT
 

typedef struct tagLAYER VISIBILITY
 

typedef struct tagWRITE_SCRN_REPORT WRITE_SCRN_REPORT
 


Enumeration Type Documentation

enum BRIGHTNESS
 

Enumerator:
BL_DIM 
BL_BRIGHT 

Definition at line 69 of file ePadInk/inc/usb_io.h.

00069              {              // LCD Backlight intensity settings
00070     BL_DIM      = 0,
00071     BL_BRIGHT   = 1
00072 } BRIGHTNESS;

enum LAYER_CODE
 

Enumerator:
CURSOR_OFF 
LAYER_OFF 
LAYER_ON 
LAYER_FLASH 
LAYER_HALF 

Definition at line 106 of file ePadInk/inc/usb_io.h.

00106              {          // visibility options for LCD layers
00107     CURSOR_OFF  = 0x00,
00108     LAYER_OFF   = 0x00,
00109     LAYER_ON    = 0x01,
00110     LAYER_FLASH = 0x02,
00111     LAYER_HALF  = 0x03
00112 } LAYER_CODE;

enum LCD_LAYER
 

Enumerator:
LAYER1 
LAYER2 
LAYER3 

Definition at line 58 of file ePadInk/inc/usb_io.h.

00058              {              // LCD has 3 virtual screen layers
00059     LAYER1 = 0x00,
00060     LAYER2 = 0x01,
00061     LAYER3 = 0x02
00062 } LCD_LAYER;

enum MIX_CODE
 

Enumerator:
MIX_OR 
MIX_XOR_OR 
MIX_AND_OR 
MIX_PRI_OR 

Definition at line 114 of file ePadInk/inc/usb_io.h.

00114              {           // layer mixing code
00115     MIX_OR      = 0x1C,  // all three layers OR-ed (00011100)
00116     MIX_XOR_OR  = 0x1D,  // (L1 XOR L2) OR L3      (00011101)
00117     MIX_AND_OR  = 0x1E,  // (L1 AND L2) OR L3      (00011110)
00118     MIX_PRI_OR  = 0x1F   // L1, L2, L3 priority OR (00011111)
00119 } MIX_CODE;

enum ON_OFF_AUTO
 

Enumerator:
B_OFF 
B_ON 
B_AUTO 

Definition at line 50 of file ePadInk/inc/usb_io.h.

00050              {
00051     B_OFF    = 0,
00052     B_ON     = 1,
00053     B_AUTO   = 2
00054 } ON_OFF_AUTO;

enum PEN_COLOR
 

Enumerator:
PEN_BLACK 
PEN_WHITE 

Definition at line 64 of file ePadInk/inc/usb_io.h.

00064              {              // determines inking background and pen color
00065     PEN_BLACK   = 1,
00066     PEN_WHITE   = 0
00067 } PEN_COLOR;

enum REPORT_ID
 

Report ID assignments

Enumerator:
R_DATA 
R_SELFTEST 
R_OPTIONS 
R_ECHO 
R_DRAWLINE 
R_SERIAL 
R_WRITESCRN 
R_SYSCAL 
R_CLRSCRN 
R_DEFAULTS 
R_BITMAP 

Definition at line 136 of file ePadInk/inc/usb_io.h.

00136              {
00137     R_DATA      = 1,
00138     R_SELFTEST  = 2,
00139     R_OPTIONS   = 3,
00140     R_ECHO      = 4,    // This function (Mouse Echo) is not used.
00141     R_DRAWLINE  = 5,
00142     R_SERIAL    = 6,
00143     R_WRITESCRN = 7,
00144     R_SYSCAL    = 8,
00145     R_CLRSCRN   = 9,
00146     R_DEFAULTS  = 10,
00147     R_BITMAP    = 11
00148 } REPORT_ID;

enum TEST_RESULT
 

Enumerator:
STATUS_IO_FAILURE 
STATUS_OK 

Definition at line 181 of file ePadInk/inc/usb_io.h.

00181              {                      // self test code descriptions
00182     STATUS_IO_FAILURE = 0xff,       // Indicates we failed to do I/O to the device.
00183     STATUS_OK = 0
00184 } TEST_RESULT;


Generated on Tue Nov 21 11:11:28 2006 for ePadAPIs by  doxygen 1.4.6-NO