/*      $OpenBSD: psychovar.h,v 1.8 2019/12/05 12:46:54 mpi Exp $       */
/*      $NetBSD: psychovar.h,v 1.6 2001/07/20 00:07:13 eeh Exp $        */

/*
 * Copyright (c) 1999, 2000 Matthew R. Green
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

#ifndef _SPARC64_DEV_PSYCHOVAR_H_
#define _SPARC64_DEV_PSYCHOVAR_H_

/* per real PCI bus info */
struct psycho_softc;

struct psycho_pbm {
        /* link to mum */
        struct psycho_softc             *pp_sc;

        /*
         * note that the sabre really only has one ranges property,
         * used for both simba a and simba b (but the ranges for
         * real psychos are the same for PCI A and PCI B anyway).
         */
        struct psycho_registers         *pp_regs;
        struct psycho_ranges            *pp_range;

        /* counts of above */
        int                             pp_nregs;
        int                             pp_nrange;
        int                             pp_nintmap;

        /* PCI Bus Module A or PCI Bus Module B */
        int                             pp_id;
#define PSYCHO_PBM_UNKNOWN      0
#define PSYCHO_PBM_A            1
#define PSYCHO_PBM_B            2

        /* chipset tag for this instance */
        pci_chipset_tag_t               pp_pc;

        /* our tags */
        bus_space_tag_t                 pp_memt;
        bus_space_tag_t                 pp_iot;
        bus_dma_tag_t                   pp_dmat;
        int                             pp_bus;
        int                             pp_flags;

        /* and pointers into the psycho regs for our bits */
        bus_space_handle_t              pp_pcictl;
        struct strbuf_ctl               pp_sb;
        /* area we can use for flushing our streaming buffer */
        char                            pp_flush[0x80];
};

/*
 * per-PCI bus on mainbus softc structure; one for sabre, or two
 * per pair of psycho's.
 */
struct psycho_softc {
        struct  device                  sc_dev;

        /*
         * one sabre has two simba's.  psycho's are separately attached,
         * with the `other' psycho_pbm allocated at the first's attach.
         */
        struct psycho_pbm               *__sc_psycho_this;
        struct psycho_pbm               *__sc_psycho_other;
#define sc_psycho_this  __sc_psycho_this
#define sc_psycho_other __sc_psycho_other

        /*
         * PSYCHO register.  we record the base physical address of these 
         * also as it is the base of the entire PSYCHO
         */
        bus_space_handle_t              sc_regsh;
        bus_space_handle_t              sc_pcictl;
        paddr_t                         sc_basepaddr;

        /* Interrupt Group Number for this device */
        int                             sc_ign;

        /* our tags (from parent) */
        bus_space_tag_t                 sc_bustag;
        bus_dma_tag_t                   sc_dmatag;      

        /* config space */
        bus_space_tag_t                 sc_configtag;
        bus_space_handle_t              sc_configaddr;

        int                             sc_clockfreq;
        int                             sc_node;        /* prom node */
        int                             sc_mode;        /* (whatareya?) */
#define PSYCHO_MODE_SABRE       1       /* i'm a sabre (yob) */
#define PSYCHO_MODE_PSYCHO      2       /* i'm a psycho (w*nker) */
#define PSYCHO_MODE_CMU_CH      3       /* i'm a CMU-CH (castrate) */

        struct iommu_state              *sc_is;
};

/* config space is per-psycho.  mem/io/dma are per-pci bus */
bus_dma_tag_t psycho_alloc_dma_tag(struct psycho_pbm *);

bus_space_tag_t psycho_alloc_mem_tag(struct psycho_pbm *);
bus_space_tag_t psycho_alloc_io_tag(struct psycho_pbm *);
bus_space_tag_t psycho_alloc_config_tag(struct psycho_pbm *);

/* uperf attachment to psycho's */
struct uperf_psycho_attach_args {
        char *upaa_name;
        struct perfmon *upaa_regs;
};

#define psycho_psychoreg_read(sc, reg)                          \
        bus_space_read_8((sc)->sc_bustag, (sc)->sc_regsh,       \
            offsetof(struct psychoreg, reg))

#define psycho_psychoreg_write(sc, reg, v)                      \
        bus_space_write_8((sc)->sc_bustag, (sc)->sc_regsh,      \
            offsetof(struct psychoreg, reg), (v))

#define psycho_psychoreg_vaddr(sc, reg)                         \
        (bus_space_vaddr((sc)->sc_bustag, (sc)->sc_regsh) +     \
                offsetof(struct psychoreg, reg))

#define psycho_pcictl_read(sc, reg)                             \
        bus_space_read_8((sc)->sc_bustag, (sc)->sc_pcictl,      \
             offsetof(struct pci_ctl, reg))

#define psycho_pcictl_write(sc, reg, v) \
        bus_space_write_8((sc)->sc_bustag, (sc)->sc_pcictl,     \
            offsetof(struct pci_ctl, reg), (v))

#endif /* _SPARC64_DEV_PSYCHOVAR_H_ */