Merge tag 'docs-4.16' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "Documentation updates for 4.16. New stuff includes refcount_t documentation, errseq documentation, kernel-doc support for nested structure definitions, the removal of lots of crufty kernel-doc support for unused formats, SPDX tag documentation, the beginnings of a manual for subsystem maintainers, and lots of fixes and updates. As usual, some of the changesets reach outside of Documentation/ to effect kerneldoc comment fixes. It also adds the new LICENSES directory, of which Thomas promises I do not need to be the maintainer" * tag 'docs-4.16' of git://git.lwn.net/linux: (65 commits) linux-next: docs-rst: Fix typos in kfigure.py linux-next: DOC: HWPOISON: Fix path to debugfs in hwpoison.txt Documentation: Fix misconversion of #if docs: add index entry for networking/msg_zerocopy Documentation: security/credentials.rst: explain need to sort group_list LICENSES: Add MPL-1.1 license LICENSES: Add the GPL 1.0 license LICENSES: Add Linux syscall note exception LICENSES: Add the MIT license LICENSES: Add the BSD-3-clause "Clear" license LICENSES: Add the BSD 3-clause "New" or "Revised" License LICENSES: Add the BSD 2-clause "Simplified" license LICENSES: Add the LGPL-2.1 license LICENSES: Add the LGPL 2.0 license LICENSES: Add the GPL 2.0 license Documentation: Add license-rules.rst to describe how to properly identify file licenses scripts: kernel_doc: better handle show warnings logic fs/*/Kconfig: drop links to 404-compliant http://acl.bestbits.at doc: md: Fix a file name to md-fault.c in fault-injection.txt errseq: Add to documentation tree ...
This commit is contained in:
@@ -13,12 +13,6 @@ Driver device table
|
||||
.. kernel-doc:: include/linux/mod_devicetable.h
|
||||
:internal:
|
||||
|
||||
Atomic and pointer manipulation
|
||||
-------------------------------
|
||||
|
||||
.. kernel-doc:: arch/x86/include/asm/atomic.h
|
||||
:internal:
|
||||
|
||||
Delaying, scheduling, and timer routines
|
||||
----------------------------------------
|
||||
|
||||
@@ -85,6 +79,21 @@ Internal Functions
|
||||
.. kernel-doc:: kernel/kthread.c
|
||||
:export:
|
||||
|
||||
Reference counting
|
||||
------------------
|
||||
|
||||
.. kernel-doc:: include/linux/refcount.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: lib/refcount.c
|
||||
:export:
|
||||
|
||||
Atomics
|
||||
-------
|
||||
|
||||
.. kernel-doc:: arch/x86/include/asm/atomic.h
|
||||
:internal:
|
||||
|
||||
Kernel objects manipulation
|
||||
---------------------------
|
||||
|
||||
|
@@ -98,3 +98,55 @@ you to check the sanity of the setup.
|
||||
cat /dev/ttyUSB0
|
||||
done
|
||||
===== end of bash scripts ===============
|
||||
|
||||
Serial TTY
|
||||
==========
|
||||
|
||||
The DbC support has been added to the xHCI driver. You can get a
|
||||
debug device provided by the DbC at runtime.
|
||||
|
||||
In order to use this, you need to make sure your kernel has been
|
||||
configured to support USB_XHCI_DBGCAP. A sysfs attribute under
|
||||
the xHCI device node is used to enable or disable DbC. By default,
|
||||
DbC is disabled::
|
||||
|
||||
root@target:/sys/bus/pci/devices/0000:00:14.0# cat dbc
|
||||
disabled
|
||||
|
||||
Enable DbC with the following command::
|
||||
|
||||
root@target:/sys/bus/pci/devices/0000:00:14.0# echo enable > dbc
|
||||
|
||||
You can check the DbC state at anytime::
|
||||
|
||||
root@target:/sys/bus/pci/devices/0000:00:14.0# cat dbc
|
||||
enabled
|
||||
|
||||
Connect the debug target to the debug host with a USB 3.0 super-
|
||||
speed A-to-A debugging cable. You can see /dev/ttyDBC0 created
|
||||
on the debug target. You will see below kernel message lines::
|
||||
|
||||
root@target: tail -f /var/log/kern.log
|
||||
[ 182.730103] xhci_hcd 0000:00:14.0: DbC connected
|
||||
[ 191.169420] xhci_hcd 0000:00:14.0: DbC configured
|
||||
[ 191.169597] xhci_hcd 0000:00:14.0: DbC now attached to /dev/ttyDBC0
|
||||
|
||||
Accordingly, the DbC state has been brought up to::
|
||||
|
||||
root@target:/sys/bus/pci/devices/0000:00:14.0# cat dbc
|
||||
configured
|
||||
|
||||
On the debug host, you will see the debug device has been enumerated.
|
||||
You will see below kernel message lines::
|
||||
|
||||
root@host: tail -f /var/log/kern.log
|
||||
[ 79.454780] usb 2-2.1: new SuperSpeed USB device number 3 using xhci_hcd
|
||||
[ 79.475003] usb 2-2.1: LPM exit latency is zeroed, disabling LPM.
|
||||
[ 79.475389] usb 2-2.1: New USB device found, idVendor=1d6b, idProduct=0010
|
||||
[ 79.475390] usb 2-2.1: New USB device strings: Mfr=1, Product=2, SerialNumber=3
|
||||
[ 79.475391] usb 2-2.1: Product: Linux USB Debug Target
|
||||
[ 79.475392] usb 2-2.1: Manufacturer: Linux Foundation
|
||||
[ 79.475393] usb 2-2.1: SerialNumber: 0001
|
||||
|
||||
The debug device works now. You can use any communication or debugging
|
||||
program to talk between the host and the target.
|
||||
|
@@ -321,6 +321,6 @@ linux-usb-devel Mailing List Archives:
|
||||
http://marc.theaimsgroup.com/?l=linux-usb-devel
|
||||
|
||||
Programming Guide for Linux USB Device Drivers:
|
||||
http://usb.cs.tum.edu/usbdoc
|
||||
http://lmu.web.psi.ch/docu/manuals/software_manuals/linux_sl/usb_linux_programming_guide.pdf
|
||||
|
||||
USB Home Page: http://www.usb.org
|
||||
|
Reference in New Issue
Block a user