diff options
Diffstat (limited to 'Documentation/usb/anchors.txt')
-rw-r--r-- | Documentation/usb/anchors.txt | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/Documentation/usb/anchors.txt b/Documentation/usb/anchors.txt index 7304bcf5a306..6f24f566955a 100644 --- a/Documentation/usb/anchors.txt +++ b/Documentation/usb/anchors.txt | |||
@@ -42,9 +42,38 @@ This function kills all URBs associated with an anchor. The URBs | |||
42 | are called in the reverse temporal order they were submitted. | 42 | are called in the reverse temporal order they were submitted. |
43 | This way no data can be reordered. | 43 | This way no data can be reordered. |
44 | 44 | ||
45 | usb_unlink_anchored_urbs() | ||
46 | -------------------------- | ||
47 | |||
48 | This function unlinks all URBs associated with an anchor. The URBs | ||
49 | are processed in the reverse temporal order they were submitted. | ||
50 | This is similar to usb_kill_anchored_urbs(), but it will not sleep. | ||
51 | Therefore no guarantee is made that the URBs have been unlinked when | ||
52 | the call returns. They may be unlinked later but will be unlinked in | ||
53 | finite time. | ||
54 | |||
55 | usb_scuttle_anchored_urbs() | ||
56 | --------------------------- | ||
57 | |||
58 | All URBs of an anchor are unanchored en masse. | ||
59 | |||
45 | usb_wait_anchor_empty_timeout() | 60 | usb_wait_anchor_empty_timeout() |
46 | ------------------------------- | 61 | ------------------------------- |
47 | 62 | ||
48 | This function waits for all URBs associated with an anchor to finish | 63 | This function waits for all URBs associated with an anchor to finish |
49 | or a timeout, whichever comes first. Its return value will tell you | 64 | or a timeout, whichever comes first. Its return value will tell you |
50 | whether the timeout was reached. | 65 | whether the timeout was reached. |
66 | |||
67 | usb_anchor_empty() | ||
68 | ------------------ | ||
69 | |||
70 | Returns true if no URBs are associated with an anchor. Locking | ||
71 | is the caller's responsibility. | ||
72 | |||
73 | usb_get_from_anchor() | ||
74 | --------------------- | ||
75 | |||
76 | Returns the oldest anchored URB of an anchor. The URB is unanchored | ||
77 | and returned with a reference. As you may mix URBs to several | ||
78 | destinations in one anchor you have no guarantee the chronologically | ||
79 | first submitted URB is returned. \ No newline at end of file | ||