xref: /freebsd/sys/isa/isa_if.m (revision f9ce010afdd3136fc73e2b500f2ed916bf9cfa59)
1#
2# Copyright (c) 1999 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$
27#
28
29CODE {
30#include <isa/isavar.h>
31};
32
33INTERFACE isa;
34
35#
36# Set the range used for a particular resource. Return EINVAL if
37# the type or rid are out of range.
38#
39METHOD int set_resource {
40	device_t	dev;
41	device_t	child;
42	int		type;
43	int		rid;
44	u_long		start;
45	u_long		count;
46};
47
48#
49# Get the range for a resource. Return ENOENT if the type or rid are
50# out of range or have not been set.
51#
52METHOD int get_resource {
53	device_t	dev;
54	device_t	child;
55	int		type;
56	int		rid;
57	u_long		*startp;
58	u_long		*countp;
59};
60
61#
62# Delete a resource.
63#
64METHOD void delete_resource {
65	device_t	dev;
66	device_t	child;
67	int		type;
68	int		rid;
69};
70
71#
72# Add a Plug-and-play configuration to the device. Configurations with
73# a lower priority are preferred.
74#
75METHOD int add_config {
76	device_t	dev;
77	device_t	child;
78	int		priority;
79	struct isa_config *config;
80};
81
82#
83# Register a function which can be called to configure a device with
84# a given set of resources. The function will be called with a struct
85# isa_config representing the desired configuration and a flag to
86# state whether the device should be enabled.
87#
88METHOD void set_config_callback {
89	device_t	dev;
90	device_t	child;
91	isa_config_cb	*fn;
92	void		*arg;
93};
94
95#
96# A helper method for implementing probe methods for PnP compatible
97# drivers. The driver calls this method with a list of PnP ids and
98# descriptions and it returns zero if one of the ids matches or ENXIO
99# otherwise.
100#
101# If the device is not plug-and-play compatible, this method returns
102# ENOENT, allowing the caller to fall back to heuristic probing
103# techniques.
104#
105METHOD int pnp_probe {
106	device_t	dev;
107	device_t	child;
108	struct isa_pnp_id *ids;
109};
110