Maxim USB CDC ACM (serial over USB)

analogdevicesinc / no-OS

Software drivers in C for systems without an operating system

http://analogdevicesinc.github.io/no-OS/

Other

927 stars 1.65k forks source link

Maxim USB CDC ACM (serial over USB) #2138

Closed buha closed 6 months ago

buha commented 6 months ago

Pull Request Description

Add USB CDC ACM functionality to Maxim platform implemented as uart ops.

To use it in a project one needs to include the following files to the project source files:

maxim_usb_uart.h
maxim_usb_uart.c
maxim_usb_uart_descriptors.h

And build using NO_OS_USB_UART=y flag.

PR Type

[ ] Bug fix (change that fixes an issue)
[x] New feature (change that adds new functionality)
[ ] Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

[x] I have followed the Coding style guidelines
[x] I have performed a self-review of the changes
[x] I have commented my code, at least hard-to-understand parts
[x] I have build all projects affected by the changes in this PR
[x] I have tested in hardware affected projects, at the relevant boards
[x] I have signed off all commits from this PR
[ ] I have updated the documentation (wiki pages, ReadMe etc), if applies

buha commented 6 months ago

V2:

removed symlinks

buha commented 6 months ago

V3:

fix attempt for astyle and maxim builds

buha commented 6 months ago

V4:

fix attempt for targets that don't have usb

buha commented 6 months ago

V5:

discarded #ifdefs in drivers/platform/maxim/[target]/... code as per above suggestion
added CI entries in builds.json to test builds with the NO_OS_USB_UART flag

buha commented 6 months ago

V6:

fixed issue with max32690, and by the way, tested this on max32690 as well

buha commented 6 months ago

V7:

fixed product id strings so that they look good in kernel dmesg. For max32690 it looks like this:

[116677.866486] usb 1-1.5: new high-speed USB device number 11 using ehci-pci
[116677.967167] usb 1-1.5: config 1 interface 0 altsetting 0 endpoint 0x84 has an invalid bInterval 255, changing to 11
[116677.967789] usb 1-1.5: New USB device found, idVendor=0b6b, idProduct=003c, bcdDevice= 1.00
[116677.967798] usb 1-1.5: New USB device strings: Mfr=1, Product=2, SerialNumber=0
[116677.967801] usb 1-1.5: Product: MAX32690 CDC-ACM
[116677.967803] usb 1-1.5: Manufacturer: Maxim Integrated
[116677.969091] cdc_acm 1-1.5:1.0: ttyACM2: USB ACM device

The line that says Product: MAX32690 CDC-ACM will be Product: MAX32650 CDC-ACM or Product: MAX32665 CDC-ACM depending on the microcontroller.