ICDecoderGeneratorPlugin.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 ICDecoderGeneratorPlugin.hh
 *
 * Declaration of ICDecoderGeneratorPlugin class.
 *
 * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
 * @author Vinogradov Viacheslav(added Verilog generating) 2012 
 * @note rating: red
 */
 
#ifndef TTA_ICDECODER_GENERATOR_PLUGIN_HH
#define TTA_ICDECODER_GENERATOR_PLUGIN_HH
 
#include <map>
#include <string>
#include <iostream>
#include <set>
 
#include "Socket.hh"
#include "HDBTypes.hh"
#include "ProGeTypes.hh"
#include "MachineImplementation.hh"
 
namespace TTAMachine {
    class Machine;
    class ImmediateUnit;
}
 
namespace IDF {
    class MachineImplementation;
}
 
class BinaryEncoding;
 
namespace ProGe {
 
class NetlistBlock;
class NetlistGenerator;
 
/**
 * Base class for plugins that are able to generate and IC and decoder.
 *
 * @todo Add rest of the methods.
 */
class ICDecoderGeneratorPlugin {
public:
    ICDecoderGeneratorPlugin(
        const TTAMachine::Machine& machine,
        const BinaryEncoding& bem,
        const std::string& description);
    virtual ~ICDecoderGeneratorPlugin();
 
    /**
     * Completes the given netlist block by adding IC block and completing the
     * decoder block by adding the ports connected to IC. Connects also IC
     * to all the units in the machine.
     *
     * @param coreBlock The netlist block to complete.
     * @param generator The netlist generator which generated the netlist.
     */
    virtual void completeNetlist(
        NetlistBlock& netlistBlock,
        const NetlistGenerator& generator) = 0;
 
    /**
     * Generates the interconnection network and instruction decoder to the
     * given destination directory.
     *
     * @param destinationDirectory The destination directory.
     * @param generator The netlist generator that generated the netlist block.
     */
    virtual void generate(
        HDL language,
        const std::string& destinationDirectory,
        const NetlistGenerator& generator,
        const IDF::MachineImplementation& implementation,
        const std::string& entityString) = 0;
 
    /**
     * Returns the set of acceptable latencies of the hardware implementation
     * of the given immediate unit.
     *
     * @param iu The immediate unit.
     */
    virtual std::set<int> requiredRFLatencies(
        const TTAMachine::ImmediateUnit& iu) const = 0;
 
    /**
     * Verifies that the plugin is compatible with the machine.
     *
     * @exception InvalidData If the plugin is not compatible with the 
     *                        machine.
     */
    virtual void verifyCompatibility() const = 0;
 
    /**
     * Returns global package definitions in the form of a stream specifically
     * for the variable length instruction architecture.
     *
     * @param language The HDL to use.
     * @param pkgStream The destination stream
     */
    virtual void writeGlobalDefinitions(
        HDL language, std::ostream& pkgStream)
        const = 0;
 
    std::string pluginDescription() const;
    int recognizedParameterCount() const;
    std::string recognizedParameter(int index) const;
    std::string parameterDescription(const std::string& paramName) const;
    void setParameter(const std::string& name, const std::string& value);
 
    const TTAMachine::Machine& machine() const;
    const BinaryEncoding& bem() const;
    virtual void readParameters() = 0;
 
protected:
    static TTAMachine::Socket::Direction convertDirection(
        HDB::Direction direction);
    void addParameter(
        const std::string& name,
        const std::string& description);
    bool hasParameterSet(const std::string& name) const;
    std::string parameterValue(const std::string& name) const;
 
private:
    /// Map type for strings.
    typedef std::map<std::string, std::string> StringMap;
 
    /// The machine to generate.
    const TTAMachine::Machine& machine_;
    /// The binary encoding map.
    const BinaryEncoding& bem_;
    /// Parameters set.
    StringMap parameterValues_;
    /// Parameter descriptions.
    StringMap parameterDescriptions_;
    /// Description of the plugin.
    std::string description_;
};
 
/**
 * Exports the given class as an IC&decoder generator.
 *
 * @note The class name of the generator MUST be [PLUGIN_NAME__]Generator,
 *       thus a generator exported with EXPORT_ICDEC_GENERATOR(Example)
 *       exports a class called ExampleGenerator.
 */
#define EXPORT_ICDEC_GENERATOR(PLUGIN_NAME__) \
extern "C" { \
    ICDecoderGeneratorPlugin*\
    create_generator_plugin_##PLUGIN_NAME__(\
        const TTAMachine::Machine& machine,\
        const BinaryEncoding& bem) {\
        PLUGIN_NAME__##Generator* instance = \
            new PLUGIN_NAME__##Generator(machine, bem);     \
        return instance;\
    }\
    void delete_generator_plugin_##PLUGIN_NAME__(\
        ICDecoderGeneratorPlugin* target) {\
        delete target;\
    }\
}
}
 
#endif