Skip to content
Snippets Groups Projects
  • Jonathan Corbet's avatar
    8a8a602f
    docs: Convert the deviceio template to RST · 8a8a602f
    Jonathan Corbet authored
    
    Convert deviceiobook.tmpl to RST and incorporate it into the driver API
    manual.
    
    Like the rest of our documentation, this one could use some work.  There's
    no mention of ioremap() and friends, no mention of io_read*() and friends.
    But we have nice documentation for all those folks writing new drivers that
    do port I/O :).
    
    The :c:func: notation has been left off of all the read*/write* functions.
    There's no kerneldoc comments for them anyway, so those links will never be
    live, and writing a bunch of repetitive "read a byte from I/O memory"
    comments lacks appeal.
    
    Cc: Matthew Wilcox <willy@infradead.org>
    Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
    8a8a602f
    History
    docs: Convert the deviceio template to RST
    Jonathan Corbet authored
    
    Convert deviceiobook.tmpl to RST and incorporate it into the driver API
    manual.
    
    Like the rest of our documentation, this one could use some work.  There's
    no mention of ioremap() and friends, no mention of io_read*() and friends.
    But we have nice documentation for all those folks writing new drivers that
    do port I/O :).
    
    The :c:func: notation has been left off of all the read*/write* functions.
    There's no kerneldoc comments for them anyway, so those links will never be
    live, and writing a bunch of repetitive "read a byte from I/O memory"
    comments lacks appeal.
    
    Cc: Matthew Wilcox <willy@infradead.org>
    Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk>
    Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
index.rst 750 B

The Linux driver implementer's API guide

The kernel offers a wide variety of interfaces to support the development of device drivers. This document is an only somewhat organized collection of some of those interfaces — it will hopefully get better over time! The available subsections can be seen below.

Table of contents