home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / cdisk.zip / SERIAL / SERIAL.H < prev    next >
Text File  |  1992-12-29  |  7KB  |  157 lines
  1. /* serial.h
  2.    include file for sample driver
  3. */
  4.  
  5. #define  SAMPLE_CAT  0x90           /* category for DosDevIOCtl          */
  6. #define  CR 0x0d
  7. #define  MIN_TIMEOUT 15000L           /* ~5 second timeout                 */
  8. #define  UART_PORT_ADDRESS 0x220
  9.  
  10. /* driver utilized structures */
  11.  
  12. typedef struct _DCBINFO {           /* DCB storage for this driver       */
  13.     USHORT usWriteTimeout;          /* timeouts for Block calls          */
  14.     USHORT usReadTimeout;           /* real Block call timeout           */
  15.     UCHAR  fbCtlHndShake;           /* OS/2 std data follows             */
  16.     UCHAR  fbFlowReplace;
  17.     UCHAR  fbTimeout;
  18.     UCHAR  bErrorReplacementChar;
  19.     UCHAR  bBreakReplacementChar;
  20.     UCHAR  bXONChar;
  21.     UCHAR  bXOFFChar;
  22. } 
  23. DCBINFO;
  24.  
  25. typedef struct _MODEMSTATUS {
  26.     UCHAR fbModemOn;
  27.     UCHAR fbModemOff;
  28. } 
  29. MODEMSTATUS;
  30.  
  31. /* standard OS/2 structure */
  32.  
  33. typedef struct _LINECONTROL {
  34.     UCHAR bDataBits;
  35.     UCHAR bParity;
  36.     UCHAR bStopBits;
  37.     UCHAR fbTransBreak;
  38. } LINECONTROL;
  39.  
  40. /* queue info returned by driver */
  41.  
  42. typedef struct _QUEUE {
  43.     USHORT cch;
  44.     USHORT cb;
  45. } 
  46. QUEUE;
  47.  
  48. /* this structure holds the register values for the 82510 uart */
  49.  
  50. typedef struct _UARTREGS {
  51.  
  52. /* bank 0, 8250/16450 compatibility bank */
  53.  
  54.     UCHAR Txd_0;                    /* transmit/read data FIFO             */
  55.     UCHAR Ger;                      /* general enable register             */
  56.     UCHAR Bal;                      /* baud rate generator A low           */
  57.     UCHAR Bah;                      /* baud rate generator A high          */
  58.     UCHAR Bank_0;                   /* select bank 0                       */
  59.     UCHAR Lcr;                      /* line control register               */
  60.     UCHAR Mcr_0;                    /* modem control register              */
  61.     UCHAR Lsr;                      /* line status register                */
  62.     UCHAR Msr;                      /* modem status register               */
  63.     UCHAR Acr0;                     /* character match value 0             */
  64.  
  65. /* bank 1, general work bank  */
  66.  
  67.     UCHAR Txd_1;                    /* transmit/read data FIFO             */
  68.     UCHAR Txf;                      /* 9th bit transmit register           */
  69.     UCHAR Bank_1;                   /* select bank 1                       */
  70.     UCHAR Tmcr;                     /* start timer A/B command register    */
  71.     UCHAR Mcr_1;                    /* modem control register for bank 1   */
  72.     UCHAR Rcm;                      /* receiver command register           */
  73.     UCHAR Tcm;                      /* transmit command register           */
  74.     UCHAR Icm;                      /* internal command register           */
  75.  
  76. /* bank 2, general configuration bank */
  77.  
  78.     UCHAR Fmd;                      /* FIFO threshold register             */
  79.     UCHAR Bank_2;                   /* select bank 2                       */
  80.     UCHAR Tmd;                      /* transmit mode register              */
  81.     UCHAR Imd;                      /* internal mode register              */
  82.     UCHAR Acr1;                     /* character match value 1             */
  83.     UCHAR Rie;                      /* receiver interrupt enable register  */
  84.     UCHAR Rmd;                      /* receive mode register               */
  85.  
  86. /* bank 3, modem configuration bank */
  87.  
  88.     UCHAR Clcf;                     /* clocks configure register           */
  89.     UCHAR Bacf;                     /* baud rate generator A config. reg.  */
  90.     UCHAR Bbl;                      /* baud rate generator B low value     */
  91.     UCHAR Bbh;                      /* baud rate generator B high value    */
  92.     UCHAR Bank_3;                   /* selct bank 3                        */
  93.     UCHAR Bbcf;                     /* baud rate generator B config. reg.  */
  94.     UCHAR Pmd;                      /* I/O mode pin register               */
  95.     UCHAR Mie;                      /* modem interrupt enable register     */
  96.     UCHAR Tmie;                     /* timer interrupt enable register     */
  97.  
  98. } UARTREGS;
  99. /* this structure holds the start and end message times for an adam message*/ 
  100.  
  101. typedef struct _DATETIME {         /* date, adam driver/server specific   */
  102.     UCHAR   hours;
  103.     UCHAR   minutes;
  104.     UCHAR   seconds;
  105.     UCHAR   hundredths;
  106.     UCHAR   day;
  107.     UCHAR   month;
  108.     USHORT  year;
  109.     short   timezone;
  110.     UCHAR   weekday;
  111.  
  112. } DATETIME;
  113. typedef DATETIME far *PDATETIME;
  114.  
  115. /* this structure holds all the driver and uart specific data for each
  116. of the four or eight 82510 uarts.
  117. */   
  118.  
  119. typedef struct _UART {
  120.    UARTREGS     uart_regs;          /* 82510 register structures           */
  121.    LINECONTROL  line_control;       /* OS/2 line control struct            */
  122.    MODEMSTATUS  modem_status;       /* OS/2 modem status struct            */
  123.    DCBINFO      dcb_info;           /* our special DCBINFO struct          */
  124.    UCHAR        opencount;          /* number of opens on a device         */
  125.    unsigned int savepid;            /* saved PID of app that opened device */
  126.    PREQPACKET   ReadQHead;          /* head pointer for linked req. queue  */
  127.    PREQPACKET   WriteQHead;         /* head pointer for linked req. queue  */
  128.    PREQPACKET   ThisReadRP;         /* pointer to current read req. pkt.   */
  129.    PREQPACKET   ThisWriteRP;        /* pointer to current write req. pkt.  */
  130.    ULONG        ReadID;             /* used for thread ID for read Block   */
  131.    ULONG        WriteID;            /* used for thread ID for write Block  */
  132.    USHORT       baud_rate;          /* current baud rate for port          */
  133.    USHORT       first_flag;         /* for timeout logic                   */
  134.    ULONG        tickcount;          /* used for driver Block call timeout  */
  135.    UCHAR        inchar;             /* current char read from uart FIFO    */
  136.    UCHAR        outchar;            /* current output character            */
  137.    UCHAR        savechar;           /* last char transmitted for bus cont. */
  138.    UCHAR        tempchar;           /* temp character storage              */
  139.    ULONG        timeout;            /* current driver timeout value        */
  140.    int          temp;               /* misc temp storage                   */
  141.    int          temp_port;          /* used to hold port temporarily       */
  142.    int          com_error_word;     /* OS/2-like, holds last comm error    */
  143.    int          com_event_word;     /* what happened last                  */
  144.    char         com_status_word;    /* what's happening now                */
  145.    USHORT       transmit_data_status; /* xmit status                       */
  146.    char         modem_input_signals; /* status of modem signals            */
  147.    char         modem_output_signals;/* set modem signals                  */
  148.    int          port;                /* current port                       */
  149.    QUEUE        receive_queue;       /* receive queue data returned to app */
  150.    QUEUE        transmit_queue;      /* xmit queue data returned to app    */
  151.    CHARQUEUE    rxadam_queue;        /* OS/2 circular receive queue        */
  152.    CHARQUEUE    txadam_queue;        /* OS/2 circular transmit queue       */
  153.  
  154.   } UART;
  155.  
  156.  
  157.