2 * Copyright (c) 2004-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * Device model for an IDE disk
33 #ifndef __IDE_DISK_HH__
34 #define __IDE_DISK_HH__
36 #include "dev/disk_image.hh"
37 #include "dev/ide_atareg.h"
38 #include "dev/ide_ctrl.hh"
39 #include "dev/ide_wdcreg.h"
40 #include "dev/io_device.hh"
41 #include "sim/eventq.hh"
43 #define DMA_BACKOFF_PERIOD 200
45 #define MAX_DMA_SIZE (65536) // 64K
46 #define MAX_MULTSECT (128)
48 #define PRD_BASE_MASK 0xfffffffe
49 #define PRD_COUNT_MASK 0xfffe
50 #define PRD_EOT_MASK 0x8000
52 typedef struct PrdEntry {
62 uint32_t getBaseAddr()
64 return (entry.baseAddr & PRD_BASE_MASK);
67 uint32_t getByteCount()
69 return ((entry.byteCount == 0) ? MAX_DMA_SIZE :
70 (entry.byteCount & PRD_COUNT_MASK));
75 return (entry.endOfTable & PRD_EOT_MASK);
79 #define DATA_OFFSET (0)
80 #define ERROR_OFFSET (1)
81 #define FEATURES_OFFSET (1)
82 #define NSECTOR_OFFSET (2)
83 #define SECTOR_OFFSET (3)
84 #define LCYL_OFFSET (4)
85 #define HCYL_OFFSET (5)
86 #define SELECT_OFFSET (6)
87 #define DRIVE_OFFSET (6)
88 #define STATUS_OFFSET (7)
89 #define COMMAND_OFFSET (7)
91 #define CONTROL_OFFSET (2)
92 #define ALTSTAT_OFFSET (2)
94 #define SELECT_DEV_BIT 0x10
95 #define CONTROL_RST_BIT 0x04
96 #define CONTROL_IEN_BIT 0x02
97 #define STATUS_BSY_BIT 0x80
98 #define STATUS_DRDY_BIT 0x40
99 #define STATUS_DRQ_BIT 0x08
100 #define STATUS_SEEK_BIT 0x10
101 #define STATUS_DF_BIT 0x20
102 #define DRIVE_LBA_BIT 0x40
107 typedef struct CommandReg {
121 typedef enum Events {
131 typedef enum DevAction {
142 ACT_DATA_WRITE_SHORT,
149 typedef enum DevState {
161 // PIO data-in (data to host)
166 // PIO data-out (data from host)
168 Data_Ready_INTRQ_Out,
176 typedef enum DmaState {
182 class PhysicalMemory;
186 * IDE Disk device model
188 class IdeDisk : public SimObject
191 typedef TheISA::Addr Addr;
193 /** The IDE controller for this disk. */
195 /** The DMA interface to use for transfers */
196 DMAInterface<Bus> *dmaInterface;
197 /** The image that contains the data of this disk. */
199 /** Pointer to physical memory for DMA transfers */
200 PhysicalMemory *physmem;
203 /** The disk delay in microseconds. */
207 /** Drive identification structure for this disk */
208 struct ataparams driveID;
209 /** Data buffer for transfers */
211 /** Number of bytes in command data transfer */
213 /** Number of bytes left in command data transfer */
214 uint32_t cmdBytesLeft;
215 /** Number of bytes left in DRQ block */
216 uint32_t drqBytesLeft;
217 /** Current sector in access */
219 /** Command block registers */
221 /** Status register */
223 /** Interrupt enable bit */
229 /** Dma transaction is a read */
231 /** PRD table base address */
234 PrdTableEntry curPrd;
235 /** Number of bytes transfered by DMA interface for current transfer */
236 uint32_t dmaInterfaceBytes;
237 /** Device ID (master=0/slave=1) */
239 /** Interrupt pending */
244 * Create and initialize this Disk.
245 * @param name The name of this disk.
246 * @param img The disk image of this disk.
247 * @param phys Pointer to physical memory
248 * @param id The disk ID (master=0/slave=1)
249 * @param disk_delay The disk delay in milliseconds
251 IdeDisk(const std::string &name, DiskImage *img, PhysicalMemory *phys,
252 int id, Tick disk_delay);
255 * Delete the data buffer.
260 * Reset the device state
265 * Set the controller for this device
266 * @param c The IDE controller
268 void setController(IdeController *c, DMAInterface<Bus> *dmaIntr) {
269 if (ctrl) panic("Cannot change the controller once set!\n");
271 dmaInterface = dmaIntr;
274 // Device register read/write
275 void read(const Addr &offset, IdeRegType regtype, uint8_t *data);
276 void write(const Addr &offset, IdeRegType regtype, const uint8_t *data);
278 // Start/abort functions
279 void startDma(const uint32_t &prdTableBase);
285 // Interrupt management
290 void doDmaTransfer();
291 friend class EventWrapper<IdeDisk, &IdeDisk::doDmaTransfer>;
292 EventWrapper<IdeDisk, &IdeDisk::doDmaTransfer> dmaTransferEvent;
295 friend class EventWrapper<IdeDisk, &IdeDisk::doDmaRead>;
296 EventWrapper<IdeDisk, &IdeDisk::doDmaRead> dmaReadWaitEvent;
299 friend class EventWrapper<IdeDisk, &IdeDisk::doDmaWrite>;
300 EventWrapper<IdeDisk, &IdeDisk::doDmaWrite> dmaWriteWaitEvent;
302 void dmaPrdReadDone();
303 friend class EventWrapper<IdeDisk, &IdeDisk::dmaPrdReadDone>;
304 EventWrapper<IdeDisk, &IdeDisk::dmaPrdReadDone> dmaPrdReadEvent;
307 friend class EventWrapper<IdeDisk, &IdeDisk::dmaReadDone>;
308 EventWrapper<IdeDisk, &IdeDisk::dmaReadDone> dmaReadEvent;
311 friend class EventWrapper<IdeDisk, &IdeDisk::dmaWriteDone>;
312 EventWrapper<IdeDisk, &IdeDisk::dmaWriteDone> dmaWriteEvent;
314 // Disk image read/write
315 void readDisk(uint32_t sector, uint8_t *data);
316 void writeDisk(uint32_t sector, uint8_t *data);
318 // State machine management
319 void updateState(DevAction_t action);
322 bool isBSYSet() { return (status & STATUS_BSY_BIT); }
323 bool isIENSet() { return nIENBit; }
328 // clear out the status byte
331 status |= STATUS_DRDY_BIT;
333 status |= STATUS_SEEK_BIT;
336 uint32_t getLBABase()
338 return (Addr)(((cmdReg.head & 0xf) << 24) | (cmdReg.cyl_high << 16) |
339 (cmdReg.cyl_low << 8) | (cmdReg.sec_num));
342 inline Addr pciToDma(Addr pciAddr);
344 uint32_t bytesInDmaPage(Addr curAddr, uint32_t bytesLeft);
347 * Serialize this object to the given output stream.
348 * @param os The stream to serialize to.
350 void serialize(std::ostream &os);
353 * Reconstruct the state of this object from a checkpoint.
354 * @param cp The checkpoint to use.
355 * @param section The section name describing this object.
357 void unserialize(Checkpoint *cp, const std::string §ion);
361 #endif // __IDE_DISK_HH__