tsunami_io.hh revision 773 
1/*
2 * Copyright (c) 2003 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 */
28
29/* @file
30 * Tsunnami Fake DMA memory map
31 */
32
33#ifndef __TSUNAMI_DMA_HH__
34#define __TSUNAMI_DMA_HH__
35
36#include "mem/functional_mem/mmap_device.hh"
37#include "dev/tsunami.hh"
38
39/*
40 * Tsunami I/O device
41 */
42class TsunamiIO : public MmapDevice
43{
44
45  private:
46    struct tm tm;
47
48    // In Tsunami RTC only has two i/o ports
49    // one  for data and one for address, so you
50    // write the address and then read/write the data
51    uint8_t RTCAddress;
52
53  protected:
54
55    class ClockEvent : public Event
56    {
57        protected:
58            Tick interval;
59            uint8_t mode;
60            uint8_t status;
61
62        public:
63            ClockEvent();
64
65            virtual void process();
66            virtual const char *description();
67            void Program(int count);
68            void ChangeMode(uint8_t mode);
69            uint8_t Status();
70
71    };
72
73    class RTCEvent : public Event
74    {
75      public:
76        RTCEvent();
77
78        virtual void process();
79        virtual const char *description();
80    };
81
82      uint8_t uip;
83
84      uint8_t mask1;
85      uint8_t mask2;
86      uint8_t mode1;
87      uint8_t mode2;
88
89      /* This timer is initilized, but after I wrote the code
90         it doesn't seem to be used again, and best I can tell
91         it too is not connected to any interrupt port */
92      ClockEvent timer0;
93
94      /* This timer is used to control the speaker, which
95         we normally could care less about, however it is
96         also used to calculated the clockspeed and hense
97         bogomips which is kinda important to the scheduler
98         so we need to implemnt it although after boot I can't
99         imagine we would be playing with the PC speaker much */
100      ClockEvent timer2;
101
102      RTCEvent rtc;
103
104      uint32_t timerData;
105
106  public:
107    TsunamiIO(const std::string &name, /*Tsunami *t,*/ time_t init_time,
108               Addr addr, Addr mask, MemoryController *mmu);
109
110    void set_time(time_t t);
111
112    virtual Fault read(MemReqPtr req, uint8_t *data);
113    virtual Fault write(MemReqPtr req, const uint8_t *data);
114
115    virtual void serialize(std::ostream &os);
116    virtual void unserialize(Checkpoint *cp, const std::string &section);
117};
118
119#endif // __TSUNAMI_IO_HH__
120