agppriv.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/dev/agp/agppriv.h 330897 2018-03-14 03:19:51Z eadler $
29 */
30
31#ifndef _PCI_AGPPRIV_H_
32#define _PCI_AGPPRIV_H_
33
34/*
35 * This file *must not* be included by code outside the agp driver itself.
36 */
37
38#include <sys/agpio.h>
39#include <dev/agp/agpvar.h>
40
41#ifdef AGP_DEBUG
42#define AGP_DPF(fmt, ...) do {				\
43    printf("agp: " fmt, ##__VA_ARGS__);			\
44} while (0)
45#else
46#define AGP_DPF(fmt, ...) do {} while (0)
47#endif
48
49#include "agp_if.h"
50
51/*
52 * Data structure to describe an AGP memory allocation.
53 */
54TAILQ_HEAD(agp_memory_list, agp_memory);
55struct 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 */
69struct 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 mtx		as_lock;	/* lock for access to GATT */
80};
81
82struct agp_gatt {
83	u_int32_t	ag_entries;
84	u_int32_t      *ag_virtual;
85	vm_offset_t	ag_physical;
86};
87
88u_int8_t		agp_find_caps(device_t dev);
89struct agp_gatt	       *agp_alloc_gatt(device_t dev);
90void			agp_set_aperture_resource(device_t dev, int rid);
91void			agp_free_cdev(device_t dev);
92void		        agp_free_gatt(struct agp_gatt *gatt);
93void			agp_free_res(device_t dev);
94int			agp_generic_attach(device_t dev);
95int			agp_generic_detach(device_t dev);
96u_int32_t		agp_generic_get_aperture(device_t dev);
97int			agp_generic_set_aperture(device_t dev,
98						 u_int32_t aperture);
99int			agp_generic_enable(device_t dev, u_int32_t mode);
100struct agp_memory      *agp_generic_alloc_memory(device_t dev, int type,
101						 vm_size_t size);
102int			agp_generic_free_memory(device_t dev,
103						struct agp_memory *mem);
104int			agp_generic_bind_memory(device_t dev,
105						struct agp_memory *mem,
106						vm_offset_t offset);
107int			agp_generic_unbind_memory(device_t dev,
108						  struct agp_memory *mem);
109
110#endif /* !_PCI_AGPPRIV_H_ */
111