[L] Change in coreboot[master]: Migrate https://www.coreboot.org/EHCI_Debug_Port to docs
Attention is currently required from: Felix Singer, David Hubbard.
Nicholas Chin has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/72956 )
Change subject: Migrate https://www.coreboot.org/EHCI_Debug_Port to docs ......................................................................
Patch Set 4:
(9 comments)
File Documentation/external_docs.md:
https://review.coreboot.org/c/coreboot/+/72956/comment/9e2449c0_c3139c86 PS4, Line 27: [USB Debug Port](lib/usb_debug_port.md) This isn't really the best place to link to the page. The external docs page is intended for resources on external domains not hosted by the coreboot project. Perhaps a new page with links to console/debugging methods would be better?
File Documentation/lib/usb_debug_port.md:
PS4: Much of this content appears to be copied from the old wiki page, which may be an issue. One reason pages from the old wiki weren't all migrated to the new documentation is licensing issues. The new wiki is CC-BY 4.0, whereas most pages on the old wiki do not have an explicit license and thus defaults to the copyright of the individual authors (I believe that's due to the Berne Convention? IANAL). Thus, either everything needs to be rewritten from scratch, or all authors who have contributed to a particular page must be contacted in order to obtain permission to their content.
Some references: https://mail.coreboot.org/hyperkitty/list/coreboot@coreboot.org/message/OZZ5... https://mail.coreboot.org/pipermail/coreboot/2017-March/thread.html#83607 (hyperkitty doesn't seem to want to group all messages in this thread properly)
PS4: The lib directory probably isn't appropriate for this file. In general, folders in `Documentation/` roughly follow the folder structure of the `src/` directory. The ehci debug driver code is located in `drivers/usb`, though I think some sort of debugging or console directory would make more sense
https://review.coreboot.org/c/coreboot/+/72956/comment/b1d01674_175a37a1 PS4, Line 15: #Finding-the-USB-debug-port The way markdown sections are translated to html seems to convert all links to lowercase. As a result, this link doesn't quite work. `#finding-the-usb-debug-port` seems to work.
https://review.coreboot.org/c/coreboot/+/72956/comment/4f04ed5c_6004bbd0 PS4, Line 46: Vendor |Southbridge |Status |Comments : --------|------------|---------|-------- : AMD |SB600 |OK |Tested by Uwe Hermann (coreboot user "Uwe"). : AMD |SB700 |WIP |Probably won't work. : AMD |SB900 |OK |Tested on HP Pavilion m6 1035dx. : AMD |A85X (Hudson D4) | OK |Tested by Tobias Diedrich (coreboot user "Ranma") on ASUS F2A85M-LE. : Intel |82801GX (ICH7) | OK |Tested by Sven Schnelle (coreboot user "SvenS") on Lenovo Thinkpad X60/T60. : NVIDIA |MCP55 |OK |Tested by Uwe Hermann. Any physical USB port will work, as the code tries all ports until the one with the attached USB Debug device is found. : SiS |SiS966 |Untested |Note: It's unclear if the chipset actually has EHCI Debug Port functionality, and (if yes), whether the current coreboot code supports it properly (or whether it's just copy-pasted code from another chipset). Recommonmark (the Markdown parser that the docs uses) doesn't support markdown tables. Please refer to https://doc.coreboot.org/getting_started/writing_documentation.html#markdown... to see how they should be formatted
https://review.coreboot.org/c/coreboot/+/72956/comment/ce79102c_cd6eb5a3 PS4, Line 96: cabpable capable
https://review.coreboot.org/c/coreboot/+/72956/comment/cbec3fdd_b32b0d24 PS4, Line 121: Carl-Daniel Hailfinger : [has written](http://www.coreboot.org/pipermail/coreboot/2008-September/038618.html) : [a script](http://www.coreboot.org/pipermail/coreboot/attachments/20080909/ae11c291/att...) : which can help finding that port. An : [updated script](http://www.coreboot.org/pipermail/coreboot/attachments/20140530/245547f8/att...) : was posted : [here](http://www.coreboot.org/pipermail/coreboot/2014-May/078022.html) : on May 30 2014. There is a newer script based on Carl-Daniel's work located the `util/find_usbdebug.sh` directory, so these may not be necessary
https://review.coreboot.org/c/coreboot/+/72956/comment/0b789695_ec845923 PS4, Line 227: http://coreboot.org/pipermail/coreboot/2006-December/thread.html#17480 : * http://lkml.org/lkml/2006/12/1/214 These just appear as plain text, so it would be nice to make them working hyperlinks
https://review.coreboot.org/c/coreboot/+/72956/comment/b6e77e8f_218f728e PS4, Line 233: * https://github.com/raspberrypi/linux/issues/1907 : * https://eramons.github.io/techblog/post/debug_coreboot/ : * http://www.spinics.net/lists/linux-usb/msg32912.html : * http://cs.usfca.edu/~cruse/cs698s10/ - various EHCI debug port and Ajays resources : * https://github.com/avivgr/teensy_debugdev Same as above, these just appear as plain text
-
Nicholas Chin (Code Review)