share/man/man9e/devmap_dup.9e

   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_DUP 9E "Jan 21, 1997"
   7 .SH NAME
   8 devmap_dup \- device mapping duplication entry point
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h
  14
  15
  16
  17 \fB int prefix\fR\fBdevmap_dup\fR(\fBdevmap_cookie_t\fR \fIdhp\fR, \fBvoid *\fR\fIpvtp\fR,
  18      \fBdevmap_cookie_t\fR \fInew_dhp\fR, \fBvoid **\fR\fInew_pvtp\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Solaris DDI specific (Solaris DDI).
  25 .SH ARGUMENTS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIdhp\fR \fR
  30 .ad
  31 .RS 13n
  32 An opaque mapping handle that the system uses to describe the mapping currently
  33 being duplicated.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIpvtp\fR \fR
  40 .ad
  41 .RS 13n
  42 Driver private mapping data for the mapping currently being duplicated.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fInew_dhp\fR \fR
  49 .ad
  50 .RS 13n
  51 An opaque data structure that the system uses to describe the duplicated device
  52 mapping.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fInew_pvtp\fR \fR
  59 .ad
  60 .RS 13n
  61 A pointer to be filled in by device drivers with the driver private mapping
  62 data for the duplicated device mapping.
  63 .RE
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The system calls \fBdevmap_dup()\fR when a device mapping is duplicated, such
  69 as during the execution of the \fBfork\fR(2) system call.  The system expects
  70 \fBdevmap_dup()\fR to generate new driver private data for the new mapping, and
  71 to set \fInew_pvtp\fR to point to it. \fInew_dhp\fR is the handle of the new
  72 mapped object.
  73 .sp
  74 .LP
  75 A non-zero return value from  \fBdevmap_dup()\fR will cause a corresponding
  76 operation such as \fBfork()\fR to fail.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 \fBdevmap_dup()\fR returns the following values:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB0\fR \fR
  85 .ad
  86 .RS 12n
  87 Successful completion.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fBNon-zero\fR
  94 .ad
  95 .RS 12n
  96 An error occurred.
  97 .RE
  98
  99 .SH EXAMPLES
 100 .sp
 101 .in +2
 102 .nf
 103 static int
 104 xxdevmap_dup(devmap_cookie_t dhp, void *pvtp, \e
 105     devmap_cookie_t new_dhp,
 106     void **new_pvtp)
 107 {
 108     struct xxpvtdata    *prvtdata;
 109     struct xxpvtdata    *p = (struct xxpvtdata *)pvtp;
 110     struct xx_softc     *softc = p->softc;
 111     mutex_enter(&softc->mutex);
 112     /* Allocate a new private data structure */
 113     prvtdata = kmem_alloc(sizeof (struct xxpvtdata), KM_SLEEP);
 114     /* Return the new data */
 115     prvtdata->off = p->off;
 116     prvtdata->len = p->len;
 117     prvtdata->ctx = p->ctx;
 118     prvtdata->dhp = new_dhp;
 119     prvtdata->softc = p->softc;
 120     *new_pvtp = prvtdata;
 121     mutex_exit(&softc->mutex);
 122     return (0);
 123 }
 124 .fi
 125 .in -2
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBfork\fR(2), \fBdevmap_callback_ctl\fR(9S)
 131 .sp
 132 .LP
 133 \fIWriting Device Drivers\fR