hub.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * usb hub driver head file
  4. *
  5. * Copyright (C) 1999 Linus Torvalds
  6. * Copyright (C) 1999 Johannes Erdfelt
  7. * Copyright (C) 1999 Gregory P. Smith
  8. * Copyright (C) 2001 Brad Hards (bhards@bigpond.net.au)
  9. * Copyright (C) 2012 Intel Corp (tianyu.lan@intel.com)
  10. *
  11. * move struct usb_hub to this file.
  12. */
  13. #include <linux/usb.h>
  14. #include <linux/usb/ch11.h>
  15. #include <linux/usb/hcd.h>
  16. #include "usb.h"
  17. struct usb_hub {
  18. struct device *intfdev; /* the "interface" device */
  19. struct usb_device *hdev;
  20. struct kref kref;
  21. struct urb *urb; /* for interrupt polling pipe */
  22. /* buffer for urb ... with extra space in case of babble */
  23. u8 (*buffer)[8];
  24. union {
  25. struct usb_hub_status hub;
  26. struct usb_port_status port;
  27. } *status; /* buffer for status reports */
  28. struct mutex status_mutex; /* for the status buffer */
  29. int error; /* last reported error */
  30. int nerrors; /* track consecutive errors */
  31. unsigned long event_bits[1]; /* status change bitmask */
  32. unsigned long change_bits[1]; /* ports with logical connect
  33. status change */
  34. unsigned long removed_bits[1]; /* ports with a "removed"
  35. device present */
  36. unsigned long wakeup_bits[1]; /* ports that have signaled
  37. remote wakeup */
  38. unsigned long power_bits[1]; /* ports that are powered */
  39. unsigned long child_usage_bits[1]; /* ports powered on for
  40. children */
  41. unsigned long warm_reset_bits[1]; /* ports requesting warm
  42. reset recovery */
  43. #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
  44. #error event_bits[] is too short!
  45. #endif
  46. struct usb_hub_descriptor *descriptor; /* class descriptor */
  47. struct usb_tt tt; /* Transaction Translator */
  48. unsigned mA_per_port; /* current for each child */
  49. #ifdef CONFIG_PM
  50. unsigned wakeup_enabled_descendants;
  51. #endif
  52. unsigned limited_power:1;
  53. unsigned quiescing:1;
  54. unsigned disconnected:1;
  55. unsigned in_reset:1;
  56. unsigned quirk_disable_autosuspend:1;
  57. unsigned quirk_check_port_auto_suspend:1;
  58. unsigned has_indicators:1;
  59. u8 indicator[USB_MAXCHILDREN];
  60. struct delayed_work leds;
  61. struct delayed_work init_work;
  62. struct work_struct events;
  63. spinlock_t irq_urb_lock;
  64. struct timer_list irq_urb_retry;
  65. struct usb_port **ports;
  66. };
  67. /**
  68. * struct usb port - kernel's representation of a usb port
  69. * @child: usb device attached to the port
  70. * @dev: generic device interface
  71. * @port_owner: port's owner
  72. * @peer: related usb2 and usb3 ports (share the same connector)
  73. * @req: default pm qos request for hubs without port power control
  74. * @connect_type: port's connect type
  75. * @location: opaque representation of platform connector location
  76. * @status_lock: synchronize port_event() vs usb_port_{suspend|resume}
  77. * @portnum: port index num based one
  78. * @is_superspeed cache super-speed status
  79. * @usb3_lpm_u1_permit: whether USB3 U1 LPM is permitted.
  80. * @usb3_lpm_u2_permit: whether USB3 U2 LPM is permitted.
  81. */
  82. struct usb_port {
  83. struct usb_device *child;
  84. struct device dev;
  85. struct usb_dev_state *port_owner;
  86. struct usb_port *peer;
  87. struct dev_pm_qos_request *req;
  88. enum usb_port_connect_type connect_type;
  89. usb_port_location_t location;
  90. struct mutex status_lock;
  91. u32 over_current_count;
  92. u8 portnum;
  93. u32 quirks;
  94. unsigned int is_superspeed:1;
  95. unsigned int usb3_lpm_u1_permit:1;
  96. unsigned int usb3_lpm_u2_permit:1;
  97. };
  98. #define to_usb_port(_dev) \
  99. container_of(_dev, struct usb_port, dev)
  100. extern int usb_hub_create_port_device(struct usb_hub *hub,
  101. int port1);
  102. extern void usb_hub_remove_port_device(struct usb_hub *hub,
  103. int port1);
  104. extern int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
  105. int port1, bool set);
  106. extern struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev);
  107. extern int hub_port_debounce(struct usb_hub *hub, int port1,
  108. bool must_be_connected);
  109. extern int usb_clear_port_feature(struct usb_device *hdev,
  110. int port1, int feature);
  111. static inline bool hub_is_port_power_switchable(struct usb_hub *hub)
  112. {
  113. __le16 hcs;
  114. if (!hub)
  115. return false;
  116. hcs = hub->descriptor->wHubCharacteristics;
  117. return (le16_to_cpu(hcs) & HUB_CHAR_LPSM) < HUB_CHAR_NO_LPSM;
  118. }
  119. static inline int hub_is_superspeed(struct usb_device *hdev)
  120. {
  121. return hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS;
  122. }
  123. static inline int hub_is_superspeedplus(struct usb_device *hdev)
  124. {
  125. return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS &&
  126. le16_to_cpu(hdev->descriptor.bcdUSB) >= 0x0310 &&
  127. hdev->bos->ssp_cap);
  128. }
  129. static inline unsigned hub_power_on_good_delay(struct usb_hub *hub)
  130. {
  131. unsigned delay = hub->descriptor->bPwrOn2PwrGood * 2;
  132. if (!hub->hdev->parent) /* root hub */
  133. return delay;
  134. else /* Wait at least 100 msec for power to become stable */
  135. return max(delay, 100U);
  136. }
  137. static inline int hub_port_debounce_be_connected(struct usb_hub *hub,
  138. int port1)
  139. {
  140. return hub_port_debounce(hub, port1, true);
  141. }
  142. static inline int hub_port_debounce_be_stable(struct usb_hub *hub,
  143. int port1)
  144. {
  145. return hub_port_debounce(hub, port1, false);
  146. }