OpenCores
URL https://opencores.org/ocsvn/openrisc_2011-10-31/openrisc_2011-10-31/trunk

Subversion Repositories openrisc_2011-10-31

[/] [openrisc/] [trunk/] [bootloaders/] [orpmon/] [include/] [ata.h] - Blame information for rev 248

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 marcus.erl
/*
2
/////////////////////////////////////////////////////////////////////
3
////                                                             ////
4
////  Include file for OpenCores ATA Controller (OCIDEC)         ////
5
////                                                             ////
6
////  File    : ata.h                                            ////
7
////  Function: c-include file                                   ////
8
////                                                             ////
9
////  Authors: Richard Herveille (rherveille@opencores)          ////
10
////           www.opencores.org                                 ////
11
////                                                             ////
12
/////////////////////////////////////////////////////////////////////
13
////                                                             ////
14
//// Copyright (C) 2002 Richard Herveille                        ////
15
////                    rherveille@opencores.org                 ////
16
////                                                             ////
17
//// This source file may be used and distributed without        ////
18
//// restriction provided that this copyright statement is not   ////
19
//// removed from the file and that any derivative work contains ////
20
//// the original copyright notice and the associated disclaimer.////
21
////                                                             ////
22
////     THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY     ////
23
//// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED   ////
24
//// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS   ////
25
//// FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL THE AUTHOR      ////
26
//// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,         ////
27
//// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    ////
28
//// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE   ////
29
//// GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR        ////
30
//// BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF  ////
31
//// LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY, OR TORT  ////
32
//// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT  ////
33
//// OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE         ////
34
//// POSSIBILITY OF SUCH DAMAGE.                                 ////
35
////                                                             ////
36
/////////////////////////////////////////////////////////////////////
37
*/
38
 
39
/*
40
 * Definitions for the Opencores ATA Controller Core
41
 */
42
 
43
#ifndef __OC_ATA_H
44
#define __OC_ATA_H
45
 
46
 
47
#ifndef REG32
48
#define REG32(adr) *((volatile unsigned long *)(adr))
49
#endif
50
 
51
 
52
typedef unsigned long basetype;
53
 
54
/* --- Register definitions --- */
55
 
56
/* ----- Core Registers                                              */
57
#define ATA_CTRL  0x00         /* Control register                   */
58
#define ATA_STAT  0x04         /* Status register                    */
59
#define ATA_PCTR  0x08         /* PIO command timing register        */
60
#define ATA_PFTR0 0x0c         /* PIO Fast Timing register Device0   */
61
#define ATA_PFTR1 0x10         /* PIO Fast Timing register Device1   */
62
#define ATA_DTR0  0x14         /* DMA Timing register Device2        */
63
#define ATA_DTR1  0x18         /* DMA Timing register Device1        */
64
#define ATA_DTXB  0x3c         /* DMA Transmit buffer                */
65
#define ATA_RXB   0x3c         /* DMA Receive buffer                 */
66
 
67
/* ----- ATA Registers                                               */
68
#define ATA_ASR   0x78         /* Alternate Status Register      (R) */
69
#define ATA_CR    0x5c         /* Command Register               (W) */
70
#define ATA_CHR   0x54         /* Cylinder High Register       (R/W) */
71
#define ATA_CLR   0x50         /* Cylinder Low Register        (R/W) */
72
#define ATA_DR    0x40         /* Data Register                      */
73
#define ATA_DCR   0x78         /* Device Control Register        (W) */
74
#define ATA_DHR   0x58         /* Device/Head Register         (R/W) */
75
#define ATA_ERR   0x44         /* Error Register                 (R) */
76
#define ATA_FR    0x44         /* Features Register              (W) */
77
#define ATA_SCR   0x48         /* Sector Count Register        (R/W) */
78
#define ATA_SNR   0x4c         /* Sector Number Register       (R/W) */
79
#define ATA_SR    0x5c         /* Status Register                (R) */
80
#define ATA_DA    0x7c         /* Device Address Register        (R) */
81
             /* ATA/ATAPI-5 does not describe Device Status Register */
82
 
83
/* ----------------------------                                       */
84
/* ----- Bits definitions -----                                       */
85
/* ----------------------------                                       */
86
 
87
/* ----- Core Control register                                        */
88
                                /* bits 31-16 are reserved            */
89
#define ATA_DMA_EN  (0<<15)     /* DMAen, DMA enable bit              */
90
                                /* bit 14 is reserved                 */
91
#define ATA_DMA_WR  (1<<14)     /* DMA Write transaction              */
92
#define ATA_DMA_RD  (0<<14)     /* DMA Read transaction               */
93
                                /* bits 13-10 are reserved            */
