annotate usr/src/man/man9f/outb.9f @ 13866:040f4b0699ee

3301 lapsus calami multum Reviewed by: Richard Lowe <richlowe@richlowe.net> Approved by: Robert Mustacchi <rm@joyent.com>
author Joshua M. Clulow <josh@sysmgr.org>
date Thu, 25 Oct 2012 10:16:36 -0700
parents 5b2854ecc12d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
1 '\" te
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
2 .\" Copyright (c) 2006, Sun Microsystems, Inc., All RIghts Reserved
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
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.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
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.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
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]
13866
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
6 .TH OUTB 9F "Oct 24, 2012"
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
7 .SH NAME
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
8 outb, outw, outl, repoutsb, repoutsw, repoutsd \- write to an I/O port
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
9 .SH SYNOPSIS
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
10 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
11 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
12 #include <sys/ddi.h>
13476
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
13 #include <sys/sunddi.h>
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
14
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
15 \fBvoid\fR \fBoutb\fR(\fBint\fR \fIport\fR, \fBunsigned char\fR \fIvalue\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
16 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
17
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
18 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
19 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
20 \fBvoid\fR \fBoutw\fR(\fBint\fR \fIport\fR, \fBunsigned short\fR \fIvalue\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
21 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
22
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
23 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
24 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
25 \fBvoid\fR \fBoutl\fR(\fBint\fR \fIport\fR, \fBunsigned long\fR \fIvalue\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
26 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
27
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
28 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
29 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
30 \fBvoid\fR \fBrepoutsb\fR(\fBint\fR \fIport\fR, \fBunsigned char *\fR\fIaddr\fR, \fBint\fR \fIcount\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
31 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
32
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
33 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
34 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
35 \fBvoid\fR \fBrepoutsw\fR(\fBint\fR \fIport\fR, \fBunsigned short *\fR\fIaddr\fR, \fBint\fR \fIcount\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
36 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
37
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
38 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
39 .nf
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
40 \fBvoid\fR \fBrepoutsd\fR(\fBint\fR \fIport\fR, \fBunsigned long *\fR\fIaddr\fR, \fBint\fR \fIcount\fR);
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
41 .fi
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
42
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
43 .SH INTERFACE LEVEL
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
44 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
45 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
46 The functions described here are obsolete. For the \fBoutb()\fR, \fBoutw()\fR,
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
47 and \fBoutl()\fR functions use, respectively, \fBddi_put8\fR(9F),
13866
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
48 \fBddi_put16\fR(9F), and \fBddi_put32\fR(9F) instead. For \fBrepoutsb()\fR,
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
49 \fBrepoutsw()\fR, and\fBrepoutsl()\fR, use, respectively,
13866
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
50 \fBddi_rep_put8\fR(9F), \fBddi_rep_put16\fR(9F), and \fBddi_rep_put32\fR(9F)
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
51 instead.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
52 .SH PARAMETERS
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
53 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
54 .ne 2
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
55 .na
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
56 \fB\fIport\fR\fR
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
57 .ad
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
58 .RS 9n
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
59 A valid \fBI/O\fR port address.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
60 .RE
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
61
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
62 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
63 .ne 2
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
64 .na
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
65 \fB\fIvalue\fR\fR
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
66 .ad
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
67 .RS 9n
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
68 The data to be written to the \fBI/O\fR port.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
69 .RE
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
70
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
71 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
72 .ne 2
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
73 .na
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
74 \fB\fIaddr\fR\fR
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
75 .ad
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
76 .RS 9n
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
77 The address of a buffer from which the values will be fetched.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
78 .RE
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
79
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
80 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
81 .ne 2
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
82 .na
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
83 \fB\fIcount\fR\fR
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
84 .ad
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
85 .RS 9n
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
86 The number of values to be written to the \fBI/O\fR port.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
87 .RE
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
88
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
89 .SH DESCRIPTION
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
90 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
91 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
92 These routines write data of various sizes to the \fBI/O\fR port with the
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
93 address specified by \fIport\fR.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
94 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
95 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
96 The \fBoutb()\fR, \fBoutw()\fR, and \fBoutl()\fR functions write 8 bits, 16
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
97 bits, and 32 bits of data respectively, writing the data specified by
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
98 \fIvalue\fR.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
99 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
100 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
101 The \fBrepoutsb()\fR, \fBrepoutsw()\fR, and \fBrepoutsd()\fR functions write
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
102 multiple 8-bit, 16-bit, and 32-bit values, respectively. \fIcount\fR specifies
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
103 the number of values to be written. \fIaddr\fR is a pointer to a buffer from
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
104 which the output values are fetched.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
105 .SH CONTEXT
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
106 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
107 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
108 These functions may be called from user, interrupt, or kernel context.
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
109 .SH ATTRIBUTES
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
110 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
111 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
112 See \fBattributes\fR(5) for descriptions of the following attributes:
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
113 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
114
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
115 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
116 .TS
13476
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
117 box;
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
118 c | c
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
119 l | l .
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
120 ATTRIBUTE TYPE ATTRIBUTE VALUE
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
121 _
13476
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
122 Architecture x86
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
123 _
13476
5b2854ecc12d 1502 Remove conversion cruft from manpages
Yuri Pankov <yuri.pankov@nexenta.com>
parents: 13304
diff changeset
124 Interface Stability Obsolete
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
125 .TE
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
126
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
127 .SH SEE ALSO
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
128 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
129 .LP
13866
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
130 \fBisa\fR(4), \fBattributes\fR(5), \fBddi_put8\fR(9F), \fBddi_put16\fR(9F),
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
131 \fBddi_put32\fR(9F), \fBddi_rep_put8\fR(9F), \fBddi_rep_put16\fR(9F),
040f4b0699ee 3301 lapsus calami multum
Joshua M. Clulow <josh@sysmgr.org>
parents: 13476
diff changeset
132 \fBddi_rep_put32\fR(9F), \fBinb\fR(9F)
13304
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
133 .sp
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
134 .LP
b54231762cfa 243 system manual pages should live with the software
Richard Lowe <richlowe@richlowe.net>
parents:
diff changeset
135 \fIWriting Device Drivers\fR