8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man9f / csx_GetMappedAddr.9f
blob133f11ba599cc0160a58cb51da90d095c6fdc452
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_GETMAPPEDADDR 9F "Jul 19, 1996"
7 .SH NAME
8 csx_GetMappedAddr \- return mapped virtual address
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/pccard.h>
16 \fBint32_t\fR \fBcsx_GetMappedAddr\fR(\fBacc_handle_t\fR \fIhandle\fR, \fBvoid **\fR\fIaddr\fR);
17 .fi
19 .SH INTERFACE LEVEL
20 .sp
21 .LP
22 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
23 .SH PARAMETERS
24 .sp
25 .ne 2
26 .na
27 \fB\fIhandle\fR \fR
28 .ad
29 .RS 11n
30 The access handle returned from \fBcsx_RequestIO\fR(9F),
31 \fBcsx_RequestWindow\fR(9F), or \fBcsx_DupHandle\fR(9F).
32 .RE
34 .sp
35 .ne 2
36 .na
37 \fB\fIaddr\fR \fR
38 .ad
39 .RS 11n
40 The virtual or \fBI/O \fRport number represented by the handle.
41 .RE
43 .SH DESCRIPTION
44 .sp
45 .LP
46 This function returns the mapped virtual address or the mapped \fBI/O \fRport
47 number represented by the handle, \fIhandle\fR.
48 .SH RETURN VALUES
49 .sp
50 .ne 2
51 .na
52 \fB\fBCS_SUCCESS\fR \fR
53 .ad
54 .RS 28n
55 The resulting address or \fBI/O \fRport number can be directly accessed by the
56 caller.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fBCS_FAILURE\fR \fR
63 .ad
64 .RS 28n
65 The resulting address or \fBI/O \fRport number can not be directly accessed by
66 the caller; the caller must make all accesses to the mapped area via the common
67 access functions.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
74 .ad
75 .RS 28n
76 No \fBPCMCIA \fRhardware installed.
77 .RE
79 .SH CONTEXT
80 .sp
81 .LP
82 This function may be called from user, kernel, or interrupt context.
83 .SH SEE ALSO
84 .sp
85 .LP
86 \fBcsx_DupHandle\fR(9F), \fBcsx_Get8\fR(9F), \fBcsx_Put8\fR(9F),
87 \fBcsx_RepGet8\fR(9F), \fBcsx_RepPut8\fR(9F), \fBcsx_RequestIO\fR(9F),
88 \fBcsx_RequestWindow\fR(9F)
89 .sp
90 .LP
91 \fIPC Card 95 Standard, PCMCIA/JEIDA\fR