Print this page
4630 clean stale references to ddi_iopb_alloc and ddi_iopb_free
4634 undocument scsi_hba_attach() and ddi_dma_lim(9s)
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man9f/ddi_iomin.9f
+++ new/usr/src/man/man9f/ddi_iomin.9f
1 1 '\" te
2 2 .\" Copyright (c) 2006, Sun Microsystems, Inc.
3 +.\" Copyright 2014 Pluribus Networks, Inc.
3 4 .\" 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 5 .\" 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 6 .\" 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_IOMIN 9F "Apr 04, 2006"
7 +.TH DDI_IOMIN 9F "Feb 26, 2014"
7 8 .SH NAME
8 9 ddi_iomin \- find minimum alignment and transfer size for DMA
9 10 .SH SYNOPSIS
10 11 .LP
11 12 .nf
12 13 #include <sys/conf.h>
13 14 #include <sys/ddi.h>
14 15 #include <sys/sunddi.h>
15 16
16 17
17 18
18 19 \fBint\fR \fBddi_iomin\fR(\fBdev_info_t *\fR\fIdip\fR, \fBint\fR \fIinitial\fR, \fBint\fR \fIstreaming\fR);
19 20 .fi
20 21
21 22 .SH INTERFACE LEVEL
22 23 .sp
23 24 .LP
24 25 Solaris DDI specific (Solaris DDI). This interface is obsolete.
25 26 .SH PARAMETERS
26 27 .sp
27 28 .ne 2
28 29 .na
29 30 \fB\fIdip\fR\fR
30 31 .ad
↓ open down ↓ |
14 lines elided |
↑ open up ↑ |
31 32 .RS 13n
32 33 A pointer to the device's \fBdev_info\fR structure.
33 34 .RE
34 35
35 36 .sp
36 37 .ne 2
37 38 .na
38 39 \fB\fIinitial\fR\fR
39 40 .ad
40 41 .RS 13n
41 -The initial minimum \fBDMA\fRtransfer size in bytes. This may be zero or an
42 -appropriate \fBdlim_minxfer\fR value for device's \fBddi_dma_lim\fR structure
43 -(see \fBddi_dma_lim_sparc\fR(9S) or \fBddi_dma_lim_x86\fR(9S)). This value must
44 -be a power of two.
42 +The initial minimum \fBDMA\fR transfer size in bytes. This may be zero or an
43 +appropriate \fBdlim_minxfer\fR value for the device's \fBddi_dma_attr\fR
44 +structure (see \fBddi_dma_attr\fR(9S)). This value must be a power of two.
45 45 .RE
46 46
47 47 .sp
48 48 .ne 2
49 49 .na
50 50 \fB\fIstreaming\fR\fR
51 51 .ad
52 52 .RS 13n
53 53 This argument, if non-zero, indicates that the returned value should be
54 54 modified to account for \fIstreaming\fR mode accesses (see
55 55 \fBddi_dma_req\fR(9S) for a discussion of streaming versus non-streaming access
56 56 mode).
57 57 .RE
58 58
59 59 .SH DESCRIPTION
60 60 .sp
61 61 .LP
62 -The \fBddi_iomin()\fR function, finds out the minimum \fBDMA\fRtransfer size
62 +The \fBddi_iomin()\fR function, finds out the minimum \fBDMA\fR transfer size
63 63 for the device pointed to by \fIdip\fR. This provides a mechanism by which a
64 64 driver can determine the effects of underlying caches as well as intervening
65 65 bus adapters on the granularity of a DMA transfer.
66 66 .SH RETURN VALUES
67 67 .sp
68 68 .LP
69 69 The \fBddi_iomin()\fR function returns the minimum \fBDMA\fRtransfer size for
70 70 the calling device, or it returns zero, which means that you cannot get there
71 71 from here.
72 72 .SH CONTEXT
73 73 .sp
74 74 .LP
75 75 This function can be called from user, interrupt, or kernel context.
76 76 .SH ATTRIBUTES
77 77 .sp
78 78 .LP
79 79 See \fBattributes\fR(5) for descriptions of the following attributes:
80 80 .sp
81 81
82 82 .sp
83 83 .TS
84 84 box;
↓ open down ↓ |
12 lines elided |
↑ open up ↑ |
85 85 c | c
86 86 l | l .
87 87 ATTRIBUTE TYPE ATTRIBUTE VALUE
88 88 _
89 89 Interface Stability Obsolete
90 90 .TE
91 91
92 92 .SH SEE ALSO
93 93 .sp
94 94 .LP
95 -\fBddi_dma_devalign\fR(9F), \fBddi_dma_setup\fR(9F), \fBddi_dma_sync\fR(9F),
96 -\fBddi_dma_lim_sparc\fR(9S), \fBddi_dma_lim_x86\fR(9S), \fBddi_dma_req\fR(9S)
95 +\fBddi_dma_attr\fR(9S), \fBddi_dma_sync\fR(9F)
97 96 .sp
98 97 .LP
99 98 \fIWriting Device Drivers\fR
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX