ESITypes.h

Go to the documentation of this file.

//===- ESITypes.h - types for the ESI dialect -------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Types for ESI are mostly in tablegen. This file should contain C++ types used
// in MLIR type parameters and other supporting declarations.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_ESI_ESITYPES_H
#define CIRCT_DIALECT_ESI_ESITYPES_H
 
#include "circt/Dialect/HW/HWTypes.h"
#include "circt/Support/LLVM.h"
#include "mlir/IR/AttrTypeSubElements.h"
#include "mlir/IR/Dialect.h"
#include "mlir/IR/Operation.h"
 
#include "ESIDialect.h"
 
namespace circt {
namespace esi {
struct BundledChannel;
} // namespace esi
} // namespace circt
 
#define GET_TYPEDEF_CLASSES
#include "circt/Dialect/ESI/ESITypes.h.inc"
 
namespace circt {
namespace esi {
 
struct BundledChannel {
  StringAttr name;
  ChannelDirection direction;
  ChannelType type;
 
  int operator==(const BundledChannel &that) const {
    return name == that.name && direction == that.direction &&
           type == that.type;
  }
};
 
// NOLINTNEXTLINE(readability-identifier-naming)
inline llvm::hash_code hash_value(const BundledChannel channel) {
  return llvm::hash_combine(channel.name, channel.direction, channel.type);
}
 
// If 'type' is an esi:ChannelType, will return the inner type of said channel.
// Else, returns 'type'.
mlir::Type innerType(mlir::Type type);
} // namespace esi
} // namespace circt
 
namespace mlir {
template <>
struct AttrTypeSubElementHandler<circt::esi::BundledChannel> {
  static void walk(const circt::esi::BundledChannel &channel,
                   AttrTypeImmediateSubElementWalker &walker) {
    walker.walk(channel.name);
    walker.walk(channel.type);
  }
 
  static circt::esi::BundledChannel
  replace(const circt::esi::BundledChannel &channel,
          AttrSubElementReplacements &attrRepls,
          TypeSubElementReplacements &typeRepls) {
    return {cast<StringAttr>(attrRepls.take_front(1)[0]), channel.direction,
            cast<circt::esi::ChannelType>(typeRepls.take_front(1)[0])};
  }
};
} // namespace mlir
 
#endif