| 1 | /* sim_tape.h: simulator tape support library definitions\r |
| 2 | \r |
| 3 | Copyright (c) 1993-2006, Robert M Supnik\r |
| 4 | \r |
| 5 | Permission is hereby granted, free of charge, to any person obtaining a\r |
| 6 | copy of this software and associated documentation files (the "Software"),\r |
| 7 | to deal in the Software without restriction, including without limitation\r |
| 8 | the rights to use, copy, modify, merge, publish, distribute, sublicense,\r |
| 9 | and/or sell copies of the Software, and to permit persons to whom the\r |
| 10 | Software is furnished to do so, subject to the following conditions:\r |
| 11 | \r |
| 12 | The above copyright notice and this permission notice shall be included in\r |
| 13 | all copies or substantial portions of the Software.\r |
| 14 | \r |
| 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r |
| 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r |
| 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL\r |
| 18 | ROBERT M SUPNIK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r |
| 19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r |
| 20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r |
| 21 | \r |
| 22 | Except as contained in this notice, the name of Robert M Supnik shall not be\r |
| 23 | used in advertising or otherwise to promote the sale, use or other dealings\r |
| 24 | in this Software without prior written authorization from Robert M Supnik.\r |
| 25 | \r |
| 26 | 30-Aug-06 JDB Added erase gap support\r |
| 27 | 14-Feb-06 RMS Added variable tape capacity\r |
| 28 | 17-Dec-05 RMS Added write support for Paul Pierce 7b format\r |
| 29 | 02-May-05 RMS Added support for Paul Pierce 7b format\r |
| 30 | */\r |
| 31 | \r |
| 32 | #ifndef _SIM_TAPE_H_\r |
| 33 | #define _SIM_TAPE_H_ 0\r |
| 34 | \r |
| 35 | /* SIMH/E11 tape format */\r |
| 36 | \r |
| 37 | typedef uint32 t_mtrlnt; /* magtape rec lnt */\r |
| 38 | \r |
| 39 | #define MTR_TMK 0x00000000 /* tape mark */\r |
| 40 | #define MTR_EOM 0xFFFFFFFF /* end of medium */\r |
| 41 | #define MTR_GAP 0xFFFFFFFE /* primary gap */\r |
| 42 | #define MTR_FHGAP 0xFFFEFFFF /* fwd half gap (overwrite) */\r |
| 43 | #define MTR_RHGAP 0xFFFF0000 /* rev half gap (overwrite) */\r |
| 44 | #define MTR_M_RHGAP (~0x000080FF) /* range mask for rev gap */\r |
| 45 | #define MTR_MAXLEN 0x00FFFFFF /* max len is 24b */\r |
| 46 | #define MTR_ERF 0x80000000 /* error flag */\r |
| 47 | #define MTR_F(x) ((x) & MTR_ERF) /* record error flg */\r |
| 48 | #define MTR_L(x) ((x) & ~MTR_ERF) /* record length */\r |
| 49 | \r |
| 50 | /* TPC tape format */\r |
| 51 | \r |
| 52 | typedef uint16 t_tpclnt; /* magtape rec lnt */\r |
| 53 | \r |
| 54 | /* P7B tape format */\r |
| 55 | \r |
| 56 | #define P7B_SOR 0x80 /* start of record */\r |
| 57 | #define P7B_PAR 0x40 /* parity */\r |
| 58 | #define P7B_DATA 0x3F /* data */\r |
| 59 | #define P7B_DPAR (P7B_PAR|P7B_DATA) /* data and parity */\r |
| 60 | #define P7B_EOF 0x0F /* eof character */\r |
| 61 | \r |
| 62 | #define TPC_TMK 0x0000 /* tape mark */\r |
| 63 | \r |
| 64 | /* Unit flags */\r |
| 65 | \r |
| 66 | #define MTUF_V_PNU (UNIT_V_UF + 0) /* position not upd */\r |
| 67 | #define MTUF_V_WLK (UNIT_V_UF + 1) /* write locked */\r |
| 68 | #define MTUF_V_FMT (UNIT_V_UF + 2) /* tape file format */\r |
| 69 | #define MTUF_W_FMT 3 /* 3b of formats */\r |
| 70 | #define MTUF_N_FMT (1u << MTUF_W_FMT) /* number of formats */\r |
| 71 | #define MTUF_M_FMT ((1u << MTUF_W_FMT) - 1)\r |
| 72 | #define MTUF_F_STD 0 /* SIMH format */\r |
| 73 | #define MTUF_F_E11 1 /* E11 format */\r |
| 74 | #define MTUF_F_TPC 2 /* TPC format */\r |
| 75 | #define MTUF_F_P7B 3 /* P7B format */\r |
| 76 | #define MUTF_F_TDF 4 /* TDF format */\r |
| 77 | #define MTUF_V_UF (MTUF_V_FMT + MTUF_W_FMT)\r |
| 78 | #define MTUF_PNU (1u << MTUF_V_PNU)\r |
| 79 | #define MTUF_WLK (1u << MTUF_V_WLK)\r |
| 80 | #define MTUF_FMT (MTUF_M_FMT << MTUF_V_FMT)\r |
| 81 | #define MTUF_WRP (MTUF_WLK | UNIT_RO)\r |
| 82 | \r |
| 83 | #define MT_F_STD (MTUF_F_STD << MTUF_V_FMT)\r |
| 84 | #define MT_F_E11 (MTUF_F_E11 << MTUF_V_FMT)\r |
| 85 | #define MT_F_TPC (MTUF_F_TPC << MTUF_V_FMT)\r |
| 86 | #define MT_F_P7B (MTUF_F_P7B << MTUF_V_FMT)\r |
| 87 | #define MT_F_TDF (MTUF_F_TDF << MTUF_V_FMT)\r |
| 88 | \r |
| 89 | #define MT_SET_PNU(u) (u)->flags = (u)->flags | MTUF_PNU\r |
| 90 | #define MT_CLR_PNU(u) (u)->flags = (u)->flags & ~MTUF_PNU\r |
| 91 | #define MT_TST_PNU(u) ((u)->flags & MTUF_PNU)\r |
| 92 | #define MT_GET_FMT(u) (((u)->flags >> MTUF_V_FMT) & MTUF_M_FMT)\r |
| 93 | \r |
| 94 | /* Return status codes */\r |
| 95 | \r |
| 96 | #define MTSE_OK 0 /* no error */\r |
| 97 | #define MTSE_TMK 1 /* tape mark */\r |
| 98 | #define MTSE_UNATT 2 /* unattached */\r |
| 99 | #define MTSE_IOERR 3 /* IO error */\r |
| 100 | #define MTSE_INVRL 4 /* invalid rec lnt */\r |
| 101 | #define MTSE_FMT 5 /* invalid format */\r |
| 102 | #define MTSE_BOT 6 /* beginning of tape */\r |
| 103 | #define MTSE_EOM 7 /* end of medium */\r |
| 104 | #define MTSE_RECE 8 /* error in record */\r |
| 105 | #define MTSE_WRP 9 /* write protected */\r |
| 106 | \r |
| 107 | /* Prototypes */\r |
| 108 | \r |
| 109 | t_stat sim_tape_attach (UNIT *uptr, char *cptr);\r |
| 110 | t_stat sim_tape_detach (UNIT *uptr);\r |
| 111 | t_stat sim_tape_rdrecf (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max);\r |
| 112 | t_stat sim_tape_rdrecr (UNIT *uptr, uint8 *buf, t_mtrlnt *bc, t_mtrlnt max);\r |
| 113 | t_stat sim_tape_wrrecf (UNIT *uptr, uint8 *buf, t_mtrlnt bc);\r |
| 114 | t_stat sim_tape_wrtmk (UNIT *uptr);\r |
| 115 | t_stat sim_tape_wreom (UNIT *uptr);\r |
| 116 | t_stat sim_tape_wrgap (UNIT *uptr, uint32 gaplen, uint32 bpi);\r |
| 117 | t_stat sim_tape_sprecf (UNIT *uptr, t_mtrlnt *bc);\r |
| 118 | t_stat sim_tape_sprecr (UNIT *uptr, t_mtrlnt *bc);\r |
| 119 | t_stat sim_tape_rewind (UNIT *uptr);\r |
| 120 | t_stat sim_tape_reset (UNIT *uptr);\r |
| 121 | t_bool sim_tape_bot (UNIT *uptr);\r |
| 122 | t_bool sim_tape_wrp (UNIT *uptr);\r |
| 123 | t_bool sim_tape_eot (UNIT *uptr);\r |
| 124 | t_stat sim_tape_set_fmt (UNIT *uptr, int32 val, char *cptr, void *desc);\r |
| 125 | t_stat sim_tape_show_fmt (FILE *st, UNIT *uptr, int32 val, void *desc);\r |
| 126 | t_stat sim_tape_set_capac (UNIT *uptr, int32 val, char *cptr, void *desc);\r |
| 127 | t_stat sim_tape_show_capac (FILE *st, UNIT *uptr, int32 val, void *desc);\r |
| 128 | \r |
| 129 | #endif\r |