linux-kernel/fake-serial/README

   1 Fake serial driver project
   2 ==========================
   3
   4 1. Main files in this directory
   5 ===============================
   6
   7 |-- cs
   8 |   `-- fake-serial-device.c : fake serial driver using serial-core API
   9 |-- tty
  10 |   `-- fake-serial-device.c : fake serial driver using tty layer directly
  11 `-- user-land
  12     |-- fsemul.c             : fake serial user-level emulation tool
  13     |-- fstool.c             : fake serial command-line utility
  14     `-- test-suite.c         : fake serial test-suite
  15
  16 2. The fake serial device
  17 =========================
  18
  19 2.1. Design main considerations
  20 -------------------------------
  21
  22   o Should emulate a modem-like device
  23
  24   o The emulated device should be able to receive commands and return
  25   appropriate responses
  26
  27   o The emulated device should implement at least the same methods
  28   implemented by the usbserial driver
  29
  30   o Hardware-specific implementations (like MCR, MSR and termios) should
  31   be fully emulated
  32
  33   o One have to able to run minicom on it, just like a modem
  34
  35 2.2. Current implementation
  36 ---------------------------
  37
  38   o Has a default of 5 devices to emulate, but it's possible to emulate up to
  39   255 devices
  40
  41   o Defines a number of commands, for each one has a defined response
  42
  43   o Has a bogus (and not tested) MCR and MSR emulation support
  44
  45   o Implements almost all usbserial methods (but some of them are bogus)
  46
  47 2.3. Test tools
  48 ---------------
  49
  50  Currently we do have the following user-space test tools:
  51
  52   fstool: A simple program wich sends the command passed to it via
  53           command-line to the driver and prints the response.
  54
  55   fsemul: Emulates the fake serial device in user-space by waiting for
  56           an user command and responds appropriately.
  57
  58   test-suite: An user-level test-suite which tests the very basic
  59               fake serial driver functionality.