summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api
Commit message (Collapse)AuthorAgeFilesLines
* PM / docs: Drop confusing kernel-doc references from infrastructure.rstRafael J. Wysocki2017-01-031-15/+0
| | | | | | | | | | | | | The references to drivers/base/power/main.c and drivers/acpi/scan.c from Documentation/driver-api/infrastructure.rst are confusing. They both cause descriptions of functions that are not relevant to device drivers at all to be generated and none of them is sufficient to cover the API in a meaningful way. Drop them for now. Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Acked-by: Jonathan Corbet <corbet@lwn.net>
* edac.rst: move concepts dictionary from edac.hMauro Carvalho Chehab2016-12-151-0/+106
| | | | | | | Instead of storing the concepts dictionary inside header file, move it to the subsystem documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* driver-api: create an edac.rst file with EDAC documentationMauro Carvalho Chehab2016-12-152-0/+73
| | | | | | | | | | Currently, there's no device driver documentation for the EDAC subsystem at the driver-api book. Fill in the blanks for the structures and functions that misses documentation, uniform the word on the existing ones, and add a new edac.rst file at driver-api, in order to document the EDAC subsystem. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* dma-buf: Extract dma-buf.rstDaniel Vetter2016-12-113-70/+74
| | | | | | | | | | | | | | | Just prep work to polish and consolidate all the dma-buf related documenation. Unfortunately I didn't discover a way to both integrate this new file into the overall toc while keeping it at the current place. Work around that by moving it into the overall driver-api/index.rst. Cc: linux-doc@vger.kernel.org Cc: Jonathan Corbet <corbet@lwn.net> Cc: Sumit Semwal <sumit.semwal@linaro.org> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/core-api/device_link: Add initial documentationLukas Wunner2016-12-052-0/+280
| | | | | | | | | | | | | | | | Document device links as introduced in v4.10 with commits: 4bdb35506b89 ("driver core: Add a wrapper around __device_release_driver()") 9ed9895370ae ("driver core: Functional dependencies tracking support") 8c73b4288496 ("PM / sleep: Make async suspend/resume of devices use device links") 21d5c57b3726 ("PM / runtime: Use device links") baa8809f6097 ("PM / runtime: Optimize the use of device links") Signed-off-by: Lukas Wunner <lukas@wunner.de> [ jc: Moved from core-api to driver-api ] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Move the 802.11 guide into the driver-api manualJonathan Corbet2016-11-297-1/+901
| | | | | | | | Put this documentation with the other driver docs and try to keep the top level reasonably clean. Cc: Johannes Berg <johannes.berg@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: convert USB to new formatOliver Neukum2016-11-162-0/+749
| | | | | | | | This is a conversion of the USB documentation to the Sphinx format. No content was altered or reformatted. Signed-off-by: Oliver <oneukum@suse.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/driver-api: Apply changed source file namesSeongJae Park2016-11-131-4/+4
| | | | | | | | | | Few files under dma-buf/ changed their names but the changes didn't applied to a document that referencing them. It is causing few documentation build warnings. This commit fixes the problems by applying changed file names on the document. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc-rst: make driver-api folder buildable stand-aloneMarkus Heiser2016-10-262-0/+18
| | | | | | | | | | | Add minimal conf.py makes the driver-api folder buildable stand-alone. To build only this folder run:: make SPHINXDIRS=driver-api htmldocs make SPHINXDIRS=driver-api pdfdocs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* vme: Convert documentation to reStructuredText, move under driver APIsMartyn Welch2016-10-212-0/+475
| | | | | | | | | Perform a relatively simple conversion of vme_api.txt to reStructuredText and move under driver-api, which seems the most logical place for this documentation. Signed-off-by: Martyn Welch <martyn.welch@collabora.co.uk> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Don't format internal MPT docsJonathan Corbet2016-09-061-18/+0
| | | | | | This is the driver API document, so the internal stuff is just noise here. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: split up serial-interfaces.rstJonathan Corbet2016-09-065-190/+190
| | | | | | | | | | It never made sense to keep these documents together; move each into its own file. Drop the section numbering on hsi.txt on its way to its own file. Suggested-by: Sebastian Reichel <sre@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Pull the HSI documentation togetherJonathan Corbet2016-09-061-4/+78
| | | | | | | | | The HSI subsystem documentation was split across hsi.txt and the device-drivers docbook. Now that the latter has been converted to Sphinx, pull in the HSI document so that it's all in one place. Acked-by: Sebastian Reichel <sre@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: split up the driver bookJonathan Corbet2016-08-2210-654/+675
| | | | | | | | We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Docs: sphinxify device-drivers.tmplJonathan Corbet2016-08-221-0/+654
Perform a basic sphinx conversion of the device-drivers docbook and move it to its own directory. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
OpenPOWER on IntegriCloud