diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/Makefile | 4 | ||||
-rw-r--r-- | Documentation/filesystems/fuse.txt | 4 | ||||
-rw-r--r-- | Documentation/tty.txt | 111 |
3 files changed, 105 insertions, 14 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 36526a1e76d7..867608ab3ca0 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -53,8 +53,8 @@ installmandocs: mandocs | |||
53 | 53 | ||
54 | ### | 54 | ### |
55 | #External programs used | 55 | #External programs used |
56 | KERNELDOC = scripts/kernel-doc | 56 | KERNELDOC = $(srctree)/scripts/kernel-doc |
57 | DOCPROC = scripts/basic/docproc | 57 | DOCPROC = $(objtree)/scripts/basic/docproc |
58 | 58 | ||
59 | XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl | 59 | XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl |
60 | #XMLTOFLAGS += --skip-validation | 60 | #XMLTOFLAGS += --skip-validation |
diff --git a/Documentation/filesystems/fuse.txt b/Documentation/filesystems/fuse.txt index 345392c4caeb..397a41adb4c3 100644 --- a/Documentation/filesystems/fuse.txt +++ b/Documentation/filesystems/fuse.txt | |||
@@ -94,8 +94,8 @@ Mount options | |||
94 | filesystem is free to implement it's access policy or leave it to | 94 | filesystem is free to implement it's access policy or leave it to |
95 | the underlying file access mechanism (e.g. in case of network | 95 | the underlying file access mechanism (e.g. in case of network |
96 | filesystems). This option enables permission checking, restricting | 96 | filesystems). This option enables permission checking, restricting |
97 | access based on file mode. This is option is usually useful | 97 | access based on file mode. It is usually useful together with the |
98 | together with the 'allow_other' mount option. | 98 | 'allow_other' mount option. |
99 | 99 | ||
100 | 'allow_other' | 100 | 'allow_other' |
101 | 101 | ||
diff --git a/Documentation/tty.txt b/Documentation/tty.txt index dab56604745d..5f799e612e03 100644 --- a/Documentation/tty.txt +++ b/Documentation/tty.txt | |||
@@ -39,28 +39,37 @@ Line Discipline Methods | |||
39 | 39 | ||
40 | TTY side interfaces: | 40 | TTY side interfaces: |
41 | 41 | ||
42 | open() - Called when the line discipline is attached to | ||
43 | the terminal. No other call into the line | ||
44 | discipline for this tty will occur until it | ||
45 | completes successfully. Can sleep. | ||
46 | |||
42 | close() - This is called on a terminal when the line | 47 | close() - This is called on a terminal when the line |
43 | discipline is being unplugged. At the point of | 48 | discipline is being unplugged. At the point of |
44 | execution no further users will enter the | 49 | execution no further users will enter the |
45 | ldisc code for this tty. Can sleep. | 50 | ldisc code for this tty. Can sleep. |
46 | 51 | ||
47 | open() - Called when the line discipline is attached to | 52 | hangup() - Called when the tty line is hung up. |
48 | the terminal. No other call into the line | 53 | The line discipline should cease I/O to the tty. |
49 | discipline for this tty will occur until it | 54 | No further calls into the ldisc code will occur. |
50 | completes successfully. Can sleep. | 55 | Can sleep. |
51 | 56 | ||
52 | write() - A process is writing data through the line | 57 | write() - A process is writing data through the line |
53 | discipline. Multiple write calls are serialized | 58 | discipline. Multiple write calls are serialized |
54 | by the tty layer for the ldisc. May sleep. | 59 | by the tty layer for the ldisc. May sleep. |
55 | 60 | ||
56 | flush_buffer() - May be called at any point between open and close. | 61 | flush_buffer() - (optional) May be called at any point between |
62 | open and close, and instructs the line discipline | ||
63 | to empty its input buffer. | ||
57 | 64 | ||
58 | chars_in_buffer() - Report the number of bytes in the buffer. | 65 | chars_in_buffer() - (optional) Report the number of bytes in the input |
66 | buffer. | ||
59 | 67 | ||
60 | set_termios() - Called on termios structure changes. The caller | 68 | set_termios() - (optional) Called on termios structure changes. |
61 | passes the old termios data and the current data | 69 | The caller passes the old termios data and the |
62 | is in the tty. Called under the termios semaphore so | 70 | current data is in the tty. Called under the |
63 | allowed to sleep. Serialized against itself only. | 71 | termios semaphore so allowed to sleep. Serialized |
72 | against itself only. | ||
64 | 73 | ||
65 | read() - Move data from the line discipline to the user. | 74 | read() - Move data from the line discipline to the user. |
66 | Multiple read calls may occur in parallel and the | 75 | Multiple read calls may occur in parallel and the |
@@ -92,6 +101,88 @@ write_wakeup() - May be called at any point between open and close. | |||
92 | this function. In such a situation defer it. | 101 | this function. In such a situation defer it. |
93 | 102 | ||
94 | 103 | ||
104 | Driver Access | ||
105 | |||
106 | Line discipline methods can call the following methods of the underlying | ||
107 | hardware driver through the function pointers within the tty->driver | ||
108 | structure: | ||
109 | |||
110 | write() Write a block of characters to the tty device. | ||
111 | Returns the number of characters accepted. | ||
112 | |||
113 | put_char() Queues a character for writing to the tty device. | ||
114 | If there is no room in the queue, the character is | ||
115 | ignored. | ||
116 | |||
117 | flush_chars() (Optional) If defined, must be called after | ||
118 | queueing characters with put_char() in order to | ||
119 | start transmission. | ||
120 | |||
121 | write_room() Returns the numbers of characters the tty driver | ||
122 | will accept for queueing to be written. | ||
123 | |||
124 | ioctl() Invoke device specific ioctl. | ||
125 | Expects data pointers to refer to userspace. | ||
126 | Returns ENOIOCTLCMD for unrecognized ioctl numbers. | ||
127 | |||
128 | set_termios() Notify the tty driver that the device's termios | ||
129 | settings have changed. New settings are in | ||
130 | tty->termios. Previous settings should be passed in | ||
131 | the "old" argument. | ||
132 | |||
133 | throttle() Notify the tty driver that input buffers for the | ||
134 | line discipline are close to full, and it should | ||
135 | somehow signal that no more characters should be | ||
136 | sent to the tty. | ||
137 | |||
138 | unthrottle() Notify the tty driver that characters can now be | ||
139 | sent to the tty without fear of overrunning the | ||
140 | input buffers of the line disciplines. | ||
141 | |||
142 | stop() Ask the tty driver to stop outputting characters | ||
143 | to the tty device. | ||
144 | |||
145 | start() Ask the tty driver to resume sending characters | ||
146 | to the tty device. | ||
147 | |||
148 | hangup() Ask the tty driver to hang up the tty device. | ||
149 | |||
150 | break_ctl() (Optional) Ask the tty driver to turn on or off | ||
151 | BREAK status on the RS-232 port. If state is -1, | ||
152 | then the BREAK status should be turned on; if | ||
153 | state is 0, then BREAK should be turned off. | ||
154 | If this routine is not implemented, use ioctls | ||
155 | TIOCSBRK / TIOCCBRK instead. | ||
156 | |||
157 | wait_until_sent() Waits until the device has written out all of the | ||
158 | characters in its transmitter FIFO. | ||
159 | |||
160 | send_xchar() Send a high-priority XON/XOFF character to the device. | ||
161 | |||
162 | |||
163 | Flags | ||
164 | |||
165 | Line discipline methods have access to tty->flags field containing the | ||
166 | following interesting flags: | ||
167 | |||
168 | TTY_THROTTLED Driver input is throttled. The ldisc should call | ||
169 | tty->driver->unthrottle() in order to resume | ||
170 | reception when it is ready to process more data. | ||
171 | |||
172 | TTY_DO_WRITE_WAKEUP If set, causes the driver to call the ldisc's | ||
173 | write_wakeup() method in order to resume | ||
174 | transmission when it can accept more data | ||
175 | to transmit. | ||
176 | |||
177 | TTY_IO_ERROR If set, causes all subsequent userspace read/write | ||
178 | calls on the tty to fail, returning -EIO. | ||
179 | |||
180 | TTY_OTHER_CLOSED Device is a pty and the other side has closed. | ||
181 | |||
182 | TTY_NO_WRITE_SPLIT Prevent driver from splitting up writes into | ||
183 | smaller chunks. | ||
184 | |||
185 | |||
95 | Locking | 186 | Locking |
96 | 187 | ||
97 | Callers to the line discipline functions from the tty layer are required to | 188 | Callers to the line discipline functions from the tty layer are required to |