├── .gitignore
├── subprojects
    ├── phosphor-logging.wrap
    ├── packagefiles
    │   └── boost
    │   │   └── meson.build
    └── boost.wrap
├── obmc-ikvm.cpp
├── obmc-ikvm.service
├── meson.build
├── OWNERS
├── ikvm_manager.cpp
├── ikvm_manager.hpp
├── README.md
├── ikvm_args.cpp
├── scancodes.hpp
├── .clang-format
├── ikvm_args.hpp
├── ikvm_input.hpp
├── ikvm_video.hpp
├── ikvm_server.hpp
├── create_usbhid.sh
├── ikvm_server.cpp
├── ikvm_video.cpp
├── ikvm_input.cpp
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | build*/
2 | subprojects/*
3 | !subprojects/phosphor-logging.wrap
4 | !subprojects/boost.wrap
5 | !subprojects/packagefiles
6 | 


--------------------------------------------------------------------------------
/subprojects/phosphor-logging.wrap:
--------------------------------------------------------------------------------
1 | [wrap-git]
2 | url = https://github.com/openbmc/phosphor-logging.git
3 | revision = HEAD
4 | 
5 | [provide]
6 | phosphor-logging = phosphor_logging_dep
7 | 


--------------------------------------------------------------------------------
/subprojects/packagefiles/boost/meson.build:
--------------------------------------------------------------------------------
1 | project('boost', 'cpp', version: '1.84.0', license: 'Boost')
2 | 
3 | boost_dep = declare_dependency(include_directories: include_directories('.'))
4 | 
5 | meson.override_dependency('boost', boost_dep)
6 | 


--------------------------------------------------------------------------------
/obmc-ikvm.cpp:
--------------------------------------------------------------------------------
 1 | #include "ikvm_args.hpp"
 2 | #include "ikvm_manager.hpp"
 3 | 
 4 | int main(int argc, char* argv[])
 5 | {
 6 |     ikvm::Args args(argc, argv);
 7 |     ikvm::Manager manager(args);
 8 | 
 9 |     manager.run();
10 | 
11 |     return 0;
12 | }
13 | 


--------------------------------------------------------------------------------
/obmc-ikvm.service:
--------------------------------------------------------------------------------
 1 | [Unit]
 2 | Description=OpenBMC ipKVM daemon
 3 | ConditionPathIsMountPoint=/sys/kernel/config
 4 | 
 5 | [Service]
 6 | Restart=always
 7 | ExecStartPre=/usr/bin/create_usbhid.sh disconnect
 8 | ExecStart=/usr/bin/obmc-ikvm -v /dev/video0 -k /dev/hidg0 -p /dev/hidg1
 9 | 
10 | [Install]
11 | WantedBy=multi-user.target
12 | 


--------------------------------------------------------------------------------
/subprojects/boost.wrap:
--------------------------------------------------------------------------------
 1 | [wrap-file]
 2 | directory = boost_1_84_0
 3 | 
 4 | source_url = https://boostorg.jfrog.io/artifactory/main/release/1.84.0/source/boost_1_84_0.tar.bz2
 5 | source_hash = cc4b893acf645c9d4b698e9a0f08ca8846aa5d6c68275c14c3e7949c24109454
 6 | source_filename = 1_84_0.tar.bz2
 7 | 
 8 | patch_directory = boost
 9 | 
10 | [provide]
11 | boost = boost_dep
12 | 


--------------------------------------------------------------------------------
/meson.build:
--------------------------------------------------------------------------------
 1 | project(
 2 |     'obmc-ikvm',
 3 |     'cpp',
 4 |     version: '1.0',
 5 |     license: 'GPLv2',
 6 |     default_options: ['cpp_std=c++23', 'werror=true'],
 7 |     meson_version: '>=1.1.1',
 8 | )
 9 | 
10 | install_data(
11 |     'create_usbhid.sh',
12 |     install_mode: 'rwxr-xr-x',
13 |     install_dir: get_option('bindir'),
14 | )
15 | 
16 | executable(
17 |     'obmc-ikvm',
18 |     [
19 |         'ikvm_args.cpp',
20 |         'ikvm_input.cpp',
21 |         'ikvm_manager.cpp',
22 |         'ikvm_server.cpp',
23 |         'ikvm_video.cpp',
24 |         'obmc-ikvm.cpp',
25 |     ],
26 |     dependencies: [
27 |         dependency('libvncserver'),
28 |         dependency('phosphor-logging'),
29 |         dependency('phosphor-dbus-interfaces'),
30 |         dependency('sdbusplus'),
31 |         dependency('threads'),
32 |         dependency('boost'),
33 |     ],
34 |     install: true,
35 | )
36 | 
37 | fs = import('fs')
38 | fs.copyfile(
39 |     'obmc-ikvm.service',
40 |     install: true,
41 |     install_dir: dependency('systemd').get_variable('systemd_system_unit_dir'),
42 | )
43 | 


--------------------------------------------------------------------------------
/OWNERS:
--------------------------------------------------------------------------------
 1 | # OWNERS
 2 | # ------
 3 | #
 4 | # The OWNERS file maintains the list of individuals responsible for various
 5 | # parts of this repository, including code review and approval.  We use the
 6 | # Gerrit 'owners' plugin, which consumes this file, along with some extra
 7 | # keywords for our own purposes and tooling.
 8 | #
 9 | # For details on the configuration used by 'owners' see:
10 | #  https://gerrit.googlesource.com/plugins/owners/+/refs/heads/master/owners/src/main/resources/Documentation/config.md
11 | #
12 | # An OWNERS file must be in the root of a repository but may also be present
13 | # in any subdirectory.  The contents of the subdirectory OWNERS file are
14 | # combined with parent directories unless 'inherit: false' is set.
15 | #
16 | # The owners file is YAML and has [up to] 4 top-level keywords.
17 | #   * owners: A list of individuals who have approval authority on the
18 | #     repository.
19 | #
20 | #   * reviewers: A list of individuals who have requested review notification
21 | #     on the repository.
22 | #
23 | #   * matchers: A list of specific file/path matchers for granular 'owners' and
24 | #     'reviewers'.  See 'owners' plugin documentation.
25 | #
26 | #   * openbmc: A list of openbmc-specific meta-data about owners and reviewers.
27 | #     - name: preferred name of the individual.
28 | #     - email: preferred email address of the individual.
29 | #     - discord: Discord nickname of the individual.
30 | #
31 | # It is expected that these 4 sections will be listed in the order above and
32 | # data within them will be kept sorted.
33 | 
34 | owners:
35 | - eajames@linux.ibm.com
36 | - jae.hyun.yoo@linux.intel.com
37 | 
38 | reviewers:
39 | 
40 | matchers:
41 | 
42 | openbmc:
43 | - name: Eddie James
44 |   email: eajames@linux.ibm.com
45 |   discord: eajames
46 | - name: Jae Hyun Yoo
47 |   email: jae.hyun.yoo@linux.intel.com
48 |   discord: jae
49 | 


--------------------------------------------------------------------------------
/ikvm_manager.cpp:
--------------------------------------------------------------------------------
  1 | #include "ikvm_manager.hpp"
  2 | 
  3 | #include <thread>
  4 | 
  5 | namespace ikvm
  6 | {
  7 | Manager::Manager(const Args& args) :
  8 |     continueExecuting(true), serverDone(false), videoDone(true),
  9 |     input(args.getKeyboardPath(), args.getPointerPath(), args.getUdcName()),
 10 |     video(args.getVideoPath(), input, args.getFrameRate(),
 11 |           args.getSubsampling()),
 12 |     server(args, input, video)
 13 | {}
 14 | 
 15 | void Manager::run()
 16 | {
 17 |     std::thread run(serverThread, this);
 18 | 
 19 |     while (continueExecuting)
 20 |     {
 21 |         if (server.wantsFrame())
 22 |         {
 23 |             video.start();
 24 |             video.getFrame();
 25 |             server.sendFrame();
 26 |         }
 27 |         else
 28 |         {
 29 |             video.stop();
 30 |         }
 31 | 
 32 |         if (video.needsResize())
 33 |         {
 34 |             waitServer();
 35 |             videoDone = false;
 36 |             video.resize();
 37 |             server.resize();
 38 |             setVideoDone();
 39 |         }
 40 |         else
 41 |         {
 42 |             setVideoDone();
 43 |             waitServer();
 44 |         }
 45 |     }
 46 | 
 47 |     run.join();
 48 | }
 49 | 
 50 | void Manager::serverThread(Manager* manager)
 51 | {
 52 |     while (manager->continueExecuting)
 53 |     {
 54 |         manager->server.run();
 55 |         manager->setServerDone();
 56 |         manager->waitVideo();
 57 |     }
 58 | }
 59 | 
 60 | void Manager::setServerDone()
 61 | {
 62 |     std::unique_lock<std::mutex> ulock(lock);
 63 | 
 64 |     serverDone = true;
 65 |     sync.notify_all();
 66 | }
 67 | 
 68 | void Manager::setVideoDone()
 69 | {
 70 |     std::unique_lock<std::mutex> ulock(lock);
 71 | 
 72 |     videoDone = true;
 73 |     sync.notify_all();
 74 | }
 75 | 
 76 | void Manager::waitServer()
 77 | {
 78 |     std::unique_lock<std::mutex> ulock(lock);
 79 | 
 80 |     while (!serverDone)
 81 |     {
 82 |         sync.wait(ulock);
 83 |     }
 84 | 
 85 |     serverDone = false;
 86 | }
 87 | 
 88 | void Manager::waitVideo()
 89 | {
 90 |     std::unique_lock<std::mutex> ulock(lock);
 91 | 
 92 |     while (!videoDone)
 93 |     {
 94 |         sync.wait(ulock);
 95 |     }
 96 | 
 97 |     // don't reset videoDone
 98 | }
 99 | 
100 | } // namespace ikvm
101 | 


--------------------------------------------------------------------------------
/ikvm_manager.hpp:
--------------------------------------------------------------------------------
 1 | #pragma once
 2 | 
 3 | #include "ikvm_args.hpp"
 4 | #include "ikvm_input.hpp"
 5 | #include "ikvm_server.hpp"
 6 | #include "ikvm_video.hpp"
 7 | 
 8 | #include <condition_variable>
 9 | #include <mutex>
10 | 
11 | namespace ikvm
12 | {
13 | /*
14 |  * @class Manager
15 |  * @brief Manages the VNC server by executing threaded loops of RFB operations
16 |  *        and video device operations.
17 |  */
18 | class Manager
19 | {
20 |   public:
21 |     /*
22 |      * @brief Constructs the Manager object
23 |      *
24 |      * @param[in] args - Reference to Args object
25 |      */
26 |     explicit Manager(const Args& args);
27 |     ~Manager() = default;
28 |     Manager(const Manager&) = default;
29 |     Manager& operator=(const Manager&) = default;
30 |     Manager(Manager&&) = default;
31 |     Manager& operator=(Manager&&) = default;
32 | 
33 |     /* @brief Begins operation of the VNC server */
34 |     void run();
35 | 
36 |   private:
37 |     /*
38 |      * @brief Thread function to loop the RFB update operations
39 |      *
40 |      * @param[in] manager - Pointer to the Manager object
41 |      */
42 |     static void serverThread(Manager* manager);
43 | 
44 |     /* @brief Notifies thread waiters that RFB operations are complete */
45 |     void setServerDone();
46 |     /* @brief Notifies thread waiters that video operations are complete */
47 |     void setVideoDone();
48 |     /* @brief Blocks until RFB operations complete */
49 |     void waitServer();
50 |     /* @brief Blocks until video operations are complete */
51 |     void waitVideo();
52 | 
53 |     /*
54 |      * @brief Boolean to indicate whether the application should continue
55 |      *        running
56 |      */
57 |     bool continueExecuting;
58 |     /* @brief Boolean to indicate that RFB operations are complete */
59 |     bool serverDone;
60 |     /* @brief Boolean to indicate that video operations are complete */
61 |     bool videoDone;
62 |     /* @brief Input object */
63 |     Input input;
64 |     /* @brief Video object */
65 |     Video video;
66 |     /* @brief RFB server object */
67 |     Server server;
68 |     /* @brief Condition variable to enable waiting for thread completion */
69 |     std::condition_variable sync;
70 |     /* @brief Mutex for waiting on condition variable safely */
71 |     std::mutex lock;
72 | };
73 | 
74 | } // namespace ikvm
75 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # OpenBMC IpKVM Server
 2 | 
 3 | The obmc-ikvm application is a VNC server that provides access to the host
 4 | graphics output. The application interfaces with the video device on the BMC
 5 | that captures the host graphics, and then serves that video data on the RFB
 6 | (remote framebuffer, also known as VNC) protocol. The application also
 7 | interfaces with the BMC USB gadget device to pass HID events from the BMC to the
 8 | host, allowing the user to interact with the host system.
 9 | 
10 | ## Usage
11 | 
12 | Once the host is running and an appropriate HID gadget device is instantiated on
13 | the BMC, the application can be started with the following command:
14 | `obmc-ikvm -v <video device path> -i <HID gadget device path>`
15 | 
16 | For example:
17 | 
18 | `obmc-ikvm -v /dev/video0 -i /dev/hidg0`
19 | 
20 | ## Accessing Remote KVM via Web Interface
21 | 
22 | 1. Log in to the BMC Web UI.
23 | 2. Navigate to **Operations** > **KVM**.
24 | 3. The host's graphical output will be displayed, and you can interact with it
25 |    directly from your browser.
26 | 
27 | ## Accessing Remote KVM via VNC Client
28 | 
29 | Direct access to the BMC KVM port (usually 5900) is generally blocked to prevent
30 | unencrypted connections. To securely connect to the KVM, use a VNC client over
31 | an SSH tunnel.
32 | 
33 | **Note:** SSH local port forwarding must be enabled on the BMC. If you are using
34 | Dropbear, make sure it is started without the `-j` option.
35 | 
36 | 1. Create an SSH tunnel to forward the KVM port from the BMC to your local
37 |    machine:
38 | 
39 |    ```bash
40 |    ssh -L <localport>:localhost:<bmc-kvm-port> <bmc-user>@<bmc-hostname>
41 |    ```
42 | 
43 |    - `localport`: The port number your VNC client will use locally (e.g., 1234)
44 |    - `bmc-kvm-port`: The port used by the KVM service on the BMC (usually 5900)
45 |    - `bmc-user`: Your SSH username for the BMC
46 |    - `bmc-hostname`: The IP address or hostname of the BMC
47 | 
48 |    **Example:**
49 | 
50 |    ```bash
51 |    ssh -L 1234:localhost:5900 root@192.168.1.1
52 |    ```
53 | 
54 | 2. Open your VNC client and connect to `localhost:<localport>`. For example,
55 |    `localhost:1234`.
56 | 
57 | **Note:** Due to CPU and hardware encoder limitations on some BMC platforms, not
58 | all VNC clients may work reliably. For example, certain clients may experience
59 | display or input issues when connecting to iKVM. If you encounter problems, try
60 | using a different VNC client or refer to your platform's documentation for
61 | compatibility details.
62 | 
63 | You should now be able to view and interact with the host's graphical output as
64 | if you were using a local monitor, keyboard, and mouse.
65 | 


