summaryrefslogtreecommitdiffstats
path: root/extensions/common
diff options
context:
space:
mode:
authorreillyg <reillyg@chromium.org>2016-02-23 17:12:31 -0800
committerCommit bot <commit-bot@chromium.org>2016-02-24 01:14:49 +0000
commit421a4c7c15b84b5d0afd9f9d4b1f25e56c840b7e (patch)
tree6f85720253dcbd9fc0d404b42dcf4a228ecf45a0 /extensions/common
parent9d07a80a367e474cdb4e4cda34c0679ae943d98b (diff)
downloadchromium_src-421a4c7c15b84b5d0afd9f9d4b1f25e56c840b7e.zip
chromium_src-421a4c7c15b84b5d0afd9f9d4b1f25e56c840b7e.tar.gz
chromium_src-421a4c7c15b84b5d0afd9f9d4b1f25e56c840b7e.tar.bz2
Clarify chrome.usb API documentation on transfer lengths.
This patch clarifies that the transfer length is only the maximum number of bytes that will be read from the device as the device is allowed to respond with a short packet. BUG=578508 Review URL: https://codereview.chromium.org/1724203002 Cr-Commit-Position: refs/heads/master@{#377163}
Diffstat (limited to 'extensions/common')
-rw-r--r--extensions/common/api/usb.idl10
1 files changed, 6 insertions, 4 deletions
diff --git a/extensions/common/api/usb.idl b/extensions/common/api/usb.idl
index 77163e7..21e4bd3 100644
--- a/extensions/common/api/usb.idl
+++ b/extensions/common/api/usb.idl
@@ -119,15 +119,16 @@ namespace usb {
// The request type.
RequestType requestType;
- // The <code>bRequest</code> field, see <i>Universal Serial Bus Specification
- // Revision 1.1</i> &sect; 9.3.
+ // The <code>bRequest</code> field, see <i>Universal Serial Bus
+ // Specification Revision 1.1</i> &sect; 9.3.
long request;
// The <code>wValue</code> field, see <i>Ibid</i>.
long value;
// The <code>wIndex</code> field, see <i>Ibid</i>.
long index;
- // The amount of data to receive (required only by input transfers).
+ // The maximum number of bytes to receive (required only by input
+ // transfers).
long? length;
// The data to transmit (required only by output transfers).
@@ -146,7 +147,8 @@ namespace usb {
// be claimed.
long endpoint;
- // The amount of data to receive (required only by input transfers).
+ // The maximum number of bytes to receive (required only by input
+ // transfers).
long? length;
// The data to transmit (required only by output transfers).