dev/tsunami_io.hh

   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  * Tsunami Fake I/O Space mapping including RTC/timer interrupts
  31  */
  32
  33 #ifndef __TSUNAMI_DMA_HH__
  34 #define __TSUNAMI_DMA_HH__
  35
  36 #define RTC_RATE 1024
  37
  38 #include "mem/functional_mem/functional_memory.hh"
  39 #include "dev/tsunami.hh"
  40
  41 /*
  42  * Tsunami I/O device
  43  */
  44 class TsunamiIO : public FunctionalMemory
  45 {
  46   private:
  47     Addr addr;
  48     static const Addr size = 0xff;
  49
  50     struct tm tm;
  51
  52     // In Tsunami RTC only has two i/o ports
  53     // one  for data and one for address, so you
  54     // write the address and then read/write the data
  55     uint8_t RTCAddress;
  56
  57   protected:
  58
  59     class ClockEvent : public Event
  60     {
  61       protected:
  62         Tick interval;
  63         uint8_t mode;
  64         uint8_t status;
  65
  66       public:
  67         ClockEvent();
  68
  69         virtual void process();
  70         virtual const char *description();
  71         void Program(int count);
  72         void ChangeMode(uint8_t mode);
  73         uint8_t Status();
  74
  75     };
  76
  77     class RTCEvent : public Event
  78     {
  79       protected:
  80         Tsunami* tsunami;
  81       public:
  82         RTCEvent(Tsunami* t);
  83
  84         virtual void process();
  85         virtual const char *description();
  86     };
  87
  88     uint8_t uip;
  89
  90     uint8_t mask1;
  91     uint8_t mask2;
  92     uint8_t mode1;
  93     uint8_t mode2;
  94
  95     uint8_t picr; //Raw PIC interrput register, before masking
  96     bool picInterrupting;
  97
  98     Tsunami *tsunami;
  99
 100     /*
 101      * This timer is initilized, but after I wrote the code
 102      * it doesn't seem to be used again, and best I can tell
 103      * it too is not connected to any interrupt port
 104      */
 105     ClockEvent timer0;
 106
 107     /*
 108      * This timer is used to control the speaker, which
 109      * we normally could care less about, however it is
 110      * also used to calculated the clockspeed and hense
 111      * bogomips which is kinda important to the scheduler
 112      * so we need to implemnt it although after boot I can't
 113      * imagine we would be playing with the PC speaker much
 114      */
 115     ClockEvent timer2;
 116
 117     RTCEvent rtc;
 118
 119     uint32_t timerData;
 120
 121
 122   public:
 123     uint32_t  frequency() const { return RTC_RATE; }
 124
 125     TsunamiIO(const std::string &name, Tsunami *t, time_t init_time,
 126               Addr a, MemoryController *mmu);
 127
 128     void set_time(time_t t);
 129
 130     virtual Fault read(MemReqPtr &req, uint8_t *data);
 131     virtual Fault write(MemReqPtr &req, const uint8_t *data);
 132
 133     void postPIC(uint8_t bitvector);
 134     void clearPIC(uint8_t bitvector);
 135
 136     virtual void serialize(std::ostream &os);
 137     virtual void unserialize(Checkpoint *cp, const std::string &section);
 138 };
 139
 140 #endif // __TSUNAMI_IO_HH__