/* kx10_pt.c: PDP-10 paper tape reader/punch simulator

   Copyright (c) 2011-2020, Richard Cornwell

   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
   RICHARD CORNWELL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
   IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

   Except as contained in this notice, the name of Richard Cornwell shall not be
   used in advertising or otherwise to promote the sale, use or other dealings
   in this Software without prior written authorization from Richard Cornwell.
*/

#include "kx10_defs.h"

#ifndef NUM_DEVS_PT
#define NUM_DEVS_PT 0
#endif

#if (NUM_DEVS_PT > 0)

#if KL
#define PT_DIS  DEV_DIS
#endif

#ifndef PT_DIS
#define PT_DIS 0
#endif

#define PP_DEVNUM 0100
#define PR_DEVNUM 0104
#define STATUS   u3
#define CHR      u4
#define CHL      u5

#define PI_DONE     000007
#define DONE_FLG    000010
#define BUSY_FLG    000020
#define BIN_FLG     000040
#define NO_TAPE_PP  000100
#if PDP6
#define TAPE_PR     000000
#else
#define TAPE_PR     000400
#endif


t_stat         ptp_devio(uint32 dev, uint64 *data);
t_stat         ptp_svc (UNIT *uptr);
t_stat         ptp_reset (DEVICE *dptr);
t_stat         ptp_attach (UNIT *uptr, CONST char *cptr);
t_stat         ptp_detach (UNIT *uptr);
t_stat         ptp_help (FILE *st, DEVICE *dptr, UNIT *uptr,
                            int32 flag, const char *cptr);
const char    *ptp_description (DEVICE *dptr);

t_stat         ptr_devio(uint32 dev, uint64 *data);
t_stat         ptr_svc (UNIT *uptr);
t_stat         ptr_boot(int32 unit_num, DEVICE * dptr);
t_stat         ptr_reset (DEVICE *dptr);
t_stat         ptr_attach (UNIT *uptr, CONST char *cptr);
t_stat         ptr_detach (UNIT *uptr);
t_stat         ptr_help (FILE *st, DEVICE *dptr, UNIT *uptr,
                             int32 flag, const char *cptr);
const char    *ptr_description (DEVICE *dptr);


DIB ptp_dib = { PP_DEVNUM, 1, &ptp_devio, NULL };

UNIT ptp_unit = {
    UDATA (&ptp_svc, UNIT_ATTABLE+UNIT_TEXT+UNIT_SEQ, 0), 10000
    };

REG ptp_reg[] = {
    { URDATA (STATUS, ptp_unit.STATUS, 8, 18, 0, 1, PV_LEFT) },
    { URDATA (TIME, ptp_unit.wait, 10, 24, 0, 1, PV_LEFT) },
    { NULL }
    };

MTAB ptp_mod[] = {
    { 0 }
    };

DEVICE ptp_dev = {
    "PTP", &ptp_unit, ptp_reg, ptp_mod,
    1, 10, 31, 1, 8, 8,
    NULL, NULL, &ptp_reset, NULL, &ptp_attach, &ptp_detach,
    &ptp_dib, DEV_DISABLE | DEV_DEBUG | PT_DIS, 0, dev_debug,
    NULL, NULL, &ptp_help, NULL, NULL, &ptp_description
    };

DIB ptr_dib = { PR_DEVNUM, 1, &ptr_devio, NULL };

UNIT ptr_unit = {
    UDATA (&ptr_svc, UNIT_ATTABLE+UNIT_TEXT, 0), 10000
    };

REG ptr_reg[] = {
    { URDATA (STATUS, ptr_unit.STATUS, 8, 18, 0, 1, PV_LEFT) },
    { URDATA (TIME, ptr_unit.wait, 10, 24, 0, 1, PV_LEFT) },
    { NULL }
    };

MTAB ptr_mod[] = {
    { 0 }
    };

DEVICE ptr_dev = {
    "PTR", &ptr_unit, ptr_reg, ptr_mod,
    1, 10, 31, 1, 8, 8,
    NULL, NULL, &ptr_reset, &ptr_boot, &ptr_attach, &ptr_detach,
    &ptr_dib, DEV_DISABLE | DEV_DEBUG | PT_DIS, 0, dev_debug,
    NULL, NULL, &ptr_help, NULL, NULL, &ptr_description
    };

/* IOT routine */

