Line No. | Rev | Author | Line |
---|---|---|---|
1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
3 | <title>Procyon AVRlib: sta013.h Source File</title> |
||
4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
5 | </head><body> |
||
6 | <!-- Generated by Doxygen 1.4.2 --> |
||
7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
8 | <h1>sta013.h</h1><a href="sta013_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file sta013.h \brief STMicroelectronics STA013 MP3 player driver. */</span> |
||
9 | 00002 <span class="comment">//*****************************************************************************</span> |
||
10 | 00003 <span class="comment">//</span> |
||
11 | 00004 <span class="comment">// File Name : 'sta013.h'</span> |
||
12 | 00005 <span class="comment">// Title : STMicroelectronics STA013 MP3 player driver</span> |
||
13 | 00006 <span class="comment">// Author : Pascal Stang</span> |
||
14 | 00007 <span class="comment">// Created : 10/22/2000</span> |
||
15 | 00008 <span class="comment">// Revised : 12/04/2000</span> |
||
16 | 00009 <span class="comment">// Version : 0.3</span> |
||
17 | 00010 <span class="comment">// Target MCU : ATmega103 (should work for Atmel AVR Series)</span> |
||
18 | 00011 <span class="comment">// Editor Tabs : 4</span> |
||
19 | 00012 <span class="comment">//</span> |
||
20 | 00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span> |
||
21 | 00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span> |
||
22 | 00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span> |
||
23 | 00016 <span class="comment">//</span><span class="comment"></span> |
||
24 | 00017 <span class="comment">/// \ingroup driver_hw</span> |
||
25 | 00018 <span class="comment">/// \defgroup sta013 ST STA013 MP3 Player Driver (sta013.c)</span> |
||
26 | 00019 <span class="comment">/// \code #include "sta013.h" \endcode</span> |
||
27 | 00020 <span class="comment">/// \par Overview</span> |
||
28 | 00021 <span class="comment">/// This library interfaces to the I2C control port of the STA013 MP3</span> |
||
29 | 00022 <span class="comment">/// decoder chip. All functions necessary for setup and and control of the</span> |
||
30 | 00023 <span class="comment">/// decoder chip are included. Supported functions include decoder initialize,</span> |
||
31 | 00024 <span class="comment">/// decoder start, stop, pause, and resume, get bitrate and sample rate, set</span> |
||
32 | 00025 <span class="comment">/// volume and tone controls.</span> |
||
33 | 00026 <span class="comment">///</span> |
||
34 | 00027 <span class="comment">/// \NOTE The actual MP3 music data must be transmitted through a separate</span> |
||
35 | 00028 <span class="comment">/// interface using SPI. The SPI function library is suitable for this.</span> |
||
36 | 00029 <span class="comment"></span><span class="comment">//</span> |
||
37 | 00030 <span class="comment">// This code is distributed under the GNU Public License</span> |
||
38 | 00031 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span> |
||
39 | 00032 <span class="comment">//</span> |
||
40 | 00033 <span class="comment">//*****************************************************************************</span> |
||
41 | 00034 |
||
42 | 00035 |
||
43 | 00036 <span class="preprocessor">#ifndef STA013_H</span> |
||
44 | 00037 <span class="preprocessor"></span><span class="preprocessor">#define STA013_H</span> |
||
45 | 00038 <span class="preprocessor"></span> |
||
46 | 00039 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span> |
||
47 | 00040 |
||
48 | 00041 <span class="comment">// include project-dependent configuration</span> |
||
49 | 00042 <span class="preprocessor">#include "<a class="code" href="sta013conf_8h.html">sta013conf.h</a>"</span> |
||
50 | 00043 |
||
51 | 00044 <span class="comment">// STA013 I2C address</span> |
||
52 | 00045 <span class="preprocessor">#define STA_I2C_DEV 0x86</span> |
||
53 | 00046 <span class="preprocessor"></span><span class="preprocessor">#define STA_IDENT 0xAC</span> |
||
54 | 00047 <span class="preprocessor"></span> |
||
55 | 00048 <span class="comment">// STA013 register (sub)address</span> |
||
56 | 00049 <span class="preprocessor">#define STA_REG_VERSION 0x00</span> |
||
57 | 00050 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_IDENT 0x01</span> |
||
58 | 00051 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_1 0x05</span> |
||
59 | 00052 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_2 0x06</span> |
||
60 | 00053 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_3 0x07</span> |
||
61 | 00054 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_REQ_POL 0x0c</span> |
||
62 | 00055 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SCLK_POL 0x0d</span> |
||
63 | 00056 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ERROR_CODE 0x0f</span> |
||
64 | 00057 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SOFT_RESET 0x10</span> |
||
65 | 00058 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLAY 0x13</span> |
||
66 | 00059 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MUTE 0x14</span> |
||
67 | 00060 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_CMD_INTERRUPT 0x16</span> |
||
68 | 00061 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DATA_REQ_ENABLE 0x18</span> |
||
69 | 00062 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SYNCSTATUS 0x40</span> |
||
70 | 00063 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANCCOUNT_L 0x41</span> |
||
71 | 00064 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANCCOUNT_H 0x42</span> |
||
72 | 00065 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_H 0x43</span> |
||
73 | 00066 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_M 0x44</span> |
||
74 | 00067 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_L 0x45</span> |
||
75 | 00068 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DLA 0x46</span> |
||
76 | 00069 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DLB 0x47</span> |
||
77 | 00070 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DRA 0x48</span> |
||
78 | 00071 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DRB 0x49</span> |
||
79 | 00072 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MFSDF_441 0x50</span> |
||
80 | 00073 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_441_L 0x51</span> |
||
81 | 00074 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_441_H 0x52</span> |
||
82 | 00075 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMDIVIDER 0x54</span> |
||
83 | 00076 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMCONF 0x55</span> |
||
84 | 00077 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMCROSS 0x56</span> |
||
85 | 00078 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_1 0x59</span> |
||
86 | 00079 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_2 0x5a</span> |
||
87 | 00080 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_3 0x5b</span> |
||
88 | 00081 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_4 0x5c</span> |
||
89 | 00082 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_5 0x5d</span> |
||
90 | 00083 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MFSDF 0x61</span> |
||
91 | 00084 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DAC_CLK_MODE 0x63</span> |
||
92 | 00085 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_L 0x64</span> |
||
93 | 00086 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_H 0x65</span> |
||
94 | 00087 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_L 0x67</span> |
||
95 | 00088 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_M 0x68</span> |
||
96 | 00089 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_H 0x69</span> |
||
97 | 00090 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_AVERAGE_BITRATE 0x6a</span> |
||
98 | 00091 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SOFTVERSION 0x71</span> |
||
99 | 00092 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_RUN 0x72</span> |
||
100 | 00093 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_FREQUENCY_LOW 0x77</span> |
||
101 | 00094 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_FREQUENCY_HIGH 0x78</span> |
||
102 | 00095 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_FREQUENCY_LOW 0x79</span> |
||
103 | 00096 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_FREQUENCY_HIGH 0x7a</span> |
||
104 | 00097 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_ENHANCE 0x7b</span> |
||
105 | 00098 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_ENHANCE 0x7c</span> |
||
106 | 00099 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TONE_ATTEN 0x7d</span> |
||
107 | 00100 <span class="preprocessor"></span> |
||
108 | 00101 <span class="preprocessor">#define MIN_VOLUME_ATTENUATION 0</span> |
||
109 | 00102 <span class="preprocessor"></span><span class="preprocessor">#define MAX_VOLUME_ATTENUATION 96</span> |
||
110 | 00103 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TONE_ATTENUATION 0</span> |
||
111 | 00104 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TONE_ATTENUATION 96</span> |
||
112 | 00105 <span class="preprocessor"></span><span class="preprocessor">#define MIN_BASS_FREQUENCY 100</span> |
||
113 | 00106 <span class="preprocessor"></span><span class="preprocessor">#define MAX_BASS_FREQUENCY 500</span> |
||
114 | 00107 <span class="preprocessor"></span><span class="preprocessor">#define MIN_BASS_ENHANCE -12 // -18dB in 1.5 dB steps</span> |
||
115 | 00108 <span class="preprocessor"></span><span class="preprocessor">#define MAX_BASS_ENHANCE +12 // +18dB in 1.5 dB steps</span> |
||
116 | 00109 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TREBLE_FREQUENCY 1000</span> |
||
117 | 00110 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TREBLE_FREQUENCY 5000</span> |
||
118 | 00111 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TREBLE_ENHANCE -12 // -18dB in 1.5 dB steps</span> |
||
119 | 00112 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TREBLE_ENHANCE +12 // +18dB in 1.5 dB steps</span> |
||
120 | 00113 <span class="preprocessor"></span><span class="preprocessor">#define SOFTMUTE_VOLUME_CHANGE 20</span> |
||
121 | 00114 <span class="preprocessor"></span> |
||
122 | 00115 <span class="comment">// global variables</span> |
||
123 | 00116 <span class="comment">//u16 Sta013UpdateIndex;</span> |
||
124 | 00117 |
||
125 | 00118 <span class="comment">// prototypes</span> |
||
126 | 00119 <span class="keywordtype">void</span> sta013HWReset(<span class="keywordtype">void</span>); |
||
127 | 00120 u08 sta013ReadReg(u08 reg); |
||
128 | 00121 <span class="keywordtype">void</span> sta013WriteReg(u08 reg, u08 data); |
||
129 | 00122 <span class="keywordtype">void</span> sta013DownloadUpdate(<span class="keywordtype">void</span>); |
||
130 | 00123 u08 sta013Init(<span class="keywordtype">void</span>); |
||
131 | 00124 |
||
132 | 00125 <span class="keywordtype">void</span> sta013StartDecoder(<span class="keywordtype">void</span>); |
||
133 | 00126 <span class="keywordtype">void</span> sta013StopDecoder(<span class="keywordtype">void</span>); |
||
134 | 00127 <span class="keywordtype">void</span> sta013PauseDecoder(<span class="keywordtype">void</span>); |
||
135 | 00128 <span class="keywordtype">void</span> sta013ResumeDecoder(<span class="keywordtype">void</span>); |
||
136 | 00129 |
||
137 | 00130 <span class="keywordtype">void</span> sta013GetMP3Info(u16 *bitrate, u08 *sampFreq, u08 *mode); |
||
138 | 00131 u16 sta013GetAverageBitrate(<span class="keywordtype">void</span>); |
||
139 | 00132 |
||
140 | 00133 <span class="keywordtype">void</span> sta013SetVolume(u08 volume, s08 balance); |
||
141 | 00134 <span class="keywordtype">void</span> sta013SetTone(s08 bassEnh, u16 bassFreq, s08 trebleEnh, u16 trebleFreq); |
||
142 | 00135 |
||
143 | 00136 |
||
144 | 00137 u08 sta013Demand(<span class="keywordtype">void</span>); |
||
145 | 00138 |
||
146 | 00139 <span class="preprocessor">#endif</span> |
||
147 | </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:07 2006 for Procyon AVRlib by |
||
148 | <a href="http://www.doxygen.org/index.html"> |
||
149 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
150 | </body> |
||
151 | </html> |
Powered by WebSVN v2.8.3