/*
 *   libdi - CD Audio Player Device Interface Library
 *
 *   Copyright (C) 1993-1996  Ti Kan
 *   E-mail: ti@amb.org
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free
 *   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 *   FreeBSD/NetBSD support
 *
 *   Contributing author: Gennady B. Sorokopud
 *   E-Mail: gena@netvision.net.il
 *
 *   This software fragment contains code that interfaces the CD player
 *   application to the FreeBSD (version 2.0.5 or later) and NetBSD
 *   (version 1.0A or later) operating systems.
 *
 *   Generic SCSI-support is required in the kernel configuration file.
 *   Also be sure "SCIOCCOMMAND" in the file "/usr/include/sys/scsiio.h"
 *   is not just a dummy.
 */
#ifndef LINT
static char *_os_fnbsd_c_ident_ = "@(#)os_fnbsd.c	6.16 96/01/07";
#endif

#include "common_d/appenv.h"
#include "common_d/util.h"
#include "libdi_d/libdi.h"
#include "libdi_d/scsipt.h"

#if (defined(__FreeBSD__) || defined(__NetBSD__)) && \
    defined(DI_SCSIPT) && !defined(DEMO_ONLY)

extern appdata_t	app_data;
extern bool_t		scsipt_notrom_error;
extern FILE		*errfp;
extern di_client_t	*di_clinfo;

STATIC int		pthru_fd = -1;	/* Passthrough device file desc */


/*
 * pthru_send
 *	Build SCSI CDB and send command to the device.
 *
 * Args:
 *	opcode - SCSI command opcode
 *	addr - The "address" portion of the SCSI CDB
 *	buf - Pointer to data buffer
 *	size - Number of bytes to transfer
 *	rsvd - The "reserved" portion of the SCSI CDB
 *	length - The "length" portion of the SCSI CDB
 *	param - The "param" portion of the SCSI CDB
 *	control - The "control" portion of the SCSI CDB
 *	rw - Data transfer direction flag (READ_OP or WRITE_OP)
 *	prnerr - Whether an error message should be displayed
 *		 when a command fails
 *
 * Return:
 *	TRUE - command completed successfully
 *	FALSE - command failed
 */