--------------------------------------------------------------------------------
/ikvm_args.cpp:
--------------------------------------------------------------------------------
 1 | #include "ikvm_args.hpp"
 2 | 
 3 | #include <getopt.h>
 4 | #include <rfb/rfb.h>
 5 | #include <stdio.h>
 6 | #include <stdlib.h>
 7 | 
 8 | namespace ikvm
 9 | {
10 | Args::Args(int argc, char* argv[]) :
11 |     frameRate(30), subsampling(0), calcFrameCRC{false}, commandLine(argc, argv)
12 | {
13 |     int option;
14 |     const char* opts = "f:s:h:k:p:u:v:c";
15 |     struct option lopts[] = {
16 |         {"frameRate", 1, 0, 'f'},
17 |         {"subsampling", 1, 0, 's'},
18 |         {"help", 0, 0, 'h'},
19 |         {"keyboard", 1, 0, 'k'},
20 |         {"mouse", 1, 0, 'p'},
21 |         {"udcName", 1, 0, 'u'},
22 |         {"videoDevice", 1, 0, 'v'},
23 |         {"calcCRC", 0, 0, 'c'},
24 |         {0, 0, 0, 0}};
25 | 
26 |     while ((option = getopt_long(argc, argv, opts, lopts, NULL)) != -1)
27 |     {
28 |         switch (option)
29 |         {
30 |             case 'f':
31 |                 frameRate = (int)strtol(optarg, NULL, 0);
32 |                 if (frameRate < 0 || frameRate > 60)
33 |                     frameRate = 30;
34 |                 break;
35 |             case 's':
36 |                 subsampling = (int)strtol(optarg, NULL, 0);
37 |                 if (subsampling < 0 || subsampling > 1)
38 |                     subsampling = 0;
39 |                 break;
40 |             case 'h':
41 |                 printUsage();
42 |                 exit(0);
43 |             case 'k':
44 |                 keyboardPath = std::string(optarg);
45 |                 break;
46 |             case 'p':
47 |                 pointerPath = std::string(optarg);
48 |                 break;
49 |             case 'u':
50 |                 udcName = std::string(optarg);
51 |                 break;
52 |             case 'v':
53 |                 videoPath = std::string(optarg);
54 |                 break;
55 |             case 'c':
56 |                 calcFrameCRC = true;
57 |                 break;
58 |         }
59 |     }
60 | }
61 | 
62 | void Args::printUsage()
63 | {
64 |     // use fprintf(stderr to match rfbUsage()
65 |     fprintf(stderr, "OpenBMC IKVM daemon\n");
66 |     fprintf(stderr, "Usage: obmc-ikvm [options]\n");
67 |     fprintf(stderr, "-f frame rate          try this frame rate\n");
68 |     fprintf(stderr, "-s subsampling         try this subsampling\n");
69 |     fprintf(stderr, "-h, --help             show this message and exit\n");
70 |     fprintf(stderr, "-k device              HID keyboard gadget device\n");
71 |     fprintf(stderr, "-p device              HID mouse gadget device\n");
72 |     fprintf(stderr,
73 |             "-u udc name            UDC that HID gadget will connect to\n");
74 |     fprintf(stderr, "-v device              V4L2 device\n");
75 |     fprintf(
76 |         stderr,
77 |         "-c, --calcCRC          Calculate CRC for each frame to save bandwidth\n");
78 |     rfbUsage();
79 | }
80 | 
81 | } // namespace ikvm
82 | 


--------------------------------------------------------------------------------
/scancodes.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #define USBHID_KEY_A 0x04
  4 | #define USBHID_KEY_B 0x05
  5 | #define USBHID_KEY_C 0x06
  6 | #define USBHID_KEY_D 0x07
  7 | #define USBHID_KEY_E 0x08
  8 | #define USBHID_KEY_F 0x09
  9 | #define USBHID_KEY_G 0x0a
 10 | #define USBHID_KEY_H 0x0b
 11 | #define USBHID_KEY_I 0x0c
 12 | #define USBHID_KEY_J 0x0d
 13 | #define USBHID_KEY_K 0x0e
 14 | #define USBHID_KEY_L 0x0f
 15 | #define USBHID_KEY_M 0x10
 16 | #define USBHID_KEY_N 0x11
 17 | #define USBHID_KEY_O 0x12
 18 | #define USBHID_KEY_P 0x13
 19 | #define USBHID_KEY_Q 0x14
 20 | #define USBHID_KEY_R 0x15
 21 | #define USBHID_KEY_S 0x16
 22 | #define USBHID_KEY_T 0x17
 23 | #define USBHID_KEY_U 0x18
 24 | #define USBHID_KEY_V 0x19
 25 | #define USBHID_KEY_W 0x1a
 26 | #define USBHID_KEY_X 0x1b
 27 | #define USBHID_KEY_Y 0x1c
 28 | #define USBHID_KEY_Z 0x1d
 29 | #define USBHID_KEY_1 0x1e
 30 | #define USBHID_KEY_2 0x1f
 31 | #define USBHID_KEY_3 0x20
 32 | #define USBHID_KEY_4 0x21
 33 | #define USBHID_KEY_5 0x22
 34 | #define USBHID_KEY_6 0x23
 35 | #define USBHID_KEY_7 0x24
 36 | #define USBHID_KEY_8 0x25
 37 | #define USBHID_KEY_9 0x26
 38 | #define USBHID_KEY_0 0x27
 39 | #define USBHID_KEY_RETURN 0x28
 40 | #define USBHID_KEY_ESC 0x29
 41 | #define USBHID_KEY_BACKSPACE 0x2a
 42 | #define USBHID_KEY_TAB 0x2b
 43 | #define USBHID_KEY_SPACE 0x2c
 44 | #define USBHID_KEY_MINUS 0x2d
 45 | #define USBHID_KEY_EQUAL 0x2e
 46 | #define USBHID_KEY_LEFTBRACE 0x2f
 47 | #define USBHID_KEY_RIGHTBRACE 0x30
 48 | #define USBHID_KEY_BACKSLASH 0x31
 49 | #define USBHID_KEY_HASH 0x32
 50 | #define USBHID_KEY_SEMICOLON 0x33
 51 | #define USBHID_KEY_APOSTROPHE 0x34
 52 | #define USBHID_KEY_GRAVE 0x35
 53 | #define USBHID_KEY_COMMA 0x36
 54 | #define USBHID_KEY_DOT 0x37
 55 | #define USBHID_KEY_SLASH 0x38
 56 | #define USBHID_KEY_CAPSLOCK 0x39
 57 | #define USBHID_KEY_F1 0x3a
 58 | #define USBHID_KEY_F2 0x3b
 59 | #define USBHID_KEY_F3 0x3c
 60 | #define USBHID_KEY_F4 0x3d
 61 | #define USBHID_KEY_F5 0x3e
 62 | #define USBHID_KEY_F6 0x3f
 63 | #define USBHID_KEY_F7 0x40
 64 | #define USBHID_KEY_F8 0x41
 65 | #define USBHID_KEY_F9 0x42
 66 | #define USBHID_KEY_F10 0x43
 67 | #define USBHID_KEY_F11 0x44
 68 | #define USBHID_KEY_F12 0x45
 69 | #define USBHID_KEY_PRINT 0x46
 70 | #define USBHID_KEY_SCROLLLOCK 0x47
 71 | #define USBHID_KEY_PAUSE 0x48
 72 | #define USBHID_KEY_INSERT 0x49
 73 | #define USBHID_KEY_HOME 0x4a
 74 | #define USBHID_KEY_PAGEUP 0x4b
 75 | #define USBHID_KEY_DELETE 0x4c
 76 | #define USBHID_KEY_END 0x4d
 77 | #define USBHID_KEY_PAGEDOWN 0x4e
 78 | #define USBHID_KEY_RIGHT 0x4f
 79 | #define USBHID_KEY_LEFT 0x50
 80 | #define USBHID_KEY_DOWN 0x51
 81 | #define USBHID_KEY_UP 0x52
 82 | #define USBHID_KEY_NUMLOCK 0x53
 83 | #define USBHID_KEY_KP_DIVIDE 0x54
 84 | #define USBHID_KEY_KP_MULTIPLY 0x55
 85 | #define USBHID_KEY_KP_SUBTRACT 0x56
 86 | #define USBHID_KEY_KP_ADD 0x57
 87 | #define USBHID_KEY_KP_ENTER 0x58
 88 | #define USBHID_KEY_KP_1 0x59
 89 | #define USBHID_KEY_KP_2 0x5a
 90 | #define USBHID_KEY_KP_3 0x5b
 91 | #define USBHID_KEY_KP_4 0x5c
 92 | #define USBHID_KEY_KP_5 0x5d
 93 | #define USBHID_KEY_KP_6 0x5e
 94 | #define USBHID_KEY_KP_7 0x5f
 95 | #define USBHID_KEY_KP_8 0x60
 96 | #define USBHID_KEY_KP_9 0x61
 97 | #define USBHID_KEY_KP_0 0x62
 98 | #define USBHID_KEY_KP_DECIMAL 0x63
 99 | #define USBHID_KEY_KP_EQUAL 0x67
100 | 


--------------------------------------------------------------------------------
/.clang-format:
--------------------------------------------------------------------------------
  1 | ---
  2 | Language:        Cpp
  3 | # BasedOnStyle:  LLVM
  4 | AccessModifierOffset: -2
  5 | AlignAfterOpenBracket: Align
  6 | AlignConsecutiveAssignments: false
  7 | AlignConsecutiveDeclarations: false
  8 | AlignEscapedNewlines: Right
  9 | AlignOperands:  Align
 10 | AlignTrailingComments:
 11 |   Kind: Always
 12 |   OverEmptyLines: 1
 13 | AllowAllParametersOfDeclarationOnNextLine: true
 14 | AllowShortBlocksOnASingleLine: Empty
 15 | AllowShortCaseLabelsOnASingleLine: false
 16 | AllowShortFunctionsOnASingleLine: Empty
 17 | AllowShortIfStatementsOnASingleLine: Never
 18 | AllowShortLambdasOnASingleLine: true
 19 | AllowShortLoopsOnASingleLine: false
 20 | AlwaysBreakBeforeMultilineStrings: false
 21 | BinPackArguments: true
 22 | BinPackParameters: true
 23 | BitFieldColonSpacing: None
 24 | BraceWrapping:
 25 |   AfterCaseLabel:  true
 26 |   AfterClass:      true
 27 |   AfterControlStatement: true
 28 |   AfterEnum:       true
 29 |   AfterExternBlock: true
 30 |   AfterFunction:   true
 31 |   AfterNamespace:  true
 32 |   AfterObjCDeclaration: true
 33 |   AfterStruct:     true
 34 |   AfterUnion:      true
 35 |   BeforeCatch:     true
 36 |   BeforeElse:      true
 37 |   BeforeLambdaBody: false
 38 |   BeforeWhile:     false
 39 |   IndentBraces:    false
 40 |   SplitEmptyFunction:   false
 41 |   SplitEmptyRecord:     false
 42 |   SplitEmptyNamespace:  false
 43 | BreakAfterAttributes: Never
 44 | BreakAfterReturnType: Automatic
 45 | BreakBeforeBinaryOperators: None
 46 | BreakBeforeBraces: Custom
 47 | BreakBeforeTernaryOperators: true
 48 | BreakConstructorInitializers: AfterColon
 49 | BreakInheritanceList: AfterColon
 50 | BreakStringLiterals: false
 51 | BreakTemplateDeclarations: Yes
 52 | ColumnLimit:     80
 53 | CommentPragmas:  '^ IWYU pragma:'
 54 | CompactNamespaces: false
 55 | ConstructorInitializerIndentWidth: 4
 56 | ContinuationIndentWidth: 4
 57 | Cpp11BracedListStyle: true
 58 | DerivePointerAlignment: false
 59 | DisableFormat:   false
 60 | FixNamespaceComments: true
 61 | ForEachMacros:
 62 |   - foreach
 63 |   - Q_FOREACH
 64 |   - BOOST_FOREACH
 65 | IncludeBlocks: Regroup
 66 | IncludeCategories:
 67 |   - Regex:           '^[<"](gtest|gmock)'
 68 |     Priority:        7
 69 |   - Regex:           '^"config.h"'
 70 |     Priority:        -1
 71 |   - Regex:           '^".*\.h"'
 72 |     Priority:        1
 73 |   - Regex:           '^".*\.hpp"'
 74 |     Priority:        2
 75 |   - Regex:           '^<.*\.h>'
 76 |     Priority:        3
 77 |   - Regex:           '^<.*\.hpp>'
 78 |     Priority:        4
 79 |   - Regex:           '^<.*'
 80 |     Priority:        5
 81 |   - Regex:           '.*'
 82 |     Priority:        6
 83 | IndentCaseLabels: true
 84 | IndentExternBlock: NoIndent
 85 | IndentRequiresClause: true
 86 | IndentWidth:     4
 87 | IndentWrappedFunctionNames: true
 88 | InsertNewlineAtEOF: true
 89 | KeepEmptyLinesAtTheStartOfBlocks: false
 90 | LambdaBodyIndentation: Signature
 91 | LineEnding: LF
 92 | MacroBlockBegin: ''
 93 | MacroBlockEnd:   ''
 94 | MaxEmptyLinesToKeep: 1
 95 | NamespaceIndentation: None
 96 | ObjCBlockIndentWidth: 2
 97 | ObjCSpaceAfterProperty: false
 98 | ObjCSpaceBeforeProtocolList: true
 99 | PackConstructorInitializers: BinPack
