8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man9f / csx_RepPut8.9f
blob5145006327a7d1ef94ec01dabf8dc2575fc93def
1 '\" te
2 .\"  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
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 CSX_REPPUT8 9F "Jul 19, 1996"
7 .SH NAME
8 csx_RepPut8, csx_RepPut16, csx_RepPut32, csx_RepPut64 \- write repetitively to
9 the device register
10 .SH SYNOPSIS
11 .LP
12 .nf
13 #include <sys/pccard.h>
17 \fBvoid\fR \fBcsx_RepPut8\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint8_t *\fR\fIhostaddr\fR, \fBuint32_t\fR \fIoffset\fR,
18      \fBuint32_t\fR \fIrepcount\fR, \fBuint32_t\fR \fIflags\fR);
19 .fi
21 .LP
22 .nf
23 \fBvoid\fR \fBcsx_RepPut16\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint16_t *\fR\fIhostaddr\fR, \fBuint32_t\fR \fIoffset\fR,
24      \fBuint32_t\fR \fIrepcount\fR, \fBuint32_t\fR \fIflags\fR);
25 .fi
27 .LP
28 .nf
29 \fBvoid\fR \fBcsx_RepPut32\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint32_t *\fR\fIhostaddr\fR, \fBuint32_t\fR \fIoffset\fR,
30      \fBuint32_t\fR \fIrepcount\fR, \fBuint32_t\fR \fIflags\fR);
31 .fi
33 .LP
34 .nf
35 \fBvoid\fR \fBcsx_RepPut64\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBuint64_t *\fR\fIhostaddr\fR, \fBuint32_t\fR \fIoffset\fR,
36      \fBuint32_t\fR \fIrepcount\fR, \fBuint32_t\fR \fIflags\fR);
37 .fi
39 .SH INTERFACE LEVEL
40 .sp
41 .LP
42 Solaris \fBDDI\fR Specific (Solaris \fBDDI\fR)
43 .SH PARAMETERS
44 .sp
45 .ne 2
46 .na
47 \fB\fIhandle\fR \fR
48 .ad
49 .RS 13n
50 The access handle returned from \fBcsx_RequestIO\fR(9F),
51 \fBcsx_RequestWindow\fR(9F), or \fBcsx_DupHandle\fR(9F).
52 .RE
54 .sp
55 .ne 2
56 .na
57 \fB\fIhostaddr\fR \fR
58 .ad
59 .RS 13n
60 Source host address.
61 .RE
63 .sp
64 .ne 2
65 .na
66 \fB\fIoffset\fR \fR
67 .ad
68 .RS 13n
69 The offset in bytes from the base of the mapped resource.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fIrepcount\fR \fR
76 .ad
77 .RS 13n
78 Number of data accesses to perform.
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fIflags\fR \fR
85 .ad
86 .RS 13n
87 Device address flags.
88 .RE
90 .SH DESCRIPTION
91 .sp
92 .LP
93 These functions generate multiple writes of various sizes to the mapped memory
94 or device register.
95 .sp
96 .LP
97 The \fBcsx_RepPut8()\fR, \fBcsx_RepPut16()\fR, \fBcsx_RepPut32()\fR, and
98 \fBcsx_RepPut64()\fR functions generate \fIrepcount\fR writes of 8 bits, 16
99 bits, 32 bits, and 64 bits of data, respectively, to the device address
100 represented by the handle, \fIhandle\fR, at an offset in bytes represented by
101 the offset, \fIoffset\fR. The data written is read consecutively from the
102 buffer pointed to by the host address pointer, \fIhostaddr\fR.
105 Data that consists of more than one byte will automatically be translated to
106 maintain a consistent view between the host and the device based on the encoded
107 information in the data access handle. The translation may involve byte
108 swapping if the host and the device have incompatible endian characteristics.
111 When the \fIflags\fR argument is set to \fBCS_DEV_AUTOINCR\fR, these functions
112 increment the  device offset, \fIoffset\fR, after each datum write operation.
113 However, when the \fIflags\fR argument is set to \fBCS_DEV_NO_AUTOINCR\fR, the
114 same device offset will be used for every datum access. For example, this flag
115 may be useful when writing to a data register.
116 .SH CONTEXT
119 These functions may be called from user, kernel, or interrupt context.
120 .SH SEE ALSO
123 \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_GetMappedAddr\fR(9F),
124 \fBcsx_Put8\fR(9F), \fBcsx_RepGet8\fR(9F), \fBcsx_RequestIO\fR(9F),
125 \fBcsx_RequestWindow\fR(9F)
128 \fIPC Card 95 Standard\fR, PCMCIA/JEIDA