| blob | b7c36e80877ed03f12b646f0b432be9db1fad80a |
1 '\" te
2 .\" Copyright (c) 2006, 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_DEVMEM_SETUP 9F "Jun 05, 2006"
7 .SH NAME
8 devmap_devmem_setup, devmap_umem_setup \- set driver memory mapping parameters
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <sys/ddi.h>
13 #include <sys/sunddi.h>
17 \fBint\fR \fBdevmap_devmem_setup\fR(\fBdevmap_cookie_t\fR \fIdhp\fR, \fBdev_info_t *\fR\fIdip\fR,
18 \fBstruct devmap_callback_ctl *\fR\fIcallbackops\fR, \fBuint_t\fR \fIrnumber\fR,
19 \fBoffset_t\fR \fIroff\fR, \fBsize_t\fR \fIlen\fR, \fBuint_t\fR \fImaxprot\fR,
20 \fBuint_t\fR \fIflags\fR, \fBddi_device_acc_attr_t *\fR\fIaccattrp\fR);
21 .fi
23 .LP
24 .nf
25 \fBint\fR \fBdevmap_umem_setup\fR(\fBdevmap_cookie_t\fR \fIdhp\fR, \fBdev_info_t *\fR\fIdip\fR,
26 \fBstruct devmap_callback_ctl *\fR\fIcallbackops\fR, \fBddi_umem_cookie_t\fR \fIcookie\fR,
27 \fBoffset_t\fR \fIkoff\fR, \fBsize_t\fR \fIlen\fR, \fBuint_t\fR \fImaxprot\fR, \fBuint_t\fR \fIflags\fR,
28 \fBddi_device_acc_attr_t *\fR\fIaccattrp\fR);
29 .fi
31 .SH INTERFACE LEVEL
32 .sp
33 .LP
34 Solaris DDI specific (Solaris DDI).
35 .SH PARAMETERS
36 .sp
37 .LP
38 \fBdevmap_devmem_setup()\fR parameters:
39 .sp
40 .ne 2
41 .na
42 \fB\fIdhp\fR\fR
43 .ad
44 .RS 15n
45 An opaque mapping handle that the system uses to describe the mapping.
46 .RE
48 .sp
49 .ne 2
50 .na
51 \fB\fIdip\fR\fR
52 .ad
53 .RS 15n
54 Pointer to the device's \fBdev_info\fR structure.
55 .RE
57 .sp
58 .ne 2
59 .na
60 \fB\fIcallbackops\fR\fR
61 .ad
62 .RS 15n
63 Pointer to a \fBdevmap_callback_ctl\fR(9S) structure. The structure contains
64 pointers to device driver-supplied functions that manage events on the device
65 mapping. The framework will copy the structure to the system private memory.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fIrnumber\fR\fR
72 .ad
73 .RS 15n
74 Index number to the register address space set.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fIroff\fR\fR
81 .ad
82 .RS 15n
83 Offset into the register address space.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fIlen\fR\fR
90 .ad
91 .RS 15n
92 Length (in bytes) of the mapping to be mapped.
93 .RE
95 .sp
96 .ne 2
97 .na
98 \fB\fImaxprot\fR\fR
99 .ad
100 .RS 15n
101 Maximum protection flag possible for attempted mapping. Some combinations of
102 possible settings are:
103 .sp
104 .ne 2
105 .na
106 \fB\fBPROT_READ\fR\fR
107 .ad
108 .RS 14n
109 Read access is allowed.
110 .RE
112 .sp
113 .ne 2
114 .na
115 \fB\fBPROT_WRITE\fR\fR
116 .ad
117 .RS 14n
118 Write access is allowed.
119 .RE
121 .sp
122 .ne 2
123 .na
124 \fB\fBPROT_EXEC\fR\fR
125 .ad
126 .RS 14n
127 Execute access is allowed.
128 .RE
130 .sp
131 .ne 2
132 .na
133 \fB\fBPROT_USER\fR\fR
134 .ad
135 .RS 14n
136 User-level access is allowed. The mapping is done as a result of a
137 \fBmmap\fR(2) system call.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fBPROT_ALL\fR\fR
144 .ad
145 .RS 14n
146 All access is allowed.
147 .RE
149 .RE
151 .sp
152 .ne 2
153 .na
154 \fB\fIflags\fR\fR
155 .ad
156 .RS 15n
157 Used to determine the cache attribute.
158 .sp
159 Possible values of the cache attribute are:
160 .sp
161 .ne 2
162 .na
163 \fB\fBIOMEM_DATA_CACHED\fR\fR
164 .ad
165 .RS 28n
166 The CPU can cache the data it fetches and push it to memory at a later time.
167 This is the default attribute that is used if no cache attributes are
168 specified.
169 .RE
171 .sp
172 .ne 2
173 .na
174 \fB\fBIOMEM_DATA_UC_WR_COMBINE\fR\fR
175 .ad
176 .RS 28n
177 The CPU never caches the data, but writes can occur out of order or can be
178 combined. Reordering is implied.
179 .sp
180 If \fBIOMEM_DATA_UC_WR_COMBINE\fR is specified but not supported,
181 \fBIOMEM_DATA_UNCACHED\fR is used instead.
182 .RE
184 .sp
185 .ne 2
186 .na
187 \fB\fBIOMEM_DATA_UNCACHED\fR\fR
188 .ad
189 .RS 28n
190 The CPU never caches data, but has uncacheable access to memory. Strict
191 ordering is implied.
192 .RE
194 The cache attributes are mutually exclusive. Any combination of the values
195 leads to a failure. On the SPARC architecture, only \fBIOMEM_DATA_CACHED\fR is
196 meaningful. Others lead to a failure.
197 .RE
199 .sp
200 .ne 2
201 .na
202 \fB\fIaccattrp\fR\fR
203 .ad
204 .RS 15n
205 Pointer to a \fBddi_device_acc_attr()\fR structure of the device. See
206 \fBddi_device_acc_attr\fR(9S). The value in \fBdevacc_attr_dataorder\fR is
207 ignored in the current release. The value in \fBdevacc_attr_endian_flags\fR is
208 meaningful on the SPARC architecture only.
209 .RE
211 .sp
212 .LP
213 \fBdevmap_umem_setup()\fR parameters:
214 .sp
215 .ne 2
216 .na
217 \fB\fIdhp\fR\fR
218 .ad
219 .RS 15n
220 An opaque data structure that the system uses to describe the mapping.
221 .RE
223 .sp
224 .ne 2
225 .na
226 \fB\fIdip\fR\fR
227 .ad
228 .RS 15n
229 Pointer to the device's \fBdev_info\fR structure.
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fIcallbackops\fR\fR
236 .ad
237 .RS 15n
238 Pointer to a \fBdevmap_callback_ctl\fR(9S) structure. The structure contains
239 pointers to device driver-supplied functions that manage events on the device
240 mapping.
241 .RE
243 .sp
244 .ne 2
245 .na
246 \fB\fIcookie\fR\fR
247 .ad
248 .RS 15n
249 A kernel memory \fIcookie\fR (see \fBddi_umem_alloc\fR(9F)).
250 .RE
252 .sp
253 .ne 2
254 .na
255 \fB\fIkoff\fR\fR
256 .ad
257 .RS 15n
258 Offset into the kernel memory defined by \fIcookie\fR.
259 .RE
261 .sp
262 .ne 2
263 .na
264 \fB\fIlen\fR\fR
265 .ad
266 .RS 15n
267 Length (in bytes) of the mapping to be mapped.
268 .RE
270 .sp
271 .ne 2
272 .na
273 \fB\fImaxprot\fR\fR
274 .ad
275 .RS 15n
276 Maximum protection flag possible for attempted mapping. Some combinations of
277 possible settings are:
278 .sp
279 .ne 2
280 .na
281 \fB\fBPROT_READ\fR\fR
282 .ad
283 .RS 14n
284 Read access is allowed.
285 .RE
287 .sp
288 .ne 2
289 .na
290 \fB\fBPROT_WRITE\fR\fR
291 .ad
292 .RS 14n
293 Write access is allowed.
294 .RE
296 .sp
297 .ne 2
298 .na
299 \fB\fBPROT_EXEC\fR\fR
300 .ad
301 .RS 14n
302 Execute access is allowed.
303 .RE
305 .sp
306 .ne 2
307 .na
308 \fB\fBPROT_USER\fR\fR
309 .ad
310 .RS 14n
311 User-level access is allowed (the mapping is being done as a result of a
312 \fBmmap\fR(2) system call).
313 .RE
315 .sp
316 .ne 2
317 .na
318 \fB\fBPROT_ALL\fR\fR
319 .ad
320 .RS 14n
321 All access is allowed.
322 .RE
324 .RE
326 .sp
327 .ne 2
328 .na
329 \fB\fIflags\fR\fR
330 .ad
331 .RS 15n
332 Must be set to \fB0\fR.
333 .RE
335 .sp
336 .ne 2
337 .na
338 \fB\fIaccattrp\fR\fR
339 .ad
340 .RS 15n
341 Pointer to a \fBddi_device_acc_attr\fR(9S) structure. Ignored in the current
342 release. Reserved for future use.
343 .RE
345 .SH DESCRIPTION
346 .sp
347 .LP
348 The \fBdevmap_devmem_setup()\fR and \fBdevmap_umem_setup()\fR functions are
349 used in the \fBdevmap\fR(9E) entry point to pass mapping parameters from the
350 driver to the system.
351 .sp
352 .LP
353 The \fIdhp\fR argument specifies a device mapping handle that the system uses
354 to store all mapping parameters of a physical contiguous memory. The system
355 copies the data pointed to by \fIcallbackops\fR to a system private memory.
356 This allows the driver to free the data after returning from either
357 \fBdevmap_devmem_setup()\fR or \fBdevmap_umem_setup()\fR. The driver is
358 notified of user events on the mappings via the entry points defined by
359 \fBdevmap_callback_ctl\fR(9S). The driver is notified of the following user
360 events:
361 .sp
362 .ne 2
363 .na
364 \fBMapping Setup\fR
365 .ad
366 .RS 17n
367 User has called \fBmmap\fR(2) to create a mapping to the device memory.
368 .RE
370 .sp
371 .ne 2
372 .na
373 \fBAccess\fR
374 .ad
375 .RS 17n
376 User has accessed an address in the mapping that has no translations.
377 .RE
379 .sp
380 .ne 2
381 .na
382 \fBDuplication\fR
383 .ad
384 .RS 17n
385 User has duplicated the mapping. Mappings are duplicated when the process calls
386 \fBfork\fR(2).
387 .RE
389 .sp
390 .ne 2
391 .na
392 \fBUnmapping\fR
393 .ad
394 .RS 17n
395 User has called \fBmunmap\fR(2) on the mapping or is exiting, \fBexit\fR(2).
396 .RE
398 .sp
399 .LP
400 See \fBdevmap_map\fR(9E), \fBdevmap_access\fR(9E), \fBdevmap_dup\fR(9E), and
401 \fBdevmap_unmap\fR(9E) for details on these entry points.
402 .sp
403 .LP
404 By specifying a valid \fIcallbackops\fR to the system, device drivers can
405 manage events on a device mapping. For example, the \fBdevmap_access\fR(9E)
406 entry point allows the drivers to perform context switching by unloading the
407 mappings of other processes and to load the mapping of the calling process.
408 Device drivers may specify \fINULL\fR to \fIcallbackops\fR which means the
409 drivers do not want to be notified by the system.
410 .sp
411 .LP
412 The maximum protection allowed for the mapping is specified in \fImaxprot\fR.
413 \fIaccattrp\fR defines the device access attributes. See
414 \fBddi_device_acc_attr\fR(9S) for more details.
415 .sp
416 .LP
417 \fBdevmap_devmem_setup()\fR is used for device memory to map in the register
418 set given by \fIrnumber\fR and the offset into the register address space given
419 by \fIroff\fR. The system uses \fIrnumber\fR and \fIroff\fR to go up the device
420 tree to get the physical address that corresponds to \fIroff\fR. The range to
421 be affected is defined by \fIlen\fR and \fIroff\fR. The range from \fIroff\fR
422 to \fIroff\fR \fI+\fR \fIlen\fR must be a physical contiguous memory and page
423 aligned.
424 .sp
425 .LP
426 Drivers use \fBdevmap_umem_setup()\fR for kernel memory to map in the kernel
427 memory described by \fIcookie\fR and the offset into the kernel memory space
428 given by \fIkoff\fR. \fIcookie\fR is a kernel memory pointer obtained from
429 \fBddi_umem_alloc\fR(9F). If \fIcookie\fR is \fINULL,\fR
430 \fBdevmap_umem_setup()\fR returns \fB-1.\fR The range to be affected is defined
431 by \fIlen\fR and \fIkoff\fR. The range from \fIkoff\fR to \fIkoff\fR \fI+\fR
432 \fIlen\fR must be within the limits of the kernel memory described by
433 \fIkoff\fR \fI+\fR \fIlen\fR and must be page aligned.
434 .sp
435 .LP
436 Drivers use \fBdevmap_umem_setup()\fR to export the kernel memory allocated by
437 \fBddi_umem_alloc\fR(9F) to user space. The system selects a user virtual
438 address that is aligned with the kernel virtual address being mapped to avoid
439 cache incoherence if the mapping is not \fBMAP_FIXED.\fR
440 .SH RETURN VALUES
441 .sp
442 .ne 2
443 .na
444 \fB\fB0\fR\fR
445 .ad
446 .RS 6n
447 Successful completion.
448 .RE
450 .sp
451 .ne 2
452 .na
453 \fB\fB-1\fR\fR
454 .ad
455 .RS 6n
456 An error occurred.
457 .RE
459 .SH CONTEXT
460 .sp
461 .LP
462 \fBdevmap_devmem_setup()\fR and \fBdevmap_umem_setup()\fR can be called from
463 user, kernel, and interrupt context.
464 .SH SEE ALSO
465 .sp
466 .LP
467 \fBexit\fR(2), \fBfork\fR(2), \fBmmap\fR(2), \fBmunmap\fR(2), \fBdevmap\fR(9E),
468 \fBddi_umem_alloc\fR(9F), \fBddi_device_acc_attr\fR(9S),
469 \fBdevmap_callback_ctl\fR(9S)
470 .sp
471 .LP
472 \fIWriting Device Drivers\fR