1 /* sim_tmxr.h: terminal multiplexor definitions 2 3 Copyright (c) 2001-2020, Robert M Supnik 4 5 Permission is hereby granted, free of charge, to any person obtaining a 6 copy of this software and associated documentation files (the "Software"), 7 to deal in the Software without restriction, including without limitation 8 the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 and/or sell copies of the Software, and to permit persons to whom the 10 Software is furnished to do so, subject to the following conditions: 11 12 The above copyright notice and this permission notice shall be included in 13 all copies or substantial portions of the Software. 14 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 ROBERT M SUPNIK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 22 Except as contained in this notice, the name of Robert M Supnik shall not be 23 used in advertising or otherwise to promote the sale, use or other dealings 24 in this Software without prior written authorization from Robert M Supnik. 25 26 Based on the original DZ11 simulator by Thord Nilson, as updated by 27 Arthur Krewat. 28 29 23-Oct-20 JDB Added tmxr_post_logs global routine 30 19-Dec-19 JDB Added tmxr_is_extended global hook 31 19-Mar-19 JDB Added extension pointer to TMLN structure; 32 added tmxr_read, tmxr_write, tmxr_show, tmxr_close global hooks; 33 added tmxr_find_ldsc, tmxr_send_buffered_data, tmxr_init_line, 34 tmxr_report_connection, and tmxr_disconnect_line globals 35 06-Aug-15 JDB [4.0] Added modem control bits and functions 36 14-Dec-14 JDB [4.0] Added include of "sim_sock.h" for SOCKET, etc. 37 20-Nov-08 RMS Added three new standardized SHOW routines 38 27-May-08 JDB Added lnorder to TMXR structure, 39 added tmxr_set_lnorder and tmxr_set_lnorder 40 14-May-08 JDB Added dptr to TMXR structure 41 04-Jan-04 RMS Changed TMXR ldsc to be pointer to linedesc array 42 Added tmxr_linemsg, logging (from Mark Pizzolato) 43 29-Dec-03 RMS Added output stall support, increased buffer size 44 22-Dec-02 RMS Added break support (from Mark Pizzolato) 45 20-Aug-02 RMS Added tmxr_open_master, tmxr_close_master, tmxr.port 46 30-Dec-01 RMS Renamed tmxr_fstatus, added tmxr_fstats 47 20-Oct-01 RMS Removed tmxr_getchar, formalized buffer guard, 48 added tmxr_rqln, tmxr_tqln 49 */ 50 51 #ifndef SIM_TMXR_H_ 52 #define SIM_TMXR_H_ 0 53 54 #include "sim_sock.h" 55 56 #define TMXR_V_VALID 15 57 #define TMXR_VALID (1 << TMXR_V_VALID) 58 #define TMXR_MAXBUF 256 /* buffer size */ 59 #define TMXR_GUARD 12 /* buffer guard */ 60 61 /* Modem Control Bits */ 62 63 #define TMXR_MDM_DTR 0x01 /* Data Terminal Ready */ 64 #define TMXR_MDM_RTS 0x02 /* Request To Send */ 65 #define TMXR_MDM_DCD 0x04 /* Data Carrier Detect */ 66 #define TMXR_MDM_RNG 0x08 /* Ring Indicator */ 67 #define TMXR_MDM_CTS 0x10 /* Clear To Send */ 68 #define TMXR_MDM_DSR 0x20 /* Data Set Ready */ 69 #define TMXR_MDM_INCOMING (TMXR_MDM_DCD|TMXR_MDM_RNG|TMXR_MDM_CTS|TMXR_MDM_DSR) /* Settable Modem Bits */ 70 #define TMXR_MDM_OUTGOING (TMXR_MDM_DTR|TMXR_MDM_RTS) /* Settable Modem Bits */ 71 72 struct tmln { 73 SOCKET conn; /* line conn */ 74 char *ipad; /* IP address */ 75 uint32 cnms; /* conn time */ 76 int32 tsta; /* Telnet state */ 77 int32 rcve; /* rcv enable */ 78 int32 xmte; /* xmt enable */ 79 int32 dstb; /* disable Tlnt bin */ 80 int32 rxbpr; /* rcv buf remove */ 81 int32 rxbpi; /* rcv buf insert */ 82 int32 rxcnt; /* rcv count */ 83 int32 txbpr; /* xmt buf remove */ 84 int32 txbpi; /* xmt buf insert */ 85 int32 txcnt; /* xmt count */ 86 FILE *txlog; /* xmt log file */ 87 char *txlogname; /* xmt log file name */ 88 char rxb[TMXR_MAXBUF]; /* rcv buffer */ 89 char rbr[TMXR_MAXBUF]; /* rcv break */ 90 char txb[TMXR_MAXBUF]; /* xmt buffer */ 91 void *exptr; /* extension pointer */ 92 }; 93 94 typedef struct tmln TMLN; 95 96 struct tmxr { 97 int32 lines; /* # lines */ 98 int32 port; /* listening port */ 99 SOCKET master; /* master socket */ 100 TMLN *ldsc; /* line descriptors */ 101 int32 *lnorder; /* line connection order */ 102 DEVICE *dptr; /* multiplexer device */ 103 }; 104 105 typedef struct tmxr TMXR; 106 107 int32 tmxr_poll_conn (TMXR *mp); 108 void tmxr_reset_ln (TMLN *lp); 109 int32 tmxr_getc_ln (TMLN *lp); 110 void tmxr_poll_rx (TMXR *mp); 111 t_stat tmxr_putc_ln (TMLN *lp, int32 chr); 112 void tmxr_poll_tx (TMXR *mp); 113 t_stat tmxr_open_master (TMXR *mp, char *cptr); 114 t_stat tmxr_close_master (TMXR *mp); 115 t_stat tmxr_attach (TMXR *mp, UNIT *uptr, char *cptr); 116 t_stat tmxr_detach (TMXR *mp, UNIT *uptr); 117 t_stat tmxr_set_modem_control_passthru (TMXR *mp); 118 t_stat tmxr_set_get_modem_bits (TMLN *lp, int32 bits_to_set, int32 bits_to_clear, int32 *incoming_bits); 119 t_stat tmxr_ex (t_value *vptr, t_addr addr, UNIT *uptr, int32 sw); 120 t_stat tmxr_dep (t_value val, t_addr addr, UNIT *uptr, int32 sw); 121 void tmxr_msg (SOCKET sock, const char *msg); 122 void tmxr_linemsg (TMLN *lp, const char *msg); 123 void tmxr_fconns (FILE *st, TMLN *lp, int32 ln); 124 void tmxr_fstats (FILE *st, TMLN *lp, int32 ln); 125 t_stat tmxr_set_log (UNIT *uptr, int32 val, char *cptr, void *desc); 126 t_stat tmxr_set_nolog (UNIT *uptr, int32 val, char *cptr, void *desc); 127 void tmxr_post_logs (t_bool close_logs); 128 t_stat tmxr_show_log (FILE *st, UNIT *uptr, int32 val, void *desc); 129 t_stat tmxr_dscln (UNIT *uptr, int32 val, char *cptr, void *desc); 130 int32 tmxr_rqln (TMLN *lp); 131 int32 tmxr_tqln (TMLN *lp); 132 t_stat tmxr_set_lnorder (UNIT *uptr, int32 val, char *cptr, void *desc); 133 t_stat tmxr_show_lnorder (FILE *st, UNIT *uptr, int32 val, void *desc); 134 t_stat tmxr_show_summ (FILE *st, UNIT *uptr, int32 val, void *desc); 135 t_stat tmxr_show_cstat (FILE *st, UNIT *uptr, int32 val, void *desc); 136 t_stat tmxr_show_lines (FILE *st, UNIT *uptr, int32 val, void *desc); 137 TMLN *tmxr_find_ldsc (UNIT *uptr, int32 val, TMXR *mp); 138 int32 tmxr_send_buffered_data (TMLN *lp); 139 void tmxr_init_line (TMLN *lp); 140 void tmxr_report_connection (TMXR *mp, TMLN *lp, int32 line); 141 void tmxr_disconnect_line (TMLN *lp); 142 143 /* Extension interface */ 144 145 extern int32 (*tmxr_read) (TMLN *lp, int32 length); 146 extern int32 (*tmxr_write) (TMLN *lp, int32 length); 147 extern void (*tmxr_show) (TMLN *lp, FILE *stream); 148 extern void (*tmxr_close) (TMLN *lp); 149 extern t_bool (*tmxr_is_extended) (TMLN *lp); 150 151 /* V4.X shims */ 152 153 #define tmxr_set_console_units(rxuptr, txuptr) 154 155 #endif 156 157