package firrtl

Get desktop application:
View/edit binary Protocol Buffers messages

• repeated FirrtlPB.Circuit circuit = 1

Used in: Expression.FixedLiteral, Module.ExternalModule.Parameter, Statement.CMemory.TypeAndDepth, Statement.Memory

• bytes value = 1

  2's complement binary representation

Used in: FirrtlPB

• repeated Module module = 1

• repeated Top top = 2

Used in: Expression.Mux, Expression.PrimOp, Expression.SubAccess, Expression.SubField, Expression.SubIndex, Expression.ValidIf, Statement.Attach, Statement.Connect, Statement.IsInvalid, Statement.MemoryPort, Statement.Node, Statement.PartialConnect, Statement.Printf, Statement.Register, Statement.Stop, Statement.When

• oneof expression

  Required.

  • Expression.Reference reference = 1

  • Expression.UIntLiteral uint_literal = 2

  • Expression.SIntLiteral sint_literal = 3

  • Expression.FixedLiteral fixed_literal = 11

  • Expression.ValidIf valid_if = 4

  • Expression.Mux mux = 6

    ExtractBits extract_bits = 5;

  • Expression.SubField sub_field = 7

  • Expression.SubIndex sub_index = 8

  • Expression.SubAccess sub_access = 9

  • Expression.PrimOp prim_op = 10

Used in: Expression

• optional BigInt value = 1

• optional Width width = 2

• optional Width point = 3

Used in: PrimOp, SIntLiteral, SubIndex, UIntLiteral

• string value = 1

  Base 10 value. May begin with a sign (+|-). Only zero can begin with a '0'. Required

Used in: Expression

• optional Expression condition = 1

  Required.

• optional Expression t_value = 2

  Required.

• optional Expression f_value = 3

  Required.

Used in: Expression

• PrimOp.Op op = 1

  Required.

• repeated Expression arg = 2

• repeated IntegerLiteral const = 3

Used in: PrimOp

• OP_UNKNOWN = 0

• OP_ADD = 1

• OP_SUB = 2

• OP_TAIL = 3

• OP_HEAD = 4

• OP_TIMES = 5

• OP_DIVIDE = 6

• OP_REM = 7

• OP_SHIFT_LEFT = 8

• OP_SHIFT_RIGHT = 9

• OP_DYNAMIC_SHIFT_LEFT = 10

• OP_DYNAMIC_SHIFT_RIGHT = 11

• OP_BIT_AND = 12

• OP_BIT_OR = 13

• OP_BIT_XOR = 14

• OP_BIT_NOT = 15

• OP_CONCAT = 16

• OP_LESS = 17

• OP_LESS_EQ = 18

• OP_GREATER = 19

• OP_GREATER_EQ = 20

• OP_EQUAL = 21

• OP_PAD = 22

• OP_NOT_EQUAL = 23

• OP_NEG = 24

• OP_XOR_REDUCE = 26

• OP_CONVERT = 27

• OP_AS_UINT = 28

• OP_AS_SINT = 29

• OP_EXTRACT_BITS = 30

• OP_AS_CLOCK = 31

• OP_AS_FIXED_POINT = 32

• OP_AND_REDUCE = 33

• OP_OR_REDUCE = 34

• OP_INCREASE_PRECISION = 35

• OP_DECREASE_PRECISION = 36

• OP_SET_PRECISION = 37

• OP_AS_ASYNC_RESET = 38

• OP_WRAP = 39

• OP_CLIP = 40

• OP_SQUEEZE = 41

• OP_AS_INTERVAL = 42

Used in: Expression

• string id = 1

  Required.

Used in: Expression

• optional IntegerLiteral value = 1

  Required.

• optional Width width = 2

Used in: Expression

• optional Expression expression = 1

  Required.

• optional Expression index = 2

  Required.

Used in: Expression

• optional Expression expression = 1

  Required.

• string field = 2

  Required.

Used in: Expression

• optional Expression expression = 1

  Required.

• optional IntegerLiteral index = 2

  Required.

Used in: Expression

• optional IntegerLiteral value = 1

  Required.

• optional Width width = 2

Used in: Expression

• optional Expression condition = 1

  Required.

• optional Expression value = 2

  Required.

Used in: Circuit

• oneof module

  Required.

  • Module.ExternalModule external_module = 1

  • Module.UserModule user_module = 2

Used in: Module

• string id = 1

  Required.

• repeated Port port = 2

• string defined_name = 3

• repeated ExternalModule.Parameter parameter = 4

Used in: ExternalModule

• string id = 1

• oneof value

  • BigInt integer = 2

  • double double = 3

  • string string = 4

  • string raw_string = 5

Used in: Module

• string id = 1

  Required.

• repeated Port port = 2

• repeated Statement statement = 3

Used in: Module.ExternalModule, Module.UserModule

• string id = 1

  Required.

• Port.Direction direction = 2

  Required.

• optional Type type = 3

  Required.

Used in: Port

• PORT_DIRECTION_UNKNOWN = 0

• PORT_DIRECTION_IN = 1

• PORT_DIRECTION_OUT = 2

Used in: Statement

• oneof source_info

  Required.

  • SourceInfo.None none = 1

  • SourceInfo.Position position = 2

  • string text = 3

Used in: SourceInfo

• None.Reason reason = 1

  Required.

Used in: None

• NONE_SOURCE_INFO_REASON_UNKNOWN = 0

• NONE_SOURCE_INFO_REASON_UNLOCATABLE = 1

• NONE_SOURCE_INFO_REASON_SUPPRESSED = 2

