Update PRU UART documentation#708
Conversation
PRU SW UART is currently not supported, remove from TOC. Signed-off-by: Judith Mendez <jm@ti.com>
PRU HW UART support exists for AM62x and AM64x SK board, enable documentation for these platforms and update rst to accomadate the new platforms. Signed-off-by: Judith Mendez <jm@ti.com>
jmenti
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
Bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh and
uditkumarti
|
New issues found with check_toc_txt.py: |
As suggested by the bot, if the file is no longer included in any toc tree, can you remove the file as well? |
|
@cshilwant No, we should not remove the fle, we will be adding SW UART support here in the future, why remove it? |
StaticRocket
left a comment
StaticRocket
left a comment
There was a problem hiding this comment.
Ordinary we would remove files when they no longer have any references. I do not see any reason for this to be special. It's git. We can always revert.
| .. ifconfig:: CONFIG_part_variant in ('AM64X') | ||
|
|
||
| .. rubric:: Support Devices | ||
| Programmable Real-Time Unit and Industrial Communication Subsystem - Gigabit (PRU-ICSSG) |
There was a problem hiding this comment.
| Programmable Real-Time Unit and Industrial Communication Subsystem - Gigabit (PRU-ICSSG) | |
| Programmable Real-Time Unit (PRU) and Industrial Communication Subsystem - Gigabit (ICSSG) or PRU-ICSSG |
| - |__PART_FAMILY_DEVICE_NAMES__| | ||
| .. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57XX') | ||
|
|
||
| Programmable Real-Time Unit Subsystem and Industrial Communication Subsystem (PRU-ICSS) |
There was a problem hiding this comment.
Is it actually Programmable Real-Time Unit Subsystem or was this also supposed to just be Programmable Real-Time Unit?
| .. ifconfig:: CONFIG_part_variant in ('AM62X') | ||
|
|
||
| Programmable Real-Time Unit Subsystem (PRUSS) | ||
|
|
||
| .. ifconfig:: CONFIG_part_variant in ('AM64X') | ||
|
|
||
| .. rubric:: Support Devices | ||
| Programmable Real-Time Unit and Industrial Communication Subsystem - Gigabit (PRU-ICSSG) | ||
|
|
||
| - |__PART_FAMILY_DEVICE_NAMES__| | ||
| .. ifconfig:: CONFIG_part_variant in ('AM335X', 'AM437X', 'AM57XX') | ||
|
|
||
| Programmable Real-Time Unit Subsystem and Industrial Communication Subsystem (PRU-ICSS) | ||
|
|
||
| which is based on the industry standard TL16C550. | ||
| The kernel driver is at drivers/tty/serial/8250/8250_pruss.c. |
There was a problem hiding this comment.
If you want this to flow better consider adding a replacement variable definition for those platforms instead. Currently this will appear as a broken up sentence. Optionally you could restructure this so the user doesn't have to follow a few sentence fragments.
| Programmable Real-Time Unit Subsystem and Industrial Communication Subsystem (PRU-ICSS) | ||
|
|
||
| which is based on the industry standard TL16C550. | ||
| The kernel driver is at drivers/tty/serial/8250/8250_pruss.c. |
There was a problem hiding this comment.
| The kernel driver is at drivers/tty/serial/8250/8250_pruss.c. | |
| The kernel driver is at :file:`drivers/tty/serial/8250/8250_pruss.c`. |
8 participants
This PR updates documentation on PRU UART, albeit SW or HW UART on the following platforms: