usr/src/man/man9f/ldi_get_dev.9f

   1 '\" te
   2 .\"  Copyright (c) 2003, 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 LDI_GET_DEV 9F "Jun 3, 2003"
   7 .SH NAME
   8 ldi_get_dev, ldi_get_otyp, ldi_get_devid, ldi_get_minor_name \- Extract
   9 information from a layered handle
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/sunldi.h>
  14
  15 \fBint\fR \fBldi_get_dev\fR(\fBldi_handle_t lh\fR, \fBdev_t *\fR\fIdevp\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBldi_get_otyp\fR(\fBldi_handle_t lh\fR, \fBint *\fR\fIotyp\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBldi_get_devid\fR(\fBldi_handle_t lh\fR, \fBddi_devid_t *\fR\fIdevid\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBldi_get_minor_name\fR(\fBldi_handle_t lh\fR, \fBchar **\fR\fIminor_name\fR);
  31 .fi
  32
  33 .SH PARAMETERS
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIlh\fR \fR
  38 .ad
  39 .RS 15n
  40 Layered handle
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIotyp\fR \fR
  47 .ad
  48 .RS 15n
  49 Indicates on which interface the driver was opened. Valid settings are:
  50 .sp
  51 .ne 2
  52 .na
  53 \fBOTYP_BLK\fR
  54 .ad
  55 .RS 12n
  56 Open device block interface.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fBOTYP_CHR\fR
  63 .ad
  64 .RS 12n
  65 Open device character interface.
  66 .RE
  67
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIdevp\fR \fR
  74 .ad
  75 .RS 15n
  76 Pointer to a device number.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIdevid\fR \fR
  83 .ad
  84 .RS 15n
  85 Device ID.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIminor_name\fR \fR
  92 .ad
  93 .RS 15n
  94 Minor device node name.
  95 .RE
  96
  97 .SH DESCRIPTION
  98 .sp
  99 .LP
 100 The \fBldi_get_dev()\fR function retrieves the \fBdev_t\fR associated with a
 101 layered handle.
 102 .sp
 103 .LP
 104 The \fBldi_get_otyp()\fR retrieves the open flag that was used to open the
 105 device associated with the layered handle.
 106 .sp
 107 .LP
 108 The \fBldi_get_devid()\fR function retrieves a \fIdevid\fR for the device
 109 associated with the layered handle. The caller  should use
 110 \fBddi_devid_free()\fR to free the devid when done with it.
 111 .sp
 112 .LP
 113 The \fBldi_get_minor_name()\fR function retrieves the name of the minor node
 114 opened for the device associated with the layered handle.
 115 \fBldi_get_minor_name()\fR allocates a buffer containing the minor node name
 116 and returns it via the \fIminor_name\fR parameter. The caller should use
 117 \fBkmem_free()\fR to release the buffer when done with it.
 118 .SH RETURN VALUES
 119 .sp
 120 .LP
 121 The \fBldi_get_dev()\fR, \fBldi_get_otyp()\fR, \fBldi_get_devid()\fR, and
 122 \fBldi_get_devid()\fR functions return \fB0\fR upon success.
 123 .sp
 124 .LP
 125 In case of an error, the following values may be returned:
 126 .sp
 127 .ne 2
 128 .na
 129 \fBEINVAL\fR
 130 .ad
 131 .RS 11n
 132 Invalid input parameters.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fBENOTSUP\fR
 139 .ad
 140 .RS 11n
 141 The operation is not supported for this device.
 142 .RE
 143
 144 .SH CONTEXT
 145 .sp
 146 .LP
 147 These functions may be called from user or kernel context.