bool_t
pthru_send(
	byte_t		opcode,
	word32_t	addr,
	byte_t		*buf,
	word32_t	size,
	byte_t		rsvd,
	word32_t	length,
	byte_t		param,
	byte_t		control,
	byte_t		rw,
	bool_t		prnerr
)
{
	static struct scsireq	ucmd;
	
	if (pthru_fd < 0 || scsipt_notrom_error)
		return FALSE;

	memset(&ucmd, 0, sizeof(ucmd));

	/* set up SCSI CDB */
	switch (opcode & 0xf0) {
	case 0xa0:
	case 0xe0:
		/* 12-byte commands */
		ucmd.cmd[0] = opcode;
		ucmd.cmd[1] = param;
		ucmd.cmd[2] = (addr >> 24) & 0xff;
		ucmd.cmd[3] = (addr >> 16) & 0xff;
		ucmd.cmd[4] = (addr >> 8) & 0xff;
		ucmd.cmd[5] = (addr & 0xff);
		ucmd.cmd[6] = (length >> 24) & 0xff;
		ucmd.cmd[7] = (length >> 16) & 0xff;
		ucmd.cmd[8] = (length >> 8) & 0xff;
		ucmd.cmd[9] = length & 0xff;
		ucmd.cmd[10] = rsvd;
		ucmd.cmd[11] = control;

		ucmd.cmdlen = 12;
		break;

	case 0xc0:
	case 0xd0:
	case 0x20:
	case 0x30:
	case 0x40:
		/* 10-byte commands */
		ucmd.cmd[0] = opcode;
		ucmd.cmd[1] = param;
		ucmd.cmd[2] = (addr >> 24) & 0xff;
		ucmd.cmd[3] = (addr >> 16) & 0xff;
		ucmd.cmd[4] = (addr >> 8) & 0xff;
		ucmd.cmd[5] = addr & 0xff;
		ucmd.cmd[6] = rsvd;
		ucmd.cmd[7] = (length >> 8) & 0xff;
		ucmd.cmd[8] = length & 0xff;
		ucmd.cmd[9] = control;

		ucmd.cmdlen = 10;
		break;

	case 0x00:
	case 0x10:
		/* 6-byte commands */
		ucmd.cmd[0] = opcode;
		ucmd.cmd[1] = param;
		ucmd.cmd[2] = (addr >> 8) & 0xff;
		ucmd.cmd[3] = addr & 0xff;
		ucmd.cmd[4] = length & 0xff;
		ucmd.cmd[5] = control;

		ucmd.cmdlen = 6;
		break;

	default:
		if (app_data.scsierr_msg && prnerr)
			fprintf(errfp, "0x%02x: Unknown SCSI opcode\n",
				opcode);
		return FALSE;
	}

	DBGDUMP("SCSI CDB bytes", ucmd.cmd, ucmd.cmdlen);
		
	/* set up uscsi_cmd */
	ucmd.databuf = (caddr_t) buf; /* data buffer */
	ucmd.datalen = size;	/* buffer length */
	ucmd.timeout = 10000;	/* 10 secs timeout */

	if (size != 0)
		ucmd.flags |= (rw == READ_OP) ? SCCMD_READ : SCCMD_WRITE;

	/* Send the command down via the "pass-through" interface */
	if (ioctl(pthru_fd, SCIOCCOMMAND, &ucmd) < 0) {
		if (app_data.scsierr_msg && prnerr)
			perror("SCIOCCOMMAND ioctl failed");
		return FALSE;
	}

	if (ucmd.retsts != SCCMD_OK) {
		if (app_data.scsierr_msg && prnerr) {
			fprintf(errfp,
				"CD audio: %s %s:\n%s=0x%x %s=0x%x\n",
				"SCSI command fault on",
				app_data.device,
				"Opcode",
				opcode,
				"Status",
				ucmd.retsts);
		}

		return FALSE;
	}

	return TRUE;
}


/*
 * pthru_open
 *	Open SCSI pass-through device
 *
 * Args:
 *	path - device path name string
 *
 * Return:
 *	TRUE - open successful
 *	FALSE - open failed
 */
bool_t
pthru_open(char *path)
{
	struct stat	stbuf;
	char		errstr[ERR_BUF_SZ];

	/* Check for validity of device node */
	if (stat(path, &stbuf) < 0) {
		sprintf(errstr, app_data.str_staterr, path);
		DI_FATAL(errstr);
		return FALSE;
	}
	if (!S_ISCHR(stbuf.st_mode)) {
		sprintf(errstr, app_data.str_noderr, path);
		DI_FATAL(errstr);
		return FALSE;
	}

	if ((pthru_fd = open(path, O_RDWR)) < 0) {
		DBGPRN(errfp, "Cannot open %s: errno=%d\n", path, errno);
		return FALSE;
	}

	return TRUE;
}


/*
 * pthru_close
 *	Close SCSI pass-through device
 *
 * Args:
 *	Nothing.
 *
 * Return:
 *	Nothing.
 */
void
pthru_close(void)
{
	if (pthru_fd >= 0) {
		close(pthru_fd);
		pthru_fd = -1;
	}
}


/*
 * pthru_vers
 *	Return OS Interface Module version string
 *
 * Args:
 *	Nothing.
 *
 * Return:
 *	Module version text string.
 */
char *
pthru_vers(void)
{
#ifdef __FreeBSD__
	return ("OS Interface module for FreeBSD\n");
#else
#ifdef __NetBSD__
	return ("OS Interface module for NetBSD\n");
#else
	return ("OS Interface module (unsupported BSD variant!)\n");
#endif	/* __NetBSD__ */
#endif	/* __FreeBSD__ */
}

#endif	/* __FreeBSD__ __NetBSD__ DI_SCSIPT DEMO_ONLY */

