/* Card read/punch routines for 7000 simulators.

   Copyright (c) 2005, 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
   ROBERT M SUPNIK 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.

   This is the standard card reader.
   This is the standard card punch.

   Input formats are accepted in a variaty of formats:
	Standard ASCII: one record per line.
		returns are ignored.
		tabs are expanded to modules 8 characters.
		~ in first column is treated as a EOF.

	Binary Card format:
		Each record 160 characters.
		First character   21012345
				  111 
		Second characters 6789----
		Top 4 bits of second character are 0.
		It is unlikely that ascii text or BCD format
		text could produce similar profile.

	BCD Format:
		Each record variable length (80 chars or less).
		Record mark has bit 7 set.
		Bit 6 is even parity.
		Bits 5-0 are character.

	CBN Format:
		Each record 160 charaters.
		First char has bit 7 set. Rest set to 0.
		Bit 6 is odd parity.
		Bit 5-0 of first character are top 6 bits
			of card.
		Bit 5-0 of second character are lower 6 bits
			of card.

    For autodetection of BCD card format, there can be no parity errors.
    All undeterminate formats are treated as ASCII.

    Auto output format is ASCII if card has only printable characters
    or card format binary.
*/


/* Flags for punch and reader. */
#define UNIT_MODE	(7 << UNIT_V_MODE)
#define MODE_AUTO	(0 << UNIT_V_MODE)
#define MODE_BIN	(1 << UNIT_V_MODE)
#define MODE_TEXT	(2 << UNIT_V_MODE)
#define MODE_BCD	(3 << UNIT_V_MODE)
#define MODE_CBN	(4 << UNIT_V_MODE)
/* Allow lower case letters */
#define MODE_LOWER	(8 << UNIT_V_MODE)


/* Device status information stored in u5 */
#define URCSTA_EOF	0001	/* Hit end of file */
#define URCSTA_ERR	0002	/* Error reading record */

struct _card_data
{
    uint8               ptr;	/* Pointer in buffer */
    uint8		len;	/* Length of buffer */
    uint16		image[80];	/* Image */
    uint8               cbuff[160];	/* Read in buffer for cards */
};

/* Generic routines. */
t_stat	 read_card(UNIT * uptr);
t_stat	 punch_card(UNIT * uptr, UNIT *stkptr);
t_stat	 card_attach(UNIT * uptr, char *file);
t_stat   card_detach(UNIT *uptr);

/* Conversion routines to save code */
uint16	 bcd_to_hol(uint8 bcd);
uint16   ebcdic_to_hol(uint8 ebcdic);
uint8	 hol_to_bcd(uint16 hol);
uint8	 hol_to_ebbcd(uint16 hol);

/* Format control routines. */
t_stat card_set_fmt (UNIT *uptr, int32 val, char *cptr, void *desc);
t_stat card_show_fmt (FILE *st, UNIT *uptr, int32 val, void *desc);