94
#define ATA_BELEC1  (1<< 9)     /* Big-Little endian conversion       */
95
                                /* enable bit for Device1             */
96
#define ATA_BELEC0  (1<< 8)     /* Big-Little endian conversion       */
97
                                /* enable bit for Device0             */
98
#define ATA_IDE_EN  (1<< 7)     /* IDE core enable bit                */
99
#define ATA_FTE1    (1<< 6)     /* Device1 Fast PIO Timing Enable bit */
100
#define ATA_FTE0    (1<< 5)     /* Device0 Fast PIO Timing Enable bit */
101
#define ATA_PWPP    (1<< 4)     /* PIO Write Ping-Pong Enable bit     */
102
#define ATA_IORDY_FTE1 (1<< 3)  /* Device1 Fast PIO Timing IORDY      */
103
                                /* enable bit                         */
104
#define ATA_IORDY_FTE0 (1<< 2)  /* Device0 Fast PIO Timing IORDY      */
105
                                /* enable bit                         */
106
#define ATA_IORDY   (1<< 1)     /* PIO Command Timing IORDY enable bit*/
107
#define ATA_RST     (1<< 0)     /* ATA Reset bit                      */
108
 
109
/* ----- Core Status register                                         */
110
#define ATA_DEVID   0xf0000000  /* bits 31-28 Device-ID               */
111
#define ATA_REVNO   0x0f000000  /* bits 27-24 Revision number         */
112
                                /* bits 23-16 are reserved            */
113
#define ATA_DMA_TIP (1<<15)     /* DMA Transfer in progress           */
114
                                /* bits 14-10 are reserved            */
115
#define ATA_DRBE    (1<<10)     /* DMA Receive buffer empty           */
116
#define ATA_DTBF    (1<< 9)     /* DMA Transmit buffer full           */
117
#define ATA_DMARQ   (1<< 8)     /* DMARQ Line status                  */
118
#define ATA_PIO_TIP (1<< 7      /* PIO Transfer in progress           */
119
#define ATA_PWPPF   (1<< 6)     /* PIO write ping-pong full           */
120
                                /* bits 5-1 are reserved              */
121
#define ATA_IDEIS  (1<< 0)      /* IDE Interrupt status               */
122
 
123
 
124
/* -----  Core Timing registers                                       */
125
#define ATA_TEOC       24       /* End of cycle time          DMA/PIO */
126
#define ATA_T4         16       /* DIOW- data hold time           PIO */
127
#define ATA_T2          8       /* DIOR-/DIOW- pulse width        PIO */
128
#define ATA_TD          8       /* DIOR-/DIOW- pulse width        DMA */
129
#define ATA_T1          0       /* Address valid to DIOR-/DIOW-   PIO */
130
#define ATA_TM          0       /* CS[1:0]valid to DIOR-/DIOW-    DMA */
131
 
132
 
133
/* ----- ATA (Alternate) Status Register                              */
134
#define ATA_SR_BSY  0x80        /* Busy                               */
135
#define ATA_SR_DRDY 0x40        /* Device Ready                       */
136
#define ATA_SR_DF   0x20        /* Device Fault                       */
137
#define ATA_SR_DSC  0x10        /* Device Seek Complete               */
138
#define ATA_SR_DRQ  0x08        /* Data Request                       */
139
#define ATA_SR_COR  0x04        /* Corrected data (obsolete)          */
140
#define ATA_SR_IDX  0x02        /*                (obsolete)          */
141
#define ATA_SR_ERR  0x01        /* Error                              */
142
 
143
/* ----- ATA Device Control Register                                  */
144
                                /* bits 7-3 are reserved              */
145
#define ATA_DCR_RST 0x04        /* Software reset   (RST=1, reset)    */
146
#define ATA_DCR_IEN 0x02        /* Interrupt Enable (IEN=0, enabled)  */
147
                                /* always write a '0' to bit0         */
148
 
149
/* ----- ATA Device Address Register                                  */
150
/* All values in this register are one's complement (i.e. inverted)   */
151
#define ATA_DAR_WTG 0x40        /* Write Gate                         */
152
#define ATA_DAR_H   0x3c        /* Head Select                        */
153
#define ATA_DAR_DS1 0x02        /* Drive select 1                     */
154
#define ATA_DAR_DS0 0x01        /* Drive select 0                     */
155
 
