share/man/man9f/ddi_get_driver_private.9f

   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 DDI_GET_DRIVER_PRIVATE 9F "Jan 16, 2006"
   7 .SH NAME
   8 ddi_get_driver_private, ddi_set_driver_private \- get or set the address of the
   9 device's private data area
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/conf.h>
  14 #include <sys/ddi.h>
  15 #include <sys/sunddi.h>
  16
  17
  18
  19 \fBvoid\fR \fBddi_set_driver_private\fR(\fBdev_info_t *\fR\fIdip\fR, \fBvoid\fR *\fIdata\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR *\fBddi_get_driver_private\fR(\fBdev_info_t *\fR\fIdip\fR);
  25 .fi
  26
  27 .SH INTERFACE LEVEL
  28 .sp
  29 .LP
  30 Solaris DDI specific (Solaris DDI).
  31 .SH PARAMETERS
  32 .sp
  33 .LP
  34 \fBddi_get_driver_private()\fR
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIdip\fR\fR
  39 .ad
  40 .RS 7n
  41 Pointer to device information  structure to get from.
  42 .RE
  43
  44 .sp
  45 .LP
  46 \fBddi_set_driver_private()\fR
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIdip\fR\fR
  51 .ad
  52 .RS 8n
  53 Pointer to device information structure to set.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIdata\fR\fR
  60 .ad
  61 .RS 8n
  62 Data area address to set.
  63 .RE
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBddi_get_driver_private()\fR function returns the address of the device's
  69 private data area from the device information structure pointed to by
  70 \fIdip\fR.
  71 .sp
  72 .LP
  73 The \fBddi_set_driver_private()\fR function sets the address of the device's
  74 private data area in the device information structure pointed to by \fIdip\fR
  75 with the value of \fIdata\fR.
  76 .SH RETURN VALUES
  77 .sp
  78 .LP
  79 The \fBddi_get_driver_private()\fR function returns the contents of
  80 \fBdevi_driver_data\fR. If \fBddi_set_driver_private()\fR has not been
  81 previously called with \fIdip\fR, an unpredictable value is returned.
  82 .SH CONTEXT
  83 .sp
  84 .LP
  85 These functions can be called from user , interrupt, or kernel context.
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fIWriting Device Drivers\fR