usb/host/xhci.h

4  * xHCI host controller driver
22 /* Code sharing between pci-quirks and xhci hcd */
23 #include	"xhci-ext-caps.h"
26 #include "xhci-port.h"
27 #include "xhci-caps.h"
32 /* xHCI PCI Configuration Registers */
41  * xHCI register interface.
42  * This corresponds to the eXtensible Host Controller Interface (xHCI)
47  * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
55  * @hcc_params2:	HCCPARAMS2 Capability Parameters 2, xhci 1.1 only
65 	__le32	hcc_params2; /* xhci 1.1 */
78  * struct xhci_op_regs - xHCI Host Controller Operational Registers.
127  * The xHCI driver must reinitialize the xHC after setting this bit.
208 /* bit 8: U3 Entry Enabled, assert PLC when root port enters U3, xhci 1.1 */
210 /* bit 9: Configuration Information Enable, xhci 1.1 */
566 	/* xHCI command response timeout in milliseconds */
615 /* Some Intel xHCI host controllers need software to keep track of the bus
702 	struct xhci_hcd		*xhci;  member
779 	 * See xhci 1.1 section 4.8.3 for more details
1051 /* xhci 1.1 uses the TD_SIZE field for TBC if Extended TBC is enabled (ETE) */
1056 /* Total burst count field, Rsvdz on xhci 1.1 with Extended TBC enabled (ETE) */
1330  * xHCI command default timeout value in milliseconds.
1389 	unsigned int		num_trbs_free; /* used only by xhci DbC */
1407 	/* xhci->event_ring keeps track of segment dma addresses */
1477  * Intel Lynx Point LP xHCI host.
1591  * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code.  Any code
1594  * they see this status (any time they drop and re-acquire xhci->lock).
1598  * There are no reports of xHCI host controllers that display this issue.
1671 	/* support xHCI 1.0 spec USB2 hardware LPM */
1699 /* Platform specific overrides to generic XHCI hc_driver ops */
1731 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)  in xhci_to_hcd()  argument
1733 	return xhci->main_hcd;  in xhci_to_hcd()
1736 static inline struct usb_hcd *xhci_get_usb3_hcd(struct xhci_hcd *xhci)  in xhci_get_usb3_hcd()  argument
1738 	if (xhci->shared_hcd)  in xhci_get_usb3_hcd()
1739 		return xhci->shared_hcd;  in xhci_get_usb3_hcd()
1741 	if (!xhci->usb2_rhub.num_ports)  in xhci_get_usb3_hcd()
1742 		return xhci->main_hcd;  in xhci_get_usb3_hcd()
1749 	struct xhci_hcd *xhci = hcd_to_xhci(hcd);  in xhci_hcd_is_usb3()  local
1751 	return hcd == xhci_get_usb3_hcd(xhci);  in xhci_hcd_is_usb3()
1754 static inline bool xhci_has_one_roothub(struct xhci_hcd *xhci)  in xhci_has_one_roothub()  argument
1756 	return xhci->allow_single_roothub &&  in xhci_has_one_roothub()
1757 	       (!xhci->usb2_rhub.num_ports || !xhci->usb3_rhub.num_ports);  in xhci_has_one_roothub()
1760 #define xhci_dbg(xhci, fmt, args...) \  argument
1761 	dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1762 #define xhci_err(xhci, fmt, args...) \  argument
1763 	dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1764 #define xhci_warn(xhci, fmt, args...) \  argument
1765 	dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1766 #define xhci_info(xhci, fmt, args...) \  argument
1767 	dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1772  * Some xHCI implementations may support 64-bit address pointers.  Registers
1775  * xHCI implementations that do not support 64-bit address pointers will ignore
1778 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,  in xhci_read_64()  argument
1783 static inline void xhci_write_64(struct xhci_hcd *xhci,  in xhci_write_64()  argument
1789 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)  in xhci_link_trb_quirk()  argument
1791 	return xhci->quirks & XHCI_LINK_TRB_QUIRK;  in xhci_link_trb_quirk()
1794 /* xHCI debugging */
1795 char *xhci_get_slot_state(struct xhci_hcd *xhci,
1797 void xhci_dbg_trace(struct xhci_hcd *xhci, void (*trace)(struct va_format *),
1800 /* xHCI memory management */
1801 void xhci_mem_cleanup(struct xhci_hcd *xhci);
1802 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
1803 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1804 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags…
1805 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
1806 void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
1810 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_e…
1811 void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
1815 void xhci_update_bw_info(struct xhci_hcd *xhci,
1819 void xhci_endpoint_copy(struct xhci_hcd *xhci,
1823 void xhci_slot_copy(struct xhci_hcd *xhci,
1826 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1829 struct xhci_ring *xhci_ring_alloc(struct xhci_hcd *xhci,
1832 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
1833 int xhci_ring_expansion(struct xhci_hcd *xhci, struct xhci_ring *ring,
1835 int xhci_alloc_erst(struct xhci_hcd *xhci,
1841 void xhci_free_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1842 void xhci_free_endpoint_ring(struct xhci_hcd *xhci,
1845 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1849 void xhci_free_stream_info(struct xhci_hcd *xhci,
1851 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1856 void xhci_free_device_endpoint_resources(struct xhci_hcd *xhci,
1861 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
1863 struct xhci_command *xhci_alloc_command_with_ctx(struct xhci_hcd *xhci,
1866 void xhci_free_command(struct xhci_hcd *xhci,
1868 struct xhci_container_ctx *xhci_alloc_container_ctx(struct xhci_hcd *xhci,
1870 void xhci_free_container_ctx(struct xhci_hcd *xhci,
1873 /* xHCI host controller glue */
1876 void xhci_quiesce(struct xhci_hcd *xhci);
1877 int xhci_halt(struct xhci_hcd *xhci);
1878 int xhci_start(struct xhci_hcd *xhci);
1879 int xhci_reset(struct xhci_hcd *xhci, u64 timeout_us);
1894 int xhci_disable_slot(struct xhci_hcd *xhci, u32 slot_id);
1895 int xhci_ext_cap_init(struct xhci_hcd *xhci);
1897 int xhci_suspend(struct xhci_hcd *xhci, bool do_wakeup);
1898 int xhci_resume(struct xhci_hcd *xhci, pm_message_t msg);
1903 int xhci_alloc_tt_info(struct xhci_hcd *xhci,
1908 /* xHCI ring, segment, TRB, and TD functions */
1910 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
1913 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
1914 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
1915 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
1917 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
1919 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
1921 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
1923 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1925 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1927 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1929 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1931 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
1934 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
1936 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
1939 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
1941 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci, unsigned int slot_id,
1947 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1949 void xhci_ring_doorbell_for_active_rings(struct xhci_hcd *xhci,
1952 void xhci_cleanup_command_queue(struct xhci_hcd *xhci);
1953 void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring);
1957 /* xHCI roothub code */
1958 void xhci_set_link_state(struct xhci_hcd *xhci, struct xhci_port *port,
1960 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, struct xhci_port *port,
1968 void xhci_hc_died(struct xhci_hcd *xhci);
1981 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1983 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
1985 /* xHCI contexts */
1987 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1988 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned…
1990 struct xhci_ring *xhci_triad_to_transfer_ring(struct xhci_hcd *xhci,
1994 static inline struct xhci_ring *xhci_urb_to_transfer_ring(struct xhci_hcd *xhci,  in xhci_urb_to_transfer_ring()  argument
1997 	return xhci_triad_to_transfer_ring(xhci, urb->dev->slot_id,  in xhci_urb_to_transfer_ring()