/*      $OpenBSD: agpvar.h,v 1.40 2024/10/10 03:36:10 jsg Exp $ */
/*      $NetBSD: agpvar.h,v 1.4 2001/10/01 21:54:48 fvdl Exp $  */

/*-
 * Copyright (c) 2000 Doug Rabson
 * 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 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 AUTHOR 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.
 *
 *      $FreeBSD: src/sys/pci/agppriv.h,v 1.3 2000/07/12 10:13:04 dfr Exp $
 */

#ifndef _PCI_AGPVAR_H_
#define _PCI_AGPVAR_H_

struct agp_attach_args {
        char                    *aa_busname;
        struct pci_attach_args  *aa_pa;
};

struct agpbus_attach_args {
        char                            *aa_busname; /*so pci doesn't conflict*/
        struct pci_attach_args          *aa_pa;
        const struct agp_methods        *aa_methods;
        bus_addr_t                       aa_apaddr;
        bus_size_t                       aa_apsize;
};

enum agp_acquire_state {
        AGP_ACQUIRE_FREE,
        AGP_ACQUIRE_USER,
        AGP_ACQUIRE_KERNEL
};

/*
 * This structure is used to query the state of the AGP system.
 */
struct agp_info {
        u_int32_t       ai_mode;
        bus_addr_t      ai_aperture_base;
        bus_size_t      ai_aperture_size;
        vsize_t         ai_memory_allowed;
        vsize_t         ai_memory_used;
        u_int32_t       ai_devid;
};

struct agp_methods {
        void    (*bind_page)(void *, bus_addr_t, paddr_t, int);
        void    (*unbind_page)(void *, bus_addr_t);
        void    (*flush_tlb)(void *);
        int     (*enable)(void *, u_int32_t mode);
};

/*
 * All chipset drivers must have this at the start of their softc.
 */
struct agp_softc {
        struct device                    sc_dev;

        const struct agp_methods        *sc_methods;    /* callbacks */
        void                            *sc_chipc;      /* chipset softc */

        bus_dma_tag_t                    sc_dmat;
        bus_space_tag_t                  sc_memt;
        pci_chipset_tag_t                sc_pc;
        pcitag_t                         sc_pcitag;
        bus_addr_t                       sc_apaddr;
        bus_size_t                       sc_apsize;
        pcireg_t                         sc_id;

        int                              sc_capoff;                     
        enum agp_acquire_state           sc_state;

        u_int32_t                        sc_maxmem;     /* mem upper bound */
        u_int32_t                        sc_allocated;  /* amount allocated */
};

struct agp_gatt {
        u_int32_t       ag_entries;
        u_int32_t       *ag_virtual;
        bus_addr_t      ag_physical;
        bus_dmamap_t    ag_dmamap;
        bus_dma_segment_t ag_dmaseg;
        size_t          ag_size;
};

/*
 * Functions private to the AGP code.
 */
struct device   *agp_attach_bus(struct pci_attach_args *,
                     const struct agp_methods *, bus_addr_t, bus_size_t,
                     struct device *);
struct agp_gatt *
        agp_alloc_gatt(bus_dma_tag_t, u_int32_t);
void    agp_free_gatt(bus_dma_tag_t, struct agp_gatt *);
void    agp_flush_cache(void);
int     agp_generic_enable(struct agp_softc *, u_int32_t);

int     agp_alloc_dmamem(bus_dma_tag_t, size_t, bus_dmamap_t *,
            bus_addr_t *, bus_dma_segment_t *);
void    agp_free_dmamem(bus_dma_tag_t, size_t, bus_dmamap_t,
            bus_dma_segment_t *);
int     agpdev_print(void *, const char *);
int     agpbus_probe(struct agp_attach_args *aa);

paddr_t agp_mmap(struct agp_softc *, off_t, int);

/*
 * Kernel API
 */
/*
 * Find the AGP device and return it.
 */
void    *agp_find_device(int);

/*
 * Return the current owner of the AGP chipset.
 */
enum     agp_acquire_state agp_state(void *);

/*
 * Query the state of the AGP system.
 */
void     agp_get_info(void *, struct agp_info *);

/*
 * Acquire the AGP chipset for use by the kernel. Returns EBUSY if the
 * AGP chipset is already acquired by another user.
 */
int      agp_acquire(void *);

/*
 * Release the AGP chipset.
 */
int      agp_release(void *);

/*
 * Enable the agp hardware with the relevant mode. The mode bits are
 * defined in <dev/pci/agpreg.h>
 */
int      agp_enable(void *, u_int32_t);

#endif /* !_PCI_AGPVAR_H_ */