[dpu_tty]: Add a DPU TTY console utility #3535

wenchungw · 2024-09-07T02:14:49Z

Add dpu_tty.py
Add dpu_tty.py to scripts

Signed-off-by: Wenchung Wang vincwang@cisco.com

What I did

Add DPU TTY console utility.

How I did it

Read platform.json to retrieve TTY settings in DPUS section. Set up TTY console according to TTY device name and baud rate.
Also provide options to overwrite default TTY device and baud rate.

"DPUS": {
    "dpu0": {
        "serial-console": {
            "device": "ttyS4",
            "baud-rate": "115200"
        }
    },
    "dpu1": {
        "serial-console": {
            "device": "ttyS5",
            "baud-rate": "115200"
        }
    }
},

How to verify it

Run the utility on a smart switch that provides DPU UART console via ttyS device. The test plan is at
https://github.com/sonic-net/sonic-mgmt/pull/12701/files section 1.4.

The utility works only on smart switch that provides DPU serial console connections through TTY /dev/ttyS* devices, for example Mt Fuji. Here is a test log.

root@MtFuji:/home/cisco# dpu-tty.py -n dpu0
picocom v3.1

port is        : /dev/ttyS4
flowcontrol    : none
baudrate is    : 115200
parity is      : none
databits are   : 8
stopbits are   : 1
escape is      : C-a
local echo is  : no
noinit is      : no
noreset is     : no
hangup is      : no
nolock is      : no
send_cmd is    : sz -vv
receive_cmd is : rz -vv -E
imap is        : 
omap is        : 
emap is        : crcrlf,delbs,
logfile is     : none
initstring     : none
exit_after is  : not set
exit is        : no

Type [C-a] [C-h] to see available commands
Terminal ready

sonic login: admin
Password: 
Linux sonic 6.1.0-11-2-arm64 #1 SMP Debian 6.1.38-4 (2023-08-08) aarch64
You are on
  ____   ___  _   _ _  ____
 / ___| / _ \| \ | (_)/ ___|
 \___ \| | | |  \| | | |
  ___) | |_| | |\  | | |___
 |____/ \___/|_| \_|_|\____|

-- Software for Open Networking in the Cloud --

Unauthorized access and/or use are prohibited.
All access and/or use are subject to monitoring.

Help:    https://sonic-net.github.io/SONiC/

Last login: Thu Sep 19 18:40:28 UTC 2024 on ttyS0
admin@sonic:~$ show ip int
Interface    Master    IPv4 address/mask    Admin/Oper    BGP Neighbor    Neighbor IP
-----------  --------  -------------------  ------------  --------------  -------------
Ethernet0              18.0.202.1/31        up/up         N/A             N/A
docker0                240.127.1.1/24       up/down       N/A             N/A
int_mnic0              169.254.200.0/24     up/up         N/A             N/A
lo                     127.0.0.1/16         up/up         N/A             N/A
admin@sonic:~$ 
Terminating...
Thanks for using picocom
root@MtFuji:/home/cisco# dpu-tty.py -n dpu7
picocom v3.1

port is        : /dev/ttyS11
flowcontrol    : none
baudrate is    : 115200
parity is      : none
databits are   : 8
stopbits are   : 1
escape is      : C-a
local echo is  : no
noinit is      : no
noreset is     : no
hangup is      : no
nolock is      : no
send_cmd is    : sz -vv
receive_cmd is : rz -vv -E
imap is        : 
omap is        : 
emap is        : crcrlf,delbs,
logfile is     : none
initstring     : none
exit_after is  : not set
exit is        : no

Type [C-a] [C-h] to see available commands
Terminal ready

sonic login: 
Terminating...
Thanks for using picocom
root@MtFuji:/home/cisco# dpu-tty.py -n dpu7
picocom v3.1

port is        : /dev/ttyS11
flowcontrol    : none
baudrate is    : 115200
parity is      : none
databits are   : 8
stopbits are   : 1
escape is      : C-a
local echo is  : no
noinit is      : no
noreset is     : no
hangup is      : no
nolock is      : no
send_cmd is    : sz -vv
receive_cmd is : rz -vv -E
imap is        : 
omap is        : 
emap is        : crcrlf,delbs,
logfile is     : none
initstring     : none
exit_after is  : not set
exit is        : no

Type [C-a] [C-h] to see available commands
Terminal ready

sonic login: admin
Password: 
Linux sonic 6.1.0-11-2-arm64 #1 SMP Debian 6.1.38-4 (2023-08-08) aarch64
You are on
  ____   ___  _   _ _  ____
 / ___| / _ \| \ | (_)/ ___|
 \___ \| | | |  \| | | |
  ___) | |_| | |\  | | |___
 |____/ \___/|_| \_|_|\____|

-- Software for Open Networking in the Cloud --

Unauthorized access and/or use are prohibited.
All access and/or use are subject to monitoring.

Help:    https://sonic-net.github.io/SONiC/

admin@sonic:~$ sudo su
root@sonic:/home/admin# show ip int
Interface    Master    IPv4 address/mask    Admin/Oper    BGP Neighbor    Neighbor IP
-----------  --------  -------------------  ------------  --------------  -------------
Ethernet0              18.7.202.1/31        up/up         N/A             N/A
docker0                240.127.1.1/24       up/down       N/A             N/A
int_mnic0              169.254.200.7/24     up/up         N/A             N/A
lo                     127.0.0.1/16         up/up         N/A             N/A
root@sonic:/home/admin# 
Terminating...
Thanks for using picocom
root@MtFuji:/home/cisco#

