FUImplementation.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 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 FUImplementation.hh
 *
 * Declaration of FUImplementation class.
 *
 * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_FU_IMPLEMENTATION_HH
#define TTA_FU_IMPLEMENTATION_HH
 
#include <string>
#include <vector>
#include <map>
 
#include "HWBlockImplementation.hh"
#include "Exception.hh"
#include "HDBTypes.hh"
 
namespace HDB {
 
class FUEntry;
class FUExternalPort;
class FUPortImplementation;
 
/**
 * Represents the implementation specific properties of an FU in HDB.
 */
class FUImplementation : public HWBlockImplementation {
public:
    /// Parameter of FU implementation.
    /*struct Parameter {
        std::string name; ///< Name of the parameter.
        std::string type; ///< Type of the parameter.
        std::string value; ///< Value of the parameter.
    };*/
    typedef HDB::Parameter Parameter;
 
    FUImplementation(
        const std::string& name,
        const std::string& opcodePort,
        const std::string& clkPort,
        const std::string& rstPort,
        const std::string& glockPort, 
        const std::string& glockReqPort);
    virtual ~FUImplementation();
 
    FUImplementation(const FUImplementation& o);
 
    void setOpcodePort(const std::string& name);
    std::string opcodePort() const;
    void setGlockReqPort(const std::string& name);
    std::string glockReqPort() const;
 
    void setOpcode(const std::string& operation, int opcode);
    void unsetOpcode(const std::string& operation);
    int opcodeCount() const;
    std::string opcodeOperation(int index) const;
    bool hasOpcode(const std::string& operation) const;
    int opcode(const std::string& operation) const;
    int maxOpcodeWidth() const;
 
    void addArchitecturePort(FUPortImplementation* port);
    void deleteArchitecturePort(FUPortImplementation* port);
    void addExternalPort(FUExternalPort* port);
    void deleteExternalPort(FUExternalPort* port);
 
    int architecturePortCount() const;
    int externalPortCount() const;
 
    FUPortImplementation& architecturePort(int index) const;
    FUPortImplementation& portImplementationByArchitectureName(
        const std::string& architectureName) const;
    FUExternalPort& externalPort(int index) const;
 
    void addParameter(
        const std::string& name, const std::string& type,
        const std::string& value);
    void removeParameter(const std::string& name);
    int parameterCount() const;
    Parameter parameter(int index) const;
    bool hasParameter(const std::string& name) const;
 
private:
    /// Vector type for FUPortImplementation.
    typedef std::vector<FUPortImplementation*> PortTable;
    /// Vector type for FUExternalPort.
    typedef std::vector<FUExternalPort*> ExternalPortTable;
    /// Map type for operation codes.
    typedef std::map<std::string, int> OpcodeMap;
    /// Vector type for parameter names.
    typedef std::vector<Parameter> ParameterTable;
 
    /// Name of the opcode port.
    std::string opcodePort_;
    /// Name of the global lock request port.
    std::string glockReqPort_;
 
    /// Contains the architectural ports.
    PortTable ports_;
    /// Contains the external ports.
    ExternalPortTable externalPorts_;
    /// Contains the operation codes.
    OpcodeMap opcodes_;
    /// Contains the parameters.
    ParameterTable parameters_;
};
}
 
#endif