agp: A rewrite of the i810 bits of the driver
[dragonfly.git] / sys / dev / agp / agppriv.h
1 /*-
2  * Copyright (c) 2000 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  *      $FreeBSD: src/sys/dev/agp/agppriv.h,v 1.8 2007/11/12 21:51:37 jhb Exp $
27  */
28
29 #ifndef _PCI_AGPPRIV_H_
30 #define _PCI_AGPPRIV_H_
31
32 /*
33  * This file *must not* be included by code outside the agp driver itself.
34  */
35
36 #include <sys/agpio.h>
37 #include "agpvar.h"
38
39 #define AGP_DEBUGxx
40
41 #ifdef AGP_DEBUG
42 #define AGP_DPF(fmt, ...) do {                          \
43     kprintf("agp: " fmt, ##__VA_ARGS__);                \
44 } while (0)
45 #else
46 #define AGP_DPF(x...) do {} while (0)
47 #endif
48
49 #include "agp_if.h"
50
51 /*
52  * Data structure to describe an AGP memory allocation.
53  */
54 TAILQ_HEAD(agp_memory_list, agp_memory);
55 struct agp_memory {
56         TAILQ_ENTRY(agp_memory) am_link;        /* wiring for the tailq */
57         int             am_id;                  /* unique id for block */
58         vm_size_t       am_size;                /* number of bytes allocated */
59         int             am_type;                /* chipset specific type */
60         struct vm_object *am_obj;               /* VM object owning pages */
61         vm_offset_t     am_physical;            /* bogus hack for i810 */
62         vm_offset_t     am_offset;              /* page offset if bound */
63         int             am_is_bound;            /* non-zero if bound */
64 };
65
66 /*
67  * All chipset drivers must have this at the start of their softc.
68  */
69 struct agp_softc {
70         struct resource         *as_aperture;   /* location of aperture */
71         int                     as_aperture_rid;
72         u_int32_t               as_maxmem;      /* allocation upper bound */
73         u_int32_t               as_allocated;   /* amount allocated */
74         enum agp_acquire_state  as_state;
75         struct agp_memory_list  as_memory;      /* list of allocated memory */
76         int                     as_nextid;      /* next memory block id */
77         int                     as_isopen;      /* user device is open */
78         struct cdev             *as_devnode;    /* from make_dev */
79         struct lock             as_lock;        /* lock for access to GATT */
80 };
81
82 struct agp_gatt {
83         u_int32_t       ag_entries;
84         u_int32_t      *ag_virtual;
85         vm_offset_t     ag_physical;
86 };
87
88 void                    agp_flush_cache(void);
89 u_int8_t                agp_find_caps(device_t dev);
90 struct agp_gatt        *agp_alloc_gatt(device_t dev);
91 void                    agp_set_aperture_resource(device_t dev, int rid);
92 void                    agp_free_cdev(device_t dev);
93 void                    agp_free_gatt(struct agp_gatt *gatt);
94 void                    agp_free_res(device_t dev);
95 int                     agp_generic_attach(device_t dev);
96 int                     agp_generic_detach(device_t dev);
97 u_int32_t               agp_generic_get_aperture(device_t dev);
98 int                     agp_generic_set_aperture(device_t dev,
99                                                  u_int32_t aperture);
100 int                     agp_generic_enable(device_t dev, u_int32_t mode);
101 struct agp_memory      *agp_generic_alloc_memory(device_t dev, int type,
102                                                  vm_size_t size);
103 int                     agp_generic_free_memory(device_t dev,
104                                                 struct agp_memory *mem);
105 int                     agp_generic_bind_memory(device_t dev,
106                                                 struct agp_memory *mem,
107                                                 vm_offset_t offset);
108 int                     agp_generic_unbind_memory(device_t dev,
109                                                   struct agp_memory *mem);
110
111 #endif /* !_PCI_AGPPRIV_H_ */