summaryrefslogtreecommitdiff
path: root/rtl/inc/bus/ari.svh
blob: 6c5a6e2c47b0becae2524628a9f19f5bd5ce41cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
//
// Copyright (c) 2026, Apollo Telephone Laboratories.
// Provided under the BSD-3 clause.
//

`ifndef BUS_ARI_SVH
`define BUS_ARI_SVH 1

//
// Number of bus segments / endpoints supported, this value
// should be bumped per every new device added to the chip.
//
parameter ARI_SEGMENT_COUNT = 3;

// Physical memory address bit-width
parameter PMA_XLEN          = 32;

//
// ARI bus tags for determining payload type
//
// @ARI_NOP:  No-operation, as per the spec
// @ARI_ADOP: Address operation
//
typedef enum logic [3:0] {
    ARI_NOP,
    ARI_ADOP
} AriTag;

//
// Address operation structure
//
// @ad:         48-bit physical address
// @data:       Data to write (if write_en=1)
// @write_en:   If set, this is a write operation
// @reserved:   Reserved, must be zero
//
typedef struct packed {
    logic [PMA_XLEN-1:0] ad;
    logic [63:0] data;
    logic write_en;
    logic [14:0] reserved;
} AriAdop;

//
// Represents an ARI frame that encapsulates a payload.
// Refer to the ARI specification.
//
// @tag:        Frame tag / kind
// @seq:        Frame sequence
// @payload:    Payload (reserved if tag = ARI_NOP)
//
typedef struct packed {
    AriTag tag;
    logic [3:0] seq;
    logic [127:0] payload;
} AriFrame;

`endif  // !BUS_ARI_SVH