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

library

?curdirlinks? -

Blame information for rev 6

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: ata.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&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>
8 <h1>ata.h</h1><a href="ata_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file ata.h \brief IDE-ATA hard disk interface driver. */</span>
9 00002 <span class="comment">//*****************************************************************************</span>
10 00003 <span class="comment">//</span>
11 00004 <span class="comment">// File Name : 'ata.h'</span>
12 00005 <span class="comment">// Title : IDE-ATA interface driver for hard disks</span>
13 00006 <span class="comment">// Author : Pascal Stang</span>
14 00007 <span class="comment">// Date : 11/22/2000</span>
15 00008 <span class="comment">// Revised : 12/29/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><span class="comment"></span>
20 00013 <span class="comment">/// \ingroup driver_hw</span>
21 00014 <span class="comment">/// \defgroup ata IDE/ATA Interface Driver (ata.c)</span>
22 00015 <span class="comment">/// \code #include "ata.h" \endcode</span>
23 00016 <span class="comment">/// \par Overview</span>
24 00017 <span class="comment">/// This library provides an interface from AVR processors to IDE/ATA</span>
25 00018 <span class="comment">/// devices. Such devices can include hard disks, CF memory cards, and</span>
26 00019 <span class="comment">/// PCMCIA disks and memory devices.  The library supports automatic drive</span>
27 00020 <span class="comment">/// identification and sector-level reading and writing.  Some minimal</span>
28 00021 <span class="comment">/// address decoding hardware is required to use this interface. For an</span>
29 00022 <span class="comment">/// example of interface hardware, see the Procyon MP3 Player docs here:</span>
30 00023 <span class="comment">/// http://hubbard.engr.scu.edu/embedded/procyonmp3/index.html.</span>
31 00024 <span class="comment">/// Future revisions if this library may include a direct hardware-less</span>
32 00025 <span class="comment">/// interface option.</span>
33 00026 <span class="comment">///</span>
34 00027 <span class="comment">/// \note This code is quite old and in some level of disrepair. Nonetheless,</span>
35 00028 <span class="comment">/// it works quite well.</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><span class="comment"></span>
41 00034 <span class="comment">//@{</span>
42 00035 <span class="comment"></span>
43 00036 <span class="preprocessor">#ifndef ATA_H</span>
44 00037 <span class="preprocessor"></span><span class="preprocessor">#define ATA_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 <span class="preprocessor">#include "<a class="code" href="ataconf_8h.html">ataconf.h</a>"</span>
48 00041
49 00042 <span class="comment">// constants</span>
50 00043 <span class="preprocessor">#define DRIVE0 0</span>
51 00044 <span class="preprocessor"></span>
52 00045 <span class="preprocessor">#define STANDBY 0</span>
53 00046 <span class="preprocessor"></span><span class="preprocessor">#define SLEEP 1</span>
54 00047 <span class="preprocessor"></span><span class="preprocessor">#define IDLE 2</span>
55 00048 <span class="preprocessor"></span>
56 00049 <span class="comment">// ATA status register bits</span>
57 00050 <span class="preprocessor">#define ATA_SR_BSY 0x80</span>
58 00051 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_DRDY 0x40</span>
59 00052 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_DF 0x20</span>
60 00053 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_DSC 0x10</span>
61 00054 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_DRQ 0x08</span>
62 00055 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_CORR 0x04</span>
63 00056 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_IDX 0x02</span>
64 00057 <span class="preprocessor"></span><span class="preprocessor">#define ATA_SR_ERR 0x01</span>
65 00058 <span class="preprocessor"></span>
66 00059 <span class="comment">// ATA error register bits</span>
67 00060 <span class="preprocessor">#define ATA_ER_UNC 0x40</span>
68 00061 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_MC 0x20</span>
69 00062 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_IDNF 0x10</span>
70 00063 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_MCR 0x08</span>
71 00064 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_ABRT 0x04</span>
72 00065 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_TK0NF 0x02</span>
73 00066 <span class="preprocessor"></span><span class="preprocessor">#define ATA_ER_AMNF 0x01</span>
74 00067 <span class="preprocessor"></span>
75 00068 <span class="comment">// ATA head register bits</span>
76 00069 <span class="preprocessor">#define ATA_HEAD_USE_LBA 0x40</span>
77 00070 <span class="preprocessor"></span><span class="comment">/*</span>
78 00071 <span class="comment">// ATA registers</span>
79 00072 <span class="comment">#define ATA_REG_BASE 0x8000</span>
80 00073 <span class="comment">#define ATA_REG_DATAL 0x00</span>
81 00074 <span class="comment">#define ATA_REG_ERROR 0x01</span>
82 00075 <span class="comment">#define ATA_REG_SECCOUNT 0x02</span>
83 00076 <span class="comment">#define ATA_REG_STARTSEC 0x03</span>
84 00077 <span class="comment">#define ATA_REG_CYLLO 0x04</span>
85 00078 <span class="comment">#define ATA_REG_CYLHI 0x05</span>
86 00079 <span class="comment">#define ATA_REG_HDDEVSEL 0x06</span>
87 00080 <span class="comment">#define ATA_REG_CMDSTATUS1 0x07</span>
88 00081 <span class="comment">#define ATA_REG_CMDSTATUS2 0x08</span>
89 00082 <span class="comment">#define ATA_REG_ACTSTATUS 0x09</span>
90 00083 <span class="comment"></span>
91 00084 <span class="comment">#define ATA_REG_DATAH 0x10</span>
92 00085 <span class="comment">*/</span>
93 00086 <span class="comment">// ATA commands</span>
94 00087 <span class="preprocessor">#define ATA_CMD_READ 0x20</span>
95 00088 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_READNR 0x21</span>
96 00089 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_WRITE 0x30</span>
97 00090 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_WRITENR 0x31</span>
98 00091 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_IDENTIFY 0xEC</span>
99 00092 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_RECALIBRATE 0x10</span>
100 00093 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_SPINDOWN 0xE0 // spin down disk immediately</span>
101 00094 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_SPINUP 0xE1 // spin up disk immediately</span>
102 00095 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_STANDBY_5SU 0xE2 // spin down disk and set auto-power-down timer (sectorcount*5sec)</span>
103 00096 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_IDLE_5SU 0xE3 // keep disk spinning and set auto-power-down timer (sectorcount*5sec)</span>
104 00097 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_SLEEP 0xE6 // sleep disk (wakeup only on HW or SW reset)</span>
105 00098 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_STANDBY_01SU 0xF2 // spin down disk and set auto-power-down timer (sectorcount*0.1sec)</span>
106 00099 <span class="preprocessor"></span><span class="preprocessor">#define ATA_CMD_IDLE_01SU 0xF3 // keep disk spinning and set auto-power-down timer (sectorcount*0.1sec)</span>
107 00100 <span class="preprocessor"></span>
108 00101
109 00102 <span class="comment">// ATA CHS disk parameters (examples, now we autodetect)</span>
110 00103 <span class="preprocessor">#define ATA_DISKPARM_CLYS 0x03A6 // number of cylinders per platter</span>
111 00104 <span class="preprocessor"></span><span class="preprocessor">#define ATA_DISKPARM_HEADS 0x10 // number of heads (usable plater sides)</span>
112 00105 <span class="preprocessor"></span><span class="preprocessor">#define ATA_DISKPARM_SECTORS 0x11 // number of sectors per head per cylinder</span>
113 00106 <span class="preprocessor"></span>
114 00107 <span class="comment">// ATA Identity fields</span>
115 00108 <span class="comment">// all offsets refer to word offset (2 byte increments)</span>
116 00109 <span class="preprocessor">#define ATA_IDENT_DEVICETYPE 0 // specifies ATA/ATAPI, removable/non-removable</span>
117 00110 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_CYLINDERS 1 // number of logical cylinders</span>
118 00111 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_HEADS 3 // number of logical heads</span>
119 00112 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_SECTORS 6 // number of sectors per track</span>
120 00113 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_SERIAL 10 // drive model name (20 characters)</span>
121 00114 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_MODEL 27 // drive model name (40 characters)</span>
122 00115 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_FIELDVALID 53 // indicates field validity of higher words (bit0: words54-58, bit1: words 64-70)</span>
123 00116 <span class="preprocessor"></span><span class="preprocessor">#define ATA_IDENT_LBASECTORS 60 // number of sectors in LBA translation mode</span>
124 00117 <span class="preprocessor"></span>
125 00118 <span class="comment">// drive mode defines (for ataSetDrivePowerMode() )</span>
126 00119 <span class="preprocessor">#define ATA_DISKMODE_SPINDOWN 0</span>
127 00120 <span class="preprocessor"></span><span class="preprocessor">#define ATA_DISKMODE_SPINUP 1</span>
128 00121 <span class="preprocessor"></span><span class="preprocessor">#define ATA_DISKMODE_SETTIMEOUT 2</span>
129 00122 <span class="preprocessor"></span><span class="preprocessor">#define ATA_DISKMODE_SLEEP 3</span>
130 00123 <span class="preprocessor"></span>
131 00124 <span class="comment">// typedefs</span>
132 00125 <span class="comment">// drive info structure</span>
133 00126 <span class="keyword">typedef</span> <span class="keyword">struct </span>
134 00127 <span class="keyword"></span>{
135 00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cylinders;
136 00129 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> heads;
137 00130 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> sectors;
138 00131 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> sizeinsectors;
139 00132 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> LBAsupport;
140 00133 <span class="keywordtype">char</span> model[41];
141 00134 } typeDriveInfo;
142 00135
143 00136
144 00137 <span class="comment">// Prototypes</span>
145 00138 <span class="keywordtype">void</span> ataInit(<span class="keywordtype">void</span>);
146 00139 <span class="keywordtype">void</span> ataDriveInit(<span class="keywordtype">void</span>);
147 00140 <span class="keywordtype">void</span> ataDriveSelect(u08 DriveNo);
148 00141 <span class="keywordtype">void</span> ataSetDrivePowerMode(u08 DriveNo, u08 mode, u08 timeout);
149 00142 u08 ataReadByte(u08 reg);
150 00143 <span class="keywordtype">void</span> ataWriteByte(u08 reg, u08 data);
151 00144 <span class="keywordtype">void</span> ataShowRegisters(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> DriveNo);
152 00145 u08 ataSWReset(<span class="keywordtype">void</span>);
153 00146 <span class="keywordtype">void</span> ataDiskErr(<span class="keywordtype">void</span>);
154 00147 <span class="keywordtype">void</span> ataPrintSector( u08 *Buffer);
155 00148 <span class="keywordtype">void</span> ataReadDataBuffer(u08 *Buffer, u16 numBytes);
156 00149 <span class="keywordtype">void</span> ataWriteDataBuffer(u08 *Buffer, u16 numBytes);
157 00150 u08 ataStatusWait(u08 mask, u08 waitStatus);
158 00151
159 00152 <span class="comment">// read and write routines for CHS based drives</span>
160 00153 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataReadSectorsCHS( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
161 00154 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Head,
162 00155 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Track,
163 00156 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Sector,
164 00157 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
165 00158 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
166 00159
167 00160 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataWriteSectorsCHS( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
168 00161 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Head,
169 00162 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Track,
170 00163 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Sector,
171 00164 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
172 00165 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
173 00166
174 00167 <span class="comment">// read and write routines for LBA based drives</span>
175 00168 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataReadSectorsLBA( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
176 00169 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lba,
177 00170 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
178 00171 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
179 00172
180 00173 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataWriteSectorsLBA( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
181 00174 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lba,
182 00175 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
183 00176 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
184 00177
185 00178 <span class="comment">// generic read and write routines using LBA</span>
186 00179 <span class="comment">// uses native or translated LBA addressing</span>
187 00180 <span class="comment">// given autodetected drive type</span>
188 00181 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataReadSectors( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
189 00182 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lba,
190 00183 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
191 00184 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
192 00185
193 00186 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ataWriteSectors( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Drive,
194 00187 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> lba,
195 00188 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numsectors,
196 00189 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *Buffer);
197 00190
198 00191 <span class="comment">//unsigned char IdentifyDrive(unsigned char DriveNo, unsigned char *Buffer, tdefDriveInfo *DriveInfo);</span>
199 00192 <span class="comment">//unsigned char SetMode(unsigned char DriveNo, unsigned char Mode, unsigned char PwrDown);</span>
200 00193 <span class="comment">//unsigned char ATA_Idle(unsigned char Drive);</span>
201 00194
202 00195 <span class="preprocessor">#endif</span>
203 00196 <span class="preprocessor"></span><span class="comment">//@}</span>
204 </span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:06 2006 for Procyon AVRlib by&nbsp;
205 <a href="http://www.doxygen.org/index.html">
206 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
207 </body>
208 </html>
{BLAME END}
{FOOTER START}

Powered by WebSVN v2.8.3