1 /* $NetBSD: agpvar.h,v 1.10 2005/12/11 12:22:48 christos 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/lock.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 #define AGP_DEBUGxx 73 74 #ifdef AGP_DEBUG 75 #define AGP_DPF(x...) do { \ 76 printf("agp: "); \ 77 printf(##x); \ 78 } while (0) 79 #else 80 #define AGP_DPF(x...) do {} while (0) 81 #endif 82 83 #define AGPUNIT(x) minor(x) 84 85 /* 86 * Data structure to describe an AGP memory allocation. 87 */ 88 TAILQ_HEAD(agp_memory_list, agp_memory); 89 struct agp_memory { 90 TAILQ_ENTRY(agp_memory) am_link; /* wiring for the tailq */ 91 int am_id; /* unique id for block */ 92 vsize_t am_size; /* number of bytes allocated */ 93 int am_type; /* chipset specific type */ 94 off_t am_offset; /* page offset if bound */ 95 int am_is_bound; /* non-zero if bound */ 96 bus_addr_t am_physical; 97 caddr_t am_virtual; 98 bus_dmamap_t am_dmamap; 99 bus_dma_segment_t *am_dmaseg; 100 int am_nseg; 101 }; 102 103 struct agp_softc; 104 105 struct agp_methods { 106 u_int32_t (*get_aperture)(struct agp_softc *); 107 int (*set_aperture)(struct agp_softc *, u_int32_t); 108 int (*bind_page)(struct agp_softc *, off_t, bus_addr_t); 109 int (*unbind_page)(struct agp_softc *, off_t); 110 void (*flush_tlb)(struct agp_softc *); 111 int (*enable)(struct agp_softc *, u_int32_t mode); 112 struct agp_memory *(*alloc_memory)(struct agp_softc *, int, vsize_t); 113 int (*free_memory)(struct agp_softc *, struct agp_memory *); 114 int (*bind_memory)(struct agp_softc *, struct agp_memory *, off_t); 115 int (*unbind_memory)(struct agp_softc *, struct agp_memory *); 116 }; 117 118 #define AGP_GET_APERTURE(sc) ((sc)->as_methods->get_aperture(sc)) 119 #define AGP_SET_APERTURE(sc,a) ((sc)->as_methods->set_aperture((sc),(a))) 120 #define AGP_BIND_PAGE(sc,o,p) ((sc)->as_methods->bind_page((sc),(o),(p))) 121 #define AGP_UNBIND_PAGE(sc,o) ((sc)->as_methods->unbind_page((sc), (o))) 122 #define AGP_FLUSH_TLB(sc) ((sc)->as_methods->flush_tlb(sc)) 123 #define AGP_ENABLE(sc,m) ((sc)->as_methods->enable((sc),(m))) 124 #define AGP_ALLOC_MEMORY(sc,t,s) ((sc)->as_methods->alloc_memory((sc),(t),(s))) 125 #define AGP_FREE_MEMORY(sc,m) ((sc)->as_methods->free_memory((sc),(m))) 126 #define AGP_BIND_MEMORY(sc,m,o) ((sc)->as_methods->bind_memory((sc),(m),(o))) 127 #define AGP_UNBIND_MEMORY(sc,m) ((sc)->as_methods->unbind_memory((sc),(m))) 128 129 /* 130 * All chipset drivers must have this at the start of their softc. 131 */ 132 struct agp_softc { 133 struct device as_dev; 134 bus_space_tag_t as_apt; 135 int as_capoff; 136 bus_addr_t as_apaddr; 137 bus_size_t as_apsize; 138 int as_apflags; 139 bus_dma_tag_t as_dmat; 140 u_int32_t as_maxmem; /* allocation upper bound */ 141 u_int32_t as_allocated; /* amount allocated */ 142 enum agp_acquire_state as_state; 143 struct agp_memory_list as_memory; /* list of allocated memory */ 144 int as_nextid; /* next memory block id */ 145 int as_isopen; /* user device is open */ 146 #if 0 147 dev_t as_devnode; /* from make_dev */ 148 #endif 149 struct lock as_lock; /* lock for access to GATT */ 150 struct agp_methods *as_methods; /* chipset-dependent API */ 151 void *as_chipc; /* chipset-dependent state */ 152 pci_chipset_tag_t as_pc; 153 pcitag_t as_tag; 154 pcireg_t as_id; 155 }; 156 157 struct agp_gatt { 158 u_int32_t ag_entries; 159 u_int32_t *ag_virtual; 160 bus_addr_t ag_physical; 161 bus_dmamap_t ag_dmamap; 162 bus_dma_segment_t ag_dmaseg; 163 size_t ag_size; 164 }; 165 166 int agpbusprint(void *, const char *); 167 168 /* 169 * Functions private to the AGP code. 170 */ 171 void agp_flush_cache(void); 172 int agp_find_caps(pci_chipset_tag_t, pcitag_t); 173 int agp_map_aperture(struct pci_attach_args *, struct agp_softc *); 174 struct agp_gatt *agp_alloc_gatt(struct agp_softc *); 175 void agp_free_gatt(struct agp_softc *, struct agp_gatt *); 176 int agp_generic_attach(struct agp_softc *); 177 int agp_generic_detach(struct agp_softc *); 178 int agp_generic_enable(struct agp_softc *, u_int32_t); 179 struct agp_memory *agp_generic_alloc_memory(struct agp_softc *, int, vsize_t); 180 int agp_generic_free_memory(struct agp_softc *, struct agp_memory *); 181 int agp_generic_bind_memory(struct agp_softc *, struct agp_memory *, 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 187 int agp_ali_attach(struct device *, struct device *, void *); 188 int agp_amd_attach(struct device *, struct device *, void *); 189 int agp_i810_attach(struct device *, struct device *, void *); 190 int agp_intel_attach(struct device *, struct device *, void *); 191 int agp_via_attach(struct device *, struct device *, void *); 192 int agp_sis_attach(struct device *, struct device *, void *); 193 194 int agp_alloc_dmamem(bus_dma_tag_t, size_t, int, bus_dmamap_t *, caddr_t *, 195 bus_addr_t *, bus_dma_segment_t *, int, int *); 196 void agp_free_dmamem(bus_dma_tag_t, size_t, bus_dmamap_t, caddr_t, 197 bus_dma_segment_t *, int) ; 198 199 MALLOC_DECLARE(M_AGP); 200 201 /* 202 * Kernel API 203 */ 204 /* 205 * Find the AGP device and return it. 206 */ 207 void *agp_find_device(int); 208 209 /* 210 * Return the current owner of the AGP chipset. 211 */ 212 enum agp_acquire_state agp_state(void *); 213 214 /* 215 * Query the state of the AGP system. 216 */ 217 void agp_get_info(void *, struct agp_info *); 218 219 /* 220 * Acquire the AGP chipset for use by the kernel. Returns EBUSY if the 221 * AGP chipset is already acquired by another user. 222 */ 223 int agp_acquire(void *); 224 225 /* 226 * Release the AGP chipset. 227 */ 228 int agp_release(void *); 229 230 /* 231 * Enable the agp hardware with the relavent mode. The mode bits are 232 * defined in <dev/pci/agpreg.h> 233 */ 234 int agp_enable(void *, u_int32_t); 235 236 /* 237 * Allocate physical memory suitable for mapping into the AGP 238 * aperture. The value returned is an opaque handle which can be 239 * passed to agp_bind(), agp_unbind() or agp_deallocate(). 240 */ 241 void *agp_alloc_memory(void *, int, vsize_t); 242 243 /* 244 * Free memory which was allocated with agp_allocate(). 245 */ 246 void agp_free_memory(void *, void *); 247 248 /* 249 * Bind memory allocated with agp_allocate() at a given offset within 250 * the AGP aperture. Returns EINVAL if the memory is already bound or 251 * the offset is not at an AGP page boundary. 252 */ 253 int agp_bind_memory(void *, void *, off_t); 254 255 /* 256 * Unbind memory from the AGP aperture. Returns EINVAL if the memory 257 * is not bound. 258 */ 259 int agp_unbind_memory(void *, void *); 260 261 /* 262 * Retrieve information about a memory block allocated with 263 * agp_alloc_memory(). 264 */ 265 void agp_memory_info(void *, void *, struct agp_memory_info *); 266 267 #endif /* !_PCI_AGPPRIV_H_ */ 268