Add usb2 link powermanagement BESL support
Subsystems (2)
v3 cover Add usb2 link powermanagement BESL support
This series adds usb2 best effort service latency (BESL) link PM support to xHCI. BESL is an updated alternative to host initated resume delay (HIRD) method of describing idle link timeouts.
Additionally this series fixes port capability checking and replaces magic numbers with port register names.
Changes since v1:
-Use kstrto* and unsigned values in sysfs functions as Alan Stern suggested
Changes since v2:
- Add Documentation/ABI/testing/sysfs-bus-usb entries for new sysfs attributes
- store l1_timeout value in microseconds instead of xHCI specific values
Mathias Nyman (4):
usb: xhci: check usb2 port capabilities before adding hw link PM
support
usb: xhci: define port register names and use them instead of magic
numbers
usb: xhci: add USB2 Link power management BESL support
usb: add usb2 Link PM variables to sysfs and usb_device
Documentation/ABI/testing/sysfs-bus-usb | 27 ++++ drivers/usb/core/sysfs.c | 54 +++++++ drivers/usb/host/xhci-ext-caps.h | 1 + drivers/usb/host/xhci-hub.c | 16 +-- drivers/usb/host/xhci-mem.c | 33 ++++- drivers/usb/host/xhci.c | 237 ++++++++++++++++++++++--------- drivers/usb/host/xhci.h | 29 ++++ include/linux/usb.h | 20 +++ 8 files changed, 337 insertions(+), 80 deletions(-)
Signature · 1 line
1.7.4.1
RFC PATCH v3 1/4 usb: xhci: check usb2 port capabilities before adding hw link PM support
Hardware link powermanagement in usb2 is a per-port capability. Previously support for hw lpm was enabled for all ports if any usb2 port supported it.
Now instead cache the capability values and check them for each port individually
--- drivers/usb/host/xhci-mem.c | 33 +++++++++++++++++++++++++++++---- drivers/usb/host/xhci.c | 27 ++++++++++++++++++++++++++- drivers/usb/host/xhci.h | 3 +++ 3 files changed, 58 insertions(+), 5 deletions(-)
drivers/usb/host/xhci-mem.c +29 -4
@@ -1851,6 +1851,7 @@ void xhci_mem_cleanup(struct xhci_hcd *xhci)kfree (xhci->usb3_ports);kfree (xhci->port_array);kfree (xhci->rh_bw); +kfree (xhci->ext_caps); xhci->page_size =0 ; xhci->page_shift =0 ;
@@ -2038,7 +2039,7 @@ static void xhci_set_hc_event_deq(struct xhci_hcd *xhci) }static void xhci_add_in_port (struct xhci_hcd *xhci,unsigned int num_ports, -__le32 __iomem *addr,u8 major_revision) +__le32 __iomem *addr,u8 major_revision,int max_caps) {u32 temp, port_offset, port_count;int i;
@@ -2063,6 +2064,10 @@ static void xhci_add_in_port(struct xhci_hcd *xhci, unsigned int num_ports,/* WTF? "Valid values are ‘1’ to MaxPorts" */ return ; +/* cache usb2 port capabilities */ +if (major_revision <0x03 && xhci->num_ext_caps < max_caps) + xhci->ext_caps[xhci->num_ext_caps++] = temp; +/* Check the host's USB2 LPM capability */ if ((xhci->hci_version ==0x96 ) && (major_revision !=0x03 ) && (temp &XHCI_L1C )) {
@@ -2120,10 +2125,11 @@ static void xhci_add_in_port(struct xhci_hcd *xhci, unsigned int num_ports,*/ static int xhci_setup_port_arrays (struct xhci_hcd *xhci,gfp_t flags) { -__le32 __iomem *addr; -u32 offset; +__le32 __iomem *addr, *tmp_addr; +u32 offset, tmp_offset;unsigned int num_ports;int i, j, port_index; +int cap_count =0 ; addr = &xhci->cap_regs->hcc_params; offset =XHCI_HCC_EXT_CAPS (xhci_readl (xhci, addr));
@@ -2156,13 +2162,32 @@ static int xhci_setup_port_arrays(struct xhci_hcd *xhci, gfp_t flags)* See section 5.3.6 for offset calculation. */ addr = &xhci->cap_regs->hc_capbase + offset; + + tmp_addr = addr; + tmp_offset = offset; + +/* count extended protocol capability entries for later caching */ +do { +u32 cap_id; + cap_id =xhci_readl (xhci, tmp_addr); +if (XHCI_EXT_CAPS_ID (cap_id) ==XHCI_EXT_CAPS_PROTOCOL ) + cap_count++; + tmp_offset =XHCI_EXT_CAPS_NEXT (cap_id); + tmp_addr += tmp_offset; + }while (tmp_offset); + + xhci->ext_caps =kzalloc (sizeof (*xhci->ext_caps) * cap_count, flags); +if (!xhci->ext_caps) +return -ENOMEM ; +while (1 ) {u32 cap_id; cap_id =xhci_readl (xhci, addr);if (XHCI_EXT_CAPS_ID (cap_id) ==XHCI_EXT_CAPS_PROTOCOL )xhci_add_in_port (xhci, num_ports, addr, - (u8 )XHCI_EXT_PORT_MAJOR (cap_id)); + (u8 )XHCI_EXT_PORT_MAJOR (cap_id), + cap_count); offset =XHCI_EXT_CAPS_NEXT (cap_id);if (!offset || (xhci->num_usb2_ports + xhci->num_usb3_ports) == num_ports)
drivers/usb/host/xhci.c +26 -1
@@ -4023,15 +4023,40 @@ int xhci_set_usb2_hardware_lpm(struct usb_hcd *hcd,return 0 ; } +/* check if a usb2 port supports a given extened capability protocol +* only USB2 ports extended protocol capability values are cached. +* Return 1 if capability is supported +*/ +static int xhci_check_usb2_port_capability (struct xhci_hcd *xhci,int port, +unsigned capability) +{ +u32 port_offset, port_count; +int i; + +for (i =0 ; i < xhci->num_ext_caps; i++) { +if (xhci->ext_caps[i] & capability) { +/* port offsets starts at 1 */ + port_offset =XHCI_EXT_PORT_OFF (xhci->ext_caps[i]) -1 ; + port_count =XHCI_EXT_PORT_COUNT (xhci->ext_caps[i]); +if (port >= port_offset && + port < port_offset + port_count) +return 1 ; + } + } +return 0 ; +} +int xhci_update_device (struct usb_hcd *hcd,struct usb_device *udev) {struct xhci_hcd *xhci =hcd_to_xhci (hcd);int ret; +int portnum = udev->portnum -1 ; ret =xhci_usb2_software_lpm_test (hcd, udev);if (!ret) {xhci_dbg (xhci,"software LPM test succeed\n" ); -if (xhci->hw_lpm_support ==1 ) { +if (xhci->hw_lpm_support ==1 && +xhci_check_usb2_port_capability (xhci, portnum,XHCI_HLC )) { udev->usb2_hw_lpm_capable =1 ; ret =xhci_set_usb2_hardware_lpm (hcd, udev,1 );if (!ret)
drivers/usb/host/xhci.h +3 -0
@@ -1532,6 +1532,9 @@ struct xhci_hcd { unsigned sw_lpm_support:1;/* support xHCI 1.0 spec USB2 hardware LPM */ unsigned hw_lpm_support:1; +/* cached usb2 extened protocol capabilites */ +u32 *ext_caps; +unsigned int num_ext_caps;/* Compliance Mode Recovery Data */ struct timer_list comp_mode_recovery_timer;u32 port_status_u0;
Signature · 1 line
1.7.4.1
RFC PATCH v3 2/4 usb: xhci: define port register names and use them instead of magic numbers
In reply to Mathias Nyman--- drivers/usb/host/xhci-hub.c | 16 +++++++--------- drivers/usb/host/xhci.c | 4 ++-- drivers/usb/host/xhci.h | 5 +++++ 3 files changed, 14 insertions(+), 11 deletions(-)
drivers/usb/host/xhci-hub.c +7 -9
@@ -867,18 +867,18 @@ int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,case USB_PORT_FEAT_U1_TIMEOUT :if (hcd->speed !=HCD_USB3 ) goto error; - temp =xhci_readl (xhci, port_array[wIndex] +1 ); + temp =xhci_readl (xhci, port_array[wIndex] +PORTPMSC ); temp &= ~PORT_U1_TIMEOUT_MASK ; temp |=PORT_U1_TIMEOUT (timeout); -xhci_writel (xhci, temp, port_array[wIndex] +1 ); +xhci_writel (xhci, temp, port_array[wIndex] +PORTPMSC );break ;case USB_PORT_FEAT_U2_TIMEOUT :if (hcd->speed !=HCD_USB3 ) goto error; - temp =xhci_readl (xhci, port_array[wIndex] +1 ); + temp =xhci_readl (xhci, port_array[wIndex] +PORTPMSC ); temp &= ~PORT_U2_TIMEOUT_MASK ; temp |=PORT_U2_TIMEOUT (timeout); -xhci_writel (xhci, temp, port_array[wIndex] +1 ); +xhci_writel (xhci, temp, port_array[wIndex] +PORTPMSC );break ;default : goto error;
@@ -1098,10 +1098,8 @@ int xhci_bus_suspend(struct usb_hcd *hcd)__le32 __iomem *addr;u32 tmp; -/* Add one to the port status register address to get -* the port power control register address. -*/ - addr = port_array[port_index] +1 ; +/* Get the port power control register address. */ + addr = port_array[port_index] +PORTPMSC ; tmp =xhci_readl (xhci, addr); tmp |=PORT_RWE ;xhci_writel (xhci, tmp, addr);
@@ -1193,7 +1191,7 @@ int xhci_bus_resume(struct usb_hcd *hcd)/* Add one to the port status register address to get * the port power control register address. */ - addr = port_array[port_index] +1 ; + addr = port_array[port_index] +PORTPMSC ; tmp =xhci_readl (xhci, addr); tmp &= ~PORT_RWE ;xhci_writel (xhci, tmp, addr);
drivers/usb/host/xhci.c +2 -2
@@ -3901,7 +3901,7 @@ static int xhci_usb2_software_lpm_test(struct usb_hcd *hcd,* Check device's USB 2.0 extension descriptor to determine whether * HIRD or BESL shoule be used. See USB2.0 LPM errata. */ - pm_addr = port_array[port_num] +1 ; + pm_addr = port_array[port_num] +PORTPMSC ; hird =xhci_calculate_hird_besl (xhci, udev); temp =PORT_L1DS (udev->slot_id) |PORT_HIRD (hird);xhci_writel (xhci, temp, pm_addr);
@@ -3999,7 +3999,7 @@ int xhci_set_usb2_hardware_lpm(struct usb_hcd *hcd, port_array = xhci->usb2_ports; port_num = udev->portnum -1 ; - pm_addr = port_array[port_num] +1 ; + pm_addr = port_array[port_num] +PORTPMSC ; temp =xhci_readl (xhci, pm_addr); xhci_dbg(xhci, "%s port %d USB2 hardware LPM\n",
drivers/usb/host/xhci.h +5 -0
@@ -132,6 +132,11 @@ struct xhci_cap_regs {/* Number of registers per port */ #define NUM_PORT_REGS 4 +#define PORTSC 0 +#define PORTPMSC 1 +#define PORTLI 2 +#define PORTHLPMC 3 +/** * struct xhci_op_regs - xHCI Host Controller Operational Registers. * @command: USBCMD - xHC command register
Signature · 1 line
1.7.4.1
RFC PATCH v3 3/4 usb: xhci: add USB2 Link power management BESL support
In reply to Mathias Nymanusb 2.0 devices with link power managment (LPM) can describe their idle link timeouts either in BESL or HIRD format, so far xHCI has only supported HIRD but later xHCI errata add BESL support as well
BESL timeouts need to inform exit latency changes with an evaluate context command the same way USB 3.0 link PM code does. The same xhci_change_max_exit_latency() function is used as with USB3 but code is pulled out from #ifdef CONFIG_PM as USB2.0 BESL LPM funcionality does not depend on CONFIG_PM.
--- drivers/usb/host/xhci-ext-caps.h | 1 + drivers/usb/host/xhci.c | 204 ++++++++++++++++++++++++++------------ drivers/usb/host/xhci.h | 21 ++++ include/linux/usb.h | 2 + 4 files changed, 164 insertions(+), 64 deletions(-)
drivers/usb/host/xhci-ext-caps.h +1 -0
@@ -71,6 +71,7 @@/* USB 2.0 xHCI 1.0 hardware LMP capability - section 7.2.2.1.3.2 */ #define XHCI_HLC (1 << 19) +#define XHCI_BLC (1 << 19)/* command register values to disable interrupts and halt the HC */ /* start/stop HC execution - do not write unless HC is halted*/
drivers/usb/host/xhci.c +140 -64
248 lines not on this page · raw message
drivers/usb/host/xhci.h +21 -0
@@ -386,6 +386,27 @@ struct xhci_op_regs {#define PORT_L1DS (p) (((p) & 0xff) << 8)#define PORT_HLE (1 << 16) + +/* USB2 Protocol PORTHLPMC */ +#define PORT_HIRDM (p)((p) & 3) +#define PORT_L1_TIMEOUT (p)(((p) & 0xff) << 2) +#define PORT_BESLD (p)(((p) & 0xf) << 10) + +/* use 512 microseconds as USB2 LPM L1 default timeout. */ +#define XHCI_L1_TIMEOUT 512 + +/* Set default HIRD/BESL value to 4 (350/400us) for USB2 L1 LPM resume latency. +* Safe to use with mixed HIRD and BESL systems (host and device) and is used +* by other operating systems. +* +* XHCI 1.0 errata 8/14/12 Table 13 notes: +* "Software should choose xHC BESL/BESLD field values that do not violate a +* device's resume latency requirements, +* e.g. not program values > '4' if BLC = '1' and a HIRD device is attached, +* or not program values < '4' if BLC = '0' and a BESL device is attached. +*/ +#define XHCI_DEFAULT_BESL 4 +/** * struct xhci_intr_reg - Interrupt Register Set * @irq_pending: IMAN - Interrupt Management Register. Used to enable
include/linux/usb.h +2 -0
@@ -468,6 +468,7 @@ struct usb3_lpm_parameters {* @wusb: device is Wireless USB * @lpm_capable: device supports LPM * @usb2_hw_lpm_capable: device can perform USB2 hardware LPM +* @usb2_hw_lpm_besl_capable: device can perform USB2 hardware BESL LPM * @usb2_hw_lpm_enabled: USB2 hardware LPM enabled * @usb3_lpm_enabled: USB3 hardware LPM enabled * @string_langid: language ID for strings
@@ -538,6 +539,7 @@ struct usb_device { unsigned wusb:1; unsigned lpm_capable:1; unsigned usb2_hw_lpm_capable:1; + unsigned usb2_hw_lpm_besl_capable:1; unsigned usb2_hw_lpm_enabled:1; unsigned usb3_lpm_enabled:1;int string_langid;
Signature · 1 line
1.7.4.1
RFC PATCH v3 4/4 usb: add usb2 Link PM variables to sysfs and usb_device
In reply to Mathias NymanAdds abitilty to tune L1 timeout (inactivity timer for usb2 link sleep) and BESL (best effort service latency)via sysfs.
This also adds a new usb2_lpm_parameters structure with those variables to struct usb_device.
--- Documentation/ABI/testing/sysfs-bus-usb | 27 +++++++++++++++ drivers/usb/core/sysfs.c | 54 +++++++++++++++++++++++++++++++ drivers/usb/host/xhci.c | 6 ++- include/linux/usb.h | 18 ++++++++++ 4 files changed, 103 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-bus-usb +27 -0
@@ -236,3 +236,30 @@ Description: This attribute is to expose these information to user space. The file will read "hotplug", "wired" and "not used" if the information is available, and "unknown" otherwise. + +What: /sys/bus/usb/devices/.../power/usb2_lpm_l1_timeout +Date: May 2013 +Contact: Mathias Nyman <[email protected]> +Description: + USB 2.0 devices may support hardware link power management (LPM) + L1 sleep state. The usb2_lpm_l1_timeout attribute allows + tuning the timeout for L1 inactivity timer (LPM timer), e.g. + needed inactivity time before host requests the device to go to L1 sleep. + Useful for power management tuning. + Supported values are 0 - 65535 microseconds. + +What: /sys/bus/usb/devices/.../power/usb2_lpm_besl +Date: May 2013 +Contact: Mathias Nyman <[email protected]> +Description: + USB 2.0 devices that support hardware link power management (LPM) + L1 sleep state now use a best effort service latency value (BESL) to + indicate the best effort to resumption of service to the device after the + initiation of the resume event. + If the device does not have a preferred besl value then the host can select + one instead. This usb2_lpm_besl attribute allows to tune the host selected besl + value in order to tune power saving and service latency. + + Supported values are 0 - 15. + More information on how besl values map to microseconds can be found in + USB 2.0 ECN Errata for Link Power Management, section 4.10)
drivers/usb/core/sysfs.c +54 -0
62 lines not on this page · raw message
drivers/usb/host/xhci.c +4 -2
@@ -3907,7 +3907,7 @@ static int xhci_calculate_usb2_hw_lpm_params(struct usb_device *udev) field =le32_to_cpu (udev->bos->ext_cap->bmAttributes);/* xHCI l1 is set in steps of 256us, xHCI 1.0 section 5.4.11.2 */ - l1 =XHCI_L1_TIMEOUT /256 ; + l1 = udev->l1_params.timeout /256 ;/* device has preferred BESLD */ if (field &USB_BESL_DEEP_VALID ) {
@@ -4091,7 +4091,7 @@ int xhci_set_usb2_hardware_lpm(struct usb_hcd *hcd, (field & USB_BESL_BASELINE_VALID)) hird =USB_GET_BESL_BASELINE (field); else - hird =XHCI_DEFAULT_BESL ; + hird = udev->l1_params.besl; exit_latency = xhci_besl_encoding[hird];spin_unlock_irqrestore (&xhci->lock, flags);
@@ -4181,6 +4181,8 @@ int xhci_update_device(struct usb_hcd *hcd, struct usb_device *udev)if (xhci->hw_lpm_support ==1 &&xhci_check_usb2_port_capability (xhci, portnum,XHCI_HLC )) { udev->usb2_hw_lpm_capable =1 ; + udev->l1_params.timeout =XHCI_L1_TIMEOUT ; + udev->l1_params.besl =XHCI_DEFAULT_BESL ;if (xhci_check_usb2_port_capability (xhci, portnum,XHCI_BLC )) udev->usb2_hw_lpm_besl_capable =1 ;
include/linux/usb.h +18 -0
@@ -394,6 +394,22 @@ enum usb_port_connect_type { };/* +* USB 2.0 Link Power Management (LPM) parameters. +*/ +struct usb2_lpm_parameters { +/* Best effort service latency indicate how long the host will drive +* resume on an exit from L1. +*/ +unsigned int besl; + +/* Timeout value in microseconds for the L1 inactivity (LPM) timer. +* When the timer counts to zero, the parent hub will initiate a LPM +* transition to L1. +*/ +int timeout; +}; + +/* * USB 3.0 Link Power Management (LPM) parameters. * * PEL and SEL are USB 3.0 Link PM latencies for device-initiated LPM exit.
@@ -488,6 +504,7 @@ struct usb3_lpm_parameters {* specific data for the device. * @slot_id: Slot ID assigned by xHCI * @removable: Device can be physically removed from this port +* @l1_params: best effor service latency for USB2 L1 LPM state, and L1 timeout. * @u1_params: exit latencies for USB3 U1 LPM state, and hub-initiated timeout. * @u2_params: exit latencies for USB3 U2 LPM state, and hub-initiated timeout. * @lpm_disable_count: Ref count used by usb_disable_lpm() and usb_enable_lpm()
@@ -568,6 +585,7 @@ struct usb_device {struct wusb_dev *wusb_dev;int slot_id;enum usb_device_removable removable; +struct usb2_lpm_parameters l1_params;struct usb3_lpm_parameters u1_params;struct usb3_lpm_parameters u2_params;unsigned lpm_disable_count;
Signature · 1 line
1.7.4.1
Alan, Greg, any more comments on this patchset?
It looks fine to me, and we've been testing it internally within Intel, so I'll queue it up for 3.11 if you don't have any more objections.
Sarah Sharp
Quoted 35 lines · Mathias Nyman
This series adds usb2 best effort service latency (BESL) link PM support to xHCI. BESL is an updated alternative to host initated resume delay (HIRD) method of describing idle link timeouts.
Additionally this series fixes port capability checking and replaces magic numbers with port register names.
Changes since v1:
-Use kstrto* and unsigned values in sysfs functions as Alan Stern suggestedChanges since v2:
- AddDocumentation/ABI/testing/sysfs-bus-usbentries for new sysfs attributes
- storel1_timeoutvalue in microseconds instead of xHCI specific valuesMathias Nyman (4):
usb: xhci: check usb2 port capabilities before adding hw link PM
support
usb: xhci: define port register names and use them instead of magic
numbers
usb: xhci: add USB2 Link power management BESL support
usb: add usb2 Link PM variables to sysfs andusb_deviceDocumentation/ABI/testing/sysfs-bus-usb | 27 ++++ drivers/usb/core/sysfs.c | 54 +++++++ drivers/usb/host/xhci-ext-caps.h | 1 + drivers/usb/host/xhci-hub.c | 16 +-- drivers/usb/host/xhci-mem.c | 33 ++++- drivers/usb/host/xhci.c | 237 ++++++++++++++++++++++--------- drivers/usb/host/xhci.h | 29 ++++ include/linux/usb.h | 20 +++ 8 files changed, 337 insertions(+), 80 deletions(-)Signature · 1 line
1.7.4.1
Quoted 4 lines · Sarah Sharp
Alan, Greg, any more comments on this patchset?
It looks fine to me, and we've been testing it internally within Intel, so I'll queue it up for 3.11 if you don't have any more objections.
No objections to any of the parts touching the USB core.
Alan Stern
Greg KH
maintainerQuoted 8 lines · Alan Stern
Quoted 4 lines · Sarah Sharp
Alan, Greg, any more comments on this patchset?
It looks fine to me, and we've been testing it internally within Intel, so I'll queue it up for 3.11 if you don't have any more objections.
No objections to any of the parts touching the USB core.
None from me either.
thanks,
greg k-h