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
|
// SPDX-License-Identifier: Apache-2.0
package chisel3
import scala.language.experimental.macros
import chisel3.internal._
import chisel3.internal.Builder.pushCommand
import chisel3.internal.sourceinfo.SourceInfo
/** Prints a message in simulation
*
* See apply methods for use
*/
object printf {
/** Helper for packing escape characters */
private[chisel3] def format(formatIn: String): String = {
require(formatIn.forall(c => c.toInt > 0 && c.toInt < 128), "format strings must comprise non-null ASCII values")
def escaped(x: Char) = {
require(x.toInt >= 0, s"char ${x} to Int ${x.toInt} must be >= 0")
if (x == '"' || x == '\\') {
s"\\${x}"
} else if (x == '\n') {
"\\n"
} else if (x == '\t') {
"\\t"
} else {
require(
x.toInt >= 32,
s"char ${x} to Int ${x.toInt} must be >= 32"
) // TODO \xNN once FIRRTL issue #59 is resolved
x
}
}
formatIn.map(escaped).mkString("")
}
/** Named class for [[printf]]s. */
final class Printf private[chisel3] (val pable: Printable) extends VerificationStatement
/** Prints a message in simulation
*
* Prints a message every cycle. If defined within the scope of a [[when]] block, the message
* will only be printed on cycles that the when condition is true.
*
* Does not fire when in reset (defined as the encapsulating Module's reset). If your definition
* of reset is not the encapsulating Module's reset, you will need to gate this externally.
*
* May be called outside of a Module (like defined in a function), uses the current default clock
* and reset. These can be overriden with [[withClockAndReset]].
*
* ==Format Strings==
*
* This method expects a ''format string'' and an ''argument list'' in a similar style to printf
* in C. The format string expects a [[scala.Predef.String String]] that may contain ''format
* specifiers'' For example:
* {{{
* printf("myWire has the value %d\n", myWire)
* }}}
* This prints the string "myWire has the value " followed by the current value of `myWire` (in
* decimal, followed by a newline.
*
* There must be exactly as many arguments as there are format specifiers
*
* ===Format Specifiers===
*
* Format specifiers are prefixed by `%`. If you wish to print a literal `%`, use `%%`.
* - `%d` - Decimal
* - `%x` - Hexadecimal
* - `%b` - Binary
* - `%c` - 8-bit Character
* - `%n` - Name of a signal
* - `%N` - Full name of a leaf signal (in an aggregate)
*
* @param fmt printf format string
* @param data format string varargs containing data to print
*/
def apply(fmt: String, data: Bits*)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Printf =
apply(Printable.pack(fmt, data: _*))
/** Prints a message in simulation
*
* Prints a message every cycle. If defined within the scope of a [[when]] block, the message
* will only be printed on cycles that the when condition is true.
*
* Does not fire when in reset (defined as the encapsulating Module's reset). If your definition
* of reset is not the encapsulating Module's reset, you will need to gate this externally.
*
* May be called outside of a Module (like defined in a function), uses the current default clock
* and reset. These can be overriden with [[withClockAndReset]].
*
* @see [[Printable]] documentation
* @param pable [[Printable]] to print
*/
def apply(pable: Printable)(implicit sourceInfo: SourceInfo, compileOptions: CompileOptions): Printf = {
var printfId: Printf = null
when(!Module.reset.asBool) {
printfId = printfWithoutReset(pable)
}
printfId
}
private[chisel3] def printfWithoutReset(
pable: Printable
)(
implicit sourceInfo: SourceInfo,
compileOptions: CompileOptions
): Printf = {
val clock = Builder.forcedClock
val printfId = new Printf(pable)
pushCommand(chisel3.internal.firrtl.Printf(printfId, sourceInfo, clock.ref, pable))
printfId
}
private[chisel3] def printfWithoutReset(
fmt: String,
data: Bits*
)(
implicit sourceInfo: SourceInfo,
compileOptions: CompileOptions
): Printf =
printfWithoutReset(Printable.pack(fmt, data: _*))
}
|