Previous command output (if the output of a command-line utility has changed)

N/A

New command output (if the output of a command-line utility has changed)

N/A

* Add dpu_tty.py * Add dpu_tty.py to scripts Signed-off-by: Wenchung Wang vincwang@cisco.com What I did Add DPU TTY console utility. How I did it * Read platform.json to retrieve TTY settings in DPUS section. Set up TTY console according to TTY device name and baud rate. * Also provide options to overwrite default TTY device and baud rate. ''' "DPUS": { "dpu0": { "serial-console": { "device": "ttyS4", "baud-rate": "115200" } }, "dpu1": { "serial-console": { "device": "ttyS5", "baud-rate": "115200" } } }, ''' How to verify it Run the utility on a smart switch that provides DPU UART console via ttyS device. The test plan is at https://github.com/sonic-net/sonic-mgmt/pull/12701/files section 1.4.

linux-foundation-easycla · 2024-09-07T02:14:54Z

The committers listed above are authorized under a signed CLA.

✅ login: wenchungw / name: Wenchung Wang (9e3b184, daec93f, a724849, bfec7a9, d2398bc, c993bfb, a40adfc, 31840f3)

oleksandrivantsiv · 2024-09-16T21:37:02Z

setup.py

@@ -120,6 +120,7 @@
        'scripts/decode-syseeprom',
        'scripts/dropcheck',
        'scripts/disk_check.py',
+        'scripts/dpu_tty.py',


Can you please rename the application to dpu-tty? To make the user experience more convenient

oleksandrivantsiv · 2024-09-16T21:42:12Z

scripts/dpu_tty.py

+def main():
+
+    parser = argparse.ArgumentParser(description='DPU TTY Console Utility')
+    parser.add_argument('-s', '--slot', type=int, required=True)


Why is the slot used instead of the DPU name?
I suggest using the DPU name (dpu0, dpu1, dpuX) in all places to refer to the DPU. This will remove any future confusion.

parser.add_argument('-n', '--name', type=str, required=True)

oleksandrivantsiv

As commented. Please also cover the application with the tests

prgeor

@wenchungw could you update this document to explain the new CLI being proposed?

https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md

Please add a new section "Console"

Add DPU serial console utility.

wenchungw · 2024-09-19T21:38:46Z

@wenchungw could you update this document to explain the new CLI being proposed?

https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md

Please add a new section "Console"

Added.

wenchungw · 2024-09-19T21:44:19Z

As commented. Please also cover the application with the tests

Added a test log.

prgeor · 2024-09-24T16:46:12Z

@oleksandrivantsiv please review/approve

wenchungw added 3 commits September 7, 2024 09:29

Correct SA errors

c993bfb

Correct SA errors

a40adfc

Correct SA error

a724849

prgeor requested a review from oleksandrivantsiv September 11, 2024 21:23

Fix a SA error

bfec7a9

oleksandrivantsiv reviewed Sep 16, 2024

View reviewed changes

oleksandrivantsiv suggested changes Sep 16, 2024

View reviewed changes

prgeor reviewed Sep 18, 2024

View reviewed changes

wenchungw and others added 3 commits September 19, 2024 00:52

Merge branch 'sonic-net:master' into dpu_tty

d2398bc

Update Command-Reference.md

9e3b184

Add DPU serial console utility.

Address review comments

31840f3

wenchungw requested review from prgeor and oleksandrivantsiv September 19, 2024 21:44

prgeor approved these changes Sep 24, 2024

View reviewed changes

oleksandrivantsiv approved these changes Sep 24, 2024

View reviewed changes

prgeor merged commit 688c1d1 into sonic-net:master Sep 25, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dpu_tty]: Add a DPU TTY console utility #3535

[dpu_tty]: Add a DPU TTY console utility #3535

wenchungw commented Sep 7, 2024 •

edited

Loading

linux-foundation-easycla bot commented Sep 7, 2024 •

edited

Loading

oleksandrivantsiv Sep 16, 2024

wenchungw Sep 19, 2024

oleksandrivantsiv Sep 16, 2024

wenchungw Sep 19, 2024

oleksandrivantsiv left a comment

prgeor left a comment

wenchungw commented Sep 19, 2024

wenchungw commented Sep 19, 2024

prgeor commented Sep 24, 2024

[dpu_tty]: Add a DPU TTY console utility #3535

[dpu_tty]: Add a DPU TTY console utility #3535

Conversation

wenchungw commented Sep 7, 2024 • edited Loading

What I did

How I did it

How to verify it

Previous command output (if the output of a command-line utility has changed)

New command output (if the output of a command-line utility has changed)

linux-foundation-easycla bot commented Sep 7, 2024 • edited Loading

oleksandrivantsiv Sep 16, 2024

Choose a reason for hiding this comment

wenchungw Sep 19, 2024

Choose a reason for hiding this comment

oleksandrivantsiv Sep 16, 2024

Choose a reason for hiding this comment

wenchungw Sep 19, 2024

Choose a reason for hiding this comment

oleksandrivantsiv left a comment

Choose a reason for hiding this comment

prgeor left a comment

Choose a reason for hiding this comment

wenchungw commented Sep 19, 2024

wenchungw commented Sep 19, 2024

prgeor commented Sep 24, 2024

wenchungw commented Sep 7, 2024 •

edited

Loading

linux-foundation-easycla bot commented Sep 7, 2024 •

edited

Loading