100 | PenaltyBreakAssignment: 25
101 | PenaltyBreakBeforeFirstCallParameter: 50
102 | PenaltyBreakComment: 300
103 | PenaltyBreakFirstLessLess: 120
104 | PenaltyBreakString: 1000
105 | PenaltyBreakTemplateDeclaration: 10
106 | PenaltyExcessCharacter: 1000000
107 | PenaltyReturnTypeOnItsOwnLine: 150
108 | PenaltyIndentedWhitespace: 1
109 | PointerAlignment: Left
110 | QualifierAlignment: Left
111 | ReferenceAlignment: Left
112 | ReflowComments:  true
113 | RequiresClausePosition: OwnLine
114 | RequiresExpressionIndentation: Keyword
115 | SortIncludes: CaseSensitive
116 | SortUsingDeclarations: true
117 | SpaceAfterCStyleCast: false
118 | SpaceAfterTemplateKeyword: true
119 | SpaceBeforeAssignmentOperators: true
120 | SpaceBeforeCpp11BracedList: false
121 | SpaceBeforeCtorInitializerColon: true
122 | SpaceBeforeInheritanceColon: true
123 | SpaceBeforeParens: ControlStatements
124 | SpaceBeforeRangeBasedForLoopColon: true
125 | SpaceInEmptyParentheses: false
126 | SpacesBeforeTrailingComments: 1
127 | SpacesInAngles: Never
128 | SpacesInContainerLiterals: true
129 | SpacesInCStyleCastParentheses: false
130 | SpacesInParentheses: false
131 | SpacesInSquareBrackets: false
132 | Standard:        Latest
133 | TabWidth:        4
134 | UseTab:          Never
135 | ...
136 | 
137 | 


--------------------------------------------------------------------------------
/ikvm_args.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include <string>
  4 | 
  5 | namespace ikvm
  6 | {
  7 | /*
  8 |  * @class Args
  9 |  * @brief Command line argument parser and storage
 10 |  */
 11 | class Args
 12 | {
 13 |   public:
 14 |     /*
 15 |      * @struct CommandLine
 16 |      * @brief Stores the original command line arguments for later use
 17 |      */
 18 |     struct CommandLine
 19 |     {
 20 |         /*
 21 |          * @brief Constructs CommandLine object
 22 |          *
 23 |          * @param[in] c - Number of arguments
 24 |          * @param[in] v - Array of arguments
 25 |          */
 26 |         CommandLine(int c, char** v) : argc(c), argv(v) {}
 27 |         ~CommandLine() = default;
 28 |         CommandLine(const CommandLine&) = default;
 29 |         CommandLine& operator=(const CommandLine&) = default;
 30 |         CommandLine(CommandLine&&) = default;
 31 |         CommandLine& operator=(CommandLine&&) = default;
 32 | 
 33 |         int argc;
 34 |         char** argv;
 35 |     };
 36 | 
 37 |     /*
 38 |      * @brief Constructs Args object
 39 |      *
 40 |      * @param[in] argc - The number of arguments in the command line call
 41 |      * @param[in] argv - The array of arguments from the command line
 42 |      */
 43 |     Args(int argc, char* argv[]);
 44 |     ~Args() = default;
 45 |     Args(const Args&) = default;
 46 |     Args& operator=(const Args&) = default;
 47 |     Args(Args&&) = default;
 48 |     Args& operator=(Args&&) = default;
 49 | 
 50 |     /*
 51 |      * @brief Get the original command line arguments
 52 |      *
 53 |      * @return Reference to the CommandLine structure storing the original
 54 |      *         command line arguments
 55 |      */
 56 |     inline const CommandLine& getCommandLine() const
 57 |     {
 58 |         return commandLine;
 59 |     }
 60 | 
 61 |     /*
 62 |      * @brief Get the desired video frame rate
 63 |      *
 64 |      * @return Value of the desired frame rate in frames per second
 65 |      */
 66 |     inline int getFrameRate() const
 67 |     {
 68 |         return frameRate;
 69 |     }
 70 | 
 71 |     /*
 72 |      * @brief Get the video subsampling
 73 |      *
 74 |      * @return Value of the video subsampling
 75 |      */
 76 |     inline int getSubsampling() const
 77 |     {
 78 |         return subsampling;
 79 |     }
 80 | 
 81 |     /*
 82 |      * @brief Get the path to the USB keyboard device
 83 |      *
 84 |      * @return Reference to the string storing the path to the keyboard device
 85 |      */
 86 |     inline const std::string& getKeyboardPath() const
 87 |     {
 88 |         return keyboardPath;
 89 |     }
 90 | 
 91 |     /*
 92 |      * @brief Get the path to the USB mouse device
 93 |      *
 94 |      * @return Reference to the string storing the path to the mouse device
 95 |      */
 96 |     inline const std::string& getPointerPath() const
 97 |     {
 98 |         return pointerPath;
 99 |     }
100 | 
101 |     /*
102 |      * @brief Get the name of UDC
103 |      *
104 |      * @return Reference to the string storing the name of UDC
105 |      */
106 |     inline const std::string& getUdcName() const
107 |     {
108 |         return udcName;
109 |     }
110 | 
111 |     /*
112 |      * @brief Get the path to the V4L2 video device
113 |      *
114 |      * @return Reference to the string storing the path to the video device
115 |      */
116 |     inline const std::string& getVideoPath() const
117 |     {
118 |         return videoPath;
119 |     }
120 | 
121 |     /*
122 |      * @brief Get the identical frames detection setting
123 |      *
124 |      * @return True if identical frames detection is enabled
125 |      */
126 |     inline bool getCalcFrameCRC() const
127 |     {
128 |         return calcFrameCRC;
129 |     }
130 | 
131 |   private:
132 |     /* @brief Prints the application usage to stderr */
133 |     void printUsage();
134 | 
135 |     /*
136 |      * @brief Desired frame rate (in frames per second) of the video
137 |      *        stream
138 |      */
139 |     int frameRate;
140 |     /* @brief Desired subsampling (0: 444, 1: 420) */
141 |     int subsampling;
142 |     /* @brief Path to the USB keyboard device */
143 |     std::string keyboardPath;
144 |     /* @brief Path to the USB mouse device */
145 |     std::string pointerPath;
146 |     /* @brief Name of UDC */
147 |     std::string udcName;
148 |     /* @brief Path to the V4L2 video device */
149 |     std::string videoPath;
150 |     /* @brief Identical frames detection */
151 |     bool calcFrameCRC;
152 |     /* @brief Original command line arguments passed to the application */
153 |     CommandLine commandLine;
154 | };
155 | 
156 | } // namespace ikvm
157 | 


--------------------------------------------------------------------------------
/ikvm_input.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include <rfb/rfb.h>
  4 | 
  5 | #include <filesystem>
  6 | #include <fstream>
  7 | #include <map>
  8 | #include <mutex>
  9 | #include <string>
 10 | 
 11 | namespace ikvm
 12 | {
 13 | /*
 14 |  * @class Input
 15 |  * @brief Receives events from RFB clients and sends reports to the USB input
 16 |  *        device
 17 |  */
 18 | class Input
 19 | {
 20 |   public:
 21 |     /*
 22 |      * @brief Constructs Input object
 23 |      *
 24 |      * @param[in] kbdPath - Path to the USB keyboard device
 25 |      * @param[in] ptrPath - Path to the USB mouse device
 26 |      * @param[in] udc - Name of UDC
 27 |      */
 28 |     Input(const std::string& kbdPath, const std::string& ptrPath,
 29 |           const std::string& udc);
 30 |     ~Input();
 31 |     Input(const Input&) = default;
 32 |     Input& operator=(const Input&) = default;
 33 |     Input(Input&&) = default;
 34 |     Input& operator=(Input&&) = default;
 35 | 
 36 |     /* @brief Connects HID gadget to host */
 37 |     void connect();
 38 |     /* @brief Disconnects HID gadget from host */
 39 |     void disconnect();
 40 |     /*
 41 |      * @brief RFB client key event handler
 42 |      *
 43 |      * @param[in] down - Boolean indicating whether key is pressed or not
 44 |      * @param[in] key  - Key code
 45 |      * @param[in] cl   - Handle to the RFB client
 46 |      */
 47 |     static void keyEvent(rfbBool down, rfbKeySym key, rfbClientPtr cl);
 48 |     /*
 49 |      * @brief RFB client pointer event handler
 50 |      *
 51 |      * @param[in] buttonMask - Bitmask indicating which buttons have been
 52 |      *                         pressed
 53 |      * @param[in] x          - Pointer x-coordinate
 54 |      * @param[in] y          - Pointer y-coordinate
 55 |      * @param[in] cl         - Handle to the RFB client
 56 |      */
 57 |     static void pointerEvent(int buttonMask, int x, int y, rfbClientPtr cl);
 58 | 
 59 |     /* @brief Sends a wakeup data packet to the USB input device */
 60 |     void sendWakeupPacket();
 61 | 
 62 |   private:
 63 |     static constexpr int NUM_MODIFIER_BITS = 4;
 64 |     static constexpr int KEY_REPORT_LENGTH = 8;
 65 |     static constexpr int PTR_REPORT_LENGTH = 6;
 66 | 
 67 |     /* @brief HID modifier bits mapped to shift and control key codes */
 68 |     static constexpr uint8_t shiftCtrlMap[NUM_MODIFIER_BITS] = {
 69 |         0x02, // left shift
 70 |         0x20, // right shift
 71 |         0x01, // left control
 72 |         0x10  // right control
 73 |     };
 74 |     /* @brief HID modifier bits mapped to meta and alt key codes */
 75 |     static constexpr uint8_t metaAltMap[NUM_MODIFIER_BITS] = {
 76 |         0x08, // left meta
 77 |         0x80, // right meta
 78 |         0x04, // left alt
 79 |         0x40  // right alt
 80 |     };
 81 |     /* @brief Path to the HID gadget UDC */
 82 |     static constexpr const char* hidUdcPath =
 83 |         "/sys/kernel/config/usb_gadget/obmc_hid/UDC";
 84 |     /* @brief Path to the USB virtual hub */
 85 |     static constexpr const char* usbVirtualHubPath =
 86 |         "/sys/bus/platform/devices/1e6a0000.usb-vhub";
 87 |     /* @brief Retry limit for writing an HID report */
 88 |     static constexpr int HID_REPORT_RETRY_MAX = 5;
 89 |     /*
 90 |      * @brief Translates a RFB-specific key code to HID modifier bit
 91 |      *
 92 |      * @param[in] key - key code
 93 |      */
 94 |     static uint8_t keyToMod(rfbKeySym key);
 95 |     /*
 96 |      * @brief Translates a RFB-specific key code to HID scancode
 97 |      *
 98 |      * @param[in] key - key code
 99 |      */
100 |     static uint8_t keyToScancode(rfbKeySym key);
101 | 
102 |     bool writeKeyboard(const uint8_t* report);
103 |     void writePointer(const uint8_t* report);
104 | 
105 |     /* @brief File descriptor for the USB keyboard device */
106 |     int keyboardFd;
107 |     /* @brief File descriptor for the USB mouse device */
108 |     int pointerFd;
109 |     /* @brief Data for keyboard report */
110 |     uint8_t keyboardReport[KEY_REPORT_LENGTH];
111 |     /* @brief Data for pointer report */
112 |     uint8_t pointerReport[PTR_REPORT_LENGTH];
113 |     /* @brief Path to the USB keyboard device */
114 |     std::string keyboardPath;
115 |     /* @brief Path to the USB mouse device */
116 |     std::string pointerPath;
117 |     /* @brief Name of UDC */
118 |     std::string udcName;
119 |     /*
120 |      * @brief Mapping of RFB key code to report data index to keep track
121 |      *        of which keys are down
122 |      */
123 |     std::map<int, int> keysDown;
124 |     /* @brief Handle of the HID gadget UDC */
125 |     std::ofstream hidUdcStream;
126 |     /* @brief Mutex for sending keyboard reports */
127 |     std::mutex keyMutex;
128 |     /* @brief Mutex for sending pointer reports */
129 |     std::mutex ptrMutex;
130 |     /* @brief Mutex for key events */
131 |     std::mutex keyEventMutex;
132 | };
133 | 
134 | } // namespace ikvm
135 | 


