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
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.
12 .\" Copyright 2016 Joyent, Inc.
15 .Dt USBA_HCDI_HUB_UPDATE 9E
18 .Nm usba_hcdi_hub_update
19 .Nd USB HCD hub update entry point
21 .In sys/usb/usba/hcdi.h
23 .Fo prefix_hcdi_hub_update
24 .Fa "usba_device_t *ud"
30 illumos USB HCD private function
32 This is a private function that is not part of the stable DDI. It may be
33 removed or changed at any time.
37 Pointer to a USB device structure being updated. See
41 The number of ports present on the hub.
43 The value of the Think Time property as defined in the USB
44 specification's hub descriptor.
48 .Fn usba_hcdi_hub_update
49 entry point is an optional entry point for USB host controller drivers.
50 It is used by some controllers to allow them to update information about
51 a device in the controller after a device has been determined to be a
52 hub during enumeration. If a host controller does not need to take any
53 specific action after enumerating a hub, then it should simply set this
63 members provide relevant information from the device's hub class
64 descriptor which can be used to help program the host controller. Any
65 programming should be performed synchronously and be completed before
66 this function returns.
68 This function will be called after
69 .Xr usba_hcdi_device_init 9E
70 has been called. Any private data registered with that function will be
73 If this function fails, the enumeration of this device will fail, the
74 hub driver will not attach to this USB device, and all devices plugged
75 into this hub will not be detected by the system.
77 This functin is called from kernel context only.
79 Upon successful completion, the
80 .Fn usba_hcdi_hub_update
81 function should return
83 Otherwise, it should return the appropriate USB error. If uncertain, use
86 .Xr usba_hcdi_device_init 9E ,