dma.h

Go to the documentation of this file.

//    sampalib.org ESL library and tools
//    Copyright (C) 2007  Thierry Grellier
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License version 2 as
//    published by the Free Software Foundation.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License along
//    with this program; if not, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//    contact: www.sampalib.org

#ifndef __SAMPA_DMA_H__ 
#define __SAMPA_DMA_H__

#include "sampa/component/protocol.h"
#include "sampa/core/gated.h"
#include "sampa/core/fifo.h"

namespace Sampa {

  class Dma : public Module {
    SAMPA_MODULE(Dma);
  public:
    Dma(const Name& name);

    void bind_clock(Clock* clock);

    void bind_read_target(Target*);
    void bind_write_target(Target*);
    
    Initiator* get_read_initiator() { return &p_read; }
    Initiator* get_write_initiator() { return &p_write; }

  protected:
    void complete_restart();  

    bool recieve_read_response(const Response&);
    bool recieve_write_response(const Response&);
    
    void request();
    void forward();
    
    typedef AdaptingInitiator<Dma> AdaptingInitiator;
    int                m_transfer;
    IntParameter       m_word_size;
    IntParameter       m_transfer_size;
    IntParameter       m_burst_size;
    Time               m_period;
    Time               m_request_date;
    Burst              m_read_burst;
    Burst              m_write_burst;
    HexParameter       m_read_address_base;  // address generator?
    HexParameter       m_write_address_base; // address generator?
    Address            m_read_address;
    Address            m_write_address;
    EventSingle        e_request;
    AdaptingInitiator  p_read;
    AdaptingInitiator  p_write;
    EventListener      e_push_or_write_request_accept_event;
    Request            m_read_request;
    Request            m_write_request;
    Fifo               m_response_fifo;
    Gated<bool>        m_pending;
  };

}

#endif

---