Documentation/DocBook/device-drivers.tmpl

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
   4
   5 <book id="LinuxDriversAPI">
   6  <bookinfo>
   7   <title>Linux Device Drivers</title>
   8
   9   <legalnotice>
  10    <para>
  11      This documentation is free software; you can redistribute
  12      it and/or modify it under the terms of the GNU General Public
  13      License as published by the Free Software Foundation; either
  14      version 2 of the License, or (at your option) any later
  15      version.
  16    </para>
  17
  18    <para>
  19      This program is distributed in the hope that it will be
  20      useful, but WITHOUT ANY WARRANTY; without even the implied
  21      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22      See the GNU General Public License for more details.
  23    </para>
  24
  25    <para>
  26      You should have received a copy of the GNU General Public
  27      License along with this program; if not, write to the Free
  28      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29      MA 02111-1307 USA
  30    </para>
  31
  32    <para>
  33      For more details see the file COPYING in the source
  34      distribution of Linux.
  35    </para>
  36   </legalnotice>
  37  </bookinfo>
  38
  39 <toc></toc>
  40
  41   <chapter id="Basics">
  42      <title>Driver Basics</title>
  43      <sect1><title>Driver Entry and Exit points</title>
  44 !Iinclude/linux/init.h
  45      </sect1>
  46
  47      <sect1><title>Atomic and pointer manipulation</title>
  48 !Iarch/x86/include/asm/atomic.h
  49      </sect1>
  50
  51      <sect1><title>Delaying, scheduling, and timer routines</title>
  52 !Iinclude/linux/sched.h
  53 !Ekernel/sched/core.c
  54 !Ikernel/sched/cpupri.c
  55 !Ikernel/sched/fair.c
  56 !Iinclude/linux/completion.h
  57 !Ekernel/time/timer.c
  58      </sect1>
  59      <sect1><title>Wait queues and Wake events</title>
  60 !Iinclude/linux/wait.h
  61 !Ekernel/sched/wait.c
  62      </sect1>
  63      <sect1><title>High-resolution timers</title>
  64 !Iinclude/linux/ktime.h
  65 !Iinclude/linux/hrtimer.h
  66 !Ekernel/time/hrtimer.c
  67      </sect1>
  68      <sect1><title>Workqueues and Kevents</title>
  69 !Iinclude/linux/workqueue.h
  70 !Ekernel/workqueue.c
  71      </sect1>
  72      <sect1><title>Internal Functions</title>
  73 !Ikernel/exit.c
  74 !Ikernel/signal.c
  75 !Iinclude/linux/kthread.h
  76 !Ekernel/kthread.c
  77      </sect1>
  78
  79      <sect1><title>Kernel objects manipulation</title>
  80 <!--
  81 X!Iinclude/linux/kobject.h
  82 -->
  83 !Elib/kobject.c
  84      </sect1>
  85
  86      <sect1><title>Kernel utility functions</title>
  87 !Iinclude/linux/kernel.h
  88 !Ekernel/printk/printk.c
  89 !Ekernel/panic.c
  90 !Ekernel/sys.c
  91 !Ekernel/rcu/srcu.c
  92 !Ekernel/rcu/tree.c
  93 !Ekernel/rcu/tree_plugin.h
  94 !Ekernel/rcu/update.c
  95      </sect1>
  96
  97      <sect1><title>Device Resource Management</title>
  98 !Edrivers/base/devres.c
  99      </sect1>
 100
 101   </chapter>
 102
 103   <chapter id="devdrivers">
 104      <title>Device drivers infrastructure</title>
 105      <sect1><title>The Basic Device Driver-Model Structures </title>
 106 !Iinclude/linux/device.h
 107      </sect1>
 108      <sect1><title>Device Drivers Base</title>
 109 !Idrivers/base/init.c
 110 !Edrivers/base/driver.c
 111 !Edrivers/base/core.c
 112 !Edrivers/base/syscore.c
 113 !Edrivers/base/class.c
 114 !Idrivers/base/node.c
 115 !Edrivers/base/firmware_class.c
 116 !Edrivers/base/transport_class.c
 117 <!-- Cannot be included, because
 118      attribute_container_add_class_device_adapter
 119  and attribute_container_classdev_to_container
 120      exceed allowed 44 characters maximum
 121 X!Edrivers/base/attribute_container.c
 122 -->
 123 !Edrivers/base/dd.c
 124 <!--
 125 X!Edrivers/base/interface.c
 126 -->
 127 !Iinclude/linux/platform_device.h
 128 !Edrivers/base/platform.c
 129 !Edrivers/base/bus.c
 130      </sect1>
 131      <sect1><title>Device Drivers DMA Management</title>
 132 !Edrivers/dma-buf/dma-buf.c
 133 !Edrivers/dma-buf/fence.c
 134 !Edrivers/dma-buf/seqno-fence.c
 135 !Iinclude/linux/fence.h
 136 !Iinclude/linux/seqno-fence.h
 137 !Edrivers/dma-buf/reservation.c
 138 !Iinclude/linux/reservation.h
 139 !Edrivers/dma-buf/sync_file.c
 140 !Iinclude/linux/sync_file.h
 141 !Edrivers/base/dma-coherent.c
 142 !Edrivers/base/dma-mapping.c
 143      </sect1>
 144      <sect1><title>Device Drivers Power Management</title>
 145 !Edrivers/base/power/main.c
 146      </sect1>
 147      <sect1><title>Device Drivers ACPI Support</title>
 148 <!-- Internal functions only
 149 X!Edrivers/acpi/sleep/main.c
 150 X!Edrivers/acpi/sleep/wakeup.c
 151 X!Edrivers/acpi/motherboard.c
 152 X!Edrivers/acpi/bus.c
 153 -->
 154 !Edrivers/acpi/scan.c
 155 !Idrivers/acpi/scan.c
 156 <!-- No correct structured comments
 157 X!Edrivers/acpi/pci_bind.c
 158 -->
 159      </sect1>
 160      <sect1><title>Device drivers PnP support</title>
 161 !Idrivers/pnp/core.c
 162 <!-- No correct structured comments
 163 X!Edrivers/pnp/system.c
 164  -->
 165 !Edrivers/pnp/card.c
 166 !Idrivers/pnp/driver.c
 167 !Edrivers/pnp/manager.c
 168 !Edrivers/pnp/support.c
 169      </sect1>
 170      <sect1><title>Userspace IO devices</title>
 171 !Edrivers/uio/uio.c
 172 !Iinclude/linux/uio_driver.h
 173      </sect1>
 174   </chapter>
 175
 176   <chapter id="parportdev">
 177      <title>Parallel Port Devices</title>
 178 !Iinclude/linux/parport.h
 179 !Edrivers/parport/ieee1284.c
 180 !Edrivers/parport/share.c
 181 !Idrivers/parport/daisy.c
 182   </chapter>
 183
 184   <chapter id="message_devices">
 185         <title>Message-based devices</title>
 186      <sect1><title>Fusion message devices</title>
 187 !Edrivers/message/fusion/mptbase.c
 188 !Idrivers/message/fusion/mptbase.c
 189 !Edrivers/message/fusion/mptscsih.c
 190 !Idrivers/message/fusion/mptscsih.c
 191 !Idrivers/message/fusion/mptctl.c
 192 !Idrivers/message/fusion/mptspi.c
 193 !Idrivers/message/fusion/mptfc.c
 194 !Idrivers/message/fusion/mptlan.c
 195      </sect1>
 196   </chapter>
 197
 198   <chapter id="snddev">
 199      <title>Sound Devices</title>
 200 !Iinclude/sound/core.h
 201 !Esound/sound_core.c
 202 !Iinclude/sound/pcm.h
 203 !Esound/core/pcm.c
 204 !Esound/core/device.c
 205 !Esound/core/info.c
 206 !Esound/core/rawmidi.c
 207 !Esound/core/sound.c
 208 !Esound/core/memory.c
 209 !Esound/core/pcm_memory.c
 210 !Esound/core/init.c
 211 !Esound/core/isadma.c
 212 !Esound/core/control.c
 213 !Esound/core/pcm_lib.c
 214 !Esound/core/hwdep.c
 215 !Esound/core/pcm_native.c
 216 !Esound/core/memalloc.c
 217 <!-- FIXME: Removed for now since no structured comments in source
 218 X!Isound/sound_firmware.c
 219 -->
 220   </chapter>
 221
 222   <chapter id="mediadev">
 223      <title>Media Devices</title>
 224
 225      <sect1><title>Video2Linux devices</title>
 226 !Iinclude/media/tuner.h
 227 !Iinclude/media/tuner-types.h
 228 !Iinclude/media/tveeprom.h
 229 !Iinclude/media/v4l2-async.h
 230 !Iinclude/media/v4l2-ctrls.h
 231 !Iinclude/media/v4l2-dv-timings.h
 232 !Iinclude/media/v4l2-event.h
 233 !Iinclude/media/v4l2-flash-led-class.h
 234 !Iinclude/media/v4l2-mc.h
 235 !Iinclude/media/v4l2-mediabus.h
 236 !Iinclude/media/v4l2-mem2mem.h
 237 !Iinclude/media/v4l2-of.h
 238 !Iinclude/media/v4l2-rect.h
 239 !Iinclude/media/v4l2-subdev.h
 240 !Iinclude/media/videobuf2-core.h
 241 !Iinclude/media/videobuf2-v4l2.h
 242 !Iinclude/media/videobuf2-memops.h
 243      </sect1>
 244      <sect1><title>Digital TV (DVB) devices</title>
 245         <sect1><title>Digital TV Common functions</title>
 246 !Idrivers/media/dvb-core/dvb_math.h
 247 !Idrivers/media/dvb-core/dvb_ringbuffer.h
 248 !Idrivers/media/dvb-core/dvbdev.h
 249         </sect1>
 250         <sect1><title>Digital TV Frontend kABI</title>
 251 !Pdrivers/media/dvb-core/dvb_frontend.h Digital TV Frontend
 252 !Idrivers/media/dvb-core/dvb_frontend.h
 253         </sect1>
 254         <sect1><title>Digital TV Demux kABI</title>
 255 !Pdrivers/media/dvb-core/demux.h Digital TV Demux
 256         <sect1><title>Demux Callback API</title>
 257 !Pdrivers/media/dvb-core/demux.h Demux Callback
 258         </sect1>
 259 !Idrivers/media/dvb-core/demux.h
 260         </sect1>
 261         <sect1><title>Digital TV Conditional Access kABI</title>
 262 !Idrivers/media/dvb-core/dvb_ca_en50221.h
 263         </sect1>
 264      </sect1>
 265     <sect1><title>Remote Controller devices</title>
 266 !Iinclude/media/rc-core.h
 267 !Iinclude/media/lirc_dev.h
 268     </sect1>
 269     <sect1><title>Media Controller devices</title>
 270 !Pinclude/media/media-device.h Media Controller
 271 !Iinclude/media/media-device.h
 272 !Iinclude/media/media-devnode.h
 273 !Iinclude/media/media-entity.h
 274     </sect1>
 275
 276   </chapter>
 277
 278   <chapter id="uart16x50">
 279      <title>16x50 UART Driver</title>
 280 !Edrivers/tty/serial/serial_core.c
 281 !Edrivers/tty/serial/8250/8250_core.c
 282   </chapter>
 283
 284   <chapter id="fbdev">
 285      <title>Frame Buffer Library</title>
 286
 287      <para>
 288        The frame buffer drivers depend heavily on four data structures.
 289        These structures are declared in include/linux/fb.h.  They are
 290        fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs.
 291        The last three can be made available to and from userland.
 292      </para>
 293
 294      <para>
 295        fb_info defines the current state of a particular video card.
 296        Inside fb_info, there exists a fb_ops structure which is a
 297        collection of needed functions to make fbdev and fbcon work.
 298        fb_info is only visible to the kernel.
 299      </para>
 300
 301      <para>
 302        fb_var_screeninfo is used to describe the features of a video card
 303        that are user defined.  With fb_var_screeninfo, things such as
 304        depth and the resolution may be defined.
 305      </para>
 306
 307      <para>
 308        The next structure is fb_fix_screeninfo. This defines the
 309        properties of a card that are created when a mode is set and can't
 310        be changed otherwise.  A good example of this is the start of the
 311        frame buffer memory.  This "locks" the address of the frame buffer
 312        memory, so that it cannot be changed or moved.
 313      </para>
 314
 315      <para>
 316        The last structure is fb_monospecs. In the old API, there was
 317        little importance for fb_monospecs. This allowed for forbidden things
 318        such as setting a mode of 800x600 on a fix frequency monitor. With
 319        the new API, fb_monospecs prevents such things, and if used
 320        correctly, can prevent a monitor from being cooked.  fb_monospecs
 321        will not be useful until kernels 2.5.x.
 322      </para>
 323
 324      <sect1><title>Frame Buffer Memory</title>
 325 !Edrivers/video/fbdev/core/fbmem.c
 326      </sect1>
 327 <!--
 328      <sect1><title>Frame Buffer Console</title>
 329 X!Edrivers/video/console/fbcon.c
 330      </sect1>
 331 -->
 332      <sect1><title>Frame Buffer Colormap</title>
 333 !Edrivers/video/fbdev/core/fbcmap.c
 334      </sect1>
 335 <!-- FIXME:
 336   drivers/video/fbgen.c has no docs, which stuffs up the sgml.  Comment
 337   out until somebody adds docs.  KAO
 338      <sect1><title>Frame Buffer Generic Functions</title>
 339 X!Idrivers/video/fbgen.c
 340      </sect1>
 341 KAO -->
 342      <sect1><title>Frame Buffer Video Mode Database</title>
 343 !Idrivers/video/fbdev/core/modedb.c
 344 !Edrivers/video/fbdev/core/modedb.c
 345      </sect1>
 346      <sect1><title>Frame Buffer Macintosh Video Mode Database</title>
 347 !Edrivers/video/fbdev/macmodes.c
 348      </sect1>
 349      <sect1><title>Frame Buffer Fonts</title>
 350         <para>
 351            Refer to the file lib/fonts/fonts.c for more information.
 352         </para>
 353 <!-- FIXME: Removed for now since no structured comments in source
 354 X!Ilib/fonts/fonts.c
 355 -->
 356      </sect1>
 357   </chapter>
 358
 359   <chapter id="input_subsystem">
 360      <title>Input Subsystem</title>
 361      <sect1><title>Input core</title>
 362 !Iinclude/linux/input.h
 363 !Edrivers/input/input.c
 364 !Edrivers/input/ff-core.c
 365 !Edrivers/input/ff-memless.c
 366      </sect1>
 367      <sect1><title>Multitouch Library</title>
 368 !Iinclude/linux/input/mt.h
 369 !Edrivers/input/input-mt.c
 370      </sect1>
 371      <sect1><title>Polled input devices</title>
 372 !Iinclude/linux/input-polldev.h
 373 !Edrivers/input/input-polldev.c
 374      </sect1>
 375      <sect1><title>Matrix keyboards/keypads</title>
 376 !Iinclude/linux/input/matrix_keypad.h
 377      </sect1>
 378      <sect1><title>Sparse keymap support</title>
 379 !Iinclude/linux/input/sparse-keymap.h
 380 !Edrivers/input/sparse-keymap.c
 381      </sect1>
 382   </chapter>
 383
 384   <chapter id="spi">
 385       <title>Serial Peripheral Interface (SPI)</title>
 386   <para>
 387         SPI is the "Serial Peripheral Interface", widely used with
 388         embedded systems because it is a simple and efficient
 389         interface:  basically a multiplexed shift register.
 390         Its three signal wires hold a clock (SCK, often in the range
 391         of 1-20 MHz), a "Master Out, Slave In" (MOSI) data line, and
 392         a "Master In, Slave Out" (MISO) data line.
 393         SPI is a full duplex protocol; for each bit shifted out the
 394         MOSI line (one per clock) another is shifted in on the MISO line.
 395         Those bits are assembled into words of various sizes on the
 396         way to and from system memory.
 397         An additional chipselect line is usually active-low (nCS);
 398         four signals are normally used for each peripheral, plus
 399         sometimes an interrupt.
 400   </para>
 401   <para>
 402         The SPI bus facilities listed here provide a generalized
 403         interface to declare SPI busses and devices, manage them
 404         according to the standard Linux driver model, and perform
 405         input/output operations.
 406         At this time, only "master" side interfaces are supported,
 407         where Linux talks to SPI peripherals and does not implement
 408         such a peripheral itself.
 409         (Interfaces to support implementing SPI slaves would
 410         necessarily look different.)
 411   </para>
 412   <para>
 413         The programming interface is structured around two kinds of driver,
 414         and two kinds of device.
 415         A "Controller Driver" abstracts the controller hardware, which may
 416         be as simple as a set of GPIO pins or as complex as a pair of FIFOs
 417         connected to dual DMA engines on the other side of the SPI shift
 418         register (maximizing throughput).  Such drivers bridge between
 419         whatever bus they sit on (often the platform bus) and SPI, and
 420         expose the SPI side of their device as a
 421         <structname>struct spi_master</structname>.
 422         SPI devices are children of that master, represented as a
 423         <structname>struct spi_device</structname> and manufactured from
 424         <structname>struct spi_board_info</structname> descriptors which
 425         are usually provided by board-specific initialization code.
 426         A <structname>struct spi_driver</structname> is called a
 427         "Protocol Driver", and is bound to a spi_device using normal
 428         driver model calls.
 429   </para>
 430   <para>
 431         The I/O model is a set of queued messages.  Protocol drivers
 432         submit one or more <structname>struct spi_message</structname>
 433         objects, which are processed and completed asynchronously.
 434         (There are synchronous wrappers, however.)  Messages are
 435         built from one or more <structname>struct spi_transfer</structname>
 436         objects, each of which wraps a full duplex SPI transfer.
 437         A variety of protocol tweaking options are needed, because
 438         different chips adopt very different policies for how they
 439         use the bits transferred with SPI.
 440   </para>
 441 !Iinclude/linux/spi/spi.h
 442 !Fdrivers/spi/spi.c spi_register_board_info
 443 !Edrivers/spi/spi.c
 444   </chapter>
 445
 446   <chapter id="i2c">
 447      <title>I<superscript>2</superscript>C and SMBus Subsystem</title>
 448
 449      <para>
 450         I<superscript>2</superscript>C (or without fancy typography, "I2C")
 451         is an acronym for the "Inter-IC" bus, a simple bus protocol which is
 452         widely used where low data rate communications suffice.
 453         Since it's also a licensed trademark, some vendors use another
 454         name (such as "Two-Wire Interface", TWI) for the same bus.
 455         I2C only needs two signals (SCL for clock, SDA for data), conserving
 456         board real estate and minimizing signal quality issues.
 457         Most I2C devices use seven bit addresses, and bus speeds of up
 458         to 400 kHz; there's a high speed extension (3.4 MHz) that's not yet
 459         found wide use.
 460         I2C is a multi-master bus; open drain signaling is used to
 461         arbitrate between masters, as well as to handshake and to
 462         synchronize clocks from slower clients.
 463      </para>
 464
 465      <para>
 466         The Linux I2C programming interfaces support only the master
 467         side of bus interactions, not the slave side.
 468         The programming interface is structured around two kinds of driver,
 469         and two kinds of device.
 470         An I2C "Adapter Driver" abstracts the controller hardware; it binds
 471         to a physical device (perhaps a PCI device or platform_device) and
 472         exposes a <structname>struct i2c_adapter</structname> representing
 473         each I2C bus segment it manages.
 474         On each I2C bus segment will be I2C devices represented by a
 475         <structname>struct i2c_client</structname>.  Those devices will
 476         be bound to a <structname>struct i2c_driver</structname>,
 477         which should follow the standard Linux driver model.
 478         (At this writing, a legacy model is more widely used.)
 479         There are functions to perform various I2C protocol operations; at
 480         this writing all such functions are usable only from task context.
 481      </para>
 482
 483      <para>
 484         The System Management Bus (SMBus) is a sibling protocol.  Most SMBus
 485         systems are also I2C conformant.  The electrical constraints are
 486         tighter for SMBus, and it standardizes particular protocol messages
 487         and idioms.  Controllers that support I2C can also support most
 488         SMBus operations, but SMBus controllers don't support all the protocol
 489         options that an I2C controller will.
 490         There are functions to perform various SMBus protocol operations,
 491         either using I2C primitives or by issuing SMBus commands to
 492         i2c_adapter devices which don't support those I2C operations.
 493      </para>
 494
 495 !Iinclude/linux/i2c.h
 496 !Fdrivers/i2c/i2c-boardinfo.c i2c_register_board_info
 497 !Edrivers/i2c/i2c-core.c
 498   </chapter>
 499
 500   <chapter id="hsi">
 501      <title>High Speed Synchronous Serial Interface (HSI)</title>
 502
 503      <para>
 504         High Speed Synchronous Serial Interface (HSI) is a
 505         serial interface mainly used for connecting application
 506         engines (APE) with cellular modem engines (CMT) in cellular
 507         handsets.
 508
 509         HSI provides multiplexing for up to 16 logical channels,
 510         low-latency and full duplex communication.
 511      </para>
 512
 513 !Iinclude/linux/hsi/hsi.h
 514 !Edrivers/hsi/hsi.c
 515   </chapter>
 516
 517   <chapter id="pwm">
 518     <title>Pulse-Width Modulation (PWM)</title>
 519     <para>
 520       Pulse-width modulation is a modulation technique primarily used to
 521       control power supplied to electrical devices.
 522     </para>
 523     <para>
 524       The PWM framework provides an abstraction for providers and consumers
 525       of PWM signals. A controller that provides one or more PWM signals is
 526       registered as <structname>struct pwm_chip</structname>. Providers are
 527       expected to embed this structure in a driver-specific structure. This
 528       structure contains fields that describe a particular chip.
 529     </para>
 530     <para>
 531       A chip exposes one or more PWM signal sources, each of which exposed
 532       as a <structname>struct pwm_device</structname>. Operations can be
 533       performed on PWM devices to control the period, duty cycle, polarity
 534       and active state of the signal.
 535     </para>
 536     <para>
 537       Note that PWM devices are exclusive resources: they can always only be
 538       used by one consumer at a time.
 539     </para>
 540 !Iinclude/linux/pwm.h
 541 !Edrivers/pwm/core.c
 542   </chapter>
 543
 544 </book>