156
/* ----- Device/Head Register                                         */
157
#define ATA_DHR_LBA 0x40        /* LBA/CHS mode ('1'=LBA mode)        */
158
#define ATA_DHR_DEV 0x10        /* Device       ('0'=dev0, '1'=dev1)  */
159
#define ATA_DHR_H   0x0f        /* Head Select                        */
160
 
161
/* ----- Error Register                                               */
162
#define ATA_ERR_BBK  0x80        /* Bad Block                          */
163
#define ATA_ERR_UNC  0x40       /* Uncorrectable Data Error           */
164
#define ATA_ERR_IDNF 0x10       /* ID Not Found                       */
165
#define ATA_ERR_ABT  0x04       /* Aborted Command                    */
166
#define ATA_ERR_TON  0x02       /* Track0 Not Found                   */
167
#define ATA_ERR_AMN  0x01       /* Address Mark Not Found             */
168
 
169
 
170
/* ----------------------------                                       */
171
/* ----- ATA commands     -----                                       */
172
/* ----------------------------                                       */
173
#define CFA_ERASE_SECTORS                0xC0
174
#define CFA_REQUEST_EXTENDED_ERROR_CODE  0x03
175
#define CFA_TRANSLATE_SECTOR             0x87
176
#define CFA_WRITE_MULTIPLE_WITHOUT_ERASE 0xCD
177
#define CFA_WRITE_SECTORS_WITHOUT_ERASE  0x38
178
#define CHECK_POWER_MODE                 0xE5
179
#define DEVICE_RESET                     0x08
180
#define DOWNLOAD_MICROCODE               0x92
181
#define EXECUTE_DEVICE_DIAGNOSTIC        0x90
182
#define FLUSH_CACHE                      0xE7
183
#define GET_MEDIA_STATUS                 0xDA
184
#define IDENTIFY_DEVICE                  0xEC
185
#define IDENTIFY_PACKET_DEVICE           0xA1
186
#define IDLE                             0xE3
187
#define IDLE_IMMEDIATE                   0xE1
188
#define INITIALIZE_DEVICE_PARAMETERS     0x91
189
#define MEDIA_EJECT                      0xED
190
#define MEDIA_LOCK                       0xDE
191
#define MEDIA_UNLOCK                     0xDF
192
#define NOP                              0x00
193
#define PACKET                           0xA0
194
#define READ_BUFFER                      0xE4
195
#define READ_DMA                         0xC8
196
#define READ_DMA_QUEUED                  0xC7
197
#define READ_MULTIPLE                    0xC4
198
#define READ_NATIVE_MAX_ADDRESS          0xF8
199
#define READ_SECTOR                      0x20
200
#define READ_SECTORS                     0x20
201
#define READ_VERIFY_SECTOR               0x40
202
#define READ_VERIFY_SECTORS              0x40
203
#define SECURITY_DISABLE_PASSWORD        0xF6
204
#define SECURITY_ERASE_PREPARE           0xF3
205
#define SECURITY_ERASE_UNIT              0xF4
206
#define SECURITY_FREEZE_LOCK             0xF5
207
#define SECURITY_SET_PASSWORD            0xF1
208
#define SECURITY_UNLOCK                  0xF2
209
#define SEEK                             0x70
210
#define SERVICE                          0xA2
211
#define SET_FEATURES                     0xEF
212
#define SET_MAX                          0xF9
213
#define SET_MULTIPLE_MODE                0xC6
214
#define SLEEP                            0xE6
215
#define SMART                            0xB0
216
#define STANDBY                          0xE2
217
#define STANDBY_IMMEDIATE                0xE0
218
#define WRITE_BUFFER                     0xE8
219
#define WRITE_DMA                        0xCA
220
#define WRITE_DMA_QUEUED                 0xCC
221
#define WRITE_MULTIPLE                   0xC5
222
#define WRITE_SECTOR                     0x30
223
#define WRITE_SECTORS                    0x30
224
 
225
 
