share/man/man9f/usb_get_addr.9f

   1 '\" te
   2 .\" Copyright (c) 2004, 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 USB_GET_ADDR 9F "Sep 16, 2016"
   7 .SH NAME
   8 usb_get_addr \- Retrieve device USB address
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/usb/usba.h>
  13
  14 \fBint\fR \fB\fR\fBusb_get_addr\fR(\fBdev_info_t *\fR\fIdip\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .LP
  19 Solaris DDI specific (Solaris DDI)
  20 .SH PARAMETERS
  21 .ne 2
  22 .na
  23 \fB\fIdip\fR\fR
  24 .ad
  25 .RS 7n
  26 Pointer to the device's dev_info structure.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .LP
  31 The \fBusb_get_addr()\fR function returns the current USB bus address for
  32 debugging  purposes. The returned address is unique for a specific USB bus, and
  33 may be replicated if multiple host controller instances are present on the
  34 system.
  35 .SH RETURN VALUES
  36 .LP
  37 On success: USB device address.
  38 .sp
  39 .LP
  40 On failure: returns 0. Fails if dip is NULL.
  41 .SH CONTEXT
  42 .LP
  43 May be called from user, kernel or interrupt context.
  44 .SH EXAMPLES
  45 .in +2
  46 .nf
  47 int usb_addr;
  48
  49 usb_addr = usb_get_addr(dip);
  50 .fi
  51 .in -2
  52
  53 .SH ATTRIBUTES
  54 .LP
  55 See \fBattributes\fR(5) for descriptions of the following attributes:
  56 .sp
  57
  58 .sp
  59 .TS
  60 box;
  61 c | c
  62 l | l .
  63 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  64 _
  65 Architecture    PCI-based systems
  66 _
  67 Interface stability     Committed
  68 .TE
  69
  70 .SH SEE ALSO
  71 .LP
  72 \fBattributes\fR(5), \fBusb_pipe_xopen\fR(9F)