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