Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-ikvm / abd331b7bfbe70dceb2a3cb4dc7998e35d3af99e
commitabd331b7bfbe70dceb2a3cb4dc7998e35d3af99e[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Wed Dec 07 05:51:11 2022 -0600
committerPatrick Williams <patrick@stwcx.xyz>Wed Dec 07 05:51:11 2022 -0600
tree6589d8253c297dfd87736f32bab2c282ed8c6f14
parent67a9bd4b7ef160723dc5e8699f61a7860b49edef [diff]
README: run prettier to reformat

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I39dbfbc7fd4b5637c0637a53e4e61ef2840c362d
1 file changed
tree: 6589d8253c297dfd87736f32bab2c282ed8c6f14
  1. .clang-format
  2. create_usbhid.sh
  3. ikvm_args.cpp
  4. ikvm_args.hpp
  5. ikvm_input.cpp
  6. ikvm_input.hpp
  7. ikvm_manager.cpp
  8. ikvm_manager.hpp
  9. ikvm_server.cpp
  10. ikvm_server.hpp
  11. ikvm_video.cpp
  12. ikvm_video.hpp
  13. LICENSE
  14. meson.build
  15. obmc-ikvm.cpp
  16. OWNERS
  17. README.md
  18. scancodes.hpp
  19. start-ipkvm.service
README.md

OpenBMC IpKVM Server

The obmc-ikvm application is a VNC server that provides access to the host graphics output. The application interfaces with the video device on the BMC that captures the host graphics, and then serves that video data on the RFB (remote framebuffer, also known as VNC) protocol. The application also interfaces with the BMC USB gadget device to pass HID events from the BMC to the host, allowing the user to interact with the host system.

Usage

Once the host is running and an appropriate HID gadget device is instantiated on the BMC, the application can be started with the following command: obmc-ikvm -v <video device path> -i <HID gadget device path>

For example:

obmc-ikvm -v /dev/video0 -i /dev/hidg0