aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>2010-10-19 19:40:53 +0200
committerMian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>2010-10-23 13:29:48 +0200
commit1bf6aaf4907790f8f6c1cd3c09139d4831cfa2d1 (patch)
tree8ff2f21fa4470dd0d5b6ae433193be6279cd458b /Documentation
parent83c5865a072efa1b097694d573060464fcab9fc7 (diff)
misc: add stm i2s driver
This patch is based on the following work: dma40: backport DMA API changes from v2.6.35 ST-Ericsson ID: AP275280 Author: Rabin Vincent <rabin.vincent@stericsson.com> i2s_test_protocol_driver: add functions for code coverage ST-Ericsson ID: AP267219 Author: Virupax Sadashivpetimath <virupax.sadashivpetimath@stericsson.com> U8500: Board specific changes for PL022 SSP controller ST-Ericsson ID:268853 Author: Krzysztof Antonowicz <krzysztof.antonowicz@tieto.com> msp: DB8500v2 support ST-Ericsson ID: CR268345 Author: Rabin Vincent <rabin.vincent@stericsson.com> Add a power management scheme for AB3550 and fix bugs that hinder simultaneous playback/capture. ST-Ericsson ID: WP 259100 Author: Xie Xiaolei <xie.xiaolei@stericsson.com> msp: add configuration param for MSP_IODLY ST-Ericsson ID: CR261462 Author: Rabin Vincent <rabin.vincent@stericsson.com> i2s-test: zero fields of message ST-Ericsson ID: AP266979 Author: Rabin Vincent <rabin.vincent@stericsson.com> msp-i2s: re-implement infinite xfer ST-Ericsson ID: AP259210 Author: Rabin Vincent <rabin.vincent@stericsson.com> ux500: switch to DMAENGINE-based DMA driver ST-Ericsson ID: AP259210 Author: Rabin Vincent <rabin.vincent@stericsson.com> Copyright corrections ST-Ericsson ID: ER259738 Author: virupaxs <virupax.sadashivpetimath@stericsson.com> fix htmldoc warnings Author: Virupax Sadashivpetimath <virupax.sadashivpetimath@stericsson.com> msp_i2s.c :: Correct updation of Vape opp constaint variable Author: dushyanth.sr <dushyanth.sr@stericsson.com> Changes to have MSP register Vape OPP constraint. Author: dushyanth.sr <dushyanth.sr@stericsson.com> Signed-off-by: Mian Yousaf Kaukab <mian.yousaf.kaukab@stericsson.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/Makefile4
-rw-r--r--Documentation/DocBook/i2s.tmpl97
2 files changed, 99 insertions, 2 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile
index eff69a9875f..cacedccb465 100644
--- a/Documentation/DocBook/Makefile
+++ b/Documentation/DocBook/Makefile
@@ -14,10 +14,10 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
mac80211.xml debugobjects.xml sh.xml regulator.xml \
alsa-driver-api.xml writing-an-alsa-driver.xml \
- tracepoint.xml media.xml drm.xml dma.xml \
+ tracepoint.xml media.xml drm.xml \
u8500_usb.xml \
ske_keypad.xml ste_ff_vibra.xml \
- mmc.xml \
+ dma.xml gpio.xml i2s.xml i2c.xml mmc.xml \
msp.xml \
touchp.xml tc_keypad.xml stmpe.xml shrm.xml
diff --git a/Documentation/DocBook/i2s.tmpl b/Documentation/DocBook/i2s.tmpl
new file mode 100644
index 00000000000..6b6c50572e2
--- /dev/null
+++ b/Documentation/DocBook/i2s.tmpl
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
+
+<book id="I2S">
+ <bookinfo>
+ <title>I2S</title>
+
+ <authorgroup>
+ <author>
+ <firstname>Sandeep</firstname>
+ <surname>Kaushik</surname>
+ <affiliation>
+ <address>
+ <email>sandeep.kaushik@st.com</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+
+ <copyright>
+ <year>2008-2009</year>
+ <holder>STMicroelectronics Pvt Ltd</holder>
+ </copyright>
+
+ <subjectset>
+ <subject>
+ <subjectterm>Linux standard functions</subjectterm>
+ </subject>
+ </subjectset>
+
+ <legalnotice>
+ <!-- Do NOT remove the legal notice below -->
+
+ <para>
+ This documentation is free software; you can redistribute
+ it and/or modify it under the terms of the GNU General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later
+ version.
+ </para>
+
+ <para>
+ This program is distributed in the hope that it will be
+ useful, but WITHOUT ANY WARRANTY; without even the implied
+ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ </para>
+
+ <para>
+ You should have received a copy of the GNU General Public
+ License along with this program; if not, write to the Free
+ Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ MA 02111-1307 USA
+ </para>
+
+ <para>
+ For more details see the file COPYING in the source
+ distribution of Linux.
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+<toc></toc>
+ <chapter id="intro">
+ <title>Introduction</title>
+ <para>
+ This Documentation describes the APIs provided by the I2S Bus Driver. I2S bus supports different
+ protocols like I2S, PCM, SPI etc.
+ </para>
+ </chapter>
+
+ <chapter id="bugs">
+ <title>Known Bugs And Assumptions</title>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>None</term>
+ <listitem>
+ <para>
+ None.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </chapter>
+
+ <chapter id="pubfunctions">
+ <title>Public Functions Provided</title>
+ <para>
+ This Section lists the functions exported by the I2S bus driver. These functions cater to all the protocols
+ supported namely: I2S, PCM, SPI.
+ </para>
+!Edrivers/misc/i2s/i2s.c
+ </chapter>
+</book>