EMTime/libopencm3-examples
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README] Coarse sweep to use markup in READMEs.

Browse Source 
This should improve online readability of the readme files.
This commit is contained in:
Piotr Esden-Tempski
2015-01-19 19:20:12 -08:00
parent ab7efee88e
commit 1c4ae95729
121 changed files with 411 additions and 609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
examples/tiva/lm4f/stellaris-ek-lm4f120xl/usb_to_serial_cdcacm/README.md
View File

@@ -1,16 +1,14 @@
------------------------------------------------------------------------------
README
------------------------------------------------------------------------------
# README
This example demonstrates the following:
* Using the USB controller
* Setting up a simple usb to serial converter (CDCACM)
File list:
* usb_cdcacm.c - implementation of the CDCACM subclass
* uart.c - implementation of UART peripheral
* usb_to_serial_cdcacm.c - glue logic between UART and CDCACM device
* usb_to_serial_cdcacm.h - common definitions
* `usb_cdcacm.c` - implementation of the CDCACM subclass
* `uart.c` - implementation of UART peripheral
* `usb_to_serial_cdcacm.c` - glue logic between UART and CDCACM device
* `usb_to_serial_cdcacm.h` - common definitions
Implements a USB-to-serial adapter, compliant to the CDCACM subclass. UART1 is
@@ -31,7 +29,7 @@ Note that the CTS pin is unused. The CDCACM specification does not define a way
to control this pin, nor does it define a way to switch between flow control
mechanisms.
The glue logic in usb_to_serial_cdcacm.c receives requests from both the UART
The glue logic in `usb_to_serial_cdcacm.c` receives requests from both the UART
and CDCACM interface, and forward them to their destination, while also
controlling the LEDs
@@ -41,28 +39,27 @@ The blue LED is lit while data is read from the UART.
The red and blue LEDs will only be lit for very short periods of time, thus they
may be difficult to notice.
------------------------------------------------------------------------------
Windows Quirks
------------------------------------------------------------------------------
On openening the CDCACM port Windows send a SET_LINE_CODING request with the
## Windows Quirks
On openening the CDCACM port Windows send a `SET_LINE_CODING` request with the
desired baud rate but without valid databits. To run this example CDDACM device
under Windows you have to return always 1 when a SET_LINE_CODING request is
under Windows you have to return always 1 when a `SET_LINE_CODING` request is
received. The following code should work:
File: usb_cdcacm.c
Function: cdcacm_control_request()
File: `usb_cdcacm.c`
Function: `cdcacm_control_request()`
case USB_CDC_REQ_SET_LINE_CODING:{
struct usb_cdc_line_coding *coding;
if (*len < sizeof(struct usb_cdc_line_coding))
{
return 0;
}
coding = (struct usb_cdc_line_coding *)*buf;
glue_set_line_coding_cb(coding->dwDTERate,
coding->bDataBits,
coding->bParityType,
coding->bCharFormat);
return 1;