share/man/man9f/usba_hubdi_dev_ops.9f

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2016 Joyent, Inc.
  13 .\"
  14 .Dd Sep 16, 2016
  15 .Dt USBA_HCDI_DEV_OPS 9F
  16 .Os
  17 .Sh NAME
  18 .Nm usba_hubdi_bus_ops ,
  19 .Nm usba_hubdi_root_hub_power
  20 .Nd device operations utility functions for HCD drivers
  21 .Sh SYNOPSIS
  22 .Ft int
  23 .Fo usba_hubdi_root_hub_power
  24 .Fa "dev_info_t *dip"
  25 .Fa "int component"
  26 .Fa "int level"
  27 .Fc
  28 .Sh INTERFACE LEVEL
  29 .Sy Volatile -
  30 illumos USB HCD private function
  31 .Pp
  32 This is a private function that is not part of the stable DDI.
  33 It may be removed or changed at any time.
  34 .Sh PARAMETERS
  35 For the parameters of the
  36 .Fn usba_hubdi_root_hub_power
  37 function, see
  38 .Xr power 9E .
  39 .Sh DESCRIPTION
  40 The
  41 .Fn usba_hubdi_root_hub_power
  42 function is a utility function for the implementation of USB HCD
  43 drivers.
  44 USB HCD drivers that support power management, should use set the
  45 .Sy devo_power
  46 member of their
  47 .Xr dev_ops 9S
  48 structure to the
  49 .Fn usba_hubdi_root_hub_power
  50 function.
  51 They should not implement their own
  52 .Xr power 9E
  53 function.
  54 .Pp
  55 In addition, drivers should pass the symbol
  56 .Sy usba_hubdi_busops
  57 as the
  58 .Sy devo_bus_ops
  59 member.
  60 It contains a properly formatted bus operations structure.
  61 .Sh CONTEXT
  62 This function should not be called directly, it should only be used as a
  63 member of a device's
  64 .Xr dev_ops 9S
  65 structure.
  66 .Sh SEE ALSO
  67 .Xr power 9E ,
  68 .Xr dev_ops 9S