xref: /illumos-gate/usr/src/man/man9f/usba_hubdi_dev_ops.9f (revision 31358b0d3ea5b07f4167f88ac393a5eb2a2249d6)
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 -
30illumos USB HCD private function
31.Pp
32This is a private function that is not part of the stable DDI. It may be
33removed or changed at any time.
34.Sh PARAMETERS
35For the parameters of the
36.Fn usba_hubdi_root_hub_power
37function, see
38.Xr power 9E .
39.Sh DESCRIPTION
40The
41.Fn usba_hubdi_root_hub_power
42function is a utility function for the implementation of USB HCD
43drivers. USB HCD drivers that support power management, should use set
44the
45.Sy devo_power
46member of their
47.Xr dev_ops 9S
48structure to the
49.Fn usba_hubdi_root_hub_power
50function. They should not implement their own
51.Xr power 9E
52function.
53.Pp
54In addition, drivers should pass the symbol
55.Sy usba_hubdi_busops
56as the
57.Sy devo_bus_ops
58member. It contains a properly formatted bus operations structure.
59.Sh CONTEXT
60This function should not be called directly, it should only be used as a
61member of a device's
62.Xr dev_ops 9S
63structure.
64.Sh SEE ALSO
65.Xr power 9E ,
66.Xr dev_ops 9S
67