Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / sys / agpio.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/sys/agpio.h,v 1.1.2.2 2001/12/20 10:36:57 ru Exp $
27  */
28
29 #ifndef _SYS_AGPIO_H_
30 #define _SYS_AGPIO_H_
31
32 /*
33  * The AGP gatt uses 4k pages irrespective of the host page size.
34  */
35 #define AGP_PAGE_SIZE           4096
36 #define AGP_PAGE_SHIFT          12
37
38 /*
39  * Macros to manipulate AGP mode words.
40  */
41 #define AGP_MODE_GET_RQ(x)              (((x) & 0xff000000U) >> 24)
42 #define AGP_MODE_GET_SBA(x)             (((x) & 0x00000200U) >> 9)
43 #define AGP_MODE_GET_AGP(x)             (((x) & 0x00000100U) >> 8)
44 #define AGP_MODE_GET_4G(x)              (((x) & 0x00000020U) >> 5)
45 #define AGP_MODE_GET_FW(x)              (((x) & 0x00000010U) >> 4)
46 #define AGP_MODE_GET_RATE(x)            ((x) & 0x00000007U)
47 #define AGP_MODE_SET_RQ(x,v)            (((x) & ~0xff000000U) | ((v) << 24))
48 #define AGP_MODE_SET_SBA(x,v)           (((x) & ~0x00000200U) | ((v) << 9))
49 #define AGP_MODE_SET_AGP(x,v)           (((x) & ~0x00000100U) | ((v) << 8))
50 #define AGP_MODE_SET_4G(x,v)            (((x) & ~0x00000020U) | ((v) << 5))
51 #define AGP_MODE_SET_FW(x,v)            (((x) & ~0x00000010U) | ((v) << 4))
52 #define AGP_MODE_SET_RATE(x,v)          (((x) & ~0x00000007U) | (v))
53 #define AGP_MODE_RATE_1x                0x00000001
54 #define AGP_MODE_RATE_2x                0x00000002
55 #define AGP_MODE_RATE_4x                0x00000004
56
57 #define AGPIOC_BASE       'A'
58 #define AGPIOC_INFO       _IOR (AGPIOC_BASE, 0, agp_info)
59 #define AGPIOC_ACQUIRE    _IO  (AGPIOC_BASE, 1)
60 #define AGPIOC_RELEASE    _IO  (AGPIOC_BASE, 2)
61 #define AGPIOC_SETUP      _IOW (AGPIOC_BASE, 3, agp_setup)
62 #if 0
63 #define AGPIOC_RESERVE    _IOW (AGPIOC_BASE, 4, agp_region)
64 #define AGPIOC_PROTECT    _IOW (AGPIOC_BASE, 5, agp_region)
65 #endif
66 #define AGPIOC_ALLOCATE   _IOWR(AGPIOC_BASE, 6, agp_allocate)
67 #define AGPIOC_DEALLOCATE _IOW (AGPIOC_BASE, 7, int)
68 #define AGPIOC_BIND       _IOW (AGPIOC_BASE, 8, agp_bind)
69 #define AGPIOC_UNBIND     _IOW (AGPIOC_BASE, 9, agp_unbind)
70
71 typedef struct _agp_version {
72         u_int16_t major;
73         u_int16_t minor;
74 } agp_version;
75
76 typedef struct _agp_info {
77         agp_version version;    /* version of the driver        */
78         u_int32_t bridge_id;    /* bridge vendor/device         */
79         u_int32_t agp_mode;     /* mode info of bridge          */
80         off_t aper_base;        /* base of aperture             */
81         size_t aper_size;       /* size of aperture             */
82         size_t pg_total;        /* max pages (swap + system)    */
83         size_t pg_system;       /* max pages (system)           */
84         size_t pg_used;         /* current pages used           */
85 } agp_info;
86
87 typedef struct _agp_setup {
88         u_int32_t agp_mode;             /* mode info of bridge          */
89 } agp_setup;
90
91 #if 0
92 /*
93  * The "prot" down below needs still a "sleep" flag somehow ...
94  */
95 typedef struct _agp_segment {
96         off_t pg_start;         /* starting page to populate    */
97         size_t pg_count;        /* number of pages              */
98         int prot;               /* prot flags for mmap          */
99 } agp_segment;
100
101 typedef struct _agp_region {
102         pid_t pid;              /* pid of process               */
103         size_t seg_count;       /* number of segments           */
104         struct _agp_segment *seg_list;
105 } agp_region;
106 #endif
107
108 typedef struct _agp_allocate {
109         int key;                /* tag of allocation            */
110         size_t pg_count;        /* number of pages              */
111         u_int32_t type;         /* 0 == normal, other devspec   */
112         u_int32_t physical;     /* device specific (some devices  
113                                  * need a phys address of the     
114                                  * actual page behind the gatt    
115                                  * table)                        */
116 } agp_allocate;
117
118 typedef struct _agp_bind {
119         int key;                /* tag of allocation            */
120         off_t pg_start;         /* starting page to populate    */
121 } agp_bind;
122
123 typedef struct _agp_unbind {
124         int key;                /* tag of allocation            */
125         u_int32_t priority;     /* priority for paging out      */
126 } agp_unbind;
127
128 #endif /* !_SYS_AGPIO_H_ */