xref: /dragonfly/sys/sys/agpio.h (revision 0bb9290e)
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/sys/agpio.h,v 1.1.2.2 2001/12/20 10:36:57 ru Exp $
27  *	$DragonFly: src/sys/sys/agpio.h,v 1.4 2006/05/20 02:42:13 dillon Exp $
28  */
29 
30 #ifndef _SYS_AGPIO_H_
31 #define _SYS_AGPIO_H_
32 
33 #ifndef _SYS_TYPES_H_
34 #include <sys/types.h>
35 #endif
36 
37 /*
38  * The AGP gatt uses 4k pages irrespective of the host page size.
39  */
40 #define AGP_PAGE_SIZE		4096
41 #define AGP_PAGE_SHIFT		12
42 
43 /*
44  * Macros to manipulate AGP mode words.
45  *
46  * SBA = Sideband Address Port
47  * FW  = Fast Writes
48  */
49 #define AGP_MODE_GET_RQ(x)		(((x) & 0xff000000U) >> 24)
50 #define AGP_MODE_GET_ARQSZ(x)		(((x) & 0x0000e000U) >> 13)
51 #define AGP_MODE_GET_CAL(x)		(((x) & 0x00001c00U) >> 10)
52 #define AGP_MODE_GET_SBA(x)		(((x) & 0x00000200U) >> 9)
53 #define AGP_MODE_GET_AGP(x)		(((x) & 0x00000100U) >> 8)
54 #define AGP_MODE_GET_GART_64(x)		(((x) & 0x00000080U) >> 7)
55 #define AGP_MODE_GET_OVER_4G(x)		(((x) & 0x00000020U) >> 5)
56 #define AGP_MODE_GET_FW(x)		(((x) & 0x00000010U) >> 4)
57 #define AGP_MODE_GET_MODE_3(x)		(((x) & 0x00000008U) >> 3)
58 #define AGP_MODE_GET_RATE(x)		((x) & 0x00000007U)
59 #define AGP_MODE_SET_RQ(x,v)		(((x) & ~0xff000000U) | ((v) << 24))
60 #define AGP_MODE_SET_ARQSZ(x,v)		(((x) & ~0x0000e000U) | ((v) << 13))
61 #define AGP_MODE_SET_CAL(x,v)		(((x) & ~0x00001c00U) | ((v) << 10))
62 #define AGP_MODE_SET_SBA(x,v)		(((x) & ~0x00000200U) | ((v) << 9))
63 #define AGP_MODE_SET_AGP(x,v)		(((x) & ~0x00000100U) | ((v) << 8))
64 #define AGP_MODE_SET_GART_64(x,v)	(((x) & ~0x00000080U) | ((v) << 7))
65 #define AGP_MODE_SET_OVER_4G(x,v)	(((x) & ~0x00000020U) | ((v) << 5))
66 #define AGP_MODE_SET_FW(x,v)		(((x) & ~0x00000010U) | ((v) << 4))
67 #define AGP_MODE_SET_MODE_3(x,v)	(((x) & ~0x00000008U) | ((v) << 3))
68 #define AGP_MODE_SET_RATE(x,v)		(((x) & ~0x00000007U) | (v))
69 #define AGP_MODE_V2_RATE_1x		0x00000001
70 #define AGP_MODE_V2_RATE_2x		0x00000002
71 #define AGP_MODE_V2_RATE_4x		0x00000004
72 #define AGP_MODE_V3_RATE_4x		0x00000001
73 #define AGP_MODE_V3_RATE_8x		0x00000002
74 #define AGP_MODE_V3_RATE_RSVD		0x00000004
75 
76 /* XXX: Compat */
77 #define AGP_MODE_GET_4G(x)		AGP_MODE_GET_OVER_4G(x)
78 #define AGP_MODE_SET_4G(x)		AGP_MODE_SET_OVER_4G(x)
79 #define AGP_MODE_RATE_1x		AGP_MODE_V2_RATE_1x
80 #define AGP_MODE_RATE_2x		AGP_MODE_V2_RATE_2x
81 #define AGP_MODE_RATE_4x		AGP_MODE_V2_RATE_4x
82 
83 #define AGPIOC_BASE       'A'
84 #define AGPIOC_INFO       _IOR (AGPIOC_BASE, 0, agp_info)
85 #define AGPIOC_ACQUIRE    _IO  (AGPIOC_BASE, 1)
86 #define AGPIOC_RELEASE    _IO  (AGPIOC_BASE, 2)
87 #define AGPIOC_SETUP      _IOW (AGPIOC_BASE, 3, agp_setup)
88 #if 0
89 #define AGPIOC_RESERVE    _IOW (AGPIOC_BASE, 4, agp_region)
90 #define AGPIOC_PROTECT    _IOW (AGPIOC_BASE, 5, agp_region)
91 #endif
92 #define AGPIOC_ALLOCATE   _IOWR(AGPIOC_BASE, 6, agp_allocate)
93 #define AGPIOC_DEALLOCATE _IOW (AGPIOC_BASE, 7, int)
94 #define AGPIOC_BIND       _IOW (AGPIOC_BASE, 8, agp_bind)
95 #define AGPIOC_UNBIND     _IOW (AGPIOC_BASE, 9, agp_unbind)
96 
97 typedef struct _agp_version {
98 	u_int16_t major;
99 	u_int16_t minor;
100 } agp_version;
101 
102 typedef struct _agp_info {
103 	agp_version version;	/* version of the driver        */
104 	u_int32_t bridge_id;	/* bridge vendor/device         */
105 	u_int32_t agp_mode;	/* mode info of bridge          */
106 	off_t aper_base;	/* base of aperture             */
107 	size_t aper_size;	/* size of aperture             */
108 	size_t pg_total;	/* max pages (swap + system)    */
109 	size_t pg_system;	/* max pages (system)           */
110 	size_t pg_used;		/* current pages used           */
111 } agp_info;
112 
113 typedef struct _agp_setup {
114 	u_int32_t agp_mode;		/* mode info of bridge          */
115 } agp_setup;
116 
117 #if 0
118 /*
119  * The "prot" down below needs still a "sleep" flag somehow ...
120  */
121 typedef struct _agp_segment {
122 	off_t pg_start;		/* starting page to populate    */
123 	size_t pg_count;	/* number of pages              */
124 	int prot;		/* prot flags for mmap          */
125 } agp_segment;
126 
127 typedef struct _agp_region {
128 	pid_t pid;		/* pid of process               */
129 	size_t seg_count;	/* number of segments           */
130 	struct _agp_segment *seg_list;
131 } agp_region;
132 #endif
133 
134 typedef struct _agp_allocate {
135 	int key;		/* tag of allocation            */
136 	size_t pg_count;	/* number of pages              */
137 	u_int32_t type;		/* 0 == normal, other devspec   */
138    	u_int32_t physical;     /* device specific (some devices
139 				 * need a phys address of the
140 				 * actual page behind the gatt
141 				 * table)                        */
142 } agp_allocate;
143 
144 typedef struct _agp_bind {
145 	int key;		/* tag of allocation            */
146 	off_t pg_start;		/* starting page to populate    */
147 } agp_bind;
148 
149 typedef struct _agp_unbind {
150 	int key;		/* tag of allocation            */
151 	u_int32_t priority;	/* priority for paging out      */
152 } agp_unbind;
153 
154 #endif /* !_SYS_AGPIO_H_ */
155