1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
.\" Manpage for bfb-install.
.TH man 8 "2 Feb 2024" "3.0" "bfb-install man page"
.SH NAME
bfb-install \- BFB installing script for BlueField SoC over rshim driver
.SH SYNOPSIS
.B bfb-install
-b, --bfb <bfb_file> -r, --rshim [<ip:>[:port]:]rshim<N>
[-c, --config <config_file>]
[-f, --rootfs <rootfs_file>]
[-h, --help]
[-k, --keep-log]
[-m, --remote-mode <scp|nc|ncpipe>]
[-R, --reverse-nc]
[-u, --runtime]
[-v, --verbose]
.SH DESCRIPTION
bfb-install is a utility script to install BFB images on BlueField SoC over the
rshim driver.
When the "--rshim" option doesn't provide an "ip" argument, the script will run
in local mode and try to access the local rshim device and install the BFB image
through it.
When the "--rshim" option provides an "ip" argument, the script will run in
remote mode and try to access the remote rshim device and install the BFB image
through it. There are three remote modes: "scp", "nc", and "ncpipe". The
default remote mode is "scp". "scp" uses the scp command to transfer the BFB
image to the remote rshim device. "nc" uses the nc command to transfer the BFB
image to the remote rshim device. "ncpipe" is similar to "nc" but uses a named
pipe on the remote device to help transfer the BFB image and achieve faster
speed.
The "--reverse-nc" flag, used with "nc" or "ncpipe" remote modes, enables a
reversed connection method where the remote host operates as a netcat server and
the local host, as a client, initiates the connection. This method is
particularly useful for environments with firewall restrictions on the local
host side.
.SH OPTIONS
.TP
-b, --bfb
This is the BFB image to use, which is pushed as the boot stream.
.TP
-c, --config
This is an optional configuration file to use, usually called bf.cfg.
.TP
-f, --rootfs
This is the optional rootfs tar.xz file which is uaually used when installing
Yocto.
.TP
-h, --help
Show the help message.
.TP
-k, --keep-log
Do not clear rshim log buffer after reading during bfb install.
.TP
-m , --remote-mode
Specify the remote mode to use. The default mode is "scp". The available modes
are "scp", "nc", and "ncpipe".
.TP
-r, --rshim
This is the rshim device to use, in the format of [<ip>:<port>:]rshim<N>. The
"ip" and "port" are optional and only used when the remote mode is specified.
These two fields will be ignored when the remote mode is not specified. Both IP
address and host name are supported for the "ip" field. If the port is not
provided, the default port 9527 is used. The "N" is the rshim device number,
usually 0 or 1.
.TP
-R, --reverse-nc
Enables a reverse connection for "nc" and "ncpipe" modes, allowing the local
host to initiate a connection to a netcat server running on the remote.
.TP
-u, --runtime
Run upgrade in runtime mode (BF3 + local rshim only).
.TP
-v, --verbose
Show verbose output.
.SH EXAMPLES
To install a BFB image using the host rshim method:
.RS
bfb-install --bfb bluefield.bfb --rshim rshim0
.RE
To install a BFB image using the BMC rshim scp method:
.RS
bfb-install --bfb bluefield.bfb --rshim 10.15.8.200:rshim0
.RE
To install a BFB image using the BMC rshim nc method:
.RS
bfb-install --bfb bluefield.bfb --rshim 10.15.8.200:rshim0 --remote-mode nc
.RE
To install a BFB image using the BMC rshim ncpipe method with custom port number
and verbose output:
.RS
bfb-install --bfb bluefield.bfb --rshim 10.15.8.200:9709:rshim0 --remote-mode ncpie --verbose
.RE
To install a BFB image in local mode with a custom configuration file:
.RS
bfb-install --bfb bluefield.bfb --rshim rshim0 --config bf.cfg
.RE
To install a BFB image with the BMC rshim using the netcat pipe method and a
reverse connection, specifying a local port within the rshim value:
.RS
bfb-install --bfb bluefield.bfb --rshim 10.15.8.200:9709:rshim0 --remote-mode ncpipe --reverse-nc
.RE
.SH KNOWN ISSUES
When using remote mode nc or ncpipe, there's a short window of time when there
is a netcat server running on the local or remote host on the specified TCP port
(default 9527). This could be a potential security risk. So these two methods
should only be used on a secure network and the security implications are
understood.
|
