SOPCInterface.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2010 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file SOPCInterface.hh
 *
 * Declaration of SOPCInterface class.
 *
 * @author Otto Esko 2010 (otto.esko-no.spam-tut.fi)
 * @note rating: red
 */
#ifndef TTA_SOPC_INTERFACE_HH
#define TTA_SOPC_INTERFACE_HH
 
#include <iostream>
#include <map>
#include <vector>
#include "ProGeTypes.hh"
#include "TCEString.hh"
 
class SOPCInterface {
public:
 
    SOPCInterface(TCEString name, TCEString declaration);
 
    virtual ~SOPCInterface();
 
    void setProperty(
        const TCEString& propertyName,
        const TCEString& propertyValue);
    void setProperty(
        const TCEString& propertyName,
        int propertyValue);
 
    void setPort(
        const TCEString& hdlName,
        const TCEString& interfaceName,
        ProGe::Direction direction,
        int width);
    
    TCEString name() const;
 
    bool hasPorts() const;
 
    virtual void writeInterface(std::ostream& stream) const;
    
    static const TCEString SOPC_ADD_INTERFACE;
    static const TCEString SOPC_SET_INT_PROPERTY;
    static const TCEString SOPC_ADD_INT_PORT;
    static const TCEString SOPC_ASSOCIATED_CLOCK;
 
    static const TCEString SOPC_MASTER_INT_NAME;
    static const TCEString SOPC_MASTER_INT_DECLR;
 
    static const TCEString SOPC_CLOCK_INT_NAME;
    static const TCEString SOPC_CLOCK_INT_DECLR;
 
    static const TCEString SOPC_EXPORT_INT_NAME;
    static const TCEString SOPC_EXPORT_INT_DECLR;
    static const TCEString SOPC_EXPORT_NAME;
 
    static const TCEString SOPC_IRQ_RECV_INT_NAME;
    static const TCEString SOPC_IRQ_RECV_INT_DECLR;
 
    static const TCEString SOPC_INPUT;
    static const TCEString SOPC_OUTPUT;
    static const TCEString SOPC_BIDIR;
    
protected:
 
    struct SOPCPort {
        TCEString hdlName;
        TCEString interfaceName;
        ProGe::Direction direction;
        int width;
    };
 
    typedef std::map<TCEString, TCEString> PropertyMap;
    typedef std::vector<SOPCPort> PortList;
 
    const PropertyMap* properties() const;
 
    const PortList* ports() const;
 
    void writeProperties(std::ostream& stream) const;
    void writePorts(std::ostream& stream) const;
 
private:
 
    SOPCInterface();
    SOPCInterface(const SOPCInterface& old);
    SOPCInterface& operator=(SOPCInterface old);
 
    TCEString name_;
    TCEString declaration_;
    PropertyMap properties_;
    PortList ports_; 
};
 
#endif