/*
 * Copyright (c) 2003 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* @file
 * Tsunnami Fake DMA memory map
 */

#ifndef __TSUNAMI_DMA_HH__
#define __TSUNAMI_DMA_HH__

#include "mem/functional_mem/mmap_device.hh"
#include "dev/tsunami.hh"

/*
 * Tsunami I/O device
 */
class TsunamiIO : public MmapDevice
{

  public:

  protected:

    class ClockEvent : public Event
    {
        protected:
            Tick interval;
            uint8_t mode;
            uint8_t status;

        public:
            ClockEvent();

            virtual void process();
            virtual const char *description();
            void Program(int count);
            void ChangeMode(uint8_t mode);
            uint8_t Status();

    };

    class RTCEvent : public Event
    {
      protected:
        Tick interval;
        uint8_t rtc_uip;

      public:
        RTCEvent();

        virtual void process();
        virtual const char *description();
        uint8_t rtc_uip_value();
    };

      uint8_t mask1;
      uint8_t mask2;
      uint8_t mode1;
      uint8_t mode2;

      ClockEvent timer0;
      ClockEvent timer1;
      ClockEvent timer2;

      uint32_t timerData;

  public:
    TsunamiIO(const std::string &name, /*Tsunami *t,*/
               Addr addr, Addr mask, MemoryController *mmu);

    virtual Fault read(MemReqPtr req, uint8_t *data);
    virtual Fault write(MemReqPtr req, const uint8_t *data);

    virtual void serialize(std::ostream &os);
    virtual void unserialize(Checkpoint *cp, const std::string &section);
};

#endif // __TSUNAMI_IO_HH__