share/man/man9f/devmap_setup.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_SETUP 9F "Jan 22, 1997"
   7 .SH NAME
   8 devmap_setup, ddi_devmap_segmap \- set up a user mapping to device memory using
   9 the devmap framework
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBint\fR \fBdevmap_setup\fR(\fBdev_t\fR \fIdev\fR, \fBoffset_t\fR \fIoff\fR, \fBddi_as_handle_t\fR \fIas\fR,
  19      \fBcaddr_t *\fR\fIaddrp\fR, \fBsize_t\fR\fIlen\fR, \fBuint_t\fR \fIprot\fR, \fBuint_t\fR \fImaxprot\fR,
  20      \fBuint_t\fR \fIflags\fR, \fBcred_t *\fR\fIcred\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBddi_devmap_segmap\fR(\fBdev_t\fR \fIdev\fR, \fBoff_t\fR \fIoff\fR, \fBddi_as_handle_t\fR \fIas\fR,
  26      \fBcaddr_t *\fR\fIaddrp\fR, \fBoff_t\fR\fIlen\fR, \fBuint_t\fR \fIprot\fR, \fBuint_t\fR \fImaxprot\fR,
  27      \fBuint_t\fR \fIflags\fR, \fBcred_t *\fR\fIcred\fR);
  28 .fi
  29
  30 .SH INTERFACE LEVEL
  31 .sp
  32 .LP
  33 Solaris DDI specific (Solaris DDI).
  34 .SH PARAMETERS
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIdev\fR \fR
  39 .ad
  40 .RS 12n
  41 Device whose memory is to be mapped.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fIoff\fR \fR
  48 .ad
  49 .RS 12n
  50 User offset within the logical device memory at which the mapping begins.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIas\fR \fR
  57 .ad
  58 .RS 12n
  59 An opaque data structure that describes the address space into which the device
  60 memory should be mapped.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIaddrp\fR \fR
  67 .ad
  68 .RS 12n
  69 Pointer to the starting address in the address space into which the device
  70 memory should be mapped.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fIlen\fR \fR
  77 .ad
  78 .RS 12n
  79 Length (in bytes) of the memory to be mapped.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fIprot\fR \fR
  86 .ad
  87 .RS 12n
  88 A bit field that specifies the protections. Some possible settings combinations
  89 are:
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBPROT_READ\fR \fR
  94 .ad
  95 .RS 15n
  96 Read access is desired.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBPROT_WRITE\fR \fR
 103 .ad
 104 .RS 15n
 105 Write access is desired.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBPROT_EXEC\fR \fR
 112 .ad
 113 .RS 15n
 114 Execute access is desired.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fBPROT_USER\fR \fR
 121 .ad
 122 .RS 15n
 123 User-level access is desired (the mapping is being done as a result of a
 124 \fBmmap\fR(2) system call).
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBPROT_ALL\fR \fR
 131 .ad
 132 .RS 15n
 133 All access is desired.
 134 .RE
 135
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fImaxprot\fR \fR
 142 .ad
 143 .RS 12n
 144 Maximum protection flag possible for attempted mapping; the \fBPROT_WRITE\fR
 145 bit may be masked out if the user opened the special file read-only.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fIflags\fR \fR
 152 .ad
 153 .RS 12n
 154 Flags indicating type of mapping. The following flags can be specified:
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBMAP_PRIVATE\fR \fR
 159 .ad
 160 .RS 16n
 161 Changes are private.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBMAP_SHARED\fR \fR
 168 .ad
 169 .RS 16n
 170 Changes should be shared.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBMAP_FIXED\fR \fR
 177 .ad
 178 .RS 16n
 179 The user specified an address in  \fI*addrp\fR rather than letting the system
 180 choose an address.
 181 .RE
 182
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fIcred\fR \fR
 189 .ad
 190 .RS 12n
 191 Pointer to the user credential structure.
 192 .RE
 193
 194 .SH DESCRIPTION
 195 .sp
 196 .LP
 197 \fBdevmap_setup()\fR and \fBddi_devmap_segmap()\fR allow device drivers to use
 198 the devmap framework to set up user mappings to device memory.  The devmap
 199 framework provides several advantages over the default device mapping framework
 200 that is used by \fBddi_segmap\fR(9F) or \fBddi_segmap_setup\fR(9F). Device
 201 drivers should use the devmap framework, if the driver wants to:
 202 .RS +4
 203 .TP
 204 .ie t \(bu
 205 .el o
 206 use an optimal MMU pagesize to minimize address translations,
 207 .RE
 208 .RS +4
 209 .TP
 210 .ie t \(bu
 211 .el o
 212 conserve kernel resources,
 213 .RE
 214 .RS +4
 215 .TP
 216 .ie t \(bu
 217 .el o
 218 receive callbacks to manage events on the mapping,
 219 .RE
 220 .RS +4
 221 .TP
 222 .ie t \(bu
 223 .el o
 224 export kernel memory to applications,
 225 .RE
 226 .RS +4
 227 .TP
 228 .ie t \(bu
 229 .el o
 230 set up device contexts for the user mapping if the device requires context
 231 switching,
 232 .RE
 233 .RS +4
 234 .TP
 235 .ie t \(bu
 236 .el o
 237 assign device access attributes to the user mapping, or
 238 .RE
 239 .RS +4
 240 .TP
 241 .ie t \(bu
 242 .el o
 243 change the maximum protection for the mapping.
 244 .RE
 245 .sp
 246 .LP
 247 \fBdevmap_setup()\fR must be called in the \fBsegmap\fR(9E) entry point to
 248 establish the mapping for the application. \fBddi_devmap_segmap()\fR can be
 249 called in, or be used as, the \fBsegmap\fR(9E) entry point. The differences
 250 between  \fBdevmap_setup()\fR and \fBddi_devmap_segmap()\fR are in the data
 251 type used for \fIoff\fR and \fIlen\fR.
 252 .sp
 253 .LP
 254 When setting up the mapping,  \fBdevmap_setup()\fR and
 255 \fBddi_devmap_segmap()\fR call the \fBdevmap\fR(9E) entry point to validate the
 256 range to be mapped. The \fBdevmap\fR(9E) entry point also translates the
 257 logical offset (as seen by the application) to the corresponding physical
 258 offset within the device address space. If the driver does not provide its own
 259 \fBdevmap\fR(9E) entry point, \fBEINVAL\fR will be returned to the
 260 \fBmmap\fR(2) system call.
 261 .SH RETURN VALUES
 262 .sp
 263 .ne 2
 264 .na
 265 \fB\fB0\fR \fR
 266 .ad
 267 .RS 12n
 268 Successful completion.
 269 .RE
 270
 271 .sp
 272 .ne 2
 273 .na
 274 \fB\fBNon-zero\fR\fR
 275 .ad
 276 .RS 12n
 277 An error occurred.  The return value of \fBdevmap_setup()\fR and
 278 \fBddi_devmap_segmap()\fR should be used directly in the  \fBsegmap\fR(9E)
 279 entry point.
 280 .RE
 281
 282 .SH CONTEXT
 283 .sp
 284 .LP
 285 \fBdevmap_setup()\fR and \fBddi_devmap_segmap()\fR can be called from user or
 286 kernel context only.
 287 .SH SEE ALSO
 288 .sp
 289 .LP
 290 \fBmmap\fR(2), \fBdevmap\fR(9E), \fBsegmap\fR(9E), \fBddi_segmap\fR(9F),
 291 \fBddi_segmap_setup\fR(9F), \fBcb_ops\fR(9S)
 292 .sp
 293 .LP
 294 \fIWriting Device Drivers\fR