226
/* SET_FEATURES has a number of sub-commands (in Features Register)   */
227
#define CFA_ENABLE_8BIT_PIO_TRANSFER_MODE       0x01
228
#define ENABLE_WRITE_CACHE                      0x02
229
#define SET_TRANSFER_MODE_SECTOR_COUNT_REG      0x03
230
#define ENABLE_ADVANCED_POWER_MANAGEMENT        0x05
231
#define ENABLE_POWERUP_IN_STANDBY_FEATURE_SET   0x06
232
#define POWERUP_IN_STANDBY_FEATURE_SET_SPINUP   0x07
233
#define CFA_ENABLE_POWER_MODE1                  0x0A
234
#define DISABLE_MEDIA_STATUS_NOTIFICATION       0x31
235
#define DISABLE_READ_LOOKAHEAD                  0x55
236
#define ENABLE_RELEASE_INTERRUPT                0x5D
237
#define ENABLE_SERVICE_INTERRUPT                0x5E
238
#define DISABLE_REVERTING_TO_POWERON_DEFAULTS   0x66
239
#define CFA_DISABLE_8BIT_PIO_TRANSFER_MODE      0x81
240
#define DISABLE_WRITE_CACHE                     0x82
241
#define DISABLE_ADVANCED_POWER_MANAGEMENT       0x85
242
#define DISABLE_POWERUP_IN_STANDBY_FEATURE_SET  0x86
243
#define CFA_DISABLE_POWER_MODE1                 0x8A
244
#define ENABLE_MEDIA_STATUS_NOTIFICATION        0x95
245
#define ENABLE_READ_LOOKAHEAD_FEATURE           0xAA
246
#define ENABLE_REVERTING_TO_POWERON_DEFAULTS    0xCC
247
#define DISABLE_RELEASE_INTERRUPT               0xDD
248
#define DISABLE_SERVICE_INTERRUPT               0xDE
249
 
250
/* SET_MAX has a number of sub-commands (in Features Register)        */
251
#define SET_MAX_ADDRESS                         0x00
252
#define SET_MAX_SET_PASSWORD                    0x01
253
#define SET_MAX_LOCK                            0x02
254
#define SET_MAX_UNLOCK                          0x03
255
#define SET_MAX_FREEZE_LOCK                     0x04
256
 
257
/* SET_MAX has a number of sub-commands (in Features Register)        */
258
#define SMART_READ_DATA                         0xD0
259
#define SMART_ATTRIBITE_AUTOSAVE                0xD1
260
#define SMART_SAVE_ATTRIBUTE_VALUES             0xD3
261
#define SMART_EXECUTE_OFFLINE_IMMEDIATE         0xD4
262
#define SMART_READ_LOG                          0xD5
263
#define SMART_WRITE_LOG                         0xD6
264
#define SMART_ENABLE_OPERATIONS                 0xD8
265
#define SMART_DISABLE_OPERATIONS                0xD9
266
#define SMART_RETURN_STATUS                     0xDA
267
 
268
/* ----------------------------                                       */
269
/* ----- Structs          -----                                       */
270
/* ----------------------------                                       */
271
 
272
/* ----------------------------                                       */
273
/* ----- Macros           -----                                       */
274
/* ----------------------------                                       */
275
 
276
#define ata_astatus(base)      (REG32(base + ATA_ASR))
277
#define ata_status(base)       (REG32(base + ATA_SR))
278
#define ata_error(base)        (REG32(base + ATA_ERR))
279
#define ata_cmd(base)          (REG32(base + ATA_CR))
280
 
281
#define ata_dev_busy(base)     (ata_astatus(base) & ATA_SR_BSY)
282
#define ata_dev_cmdrdy(base)   (ata_astatus(base) & (~ATA_SR_BSY & ATA_SR_DRDY))
283
#define ata_dev_datrdy(base)   (ata_astatus(base) & ATA_SR_DRQ)
284
 
285
 
286
 
287
/*
288
  INTERNALS
289
*/
290
 
291
/* -------------------                                                */
292
/* ----- defines -----                                                */
293
/* -------------------                                                */
294
#define READ 0
295
#define WRITE 1
296
 
297
#define FMODE_READ 0
298
#define FMODE_WRITE 1
299
 
300
#define SET (1<<31)
301
#define CLR 0
302
 
303
 
304
#define PIO4 0x02
305
#define PIO3 0x01
306
 
307
/*define MAJOR, MINOR numbers                                         */
308
#define MAJOR(dev) (dev >> 8)
309
#define MINOR(dev) (dev & 0xff)
310
 
311
#define MINOR_DEV0 0x00
312
#define MINOR_DEV1 0X80
313
 
314
 
315
#define ATA_IOCTL_EXEC_CMD        0
316
#define ATA_IOCTL_READ            1
317
#define ATA_IOCTL_ENABLE_HOST     2
318
#define ATA_IOCTL_IDENTIFY_DEVICE 3
319
#define ATA_IOCTL_IDENTIFY_HOST   4
320
#define ATA_IOCTL_SELECT_DEVICE   5
321
#define ATA_IOCTL_SET_RST         6
322
#define ATA_IOCTL_SET_PIO         7
323
#define ATA_IOCTL_SET_FEATURES    8
324
#define ATA_IOCTL_SET_FTE         9
325
 