--------------------------------------------------------------------------------
/ikvm_video.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include "ikvm_input.hpp"
  4 | 
  5 | #include <mutex>
  6 | #include <string>
  7 | #include <vector>
  8 | 
  9 | namespace ikvm
 10 | {
 11 | 
 12 | /*
 13 |  * @class Video
 14 |  * @brief Sets up the V4L2 video device and performs read operations
 15 |  */
 16 | class Video
 17 | {
 18 |   public:
 19 |     /*
 20 |      * @brief Constructs Video object
 21 |      *
 22 |      * @param[in] p     - Path to the V4L2 video device
 23 |      * @param[in] input - Reference to the Input object
 24 |      * @param[in] fr    - desired frame rate of the video
 25 |      */
 26 |     Video(const std::string& p, Input& input, int fr = 30, int sub = 0);
 27 |     ~Video();
 28 |     Video(const Video&) = default;
 29 |     Video& operator=(const Video&) = default;
 30 |     Video(Video&&) = default;
 31 |     Video& operator=(Video&&) = default;
 32 | 
 33 |     /*
 34 |      * @brief Gets the video frame data
 35 |      *
 36 |      * @return Pointer to the video frame data
 37 |      */
 38 |     char* getData();
 39 |     /* @brief Performs read to grab latest video frame */
 40 |     void getFrame();
 41 |     /*
 42 |      * @brief Gets whether or not the video frame needs to be resized
 43 |      *
 44 |      * @return Boolean indicating if the frame needs to be resized
 45 |      */
 46 |     bool needsResize();
 47 |     /* @brief Performs the resize and re-allocates framebuffer */
 48 |     void resize();
 49 |     /* @brief Starts streaming from the video device */
 50 |     void start();
 51 |     /* @brief Stops streaming from the video device */
 52 |     void stop();
 53 |     /* @brief Restarts streaming from the video device */
 54 |     void restart()
 55 |     {
 56 |         stop();
 57 |         start();
 58 |     }
 59 | 
 60 |     /*
 61 |      * @brief Gets the desired video frame rate in frames per second
 62 |      *
 63 |      * @return Value of the desired frame rate
 64 |      */
 65 |     inline int getFrameRate() const
 66 |     {
 67 |         return frameRate;
 68 |     }
 69 |     /*
 70 |      * @brief Gets the size of the video frame data
 71 |      *
 72 |      * @return Value of the size of the video frame data in bytes
 73 |      */
 74 |     inline size_t getFrameSize() const
 75 |     {
 76 |         return buffers[lastFrameIndex].payload;
 77 |     }
 78 |     /*
 79 |      * @brief Gets the height of the video frame
 80 |      *
 81 |      * @return Value of the height of video frame in pixels
 82 |      */
 83 |     inline size_t getHeight() const
 84 |     {
 85 |         return height;
 86 |     }
 87 |     /*
 88 |      * @brief Gets the pixel format  of the video frame
 89 |      *
 90 |      * @return Value of the pixel format of video frame */
 91 |     inline uint32_t getPixelformat() const
 92 |     {
 93 |         return pixelformat;
 94 |     }
 95 |     /*
 96 |      * @brief Gets the width of the video frame
 97 |      *
 98 |      * @return Value of the width of video frame in pixels
 99 |      */
100 |     inline size_t getWidth() const
101 |     {
102 |         return width;
103 |     }
104 |     /*
105 |      * @brief Gets the subsampling of the video frame
106 |      *
107 |      * @return Value of the subsampling of video frame, 1:420/0:444
108 |      */
109 |     inline int getSubsampling() const
110 |     {
111 |         return subSampling;
112 |     }
113 |     /*
114 |      * @brief Sets the subsampling of the video frame
115 |      *
116 |      * @return Value of the subsampling of video frame, 1:420/0:444
117 |      */
118 |     inline void setSubsampling(int _sub)
119 |     {
120 |         subSampling = _sub;
121 |     }
122 | 
123 |     /* @brief Number of bits per component of a pixel */
124 |     static const int bitsPerSample;
125 |     /* @brief Number of bytes of storage for a pixel */
126 |     static const int bytesPerPixel;
127 |     /* @brief Number of components in a pixel (i.e. 3 for RGB pixel) */
128 |     static const int samplesPerPixel;
129 | 
130 |   private:
131 |     /*
132 |      * @struct Buffer
133 |      * @brief Store the address and size of frame data from streaming
134 |      *        operations
135 |      */
136 |     struct Buffer
137 |     {
138 |         Buffer() : data(nullptr), queued(false), payload(0), size(0) {}
139 |         ~Buffer() = default;
140 |         Buffer(const Buffer&) = default;
141 |         Buffer& operator=(const Buffer&) = default;
142 |         Buffer(Buffer&&) = default;
143 |         Buffer& operator=(Buffer&&) = default;
144 | 
145 |         void* data;
146 |         bool queued;
147 |         size_t payload;
148 |         size_t size;
149 |     };
150 | 
151 |     /*
152 |      * @brief Boolean to indicate whether the resize was triggered during
153 |      *        the open operation
154 |      */
155 |     bool resizeAfterOpen;
156 |     /* @brief Indicates whether or not timings query was last sucessful */
157 |     bool timingsError;
158 |     /* @brief File descriptor for the V4L2 video device */
159 |     int fd;
160 |     /* @brief Desired frame rate of video stream in frames per second */
161 |     int frameRate;
162 |     /* @brief Buffer index for the last video frame */
163 |     int lastFrameIndex;
164 |     /* @brief Height in pixels of the video frame */
165 |     size_t height;
166 |     /* @brief Width in pixels of the video frame */
167 |     size_t width;
168 |     /* @brief jpeg's subsampling, 1:420/0:444 */
169 |     int subSampling;
170 |     /* @brief Reference to the Input object */
171 |     Input& input;
172 |     /* @brief Path to the V4L2 video device */
173 |     const std::string path;
174 |     /* @brief Streaming buffer storage */
175 |     std::vector<Buffer> buffers;
176 | 
177 |     /* @brief Pixel Format  */
178 |     uint32_t pixelformat;
179 | };
180 | 
181 | } // namespace ikvm
182 | 


--------------------------------------------------------------------------------
/ikvm_server.hpp:
--------------------------------------------------------------------------------
  1 | #pragma once
  2 | 
  3 | #include "ikvm_args.hpp"
  4 | #include "ikvm_input.hpp"
  5 | #include "ikvm_video.hpp"
  6 | 
  7 | #include <rfb/rfb.h>
  8 | 
  9 | #include <vector>
 10 | 
 11 | namespace ikvm
 12 | {
 13 | /*
 14 |  * @class Server
 15 |  * @brief Manages the RFB server connection and updates
 16 |  */
 17 | class Server
 18 | {
 19 |   public:
 20 |     /*
 21 |      * @struct ClientData
 22 |      * @brief Store necessary data for each connected RFB client
 23 |      */
 24 |     struct ClientData
 25 |     {
 26 |         /*
 27 |          * @brief Constructs ClientData object
 28 |          *
 29 |          * @param[in] s - Number of frames to skip when client connects
 30 |          * @param[in] i - Pointer to Input object
 31 |          */
 32 |         ClientData(int s, Input* i) : skipFrame(s), input(i), last_crc{-1}
 33 |         {
 34 |             needUpdate = false;
 35 |         }
 36 |         ~ClientData() = default;
 37 |         ClientData(const ClientData&) = default;
 38 |         ClientData& operator=(const ClientData&) = default;
 39 |         ClientData(ClientData&&) = default;
 40 |         ClientData& operator=(ClientData&&) = default;
 41 | 
 42 |         int skipFrame;
 43 |         Input* input;
 44 |         bool needUpdate;
 45 |         int64_t last_crc;
 46 |     };
 47 | 
 48 |     /*
 49 |      * @brief Constructs Server object
 50 |      *
 51 |      * @param[in] args - Reference to Args object
 52 |      * @param[in] i    - Reference to Input object
 53 |      * @param[in] v    - Reference to Video object
 54 |      */
 55 |     Server(const Args& args, Input& i, Video& v);
 56 |     ~Server();
 57 |     Server(const Server&) = default;
 58 |     Server& operator=(const Server&) = default;
 59 |     Server(Server&&) = default;
 60 |     Server& operator=(Server&&) = default;
 61 | 
 62 |     /* @brief Resizes the RFB framebuffer */
 63 |     void resize();
 64 |     /* @brief Executes any pending RFB updates and client input */
 65 |     void run();
 66 |     /* @brief Sends pending video frame to clients */
 67 |     void sendFrame();
 68 | 
 69 |     /*
 70 |      * @brief Indicates whether or not video data is desired
 71 |      *
 72 |      * @return Boolean to indicate whether any clients need a video frame
 73 |      */
 74 |     inline bool wantsFrame() const
 75 |     {
 76 |         return server->clientHead;
 77 |     }
 78 |     /*
 79 |      * @brief Get the Video object
 80 |      *
 81 |      * @return Reference to the Video object
 82 |      */
 83 |     inline const Video& getVideo() const
 84 |     {
 85 |         return video;
 86 |     }
 87 | 
 88 |   private:
 89 |     /*
 90 |      * @brief Handler for a client frame update message
 91 |      *
 92 |      * @param[in] cl - Handle to the client object
 93 |      * @param[in] furMsg - Pointer of the FUR message
 94 |      */
 95 |     static void clientFramebufferUpdateRequest(
 96 |         rfbClientPtr cl, rfbFramebufferUpdateRequestMsg* furMsg);
 97 |     /*
 98 |      * @brief Handler for a client disconnecting
 99 |      *
100 |      * @param[in] cl - Handle to the client object
101 |      */
102 |     static void clientGone(rfbClientPtr cl);
103 |     /*
104 |      * @brief Handler for client connecting
105 |      *
106 |      * @param[in] cl - Handle to the client object
107 |      */
108 |     static enum rfbNewClientAction newClient(rfbClientPtr cl);
109 | 
110 |     /* @brief Performs the resize operation on the framebuffer */
111 |     void doResize();
112 | 
113 |     /* @brief Boolean to indicate if a resize operation is on-going */
114 |     bool pendingResize;
115 |     /* @brief Number of frames handled since a client connected */
116 |     int frameCounter;
117 |     /* @brief Number of connected clients */
118 |     unsigned int numClients;
119 |     /* @brief Microseconds to process RFB events every frame */
120 |     long int processTime;
121 |     /* @brief Handle to the RFB server object */
122 |     rfbScreenInfoPtr server;
123 |     /* @brief Reference to the Input object */
124 |     Input& input;
125 |     /* @brief Reference to the Video object */
126 |     Video& video;
127 |     /* @brief Default framebuffer storage */
128 |     std::vector<char> framebuffer;
129 |     /* @brief Identical frames detection */
130 |     bool calcFrameCRC;
131 |     /* @brief Cursor bitmap width */
132 |     static constexpr int cursorWidth = 20;
133 |     /* @brief Cursor bitmap height */
134 |     static constexpr int cursorHeight = 20;
135 |     /* @brief Cursor bitmap */
136 |     static constexpr char cursor[] =
137 |         "                    "
138 |         " x                  "
139 |         " xx                 "
140 |         " xxx                "
141 |         " xxxx               "
142 |         " xxxxx              "
143 |         " xxxxxx             "
144 |         " xxxxxxx            "
145 |         " xxxxxxxx           "
146 |         " xxxxxxxxx          "
147 |         " xxxxxxxxxx         "
148 |         " xxxxxxxxxxx        "
149 |         " xxxxxxx            "
150 |         " xxxxxxx            "
151 |         " xxx  xxx           "
152 |         " xx   xxx           "
153 |         " x     xxx          "
154 |         "       xxx          "
155 |         "        x           "
156 |         "                    ";
157 |     /* @brief Cursor bitmap mask */
158 |     static constexpr char cursorMask[] =
159 |         " o                  "
160 |         "oxo                 "
161 |         "oxxo                "
162 |         "oxxxo               "
163 |         "oxxxxo              "
164 |         "oxxxxxo             "
165 |         "oxxxxxxo            "
166 |         "oxxxxxxxo           "
167 |         "oxxxxxxxxo          "
168 |         "oxxxxxxxxxo         "
169 |         "oxxxxxxxxxxo        "
170 |         "oxxxxxxxxxxxo       "
171 |         "oxxxxxxxoooo        "
172 |         "oxxxxxxxo           "
173 |         "oxxxooxxxo          "
174 |         "oxxo oxxxo          "
175 |         "oxo   oxxxo         "
176 |         " o    oxxxo         "
177 |         "       oxo          "
178 |         "        o           ";
179 | };
180 | 
181 | } // namespace ikvm
182 | 


