/*	$NetBSD: vmereg.h,v 1.6 2005/11/16 00:49:03 uwe Exp $ */

/*-
 * Copyright (c) 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Paul Kranenburg.
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *        This product includes software developed by the NetBSD
 *        Foundation, Inc. and its contributors.
 * 4. Neither the name of The NetBSD Foundation 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 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.
 */

struct vmebusreg {
	volatile uint32_t	vmebus_cr;	/* VMEbus control register */
	volatile uint32_t	vmebus_afar;	/* VMEbus async fault address */
	volatile uint32_t	vmebus_afsr;	/* VMEbus async fault status */
};

/* VME bus Register offsets */
#define VMEBUS_CR_REG	0
#define VMEBUS_AFAR_REG	4
#define VMEBUS_AFSR_REG	8

/* VME Control Register bits */
#define VMEBUS_CR_C	0x80000000	/* I/O cache enable */
#define VMEBUS_CR_S	0x40000000	/* VME slave enable */
#define VMEBUS_CR_L	0x20000000	/* Loopback enable (diagnostic) */
#define VMEBUS_CR_R	0x10000000	/* VMEbus reset */
#define VMEBUS_CR_RSVD	0x0ffffff0	/* reserved */
#define VMEBUS_CR_IMPL	0x0000000f	/* VMEbus interface implementation */
#define VMEBUS_CR_BITS	"\177\020"	\
			"f\0\4IMPL\0b\34R\0b\35L\0b\36S\0b\37C\0"

/* VME Asynchronous Fault Status bits */
#define VMEBUS_AFSR_SZ	0xe0000000	/* Error transaction size */
#define    VMEBUS_AFSR_SZ4	0	/* 4 byte */
#define    VMEBUS_AFSR_SZ1	1	/* 1 byte */
#define    VMEBUS_AFSR_SZ2	2	/* 2 byte */
#define    VMEBUS_AFSR_SZ32	5	/* 32 byte */
#define VMEBUS_AFSR_TO	0x10000000	/* VME master access time-out */
#define VMEBUS_AFSR_BERR 0x08000000	/* VME master got BERR */
#define VMEBUS_AFSR_WB	0x04000000	/* IOC write-back error (if SZ == 32) */
					/* Non-IOC write error (id SZ != 32) */
#define VMEBUS_AFSR_ERR	0x02000000	/* Error summary bit */
#define VMEBUS_AFSR_S	0x01000000	/* MVME error in supervisor space */
#define VMEBUS_AFSR_ME	0x00800000	/* Multiple error */
#define VMEBUS_AFSR_RSVD 0x007fffff	/* reserved */
#define VMEBUS_AFSR_BITS "\177\020"	\
			 "b\27ME\0b\30S\0b\31ERR\0b\32WB\0\33TO\0f\34\3SZ\0"

struct vmebusvec {
	volatile uint8_t	vmebusvec[16];
};

/*
 * VME IO-cache definitions.
 */
#define VME_IOC_SIZE		0x8000
#define VME_IOC_LINESHFT	5
#define VME_IOC_LINESZ		(1 << VME_IOC_LINESHFT)

/*
 * The VME IO cache lines are selected by bits [13-22] of the DVMA address.
 * A byte within a cache line is selected by bits [0-4]. The bits in between
 * (e.g. [5-12]) are used as the cache tag.
 */
#define VME_IOC_IDXSHFT		13
#define VME_IOC_IDXMASK		0x3ff
#define VME_IOC_PAGESZ		(1 << VME_IOC_IDXSHFT) /* 8192 */
#define VME_IOC_LINE_IDX(addr)	\
	((((u_long)(addr)) >> VME_IOC_IDXSHFT) & VME_IOC_IDXMASK)
#define VME_IOC_LINE(addr)	(VME_IOC_LINE_IDX(addr) << VME_IOC_LINESHFT)

/* Format of a IO cache tag entry */
#define VME_IOC_W		0x00100000	/* Allow writes */
#define VME_IOC_IC		0x00200000	/* Line is cacheable */
#define VME_IOC_M		0x00400000	/* Line is modified */
#define VME_IOC_V		0x00800000	/* Data is valid */
#define VME_IOC_TAGMASK		0xff000000	/* Tag (bits <5-12> of DVMA) */
#define VME_IOC_BITS		"\177\020"	\
				"b\24W\0b\25IC\0b\26M\0b\27V\0f\30\10TAG\0"

/*
 * Physical IO-cache addresses.
 * (expressed as offsets relative to VME vector registers, for want
 *  of something better).
 */
#define VME_IOC_TAGOFFSET	0x0f000000
#define VME_IOC_DATAOFFSET	0x0f008000
#define VME_IOC_FLUSHOFFSET	0x0f020000