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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// See LICENSE for license details.
package chisel3
import scala.language.experimental.macros
import chisel3.internal.sourceinfo.{SourceInfo, SourceInfoTransform}
// scalastyle:off method.name
// REVIEW TODO: Further discussion needed on what Num actually is.
/** Abstract trait defining operations available on numeric-like hardware data types.
*
* @tparam T the underlying type of the number
* @groupdesc Arithmetic Arithmetic hardware operators
* @groupdesc Comparison Comparison hardware operators
* @groupdesc Logical Logical hardware operators
* @define coll numeric-like type
* @define numType hardware type
* @define canHaveHighCost can result in significant cycle time and area costs
* @define canGenerateA This method generates a
* @define singleCycleMul @note $canGenerateA fully combinational multiplier which $canHaveHighCost.
* @define singleCycleDiv @note $canGenerateA fully combinational divider which $canHaveHighCost.
* @define maxWidth @note The width of the returned $numType is `max(width of this, width of that)`.
* @define maxWidthPlusOne @note The width of the returned $numType is `max(width of this, width of that) + 1`.
* @define sumWidth @note The width of the returned $numType is `width of this` + `width of that`.
* @define unchangedWidth @note The width of the returned $numType is unchanged, i.e., the `width of this`.
*/
trait Num[T <: Data] {
self: Num[T] =>
// def << (b: T): T
// def >> (b: T): T
//def unary_-(): T
// REVIEW TODO: double check ops conventions against FIRRTL
/** Addition operator
*
* @param that a $numType
* @return the sum of this $coll and `that`
* $maxWidth
* @group Arithmetic
*/
final def + (that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_+ (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Multiplication operator
*
* @param that a $numType
* @return the product of this $coll and `that`
* $sumWidth
* $singleCycleMul
* @group Arithmetic
*/
final def * (that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_* (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Division operator
*
* @param that a $numType
* @return the quotient of this $coll divided by `that`
* $singleCycleDiv
* @todo full rules
* @group Arithmetic
*/
final def / (that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_/ (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Modulo operator
*
* @param that a $numType
* @return the remainder of this $coll divided by `that`
* $singleCycleDiv
* @group Arithmetic
*/
final def % (that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_% (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Subtraction operator
*
* @param that a $numType
* @return the difference of this $coll less `that`
* $maxWidthPlusOne
* @group Arithmetic
*/
final def - (that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_- (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Less than operator
*
* @param that a $numType
* @return a hardware [[Bool]] asserted if this $coll is less than `that`
* @group Comparison
*/
final def < (that: T): Bool = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_< (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
/** Less than or equal to operator
*
* @param that a $numType
* @return a hardware [[Bool]] asserted if this $coll is less than or equal to `that`
* @group Comparison
*/
final def <= (that: T): Bool = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_<= (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
/** Greater than operator
*
* @param that a hardware component
* @return a hardware [[Bool]] asserted if this $coll is greater than `that`
* @group Comparison
*/
final def > (that: T): Bool = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_> (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
/** Greater than or equal to operator
*
* @param that a hardware component
* @return a hardware [[Bool]] asserted if this $coll is greather than or equal to `that`
* @group Comparison
*/
final def >= (that: T): Bool = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_>= (that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Bool
/** Absolute value operator
*
* @return a $numType with a value equal to the absolute value of this $coll
* $unchangedWidth
* @group Arithmetic
*/
final def abs(): T = macro SourceInfoTransform.noArg
/** @group SourceInfoTransformMacro */
def do_abs(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T
/** Minimum operator
*
* @param that a hardware $coll
* @return a $numType with a value equal to the mimimum value of this $coll and `that`
* $maxWidth
* @group Arithmetic
*/
final def min(that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_min(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T =
Mux(this < that, this.asInstanceOf[T], that)
/** Maximum operator
*
* @param that a $numType
* @return a $numType with a value equal to the mimimum value of this $coll and `that`
* $maxWidth
* @group Arithmetic
*/
final def max(that: T): T = macro SourceInfoTransform.thatArg
/** @group SourceInfoTransformMacro */
def do_max(that: T)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): T =
Mux(this < that, that, this.asInstanceOf[T])
}
|
