TTY

Teletypewriter (TTY) layer takes care of all those serial devices. Including the virtual ones like pseudoterminal (PTY).

TTY structures

There are several major TTY structures. Every TTY device in a system has a corresponding struct tty_port. These devices are maintained by a TTY driver which is struct tty_driver. This structure describes the driver but also contains a reference to operations which could be performed on the TTYs. It is struct tty_operations. Then, upon open, a struct tty_struct is allocated and lives until the final close. During this time, several callbacks from struct tty_operations are invoked by the TTY layer.

Every character received by the kernel (both from devices and users) is passed through a preselected TTY Line Discipline (in short ldisc; in C, struct tty_ldisc_ops). Its task is to transform characters as defined by a particular ldisc or by user too. The default one is n_tty, implementing echoes, signal handling, jobs control, special characters processing, and more. The transformed characters are passed further to user/device, depending on the source.

In-detail description of the named TTY structures is in separate documents:

• TTY Driver and TTY Operations
  • Allocation
  • Registration
  • TTY Driver Reference
  • TTY Operations Reference
• TTY Port
  • TTY Port Functions
  • TTY Port Reference
  • TTY Port Operations Reference
• TTY Struct
  • Initialization
  • Name
  • Reference counting
  • Install
  • Read & Write
  • Start & Stop
  • Wakeup
  • Hangup
  • Misc
  • TTY Struct Flags
  • TTY Struct Reference
• TTY Line Discipline
  • Registration
  • Other Functions
  • Line Discipline Operations Reference
  • Driver Access
  • TTY Flags
  • Locking
  • Internal Functions
• TTY Buffer
  • Flip Buffer Management
  • Other Functions
  • Buffer Locking
  • Internal Functions
• TTY IOCTL Helpers
• TTY Internals
  • Kopen
  • Exported Internal Functions
  • Internal Functions
• Console
  • Struct Console
  • Struct Consw
  • Console functions

Writing TTY Driver

Before one starts writing a TTY driver, they must consider Serial and USB Serial layers first. Drivers for serial devices can often use one of these specific layers to implement a serial driver. Only special devices should be handled directly by the TTY Layer. If you are about to write such a driver, read on.

A typical sequence a TTY driver performs is as follows:

1. Allocate and register a TTY driver (module init)

2. Create and register TTY devices as they are probed (probe function)

3. Handle TTY operations and events like interrupts (TTY core invokes the former, the device the latter)

4. Remove devices as they are going away (remove function)

5. Unregister and free the TTY driver (module exit)

Steps regarding driver, i.e. 1., 3., and 5. are described in detail in TTY Driver and TTY Operations. For the other two (devices handling), look into TTY Port.

Other Documentation

Miscellaneous documentation can be further found in these documents:

• MOXA Smartio/Industio Family Device Driver Installation Guide
  • 1. Introduction
  • 2. System Requirement
  • 3. Installation
  • 4. Utilities
  • 5. Setserial
  • 6. Troubleshooting
• GSM 0710 tty multiplexor HOWTO
  • How to use it
• N_TTY
  • External Functions
  • Internal Functions