--------------------------------------------------------------------------------
/create_usbhid.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | hid_conf_directory="/sys/kernel/config/usb_gadget/obmc_hid"
  4 | SOC_FAMILY=$(cat /sys/bus/soc/devices/soc0/family)
  5 | 
  6 | if [ "${SOC_FAMILY}" = "AST2500" ] || [ "${SOC_FAMILY}" = "AST2600" ]; then
  7 |     DEV_NAME="1e6a0000.usb-vhub"
  8 | elif [ "${SOC_FAMILY}" = "AST2700" ] || [ "${SOC_FAMILY}" = "AST2750" ]; then
  9 |     DEV_NAME="12060000.usb-vhub"
 10 | else
 11 |     DEV_NAME="1e6a0000.usb-vhub"
 12 |     echo "Unknown SOC_FAMILY '${SOC_FAMILY}', defaulting DEV_NAME to '${DEV_NAME}'"
 13 |     exit 1
 14 | fi
 15 | 
 16 | create_hid() {
 17 |     # create gadget
 18 |     mkdir "${hid_conf_directory}"
 19 |     cd "${hid_conf_directory}" || exit 1
 20 | 
 21 |     # add basic information
 22 |     echo 0x0100 > bcdDevice
 23 |     echo 0x0200 > bcdUSB
 24 |     echo 0x0104 > idProduct		# Multifunction Composite Gadget
 25 |     echo 0x1d6b > idVendor		# Linux Foundation
 26 | 
 27 |     # create English locale
 28 |     mkdir strings/0x409
 29 | 
 30 |     echo "OpenBMC" > strings/0x409/manufacturer
 31 |     echo "Virtual Keyboard and Mouse" > strings/0x409/product
 32 |     echo "OBMC0001" > strings/0x409/serialnumber
 33 | 
 34 |     # Create HID keyboard function
 35 |     mkdir functions/hid.0
 36 | 
 37 |     echo 1 > functions/hid.0/protocol	# 1: keyboard
 38 |     echo 8 > functions/hid.0/report_length
 39 |     echo 1 > functions/hid.0/subclass
 40 | 
 41 |     # Binary HID keyboard descriptor
 42 |     #  0x05, 0x01, // USAGE_PAGE (Generic Desktop)
 43 |     #  0x09, 0x06, // USAGE (Keyboard)
 44 |     #  0xa1, 0x01, // COLLECTION (Application)
 45 |     #  0x05, 0x07, //   USAGE_PAGE (Keyboard)
 46 |     #  0x19, 0xe0, //   USAGE_MINIMUM (Keyboard LeftControl)
 47 |     #  0x29, 0xe7, //   USAGE_MAXIMUM (Keyboard Right GUI)
 48 |     #  0x15, 0x00, //   LOGICAL_MINIMUM (0)
 49 |     #  0x25, 0x01, //   LOGICAL_MAXIMUM (1)
 50 |     #  0x75, 0x01, //   REPORT_SIZE (1)
 51 |     #  0x95, 0x08, //   REPORT_COUNT (8)
 52 |     #  0x81, 0x02, //   INPUT (Data,Var,Abs)
 53 |     #  0x95, 0x01, //   REPORT_COUNT (1)
 54 |     #  0x75, 0x08, //   REPORT_SIZE (8)
 55 |     #  0x81, 0x03, //   INPUT (Data,Var,Abs)
 56 |     #  0x95, 0x05, //   REPORT_COUNT (5)
 57 |     #  0x75, 0x01, //   REPORT_SIZE (1)
 58 |     #  0x05, 0x08, //   USAGE_PAGE (LEDs)
 59 |     #  0x19, 0x01, //   USAGE_MINIMUM (Num Lock)
 60 |     #  0x29, 0x05, //   USAGE_MAXIMUM (Kana)
 61 |     #  0x91, 0x02, //   OUTPUT (Data,Var,Abs)
 62 |     #  0x95, 0x01, //   REPORT_COUNT (1)
 63 |     #  0x75, 0x03, //   REPORT_SIZE (3)
 64 |     #  0x91, 0x03, //   OUTPUT (Cnst,Var,Abs)
 65 |     #  0x95, 0x06, //   REPORT_COUNT (6)
 66 |     #  0x75, 0x08, //   REPORT_SIZE (8)
 67 |     #  0x15, 0x00, //   LOGICAL_MINIMUM (0)
 68 |     #  0x25, 0x65, //   LOGICAL_MAXIMUM (101)
 69 |     #  0x05, 0x07, //   USAGE_PAGE (Keyboard)
 70 |     #  0x19, 0x00, //   USAGE_MINIMUM (Reserved (no event indicated))
 71 |     #  0x29, 0x65, //   USAGE_MAXIMUM (Keyboard Application)
 72 |     #  0x81, 0x00, //   INPUT (Data,Ary,Abs)
 73 |     #  0xc0        // END_COLLECTION
 74 |     printf '\x05\x01\x09\x06\xa1\x01\x05\x07\x19\xe0\x29\xe7\x15\x00\x25\x01\x75\x01\x95\x08\x81\x02\x95\x01\x75\x08\x81\x03\x95\x05\x75\x01\x05\x08\x19\x01\x29\x05\x91\x02\x95\x01\x75\x03\x91\x03\x95\x06\x75\x08\x15\x00\x25\x65\x05\x07\x19\x00\x29\x65\x81\x00\xc0' > functions/hid.0/report_desc
 75 | 
 76 |     # Create HID mouse function
 77 |     mkdir functions/hid.1
 78 | 
 79 |     echo 2 > functions/hid.1/protocol	# 2: mouse
 80 |     echo 6 > functions/hid.1/report_length
 81 |     echo 1 > functions/hid.1/subclass
 82 | 
 83 |     # Binary HID mouse descriptor (absolute coordinate)
 84 |     #  0x05, 0x01,       // USAGE_PAGE (Generic Desktop)
 85 |     #  0x09, 0x02,       // USAGE (Mouse)
 86 |     #  0xa1, 0x01,       // COLLECTION (Application)
 87 |     #  0x09, 0x01,       //   USAGE (Pointer)
 88 |     #  0xa1, 0x00,       //   COLLECTION (Physical)
 89 |     #  0x05, 0x09,       //     USAGE_PAGE (Button)
 90 |     #  0x19, 0x01,       //     USAGE_MINIMUM (Button 1)
 91 |     #  0x29, 0x03,       //     USAGE_MAXIMUM (Button 3)
 92 |     #  0x15, 0x00,       //     LOGICAL_MINIMUM (0)
 93 |     #  0x25, 0x01,       //     LOGICAL_MAXIMUM (1)
 94 |     #  0x95, 0x03,       //     REPORT_COUNT (3)
 95 |     #  0x75, 0x01,       //     REPORT_SIZE (1)
 96 |     #  0x81, 0x02,       //     INPUT (Data,Var,Abs)
 97 |     #  0x95, 0x01,       //     REPORT_COUNT (1)
 98 |     #  0x75, 0x05,       //     REPORT_SIZE (5)
 99 |     #  0x81, 0x03,       //     INPUT (Cnst,Var,Abs)
100 |     #  0x05, 0x01,       //     USAGE_PAGE (Generic Desktop)
101 |     #  0x09, 0x30,       //     USAGE (X)
102 |     #  0x09, 0x31,       //     USAGE (Y)
103 |     #  0x35, 0x00,       //     PHYSICAL_MINIMUM (0)
104 |     #  0x46, 0xff, 0x7f, //     PHYSICAL_MAXIMUM (32767)
105 |     #  0x15, 0x00,       //     LOGICAL_MINIMUM (0)
106 |     #  0x26, 0xff, 0x7f, //     LOGICAL_MAXIMUM (32767)
107 |     #  0x65, 0x11,       //     UNIT (SI Lin:Distance)
108 |     #  0x55, 0x00,       //     UNIT_EXPONENT (0)
109 |     #  0x75, 0x10,       //     REPORT_SIZE (16)
110 |     #  0x95, 0x02,       //     REPORT_COUNT (2)
111 |     #  0x81, 0x02,       //     INPUT (Data,Var,Abs)
112 |     #  0x09, 0x38,       //     Usage (Wheel)
113 |     #  0x15, 0xff,       //     LOGICAL_MINIMUM (-1)
114 |     #  0x25, 0x01,       //     LOGICAL_MAXIMUM (1)
115 |     #  0x35, 0x00,       //     PHYSICAL_MINIMUM (-127)
116 |     #  0x45, 0x00,       //     PHYSICAL_MAXIMUM (127)
117 |     #  0x75, 0x08,       //     REPORT_SIZE (8)
118 |     #  0x95, 0x01,       //     REPORT_COUNT (1)
119 |     #  0x81, 0x06,       //     INPUT (Data,Var,Rel)
120 |     #  0xc0,             //   END_COLLECTION
121 |     #  0xc0              // END_COLLECTION
122 |     printf '\x05\x01\x09\x02\xa1\x01\x09\x01\xa1\x00\x05\x09\x19\x01\x29\x03\x15\x00\x25\x01\x95\x03\x75\x01\x81\x02\x95\x01\x75\x05\x81\x03\x05\x01\x09\x30\x09\x31\x35\x00\x46\xff\x7f\x15\x00\x26\xff\x7f\x65\x11\x55\x00\x75\x10\x95\x02\x81\x02\x09\x38\x15\xff\x25\x01\x35\x00\x45\x00\x75\x08\x95\x01\x81\x06\xc0\xc0' > functions/hid.1/report_desc
123 | 
124 |     # Create configuration
125 |     mkdir configs/c.1
126 |     mkdir configs/c.1/strings/0x409
127 | 
128 |     echo 0xe0 > configs/c.1/bmAttributes
129 |     echo 200 > configs/c.1/MaxPower
130 |     echo "" > configs/c.1/strings/0x409/configuration
131 | 
132 |     # Link HID functions to configuration
133 |     ln -s functions/hid.0 configs/c.1
134 |     ln -s functions/hid.1 configs/c.1
135 | }
136 | 
137 | connect_hid() {
138 |     if ! grep -q "${DEV_NAME}:p" UDC; then
139 |         i=0
140 |         num_ports=5
141 |         base_usb_dir="/sys/bus/platform/devices/${DEV_NAME}/${DEV_NAME}:p"
142 |         while [ "${i}" -lt "${num_ports}" ]; do
143 |             port=$(("${i}" + 1))
144 |             i="${port}"
145 |             if [ ! -e "${base_usb_dir}${port}/gadget/suspended" ]; then
146 |                 break
147 |             fi
148 |         done
149 |         echo "${DEV_NAME}:p${port}" > UDC
150 |     fi
151 | }
152 | 
153 | disconnect_hid() {
154 |     if grep -q "${DEV_NAME}:p" UDC; then
155 |         echo "" > UDC
156 |     fi
157 | }
158 | 
159 | if [ ! -e "${hid_conf_directory}" ]; then
160 |     create_hid
161 | else
162 |     cd "${hid_conf_directory}" || exit 1
163 | fi
164 | 
165 | if [ "$1" = "connect" ]; then
166 |     connect_hid
167 | elif [ "$1" = "disconnect" ]; then
168 |     disconnect_hid
169 | else
170 |     echo >&2 "Invalid option: $1. Use 'connect' or 'disconnect'."
171 |     exit 1
172 | fi
173 | 


--------------------------------------------------------------------------------
/ikvm_server.cpp:
--------------------------------------------------------------------------------
  1 | #include "ikvm_server.hpp"
  2 | 
  3 | #include <linux/videodev2.h>
  4 | #include <rfb/rfbproto.h>
  5 | 
  6 | #include <boost/crc.hpp>
  7 | #include <phosphor-logging/elog-errors.hpp>
  8 | #include <phosphor-logging/elog.hpp>
  9 | #include <phosphor-logging/log.hpp>
 10 | #include <xyz/openbmc_project/Common/error.hpp>
 11 | 
 12 | namespace ikvm
 13 | {
 14 | 
 15 | using namespace phosphor::logging;
 16 | using namespace sdbusplus::xyz::openbmc_project::Common::Error;
 17 | 
 18 | Server::Server(const Args& args, Input& i, Video& v) :
 19 |     pendingResize(false), frameCounter(0), numClients(0), input(i), video(v)
 20 | {
 21 |     std::string ip("localhost");
 22 |     const Args::CommandLine& commandLine = args.getCommandLine();
 23 |     int argc = commandLine.argc;
 24 | 
 25 |     server = rfbGetScreen(&argc, commandLine.argv, video.getWidth(),
 26 |                           video.getHeight(), Video::bitsPerSample,
 27 |                           Video::samplesPerPixel, Video::bytesPerPixel);
 28 | 
 29 |     if (!server)
 30 |     {
 31 |         log<level::ERR>("Failed to get VNC screen due to invalid arguments");
 32 |         elog<InvalidArgument>(
 33 |             xyz::openbmc_project::Common::InvalidArgument::ARGUMENT_NAME(""),
 34 |             xyz::openbmc_project::Common::InvalidArgument::ARGUMENT_VALUE(""));
 35 |     }
 36 | 
 37 |     framebuffer.resize(
 38 |         video.getHeight() * video.getWidth() * Video::bytesPerPixel, 0);
 39 | 
 40 |     server->screenData = this;
 41 |     server->desktopName = "OpenBMC IKVM";
 42 |     server->frameBuffer = framebuffer.data();
 43 |     server->newClientHook = newClient;
 44 |     server->cursor = rfbMakeXCursor(cursorWidth, cursorHeight, (char*)cursor,
 45 |                                     (char*)cursorMask);
 46 |     server->cursor->xhot = 1;
 47 |     server->cursor->yhot = 1;
 48 | 
 49 |     rfbStringToAddr(&ip[0], &server->listenInterface);
 50 | 
 51 |     rfbInitServer(server);
 52 | 
 53 |     rfbMarkRectAsModified(server, 0, 0, video.getWidth(), video.getHeight());
 54 | 
 55 |     server->kbdAddEvent = Input::keyEvent;
 56 |     server->ptrAddEvent = Input::pointerEvent;
 57 | 
 58 |     processTime = (1000000 / video.getFrameRate()) - 100;
 59 | 
 60 |     calcFrameCRC = args.getCalcFrameCRC();
 61 | }
 62 | 
 63 | Server::~Server()
 64 | {
 65 |     rfbScreenCleanup(server);
 66 | }
 67 | 
 68 | void Server::resize()
 69 | {
 70 |     if (frameCounter > video.getFrameRate())
 71 |     {
 72 |         doResize();
 73 |     }
 74 |     else
 75 |     {
 76 |         pendingResize = true;
 77 |     }
 78 | }
 79 | 
 80 | void Server::run()
 81 | {
 82 |     rfbProcessEvents(server, processTime);
 83 | 
 84 |     if (server->clientHead)
 85 |     {
 86 |         frameCounter++;
 87 |         if (pendingResize && frameCounter > video.getFrameRate())
 88 |         {
 89 |             doResize();
 90 |             pendingResize = false;
 91 |         }
 92 |     }
 93 | }
 94 | 
 95 | void Server::sendFrame()
 96 | {
 97 |     char* data = video.getData();
 98 |     rfbClientIteratorPtr it;
 99 |     rfbClientPtr cl;
100 |     int64_t frame_crc = -1;
101 | 
102 |     if (!data || pendingResize)
103 |     {
104 |         return;
105 |     }
106 | 
107 |     it = rfbGetClientIterator(server);
108 | 
109 |     while ((cl = rfbClientIteratorNext(it)))
110 |     {
111 |         ClientData* cd = (ClientData*)cl->clientData;
112 |         rfbFramebufferUpdateMsg* fu = (rfbFramebufferUpdateMsg*)cl->updateBuf;
113 | 
114 |         if (!cd)
115 |         {
116 |             continue;
117 |         }
118 | 
119 |         if (cd->skipFrame)
120 |         {
121 |             cd->skipFrame--;
122 |             continue;
123 |         }
124 | 
125 |         if (!cd->needUpdate)
126 |         {
127 |             continue;
128 |         }
129 | 
130 |         if (calcFrameCRC)
131 |         {
132 |             if (frame_crc == -1)
133 |             {
134 |                 /* JFIF header contains some varying data so skip it for
135 |                  * checksum calculation */
136 |                 frame_crc =
137 |                     boost::crc<32, 0x04C11DB7, 0xFFFFFFFF, 0xFFFFFFFF, true,
138 |                                true>(data + 0x30, video.getFrameSize() - 0x30);
139 |             }
140 | 
141 |             if (cd->last_crc == frame_crc)
142 |             {
143 |                 continue;
144 |             }
145 | 
146 |             cd->last_crc = frame_crc;
147 |         }
148 | 
149 |         cd->needUpdate = false;
150 | 
151 |         if (cl->enableLastRectEncoding)
152 |         {
153 |             fu->nRects = 0xFFFF;
154 |         }
155 |         else
156 |         {
157 |             fu->nRects = Swap16IfLE(1);
158 |         }
159 | 
160 |         switch (video.getPixelformat())
161 |         {
162 |             case V4L2_PIX_FMT_RGB24:
163 |                 framebuffer.assign(data, data + video.getFrameSize());
164 |                 rfbMarkRectAsModified(server, 0, 0, video.getWidth(),
165 |                                       video.getHeight());
166 |                 break;
167 | 
168 |             case V4L2_PIX_FMT_JPEG:
169 |                 fu->type = rfbFramebufferUpdate;
170 |                 cl->ublen = sz_rfbFramebufferUpdateMsg;
171 |                 rfbSendUpdateBuf(cl);
172 |                 cl->tightEncoding = rfbEncodingTight;
173 |                 rfbSendTightHeader(cl, 0, 0, video.getWidth(),
174 |                                    video.getHeight());
175 |                 cl->updateBuf[cl->ublen++] = (char)(rfbTightJpeg << 4);
176 |                 rfbSendCompressedDataTight(cl, data, video.getFrameSize());
177 |                 if (cl->enableLastRectEncoding)
178 |                 {
179 |                     rfbSendLastRectMarker(cl);
180 |                 }
181 |                 rfbSendUpdateBuf(cl);
182 |                 break;
183 | 
184 |             default:
185 |                 break;
186 |         }
187 |     }
188 | 
189 |     rfbReleaseClientIterator(it);
190 | }
191 | 
192 | void Server::clientFramebufferUpdateRequest(
193 |     rfbClientPtr cl, rfbFramebufferUpdateRequestMsg* furMsg)
194 | {
195 |     ClientData* cd = (ClientData*)cl->clientData;
196 | 
197 |     if (!cd)
198 |         return;
199 | 
200 |     // Ignore the furMsg info. This service uses full frame update always.
201 |     (void)furMsg;
202 | 
203 |     cd->needUpdate = true;
204 | }
205 | 
206 | void Server::clientGone(rfbClientPtr cl)
207 | {
208 |     Server* server = (Server*)cl->screen->screenData;
209 | 
210 |     delete (ClientData*)cl->clientData;
211 |     cl->clientData = nullptr;
212 | 
213 |     if (server->numClients-- == 1)
214 |     {
215 |         server->input.disconnect();
216 |         rfbMarkRectAsModified(server->server, 0, 0, server->video.getWidth(),
217 |                               server->video.getHeight());
218 |     }
219 | }
220 | 
221 | enum rfbNewClientAction Server::newClient(rfbClientPtr cl)
222 | {
223 |     Server* server = (Server*)cl->screen->screenData;
224 | 
225 |     cl->clientData =
226 |         new ClientData(server->video.getFrameRate(), &server->input);
227 |     cl->clientGoneHook = clientGone;
228 |     cl->clientFramebufferUpdateRequestHook = clientFramebufferUpdateRequest;
229 |     if (!server->numClients++)
230 |     {
231 |         server->input.connect();
232 |         server->pendingResize = false;
233 |         server->frameCounter = 0;
234 |     }
235 | 
236 |     return RFB_CLIENT_ACCEPT;
237 | }
238 | 
239 | void Server::doResize()
240 | {
241 |     rfbClientIteratorPtr it;
242 |     rfbClientPtr cl;
243 | 
244 |     framebuffer.resize(
245 |         video.getHeight() * video.getWidth() * Video::bytesPerPixel, 0);
246 | 
247 |     rfbNewFramebuffer(server, framebuffer.data(), video.getWidth(),
248 |                       video.getHeight(), Video::bitsPerSample,
249 |                       Video::samplesPerPixel, Video::bytesPerPixel);
250 |     rfbMarkRectAsModified(server, 0, 0, video.getWidth(), video.getHeight());
251 | 
252 |     it = rfbGetClientIterator(server);
253 | 
254 |     while ((cl = rfbClientIteratorNext(it)))
255 |     {
256 |         ClientData* cd = (ClientData*)cl->clientData;
257 | 
258 |         if (!cd)
259 |         {
260 |             continue;
261 |         }
262 | 
263 |         // delay video updates to give the client time to resize
264 |         cd->skipFrame = video.getFrameRate();
265 |     }
266 | 
267 |     rfbReleaseClientIterator(it);
268 | }
269 | 
270 | } // namespace ikvm
271 | 


