PortCode.cc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2014 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.cc
 *
 * Implementation of PortCode class.
 *
 * @author Lasse Laasonen 2005 (lasse.laasonen-no.spam-tut.fi)
 * @author Pekka Jääskeläinen 2014
 * @note rating: red
 */
 
#include "PortCode.hh"
#include "ObjectState.hh"
#include "MathTools.hh"
 
const std::string PortCode::OSNAME_PORT_CODE = "port_code";
const std::string PortCode::OSKEY_UNIT_NAME = "unit_name";
const std::string PortCode::OSKEY_ENCODING = "encoding";
const std::string PortCode::OSKEY_EXTRA_BITS = "extra_bits";
const std::string PortCode::OSKEY_INDEX_WIDTH = "index_width";
const std::string PortCode::OSKEY_MAX_INDEX = "max-index";
 
/**
 * The constructor.
 *
 * Creates a port code with port ID.
 *
 * @param unitName Name of the unit.
 * @param encoding The encoding.
 * @param extraBits The number of extra bits in the encoding.
 * @param indexWidth The width of the register index.
 * @exception OutOfRange If the some of the given values is negative.
 */
PortCode::PortCode(
    const std::string& unitName, unsigned int encoding,
    unsigned int extraBits, int indexWidth)
    : unitName_(unitName),
      encoding_(encoding),
      extraBits_(extraBits),
      indexWidth_(indexWidth),
      hasEncoding_(true),
      parent_(NULL),
      maxRegIndex_(0) {
    if (indexWidth_ < 0) {
        throw OutOfRange(__FILE__, __LINE__, __func__);
    }
}
 
/**
 * The constructor.
 *
 * Creates a port code without port ID.
 *
 * @param unitName Name of the unit.
 * @param indexWidth The width of the register index.
 * @exception OutOfRange If the some of the given values is negative.
 */
PortCode::PortCode(const std::string& unitName, int indexWidth)
    : unitName_(unitName),
      encoding_(0),
      extraBits_(0),
      indexWidth_(indexWidth),
      hasEncoding_(false),
      parent_(NULL),
      maxRegIndex_(0) {
    if (indexWidth_ < 0) {
        throw OutOfRange(__FILE__, __LINE__, __func__);
    }
}
 
/**
 * The constructor.
 *
 * Loads the state of the object from the given ObjectState instance.
 *
 * @param state The ObjectState instance.
 * @exception ObjectStateLoadingException If the given ObjectState instance
 *                                        is erroneous.
 */
PortCode::PortCode(const ObjectState* state)
    : unitName_(""),
      encoding_(0),
      extraBits_(0),
      indexWidth_(0),
      hasEncoding_(false),
      parent_(NULL),
      maxRegIndex_(0) {
    try {
        unitName_ = state->stringAttribute(OSKEY_UNIT_NAME);
        if (state->hasAttribute(OSKEY_MAX_INDEX))
            maxRegIndex_ = state->intAttribute(OSKEY_MAX_INDEX);
        if (state->hasAttribute(OSKEY_ENCODING)) {
            encoding_ = state->intAttribute(OSKEY_ENCODING);
            extraBits_ = state->intAttribute(OSKEY_EXTRA_BITS);
            hasEncoding_ = true;
        }
        if (state->hasAttribute(OSKEY_INDEX_WIDTH)) {
            indexWidth_ = state->intAttribute(OSKEY_INDEX_WIDTH);
        }
    } catch (const Exception&) {
        throw ObjectStateLoadingException(__FILE__, __LINE__, __func__);
    }
}
 
/**
 * The destructor.
 */
PortCode::~PortCode() {
}
 
 
/**
 * Returns the name of the unit.
 *
 * @return The name of the unit.
 */
std::string
PortCode::unitName() const {
    return unitName_;
}
 
 
/**
 * Tells whether the port code has an encoding (port ID).
 *
 * @return True if the port code has an encoding, otherwise false.
 */
bool
PortCode::hasEncoding() const {
    return hasEncoding_;
}
 
 
/**
 * Returns the encoding.
 *
 * @return The encoding.
 * @exception NotAvailable If the port code does not have an encoding 
 *                         (port ID).
 */
unsigned int
PortCode::encoding() const {
    if (!hasEncoding()) {
        throw NotAvailable(__FILE__, __LINE__, __func__);
    }
    return encoding_;
}
 
/**
 * Returns the number of extra bits in the encoding.
 *
 * @return The number of extra bits.
 */
unsigned int
PortCode::extraBits() const {
    return extraBits_;
}
 
 
/**
 * Returns the width of the whole port code (portID + opcode).
 *
 * @return The width.
 */
int
PortCode::width() const {
    if (hasEncoding()) {
        return MathTools::bitLength(encoding()) + extraBits() + 
            indexWidth();
    } else {
        return indexWidth();
    }
}
 
 
/**
 * Returns the width of the encoding (port ID).
 *
 * @return The width of the encoding.
 */
int
PortCode::encodingWidth() const {
    return width() - indexWidth();
}
 
 
/**
 * Returns the width of the register index (opcode).
 *
 * @return The width of the register index.
 */
int
PortCode::indexWidth() const {
    return indexWidth_;
}
 
 
/**
 * Returns the parent socket code table.
 *
 * @return The parent socket code table.
 */
SocketCodeTable*
PortCode::parent() const {
    return parent_;
}
 
 
/**
 * Saves the state of the object to an ObjectState instance.
 *
 * @return The newly created ObjectState instance.
 */
ObjectState*
PortCode::saveState() const {
    ObjectState* state = new ObjectState(OSNAME_PORT_CODE);
    state->setAttribute(OSKEY_UNIT_NAME, unitName());
    if (hasEncoding()) {
        state->setAttribute(OSKEY_ENCODING, encoding());
        state->setAttribute(OSKEY_EXTRA_BITS, extraBits());
    }
    if (maxRegIndex_ != 0) state->setAttribute(OSKEY_MAX_INDEX, maxRegIndex_);
    state->setAttribute(OSKEY_INDEX_WIDTH, indexWidth());
    return state;
}
 
 
/**
 * Sets the parent socket code table pointer.
 *
 * @param parent The parent pointer.
 */
void
PortCode::setParent(SocketCodeTable* parent) {
    parent_ = parent;
}