/* $Id: tcvar.h,v 1.1 1998/08/20 08:27:11 dfr Exp $ */
/*	$NetBSD: tcvar.h,v 1.13 1998/05/22 21:15:48 thorpej Exp $	*/

/*
 * Copyright (c) 1995 Carnegie-Mellon University.
 * All rights reserved.
 *
 * Author: Chris G. Demetriou
 * 
 * Permission to use, copy, modify and distribute this software and
 * its documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 
 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 */

#ifndef __DEV_TC_TCVAR_H__
#define __DEV_TC_TCVAR_H__

/*
 * Definitions for TurboChannel autoconfiguration.
 */

/*
 * In the long run, the following block will go completely away.
 * For now, the MI TC code still uses the old TC_IPL_ names
 * and not the new IPL_ names.
 */
#if 1
/*
 * Map the new definitions to the old.
 */
#include <machine/intr.h>

#define tc_intrlevel_t	int

#define	TC_IPL_NONE	IPL_NONE
#define	TC_IPL_BIO	IPL_BIO
#define	TC_IPL_NET	IPL_NET
#define	TC_IPL_TTY	IPL_TTY
#define	TC_IPL_CLOCK	IPL_CLOCK
#endif /* 1 */


typedef u_int64_t       tc_addr_t;
typedef int32_t         tc_offset_t;

#define tc_mb()         alpha_mb()
#define tc_wmb()        alpha_wmb()


/*
 * A junk address to read from, to make sure writes are complete.  See
 * System Programmer's Manual, section 9.3 (p. 9-4), and sacrifice a
 * chicken.
 */
#define tc_syncbus()                                                    \
    do {                                                                \
        volatile u_int32_t no_optimize;                                 \
        no_optimize =                                                   \
            *(volatile u_int32_t *)ALPHA_PHYS_TO_K0SEG(0x00000001f0080220); \
    } while (0)

#define tc_badaddr(tcaddr)                                              \
    badaddr((void *)(tcaddr), sizeof (u_int32_t))

#define TC_SPACE_IND            0xffffffffe0000003
#define TC_SPACE_DENSE          0x0000000000000000
#define TC_SPACE_DENSE_OFFSET   0x0000000007fffffc
#define TC_SPACE_SPARSE         0x0000000010000000
#define TC_SPACE_SPARSE_OFFSET  0x000000000ffffff8

#define TC_DENSE_TO_SPARSE(addr)                                        \
    (((addr) & TC_SPACE_IND) | TC_SPACE_SPARSE |                        \
        (((addr) & TC_SPACE_DENSE_OFFSET) << 1))
                
#define TC_PHYS_TO_UNCACHED(addr)                                       \
    (addr)

/*
 * These functions are private, and may not be called by
 * machine-independent code.
 */
void tc_dma_init __P((void));

/*
 * Address of scatter/gather SRAM on the 3000/500-series.
 *
 * There is room for 32K entries, yielding 256M of sgva space.
 * The page table is readable in both dense and sparse space.
 * The page table is writable only in sparse space.
 *
 * In sparse space, the 32-bit PTEs are followed by 32-bits
 * of pad.
 */
#define TC_SGSRAM_DENSE         0x0000001c2800000UL
#define TC_SGSRAM_SPARSE        0x0000001d5000000UL


/*
 * Description of TurboChannel slots, provided by machine-dependent
 * code to the TurboChannel bus driver.
 */
struct tc_slotdesc {
	tc_addr_t	tcs_addr;
	void		*tcs_cookie;
	int		tcs_used;
};

/*
 * Description of built-in TurboChannel devices, provided by
 * machine-dependent code to the TurboChannel bus driver.
 */
struct tc_builtin {
	char		*tcb_modname;
	u_int		tcb_slot;
	tc_offset_t	tcb_offset;
	void		*tcb_cookie;
};

/*
 * Arguments used to attach TurboChannel busses.
 */
struct tcbus_attach_args {
        char            *tba_busname;           /* XXX should be common */
/*        bus_space_tag_t tba_memt;*/

        /* Bus information */
        u_int           tba_speed;              /* see TC_SPEED_* below */
        u_int           tba_nslots;
        struct tc_slotdesc *tba_slots;
        u_int           tba_nbuiltins;
        const struct tc_builtin *tba_builtins;
        

        /* TC bus resource management; XXX will move elsewhere eventually. */
/*
        void    (*tba_intr_establish) __P((struct device *, void *,
                    tc_intrlevel_t, int (*)(void *), void *));
        void    (*tba_intr_disestablish) __P((struct device *, void *));
*/
};

/*
 * Arguments used to attach TurboChannel devices.
 */
struct tc_attach_args {
/*
        bus_space_tag_t ta_memt;
        bus_dma_tag_t   ta_dmat;
*/
        char            ta_modname[TC_ROM_LLEN+1];
        u_int           ta_slot;
        tc_offset_t     ta_offset;
        tc_addr_t       ta_addr;
        void            *ta_cookie;
        u_int           ta_busspeed;            /* see TC_SPEED_* below */
};

/*
 * Interrupt establishment functions.
 */
void	tc_intr_establish __P((struct device *, void *, tc_intrlevel_t,
	    int (*)(void *), void *));
void	tc_intr_disestablish __P((struct device *, void *));

#if 0
#include "locators.h"
/*
 * Easy to remember names for TurboChannel device locators.
 */
#define	tccf_slot	cf_loc[TCCF_SLOT]		/* slot */
#define	tccf_offset	cf_loc[TCCF_OFFSET]		/* offset */

#endif

#define	TCCF_SLOT_UNKNOWN	TCCF_SLOT_DEFAULT
#define	TCCF_OFFSET_UNKNOWN	TCCF_OFFSET_DEFAULT

/*
 * Miscellaneous definitions.
 */
#define	TC_SPEED_12_5_MHZ	0		/* 12.5MHz TC bus */
#define	TC_SPEED_25_MHZ		1		/* 25MHz TC bus */

#endif /* __DEV_TC_TCVAR_H__ */
