Print this page
12309 errors in section 9e of the manual
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man9e/usba_hcdi_hub_update.9e.man.txt
+++ new/usr/src/man/man9e/usba_hcdi_hub_update.9e.man.txt
1 1 USBA_HCDI_HUB_UPDATE(9E) Driver Entry Points USBA_HCDI_HUB_UPDATE(9E)
2 2
3 3 NAME
4 4 usba_hcdi_hub_update - USB HCD hub update entry point
5 5
6 6 SYNOPSIS
7 7 #include <sys/usb/usba/hcdi.h>
8 8
9 9 int
10 10 prefix_hcdi_hub_update(usba_device_t *ud, uint8_t nports, uint8_t tt);
11 11
12 12 INTERFACE LEVEL
13 13 Volatile - illumos USB HCD private function
14 14
15 15 This is a private function that is not part of the stable DDI. It may be
16 16 removed or changed at any time.
17 17
18 18 PARAMETERS
19 19 ud Pointer to a USB device structure being updated. See
20 20 usba_device(9S) for more information.
21 21
22 22 nports The number of ports present on the hub.
23 23
24 24 tt The value of the Think Time property as defined in the USB
25 25 specification's hub descriptor.
26 26
27 27 DESCRIPTION
28 28 The usba_hcdi_hub_update() entry point is an optional entry point for USB
29 29 host controller drivers. It is used by some controllers to allow them to
30 30 update information about a device in the controller after a device has
31 31 been determined to be a hub during enumeration. If a host controller
32 32 does not need to take any specific action after enumerating a hub, then
33 33 it should simply set this entry point in the usba_hcdi_ops(9S) structure
34 34 to NULL.
35 35
36 36 The nports and tt members provide relevant information from the device's
37 37 hub class descriptor which can be used to help program the host
38 38 controller. Any programming should be performed synchronously and be
39 39 completed before this function returns.
↓ open down ↓ |
39 lines elided |
↑ open up ↑ |
40 40
41 41 This function will be called after usba_hcdi_device_init(9E) has been
42 42 called. Any private data registered with that function will be
43 43 available.
44 44
45 45 If this function fails, the enumeration of this device will fail, the hub
46 46 driver will not attach to this USB device, and all devices plugged into
47 47 this hub will not be detected by the system.
48 48
49 49 CONTEXT
50 - This functin is called from kernel context only.
50 + This function is called from kernel context only.
51 51
52 52 RETURN VALUES
53 53 Upon successful completion, the usba_hcdi_hub_update() function should
54 54 return USB_SUCCESS. Otherwise, it should return the appropriate USB
55 55 error. If uncertain, use USB_FAILURE.
56 56
57 57 SEE ALSO
58 58 usba_hcdi_device_init(9E), usba_device(9S), usba_hcdi_ops(9S)
59 59
60 -illumos December 20, 2016 illumos
60 +illumos February 15, 2020 illumos
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX