docs/architecture/interface-overview.md

6 - Engineers provide domain expertise in specific areas and learn about use cases
8 - Give BMC administrators and system integrators a simplified view of the BMC's
11 - Management and security folks need everything to work and play together
24 OpenBMC's services and the interfaces they provide are controlled by `systemd`.
38 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Control/S…
58         +----------------+         +----------------+
61         | Network       -+- LPC ---+-               |
62        -+- eth0         -+--PCIe --+-               |
63        -+- eth1         -+--UART --+-               |
64         |  lo           -+- I2C ---+-               |
65         |               -+--I3C ---+-               |
66         | USB           -+- SPI ---+-               |
67        -+- usb0         -+- PECI --+-               |
68         |               -+- GPIOs -+-               |
69         | Serial        -+- UTMI --+-               |
70        -+- tty0          |         |                |
72         +----------------+         +----------------+
75 #### Host-BMC physical interface transport protocols
77 This lists protocols that operate over the BMC-host physical interfaces:
79 - Host IPMI.
80 - [MCTP][]. OpenBMC offers MCTP over LPC, PCIe, UART.
81 - Custom OEM solution.
82 - SMBus.
87 #### Host-BMC data models
89 This lists specifications for the data which flows over the BMC-host transport
92 - Host IPMI.
93 - PLDM (DMTF document DSP0240).
94 - Custom OEM solution.
103         +----------------------------------+
106        -+-+ Network services               |
108         | +-+ TCP ports                    |
109         | | +- 22 ssh - shell              |
110         | | +- 80 HTTP (no connection)     |
111         | | +- 443 HTTPS                   |
112         | | +- 2200 ssh - host console     |
113         | | +- 5355 mDNS service discovery |
115         | +-+ UDP ports                    |
116         |   +- 427 SLP                     |
117         |   +- 623 RMCP+ IPMI              |
118         |   +- 5355 mDNS service discovery |
120         +----------------------------------+
125 - Active SSH sessions.
126 - Active KVM-IP sessions.
127 - Active virtual media sessions.
135 - TFTP (disabled by default, when invoked by BMC operator) - Trivial FTP client
137 - SNMP manager to catch [SNMP traps][] (when enabled).
140   https://github.com/openbmc/docs/blob/master/code-update/code-update.md
142   https://github.com/openbmc/phosphor-snmp/blob/master/docs/snmp-configuration.md
148 - Client access via network IPMI.
149 - Client access via ssh port 2200.
150 - The hostlogger facility.
153                 +---------------------------+    +-----------------+
157  UDP port 623 .... netipmid ------------}   |    |                 |
159  ssh -p 2200   ... obmc-console-client -}---+----+- serial UART    |
161                 |  hostlogger ----------}   |    |                 |
163                 +---------------------------+    +-----------------+
166 The [obmc-console][] details how the host UART connection is abstracted within
169 [obmc-console]: https://github.com/openbmc/obmc-console/blob/master/README.md
176         +--------------------------------------------------+
179        -+-+ Network services                               |
181         |  +- 443 HTTPS - BMCWeb -> { static content       |
183         |  +- (other ports) <---+   {   Redfish schema     |
186        -+- Websockets -+        |   { Phosphor REST APIs   |
187         |              |        +<--{-- can set up:        |
188         |              |            {     KVM-IP, USB-IP,  |
191         +--------------------------------------------------+
206 - Web application (webui-vue) and other static content
207 - REST APIs including custom phosphor-rest and Redfish APIs
208 - KVM-IP (Keyboard, Video, Mouse over IP)
209 - Virtual media via USB-IP (Universal Serial Bus over IP)
210 - others
217     +---------------+    +-----------------+
220     |        ipmid -+----+-                |
222     +---------------+    +-----------------+
230 …https://github.com/openbmc/openbmc/blob/master/meta-phosphor/classes/phosphor-ipmi-host-whitelist.…
232 ### D-Bus interfaces
234 OpenBMC uses D-Bus interfaces as the primary way to communicate (inter-process
239         +--------------------------------------------------+
242         | +-------+                                        |
243         | | D-Bus |                                        |
244         | |      -+- bmcweb                                |
245         | |      -+- ipmid                                 |
246         | |      -+- ...                                   |
247         | |      -+- many more (not shown here)            |
248         | |      -+- ...                                   |
250         | +-------+                                        |
252         +--------------------------------------------------+
255 To learn more, read the [Phosphor D-Bus interface docs][] and search for README
258 [phosphor d-bus interface docs]:
259   https://github.com/openbmc/phosphor-dbus-interfaces
277              +-----------+      +----------------+
280 network   ---+- Network  |      |       Network -+- payload
282              +-----------+      +----------------+
285 The BMC may be served by a Network Controller Sideband Interface (NC-SI) which
289              +-----------+      +----------------+
292 network    +-+- Network  |      |       Network -+-+
294            | +-----------+      +----------------+ |
296            |      +------------------+             |
298            |      |.........+       -+-------------+
299            +------+- side-  :        |
300 management -------+- band   :       -+- payload
302                   +------------------+
309              +-----------+      +----------------+
312           +--+- Network  |      |       Network -+- payload
314           |  |           |   +--+- management    |
316           |  +-----------+   |  +----------------+
318           +------------------+
324              +-----------+      +----------------+
326         +-+  |           |      |                |
327    USB --+---+- Network  |      |       Network -+- payload
328         +-+  |           |      |                |  network
330              +-----------+      +----------------+
336 controlling the BMC's U-Boot and then providing access to the BMC's shell.
359 accesses the host system's console. See also `obmc-console-server` which
367 BMC via the `avahi-browse -rt _obmc_rest._tcp` command.
373 `slptool -u ${ip} findsrvtypes or findsrvs` command.
378 source here: `https://github.com/openbmc/phosphor-net-ipmid` and some details
381 more. Also known as out of band IPMI. Contrast with host-IPMI which interacts
388 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Ipmi/SESS…
393 Refers to the host-facing IPMI service provided by the `ipmid` program with
394 source here: `https://github.com/openbmc/phosphor-host-ipmid`. The systemd
395 service is `phosphor-ipmi-host` implemented by the `ipmid` program. Also known
396 as in-band IPMI. Contrast with RMCP+ which faces the network and with PLDM which
406 ### obmc-console
409 https://github.com/openbmc/obmc-console and two applications:
411 - The `obmc-console-server` abstracts the host console (UART) connection as a
413 - The `obmc-console-client` can connect a console to an SSH session.
420 https://github.com/openbmc/phosphor-hostlogger which listens to the
421 `obmc-console-server` and logs host console messages into the BMC's file system.
427 https://github.com/openbmc/bmcweb#configuration with build-time options to
431 - enable downloading firmware images from a TFTP server
432 - enable the "http" URI scheme
433 - others
435 The webserver also sets up Secure Websockets for services such as KVM-IP,
436 Virtual-USB, and more.
442 here: https://github.com/openbmc/docs/blob/master/REDFISH-cheatsheet.md
444 ### phosphor-dbus-rest
447 https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md
449 ### KVM-IP
453 (KVM) remotely. See https://github.com/openbmc/obmc-ikvm/blob/master/README.md
458 Also known as: remote media and USB-over-IP. Design:
460 with LAN-over-USB.
464 Also known as USB-over-IP, and helps implement virtual media. Contrast with the