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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Scratchpad Memory
//!
//! TODO: Hardcoded values
//! - data width of `addr` field of ScratchpadReadReq is hardcoded to 12 bits
//! - data width of `data` field of ScratchpadReadResp is hardcoded to 128 bits

use crate::gemmini::isa::rocc::*;
use crate::gemmini::local_addr::*;
use crate::gemmini::*;

/// Data width of entry in the scratchpad.
pub const SP_DATA_WIDTH: usize = 16 * 8; // (meshColumns * tileColumns) * inputType.getWidth
/// Mask width of entry in the scratchpad.
pub const SP_MASK_WIDTH: usize = SP_DATA_WIDTH / 8;

/// Scratchpad memory read request.
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadMemReadReq<const SCALE_BITS: usize> {
    /// Virtual address.
    pub vaddr: U<CORE_MAX_ADDR_BITS>,
    /// Local address.
    pub laddr: LocalAddr, // TODO: Don't use a magic number here

    /// TODO: Documentation
    pub cols: U<16>, // TODO: Don't use a magic number here
    /// TODO: Documentation
    pub repeats: U<16>, // TODO: Don't use a magic number here
    /// TODO: Documentation
    pub scale: U<SCALE_BITS>,
    /// TODO: Documentation
    pub has_acc_bitwidth: bool,
    /// TODO: Documentation
    pub all_zeros: bool,
    /// TODO: Documentation
    pub block_stride: U<16>, // TODO: Don't use a magic number here
    /// TODO: Documentation
    pub pixel_repeats: U<8>, // TODO: Don't use a magic number here
    /// TODO: Documentation
    pub cmd_id: U<8>, // TODO: Don't use a magic number here
    /// TODO: Documentation
    pub status: MStatus,
}

/// Scratchpad memory read response.
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadMemReadResp {
    /// Bytes to read.
    pub bytes_read: U<16>, // TODO: Don't use a magic number here
    /// Command ID.
    pub cmd_id: U<8>, // TODO: Don't use a magic number here
}

/// Scratchpad memory write request.
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadMemWriteReq<const ACC_BITS: usize, const SCALE_BITS: usize> {
    /// TODO: Documentation
    pub vaddr: U<CORE_MAX_ADDR_BITS>,
    /// TODO: Documentation
    pub laddr: LocalAddr,

    /// TODO: Documentation
    pub acc_act: U<3>,
    /// TODO: Documentation
    pub acc_scale: U<SCALE_BITS>,
    /// TODO: Documentation
    pub acc_igelu_qb: U<ACC_BITS>,
    /// TODO: Documentation
    pub acc_igelu_qc: U<ACC_BITS>,
    /// TODO: Documentation
    pub acc_iexp_qln2: U<ACC_BITS>,
    /// TODO: Documentation
    pub acc_iexp_qln2_inv: U<ACC_BITS>,
    /// TODO: Documentation
    pub acc_norm_stats_id: U<8>, // TODO: Don't use a magic number here

    /// TODO: Documentation
    pub len: U<16>,
    /// TODO: Documentation
    pub block: U<8>,

    /// TODO: Documentation
    pub cmd_id: U<8>,
    /// TODO: Documentation
    pub status: MStatus,

    /// TODO: Documentation
    pub pool_en: bool,
    /// TODO: Documentation
    pub store_en: bool,
}

/// Scratchpad memory write response.
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadMemWriteResp {
    /// Command ID.
    pub cmd_id: U<8>,
}

/// ScratchpadReadReq
///
/// <https://github.com/ucb-bar/gemmini/blob/be2e9f26181658895ebc7ca7f7d6be6210f5cdef/src/main/scala/gemmini/Scratchpad.scala#L75>
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadReadReq {
    /// Address.
    pub addr: U<{ clog2(SP_BANK_ENTRIES) }>,
    /// Request was from DMA or not.
    pub from_dma: bool,
}

/// Scratchpad Read Response
///
/// <https://github.com/ucb-bar/gemmini/blob/be2e9f26181658895ebc7ca7f7d6be6210f5cdef/src/main/scala/gemmini/Scratchpad.scala#L80>
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadReadResp {
    /// Data.
    pub data: U<SP_DATA_WIDTH>,
    /// Request was from DMA or not.
    pub from_dma: bool,
}

/// Scratchpad Write Request
///
/// Note: There is no response for Scratchpad Write
///
/// <https://github.com/ucb-bar/gemmini/blob/be2e9f26181658895ebc7ca7f7d6be6210f5cdef/src/main/scala/gemmini/Scratchpad.scala#L90>
#[derive(Debug, Clone, Copy)]
pub struct ScratchpadWriteReq {
    /// Address.
    pub addr: U<{ clog2(SP_BANK_ENTRIES) }>,
    /// Data.
    pub data: U<SP_DATA_WIDTH>,
    /// Mask.
    pub mask: U<SP_MASK_WIDTH>, // sub word write.
}

/// Scratchpad Bank
///
/// <https://github.com/ucb-bar/gemmini/blob/be2e9f26181658895ebc7ca7f7d6be6210f5cdef/src/main/scala/gemmini/Scratchpad.scala#L97>
pub fn spad_bank(
    _read_req: Vr<ScratchpadReadReq>,
    _write_req: Valid<ScratchpadWriteReq>,
) -> (Vr<ScratchpadReadResp>, ()) {
    todo!()
}