1 /* sim_tape.h: simulator tape support library definitions 2 3 Copyright (c) 1993-2008 Robert M Supnik 4 Copyright (c) 2021 The DPS8M Development Team 5 6 Permission is hereby granted, free of charge, to any person obtaining a 7 copy of this software and associated documentation files (the "Software"), 8 to deal in the Software without restriction, including without limitation 9 the rights to use, copy, modify, merge, publish, distribute, sublicense, 10 and/or sell copies of the Software, and to permit persons to whom the 11 Software is furnished to do so, subject to the following conditions: 12 13 The above copyright notice and this permission notice shall be included in 14 all copies or substantial portions of the Software. 15 16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 ROBERT M SUPNIK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 20 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 22 23 Except as contained in this notice, the name of Robert M Supnik shall not be 24 used in advertising or otherwise to promote the sale, use or other dealings 25 in this Software without prior written authorization from Robert M Supnik. 26 */ 27 28 #ifndef SIM_TAPE_H_ 29 # define SIM_TAPE_H_ 0 30 31 /* SIMH/E11 tape format */ 32 33 typedef uint32 t_mtrlnt; /* magtape rec lnt */ 34 35 # define MTR_TMK 0x00000000 /* tape mark */ 36 # define MTR_EOM 0xFFFFFFFF /* end of medium */ 37 # define MTR_GAP 0xFFFFFFFE /* primary gap */ 38 # define MTR_RRGAP 0xFFFFFFFF /* reverse read half gap */ 39 # define MTR_FHGAP 0xFFFEFFFF /* fwd half gap (overwrite) */ 40 # define MTR_RHGAP 0xFFFF0000 /* rev half gap (overwrite) */ 41 # define MTR_M_RHGAP (~0x000080FF) /* range mask for rev gap */ 42 # define MTR_MAXLEN 0x00FFFFFF /* max len is 24b */ 43 # define MTR_ERF 0x80000000 /* error flag */ 44 # define MTR_F(x) ((x) & MTR_ERF) /* record error flg */ 45 # define MTR_L(x) ((x) & ~MTR_ERF) /* record length */ 46 47 /* TPC tape format */ 48 49 typedef uint16 t_tpclnt; /* magtape rec lnt */ 50 51 /* P7B tape format */ 52 53 # define P7B_SOR 0x80 /* start of record */ 54 # define P7B_PAR 0x40 /* parity */ 55 # define P7B_DATA 0x3F /* data */ 56 # define P7B_DPAR (P7B_PAR|P7B_DATA) /* data and parity */ 57 # define P7B_EOF 0x0F /* eof character */ 58 59 # define TPC_TMK 0x0000 /* tape mark */ 60 61 /* Unit flags */ 62 63 # define MTUF_V_PNU (UNIT_V_UF + 0) /* position not upd */ 64 # define MTUF_V_WLK (UNIT_V_UF + 1) /* write locked */ 65 # define MTUF_V_FMT (UNIT_V_UF + 2) /* tape file format */ 66 # define MTUF_W_FMT 3 /* 3b of formats */ 67 # define MTUF_N_FMT (1u << MTUF_W_FMT) /* number of formats */ 68 # define MTUF_M_FMT ((1u << MTUF_W_FMT) - 1) 69 # define MTUF_F_STD 0 /* SIMH format */ 70 # define MTUF_F_E11 1 /* E11 format */ 71 # define MTUF_F_TPC 2 /* TPC format */ 72 # define MTUF_F_P7B 3 /* P7B format */ 73 # define MUTF_F_TDF 4 /* TDF format */ 74 # define MTUF_V_UF (MTUF_V_FMT + MTUF_W_FMT) 75 # define MTUF_PNU (1u << MTUF_V_PNU) 76 # define MTUF_WLK (1u << MTUF_V_WLK) 77 # define MTUF_FMT (MTUF_M_FMT << MTUF_V_FMT) 78 # define MTUF_WRP (MTUF_WLK | UNIT_RO) 79 80 # define MT_F_STD (MTUF_F_STD << MTUF_V_FMT) 81 # define MT_F_E11 (MTUF_F_E11 << MTUF_V_FMT) 82 # define MT_F_TPC (MTUF_F_TPC << MTUF_V_FMT) 83 # define MT_F_P7B (MTUF_F_P7B << MTUF_V_FMT) 84 # define MT_F_TDF (MTUF_F_TDF << MTUF_V_FMT) 85 86 # define MT_SET_PNU(u) (u)->flags = (u)->flags | MTUF_PNU 87 # define MT_CLR_PNU(u) (u)->flags = (u)->flags & ~MTUF_PNU 88 # define MT_TST_PNU(u) ((u)->flags & MTUF_PNU) 89 # define MT_GET_FMT(u) (((u)->flags >> MTUF_V_FMT) & MTUF_M_FMT) 90 91 /* sim_tape_position Position Flags */ 92 # define MTPOS_V_REW 3 93 # define MTPOS_M_REW (1u << MTPOS_V_REW) /* Rewind First */ 94 # define MTPOS_V_REV 2 95 # define MTPOS_M_REV (1u << MTPOS_V_REV) /* Reverse Direction */ 96 # define MTPOS_V_OBJ 1 97 # define MTPOS_M_OBJ (1u << MTPOS_V_OBJ) /* Objects vs Records/Files */ 98 # define MTPOS_V_DLE 4 99 # define MTPOS_M_DLE (1u << MTPOS_V_DLE) /* Detect LEOT */ 100 101 /* Tape density values */ 102 103 # define MT_DENS_NONE 0 /* density not set */ 104 # define MT_DENS_200 1 /* 200 bpi NRZI */ 105 # define MT_DENS_556 2 /* 556 bpi NRZI */ 106 # define MT_DENS_800 3 /* 800 bpi NRZI */ 107 # define MT_DENS_1600 4 /* 1600 bpi PE */ 108 # define MT_DENS_6250 5 /* 6250 bpi GCR */ 109 110 # define MTVF_DENS_MASK (((1u << UNIT_S_DF_TAPE) - 1) << UNIT_V_DF_TAPE) 111 # define MT_DENS(f) (((f) & MTVF_DENS_MASK) >> UNIT_V_DF_TAPE) 112 113 # define MT_NONE_VALID (1u << MT_DENS_NONE) /* density not set is valid */ 114 # define MT_200_VALID (1u << MT_DENS_200) /* 200 bpi is valid */ 115 # define MT_556_VALID (1u << MT_DENS_556) /* 556 bpi is valid */ 116 # define MT_800_VALID (1u << MT_DENS_800) /* 800 bpi is valid */ 117 # define MT_1600_VALID (1u << MT_DENS_1600) /* 1600 bpi is valid */ 118 # define MT_6250_VALID (1u << MT_DENS_6250) /* 6250 bpi is valid */ 119 120 /* Return status codes */ 121 122 # define MTSE_OK 0 /* no error */ 123 # define MTSE_TMK 1 /* tape mark */ 124 # define MTSE_UNATT 2 /* unattached */ 125 # define MTSE_IOERR 3 /* IO error */ 126 # define MTSE_INVRL 4 /* invalid rec lnt */ 127 # define MTSE_FMT 5 /* invalid format */ 128 # define MTSE_BOT 6 /* beginning of tape */ 129 # define MTSE_EOM 7 /* end of medium */ 130 # define MTSE_RECE 8 /* error in record */ 131 # define MTSE_WRP 9 /* write protected */ 132 # define MTSE_LEOT 10 /* Logical End Of Tape */ 133 # define MTSE_RUNAWAY 11 /* tape runaway */ 134 135 typedef void (*TAPE_PCALLBACK)(UNIT *unit, t_stat status); 136 137 /* Tape Internal Debug flags */ 138 139 # define MTSE_DBG_DAT 0x0400000 /* Debug Data */ 140 # define MTSE_DBG_POS 0x0800000 /* Debug Positioning activities */ 141 # define MTSE_DBG_STR 0x1000000 /* Debug Tape Structure */ 142 143 /* Prototypes */ 144 145 t_stat sim_tape_attach_ex (UNIT *uptr, const char *cptr, uint32 dbit, int completion_delay); 146 t_stat sim_tape_attach (UNIT *uptr, CONST char *cptr); 147 t_stat sim_tape_detach (UNIT *uptr); 148 t_stat sim_tape_attach_help(FILE *st, DEVICE *dptr, const UNIT *uptr, int32 flag, const char *cptr); 149 t_stat sim_tape_rdrecf (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max); 150 t_stat sim_tape_rdrecf_a (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max, TAPE_PCALLBACK callback); 151 t_stat sim_tape_rdrecr (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max); 152 t_stat sim_tape_rdrecr_a (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max, TAPE_PCALLBACK callback); 153 t_stat sim_tape_wrrecf (UNIT *uptr, uint8 *buf, t_mtrlnt bc); 154 t_stat sim_tape_wrrecf_a (UNIT *uptr, uint8 *buf, t_mtrlnt bc, TAPE_PCALLBACK callback); 155 t_stat sim_tape_wrtmk (UNIT *uptr); 156 t_stat sim_tape_wrtmk_a (UNIT *uptr, TAPE_PCALLBACK callback); 157 t_stat sim_tape_wreom (UNIT *uptr); 158 t_stat sim_tape_wreom_a (UNIT *uptr, TAPE_PCALLBACK callback); 159 t_stat sim_tape_wreomrw (UNIT *uptr); 160 t_stat sim_tape_wreomrw_a (UNIT *uptr, TAPE_PCALLBACK callback); 161 t_stat sim_tape_wrgap (UNIT *uptr, uint32 gaplen); 162 t_stat sim_tape_wrgap_a (UNIT *uptr, uint32 gaplen, TAPE_PCALLBACK callback); 163 t_stat sim_tape_sprecf (UNIT *uptr, t_mtrlnt *bc); 164 t_stat sim_tape_sprecf_a (UNIT *uptr, t_mtrlnt *bc, TAPE_PCALLBACK callback); 165 t_stat sim_tape_sprecsf (UNIT *uptr, uint32 count, uint32 *skipped); 166 t_stat sim_tape_sprecsf_a (UNIT *uptr, uint32 count, uint32 *skipped, TAPE_PCALLBACK callback); 167 t_stat sim_tape_spfilef (UNIT *uptr, uint32 count, uint32 *skipped); 168 t_stat sim_tape_spfilef_a (UNIT *uptr, uint32 count, uint32 *skipped, TAPE_PCALLBACK callback); 169 t_stat sim_tape_spfilebyrecf (UNIT *uptr, uint32 count, uint32 *skipped, uint32 *recsskipped, t_bool check_leot); 170 t_stat sim_tape_spfilebyrecf_a (UNIT *uptr, uint32 count, uint32 *skipped, uint32 *recsskipped, t_bool check_leot, TAPE_PCALLBACK callback); 171 t_stat sim_tape_sprecr (UNIT *uptr, t_mtrlnt *bc); 172 t_stat sim_tape_sprecr_a (UNIT *uptr, t_mtrlnt *bc, TAPE_PCALLBACK callback); 173 t_stat sim_tape_sprecsr (UNIT *uptr, uint32 count, uint32 *skipped); 174 t_stat sim_tape_sprecsr_a (UNIT *uptr, uint32 count, uint32 *skipped, TAPE_PCALLBACK callback); 175 t_stat sim_tape_spfiler (UNIT *uptr, uint32 count, uint32 *skipped); 176 t_stat sim_tape_spfiler_a (UNIT *uptr, uint32 count, uint32 *skipped, TAPE_PCALLBACK callback); 177 t_stat sim_tape_spfilebyrecr (UNIT *uptr, uint32 count, uint32 *skipped, uint32 *recsskipped); 178 t_stat sim_tape_spfilebyrecr_a (UNIT *uptr, uint32 count, uint32 *skipped, uint32 *recsskipped, TAPE_PCALLBACK callback); 179 t_stat sim_tape_rewind (UNIT *uptr); 180 t_stat sim_tape_rewind_a (UNIT *uptr, TAPE_PCALLBACK callback); 181 t_stat sim_tape_position (UNIT *uptr, uint32 flags, uint32 recs, uint32 *recskipped, uint32 files, uint32 *fileskipped, uint32 *objectsskipped); 182 t_stat sim_tape_position_a (UNIT *uptr, uint32 flags, uint32 recs, uint32 *recsskipped, uint32 files, uint32 *filesskipped, uint32 *objectsskipped, TAPE_PCALLBACK callback); 183 t_stat sim_tape_reset (UNIT *uptr); 184 t_bool sim_tape_bot (UNIT *uptr); 185 t_bool sim_tape_wrp (UNIT *uptr); 186 t_bool sim_tape_eot (UNIT *uptr); 187 t_stat sim_tape_set_fmt (UNIT *uptr, int32 val, CONST char *cptr, void *desc); 188 t_stat sim_tape_show_fmt (FILE *st, UNIT *uptr, int32 val, CONST void *desc); 189 t_stat sim_tape_set_capac (UNIT *uptr, int32 val, CONST char *cptr, void *desc); 190 t_stat sim_tape_show_capac (FILE *st, UNIT *uptr, int32 val, CONST void *desc); 191 t_stat sim_tape_set_dens (UNIT *uptr, int32 val, CONST char *cptr, void *desc); 192 t_stat sim_tape_show_dens (FILE *st, UNIT *uptr, int32 val, CONST void *desc); 193 194 #endif 195