1man(8)                          rshim man page                          man(8)
2
3
4

NAME

6       rshim - user-space rshim driver for BlueField SoC
7

SYNOPSIS

9       rshim [options]
10

DESCRIPTION

12       rshim  is  the  user-space  rshim driver for BlueField SoC. It provides
13       ways to access the rshim resources on the BlueField target via  USB  or
14       PCIe from external host machine. The current version implements virtual
15       console, virtual network interface, boot stream push,  register  access
16       and some utility commands.
17
18       This   driver  will  probe  the  rshim  backend  and  create  directory
19       /dev/rshim<N> for each of them with the following device files.
20
21
22   /dev/rshim<N>/boot
23       Boot device file used to push boot stream to the target, for example,
24
25           cat install.bfb > /dev/rshim<N>/boot
26
27
28   /dev/rshim<N>/console
29       Console device file, which can be used by console tools to  connect  to
30       the target, such as
31
32           screen /dev/rshim<N>/console
33
34
35   /dev/rshim<N>/rshim
36       Device  file  used to access rshim register space. When reading/writing
37       to this file, the offset is encoded as "((rshim_channel << 16) | regis‐
38       ter_offset)".  This  file can be used by tools like openocd to do Core‐
39       Sight debugging.
40
41
42   /dev/rshim<N>/misc
43       Key/Value pairs used to read/write misc information. For example
44
45       Display the output
46
47           cat /dev/rshim0/misc
48               DISPLAY_LEVEL   0 (0:basic, 1:advanced, 2:log)
49               BOOT_MODE       1 (0:rshim, 1:emmc, 2:emmc-boot-swap)
50               BOOT_TIMEOUT    100 (seconds)
51               SW_RESET        0 (1: reset)
52               DEV_NAME        pcie-04:00.2
53
54       Initiate SW reset
55
56           echo "SW_RESET 1" > /dev/rshim<N>/misc
57
58       Enable the advanced options
59
60           echo "DISPLAY_LEVEL 1" > /dev/rshim<N>/misc
61
62           cat /dev/rshim0/misc
63               DISPLAY_LEVEL   1 (0:basic, 1:advanced, 2:log)
64               BOOT_MODE       1 (0:rshim, 1:emmc, 2:emmc-boot-swap)
65               BOOT_TIMEOUT    100 (seconds)
66               SW_RESET        0 (1: reset)
67               DEV_NAME        pcie-04:00.2
68               PEER_MAC        00:1a:ca:ff:ff:01 (rw)
69               PXE_ID          0x00000000 (rw)
70               VLAN_ID         0 0 (rw)
71

OPTIONS

73       -b, --backend
74           Specify the backend to attach, which can be one  of  usb,  pcie  or
75           pcie_lf.  If not specified, the driver will scan all rshim backends
76           unless the '-d' option is given with a device name specified.
77
78       -d, --device
79           Specify the device name to attach with the format below. The  back‐
80           end  driver  can  be  deduced  from  the device name, thus the '-b'
81           option is not needed.
82
83               PCIe backend:
84                   pcie-<bus>:<device>.<function>. Example: pcie-04:00.2
85                   Devices can be found with command 'lspci -n'.
86
87               PCIe backend in livefish mode:
88                   pcie-lf-<bus>:<device>.<function>. Example: pcie-04:00.2
89                   Devices can be found with command 'lspci -n'.
90
91               USB backend:
92                   usb-<bus>-xx.xx. Example: usb-2-1.7
93                   Devices can be found under /sys/bus/usb/devices/.
94
95       -f, --foreground
96           Run in forground.
97
98       -i, --index
99           Specify the index to create  device  path  /dev/rshim<index>.  It's
100           also  used to create network interface name tmfifo_net<index>. This
101           option is needed when multiple rshim instances are running.
102
103       -l, --log-level
104           Log level (0:none, 1:error, 2:warning, 3:notice, 4:debug) Log  mes‐
105           sages  will  be  printed  to  standard output when running in fore‐
106           ground, or in syslog when running as a daemon.
107
108       -v, --version
109           Display version
110
111
112
1132.0                               18 Dec 2019                           man(8)