• NONE_SOURCE_INFO_REASON_DEPRECATED = 3

Used in: SourceInfo

• string filename = 1

  Required.

• uint32 line = 2

  Required.

• uint32 column = 3

  Required.

Used in: Module.UserModule, Statement.When

• oneof statement

  Required.

  • Statement.Wire wire = 1

  • Statement.Register register = 2

  • Statement.Memory memory = 3

  • Statement.CMemory cmemory = 4

  • Statement.Instance instance = 5

  • Statement.Node node = 6

  • Statement.When when = 7

  • Statement.Stop stop = 8

  • Statement.Printf printf = 10

  • Statement.Skip skip = 14

  • Statement.Connect connect = 15

  • Statement.PartialConnect partial_connect = 16

  • Statement.IsInvalid is_invalid = 17

  • Statement.MemoryPort memory_port = 18

  • Statement.Attach attach = 20

• optional SourceInfo source_info = 19

Used in: Statement

• repeated Expression expression = 1

Used in: Statement

• string id = 1

  Required.

• oneof type

  Required.

  • Type.VectorType vector_type = 2

  • CMemory.TypeAndDepth type_and_depth = 4

• bool sync_read = 3

  Required.

• ReadUnderWrite read_under_write = 5

As alternative to using VectorType as type

Used in: CMemory

• optional Type data_type = 1

• optional BigInt depth = 2

Used in: Statement

• optional Expression location = 1

  This should be limited to Reference, SubField, SubIndex, or SubAccess. Required.

• optional Expression expression = 2

  Required.

Used in: Statement

• string id = 1

  Required.

• string module_id = 2

  Required.

Used in: Statement

• optional Expression expression = 1

  Required.

Used in: Statement

• string id = 1

  Required.

• optional Type type = 2

  Required.

• oneof depth

  Required.

  • uint32 uint_depth = 3

  • BigInt bigint_depth = 9

• uint32 write_latency = 4

  Required.

• uint32 read_latency = 5

  Required.

• repeated string reader_id = 6

• repeated string writer_id = 7

• repeated string readwriter_id = 8

• ReadUnderWrite read_under_write = 10

Used in: Statement

• MemoryPort.Direction direction = 1

  Required.

• string id = 2

  Required.

• string memory_id = 3

  Required.

• optional Expression memory_index = 4

  Required.

• optional Expression expression = 5

  Required.

Used in: MemoryPort

• MEMORY_PORT_DIRECTION_UNKNOWN = 0

• MEMORY_PORT_DIRECTION_INFER = 1

• MEMORY_PORT_DIRECTION_READ = 2

• MEMORY_PORT_DIRECTION_WRITE = 3

• MEMORY_PORT_DIRECTION_READ_WRITE = 4

Used in: Statement

• string id = 1

  Required.

• optional Expression expression = 2

  Required.

Used in: Statement

• optional Expression location = 1

  This should be limited to Reference, SubField, SubIndex, or SubAccess. Required.

• optional Expression expression = 2

  Required.

Used in: Statement

• string value = 1

  Required.

• repeated Expression arg = 2

• optional Expression clk = 3

  Required.

• optional Expression en = 4

  Required.

Used in: CMemory, Memory

• UNDEFINED = 0

• OLD = 1

• NEW = 2

Used in: Statement

• string id = 1

  Required.

• optional Type type = 2

  Required.

• optional Expression clock = 3

  Required.

• optional Expression reset = 4

• optional Expression init = 5

Empty

Used in: Statement

(message has no fields)

Used in: Statement

• int32 return_value = 1

  Required.

• optional Expression clk = 2

  Required.

• optional Expression en = 3

  Required.

Used in: Statement

• optional Expression predicate = 1

  Required.

• repeated Statement consequent = 2

• repeated Statement otherwise = 3

Used in: Statement

• string id = 1

  Required.

• optional Type type = 2

  Required.

Used in: Circuit

• string name = 1

  Required.

Used in: Port, Statement.CMemory.TypeAndDepth, Statement.Memory, Statement.Register, Statement.Wire, Type.BundleType.Field, Type.VectorType

• oneof type

  Required.

  • Type.UIntType uint_type = 2

  • Type.SIntType sint_type = 3

  • Type.ClockType clock_type = 4

  • Type.BundleType bundle_type = 5

  • Type.VectorType vector_type = 6

  • Type.FixedType fixed_type = 7

  • Type.AnalogType analog_type = 8

  • Type.AsyncResetType async_reset_type = 9

  • Type.ResetType reset_type = 10

Used in: Type

• optional Width width = 3

Empty.

Used in: Type

(message has no fields)

Used in: Type

• repeated BundleType.Field field = 1

Used in: BundleType

• bool is_flipped = 1

  Required.

• string id = 2

  Required.

• optional Type type = 3

  Required.

Empty.

Used in: Type

(message has no fields)

Used in: Type

• optional Width width = 1

• optional Width point = 2

Empty.

Used in: Type

(message has no fields)

Used in: Type

• optional Width width = 1

Used in: Type

• optional Width width = 1

Used in: Statement.CMemory, Type

• optional Type type = 1

  Required.

• uint32 size = 2

  Required.

Using proto3 means that there is no has* method for primitives. This necesitates boxing width values because there are cases where a width of zero (the default value of uint32) is a valid width.

Used in: Expression.FixedLiteral, Expression.SIntLiteral, Expression.UIntLiteral, Type.AnalogType, Type.FixedType, Type.SIntType, Type.UIntType

• uint32 value = 1

  Required