t_stat ptp_devio(uint32 dev, uint64 *data) {
    UNIT *uptr = &ptp_unit;
    switch(dev & 3) {
    case CONI:
         *data = uptr->STATUS;
#if WAITS
         /* The NXM stop switch is always off */
         if (cpu_unit[0].flags & UNIT_WAITS)
             *data |= 0200;
#endif
         sim_debug(DEBUG_CONI, &ptp_dev, "PP: CONI %012llo\n", *data);
         break;

    case CONO:
         clr_interrupt(dev);
         uptr->STATUS = (PI_DONE|DONE_FLG|BUSY_FLG|BIN_FLG) & *data;
         if ((uptr->flags & UNIT_ATT) == 0)
             uptr->STATUS |= NO_TAPE_PP;
         if (uptr->STATUS & BUSY_FLG) {
             uptr->CHR = 0;
             sim_activate (&ptp_unit, ptp_unit.wait);
         }
         if (uptr->STATUS & DONE_FLG)
             set_interrupt(dev, uptr->STATUS);
         sim_debug(DEBUG_CONO, &ptp_dev, "PP: CONO %012llo\n", *data);
         break;

    case DATAO:
         if ((uptr->STATUS & BUSY_FLG) == 0) {
             uptr->CHR = *data & 00377;
             if (uptr->STATUS & BIN_FLG) {
                uptr->CHR &= 077;
                uptr->CHR |= 0200;
             }
             uptr->STATUS |= BUSY_FLG;
             uptr->STATUS &= ~DONE_FLG;
             clr_interrupt(dev);
             sim_activate (&ptp_unit, ptp_unit.wait);
         }
         sim_debug(DEBUG_DATAIO, &ptp_dev, "PP: DATAO %012llo\n", *data);
         break;
    case DATAI:
         *data = 0;
         break;
    }
    return SCPE_OK;
}


/* Unit service */
t_stat ptp_svc (UNIT *uptr)
{
    uptr->STATUS &= ~BUSY_FLG;
    uptr->STATUS |= DONE_FLG;
    set_interrupt(PP_DEVNUM, uptr->STATUS & 7);

    if ((uptr->flags & UNIT_ATT) == 0) {
        uptr->STATUS |= NO_TAPE_PP;
        return SCPE_OK;
    }
    fputc (uptr->CHR, uptr->fileref);                       /* print char */
    uptr->pos = ftell (uptr->fileref);
    if (ferror (uptr->fileref)) {                           /* error? */
        perror ("PTP I/O error");
        clearerr (uptr->fileref);
        return SCPE_IOERR;
    }
    return SCPE_OK;
}

/* Reset routine */

t_stat ptp_reset (DEVICE *dptr)
{
    UNIT *uptr = &ptp_unit;
    uptr->CHR = 0;
    uptr->CHL = 0;
    uptr->STATUS = 0;
    clr_interrupt(PP_DEVNUM);
    sim_cancel (&ptp_unit);                                 /* deactivate unit */
    return SCPE_OK;
}

/* Attach routine */

t_stat ptp_attach (UNIT *uptr, CONST char *cptr)
{
    t_stat reason;

    sim_switches |= SWMASK ('A');   /* Position to EOF */
    reason = attach_unit (uptr, cptr);
    uptr->STATUS &= ~NO_TAPE_PP;
    return reason;
}

/* Detach routine */

t_stat ptp_detach (UNIT *uptr)
{
    uptr->STATUS |= NO_TAPE_PP;
    return detach_unit (uptr);
}



t_stat ptr_devio(uint32 dev, uint64 *data) {
    UNIT *uptr = &ptr_unit;
    switch(dev & 3) {
    case CONI:
         *data = uptr->STATUS;
         sim_debug(DEBUG_CONI, &ptr_dev, "PT: CONI %012llo\n", *data);
         break;

    case CONO:
         clr_interrupt(dev);
         uptr->STATUS = (PI_DONE|DONE_FLG|BUSY_FLG|BIN_FLG) & *data;
         if ((uptr->flags & UNIT_ATT))
             uptr->STATUS |= TAPE_PR;
         if (uptr->STATUS & BUSY_FLG) {
             uptr->CHR = 0;
             uptr->CHL = 0;
             sim_activate (&ptr_unit, ptr_unit.wait);
         }
         if (uptr->STATUS & DONE_FLG)
             set_interrupt(dev, uptr->STATUS);
         sim_debug(DEBUG_CONO, &ptr_dev, "PT: CONO %012llo\n", *data);
         break;

    case DATAI:
         if ((uptr->STATUS & DONE_FLG)) {
             *data = ((uint64)uptr->CHL) << 18;
             *data |= ((uint64)uptr->CHR);
             uptr->STATUS &= ~DONE_FLG;
             clr_interrupt(dev);
             sim_activate (&ptr_unit, ptr_unit.wait);
         }
             uptr->STATUS |= BUSY_FLG;
         sim_debug(DEBUG_DATAIO, &ptr_dev, "PT: DATAI %012llo\n", *data);
         break;
    case DATAO:
         break;
    }
    return SCPE_OK;
}

