Documentation/ABI/testing/sysfs-tty

   1 What:           /sys/class/tty/console/active
   2 Date:           Nov 2010
   3 Contact:        Kay Sievers <kay.sievers@vrfy.org>
   4 Description:
   5                  Shows the list of currently configured
   6                  console devices, like 'tty1 ttyS0'.
   7                  The last entry in the file is the active
   8                  device connected to /dev/console.
   9                  The file supports poll() to detect virtual
  10                  console switches.
  11
  12 What:           /sys/class/tty/tty<x>/active
  13 Date:           Nov 2010
  14 Contact:        Kay Sievers <kay.sievers@vrfy.org>
  15 Description:
  16                  Shows the currently active virtual console
  17                  device, like 'tty1'.
  18                  The file supports poll() to detect virtual
  19                  console switches.
  20
  21 What:           /sys/class/tty/ttyS<x>/uartclk
  22 Date:           Sep 2012
  23 Contact:        Tomas Hlavacek <tmshlvck@gmail.com>
  24 Description:
  25                  Shows the current uartclk value associated with the
  26                  UART port in serial_core, that is bound to TTY like ttyS0.
  27                  uartclk = 16 * baud_base
  28
  29                  These sysfs values expose the TIOCGSERIAL interface via
  30                  sysfs rather than via ioctls.
  31
  32 What:           /sys/class/tty/ttyS<x>/type
  33 Date:           October 2012
  34 Contact:        Alan Cox <alan@linux.intel.com>
  35 Description:
  36                  Shows the current tty type for this port.
  37
  38                  These sysfs values expose the TIOCGSERIAL interface via
  39                  sysfs rather than via ioctls.
  40
  41 What:           /sys/class/tty/ttyS<x>/line
  42 Date:           October 2012
  43 Contact:        Alan Cox <alan@linux.intel.com>
  44 Description:
  45                  Shows the current tty line number for this port.
  46
  47                  These sysfs values expose the TIOCGSERIAL interface via
  48                  sysfs rather than via ioctls.
  49
  50 What:           /sys/class/tty/ttyS<x>/port
  51 Date:           October 2012
  52 Contact:        Alan Cox <alan@linux.intel.com>
  53 Description:
  54                  Shows the current tty port I/O address for this port.
  55
  56                  These sysfs values expose the TIOCGSERIAL interface via
  57                  sysfs rather than via ioctls.
  58
  59 What:           /sys/class/tty/ttyS<x>/irq
  60 Date:           October 2012
  61 Contact:        Alan Cox <alan@linux.intel.com>
  62 Description:
  63                  Shows the current primary interrupt for this port.
  64
  65                  These sysfs values expose the TIOCGSERIAL interface via
  66                  sysfs rather than via ioctls.
  67
  68 What:           /sys/class/tty/ttyS<x>/flags
  69 Date:           October 2012
  70 Contact:        Alan Cox <alan@linux.intel.com>
  71 Description:
  72                  Show the tty port status flags for this port.
  73
  74                  These sysfs values expose the TIOCGSERIAL interface via
  75                  sysfs rather than via ioctls.
  76
  77 What:           /sys/class/tty/ttyS<x>/xmit_fifo_size
  78 Date:           October 2012
  79 Contact:        Alan Cox <alan@linux.intel.com>
  80 Description:
  81                  Show the transmit FIFO size for this port.
  82
  83                  These sysfs values expose the TIOCGSERIAL interface via
  84                  sysfs rather than via ioctls.
  85
  86 What:           /sys/class/tty/ttyS<x>/close_delay
  87 Date:           October 2012
  88 Contact:        Alan Cox <alan@linux.intel.com>
  89 Description:
  90                 Show the closing delay time for this port in centiseconds.
  91
  92                 These sysfs values expose the TIOCGSERIAL interface via
  93                 sysfs rather than via ioctls.
  94
  95 What:           /sys/class/tty/ttyS<x>/closing_wait
  96 Date:           October 2012
  97 Contact:        Alan Cox <alan@linux.intel.com>
  98 Description:
  99                 Show the close wait time for this port in centiseconds.
 100
 101                 Waiting forever is represented as 0. If waiting on close is
 102                 disabled then the value is 65535.
 103
 104                 These sysfs values expose the TIOCGSERIAL interface via
 105                 sysfs rather than via ioctls.
 106
 107 What:           /sys/class/tty/ttyS<x>/custom_divisor
 108 Date:           October 2012
 109 Contact:        Alan Cox <alan@linux.intel.com>
 110 Description:
 111                  Show the custom divisor if any that is set on this port.
 112
 113                  These sysfs values expose the TIOCGSERIAL interface via
 114                  sysfs rather than via ioctls.
 115
 116 What:           /sys/class/tty/ttyS<x>/io_type
 117 Date:           October 2012
 118 Contact:        Alan Cox <alan@linux.intel.com>
 119 Description:
 120                  Show the I/O type that is to be used with the iomem base
 121                  address.
 122
 123                  These sysfs values expose the TIOCGSERIAL interface via
 124                  sysfs rather than via ioctls.
 125
 126 What:           /sys/class/tty/ttyS<x>/iomem_base
 127 Date:           October 2012
 128 Contact:        Alan Cox <alan@linux.intel.com>
 129 Description:
 130                  The I/O memory base for this port.
 131
 132                  These sysfs values expose the TIOCGSERIAL interface via
 133                  sysfs rather than via ioctls.
 134
 135 What:           /sys/class/tty/ttyS<x>/iomem_reg_shift
 136 Date:           October 2012
 137 Contact:        Alan Cox <alan@linux.intel.com>
 138 Description:
 139                  Show the register shift indicating the spacing to be used
 140                  for accesses on this iomem address.
 141
 142                  These sysfs values expose the TIOCGSERIAL interface via
 143                  sysfs rather than via ioctls.
 144
 145 What:           /sys/class/tty/ttyS<x>/rx_trig_bytes
 146 Date:           May 2014
 147 Contact:        Yoshihiro YUNOMAE <yoshihiro.yunomae.ez@hitachi.com>
 148 Description:
 149                  Shows current RX interrupt trigger bytes or sets the
 150                  user specified value to change it for the FIFO buffer.
 151                  Users can show or set this value regardless of opening the
 152                  serial device file or not.
 153
 154                  The RX trigger can be set one of four kinds of values for UART
 155                  serials. When users input a meaning less value to this I/F,
 156                  the RX trigger is changed to the nearest lower value for the
 157                  device specification. For example, when user sets 7bytes on
 158                  16550A, which has 1/4/8/14 bytes trigger, the RX trigger is
 159                  automatically changed to 4 bytes.
 160
 161 What:           /sys/class/tty/ttyS<x>/console
 162 Date:           February 2020
 163 Contact:        Andy Shevchenko <andriy.shevchenko@linux.intel.com>
 164 Description:
 165                  Allows user to detach or attach back the given device as
 166                  kernel console. It shows and accepts a boolean variable.