usr/src/man/man9s/devmap_callback_ctl.9s

   1 '\" te
   2 .\"  Copyright (c) 2000, 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_CALLBACK_CTL 9S "Jul 24, 1996"
   7 .SH NAME
   8 devmap_callback_ctl \- device mapping-control structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddidevmap.h>
  13 .fi
  14
  15 .SH INTERFACE LEVEL
  16 .sp
  17 .LP
  18 Solaris DDI specific (Solaris DDI).
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 A \fBdevmap_callback_ctl\fR structure describes a set of callback routines that
  23 are called by  the system to notify a device driver to manage events on  the
  24 device mappings created by \fBdevmap_setup\fR(9F) or
  25 \fBddi_devmap_segmap\fR(9F).
  26 .sp
  27 .LP
  28 Device drivers pass the initialized \fBdevmap_callback_ctl\fR structure to
  29 either \fBdevmap_devmem_setup\fR(9F) or \fBdevmap_umem_setup\fR(9F) in the
  30 \fBdevmap\fR(9E) entry point during the mapping setup.  The system makes a
  31 private copy of the structure for later use. Device drivers can specify
  32 different \fBdevmap_callback_ctl\fR for different mappings.
  33 .sp
  34 .LP
  35 A device driver should allocate the device mapping control structure and
  36 initialize the following fields, if the driver wants the entry points to be
  37 called by the system:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBdevmap_rev\fR \fR
  42 .ad
  43 .RS 18n
  44 Version number. Set this to \fBDEVMAP_OPS_REV\fR.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBdevmap_map\fR \fR
  51 .ad
  52 .RS 18n
  53 Set to the address of the \fBdevmap_map\fR(9E) entry point or to  \fINULL\fR if
  54 the driver does not support this callback. If set, the system calls the
  55 \fBdevmap_map\fR(9E) entry point during the \fBmmap\fR(2) system call.  The
  56 drivers typically allocate driver private data structure in this function and
  57 return the pointer to the private data structure to the system for later use.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBdevmap_access\fR \fR
  64 .ad
  65 .RS 18n
  66 Set to the address of the \fBdevmap_access\fR(9E) entry point or to  \fINULL\fR
  67 if the driver does not support this callback. If set, the system calls the
  68 driver's \fBdevmap_access\fR(9E) entry point during memory access.  The system
  69 expects \fBdevmap_access\fR(9E) to call either \fBdevmap_do_ctxmgt\fR(9F) or
  70 \fBdevmap_default_access\fR(9F) to load the memory address translations before
  71 it returns to the system.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBdevmap_dup\fR \fR
  78 .ad
  79 .RS 18n
  80 Set to the address of the \fBdevmap_dup\fR(9E) entry point or to  \fINULL\fR if
  81 the driver does not support this call. If set, the system calls the
  82 \fBdevmap_dup\fR(9E) entry point during the \fBfork\fR(2) system call.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBdevmap_unmap\fR \fR
  89 .ad
  90 .RS 18n
  91 Set to the address of the \fBdevmap_unmap\fR(9E) entry point or to  \fINULL\fR
  92 if the driver does not support this call. If set, the system will call the
  93 \fBdevmap_unmap\fR(9E) entry point during the \fBmunmap\fR(2) or \fBexit\fR(2)
  94 system calls.
  95 .RE
  96
  97 .SH STRUCTURE MEMBERS
  98 .sp
  99 .in +2
 100 .nf
 101 int     devmap_rev;
 102 int     (*devmap_map)(devmap_cookie_t dhp, dev_t dev,
 103      uint_t flags,offset_t off, size_t len, void **pvtp);
 104 int     (*devmap_access)(devmap_cookie_t dhp, void *pvtp,
 105      offset_t off, size_t len, uint_t type, uint_t rw);
 106 int     (*devmap_dup)(devmap_cookie_t dhp, void *pvtp,
 107                    devmap_cookie_t new_dhp, void **new_pvtp);
 108 void    (*devmap_unmap)(devmap_cookie_t dhp, void *pvtp,
 109      offset_t off, size_t len, devmap_cookie_t new_dhp1,
 110      void **new_pvtp1, devmap_cookie_t new_dhp2, void **new_pvtp2);
 111 .fi
 112 .in -2
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBexit\fR(2), \fBfork\fR(2), \fBmmap\fR(2), \fBmunmap\fR(2), \fBdevmap\fR(9E),
 118 \fBdevmap_access\fR(9E), \fBdevmap_dup\fR(9E), \fBdevmap_map\fR(9E),
 119 \fBdevmap_unmap\fR(9E), \fBddi_devmap_segmap\fR(9F),
 120 \fBdevmap_default_access\fR(9F), \fBdevmap_devmem_setup\fR(9F),
 121 \fBdevmap_do_ctxmgt\fR(9F), \fBdevmap_setup\fR(9F), \fBdevmap_umem_setup\fR(9F)
 122 .sp
 123 .LP
 124 \fIWriting Device Drivers\fR