--------------------------------------------------------------------------------
/ikvm_video.cpp:
--------------------------------------------------------------------------------
  1 | #include "ikvm_video.hpp"
  2 | 
  3 | #include <err.h>
  4 | #include <errno.h>
  5 | #include <fcntl.h>
  6 | #include <linux/videodev2.h>
  7 | #include <poll.h>
  8 | #include <sys/ioctl.h>
  9 | #include <sys/mman.h>
 10 | #include <sys/select.h>
 11 | #include <sys/stat.h>
 12 | #include <sys/time.h>
 13 | #include <sys/types.h>
 14 | #include <unistd.h>
 15 | 
 16 | #include <phosphor-logging/elog-errors.hpp>
 17 | #include <phosphor-logging/elog.hpp>
 18 | #include <phosphor-logging/log.hpp>
 19 | #include <xyz/openbmc_project/Common/Device/error.hpp>
 20 | #include <xyz/openbmc_project/Common/File/error.hpp>
 21 | 
 22 | namespace ikvm
 23 | {
 24 | 
 25 | const int Video::bitsPerSample(8);
 26 | const int Video::bytesPerPixel(4);
 27 | const int Video::samplesPerPixel(3);
 28 | 
 29 | using namespace phosphor::logging;
 30 | using namespace sdbusplus::xyz::openbmc_project::Common::File::Error;
 31 | using namespace sdbusplus::xyz::openbmc_project::Common::Device::Error;
 32 | 
 33 | Video::Video(const std::string& p, Input& input, int fr, int sub) :
 34 |     resizeAfterOpen(false), timingsError(false), fd(-1), frameRate(fr),
 35 |     lastFrameIndex(-1), height(600), width(800), subSampling(sub), input(input),
 36 |     path(p), pixelformat(V4L2_PIX_FMT_JPEG)
 37 | {}
 38 | 
 39 | Video::~Video()
 40 | {
 41 |     stop();
 42 | }
 43 | 
 44 | char* Video::getData()
 45 | {
 46 |     if (lastFrameIndex >= 0)
 47 |     {
 48 |         return (char*)buffers[lastFrameIndex].data;
 49 |     }
 50 | 
 51 |     return nullptr;
 52 | }
 53 | 
 54 | void Video::getFrame()
 55 | {
 56 |     int rc(0);
 57 |     int fd_flags;
 58 |     v4l2_buffer buf;
 59 |     fd_set fds;
 60 |     timeval tv;
 61 | 
 62 |     if (fd < 0)
 63 |     {
 64 |         return;
 65 |     }
 66 | 
 67 |     FD_ZERO(&fds);
 68 |     FD_SET(fd, &fds);
 69 | 
 70 |     tv.tv_sec = 1;
 71 |     tv.tv_usec = 0;
 72 | 
 73 |     memset(&buf, 0, sizeof(v4l2_buffer));
 74 |     buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
 75 |     buf.memory = V4L2_MEMORY_MMAP;
 76 | 
 77 |     // Switch to non-blocking in order to safely dequeue all buffers; if the
 78 |     // video signal is lost while blocking to dequeue, the video driver may
 79 |     // wait forever if signal is not re-acquired
 80 |     fd_flags = fcntl(fd, F_GETFL);
 81 |     fcntl(fd, F_SETFL, fd_flags | O_NONBLOCK);
 82 | 
 83 |     rc = select(fd + 1, &fds, NULL, NULL, &tv);
 84 |     if (rc > 0)
 85 |     {
 86 |         do
 87 |         {
 88 |             rc = ioctl(fd, VIDIOC_DQBUF, &buf);
 89 |             if (rc >= 0)
 90 |             {
 91 |                 buffers[buf.index].queued = false;
 92 | 
 93 |                 if (!(buf.flags & V4L2_BUF_FLAG_ERROR))
 94 |                 {
 95 |                     lastFrameIndex = buf.index;
 96 |                     buffers[lastFrameIndex].payload = buf.bytesused;
 97 |                     break;
 98 |                 }
 99 |                 else
100 |                 {
101 |                     buffers[buf.index].payload = 0;
102 |                 }
103 |             }
104 |         } while (rc >= 0);
105 |     }
106 | 
107 |     fcntl(fd, F_SETFL, fd_flags);
108 | 
109 |     for (unsigned int i = 0; i < buffers.size(); ++i)
110 |     {
111 |         if (i == (unsigned int)lastFrameIndex)
112 |         {
113 |             continue;
114 |         }
115 | 
116 |         if (!buffers[i].queued)
117 |         {
118 |             memset(&buf, 0, sizeof(v4l2_buffer));
119 |             buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
120 |             buf.memory = V4L2_MEMORY_MMAP;
121 |             buf.index = i;
122 | 
123 |             rc = ioctl(fd, VIDIOC_QBUF, &buf);
124 |             if (rc)
125 |             {
126 |                 log<level::ERR>("Failed to queue buffer",
127 |                                 entry("ERROR=%s", strerror(errno)));
128 |             }
129 |             else
130 |             {
131 |                 buffers[i].queued = true;
132 |             }
133 |         }
134 |     }
135 | }
136 | 
137 | bool Video::needsResize()
138 | {
139 |     int rc;
140 |     v4l2_dv_timings timings;
141 | 
142 |     if (fd < 0)
143 |     {
144 |         return false;
145 |     }
146 | 
147 |     if (resizeAfterOpen)
148 |     {
149 |         return true;
150 |     }
151 | 
152 |     memset(&timings, 0, sizeof(v4l2_dv_timings));
153 |     rc = ioctl(fd, VIDIOC_QUERY_DV_TIMINGS, &timings);
154 |     if (rc < 0)
155 |     {
156 |         if (!timingsError)
157 |         {
158 |             log<level::ERR>("Failed to query timings",
159 |                             entry("ERROR=%s", strerror(errno)));
160 |             timingsError = true;
161 |         }
162 | 
163 |         restart();
164 |         return false;
165 |     }
166 |     else
167 |     {
168 |         timingsError = false;
169 |     }
170 | 
171 |     if (timings.bt.width != width || timings.bt.height != height)
172 |     {
173 |         width = timings.bt.width;
174 |         height = timings.bt.height;
175 | 
176 |         if (!width || !height)
177 |         {
178 |             log<level::ERR>("Failed to get new resolution",
179 |                             entry("WIDTH=%d", width),
180 |                             entry("HEIGHT=%d", height));
181 |             elog<Open>(
182 |                 xyz::openbmc_project::Common::File::Open::ERRNO(-EPROTO),
183 |                 xyz::openbmc_project::Common::File::Open::PATH(path.c_str()));
184 |         }
185 | 
186 |         lastFrameIndex = -1;
187 |         return true;
188 |     }
189 | 
190 |     return false;
191 | }
192 | 
193 | void Video::resize()
194 | {
195 |     int rc;
196 |     unsigned int i;
197 |     bool needsResizeCall(false);
198 |     v4l2_buf_type type(V4L2_BUF_TYPE_VIDEO_CAPTURE);
199 |     v4l2_requestbuffers req;
200 | 
201 |     if (fd < 0)
202 |     {
203 |         return;
204 |     }
205 | 
206 |     if (resizeAfterOpen)
207 |     {
208 |         resizeAfterOpen = false;
209 |         return;
210 |     }
211 | 
212 |     for (i = 0; i < buffers.size(); ++i)
213 |     {
214 |         if (buffers[i].data)
215 |         {
216 |             needsResizeCall = true;
217 |             break;
218 |         }
219 |     }
220 | 
221 |     if (needsResizeCall)
222 |     {
223 |         rc = ioctl(fd, VIDIOC_STREAMOFF, &type);
224 |         if (rc)
225 |         {
226 |             log<level::ERR>("Failed to stop streaming",
227 |                             entry("ERROR=%s", strerror(errno)));
228 |             elog<ReadFailure>(
229 |                 xyz::openbmc_project::Common::Device::ReadFailure::
230 |                     CALLOUT_ERRNO(errno),
231 |                 xyz::openbmc_project::Common::Device::ReadFailure::
232 |                     CALLOUT_DEVICE_PATH(path.c_str()));
233 |         }
234 |     }
235 | 
236 |     for (i = 0; i < buffers.size(); ++i)
237 |     {
238 |         if (buffers[i].data)
239 |         {
240 |             munmap(buffers[i].data, buffers[i].size);
241 |             buffers[i].data = nullptr;
242 |             buffers[i].queued = false;
243 |         }
244 |     }
245 | 
246 |     if (needsResizeCall)
247 |     {
248 |         v4l2_dv_timings timings;
249 | 
250 |         memset(&req, 0, sizeof(v4l2_requestbuffers));
251 |         req.count = 0;
252 |         req.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
253 |         req.memory = V4L2_MEMORY_MMAP;
254 |         rc = ioctl(fd, VIDIOC_REQBUFS, &req);
255 |         if (rc < 0)
256 |         {
257 |             log<level::ERR>("Failed to zero streaming buffers",
258 |                             entry("ERROR=%s", strerror(errno)));
259 |             elog<ReadFailure>(
260 |                 xyz::openbmc_project::Common::Device::ReadFailure::
261 |                     CALLOUT_ERRNO(errno),
262 |                 xyz::openbmc_project::Common::Device::ReadFailure::
263 |                     CALLOUT_DEVICE_PATH(path.c_str()));
264 |         }
265 | 
266 |         memset(&timings, 0, sizeof(v4l2_dv_timings));
267 |         rc = ioctl(fd, VIDIOC_QUERY_DV_TIMINGS, &timings);
268 |         if (rc < 0)
269 |         {
270 |             log<level::ERR>("Failed to query timings, restart",
271 |                             entry("ERROR=%s", strerror(errno)));
272 |             restart();
273 |             return;
274 |         }
275 | 
276 |         rc = ioctl(fd, VIDIOC_S_DV_TIMINGS, &timings);
277 |         if (rc < 0)
278 |         {
279 |             log<level::ERR>("Failed to set timings",
280 |                             entry("ERROR=%s", strerror(errno)));
281 |             elog<ReadFailure>(
282 |                 xyz::openbmc_project::Common::Device::ReadFailure::
283 |                     CALLOUT_ERRNO(errno),
284 |                 xyz::openbmc_project::Common::Device::ReadFailure::
285 |                     CALLOUT_DEVICE_PATH(path.c_str()));
286 |         }
287 | 
288 |         buffers.clear();
289 |     }
290 | 
291 |     memset(&req, 0, sizeof(v4l2_requestbuffers));
292 |     req.count = 3;
293 |     req.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
294 |     req.memory = V4L2_MEMORY_MMAP;
295 |     rc = ioctl(fd, VIDIOC_REQBUFS, &req);
296 |     if (rc < 0 || req.count < 2)
297 |     {
298 |         log<level::ERR>("Failed to request streaming buffers",
299 |                         entry("ERROR=%s", strerror(errno)));
300 |         elog<ReadFailure>(
301 |             xyz::openbmc_project::Common::Device::ReadFailure::CALLOUT_ERRNO(
302 |                 errno),
303 |             xyz::openbmc_project::Common::Device::ReadFailure::
304 |                 CALLOUT_DEVICE_PATH(path.c_str()));
305 |     }
306 | 
307 |     buffers.resize(req.count);
308 | 
309 |     for (i = 0; i < buffers.size(); ++i)
310 |     {
311 |         v4l2_buffer buf;
312 | 
313 |         memset(&buf, 0, sizeof(v4l2_buffer));
314 |         buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
315 |         buf.memory = V4L2_MEMORY_MMAP;
316 |         buf.index = i;
317 | 
318 |         rc = ioctl(fd, VIDIOC_QUERYBUF, &buf);
319 |         if (rc < 0)
320 |         {
321 |             log<level::ERR>("Failed to query buffer",
322 |                             entry("ERROR=%s", strerror(errno)));
323 |             elog<ReadFailure>(
324 |                 xyz::openbmc_project::Common::Device::ReadFailure::
325 |                     CALLOUT_ERRNO(errno),
326 |                 xyz::openbmc_project::Common::Device::ReadFailure::
327 |                     CALLOUT_DEVICE_PATH(path.c_str()));
328 |         }
329 | 
330 |         buffers[i].data = mmap(NULL, buf.length, PROT_READ | PROT_WRITE,
331 |                                MAP_SHARED, fd, buf.m.offset);
332 |         if (buffers[i].data == MAP_FAILED)
333 |         {
334 |             log<level::ERR>("Failed to mmap buffer",
335 |                             entry("ERROR=%s", strerror(errno)));
336 |             elog<ReadFailure>(
337 |                 xyz::openbmc_project::Common::Device::ReadFailure::
338 |                     CALLOUT_ERRNO(errno),
339 |                 xyz::openbmc_project::Common::Device::ReadFailure::
340 |                     CALLOUT_DEVICE_PATH(path.c_str()));
341 |         }
342 | 
343 |         buffers[i].size = buf.length;
344 | 
345 |         rc = ioctl(fd, VIDIOC_QBUF, &buf);
346 |         if (rc < 0)
347 |         {
348 |             log<level::ERR>("Failed to queue buffer",
349 |                             entry("ERROR=%s", strerror(errno)));
350 |             elog<ReadFailure>(
351 |                 xyz::openbmc_project::Common::Device::ReadFailure::
352 |                     CALLOUT_ERRNO(errno),
353 |                 xyz::openbmc_project::Common::Device::ReadFailure::
354 |                     CALLOUT_DEVICE_PATH(path.c_str()));
355 |         }
356 | 
357 |         buffers[i].queued = true;
358 |     }
359 | 
360 |     rc = ioctl(fd, VIDIOC_STREAMON, &type);
361 |     if (rc)
362 |     {
363 |         log<level::ERR>("Failed to start streaming",
364 |                         entry("ERROR=%s", strerror(errno)));
365 |         elog<ReadFailure>(
366 |             xyz::openbmc_project::Common::Device::ReadFailure::CALLOUT_ERRNO(
367 |                 errno),
368 |             xyz::openbmc_project::Common::Device::ReadFailure::
369 |                 CALLOUT_DEVICE_PATH(path.c_str()));
370 |     }
371 | }
372 | 
373 | void Video::start()
374 | {
375 |     int rc;
376 |     size_t oldHeight = height;
377 |     size_t oldWidth = width;
378 |     v4l2_capability cap;
379 |     v4l2_format fmt;
380 |     v4l2_streamparm sparm;
381 |     v4l2_control ctrl;
382 | 
383 |     if (fd >= 0)
384 |     {
385 |         return;
386 |     }
387 | 
388 |     input.sendWakeupPacket();
389 | 
390 |     fd = open(path.c_str(), O_RDWR);
391 |     if (fd < 0)
392 |     {
393 |         log<level::ERR>("Failed to open video device",
394 |                         entry("PATH=%s", path.c_str()),
395 |                         entry("ERROR=%s", strerror(errno)));
396 |         elog<Open>(
397 |             xyz::openbmc_project::Common::File::Open::ERRNO(errno),
398 |             xyz::openbmc_project::Common::File::Open::PATH(path.c_str()));
399 |     }
400 | 
401 |     memset(&cap, 0, sizeof(v4l2_capability));
402 |     rc = ioctl(fd, VIDIOC_QUERYCAP, &cap);
403 |     if (rc < 0)
404 |     {
405 |         log<level::ERR>("Failed to query video device capabilities",
406 |                         entry("ERROR=%s", strerror(errno)));
407 |         elog<ReadFailure>(
408 |             xyz::openbmc_project::Common::Device::ReadFailure::CALLOUT_ERRNO(
409 |                 errno),
410 |             xyz::openbmc_project::Common::Device::ReadFailure::
411 |                 CALLOUT_DEVICE_PATH(path.c_str()));
412 |     }
413 | 
414 |     if (!(cap.capabilities & V4L2_CAP_VIDEO_CAPTURE) ||
415 |         !(cap.capabilities & V4L2_CAP_STREAMING))
416 |     {
417 |         log<level::ERR>("Video device doesn't support this application");
418 |         elog<Open>(
419 |             xyz::openbmc_project::Common::File::Open::ERRNO(errno),
420 |             xyz::openbmc_project::Common::File::Open::PATH(path.c_str()));
421 |     }
422 | 
423 |     memset(&fmt, 0, sizeof(v4l2_format));
424 |     fmt.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
425 |     rc = ioctl(fd, VIDIOC_G_FMT, &fmt);
426 |     if (rc < 0)
427 |     {
428 |         log<level::ERR>("Failed to query video device format",
429 |                         entry("ERROR=%s", strerror(errno)));
430 |         elog<ReadFailure>(
431 |             xyz::openbmc_project::Common::Device::ReadFailure::CALLOUT_ERRNO(
432 |                 errno),
433 |             xyz::openbmc_project::Common::Device::ReadFailure::
434 |                 CALLOUT_DEVICE_PATH(path.c_str()));
435 |     }
436 | 
437 |     memset(&sparm, 0, sizeof(v4l2_streamparm));
438 |     sparm.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
439 |     sparm.parm.capture.timeperframe.numerator = 1;
440 |     sparm.parm.capture.timeperframe.denominator = frameRate;
441 |     rc = ioctl(fd, VIDIOC_S_PARM, &sparm);
442 |     if (rc < 0)
443 |     {
444 |         log<level::WARNING>("Failed to set video device frame rate",
445 |                             entry("ERROR=%s", strerror(errno)));
446 |     }
447 | 
448 |     ctrl.id = V4L2_CID_JPEG_CHROMA_SUBSAMPLING;
449 |     ctrl.value = subSampling ? V4L2_JPEG_CHROMA_SUBSAMPLING_420
450 |                              : V4L2_JPEG_CHROMA_SUBSAMPLING_444;
451 |     rc = ioctl(fd, VIDIOC_S_CTRL, &ctrl);
452 |     if (rc < 0)
453 |     {
454 |         log<level::WARNING>("Failed to set video jpeg subsampling",
455 |                             entry("ERROR=%s", strerror(errno)));
456 |     }
457 | 
458 |     height = fmt.fmt.pix.height;
459 |     width = fmt.fmt.pix.width;
460 |     pixelformat = fmt.fmt.pix.pixelformat;
461 | 
462 |     if (pixelformat != V4L2_PIX_FMT_RGB24 && pixelformat != V4L2_PIX_FMT_JPEG)
463 |     {
464 |         log<level::ERR>("Pixel Format not supported",
465 |                         entry("PIXELFORMAT=%d", pixelformat));
466 |     }
467 | 
468 |     resize();
469 | 
470 |     if (oldHeight != height || oldWidth != width)
471 |     {
472 |         resizeAfterOpen = true;
473 |     }
474 | }
475 | 
476 | void Video::stop()
477 | {
478 |     int rc;
479 |     unsigned int i;
480 |     v4l2_buf_type type(V4L2_BUF_TYPE_VIDEO_CAPTURE);
481 | 
482 |     if (fd < 0)
483 |     {
484 |         return;
485 |     }
486 | 
487 |     lastFrameIndex = -1;
488 | 
489 |     rc = ioctl(fd, VIDIOC_STREAMOFF, &type);
490 |     if (rc)
491 |     {
492 |         log<level::ERR>("Failed to stop streaming",
493 |                         entry("ERROR=%s", strerror(errno)));
494 |     }
495 | 
496 |     for (i = 0; i < buffers.size(); ++i)
497 |     {
498 |         if (buffers[i].data)
499 |         {
500 |             munmap(buffers[i].data, buffers[i].size);
501 |             buffers[i].data = nullptr;
502 |             buffers[i].queued = false;
503 |         }
504 |     }
505 | 
506 |     close(fd);
507 |     fd = -1;
508 | }
509 | 
510 | } // namespace ikvm
511 | 


