Commit d1b1944085ab2345fae4a5fbb614f1a4d0732d3e
Committed by
Greg Kroah-Hartman
1 parent
4a511bc3f5
Exists in
master
and in
4 other branches
USB: Documentation/usb/anchors.txt #2
This adds Documentation for the extensions of the anchor API. Signed-off-by: Oliver Neukum <oneukum@suse.de> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Showing 1 changed file with 17 additions and 0 deletions Side-by-side Diff
Documentation/usb/anchors.txt
... | ... | @@ -52,10 +52,29 @@ |
52 | 52 | the call returns. They may be unlinked later but will be unlinked in |
53 | 53 | finite time. |
54 | 54 | |
55 | +usb_scuttle_anchored_urbs() | |
56 | +--------------------------- | |
57 | + | |
58 | +All URBs of an anchor are unanchored en masse. | |
59 | + | |
55 | 60 | usb_wait_anchor_empty_timeout() |
56 | 61 | ------------------------------- |
57 | 62 | |
58 | 63 | This function waits for all URBs associated with an anchor to finish |
59 | 64 | or a timeout, whichever comes first. Its return value will tell you |
60 | 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. |