/* $NetBSD: hpibvar.h,v 1.24 2021/07/09 17:05:33 tsutsui Exp $ */
/*-
* Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Copyright (c) 1982, 1990, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)hpibvar.h 8.1 (Berkeley) 6/10/93
*/
#define HPIB_IPL(x) ((((x) >> 4) & 0x3) + 3)
#define HPIBA 32
#define HPIBB 1
#define HPIBC 8
#define HPIBA_BA 21
#define HPIBC_BA 30
#define HPIBA_IPL 3
#define CSA_BA 0x1F
#define IDS_WDMA 0x04
#define IDS_WRITE 0x08
#define IDS_IR 0x40
#define IDS_IE 0x80
#define IDS_DMA(x) (1 << (x))
#define C_SDC 0x04 /* Selected device clear */
#define C_SDC_P 0x04 /* with odd parity */
#define C_DCL 0x14 /* Universal device clear */
#define C_DCL_P 0x94 /* with odd parity */
#define C_LAG 0x20 /* Listener address group commands */
#define C_UNL 0x3f /* Universal unlisten */
#define C_UNL_P 0xbf /* with odd parity */
#define C_TAG 0x40 /* Talker address group commands */
#define C_UNA 0x5e /* Unaddress (master talk address?) */
#define C_UNA_P 0x5e /* with odd parity */
#define C_UNT 0x5f /* Universal untalk */
#define C_UNT_P 0xdf /* with odd parity */
#define C_SCG 0x60 /* Secondary group commands */
/*
* Description structure for CS/80 devices.
*/
struct cs80_describe {
u_int d_iuw:16, /* controller: installed unit word */
d_cmaxxfr:16, /* controller: max transfer rate (Kb) */
d_ctype:8, /* controller: controller type */
d_utype:8, /* unit: unit type */
d_name:24, /* unit: name (6 BCD digits) */
d_sectsize:16, /* unit: # of bytes per block (sector) */
d_blkbuf:8, /* unit: # of blocks which can be buffered */
d_burstsize:8, /* unit: recommended burst size */
d_blocktime:16, /* unit: block time (u-sec) */
d_uavexfr:16, /* unit: average transfer rate (Kb) */
d_retry:16, /* unit: optimal retry time (1/100-sec) */
d_access:16, /* unit: access time param (1/100-sec) */
d_maxint:8, /* unit: maximum interleave */
d_fvbyte:8, /* unit: fixed volume byte */
d_rvbyte:8, /* unit: removable volume byte */
d_maxcyl:24, /* volume: maximum cylinder */
d_maxhead:8, /* volume: maximum head */
d_maxsect:16, /* volume: maximum sector on track */
d_maxvsecth:16, /* volume: maximum sector on volume (MSW) */
d_maxvsectl:32, /* volume: maximum sector on volume (LSWs) */
d_interleave:8; /* volume: current interleave */
} __attribute__((__packed__));
#ifdef _KERNEL
#include <sys/queue.h>
struct hpibbus_softc;
/*
* Each of the HP-IB controller drivers fills in this structure, which
* is used by the indirect driver to call controller-specific functions.
*/
struct hpib_controller {
void (*hpib_reset)(struct hpibbus_softc *);
int (*hpib_send)(struct hpibbus_softc *,
int, int, void *, int);
int (*hpib_recv)(struct hpibbus_softc *,
int, int, void *, int);
int (*hpib_ppoll)(struct hpibbus_softc *);
void (*hpib_ppwatch)(void *);
void (*hpib_go)(struct hpibbus_softc *,
int, int, void *, int, int, int);
void (*hpib_done)(struct hpibbus_softc *);
int (*hpib_intr)(void *);
};
/*
* Attach an HP-IB bus to an HP-IB controller.
*/
struct hpibdev_attach_args {
struct hpib_controller *ha_ops; /* controller ops vector */
int ha_type; /* XXX */
int ha_ba;
struct hpibbus_softc **ha_softcpp; /* XXX */
};
/*
* Attach an HP-IB device to an HP-IB bus.
*/
struct hpibbus_attach_args {
uint16_t ha_id; /* device id */
int ha_slave; /* HP-IB bus slave */
int ha_punit; /* physical unit on slave */
};
/* Locator short-hand */
#include "locators.h"
#define hpibbuscf_slave cf_loc[HPIBBUSCF_SLAVE]
#define hpibbuscf_punit cf_loc[HPIBBUSCF_PUNIT]
#define HPIB_NSLAVES 8 /* number of slaves on a bus */
#define HPIB_NPUNITS 15 /* number of punits per slave */
/*
* An HP-IB job queue entry. Slave drivers have one of these used
* to queue requests with the controller.
*/
struct hpibqueue {
TAILQ_ENTRY(hpibqueue) hq_list; /* entry on queue */
void *hq_softc; /* slave's softc */
int hq_slave; /* slave on bus */
/*
* Callbacks used to start and stop the slave driver.
*/
void (*hq_start)(void *);
void (*hq_go)(void *);
void (*hq_intr)(void *);
};
struct dmaqueue;
/*
* Software state per HP-IB bus.
*/
struct hpibbus_softc {
device_t sc_dev; /* generic device glue */
struct hpib_controller *sc_ops; /* controller ops vector */
volatile int sc_flags; /* misc flags */
struct dmaqueue *sc_dq;
TAILQ_HEAD(, hpibqueue) sc_queue;
int sc_ba;
int sc_type;
char *sc_addr;
int sc_count;
int sc_curcnt;
};
/* sc_flags */
#define HPIBF_IO 0x1
#define HPIBF_DONE 0x2
#define HPIBF_PPOLL 0x4
#define HPIBF_READ 0x8
#define HPIBF_TIMO 0x10
#define HPIBF_DMA16 0x8000
extern void *internalhpib;
extern int hpibtimeout;
extern int hpibdmathresh;
void hpibreset(int);
int hpibsend(int, int, int, void *, int);
int hpibrecv(int, int, int, void *, int);
int hpibustart(int);
void hpibgo(int, int, int, void *, int, int, int);
int hpibpptest(int, int);
void hpibppclear(int);
void hpibawait(int);
int hpibswait(int, int);
int hpibid(int, int);
int hpibreq(device_t, struct hpibqueue *);
void hpibfree(device_t, struct hpibqueue *);
int hpibintr(void *);
int hpibdevprint(void *, const char *);
#endif