Attribute

Attribute can annotate some declarations like variable declaration.

sv Attribute

sv attribute represents SystemVerilog attribute. It will be transpiled to SystemVerilog attribute (* *).

module ModuleA {
    #[sv("ram_style=\"block\"")]
    let _a: logic<10> = 1;
    #[sv("mark_debug=\"true\"")]
    let _b: logic<10> = 1;
}

allow Attribute

allow attribute is used to disable specified lint check.

module ModuleA {
    #[allow(unused_variable)]
    let a: logic<10> = 1;
}

Available lint names are below:

• unused_variable
• missing_reset_statement
• missing_port

ifdef/ifndef/elsif/else Attribute

ifdef and ifndef attributes are used to control whether the annotated code block is enabled by defined value. In addition, the code block with elsif or else attributes is optional and a code block with ifdef or ifndef attributes can be followed with that code block.

The following example shows a usage of these attributes and which code blocks will be enabled according to defined values.

• For the sequence of ifdef/elsif/else attributes
  • If DEFINE_A is defined, the code block with #[ifdef(DEFINE_A)] (code block a) is enbaled, and code blocks with #[ifndef(DEFINE_B)] and #[else] (code block b/c) are disabled.
  • If DEFINE_A is not defined and DEFINE_B is defiend, the code block with #[elsif(DEFINE_B)] (code block b) is enabled, and code blocks with #[ifdef(DEFINE_A)] and #[else] (code block a/c) are disabled.
  • If DEFINE_A and DEFINE_B are not defined the code block with #[else] is enabled, and code blocks with #[ifdef(DEFINE_A)] and #[elsif(DEFINE_B)] (code block a/b) are disabled.
• For the sequence of ifndef/else attributes
  • If DEFINE_D is not defined, the code block with #[ifndef(DEFINE_D)] (code block d) is enabled, and the code block with #[else] (code block e) is disabled.
  • If DEFINE_D is defined, the code block with #[else] (code block e) is enabled, and the code block with #[ifndef(DEFINE_D)] (code block d) is disabled.

module ModuleA {
    #[ifdef(DEFINE_A)]
    {
        // code block a
        let _a: logic<10> = 1;
    }
    #[elsif(DEFINE_B)]
    {
        // code block b
        let _a: logic<10> = 2;
    }
    #[else]
    {
        // code block c
        let _a: logic<10> = 3;
    }

    #[ifndef(DEFINE_D)]
    {
        // code block d
        let _b: logic<10> = 4;
    }
    #[else]
    {
        // code block e
        let _b: logic<10> = 5;
    }
}

To avoid complex adjustment around trailing comma in generated code, the last item with ifdef in comma-separated list is forbidden.

expand Attribute

If expand attribute is set, structured ports such as modport are expanded into each Verilog ports. Synthesis tools may require that ports of the top module includes no such ports. This attribute is helpful for such case. The following argument is supported.

• modport: Expand ports of which direction is modport

interface InterfaceA::<W: u32> {
    var ready: logic   ;
    var valid: logic   ;
    var data : logic<W>;

    modport master {
        ready: input ,
        valid: output,
        data : output,
    }

    modport slave {
        ready: output,
        valid: input ,
        data : input ,
    }
}

#[expand(modport)]
module ModuleA (
    slave_if : modport InterfaceA::<8>::slave  [4],
    master_if: modport InterfaceA::<8>::master [4],
) {
    for i in 0..4 :g {
        connect slave_if[i] <> master_if[i];
    }
}

module ModuleB {
    inst a_if: InterfaceA::<8> [4];
    inst b_if: InterfaceA::<8> [4];

    inst u: ModuleA (
        slave_if : a_if,
        master_if: b_if,
    );
}

align Attribute

align attribute is used to control vertical alignment by formatter. If number is specified as an argument of align attribute, all numbers are aligned. identifier can be used too.

module ModuleA {
    let a  : logic<32> = 1;
    let aa : logic<32> = 1;
    let aaa: logic<32> = 1;

    let _b: logic = {
        a[0] repeat 1, a[0] repeat 1,
        aa[1] repeat 8, aa[1] repeat 8,
        aaa[2] repeat 16, aaa[2] repeat 16,
    };

    #[align(number, identifier)]
    let _c : logic = {
        a  [0 ] repeat 1 , a  [0 ] repeat 1 ,
        aa [1 ] repeat 8 , aa [1 ] repeat 8 ,
        aaa[2 ] repeat 16, aaa[2 ] repeat 16,
    };
}

fmt Attribute

fmt attribute is used to control formatiing way. The following arguments are supported:

• compact: compact formatting without newlines

module ModuleA {
    #[fmt(compact)]
    {
        inst u1: $sv::Module #( A: 1, B: 2 ) ( x: 1, y: _ );
        inst u2: $sv::Module #( A: 1, B: 2 ) ( x: 1, y: _ );
        inst u3: $sv::Module #( A: 1, B: 2 ) ( x: 1, y: _ );
        inst u4: $sv::Module #( A: 1, B: 2 ) ( x: 1, y: _ );
    }
}