driver
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:7k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. Low Level Serial API
  2. --------------------
  3.    $Id: driver,v 1.3 2001/11/24 23:24:47 rmk Exp $
  4. This document is meant as a brief overview of some aspects of the new serial
  5. driver.  It is not complete, any questions you have should be directed to
  6. <rmk@arm.linux.org.uk>
  7. The reference implementation is contained within serial_amba.c.
  8. Low Level Serial Hardware Driver
  9. --------------------------------
  10. The low level serial hardware driver is responsible for supplying port
  11. information (defined by uart_port) and a set of control methods (defined
  12. by uart_ops) to the core serial driver.  The low level driver is also
  13. responsible for handling interrupts for the port, and providing any
  14. console support.
  15. Console Support
  16. ---------------
  17. The serial core provides a few helper functions.  This includes identifing
  18. the correct port structure (via uart_get_console) and decoding command line
  19. arguments (uart_parse_options).
  20. Locking
  21. -------
  22. Generally, all locking is done by the core driver, except for the interrupt
  23. functions.  It is the responsibility of the low level hardware driver to
  24. perform the necessary locking there using info->lock. (since it is running
  25. in an interrupt, you only need to use spin_lock() and spin_unlock() from
  26. the interrupt handler).
  27. uart_ops
  28. --------
  29. The uart_ops structure is the main interface between serial_core and the
  30. hardware specific driver.  It contains all the methods to control the
  31. hardware.
  32.   tx_empty(port)
  33. This function tests whether the transmitter fifo and shifter
  34. for the port described by 'port' is empty.  If it is empty,
  35. this function should return TIOCSER_TEMT, otherwise return 0.
  36. If the port does not support this operation, then it should
  37. return TIOCSER_TEMT.
  38.   set_mctrl(port, mctrl)
  39. This function sets the modem control lines for port described
  40. by 'port' to the state described by mctrl.  The relevant bits
  41. of mctrl are:
  42. - TIOCM_RTS RTS signal.
  43. - TIOCM_DTR DTR signal.
  44. - TIOCM_OUT1 OUT1 signal.
  45. - TIOCM_OUT2 OUT2 signal.
  46. If the appropriate bit is set, the signal should be driven
  47. active.  If the bit is clear, the signal should be driven
  48. inactive.
  49.   get_mctrl(port)
  50. Returns the current state of modem control inputs.  The state
  51. of the outputs should not be returned, since the core keeps
  52. track of their state.  The state information should include:
  53. - TIOCM_DCD state of DCD signal
  54. - TIOCM_CTS state of CTS signal
  55. - TIOCM_DSR state of DSR signal
  56. - TIOCM_RI state of RI signal
  57. The bit is set if the signal is currently driven active.  If
  58. the port does not support CTS, DCD or DSR, the driver should
  59. indicate that the signal is permanently active.  If RI is
  60. not available, the signal should not be indicated as active.
  61.   stop_tx(port,from_tty)
  62. Stop transmitting characters.  This might be due to the CTS
  63. line becoming inactive or the tty layer indicating we want
  64. to stop transmission.
  65.   start_tx(port,nonempty,from_tty)
  66. start transmitting characters.  (incidentally, nonempty will
  67. always be nonzero, and shouldn't be used - it will be dropped).
  68.   stop_rx(port)
  69. Stop receiving characters; the port is in the process of
  70. being closed.
  71.   enable_ms(port)
  72. Enable the modem status interrupts.
  73.   break_ctl(port,ctl)
  74. Control the transmission of a break signal.  If ctl is
  75. nonzero, the break signal should be transmitted.  The signal
  76. should be terminated when another call is made with a zero
  77. ctl.
  78.   startup(port,info)
  79. Grab any interrupt resources and initialise any low level driver
  80. state.  Enable the port for reception.  It should not activate
  81. RTS nor DTR; this will be done via a separate call to set_mctrl.
  82.   shutdown(port,info)
  83. Disable the port, disable any break condition that may be in
  84. effect, and free any interrupt resources.  It should not disable
  85. RTS nor DTR; this will have already been done via a separate
  86. call to set_mctrl.
  87.   change_speed(port,cflag,iflag,quot)
  88. Change the port parameters, including word length, parity, stop
  89. bits.  Update read_status_mask and ignore_status_mask to indicate
  90. the types of events we are interested in receiving.  Relevant
  91. cflag bits are:
  92. CSIZE - word size
  93. CSTOPB - 2 stop bits
  94. PARENB - parity enable
  95. PARODD - odd parity (when PARENB is in force)
  96. CREAD - enable reception of characters (if not set,
  97.   still receive characters from the port, but
  98.   throw them away.
  99. CRTSCTS - if set, enable CTS status change reporting
  100. CLOCAL - if not set, enable modem status change
  101.   reporting.
  102. Relevant iflag bits are:
  103. INPCK - enable frame and parity error events to be
  104.   passed to the TTY layer.
  105. BRKINT
  106. PARMRK - both of these enable break events to be
  107.   passed to the TTY layer.
  108. IGNPAR - ignore parity and framing errors
  109. IGNBRK - ignore break errors,  If IGNPAR is also
  110.   set, ignore overrun errors as well.
  111. The interaction of the iflag bits is as follows (parity error
  112. given as an example):
  113. Parity error INPCK IGNPAR
  114. None n/a n/a character received
  115. Yes n/a 0 character discarded
  116. Yes 0 1 character received, marked as
  117. TTY_NORMAL
  118. Yes 1 1 character received, marked as
  119. TTY_PARITY
  120.   pm(port,state,oldstate)
  121. perform any power management related activities on the specified
  122. port.  state indicates the new state (defined by ACPI D0-D3),
  123. oldstate indicates the previous state.  Essentially, D0 means
  124. fully on, D3 means powered down.
  125. This function should not be used to grab any resources.
  126.   type(port)
  127. Return a pointer to a string constant describing the specified
  128. port, or return NULL, in which case the string 'unknown' is
  129. substituted.
  130.   release_port(port)
  131. Release any memory and IO region resources currently in use by
  132. the port.
  133.   request_port(port)
  134. Request any memory and IO region resources required by the port.
  135. If any fail, no resources should be registered when this function
  136. returns, and it should return -EBUSY on failure.
  137.   config_port(port,type)
  138. Perform any autoconfiguration steps required for the port.  `type`
  139. contains a bit mask of the required configuration.  UART_CONFIG_TYPE
  140. indicates that the port requires detection and identification.
  141. port->type should be set to the type found, or PORT_UNKNOWN if
  142. no port was detected.
  143. UART_CONFIG_IRQ indicates autoconfiguration of the interrupt signal,
  144. which should be probed using standard kernel autoprobing techniques.
  145. This is not necessary on platforms where ports have interrupts
  146. internally hard wired (eg, system on a chip implementations).
  147.   verify_port(port,serinfo)
  148. Verify the new serial port information contained within serinfo is
  149. suitable for this port type.
  150.   ioctl(port,cmd,arg)
  151. Perform any port specific IOCTLs.  IOCTL commands must be defined
  152. using the standard numbering system found in <asm/ioctl.h>
  153. Other notes
  154. -----------
  155. It is intended some day to drop the 'unused' entries from uart_port, and
  156. allow low level drivers to register their own individual uart_port's with
  157. the core.  This will allow drivers to use uart_port as a pointer to a
  158. structure containing both the uart_port entry with their own extensions,
  159. thus:
  160. struct my_port {
  161. struct uart_port port;
  162. int my_stuff;
  163. };