--------------------------------------------------------------------------------
/ikvm_input.cpp:
--------------------------------------------------------------------------------
  1 | #include "ikvm_input.hpp"
  2 | 
  3 | #include "ikvm_server.hpp"
  4 | #include "scancodes.hpp"
  5 | 
  6 | #include <err.h>
  7 | #include <errno.h>
  8 | #include <fcntl.h>
  9 | #include <rfb/keysym.h>
 10 | #include <sys/stat.h>
 11 | #include <sys/types.h>
 12 | 
 13 | #include <phosphor-logging/elog-errors.hpp>
 14 | #include <phosphor-logging/elog.hpp>
 15 | #include <phosphor-logging/log.hpp>
 16 | #include <xyz/openbmc_project/Common/File/error.hpp>
 17 | 
 18 | namespace fs = std::filesystem;
 19 | 
 20 | namespace ikvm
 21 | {
 22 | using namespace phosphor::logging;
 23 | using namespace sdbusplus::xyz::openbmc_project::Common::File::Error;
 24 | 
 25 | Input::Input(const std::string& kbdPath, const std::string& ptrPath,
 26 |              const std::string& udc) :
 27 |     keyboardFd(-1), pointerFd(-1), keyboardReport{0}, pointerReport{0},
 28 |     keyboardPath(kbdPath), pointerPath(ptrPath), udcName(udc)
 29 | {
 30 |     hidUdcStream.exceptions(std::ofstream::failbit | std::ofstream::badbit);
 31 |     hidUdcStream.open(hidUdcPath, std::ios::out | std::ios::app);
 32 | }
 33 | 
 34 | Input::~Input()
 35 | {
 36 |     if (keyboardFd >= 0)
 37 |     {
 38 |         close(keyboardFd);
 39 |     }
 40 | 
 41 |     if (pointerFd >= 0)
 42 |     {
 43 |         close(pointerFd);
 44 |     }
 45 | 
 46 |     disconnect();
 47 |     hidUdcStream.close();
 48 | }
 49 | 
 50 | void Input::connect()
 51 | {
 52 |     try
 53 |     {
 54 |         if (udcName.empty())
 55 |         {
 56 |             bool found = false;
 57 |             for (const auto& port : fs::directory_iterator(usbVirtualHubPath))
 58 |             {
 59 |                 // /sys/bus/platform/devices/1e6a0000.usb-vhub/1e6a0000.usb-vhub:pX
 60 |                 if (fs::is_directory(port) && !fs::is_symlink(port))
 61 |                 {
 62 |                     for (const auto& gadget :
 63 |                          fs::directory_iterator(port.path()))
 64 |                     {
 65 |                         // Kernel 6.0:
 66 |                         // /sys/.../1e6a0000.usb-vhub:pX/gadget.Y/suspended
 67 |                         // Kernel 5.15:
 68 |                         // /sys/.../1e6a0000.usb-vhub:pX/gadget/suspended
 69 |                         if (fs::is_directory(gadget) &&
 70 |                             gadget.path().string().find("gadget") !=
 71 |                                 std::string::npos &&
 72 |                             !fs::exists(gadget.path() / "suspended"))
 73 |                         {
 74 |                             const std::string portId = port.path().filename();
 75 |                             hidUdcStream << portId << std::endl;
 76 |                             found = true;
 77 |                             break;
 78 |                         }
 79 |                     }
 80 |                 }
 81 |                 if (found)
 82 |                 {
 83 |                     break;
 84 |                 }
 85 |             }
 86 |         }
 87 |         else // If UDC has been specified by '-u' parameter, connect to it.
 88 |         {
 89 |             hidUdcStream << udcName << std::endl;
 90 |         }
 91 |     }
 92 |     catch (fs::filesystem_error& e)
 93 |     {
 94 |         log<level::ERR>("Failed to search USB virtual hub port",
 95 |                         entry("ERROR=%s", e.what()));
 96 |         return;
 97 |     }
 98 |     catch (std::ofstream::failure& e)
 99 |     {
100 |         log<level::ERR>("Failed to connect HID gadget",
101 |                         entry("ERROR=%s", e.what()));
102 |         return;
103 |     }
104 | 
105 |     if (!keyboardPath.empty())
106 |     {
107 |         keyboardFd =
108 |             open(keyboardPath.c_str(), O_RDWR | O_CLOEXEC | O_NONBLOCK);
109 |         if (keyboardFd < 0)
110 |         {
111 |             log<level::ERR>("Failed to open input device",
112 |                             entry("PATH=%s", keyboardPath.c_str()),
113 |                             entry("ERROR=%s", strerror(errno)));
114 |             elog<Open>(xyz::openbmc_project::Common::File::Open::ERRNO(errno),
115 |                        xyz::openbmc_project::Common::File::Open::PATH(
116 |                            keyboardPath.c_str()));
117 |         }
118 |     }
119 | 
120 |     if (!pointerPath.empty())
121 |     {
122 |         pointerFd = open(pointerPath.c_str(), O_RDWR | O_CLOEXEC | O_NONBLOCK);
123 |         if (pointerFd < 0)
124 |         {
125 |             log<level::ERR>("Failed to open input device",
126 |                             entry("PATH=%s", pointerPath.c_str()),
127 |                             entry("ERROR=%s", strerror(errno)));
128 |             elog<Open>(xyz::openbmc_project::Common::File::Open::ERRNO(errno),
129 |                        xyz::openbmc_project::Common::File::Open::PATH(
130 |                            pointerPath.c_str()));
131 |         }
132 |     }
133 | }
134 | 
135 | void Input::disconnect()
136 | {
137 |     if (keyboardFd >= 0)
138 |     {
139 |         close(keyboardFd);
140 |         keyboardFd = -1;
141 |     }
142 | 
143 |     if (pointerFd >= 0)
144 |     {
145 |         close(pointerFd);
146 |         pointerFd = -1;
147 |     }
148 | 
149 |     try
150 |     {
151 |         hidUdcStream << "" << std::endl;
152 |     }
153 |     catch (std::ofstream::failure& e)
154 |     {
155 |         log<level::ERR>("Failed to disconnect HID gadget",
156 |                         entry("ERROR=%s", e.what()));
157 |     }
158 | }
159 | 
160 | void Input::keyEvent(rfbBool down, rfbKeySym key, rfbClientPtr cl)
161 | {
162 |     Server::ClientData* cd = (Server::ClientData*)cl->clientData;
163 |     Input* input = cd->input;
164 |     bool sendKeyboard = false;
165 | 
166 |     if (input->keyboardFd < 0)
167 |     {
168 |         return;
169 |     }
170 | 
171 |     std::unique_lock<std::mutex> keLock(input->keyEventMutex);
172 | 
173 |     if (down)
174 |     {
175 |         uint8_t sc = keyToScancode(key);
176 | 
177 |         if (sc)
178 |         {
179 |             if (input->keysDown.find(key) == input->keysDown.end())
180 |             {
181 |                 for (unsigned int i = 2; i < KEY_REPORT_LENGTH; ++i)
182 |                 {
183 |                     if (!input->keyboardReport[i])
184 |                     {
185 |                         input->keyboardReport[i] = sc;
186 |                         input->keysDown.insert(std::make_pair(key, i));
187 |                         sendKeyboard = true;
188 |                         break;
189 |                     }
190 |                 }
191 |             }
192 |         }
193 |         else
194 |         {
195 |             uint8_t mod = keyToMod(key);
196 | 
197 |             if (mod)
198 |             {
199 |                 input->keyboardReport[0] |= mod;
200 |                 sendKeyboard = true;
201 |             }
202 |         }
203 |     }
204 |     else
205 |     {
206 |         auto it = input->keysDown.find(key);
207 | 
208 |         if (it != input->keysDown.end())
209 |         {
210 |             input->keyboardReport[it->second] = 0;
211 |             input->keysDown.erase(it);
212 |             sendKeyboard = true;
213 |         }
214 |         else
215 |         {
216 |             uint8_t mod = keyToMod(key);
217 | 
218 |             if (mod)
219 |             {
220 |                 input->keyboardReport[0] &= ~mod;
221 |                 sendKeyboard = true;
222 |             }
223 |         }
224 |     }
225 | 
226 |     keLock.unlock();
227 | 
228 |     if (sendKeyboard)
229 |     {
230 |         input->writeKeyboard(input->keyboardReport);
231 |     }
232 | }
233 | 
234 | void Input::pointerEvent(int buttonMask, int x, int y, rfbClientPtr cl)
235 | {
236 |     Server::ClientData* cd = (Server::ClientData*)cl->clientData;
237 |     Input* input = cd->input;
238 |     Server* server = (Server*)cl->screen->screenData;
239 |     const Video& video = server->getVideo();
240 | 
241 |     if (input->pointerFd < 0)
242 |     {
243 |         return;
244 |     }
245 | 
246 |     if (buttonMask > 4)
247 |     {
248 |         input->pointerReport[0] = 0;
249 |         if (buttonMask == 8)
250 |         {
251 |             input->pointerReport[5] = 1;
252 |         }
253 |         else if (buttonMask == 16)
254 |         {
255 |             input->pointerReport[5] = 0xff;
256 |         }
257 |     }
258 |     else
259 |     {
260 |         input->pointerReport[0] =
261 |             ((buttonMask & 0x4) >> 1) | ((buttonMask & 0x2) << 1) |
262 |             (buttonMask & 0x1);
263 |         input->pointerReport[5] = 0;
264 |     }
265 | 
266 |     if (x >= 0 && (unsigned int)x < video.getWidth())
267 |     {
268 |         uint16_t xx = (uint16_t)(x * (SHRT_MAX + 1) / video.getWidth());
269 | 
270 |         memcpy(&input->pointerReport[1], &xx, 2);
271 |     }
272 | 
273 |     if (y >= 0 && (unsigned int)y < video.getHeight())
274 |     {
275 |         uint16_t yy = (uint16_t)(y * (SHRT_MAX + 1) / video.getHeight());
276 | 
277 |         memcpy(&input->pointerReport[3], &yy, 2);
278 |     }
279 | 
280 |     rfbDefaultPtrAddEvent(buttonMask, x, y, cl);
281 |     input->writePointer(input->pointerReport);
282 | }
283 | 
284 | void Input::sendWakeupPacket()
285 | {
286 |     uint8_t wakeupReport[KEY_REPORT_LENGTH] = {0};
287 | 
288 |     if (pointerFd >= 0)
289 |     {
290 |         uint16_t xy = SHRT_MAX / 2;
291 | 
292 |         memcpy(&wakeupReport[1], &xy, 2);
293 |         memcpy(&wakeupReport[3], &xy, 2);
294 | 
295 |         writePointer(wakeupReport);
296 |     }
297 | 
298 |     if (keyboardFd >= 0)
299 |     {
300 |         memset(&wakeupReport[0], 0, KEY_REPORT_LENGTH);
301 | 
302 |         wakeupReport[0] = keyToMod(XK_Shift_L);
303 | 
304 |         if (!writeKeyboard(wakeupReport))
305 |         {
306 |             return;
307 |         }
308 | 
309 |         wakeupReport[0] = 0;
310 | 
311 |         writeKeyboard(wakeupReport);
312 |     }
313 | }
314 | 
315 | uint8_t Input::keyToMod(rfbKeySym key)
316 | {
317 |     uint8_t mod = 0;
318 | 
319 |     if (key >= XK_Shift_L && key <= XK_Control_R)
320 |     {
321 |         mod = shiftCtrlMap[key - XK_Shift_L];
322 |     }
323 |     else if (key >= XK_Meta_L && key <= XK_Alt_R)
324 |     {
325 |         mod = metaAltMap[key - XK_Meta_L];
326 |     }
327 | 
328 |     return mod;
329 | }
330 | 
331 | uint8_t Input::keyToScancode(rfbKeySym key)
332 | {
333 |     uint8_t scancode = 0;
334 | 
335 |     if ((key >= 'A' && key <= 'Z') || (key >= 'a' && key <= 'z'))
336 |     {
337 |         scancode = USBHID_KEY_A + ((key & 0x5F) - 'A');
338 |     }
339 |     else if (key >= '1' && key <= '9')
340 |     {
341 |         scancode = USBHID_KEY_1 + (key - '1');
342 |     }
343 |     else if (key >= XK_F1 && key <= XK_F12)
344 |     {
345 |         scancode = USBHID_KEY_F1 + (key - XK_F1);
346 |     }
347 |     else if (key >= XK_KP_F1 && key <= XK_KP_F4)
348 |     {
349 |         scancode = USBHID_KEY_F1 + (key - XK_KP_F1);
350 |     }
351 |     else if (key >= XK_KP_1 && key <= XK_KP_9)
352 |     {
353 |         scancode = USBHID_KEY_KP_1 + (key - XK_KP_1);
354 |     }
355 |     else
356 |     {
357 |         switch (key)
358 |         {
359 |             case XK_exclam:
360 |                 scancode = USBHID_KEY_1;
361 |                 break;
362 |             case XK_at:
363 |                 scancode = USBHID_KEY_2;
364 |                 break;
365 |             case XK_numbersign:
366 |                 scancode = USBHID_KEY_3;
367 |                 break;
368 |             case XK_dollar:
369 |                 scancode = USBHID_KEY_4;
370 |                 break;
371 |             case XK_percent:
372 |                 scancode = USBHID_KEY_5;
373 |                 break;
374 |             case XK_asciicircum:
375 |                 scancode = USBHID_KEY_6;
376 |                 break;
377 |             case XK_ampersand:
378 |                 scancode = USBHID_KEY_7;
379 |                 break;
380 |             case XK_asterisk:
381 |                 scancode = USBHID_KEY_8;
382 |                 break;
383 |             case XK_parenleft:
384 |                 scancode = USBHID_KEY_9;
385 |                 break;
386 |             case XK_0:
387 |             case XK_parenright:
388 |                 scancode = USBHID_KEY_0;
389 |                 break;
390 |             case XK_Return:
391 |                 scancode = USBHID_KEY_RETURN;
392 |                 break;
393 |             case XK_Escape:
394 |                 scancode = USBHID_KEY_ESC;
395 |                 break;
396 |             case XK_BackSpace:
397 |                 scancode = USBHID_KEY_BACKSPACE;
398 |                 break;
399 |             case XK_Tab:
400 |             case XK_KP_Tab:
401 |                 scancode = USBHID_KEY_TAB;
402 |                 break;
403 |             case XK_space:
404 |             case XK_KP_Space:
405 |                 scancode = USBHID_KEY_SPACE;
406 |                 break;
407 |             case XK_minus:
408 |             case XK_underscore:
409 |                 scancode = USBHID_KEY_MINUS;
410 |                 break;
411 |             case XK_plus:
412 |             case XK_equal:
413 |                 scancode = USBHID_KEY_EQUAL;
414 |                 break;
415 |             case XK_bracketleft:
416 |             case XK_braceleft:
417 |                 scancode = USBHID_KEY_LEFTBRACE;
418 |                 break;
419 |             case XK_bracketright:
420 |             case XK_braceright:
421 |                 scancode = USBHID_KEY_RIGHTBRACE;
422 |                 break;
423 |             case XK_backslash:
424 |             case XK_bar:
425 |                 scancode = USBHID_KEY_BACKSLASH;
426 |                 break;
427 |             case XK_colon:
428 |             case XK_semicolon:
429 |                 scancode = USBHID_KEY_SEMICOLON;
430 |                 break;
431 |             case XK_quotedbl:
432 |             case XK_apostrophe:
433 |                 scancode = USBHID_KEY_APOSTROPHE;
434 |                 break;
435 |             case XK_grave:
436 |             case XK_asciitilde:
437 |                 scancode = USBHID_KEY_GRAVE;
438 |                 break;
439 |             case XK_comma:
440 |             case XK_less:
441 |                 scancode = USBHID_KEY_COMMA;
442 |                 break;
443 |             case XK_period:
444 |             case XK_greater:
445 |                 scancode = USBHID_KEY_DOT;
446 |                 break;
447 |             case XK_slash:
448 |             case XK_question:
449 |                 scancode = USBHID_KEY_SLASH;
450 |                 break;
451 |             case XK_Caps_Lock:
452 |                 scancode = USBHID_KEY_CAPSLOCK;
453 |                 break;
454 |             case XK_Print:
455 |                 scancode = USBHID_KEY_PRINT;
456 |                 break;
457 |             case XK_Scroll_Lock:
458 |                 scancode = USBHID_KEY_SCROLLLOCK;
459 |                 break;
460 |             case XK_Pause:
461 |                 scancode = USBHID_KEY_PAUSE;
462 |                 break;
463 |             case XK_Insert:
464 |             case XK_KP_Insert:
465 |                 scancode = USBHID_KEY_INSERT;
466 |                 break;
467 |             case XK_Home:
468 |             case XK_KP_Home:
469 |                 scancode = USBHID_KEY_HOME;
470 |                 break;
471 |             case XK_Page_Up:
472 |             case XK_KP_Page_Up:
473 |                 scancode = USBHID_KEY_PAGEUP;
474 |                 break;
475 |             case XK_Delete:
476 |             case XK_KP_Delete:
477 |                 scancode = USBHID_KEY_DELETE;
478 |                 break;
479 |             case XK_End:
480 |             case XK_KP_End:
481 |                 scancode = USBHID_KEY_END;
482 |                 break;
483 |             case XK_Page_Down:
484 |             case XK_KP_Page_Down:
485 |                 scancode = USBHID_KEY_PAGEDOWN;
486 |                 break;
487 |             case XK_Right:
488 |             case XK_KP_Right:
489 |                 scancode = USBHID_KEY_RIGHT;
490 |                 break;
491 |             case XK_Left:
492 |             case XK_KP_Left:
493 |                 scancode = USBHID_KEY_LEFT;
494 |                 break;
495 |             case XK_Down:
496 |             case XK_KP_Down:
497 |                 scancode = USBHID_KEY_DOWN;
498 |                 break;
499 |             case XK_Up:
500 |             case XK_KP_Up:
501 |                 scancode = USBHID_KEY_UP;
502 |                 break;
503 |             case XK_Num_Lock:
504 |                 scancode = USBHID_KEY_NUMLOCK;
505 |                 break;
506 |             case XK_KP_Enter:
507 |                 scancode = USBHID_KEY_KP_ENTER;
508 |                 break;
509 |             case XK_KP_Equal:
510 |                 scancode = USBHID_KEY_KP_EQUAL;
511 |                 break;
512 |             case XK_KP_Multiply:
513 |                 scancode = USBHID_KEY_KP_MULTIPLY;
514 |                 break;
515 |             case XK_KP_Add:
516 |                 scancode = USBHID_KEY_KP_ADD;
517 |                 break;
518 |             case XK_KP_Subtract:
519 |                 scancode = USBHID_KEY_KP_SUBTRACT;
520 |                 break;
521 |             case XK_KP_Decimal:
522 |                 scancode = USBHID_KEY_KP_DECIMAL;
523 |                 break;
524 |             case XK_KP_Divide:
525 |                 scancode = USBHID_KEY_KP_DIVIDE;
526 |                 break;
527 |             case XK_KP_0:
528 |                 scancode = USBHID_KEY_KP_0;
529 |                 break;
530 |         }
531 |     }
532 | 
533 |     return scancode;
534 | }
535 | 
536 | bool Input::writeKeyboard(const uint8_t* report)
537 | {
538 |     std::unique_lock<std::mutex> lk(keyMutex);
539 |     uint retryCount = HID_REPORT_RETRY_MAX;
540 | 
541 |     while (retryCount > 0)
542 |     {
543 |         if (write(keyboardFd, report, KEY_REPORT_LENGTH) == KEY_REPORT_LENGTH)
544 |         {
545 |             return true;
546 |         }
547 | 
548 |         if (errno != EAGAIN)
549 |         {
550 |             if (errno != ESHUTDOWN)
551 |             {
552 |                 log<level::ERR>("Failed to write keyboard report",
553 |                                 entry("ERROR=%s", strerror(errno)));
554 |             }
555 | 
556 |             break;
557 |         }
558 | 
559 |         lk.unlock();
560 |         std::this_thread::sleep_for(std::chrono::milliseconds(10));
561 |         lk.lock();
562 |         retryCount--;
563 |     }
564 | 
565 |     return false;
566 | }
567 | 
568 | void Input::writePointer(const uint8_t* report)
569 | {
570 |     std::unique_lock<std::mutex> lk(ptrMutex);
571 |     uint retryCount = HID_REPORT_RETRY_MAX;
572 | 
573 |     while (retryCount > 0)
574 |     {
575 |         if (write(pointerFd, report, PTR_REPORT_LENGTH) == PTR_REPORT_LENGTH)
576 |         {
577 |             break;
578 |         }
579 | 
580 |         if (errno != EAGAIN)
581 |         {
582 |             if (errno != ESHUTDOWN)
583 |             {
584 |                 log<level::ERR>("Failed to write pointer report",
585 |                                 entry("ERROR=%s", strerror(errno)));
586 |             }
587 | 
588 |             break;
589 |         }
590 | 
591 |         lk.unlock();
592 |         std::this_thread::sleep_for(std::chrono::milliseconds(10));
593 |         lk.lock();
594 |         retryCount--;
595 |     }
596 | }
597 | 
598 | } // namespace ikvm
599 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |                             Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                     GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |                             NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 |                      END OF TERMS AND CONDITIONS
281 | 
282 |             How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     <one line to give the program's name and a brief idea of what it does.>
294 |     Copyright (C) <year>  <name of author>
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   <signature of Ty Coon>, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 | 
341 | 


--------------------------------------------------------------------------------