aboutsummaryrefslogtreecommitdiff
path: root/Documentation/DocBook/u8500_usb.tmpl
blob: 86f2e7cb7ce5e2f0f1f88856865cf79333990b2f (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?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="USB-FUNCTION-Guide">
 <bookinfo>
  <title>Montblanc USB Driver Function guide</title>

  <authorgroup>
   <author>
    <firstname>Raj</firstname>
    <surname>Kumar</surname>
    <affiliation>
     <address>
      <email>raj.e.kumar@stericsson.com</email>
     </address>
    </affiliation>
   </author>
    <author>
    <firstname>NaveenKumar</firstname>
    <surname>Gaddipati</surname>
    <affiliation>
     <address>
      <email>naveen.gaddipati@stericsson.com</email>
     </address>
    </affiliation>
   </author>
   </authorgroup>

  <copyright>
   <year>2009</year>
   <holder>ST-Ericsson</holder>
  </copyright>

  <subjectset>
    <subject>
      <subjectterm>Connectivity</subjectterm>
    </subject>
  </subjectset>

  <legalnotice>
   <para>
     This documentation is free software; you can redistribute
     it and/or modify it under the terms of the GNU General Public
     License version 2 as published by the Free Software Foundation.
   </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 ST-Ericsson's adaptation on USB external DMA and communication between Mentor USB IP controller and the USB
	transreveiver
    </para>
    </chapter>

 <chapter id="concepts">
  <title>Concepts</title>
  <!-- Do NOT change the chapter id or title! -->
  <para>
	In ST-Ericsson's USB driver, the open source linux gadget stack and Mentor IP USB 2.0 driver is used. Since the USB Transceiver and Mentor USB IP controller are on different hardware, API's are defined for the communication between them. These API's are available in stm_musb.c file.
	The ST-Ericsson's USB driver doesn't have the internal DMA dedicated for USB. So, the external system DMA is used. The integration of external DMA with the mentor chip is available in stm_musb_dma.c file.
	Changes have been made in the musb_core.c file where endpoints are configured as per the platform and also integrated DMA specific chnages in the musb_gadget.c file. One new file ste_config.h is added which is platform specific.
     <!-- TODO: A brief introduction about the concepts
           which are introduced by the driver.
           Remove this chapter completely if there are no
           special concepts introduced by this driver.
           Do NOT change the chapter id or title! -->
     <!-- TODO: This guideline for this chapter may be extended
           during the user-guide guidelines drop. -->
  </para>
 </chapter>

 <chapter id="bugs">
  <title>Known Bugs And Assumptions</title>
  <!--  Do NOT change the chapter id or title! -->
  <para>
    <variablelist>

     <varlistentry>
      <term>None.</term>
      <listitem>
       <para>
       </para>
      </listitem>
     </varlistentry>

    </variablelist>

  </para>
 </chapter>

 <chapter id="pubfunctions">
   <title>Public Functions Provided</title>
   <!-- Do NOT change the chapter id or title! -->
   <para>
	List of public interfaces in stm_musb_dma.c
   </para>
   <!-- TODO: Replace with link to appropriate headerfile(s), one per row, ensure the exclamation mark is on the first column! -->
!Edrivers/usb/musb/stm_musb.c
 </chapter>

 <chapter id="internal-functions">
   <title>Internal Functions Provided</title>
   <para>
	List of internal functions
   </para>
   <!-- Do NOT change the chapter id or title! -->
   <!-- TODO: Replace with link to appropriate headerfile(s),
        source file(s), or both. One per row, ensure the
        exclamation mark is on the first column! If no
        appropriate header or source file exist describing a public interface,
        replace the inclusion with a paragraph containing the text
        "Not Applicable"-->
  <section id="stm_musb_dma.c">
    <title>stm_musb_dma.c</title>
!Idrivers/usb/musb/stm_musb_dma.c
  </section>
  <section id="stm_musb.c">
    <title>stm_musb.c</title>
!Idrivers/usb/musb/stm_musb.c
  </section>
</chapter>

</book>