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