Merge commit '9276b3991ba20d5a5660887ba81b0bc7bed25a0c'
[unleashed.git] / share / man / man9f / ddi_slaveonly.9f
blobcd7e11d3d3dce1998355e5ed37858a7f0b35d88a
1 '\" te
2 .\" Copyright (c) 2006, Sun Microsystems, Inc.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DDI_SLAVEONLY 9F "Jan 16, 2006"
7 .SH NAME
8 ddi_slaveonly \- tell if a device is installed in a slave access only location
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/conf.h>
13 #include <sys/ddi.h>
14 #include <sys/sunddi.h>
18 \fBint\fR \fBddi_slaveonly\fR(\fBdev_info_t\fR \fI*dip\fR);
19 .fi
21 .SH INTERFACE LEVEL
22 .sp
23 .LP
24 Solaris DDI specific (Solaris DDI).
25 .SH PARAMETERS
26 .sp
27 .ne 2
28 .na
29 \fB\fIdip\fR\fR
30 .ad
31 .RS 7n
32 A pointer to the device's \fBdev_info\fR structure.
33 .RE
35 .SH DESCRIPTION
36 .sp
37 .LP
38 The \fBddi_slaveonly()\fR function tells the caller if the bus, or part of the
39 bus that the device is installed on, does not permit the device to become a DMA
40 master, that is, whether the device has been installed in a slave access only
41 slot.
42 .SH RETURN VALUES
43 .sp
44 .ne 2
45 .na
46 \fB\fBDDI_SUCCESS\fR\fR
47 .ad
48 .RS 15n
49 The device has been installed in a slave access only location.
50 .RE
52 .sp
53 .ne 2
54 .na
55 \fB\fBDDI_FAILURE\fR\fR
56 .ad
57 .RS 15n
58 The device has not been installed in a slave access only location.
59 .RE
61 .SH CONTEXT
62 .sp
63 .LP
64 The \fBddi_slaveonly()\fR function can be called from user, interrupt, or
65 kernel context.
66 .SH SEE ALSO
67 .sp
68 .LP
69 \fIWriting Device Drivers\fR