?lang_form? ?lang_select? ?lang_submit? ?lang_endform?
{HEADER END}
{FILE START}

library

?curdirlinks? - Rev 6

?prevdifflink? - Blame - ?getfile?

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Procyon AVRlib: sta013.h Source File</title>
<link href="dox.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<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>
00002 <span class="comment">//*****************************************************************************</span>
00003 <span class="comment">//</span>
00004 <span class="comment">// File Name    : 'sta013.h'</span>
00005 <span class="comment">// Title        : STMicroelectronics STA013 MP3 player driver</span>
00006 <span class="comment">// Author       : Pascal Stang</span>
00007 <span class="comment">// Created      : 10/22/2000</span>
00008 <span class="comment">// Revised      : 12/04/2000</span>
00009 <span class="comment">// Version      : 0.3</span>
00010 <span class="comment">// Target MCU   : ATmega103 (should work for Atmel AVR Series)</span>
00011 <span class="comment">// Editor Tabs  : 4</span>
00012 <span class="comment">//</span>
00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span>
00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span>
00015 <span class="comment">// tested.  Nonetheless, you can expect most functions to work.</span>
00016 <span class="comment">//</span><span class="comment"></span>
00017 <span class="comment">/// \ingroup driver_hw</span>
00018 <span class="comment">/// \defgroup sta013 ST STA013 MP3 Player Driver (sta013.c)</span>
00019 <span class="comment">/// \code #include "sta013.h" \endcode</span>
00020 <span class="comment">/// \par Overview</span>
00021 <span class="comment">///     This library interfaces to the I2C control port of the STA013 MP3</span>
00022 <span class="comment">/// decoder chip.  All functions necessary for setup and and control of the</span>
00023 <span class="comment">/// decoder chip are included.  Supported functions include decoder initialize,</span>
00024 <span class="comment">/// decoder start, stop, pause, and resume, get bitrate and sample rate, set</span>
00025 <span class="comment">/// volume and tone controls.</span>
00026 <span class="comment">///</span>
00027 <span class="comment">/// \NOTE The actual MP3 music data must be transmitted through a separate</span>
00028 <span class="comment">/// interface using SPI.  The SPI function library is suitable for this.</span>
00029 <span class="comment"></span><span class="comment">//</span>
00030 <span class="comment">// This code is distributed under the GNU Public License</span>
00031 <span class="comment">//      which can be found at http://www.gnu.org/licenses/gpl.txt</span>
00032 <span class="comment">//</span>
00033 <span class="comment">//*****************************************************************************</span>
00034 
00035 
00036 <span class="preprocessor">#ifndef STA013_H</span>
00037 <span class="preprocessor"></span><span class="preprocessor">#define STA013_H</span>
00038 <span class="preprocessor"></span>
00039 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>
00040 
00041 <span class="comment">// include project-dependent configuration</span>
00042 <span class="preprocessor">#include "<a class="code" href="sta013conf_8h.html">sta013conf.h</a>"</span>
00043 
00044 <span class="comment">// STA013 I2C address</span>
00045 <span class="preprocessor">#define STA_I2C_DEV                     0x86</span>
00046 <span class="preprocessor"></span><span class="preprocessor">#define STA_IDENT                       0xAC</span>
00047 <span class="preprocessor"></span>
00048 <span class="comment">// STA013 register (sub)address</span>
00049 <span class="preprocessor">#define STA_REG_VERSION                0x00</span>
00050 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_IDENT                  0x01</span>
00051 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_1               0x05</span>
00052 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_2               0x06</span>
00053 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLCTL_3               0x07</span>
00054 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_REQ_POL                0x0c</span>
00055 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SCLK_POL               0x0d</span>
00056 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ERROR_CODE             0x0f</span>
00057 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SOFT_RESET             0x10</span>
00058 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLAY                   0x13</span>
00059 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MUTE                   0x14</span>
00060 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_CMD_INTERRUPT          0x16</span>
00061 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DATA_REQ_ENABLE        0x18</span>
00062 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SYNCSTATUS             0x40</span>
00063 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANCCOUNT_L             0x41</span>
00064 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANCCOUNT_H             0x42</span>
00065 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_H                 0x43</span>
00066 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_M                 0x44</span>
00067 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_HEAD_L                 0x45</span>
00068 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DLA                    0x46</span>
00069 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DLB                    0x47</span>
00070 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DRA                    0x48</span>
00071 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DRB                    0x49</span>
00072 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MFSDF_441              0x50</span>
00073 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_441_L          0x51</span>
00074 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_441_H          0x52</span>
00075 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMDIVIDER             0x54</span>
00076 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMCONF                0x55</span>
00077 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PCMCROSS               0x56</span>
00078 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_1             0x59</span>
00079 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_2             0x5a</span>
00080 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_3             0x5b</span>
00081 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_4             0x5c</span>
00082 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_ANC_DATA_5             0x5d</span>
00083 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_MFSDF                  0x61</span>
00084 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_DAC_CLK_MODE           0x63</span>
00085 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_L              0x64</span>
00086 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_PLLFRAC_H              0x65</span>
00087 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_L            0x67</span>
00088 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_M            0x68</span>
00089 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_FRAME_CNT_H            0x69</span>
00090 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_AVERAGE_BITRATE        0x6a</span>
00091 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_SOFTVERSION            0x71</span>
00092 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_RUN                    0x72</span>
00093 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_FREQUENCY_LOW   0x77</span>
00094 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_FREQUENCY_HIGH  0x78</span>
00095 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_FREQUENCY_LOW     0x79</span>
00096 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_FREQUENCY_HIGH    0x7a</span>
00097 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TREBLE_ENHANCE         0x7b</span>
00098 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_BASS_ENHANCE           0x7c</span>
00099 <span class="preprocessor"></span><span class="preprocessor">#define STA_REG_TONE_ATTEN             0x7d</span>
00100 <span class="preprocessor"></span>
00101 <span class="preprocessor">#define MIN_VOLUME_ATTENUATION          0</span>
00102 <span class="preprocessor"></span><span class="preprocessor">#define MAX_VOLUME_ATTENUATION          96</span>
00103 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TONE_ATTENUATION            0</span>
00104 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TONE_ATTENUATION            96</span>
00105 <span class="preprocessor"></span><span class="preprocessor">#define MIN_BASS_FREQUENCY              100</span>
00106 <span class="preprocessor"></span><span class="preprocessor">#define MAX_BASS_FREQUENCY              500</span>
00107 <span class="preprocessor"></span><span class="preprocessor">#define MIN_BASS_ENHANCE                -12 // -18dB in 1.5 dB steps</span>
00108 <span class="preprocessor"></span><span class="preprocessor">#define MAX_BASS_ENHANCE                +12 // +18dB in 1.5 dB steps</span>
00109 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TREBLE_FREQUENCY            1000</span>
00110 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TREBLE_FREQUENCY            5000</span>
00111 <span class="preprocessor"></span><span class="preprocessor">#define MIN_TREBLE_ENHANCE              -12 // -18dB in 1.5 dB steps</span>
00112 <span class="preprocessor"></span><span class="preprocessor">#define MAX_TREBLE_ENHANCE              +12 // +18dB in 1.5 dB steps</span>
00113 <span class="preprocessor"></span><span class="preprocessor">#define SOFTMUTE_VOLUME_CHANGE          20</span>
00114 <span class="preprocessor"></span>
00115 <span class="comment">// global variables</span>
00116 <span class="comment">//u16 Sta013UpdateIndex;</span>
00117 
00118 <span class="comment">// prototypes</span>
00119 <span class="keywordtype">void</span> sta013HWReset(<span class="keywordtype">void</span>);
00120 u08  sta013ReadReg(u08 reg);
00121 <span class="keywordtype">void</span> sta013WriteReg(u08 reg, u08 data);
00122 <span class="keywordtype">void</span> sta013DownloadUpdate(<span class="keywordtype">void</span>);
00123 u08  sta013Init(<span class="keywordtype">void</span>);
00124 
00125 <span class="keywordtype">void</span> sta013StartDecoder(<span class="keywordtype">void</span>);
00126 <span class="keywordtype">void</span> sta013StopDecoder(<span class="keywordtype">void</span>);
00127 <span class="keywordtype">void</span> sta013PauseDecoder(<span class="keywordtype">void</span>);
00128 <span class="keywordtype">void</span> sta013ResumeDecoder(<span class="keywordtype">void</span>);
00129 
00130 <span class="keywordtype">void</span> sta013GetMP3Info(u16 *bitrate, u08 *sampFreq, u08 *mode);
00131 u16 sta013GetAverageBitrate(<span class="keywordtype">void</span>);
00132 
00133 <span class="keywordtype">void</span> sta013SetVolume(u08 volume, s08 balance);
00134 <span class="keywordtype">void</span> sta013SetTone(s08 bassEnh, u16 bassFreq, s08 trebleEnh, u16 trebleFreq);
00135 
00136 
00137 u08  sta013Demand(<span class="keywordtype">void</span>);
00138 
00139 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:07 2006 for Procyon AVRlib by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
{FILE END}
{FOOTER START}

Powered by WebSVN v2.8.3