Home | History | Annotate | Line # | Download | only in pci
      1 /*	$NetBSD: agpvar.h,v 1.22 2022/04/10 09:50:45 andvar Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2000 Doug Rabson
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  *
     28  *	$FreeBSD: src/sys/pci/agppriv.h,v 1.3 2000/07/12 10:13:04 dfr Exp $
     29  */
     30 
     31 #ifndef _PCI_AGPVAR_H_
     32 #define _PCI_AGPVAR_H_
     33 
     34 #include <sys/mallocvar.h>
     35 #include <sys/mutex.h>
     36 
     37 struct agpbus_attach_args {
     38 	char	*_apa_busname; /* XXX placeholder */
     39 	struct pci_attach_args apa_pci_args;
     40 };
     41 
     42 /*
     43  * The AGP chipset can be acquired by user or kernel code. If the
     44  * chipset has already been acquired, it cannot be acquired by another
     45  * user until the previous user has released it.
     46  */
     47 enum agp_acquire_state {
     48 	AGP_ACQUIRE_FREE,
     49 	AGP_ACQUIRE_USER,
     50 	AGP_ACQUIRE_KERNEL
     51 };
     52 
     53 /*
     54  * This structure is used to query the state of the AGP system.
     55  */
     56 struct agp_info {
     57 	u_int32_t	ai_mode;
     58 	bus_addr_t	ai_aperture_base;
     59 	bus_size_t	ai_aperture_size;
     60 	vsize_t		ai_memory_allowed;
     61 	vsize_t		ai_memory_used;
     62 	u_int32_t	ai_devid;
     63 };
     64 
     65 struct agp_memory_info {
     66 	vsize_t		ami_size;	/* size in bytes */
     67 	bus_addr_t	ami_physical;	/* bogus hack for i810 */
     68 	off_t		ami_offset;	/* page offset if bound */
     69 	int		ami_is_bound;	/* non-zero if bound */
     70 };
     71 
     72 #ifdef AGP_DEBUG
     73 #define AGP_DPF(x) do {			\
     74     printf("agp: ");				\
     75     printf x;				\
     76 } while (0)
     77 #else
     78 #define AGP_DPF(x)
     79 #endif
     80 
     81 #define AGPUNIT(x)	minor(x)
     82 
     83 /*
     84  * Data structure to describe an AGP memory allocation.
     85  */
     86 TAILQ_HEAD(agp_memory_list, agp_memory);
     87 struct agp_memory {
     88 	TAILQ_ENTRY(agp_memory) am_link;	/* wiring for the tailq */
     89 	int		am_id;			/* unique id for block */
     90 	vsize_t		am_size;		/* number of bytes allocated */
     91 	int		am_type;		/* chipset specific type */
     92 	off_t		am_offset;		/* page offset if bound */
     93 	int		am_is_bound;		/* non-zero if bound */
     94 	bus_addr_t	  am_physical;
     95 	void *		  am_virtual;
     96 	bus_dmamap_t	  am_dmamap;
     97 	bus_dma_segment_t *am_dmaseg;
     98 	int		  am_nseg;
     99 };
    100 
    101 struct agp_softc;
    102 
    103 struct agp_methods {
    104 	u_int32_t (*get_aperture)(struct agp_softc *);
    105 	int (*set_aperture)(struct agp_softc *, u_int32_t);
    106 	int (*bind_page)(struct agp_softc *, off_t, bus_addr_t);
    107 	int (*unbind_page)(struct agp_softc *, off_t);
    108 	void (*flush_tlb)(struct agp_softc *);
    109 	int (*enable)(struct agp_softc *, u_int32_t mode);
    110 	struct agp_memory *(*alloc_memory)(struct agp_softc *, int, vsize_t);
    111 	int (*free_memory)(struct agp_softc *, struct agp_memory *);
    112 	int (*bind_memory)(struct agp_softc *, struct agp_memory *, off_t);
    113 	int (*unbind_memory)(struct agp_softc *, struct agp_memory *);
    114 };
    115 
    116 #define AGP_GET_APERTURE(sc)	 ((sc)->as_methods->get_aperture(sc))
    117 #define AGP_SET_APERTURE(sc,a)	 ((sc)->as_methods->set_aperture((sc),(a)))
    118 #define AGP_BIND_PAGE(sc,o,p)	 ((sc)->as_methods->bind_page((sc),(o),(p)))
    119 #define AGP_UNBIND_PAGE(sc,o)	 ((sc)->as_methods->unbind_page((sc), (o)))
    120 #define AGP_FLUSH_TLB(sc)	 ((sc)->as_methods->flush_tlb(sc))
    121 #define AGP_ENABLE(sc,m)	 ((sc)->as_methods->enable((sc),(m)))
    122 #define AGP_ALLOC_MEMORY(sc,t,s) ((sc)->as_methods->alloc_memory((sc),(t),(s)))
    123 #define AGP_FREE_MEMORY(sc,m)	 ((sc)->as_methods->free_memory((sc),(m)))
    124 #define AGP_BIND_MEMORY(sc,m,o)	 ((sc)->as_methods->bind_memory((sc),(m),(o)))
    125 #define AGP_UNBIND_MEMORY(sc,m)	 ((sc)->as_methods->unbind_memory((sc),(m)))
    126 
    127 /*
    128  * All chipset drivers must have this at the start of their softc.
    129  */
    130 struct agp_softc {
    131 	device_t		as_dev;
    132 	bus_space_tag_t		as_apt;
    133 	int			as_capoff;
    134 	bus_addr_t		as_apaddr;
    135 	bus_size_t		as_apsize;
    136 	int			as_apflags;
    137 	bus_dma_tag_t		as_dmat;
    138 	u_int32_t		as_maxmem;	/* allocation upper bound */
    139 	u_int32_t		as_allocated;	/* amount allocated */
    140 	enum agp_acquire_state	as_state;
    141 	struct agp_memory_list	as_memory;	/* list of allocated memory */
    142 	int			as_nextid;	/* next memory block id */
    143 	int			as_isopen;	/* user device is open */
    144 #if 0
    145 	dev_t			as_devnode;	/* from make_dev */
    146 #endif
    147 	kmutex_t		as_mtx;		/* mutex for access to GATT */
    148 	struct agp_methods	*as_methods;	/* chipset-dependent API */
    149 	void			*as_chipc;	/* chipset-dependent state */
    150 	pci_chipset_tag_t	as_pc;
    151 	pcitag_t		as_tag;
    152 	pcireg_t		as_id;
    153 };
    154 
    155 struct agp_gatt {
    156 	u_int32_t	  ag_entries;
    157 	u_int32_t        *ag_virtual;
    158 	bus_addr_t	  ag_physical;
    159 	bus_dmamap_t	  ag_dmamap;
    160 	bus_dma_segment_t ag_dmaseg;
    161 	size_t		  ag_size;
    162 };
    163 
    164 int agpbusprint(void *, const char *);
    165 
    166 /*
    167  * Functions private to the AGP code.
    168  */
    169 void agp_flush_cache(void);
    170 int agp_find_caps(pci_chipset_tag_t, pcitag_t);
    171 int agp_map_aperture(struct pci_attach_args *, struct agp_softc *, int);
    172 struct agp_gatt *agp_alloc_gatt(struct agp_softc *);
    173 void agp_free_gatt(struct agp_softc *, struct agp_gatt *);
    174 int agp_generic_attach(struct agp_softc *);
    175 int agp_generic_detach(struct agp_softc *);
    176 int agp_generic_enable(struct agp_softc *, u_int32_t);
    177 struct agp_memory *agp_generic_alloc_memory(struct agp_softc *, int, vsize_t);
    178 int agp_generic_free_memory(struct agp_softc *, struct agp_memory *);
    179 int agp_generic_bind_memory(struct agp_softc *, struct agp_memory *, off_t);
    180 int agp_generic_bind_memory_bounded(struct agp_softc *, struct agp_memory *,
    181 	off_t, off_t, off_t);
    182 int agp_generic_unbind_memory(struct agp_softc *, struct agp_memory *);
    183 
    184 /* The vendor has already been matched when these functions are called */
    185 int agp_amd_match(const struct pci_attach_args *);
    186 int agp_amd64_match(const struct pci_attach_args *);
    187 
    188 int agp_ali_attach(device_t, device_t, void *);
    189 int agp_amd_attach(device_t, device_t, void *);
    190 int agp_apple_attach(device_t, device_t, void *);
    191 int agp_i810_attach(device_t, device_t, void *);
    192 int agp_intel_attach(device_t, device_t, void *);
    193 int agp_via_attach(device_t, device_t, void *);
    194 int agp_sis_attach(device_t, device_t, void *);
    195 int agp_amd64_attach(device_t, device_t, void *);
    196 
    197 int agp_alloc_dmamem(bus_dma_tag_t, size_t, int, bus_dmamap_t *, void **,
    198 		     bus_addr_t *, bus_dma_segment_t *, int, int *);
    199 void agp_free_dmamem(bus_dma_tag_t, size_t, bus_dmamap_t, void *,
    200 		     bus_dma_segment_t *, int) ;
    201 
    202 MALLOC_DECLARE(M_AGP);
    203 
    204 /*
    205  * Kernel API
    206  */
    207 /*
    208  * Find the AGP device and return it.
    209  */
    210 void *agp_find_device(int);
    211 
    212 /*
    213  * Return the current owner of the AGP chipset.
    214  */
    215 enum agp_acquire_state agp_state(void *);
    216 
    217 /*
    218  * Query the state of the AGP system.
    219  */
    220 void agp_get_info(void *, struct agp_info *);
    221 
    222 /*
    223  * Acquire the AGP chipset for use by the kernel. Returns EBUSY if the
    224  * AGP chipset is already acquired by another user.
    225  */
    226 int agp_acquire(void *);
    227 
    228 /*
    229  * Release the AGP chipset.
    230  */
    231 int agp_release(void *);
    232 
    233 /*
    234  * Enable the agp hardware with the relevant mode. The mode bits are
    235  * defined in <dev/pci/agpreg.h>
    236  */
    237 int agp_enable(void *, u_int32_t);
    238 
    239 /*
    240  * Allocate physical memory suitable for mapping into the AGP
    241  * aperture.  The value returned is an opaque handle which can be
    242  * passed to agp_bind(), agp_unbind() or agp_deallocate().
    243  */
    244 void *agp_alloc_memory(void *, int, vsize_t);
    245 
    246 /*
    247  * Free memory which was allocated with agp_allocate().
    248  */
    249 void agp_free_memory(void *, void *);
    250 
    251 /*
    252  * Bind memory allocated with agp_allocate() at a given offset within
    253  * the AGP aperture. Returns EINVAL if the memory is already bound or
    254  * the offset is not at an AGP page boundary.
    255  */
    256 int agp_bind_memory(void *, void *, off_t);
    257 
    258 /*
    259  * Unbind memory from the AGP aperture. Returns EINVAL if the memory
    260  * is not bound.
    261  */
    262 int agp_unbind_memory(void *, void *);
    263 
    264 /*
    265  * Retrieve information about a memory block allocated with
    266  * agp_alloc_memory().
    267  */
    268 void agp_memory_info(void *, void *, struct agp_memory_info *);
    269 
    270 /*
    271  * XXX horrible hack to allow drm code to use our mapping
    272  * of VGA chip registers
    273  */
    274 int agp_i810_borrow(bus_addr_t, bus_size_t, bus_space_handle_t *);
    275 
    276 #endif /* !_PCI_AGPPRIV_H_ */
    277