usr/src/man/man9f/devmap_default_access.9f

   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 DEVMAP_DEFAULT_ACCESS 9F "Jan 14, 1997"
   7 .SH NAME
   8 devmap_default_access \- default driver memory access function
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16 \fBint\fR \fBdevmap_default_access\fR(\fBdevmap_cookie_t\fR \fIdhp\fR, \fBvoid *\fR\fIpvtp\fR,
  17      \fBoffset_t\fR \fIoff\fR, \fBsize_t\fR \fIlen\fR, \fBuint_t\fR \fItype\fR, \fBuint_t\fR \fIrw\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIdhp\fR \fR
  29 .ad
  30 .RS 9n
  31 An opaque mapping handle that the system uses to describe the mapping.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIpvtp\fR \fR
  38 .ad
  39 .RS 9n
  40 Driver private mapping data.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIoff\fR \fR
  47 .ad
  48 .RS 9n
  49 User offset within the logical device memory at which the access begins.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIlen\fR \fR
  56 .ad
  57 .RS 9n
  58 Length (in bytes) of the memory being accessed.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fItype\fR \fR
  65 .ad
  66 .RS 9n
  67 Type of access operation.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIrw\fR \fR
  74 .ad
  75 .RS 9n
  76 Type of access.
  77 .RE
  78
  79 .SH DESCRIPTION
  80 .sp
  81 .LP
  82 \fBdevmap_default_access()\fR is a function providing the semantics of
  83 \fBdevmap_access\fR(9E). The drivers call \fBdevmap_default_access()\fR to
  84 handle the mappings that do not support context switching. The drivers should
  85 call \fBdevmap_do_ctxmgt\fR(9F) for the mappings that support context
  86 management.
  87 .sp
  88 .LP
  89 \fBdevmap_default_access()\fR can either be called from \fBdevmap_access\fR(9E)
  90 or be used as the \fBdevmap_access\fR(9E) entry point. The arguments \fIdhp\fR,
  91 \fIpvtp\fR,  \fIoff\fR,  \fIlen\fR, \fItype\fR,  and \fIrw\fR are provided by
  92 the \fBdevmap_access\fR(9E) entry point and must not be modified.
  93 .SH RETURN VALUES
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB0\fR \fR
  98 .ad
  99 .RS 12n
 100 Successful completion.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBNon-zero\fR\fR
 107 .ad
 108 .RS 12n
 109 An error occurred.
 110 .RE
 111
 112 .SH CONTEXT
 113 .sp
 114 .LP
 115 \fBdevmap_default_access()\fR must be called from the driver's
 116 \fBdevmap_access\fR(9E) entry point.
 117 .SH EXAMPLES
 118 .LP
 119 \fBExample 1 \fRUsing devmap_default_access in devmap_access.
 120 .sp
 121 .LP
 122 The following shows an example of using \fBdevmap_default_access()\fR in the
 123 \fBdevmap_access\fR(9E) entry point.
 124
 125 .sp
 126 .in +2
 127 .nf
 128 \&.\|.\|.
 129 #define OFF_DO_CTXMGT  0x40000000
 130 #define OFF_NORMAL     0x40100000
 131 #define CTXMGT_SIZE    0x100000
 132 #define NORMAL_SIZE    0x100000
 133
 134 /*
 135  * Driver devmap_contextmgt(9E) callback function.
 136  */
 137 static int
 138 xx_context_mgt(devmap_cookie_t dhp, void *pvtp, offset_t offset,
 139     size_t length, uint_t type, uint_t rw)
 140 {
 141     ......
 142     /*
 143      * see devmap_contextmgt(9E) for an example
 144      */
 145 }
 146
 147 /*
 148  * Driver devmap_access(9E) entry point
 149  */
 150 static int
 151 xxdevmap_access(devmap_cookie_t dhp, void *pvtp, offset_t off,
 152     size_t len, uint_t type, uint_t rw)
 153 {
 154     offset_t diff;
 155     int err;
 156
 157     /*
 158      * check if off is within the range that supports
 159      * context management.
 160      */
 161     if ((diff = off - OFF_DO_CTXMG) >= 0 && diff < CTXMGT_SIZE) {
 162         /*
 163          * calculates the length for context switching
 164          */
 165         if ((len + off) > (OFF_DO_CTXMGT + CTXMGT_SIZE))
 166             return (-1);
 167         /*
 168          * perform context switching
 169          */
 170         err = devmap_do_ctxmgt(dhp, pvtp, off, len, type,
 171             rw,  xx_context_mgt);
 172     /*
 173      * check if off is within the range that does normal
 174      * memory mapping.
 175      */
 176     } else if ((diff = off - OFF_NORMAL) >= 0 && diff < NORMAL_SIZE) {
 177         if ((len + off) > (OFF_NORMAL + NORMAL_SIZE))
 178             return (-1);
 179         err = devmap_default_access(dhp, pvtp, off, len, type, rw);
 180     } else
 181         return (-1);
 182
 183     return (err);
 184 }
 185 .fi
 186 .in -2
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBdevmap_access\fR(9E), \fBdevmap_do_ctxmgt\fR(9F),
 192 \fBdevmap_callback_ctl\fR(9S)
 193 .sp
 194 .LP
 195 \fIWriting Device Drivers\fR