/* Unit service */
t_stat ptr_svc (UNIT *uptr)
{
    int32     temp;
    uint64    word;
    int       count = (uptr->STATUS & BIN_FLG) ? 6 : 1;

    uptr->STATUS &= ~BUSY_FLG;
    uptr->STATUS |= DONE_FLG;
    set_interrupt(PR_DEVNUM, uptr->STATUS);

    if ((uptr->flags & UNIT_ATT) == 0)                   /* attached? */
        return SCPE_OK;
    word = 0;
    while (count > 0) {
        if ((temp = getc (uptr->fileref)) == EOF) {
           if (feof (uptr->fileref)) {
             uptr->STATUS &= ~TAPE_PR;
             break;
           }
        }
        if (uptr->STATUS & BIN_FLG) {
           if (temp & 0200) {
                word <<= 6;
                word |= (uint64)(temp & 077);
                count--;
           }
        } else {
           word |= (uint64)(temp);
           count--;
        }
    }
    uptr->CHL = (word >> 18) & RMASK;
    uptr->CHR = word & RMASK;
    return SCPE_OK;
}

uint64
ptr_read_word(UNIT *uptr) {
     int i, ch;
     uint64 word = 0;

     for(i = 0; i < 6;) {
        if ((ch = getc (uptr->fileref)) == EOF)
           return word;
        if (ch & 0200) {
            word <<= 6;
            word |= (uint64)(ch & 077);
            i++;
        }
     }
     return word;
}

/* Boot from given device */
t_stat
ptr_boot(int32 unit_num, DEVICE * dptr)
{
    UNIT               *uptr = &dptr->units[unit_num];
    uint64              word;
    int                 wc, addr;

    if ((uptr->flags & UNIT_ATT) == 0)
        return SCPE_UNATT;      /* attached? */

    word = ptr_read_word(uptr);
    wc = (word >> 18) & RMASK;
    addr = word & RMASK;
    while (wc != 0) {
        wc = (wc + 1) & RMASK;
        addr = (addr + 1) & RMASK;
        word = ptr_read_word(uptr);
        if (addr < 020)
           FM[addr] = word;
        else
           M[addr] = word;
    }
    if (addr < 020)
       FM[addr] = word;
    else
       M[addr] = word;
    uptr->STATUS = BUSY_FLG|BIN_FLG|TAPE_PR;
    uptr->CHR = 0;
    uptr->CHL = 0;
    sim_activate (&ptr_unit, ptr_unit.wait);
    PC = word & RMASK;
    return SCPE_OK;
}


/* Reset routine */

t_stat ptr_reset (DEVICE *dptr)
{
    UNIT *uptr = &ptr_unit;
    uptr->CHR = 0;
    uptr->CHL = 0;
    uptr->STATUS = 0;
    clr_interrupt(PR_DEVNUM);
    sim_cancel (&ptr_unit);                                 /* deactivate unit */
    return SCPE_OK;
}

/* Attach routine */

t_stat ptr_attach (UNIT *uptr, CONST char *cptr)
{
    t_stat reason;

    reason = attach_unit (uptr, cptr);
    uptr->STATUS |= TAPE_PR;
    return reason;
}

/* Detach routine */

t_stat ptr_detach (UNIT *uptr)
{
    uptr->STATUS &= ~TAPE_PR;
    return detach_unit (uptr);
}

t_stat ptr_help (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, const char *cptr)
{
fprintf (st, "Paper Tape Reader (PTR)\n\n");
fprintf (st, "The paper tape reader (PTR) reads data from a disk file.  The POS register\n");
fprintf (st, "specifies the number of the next data item to be read.  Thus, by changing\n");
fprintf (st, "POS, the user can backspace or advance the reader.\n");
fprint_set_help (st, dptr);
fprint_show_help (st, dptr);
fprint_reg_help (st, dptr);
return SCPE_OK;
}

const char *ptr_description (DEVICE *dptr)
{
return "paper tape reader";
}

t_stat ptp_help (FILE *st, DEVICE *dptr, UNIT *uptr, int32 flag, const char *cptr)
{
fprintf (st, "Paper Tape Punch (PTP)\n\n");
fprintf (st, "The paper tape punch (PTP) writes data to a disk file.  The POS register\n");
fprintf (st, "specifies the number of the next data item to be written.  Thus, by changing\n");
fprintf (st, "POS, the user can backspace or advance the punch.\n");
fprintf (st, "A new file can be created if you attach with the -N switch\n\n");
fprint_set_help (st, dptr);
fprint_show_help (st, dptr);
fprint_reg_help (st, dptr);
return SCPE_OK;
}

const char *ptp_description (DEVICE *dptr)
{
return "paper tape punch";
}
#endif