diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-29 05:19:41 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-29 05:19:41 +0000 |
| commit | 414b92e8123b9163015fb99ec286439275b000e8 (patch) | |
| tree | 4cb44799143cd511fd7e6a7045753811b32ae28c /LUFA | |
| parent | 958d28d05dcf29530cc552ba75b53fc41bd89c7e (diff) | |
| download | lufa-414b92e8123b9163015fb99ec286439275b000e8.tar.gz lufa-414b92e8123b9163015fb99ec286439275b000e8.tar.bz2 lufa-414b92e8123b9163015fb99ec286439275b000e8.zip | |
Add to the existing CDC Class Driver's CreateStream() function documentation to explicitly state that the created streams are bidirectional.
Diffstat (limited to 'LUFA')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/CDC.h | 3 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index f7bdee019..5cd3aaf61 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -212,7 +212,8 @@ void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
- * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
+ * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
+ * stream is bidirectional and can be used for both input and output functions.
*
* Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
* fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index d1ad49c27..03b31d0ed 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -215,7 +215,8 @@ uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
- * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
+ * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
+ * stream is bidirectional and can be used for both input and output functions.
*
* \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
* to the given CDC interface.
|