326
#define ARG_HW_RST  0
327
#define ARG_SW_RST  1
328
#define ARG_DEV_RST 2
329
 
330
/* PIO numbers and PIO timing (in ns)                                 */
331
#define ARG_PIO4 4
332
#define ARG_PIO3 3
333
#define ARG_PIO2 2
334
#define ARG_PIO1 1
335
#define ARG_PIO0 0
336
 
337
/* register transfer timings                                          */
338
#define PIO0_RT0  600
339
#define PIO0_RT1  70
340
#define PIO0_RT2  290
341
#define PIO0_RT2I 0
342
#define PIO0_RT4  30
343
#define PIO0_RT9  20
344
 
345
#define PIO1_RT0  383
346
#define PIO1_RT1  50
347
#define PIO1_RT2  290
348
#define PIO1_RT2I 0
349
#define PIO1_RT4  20
350
#define PIO1_RT9  15
351
 
352
#define PIO2_RT0  330
353
#define PIO2_RT1  30
354
#define PIO2_RT2  290
355
#define PIO2_RT2I 0
356
#define PIO2_RT4  15
357
#define PIO2_RT9  10
358
 
359
#define PIO3_RT0  180
360
#define PIO3_RT1  30
361
#define PIO3_RT2  80
362
#define PIO3_RT2I 70
363
#define PIO3_RT4  10
364
#define PIO3_RT9  10
365
 
366
#define PIO4_RT0  120
367
#define PIO4_RT1  25
368
#define PIO4_RT2  70
369
#define PIO4_RT2I 25
370
#define PIO4_RT4  10
371
#define PIO4_RT9  10
372
 
373
/* data transfer timings                                              */
374
#define PIO0_DT0  600
375
#define PIO0_DT1  70
376
#define PIO0_DT2  165
377
#define PIO0_DT2I 0
378
#define PIO0_DT4  30
379
#define PIO0_DT9  20
380
 
381
#define PIO1_DT0  383
382
#define PIO1_DT1  50
383
#define PIO1_DT2  125
384
#define PIO1_DT2I 0
385
#define PIO1_DT4  20
386
#define PIO1_DT9  15
387
 
388
#define PIO2_DT0  240
389
#define PIO2_DT1  30
390
#define PIO2_DT2  100
391
#define PIO2_DT2I 0
392
#define PIO2_DT4  15
393
#define PIO2_DT9  10
394
 
395
#define PIO3_DT0  180
396
#define PIO3_DT1  30
397
#define PIO3_DT2  80
398
#define PIO3_DT2I 70
399
#define PIO3_DT4  10
400
#define PIO3_DT9  10
401
 
402
#define PIO4_DT0  120
403
#define PIO4_DT1  25
404
#define PIO4_DT2  70
405
#define PIO4_DT2I 25
406
#define PIO4_DT4  10
407
#define PIO4_DT9  10
408
 
409
 
410
 
411
/* error numbers                                                      */
412
#define EINVAL -1
413
#define EIOCTLIARG -2
414
 
415
#define EOPENIDEV  -3
416
#define EOPENIHOST -4
417
#define EOPENNODEV -5
418
 
419
 
420
 
421
 
422
/* ------------------------------                                     */
423
/* ----- structs & typedefs -----                                     */
424
/* ------------------------------                                     */
425
struct inode {
426
  unsigned short i_rdev;
427
};
428
 
429
struct file {
430
  unsigned long f_mode;
431
  unsigned long f_flags;
432
};
433
 
434
typedef unsigned int dev_t;
435
 
436
struct request {
437
  dev_t         rq_dev;
438
  int           cmd;
439
  unsigned long sector;
440
  unsigned long nr_sectors;
441
  unsigned char *buffer;
442
};
443
 
444
 
445
/* ----------------------------                                       */
446
/* ----- Prototypes       -----                                       */
447
/* ----------------------------                                       */
448
int ata_open(struct inode *inode, struct file *filp);
449
int ata_open_device_not_found(struct inode *inode);
450
 
451
int ata_release(struct inode *inode, struct file *filp);
452
 
453
int ata_ioctl(struct inode *inode, struct file *filp, unsigned command, unsigned long argument);
454
unsigned long ata_calc_pio_timing(short t0, short t1, short t2, short t4, short t2i, short t9);
455
 
456
int ata_read_dport(unsigned long base);
457
 
458
int ata_check_media_change(dev_t dev);
459
 
460
int ata_revalidate(dev_t dev);
461
 
462
int ata_request(struct inode *inode, struct file *filp, struct request *request);
463
 
464
 
465
#endif

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.