PortCode.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 PortCode.hh
 *
 * Declaration of PortCode class.
 *
 * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_PORT_CODE_HH
#define TTA_PORT_CODE_HH
 
#include <string>
#include "Exception.hh"
 
class SocketCodeTable;
class ObjectState;
 
/**
 * Base class for FUPortCode, RFPortCode and IUPortCode.
 */
class PortCode {
public:
    virtual ~PortCode();
 
    std::string unitName() const;
 
    bool hasEncoding() const;
    unsigned int encoding() const;
    unsigned int extraBits() const;
    int width() const;
    int encodingWidth() const;
    int indexWidth() const;
 
    void setMaxIndex(unsigned regIndex) { maxRegIndex_ = regIndex; }
    bool isMaxIndexSet() const { return maxRegIndex_ != 0; }
    unsigned maxIndex() const { return maxRegIndex_; }
 
    SocketCodeTable* parent() const;
 
    virtual ObjectState* saveState() const;
 
    /// ObjectState name for PortCode.
    static const std::string OSNAME_PORT_CODE;
    /// ObjectState attribute key for the name of the unit.
    static const std::string OSKEY_UNIT_NAME;
    /// ObjectState attribute key for the encoding.
    static const std::string OSKEY_ENCODING;
    /// ObjectState attribute key for the number of extra bits.
    static const std::string OSKEY_EXTRA_BITS;
    /// ObjectState attribute key for the widht of register index.
    static const std::string OSKEY_INDEX_WIDTH;
    /// ObjectState attribute key for the max-index attribute.
    static const std::string OSKEY_MAX_INDEX;
 
protected:
    PortCode(
        const std::string& unitName, unsigned int encoding,
        unsigned int extraBits, int indexWidth);
    PortCode(const std::string& unitName, int indexWidth);
    PortCode(const ObjectState* state);
    void setParent(SocketCodeTable* parent);
 
private:
    /// Name of the unit.
    std::string unitName_;
    /// The encoding.
    unsigned int encoding_;
    /// The number of extra bits in the encoding.
    unsigned int extraBits_;
    /// The width of the register index in the port code.
    int indexWidth_;
    /// Tells whether the port code has an encoding.
    bool hasEncoding_;
    /// The parent socket code table.
    SocketCodeTable* parent_;
    /// In case this is set to non-zero, the whole width of the index
    /// field is not used because the number of register indices is not
    /// an exponent of two. This allow sharing the field with other
    /// values.
    unsigned maxRegIndex_;
};
 
#endif