diff options
Diffstat (limited to 'Documentation/DocBook/kernel-api.tmpl')
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 377 |
1 files changed, 0 insertions, 377 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index 5818ff75786a..bc962cda6504 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
| @@ -38,58 +38,6 @@ | |||
| 38 | 38 | ||
| 39 | <toc></toc> | 39 | <toc></toc> |
| 40 | 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_32.h | ||
| 49 | !Iarch/x86/include/asm/unaligned.h | ||
| 50 | </sect1> | ||
| 51 | |||
| 52 | <sect1><title>Delaying, scheduling, and timer routines</title> | ||
| 53 | !Iinclude/linux/sched.h | ||
| 54 | !Ekernel/sched.c | ||
| 55 | !Ekernel/timer.c | ||
| 56 | </sect1> | ||
| 57 | <sect1><title>High-resolution timers</title> | ||
| 58 | !Iinclude/linux/ktime.h | ||
| 59 | !Iinclude/linux/hrtimer.h | ||
| 60 | !Ekernel/hrtimer.c | ||
| 61 | </sect1> | ||
| 62 | <sect1><title>Workqueues and Kevents</title> | ||
| 63 | !Ekernel/workqueue.c | ||
| 64 | </sect1> | ||
| 65 | <sect1><title>Internal Functions</title> | ||
| 66 | !Ikernel/exit.c | ||
| 67 | !Ikernel/signal.c | ||
| 68 | !Iinclude/linux/kthread.h | ||
| 69 | !Ekernel/kthread.c | ||
| 70 | </sect1> | ||
| 71 | |||
| 72 | <sect1><title>Kernel objects manipulation</title> | ||
| 73 | <!-- | ||
| 74 | X!Iinclude/linux/kobject.h | ||
| 75 | --> | ||
| 76 | !Elib/kobject.c | ||
| 77 | </sect1> | ||
| 78 | |||
| 79 | <sect1><title>Kernel utility functions</title> | ||
| 80 | !Iinclude/linux/kernel.h | ||
| 81 | !Ekernel/printk.c | ||
| 82 | !Ekernel/panic.c | ||
| 83 | !Ekernel/sys.c | ||
| 84 | !Ekernel/rcupdate.c | ||
| 85 | </sect1> | ||
| 86 | |||
| 87 | <sect1><title>Device Resource Management</title> | ||
| 88 | !Edrivers/base/devres.c | ||
| 89 | </sect1> | ||
| 90 | |||
| 91 | </chapter> | ||
| 92 | |||
| 93 | <chapter id="adt"> | 41 | <chapter id="adt"> |
| 94 | <title>Data Types</title> | 42 | <title>Data Types</title> |
| 95 | <sect1><title>Doubly Linked Lists</title> | 43 | <sect1><title>Doubly Linked Lists</title> |
| @@ -298,62 +246,6 @@ X!Earch/x86/kernel/mca_32.c | |||
| 298 | !Ikernel/acct.c | 246 | !Ikernel/acct.c |
| 299 | </chapter> | 247 | </chapter> |
| 300 | 248 | ||
| 301 | <chapter id="devdrivers"> | ||
| 302 | <title>Device drivers infrastructure</title> | ||
| 303 | <sect1><title>Device Drivers Base</title> | ||
| 304 | <!-- | ||
| 305 | X!Iinclude/linux/device.h | ||
| 306 | --> | ||
| 307 | !Edrivers/base/driver.c | ||
| 308 | !Edrivers/base/core.c | ||
| 309 | !Edrivers/base/class.c | ||
| 310 | !Edrivers/base/firmware_class.c | ||
| 311 | !Edrivers/base/transport_class.c | ||
| 312 | <!-- Cannot be included, because | ||
| 313 | attribute_container_add_class_device_adapter | ||
| 314 | and attribute_container_classdev_to_container | ||
| 315 | exceed allowed 44 characters maximum | ||
| 316 | X!Edrivers/base/attribute_container.c | ||
| 317 | --> | ||
| 318 | !Edrivers/base/sys.c | ||
| 319 | <!-- | ||
| 320 | X!Edrivers/base/interface.c | ||
| 321 | --> | ||
| 322 | !Edrivers/base/platform.c | ||
| 323 | !Edrivers/base/bus.c | ||
| 324 | </sect1> | ||
| 325 | <sect1><title>Device Drivers Power Management</title> | ||
| 326 | !Edrivers/base/power/main.c | ||
| 327 | </sect1> | ||
| 328 | <sect1><title>Device Drivers ACPI Support</title> | ||
| 329 | <!-- Internal functions only | ||
| 330 | X!Edrivers/acpi/sleep/main.c | ||
| 331 | X!Edrivers/acpi/sleep/wakeup.c | ||
| 332 | X!Edrivers/acpi/motherboard.c | ||
| 333 | X!Edrivers/acpi/bus.c | ||
| 334 | --> | ||
| 335 | !Edrivers/acpi/scan.c | ||
| 336 | !Idrivers/acpi/scan.c | ||
| 337 | <!-- No correct structured comments | ||
| 338 | X!Edrivers/acpi/pci_bind.c | ||
| 339 | --> | ||
| 340 | </sect1> | ||
| 341 | <sect1><title>Device drivers PnP support</title> | ||
| 342 | !Idrivers/pnp/core.c | ||
| 343 | <!-- No correct structured comments | ||
| 344 | X!Edrivers/pnp/system.c | ||
| 345 | --> | ||
| 346 | !Edrivers/pnp/card.c | ||
| 347 | !Idrivers/pnp/driver.c | ||
| 348 | !Edrivers/pnp/manager.c | ||
| 349 | !Edrivers/pnp/support.c | ||
| 350 | </sect1> | ||
| 351 | <sect1><title>Userspace IO devices</title> | ||
| 352 | !Edrivers/uio/uio.c | ||
| 353 | !Iinclude/linux/uio_driver.h | ||
| 354 | </sect1> | ||
| 355 | </chapter> | ||
| 356 | |||
| 357 | <chapter id="blkdev"> | 249 | <chapter id="blkdev"> |
| 358 | <title>Block Devices</title> | 250 | <title>Block Devices</title> |
| 359 | !Eblock/blk-core.c | 251 | !Eblock/blk-core.c |
| @@ -381,275 +273,6 @@ X!Edrivers/pnp/system.c | |||
| 381 | !Edrivers/char/misc.c | 273 | !Edrivers/char/misc.c |
| 382 | </chapter> | 274 | </chapter> |
| 383 | 275 | ||
| 384 | <chapter id="parportdev"> | ||
| 385 | <title>Parallel Port Devices</title> | ||
| 386 | !Iinclude/linux/parport.h | ||
| 387 | !Edrivers/parport/ieee1284.c | ||
| 388 | !Edrivers/parport/share.c | ||
| 389 | !Idrivers/parport/daisy.c | ||
| 390 | </chapter> | ||
| 391 | |||
| 392 | <chapter id="message_devices"> | ||
| 393 | <title>Message-based devices</title> | ||
| 394 | <sect1><title>Fusion message devices</title> | ||
| 395 | !Edrivers/message/fusion/mptbase.c | ||
| 396 | !Idrivers/message/fusion/mptbase.c | ||
| 397 | !Edrivers/message/fusion/mptscsih.c | ||
| 398 | !Idrivers/message/fusion/mptscsih.c | ||
| 399 | !Idrivers/message/fusion/mptctl.c | ||
| 400 | !Idrivers/message/fusion/mptspi.c | ||
| 401 | !Idrivers/message/fusion/mptfc.c | ||
| 402 | !Idrivers/message/fusion/mptlan.c | ||
| 403 | </sect1> | ||
| 404 | <sect1><title>I2O message devices</title> | ||
| 405 | !Iinclude/linux/i2o.h | ||
| 406 | !Idrivers/message/i2o/core.h | ||
| 407 | !Edrivers/message/i2o/iop.c | ||
| 408 | !Idrivers/message/i2o/iop.c | ||
| 409 | !Idrivers/message/i2o/config-osm.c | ||
| 410 | !Edrivers/message/i2o/exec-osm.c | ||
| 411 | !Idrivers/message/i2o/exec-osm.c | ||
| 412 | !Idrivers/message/i2o/bus-osm.c | ||
| 413 | !Edrivers/message/i2o/device.c | ||
| 414 | !Idrivers/message/i2o/device.c | ||
| 415 | !Idrivers/message/i2o/driver.c | ||
| 416 | !Idrivers/message/i2o/pci.c | ||
| 417 | !Idrivers/message/i2o/i2o_block.c | ||
| 418 | !Idrivers/message/i2o/i2o_scsi.c | ||
| 419 | !Idrivers/message/i2o/i2o_proc.c | ||
| 420 | </sect1> | ||
| 421 | </chapter> | ||
| 422 | |||
| 423 | <chapter id="snddev"> | ||
| 424 | <title>Sound Devices</title> | ||
| 425 | !Iinclude/sound/core.h | ||
| 426 | !Esound/sound_core.c | ||
| 427 | !Iinclude/sound/pcm.h | ||
| 428 | !Esound/core/pcm.c | ||
| 429 | !Esound/core/device.c | ||
| 430 | !Esound/core/info.c | ||
| 431 | !Esound/core/rawmidi.c | ||
| 432 | !Esound/core/sound.c | ||
| 433 | !Esound/core/memory.c | ||
| 434 | !Esound/core/pcm_memory.c | ||
| 435 | !Esound/core/init.c | ||
| 436 | !Esound/core/isadma.c | ||
| 437 | !Esound/core/control.c | ||
| 438 | !Esound/core/pcm_lib.c | ||
| 439 | !Esound/core/hwdep.c | ||
| 440 | !Esound/core/pcm_native.c | ||
| 441 | !Esound/core/memalloc.c | ||
| 442 | <!-- FIXME: Removed for now since no structured comments in source | ||
| 443 | X!Isound/sound_firmware.c | ||
| 444 | --> | ||
| 445 | </chapter> | ||
| 446 | |||
| 447 | <chapter id="uart16x50"> | ||
| 448 | <title>16x50 UART Driver</title> | ||
| 449 | !Iinclude/linux/serial_core.h | ||
| 450 | !Edrivers/serial/serial_core.c | ||
| 451 | !Edrivers/serial/8250.c | ||
| 452 | </chapter> | ||
| 453 | |||
| 454 | <chapter id="fbdev"> | ||
| 455 | <title>Frame Buffer Library</title> | ||
| 456 | |||
| 457 | <para> | ||
| 458 | The frame buffer drivers depend heavily on four data structures. | ||
| 459 | These structures are declared in include/linux/fb.h. They are | ||
| 460 | fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs. | ||
| 461 | The last three can be made available to and from userland. | ||
| 462 | </para> | ||
| 463 | |||
| 464 | <para> | ||
| 465 | fb_info defines the current state of a particular video card. | ||
| 466 | Inside fb_info, there exists a fb_ops structure which is a | ||
| 467 | collection of needed functions to make fbdev and fbcon work. | ||
| 468 | fb_info is only visible to the kernel. | ||
| 469 | </para> | ||
| 470 | |||
| 471 | <para> | ||
| 472 | fb_var_screeninfo is used to describe the features of a video card | ||
| 473 | that are user defined. With fb_var_screeninfo, things such as | ||
| 474 | depth and the resolution may be defined. | ||
| 475 | </para> | ||
| 476 | |||
| 477 | <para> | ||
| 478 | The next structure is fb_fix_screeninfo. This defines the | ||
| 479 | properties of a card that are created when a mode is set and can't | ||
| 480 | be changed otherwise. A good example of this is the start of the | ||
| 481 | frame buffer memory. This "locks" the address of the frame buffer | ||
| 482 | memory, so that it cannot be changed or moved. | ||
| 483 | </para> | ||
| 484 | |||
| 485 | <para> | ||
| 486 | The last structure is fb_monospecs. In the old API, there was | ||
| 487 | little importance for fb_monospecs. This allowed for forbidden things | ||
| 488 | such as setting a mode of 800x600 on a fix frequency monitor. With | ||
| 489 | the new API, fb_monospecs prevents such things, and if used | ||
| 490 | correctly, can prevent a monitor from being cooked. fb_monospecs | ||
| 491 | will not be useful until kernels 2.5.x. | ||
| 492 | </para> | ||
| 493 | |||
| 494 | <sect1><title>Frame Buffer Memory</title> | ||
| 495 | !Edrivers/video/fbmem.c | ||
| 496 | </sect1> | ||
| 497 | <!-- | ||
| 498 | <sect1><title>Frame Buffer Console</title> | ||
| 499 | X!Edrivers/video/console/fbcon.c | ||
| 500 | </sect1> | ||
| 501 | --> | ||
| 502 | <sect1><title>Frame Buffer Colormap</title> | ||
| 503 | !Edrivers/video/fbcmap.c | ||
| 504 | </sect1> | ||
| 505 | <!-- FIXME: | ||
| 506 | drivers/video/fbgen.c has no docs, which stuffs up the sgml. Comment | ||
| 507 | out until somebody adds docs. KAO | ||
| 508 | <sect1><title>Frame Buffer Generic Functions</title> | ||
| 509 | X!Idrivers/video/fbgen.c | ||
| 510 | </sect1> | ||
| 511 | KAO --> | ||
| 512 | <sect1><title>Frame Buffer Video Mode Database</title> | ||
| 513 | !Idrivers/video/modedb.c | ||
| 514 | !Edrivers/video/modedb.c | ||
| 515 | </sect1> | ||
| 516 | <sect1><title>Frame Buffer Macintosh Video Mode Database</title> | ||
| 517 | !Edrivers/video/macmodes.c | ||
| 518 | </sect1> | ||
| 519 | <sect1><title>Frame Buffer Fonts</title> | ||
| 520 | <para> | ||
| 521 | Refer to the file drivers/video/console/fonts.c for more information. | ||
| 522 | </para> | ||
| 523 | <!-- FIXME: Removed for now since no structured comments in source | ||
| 524 | X!Idrivers/video/console/fonts.c | ||
| 525 | --> | ||
| 526 | </sect1> | ||
| 527 | </chapter> | ||
| 528 | |||
| 529 | <chapter id="input_subsystem"> | ||
| 530 | <title>Input Subsystem</title> | ||
| 531 | !Iinclude/linux/input.h | ||
| 532 | !Edrivers/input/input.c | ||
| 533 | !Edrivers/input/ff-core.c | ||
| 534 | !Edrivers/input/ff-memless.c | ||
| 535 | </chapter> | ||
| 536 | |||
| 537 | <chapter id="spi"> | ||
| 538 | <title>Serial Peripheral Interface (SPI)</title> | ||
| 539 | <para> | ||
| 540 | SPI is the "Serial Peripheral Interface", widely used with | ||
| 541 | embedded systems because it is a simple and efficient | ||
| 542 | interface: basically a multiplexed shift register. | ||
| 543 | Its three signal wires hold a clock (SCK, often in the range | ||
| 544 | of 1-20 MHz), a "Master Out, Slave In" (MOSI) data line, and | ||
| 545 | a "Master In, Slave Out" (MISO) data line. | ||
| 546 | SPI is a full duplex protocol; for each bit shifted out the | ||
| 547 | MOSI line (one per clock) another is shifted in on the MISO line. | ||
| 548 | Those bits are assembled into words of various sizes on the | ||
| 549 | way to and from system memory. | ||
| 550 | An additional chipselect line is usually active-low (nCS); | ||
| 551 | four signals are normally used for each peripheral, plus | ||
| 552 | sometimes an interrupt. | ||
| 553 | </para> | ||
| 554 | <para> | ||
| 555 | The SPI bus facilities listed here provide a generalized | ||
| 556 | interface to declare SPI busses and devices, manage them | ||
| 557 | according to the standard Linux driver model, and perform | ||
| 558 | input/output operations. | ||
| 559 | At this time, only "master" side interfaces are supported, | ||
| 560 | where Linux talks to SPI peripherals and does not implement | ||
| 561 | such a peripheral itself. | ||
| 562 | (Interfaces to support implementing SPI slaves would | ||
| 563 | necessarily look different.) | ||
| 564 | </para> | ||
| 565 | <para> | ||
| 566 | The programming interface is structured around two kinds of driver, | ||
| 567 | and two kinds of device. | ||
| 568 | A "Controller Driver" abstracts the controller hardware, which may | ||
| 569 | be as simple as a set of GPIO pins or as complex as a pair of FIFOs | ||
| 570 | connected to dual DMA engines on the other side of the SPI shift | ||
| 571 | register (maximizing throughput). Such drivers bridge between | ||
| 572 | whatever bus they sit on (often the platform bus) and SPI, and | ||
| 573 | expose the SPI side of their device as a | ||
| 574 | <structname>struct spi_master</structname>. | ||
| 575 | SPI devices are children of that master, represented as a | ||
| 576 | <structname>struct spi_device</structname> and manufactured from | ||
| 577 | <structname>struct spi_board_info</structname> descriptors which | ||
| 578 | are usually provided by board-specific initialization code. | ||
| 579 | A <structname>struct spi_driver</structname> is called a | ||
| 580 | "Protocol Driver", and is bound to a spi_device using normal | ||
| 581 | driver model calls. | ||
| 582 | </para> | ||
| 583 | <para> | ||
| 584 | The I/O model is a set of queued messages. Protocol drivers | ||
| 585 | submit one or more <structname>struct spi_message</structname> | ||
| 586 | objects, which are processed and completed asynchronously. | ||
| 587 | (There are synchronous wrappers, however.) Messages are | ||
| 588 | built from one or more <structname>struct spi_transfer</structname> | ||
| 589 | objects, each of which wraps a full duplex SPI transfer. | ||
| 590 | A variety of protocol tweaking options are needed, because | ||
| 591 | different chips adopt very different policies for how they | ||
| 592 | use the bits transferred with SPI. | ||
| 593 | </para> | ||
| 594 | !Iinclude/linux/spi/spi.h | ||
| 595 | !Fdrivers/spi/spi.c spi_register_board_info | ||
| 596 | !Edrivers/spi/spi.c | ||
| 597 | </chapter> | ||
| 598 | |||
| 599 | <chapter id="i2c"> | ||
| 600 | <title>I<superscript>2</superscript>C and SMBus Subsystem</title> | ||
| 601 | |||
| 602 | <para> | ||
| 603 | I<superscript>2</superscript>C (or without fancy typography, "I2C") | ||
| 604 | is an acronym for the "Inter-IC" bus, a simple bus protocol which is | ||
| 605 | widely used where low data rate communications suffice. | ||
| 606 | Since it's also a licensed trademark, some vendors use another | ||
| 607 | name (such as "Two-Wire Interface", TWI) for the same bus. | ||
| 608 | I2C only needs two signals (SCL for clock, SDA for data), conserving | ||
| 609 | board real estate and minimizing signal quality issues. | ||
| 610 | Most I2C devices use seven bit addresses, and bus speeds of up | ||
| 611 | to 400 kHz; there's a high speed extension (3.4 MHz) that's not yet | ||
| 612 | found wide use. | ||
| 613 | I2C is a multi-master bus; open drain signaling is used to | ||
| 614 | arbitrate between masters, as well as to handshake and to | ||
| 615 | synchronize clocks from slower clients. | ||
| 616 | </para> | ||
| 617 | |||
| 618 | <para> | ||
| 619 | The Linux I2C programming interfaces support only the master | ||
| 620 | side of bus interactions, not the slave side. | ||
| 621 | The programming interface is structured around two kinds of driver, | ||
| 622 | and two kinds of device. | ||
| 623 | An I2C "Adapter Driver" abstracts the controller hardware; it binds | ||
| 624 | to a physical device (perhaps a PCI device or platform_device) and | ||
| 625 | exposes a <structname>struct i2c_adapter</structname> representing | ||
| 626 | each I2C bus segment it manages. | ||
| 627 | On each I2C bus segment will be I2C devices represented by a | ||
| 628 | <structname>struct i2c_client</structname>. Those devices will | ||
| 629 | be bound to a <structname>struct i2c_driver</structname>, | ||
| 630 | which should follow the standard Linux driver model. | ||
| 631 | (At this writing, a legacy model is more widely used.) | ||
| 632 | There are functions to perform various I2C protocol operations; at | ||
| 633 | this writing all such functions are usable only from task context. | ||
| 634 | </para> | ||
| 635 | |||
| 636 | <para> | ||
| 637 | The System Management Bus (SMBus) is a sibling protocol. Most SMBus | ||
| 638 | systems are also I2C conformant. The electrical constraints are | ||
| 639 | tighter for SMBus, and it standardizes particular protocol messages | ||
| 640 | and idioms. Controllers that support I2C can also support most | ||
| 641 | SMBus operations, but SMBus controllers don't support all the protocol | ||
| 642 | options that an I2C controller will. | ||
| 643 | There are functions to perform various SMBus protocol operations, | ||
| 644 | either using I2C primitives or by issuing SMBus commands to | ||
| 645 | i2c_adapter devices which don't support those I2C operations. | ||
| 646 | </para> | ||
| 647 | |||
| 648 | !Iinclude/linux/i2c.h | ||
| 649 | !Fdrivers/i2c/i2c-boardinfo.c i2c_register_board_info | ||
| 650 | !Edrivers/i2c/i2c-core.c | ||
| 651 | </chapter> | ||
| 652 | |||
| 653 | <chapter id="clk"> | 276 | <chapter id="clk"> |
| 654 | <title>Clock Framework</title> | 277 | <title>Clock Framework</title> |
| 655 | 278 | ||
