mirror of
https://github.com/verilator/verilator.git
synced 2025-01-01 04:07:34 +00:00
415 lines
15 KiB
C++
415 lines
15 KiB
C++
// -*- mode: C++; c-file-style: "cc-mode" -*-
|
||
//*************************************************************************
|
||
//
|
||
// Copyright 2009-2017 by Wilson Snyder. This program is free software; you can
|
||
// redistribute it and/or modify it under the terms of either the GNU
|
||
// Lesser General Public License Version 3 or the Perl Artistic License.
|
||
// Version 2.0.
|
||
//
|
||
// Verilator is distributed in the hope that it will be useful,
|
||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
// GNU General Public License for more details.
|
||
//
|
||
//=========================================================================
|
||
///
|
||
/// \file
|
||
/// \brief Verilator: DPI implementation code
|
||
///
|
||
/// This file must be compiled and linked against all objects
|
||
/// created from Verilator or called by Verilator that use the DPI.
|
||
///
|
||
/// Code available from: http://www.veripool.org/verilator
|
||
///
|
||
//=========================================================================
|
||
|
||
#define _VERILATED_DPI_CPP_
|
||
#include "verilatedos.h"
|
||
#include "verilated_dpi.h"
|
||
#include "verilated_imp.h"
|
||
|
||
// On MSVC++ we need svdpi.h to declare exports, not imports
|
||
#define DPI_PROTOTYPES
|
||
#undef XXTERN
|
||
#define XXTERN DPI_EXTERN DPI_DLLESPEC
|
||
#undef EETERN
|
||
#define EETERN DPI_EXTERN DPI_DLLESPEC
|
||
|
||
#include "vltstd/svdpi.h"
|
||
|
||
//======================================================================
|
||
// Internal macros
|
||
|
||
// Not supported yet
|
||
#define _VL_SVDPI_UNIMP() \
|
||
VL_FATAL_MT(__FILE__,__LINE__,"",(std::string("%%Error: Unsupported DPI function: ")+VL_FUNC).c_str())
|
||
|
||
// Function requires a "context" in the import declaration
|
||
#define _VL_SVDPI_CONTEXT_WARN() \
|
||
VL_PRINTF_MT("%%Warning: DPI C Function called by Verilog DPI import with missing 'context' keyword.\n");
|
||
|
||
// Function requires svOpenArrayHandle dimensionality
|
||
#define _VL_SVDPI_DIMENSION_CHECK(d, dimensions) \
|
||
do { if (VL_UNLIKELY(svDimensions(d) != (dimensions))) { \
|
||
VL_PRINTF_MT("%%Warning: %s called on array that is not %d dimensional.\n", __FUNCTION__, dimensions); \
|
||
} } while(0)
|
||
|
||
//======================================================================
|
||
//======================================================================
|
||
//======================================================================
|
||
// DPI ROUTINES
|
||
|
||
const char* svDpiVersion() {
|
||
return "1800-2005";
|
||
}
|
||
|
||
//======================================================================
|
||
// Bit-select utility functions.
|
||
|
||
svBit svGetBitselBit(const svBitVecVal* sp, int bit) {
|
||
return VL_BITRSHIFT_W(sp,bit) & 1;
|
||
}
|
||
svLogic svGetBitselLogic(const svLogicVecVal* sp, int bit) {
|
||
// Not VL_BITRSHIFT_W as sp is a different structure type
|
||
// Verilator doesn't support X/Z so only aval
|
||
return (((sp[VL_BITWORD_I(bit)].aval >> VL_BITBIT_I(bit)) & 1)
|
||
| (((sp[VL_BITWORD_I(bit)].bval >> VL_BITBIT_I(bit)) & 1)<<1));
|
||
}
|
||
|
||
void svPutBitselBit(svBitVecVal* dp, int bit, svBit s) {
|
||
VL_ASSIGNBIT_WI(32, bit, dp, s);
|
||
}
|
||
void svPutBitselLogic(svLogicVecVal* dp, int bit, svLogic s) {
|
||
// Verilator doesn't support X/Z so only aval
|
||
dp[VL_BITWORD_I(bit)].aval
|
||
= ((dp[VL_BITWORD_I(bit)].aval & ~(VL_UL(1)<<VL_BITBIT_I(bit)))
|
||
| ((s&1)<<VL_BITBIT_I(bit)));
|
||
dp[VL_BITWORD_I(bit)].bval
|
||
= ((dp[VL_BITWORD_I(bit)].bval & ~(VL_UL(1)<<VL_BITBIT_I(bit)))
|
||
| ((s&2)>>1<<VL_BITBIT_I(bit)));
|
||
}
|
||
|
||
void svGetPartselBit(svBitVecVal* dp, const svBitVecVal* sp, int lsb, int width) {
|
||
// See also VL_SEL_WWI
|
||
int msb = lsb+width-1;
|
||
int word_shift = VL_BITWORD_I(lsb);
|
||
if (VL_BITBIT_I(lsb)==0) {
|
||
// Just a word extract
|
||
for (int i=0; i<VL_WORDS_I(width); ++i) dp[i] = sp[i+word_shift];
|
||
} else {
|
||
int loffset = lsb & VL_SIZEBITS_I;
|
||
int nbitsfromlow = 32-loffset; // bits that end up in lword (know loffset!=0)
|
||
// Middle words
|
||
int words = VL_WORDS_I(msb-lsb+1);
|
||
for (int i=0; i<words; ++i) {
|
||
dp[i] = sp[i+word_shift]>>loffset;
|
||
int upperword = i+word_shift+1;
|
||
if (upperword <= static_cast<int>(VL_BITWORD_I(msb))) {
|
||
dp[i] |= sp[upperword] << nbitsfromlow;
|
||
}
|
||
}
|
||
}
|
||
// Clean result
|
||
dp[VL_WORDS_I(width)-1] &= VL_MASK_I(width);
|
||
}
|
||
void svGetPartselLogic(svLogicVecVal* dp, const svLogicVecVal* sp, int lsb, int width) {
|
||
int msb = lsb+width-1;
|
||
int word_shift = VL_BITWORD_I(lsb);
|
||
if (VL_BITBIT_I(lsb)==0) {
|
||
// Just a word extract
|
||
for (int i=0; i<VL_WORDS_I(width); ++i) dp[i] = sp[i+word_shift];
|
||
} else {
|
||
int loffset = lsb & VL_SIZEBITS_I;
|
||
int nbitsfromlow = 32-loffset; // bits that end up in lword (know loffset!=0)
|
||
// Middle words
|
||
int words = VL_WORDS_I(msb-lsb+1);
|
||
for (int i=0; i<words; ++i) {
|
||
dp[i].aval = sp[i+word_shift].aval >> loffset;
|
||
dp[i].bval = sp[i+word_shift].bval >> loffset;
|
||
int upperword = i+word_shift+1;
|
||
if (upperword <= static_cast<int>(VL_BITWORD_I(msb))) {
|
||
dp[i].aval |= sp[upperword].aval << nbitsfromlow;
|
||
dp[i].bval |= sp[upperword].bval << nbitsfromlow;
|
||
}
|
||
}
|
||
}
|
||
// Clean result
|
||
dp[VL_WORDS_I(width)-1].aval &= VL_MASK_I(width);
|
||
dp[VL_WORDS_I(width)-1].bval &= VL_MASK_I(width);
|
||
}
|
||
void svPutPartselBit(svBitVecVal* dp, const svBitVecVal s, int lbit, int width) {
|
||
// See also _VL_INSERT_WI
|
||
int hbit = lbit+width-1;
|
||
int hoffset = VL_BITBIT_I(hbit);
|
||
int loffset = VL_BITBIT_I(lbit);
|
||
if (hoffset==VL_SIZEBITS_I && loffset==0) {
|
||
// Fast and common case, word based insertion
|
||
dp[VL_BITWORD_I(lbit)] = s;
|
||
}
|
||
else {
|
||
int hword = VL_BITWORD_I(hbit);
|
||
int lword = VL_BITWORD_I(lbit);
|
||
if (hword==lword) { // know < 32 bits because above checks it
|
||
IData insmask = (VL_MASK_I(hoffset-loffset+1))<<loffset;
|
||
dp[lword] = (dp[lword] & ~insmask) | ((s<<loffset) & insmask);
|
||
} else {
|
||
IData hinsmask = (VL_MASK_I(hoffset-0+1))<<0;
|
||
IData linsmask = (VL_MASK_I(31-loffset+1))<<loffset;
|
||
int nbitsonright = 32-loffset; // bits that end up in lword
|
||
dp[lword] = (dp[lword] & ~linsmask) | ((s<<loffset) & linsmask);
|
||
dp[hword] = (dp[hword] & ~hinsmask) | ((s>>nbitsonright) & hinsmask);
|
||
}
|
||
}
|
||
}
|
||
void svPutPartselLogic(svLogicVecVal* dp, const svLogicVecVal s, int lbit, int width) {
|
||
int hbit = lbit+width-1;
|
||
int hoffset = VL_BITBIT_I(hbit);
|
||
int loffset = VL_BITBIT_I(lbit);
|
||
if (hoffset==VL_SIZEBITS_I && loffset==0) {
|
||
// Fast and common case, word based insertion
|
||
dp[VL_BITWORD_I(lbit)].aval = s.aval;
|
||
dp[VL_BITWORD_I(lbit)].bval = s.bval;
|
||
}
|
||
else {
|
||
int hword = VL_BITWORD_I(hbit);
|
||
int lword = VL_BITWORD_I(lbit);
|
||
if (hword==lword) { // know < 32 bits because above checks it
|
||
IData insmask = (VL_MASK_I(hoffset-loffset+1))<<loffset;
|
||
dp[lword].aval = (dp[lword].aval & ~insmask) | ((s.aval<<loffset) & insmask);
|
||
dp[lword].bval = (dp[lword].bval & ~insmask) | ((s.bval<<loffset) & insmask);
|
||
} else {
|
||
IData hinsmask = (VL_MASK_I(hoffset-0+1))<<0;
|
||
IData linsmask = (VL_MASK_I(31-loffset+1))<<loffset;
|
||
int nbitsonright = 32-loffset; // bits that end up in lword
|
||
dp[lword].aval = (dp[lword].aval & ~linsmask) | ((s.aval<<loffset) & linsmask);
|
||
dp[lword].bval = (dp[lword].bval & ~linsmask) | ((s.bval<<loffset) & linsmask);
|
||
dp[hword].aval = (dp[hword].aval & ~hinsmask) | ((s.aval>>nbitsonright) & hinsmask);
|
||
dp[hword].bval = (dp[hword].bval & ~hinsmask) | ((s.bval>>nbitsonright) & hinsmask);
|
||
}
|
||
}
|
||
}
|
||
|
||
//======================================================================
|
||
// Open array querying functions
|
||
|
||
int svLeft(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svRight(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svLow(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svHigh(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svIncrement(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svSize(const svOpenArrayHandle h, int d) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
int svDimensions(const svOpenArrayHandle h) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
void* svGetArrayPtr(const svOpenArrayHandle h) {
|
||
_VL_SVDPI_UNIMP(); return NULL;
|
||
}
|
||
int svSizeOfArray(const svOpenArrayHandle h) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
|
||
void* svGetArrElemPtr(const svOpenArrayHandle h, int indx1, ...) {
|
||
_VL_SVDPI_UNIMP(); return NULL;
|
||
}
|
||
void* svGetArrElemPtr1(const svOpenArrayHandle h, int indx1) {
|
||
_VL_SVDPI_UNIMP(); return NULL;
|
||
}
|
||
void* svGetArrElemPtr2(const svOpenArrayHandle h, int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP(); return NULL;
|
||
}
|
||
void* svGetArrElemPtr3(const svOpenArrayHandle h, int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP(); return NULL;
|
||
}
|
||
|
||
//======================================================================
|
||
// s=source, d=destination
|
||
// From user space into simulator storage
|
||
|
||
void svPutBitArrElemVecVal(const svOpenArrayHandle d, const svBitVecVal* s,
|
||
int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem1VecVal(const svOpenArrayHandle d, const svBitVecVal* s,
|
||
int indx1) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem2VecVal(const svOpenArrayHandle d, const svBitVecVal* s,
|
||
int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem3VecVal(const svOpenArrayHandle d, const svBitVecVal* s,
|
||
int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElemVecVal(const svOpenArrayHandle d, const svLogicVecVal* s,
|
||
int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElem1VecVal(const svOpenArrayHandle d, const svLogicVecVal* s,
|
||
int indx1) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElem2VecVal(const svOpenArrayHandle d, const svLogicVecVal* s,
|
||
int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElem3VecVal(const svOpenArrayHandle d, const svLogicVecVal* s,
|
||
int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
|
||
//======================================================================
|
||
// From simulator storage into user space
|
||
|
||
void svGetBitArrElemVecVal(svBitVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetBitArrElem1VecVal(svBitVecVal* d, const svOpenArrayHandle s,
|
||
int indx1) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetBitArrElem2VecVal(svBitVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetBitArrElem3VecVal(svBitVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetLogicArrElemVecVal(svLogicVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetLogicArrElem1VecVal(svLogicVecVal* d, const svOpenArrayHandle s,
|
||
int indx1) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetLogicArrElem2VecVal(svLogicVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svGetLogicArrElem3VecVal(svLogicVecVal* d, const svOpenArrayHandle s,
|
||
int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
|
||
svBit svGetBitArrElem(const svOpenArrayHandle s, int indx1, ...) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
svBit svGetBitArrElem1(const svOpenArrayHandle s, int indx1) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
svBit svGetBitArrElem2(const svOpenArrayHandle s, int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
svBit svGetBitArrElem3(const svOpenArrayHandle s, int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP(); return 0;
|
||
}
|
||
svLogic svGetLogicArrElem(const svOpenArrayHandle s, int indx1, ...) {
|
||
_VL_SVDPI_UNIMP(); return sv_x;
|
||
}
|
||
svLogic svGetLogicArrElem1(const svOpenArrayHandle s, int indx1) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
return svGetBitArrElem1(s, indx1);
|
||
}
|
||
svLogic svGetLogicArrElem2(const svOpenArrayHandle s, int indx1, int indx2) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
return svGetBitArrElem2(s, indx1, indx2);
|
||
}
|
||
svLogic svGetLogicArrElem3(const svOpenArrayHandle s, int indx1, int indx2, int indx3) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
return svGetBitArrElem3(s, indx1, indx2, indx3);
|
||
}
|
||
|
||
void svPutBitArrElem(const svOpenArrayHandle d, svBit value, int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem1(const svOpenArrayHandle d, svBit value, int indx1) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem2(const svOpenArrayHandle d, svBit value, int indx1, int indx2) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutBitArrElem3(const svOpenArrayHandle d, svBit value, int indx1, int indx2, int indx3) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElem(const svOpenArrayHandle d, svLogic value, int indx1, ...) {
|
||
_VL_SVDPI_UNIMP();
|
||
}
|
||
void svPutLogicArrElem1(const svOpenArrayHandle d, svLogic value, int indx1) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
svPutBitArrElem1(d, value, indx1);
|
||
}
|
||
void svPutLogicArrElem2(const svOpenArrayHandle d, svLogic value, int indx1, int indx2) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
svPutBitArrElem2(d, value, indx1, indx2);
|
||
}
|
||
void svPutLogicArrElem3(const svOpenArrayHandle d, svLogic value, int indx1, int indx2, int indx3) {
|
||
// Verilator doesn't support X/Z so can just call Bit version
|
||
svPutBitArrElem3(d, value, indx1, indx2, indx3);
|
||
}
|
||
|
||
//======================================================================
|
||
// Functions for working with DPI context
|
||
|
||
svScope svGetScope() {
|
||
if (VL_UNLIKELY(!Verilated::dpiInContext())) { _VL_SVDPI_CONTEXT_WARN(); return NULL; }
|
||
return (svScope)Verilated::dpiScope();
|
||
}
|
||
|
||
svScope svSetScope(const svScope scope) {
|
||
const VerilatedScope* prevScopep = Verilated::dpiScope();
|
||
const VerilatedScope* vscopep = reinterpret_cast<const VerilatedScope*>(scope);
|
||
Verilated::dpiScope(vscopep);
|
||
return (svScope)prevScopep;
|
||
}
|
||
|
||
const char* svGetNameFromScope(const svScope scope) {
|
||
const VerilatedScope* vscopep = reinterpret_cast<const VerilatedScope*>(scope);
|
||
return vscopep->name();
|
||
}
|
||
|
||
svScope svGetScopeFromName(const char* scopeName) {
|
||
return (svScope)VerilatedImp::scopeFind(scopeName);
|
||
}
|
||
|
||
int svPutUserData(const svScope scope, void* userKey, void* userData) {
|
||
VerilatedImp::userInsert(scope,userKey,userData);
|
||
return 0;
|
||
}
|
||
|
||
void* svGetUserData(const svScope scope, void* userKey) {
|
||
return VerilatedImp::userFind(scope,userKey);
|
||
}
|
||
|
||
int svGetCallerInfo(const char** fileNamepp, int *lineNumberp) {
|
||
if (VL_UNLIKELY(!Verilated::dpiInContext())) { _VL_SVDPI_CONTEXT_WARN(); return false; }
|
||
if (VL_LIKELY(fileNamepp)) *fileNamepp = Verilated::dpiFilenamep(); // thread local
|
||
if (VL_LIKELY(lineNumberp)) *lineNumberp = Verilated::dpiLineno(); // thread local
|
||
return true;
|
||
}
|
||
|
||
//======================================================================
|
||
// Disables
|
||
|
||
int svIsDisabledState() {
|
||
return 0; // Disables not implemented
|
||
}
|
||
|
||
void svAckDisabledState() {
|
||
// Disables not implemented
|
||
}
|