aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/serial/driver
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/serial/driver')
-rw-r--r--Documentation/serial/driver44
1 files changed, 41 insertions, 3 deletions
diff --git a/Documentation/serial/driver b/Documentation/serial/driver
index 0a25a9191864..067c47d46917 100644
--- a/Documentation/serial/driver
+++ b/Documentation/serial/driver
@@ -133,6 +133,16 @@ hardware.
133 Interrupts: locally disabled. 133 Interrupts: locally disabled.
134 This call must not sleep 134 This call must not sleep
135 135
136 send_xchar(port,ch)
137 Transmit a high priority character, even if the port is stopped.
138 This is used to implement XON/XOFF flow control and tcflow(). If
139 the serial driver does not implement this function, the tty core
140 will append the character to the circular buffer and then call
141 start_tx() / stop_tx() to flush the data out.
142
143 Locking: none.
144 Interrupts: caller dependent.
145
136 stop_rx(port) 146 stop_rx(port)
137 Stop receiving characters; the port is in the process of 147 Stop receiving characters; the port is in the process of
138 being closed. 148 being closed.
@@ -242,9 +252,8 @@ hardware.
242 252
243 pm(port,state,oldstate) 253 pm(port,state,oldstate)
244 Perform any power management related activities on the specified 254 Perform any power management related activities on the specified
245 port. State indicates the new state (defined by ACPI D0-D3), 255 port. State indicates the new state (defined by
246 oldstate indicates the previous state. Essentially, D0 means 256 enum uart_pm_state), oldstate indicates the previous state.
247 fully on, D3 means powered down.
248 257
249 This function should not be used to grab any resources. 258 This function should not be used to grab any resources.
250 259
@@ -255,6 +264,10 @@ hardware.
255 Locking: none. 264 Locking: none.
256 Interrupts: caller dependent. 265 Interrupts: caller dependent.
257 266
267 set_wake(port,state)
268 Enable/disable power management wakeup on serial activity. Not
269 currently implemented.
270
258 type(port) 271 type(port)
259 Return a pointer to a string constant describing the specified 272 Return a pointer to a string constant describing the specified
260 port, or return NULL, in which case the string 'unknown' is 273 port, or return NULL, in which case the string 'unknown' is
@@ -307,6 +320,31 @@ hardware.
307 Locking: none. 320 Locking: none.
308 Interrupts: caller dependent. 321 Interrupts: caller dependent.
309 322
323 poll_init(port)
324 Called by kgdb to perform the minimal hardware initialization needed
325 to support poll_put_char() and poll_get_char(). Unlike ->startup()
326 this should not request interrupts.
327
328 Locking: tty_mutex and tty_port->mutex taken.
329 Interrupts: n/a.
330
331 poll_put_char(port,ch)
332 Called by kgdb to write a single character directly to the serial
333 port. It can and should block until there is space in the TX FIFO.
334
335 Locking: none.
336 Interrupts: caller dependent.
337 This call must not sleep
338
339 poll_get_char(port)
340 Called by kgdb to read a single character directly from the serial
341 port. If data is available, it should be returned; otherwise
342 the function should return NO_POLL_CHAR immediately.
343
344 Locking: none.
345 Interrupts: caller dependent.
346 This call must not sleep
347
310Other functions 348Other functions
311--------------- 349---------------
312 350