aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/msp.tmpl
blob: f6980571be7c230b5a314b51ee7edae6036bb5f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?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="MSP-Guide">
 <bookinfo>
  <title>API documentation for MSP Controller Driver</title>

  <copyright>
   <year>2008-2009</year>
   <holder>STMicroelectronics Pvt Ltd</holder>
  </copyright>

  <legalnotice>
   <para>
   This program 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.1 of the License, or (at your option)
   any later version.

   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.

   You should have received a copy of the GNU General Public License
   along with this program. If not, see "http://www.gnu.org/licenses/".

   </para>
   </legalnotice>
 </bookinfo>

<toc></toc>
  <chapter id="intro">
    <title>Introduction</title>
    <para>
	This Documentation describes the API's provided by the MSP controller Driver.
	MSP controller supports different protocols like I2S, PCM, SPI etc. This MSP
	controller driver is Open Source compliant for all the Protocols and a new
	bus called I2S is defined to jusitfy all these protcols.
    </para>
  </chapter>

  <chapter id="interface">
    <title>MSP Funtions registered over I2S Bus</title>
    <para>
	For Linux I2S framework, it hooks following functions to the I2S framework:

	stm_msp_configure_enable

	stm_msp_transceive_data

	stm_msp_close
    </para>
  </chapter>
  <chapter id="MSP">
    <title> Functions </title>
	<para>
	This Section lists the functions used by the MSP controller driver.
	These functions cater to all the protocols supported namely: I2S, PCM, SPI.
	</para>
!Edrivers/misc/i2s/msp_i2s.c
  </chapter>
</book>