tt-flash 3.4.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tt_flash-3.4.1/LICENSE ADDED
@@ -0,0 +1,206 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
203
+
204
+
205
+ Copyright (c) 2024 Tenstorrent AI ULC
206
+
@@ -0,0 +1,3 @@
1
+ For the avoidance of doubt, this software assists in programming Tenstorrent products.
2
+
3
+ However, making, using, or selling hardware, models, or IP may require the license of rights (such as patent rights) from Tenstorrent or others.
@@ -0,0 +1,425 @@
1
+ Metadata-Version: 2.4
2
+ Name: tt-flash
3
+ Version: 3.4.1
4
+ Summary: Utility to flash firmware blobs to tt devices
5
+ Author-email: Daniel Rosen <drosen@tenstorrent.com>
6
+ Maintainer-email: Daniel Rosen <drosen@tenstorrent.com>
7
+ License:
8
+ Apache License
9
+ Version 2.0, January 2004
10
+ http://www.apache.org/licenses/
11
+
12
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+ 1. Definitions.
15
+
16
+ "License" shall mean the terms and conditions for use, reproduction,
17
+ and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+ "Licensor" shall mean the copyright owner or entity authorized by
20
+ the copyright owner that is granting the License.
21
+
22
+ "Legal Entity" shall mean the union of the acting entity and all
23
+ other entities that control, are controlled by, or are under common
24
+ control with that entity. For the purposes of this definition,
25
+ "control" means (i) the power, direct or indirect, to cause the
26
+ direction or management of such entity, whether by contract or
27
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+ "You" (or "Your") shall mean an individual or Legal Entity
31
+ exercising permissions granted by this License.
32
+
33
+ "Source" form shall mean the preferred form for making modifications,
34
+ including but not limited to software source code, documentation
35
+ source, and configuration files.
36
+
37
+ "Object" form shall mean any form resulting from mechanical
38
+ transformation or translation of a Source form, including but
39
+ not limited to compiled object code, generated documentation,
40
+ and conversions to other media types.
41
+
42
+ "Work" shall mean the work of authorship, whether in Source or
43
+ Object form, made available under the License, as indicated by a
44
+ copyright notice that is included in or attached to the work
45
+ (an example is provided in the Appendix below).
46
+
47
+ "Derivative Works" shall mean any work, whether in Source or Object
48
+ form, that is based on (or derived from) the Work and for which the
49
+ editorial revisions, annotations, elaborations, or other modifications
50
+ represent, as a whole, an original work of authorship. For the purposes
51
+ of this License, Derivative Works shall not include works that remain
52
+ separable from, or merely link (or bind by name) to the interfaces of,
53
+ the Work and Derivative Works thereof.
54
+
55
+ "Contribution" shall mean any work of authorship, including
56
+ the original version of the Work and any modifications or additions
57
+ to that Work or Derivative Works thereof, that is intentionally
58
+ submitted to Licensor for inclusion in the Work by the copyright owner
59
+ or by an individual or Legal Entity authorized to submit on behalf of
60
+ the copyright owner. For the purposes of this definition, "submitted"
61
+ means any form of electronic, verbal, or written communication sent
62
+ to the Licensor or its representatives, including but not limited to
63
+ communication on electronic mailing lists, source code control systems,
64
+ and issue tracking systems that are managed by, or on behalf of, the
65
+ Licensor for the purpose of discussing and improving the Work, but
66
+ excluding communication that is conspicuously marked or otherwise
67
+ designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+ "Contributor" shall mean Licensor and any individual or Legal Entity
70
+ on behalf of whom a Contribution has been received by Licensor and
71
+ subsequently incorporated within the Work.
72
+
73
+ 2. Grant of Copyright License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ copyright license to reproduce, prepare Derivative Works of,
77
+ publicly display, publicly perform, sublicense, and distribute the
78
+ Work and such Derivative Works in Source or Object form.
79
+
80
+ 3. Grant of Patent License. Subject to the terms and conditions of
81
+ this License, each Contributor hereby grants to You a perpetual,
82
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+ (except as stated in this section) patent license to make, have made,
84
+ use, offer to sell, sell, import, and otherwise transfer the Work,
85
+ where such license applies only to those patent claims licensable
86
+ by such Contributor that are necessarily infringed by their
87
+ Contribution(s) alone or by combination of their Contribution(s)
88
+ with the Work to which such Contribution(s) was submitted. If You
89
+ institute patent litigation against any entity (including a
90
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+ or a Contribution incorporated within the Work constitutes direct
92
+ or contributory patent infringement, then any patent licenses
93
+ granted to You under this License for that Work shall terminate
94
+ as of the date such litigation is filed.
95
+
96
+ 4. Redistribution. You may reproduce and distribute copies of the
97
+ Work or Derivative Works thereof in any medium, with or without
98
+ modifications, and in Source or Object form, provided that You
99
+ meet the following conditions:
100
+
101
+ (a) You must give any other recipients of the Work or
102
+ Derivative Works a copy of this License; and
103
+
104
+ (b) You must cause any modified files to carry prominent notices
105
+ stating that You changed the files; and
106
+
107
+ (c) You must retain, in the Source form of any Derivative Works
108
+ that You distribute, all copyright, patent, trademark, and
109
+ attribution notices from the Source form of the Work,
110
+ excluding those notices that do not pertain to any part of
111
+ the Derivative Works; and
112
+
113
+ (d) If the Work includes a "NOTICE" text file as part of its
114
+ distribution, then any Derivative Works that You distribute must
115
+ include a readable copy of the attribution notices contained
116
+ within such NOTICE file, excluding those notices that do not
117
+ pertain to any part of the Derivative Works, in at least one
118
+ of the following places: within a NOTICE text file distributed
119
+ as part of the Derivative Works; within the Source form or
120
+ documentation, if provided along with the Derivative Works; or,
121
+ within a display generated by the Derivative Works, if and
122
+ wherever such third-party notices normally appear. The contents
123
+ of the NOTICE file are for informational purposes only and
124
+ do not modify the License. You may add Your own attribution
125
+ notices within Derivative Works that You distribute, alongside
126
+ or as an addendum to the NOTICE text from the Work, provided
127
+ that such additional attribution notices cannot be construed
128
+ as modifying the License.
129
+
130
+ You may add Your own copyright statement to Your modifications and
131
+ may provide additional or different license terms and conditions
132
+ for use, reproduction, or distribution of Your modifications, or
133
+ for any such Derivative Works as a whole, provided Your use,
134
+ reproduction, and distribution of the Work otherwise complies with
135
+ the conditions stated in this License.
136
+
137
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
138
+ any Contribution intentionally submitted for inclusion in the Work
139
+ by You to the Licensor shall be under the terms and conditions of
140
+ this License, without any additional terms or conditions.
141
+ Notwithstanding the above, nothing herein shall supersede or modify
142
+ the terms of any separate license agreement you may have executed
143
+ with Licensor regarding such Contributions.
144
+
145
+ 6. Trademarks. This License does not grant permission to use the trade
146
+ names, trademarks, service marks, or product names of the Licensor,
147
+ except as required for reasonable and customary use in describing the
148
+ origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+ 7. Disclaimer of Warranty. Unless required by applicable law or
151
+ agreed to in writing, Licensor provides the Work (and each
152
+ Contributor provides its Contributions) on an "AS IS" BASIS,
153
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+ implied, including, without limitation, any warranties or conditions
155
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+ PARTICULAR PURPOSE. You are solely responsible for determining the
157
+ appropriateness of using or redistributing the Work and assume any
158
+ risks associated with Your exercise of permissions under this License.
159
+
160
+ 8. Limitation of Liability. In no event and under no legal theory,
161
+ whether in tort (including negligence), contract, or otherwise,
162
+ unless required by applicable law (such as deliberate and grossly
163
+ negligent acts) or agreed to in writing, shall any Contributor be
164
+ liable to You for damages, including any direct, indirect, special,
165
+ incidental, or consequential damages of any character arising as a
166
+ result of this License or out of the use or inability to use the
167
+ Work (including but not limited to damages for loss of goodwill,
168
+ work stoppage, computer failure or malfunction, or any and all
169
+ other commercial damages or losses), even if such Contributor
170
+ has been advised of the possibility of such damages.
171
+
172
+ 9. Accepting Warranty or Additional Liability. While redistributing
173
+ the Work or Derivative Works thereof, You may choose to offer,
174
+ and charge a fee for, acceptance of support, warranty, indemnity,
175
+ or other liability obligations and/or rights consistent with this
176
+ License. However, in accepting such obligations, You may act only
177
+ on Your own behalf and on Your sole responsibility, not on behalf
178
+ of any other Contributor, and only if You agree to indemnify,
179
+ defend, and hold each Contributor harmless for any liability
180
+ incurred by, or claims asserted against, such Contributor by reason
181
+ of your accepting any such warranty or additional liability.
182
+
183
+ END OF TERMS AND CONDITIONS
184
+
185
+ APPENDIX: How to apply the Apache License to your work.
186
+
187
+ To apply the Apache License to your work, attach the following
188
+ boilerplate notice, with the fields enclosed by brackets "[]"
189
+ replaced with your own identifying information. (Don't include
190
+ the brackets!) The text should be enclosed in the appropriate
191
+ comment syntax for the file format. We also recommend that a
192
+ file or class name and description of purpose be included on the
193
+ same "printed page" as the copyright notice for easier
194
+ identification within third-party archives.
195
+
196
+ Copyright [yyyy] [name of copyright owner]
197
+
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+
210
+
211
+ Copyright (c) 2024 Tenstorrent AI ULC
212
+
213
+
214
+ Project-URL: Homepage, http://tenstorrent.com
215
+ Project-URL: Bug Reports, https://github.com/tenstorrent/tt-flash/issues
216
+ Project-URL: Source, https://github.com/tenstorrent/tt-flash
217
+ Classifier: Development Status :: 4 - Beta
218
+ Classifier: Environment :: Console :: Curses
219
+ Classifier: License :: OSI Approved :: Apache Software License
220
+ Classifier: Programming Language :: Python :: 3
221
+ Classifier: Programming Language :: Python :: 3.7
222
+ Classifier: Programming Language :: Python :: 3.8
223
+ Classifier: Programming Language :: Python :: 3.9
224
+ Classifier: Programming Language :: Python :: 3.10
225
+ Classifier: Programming Language :: Python :: 3.11
226
+ Classifier: Programming Language :: Python :: 3 :: Only
227
+ Requires-Python: >=3.7
228
+ Description-Content-Type: text/markdown
229
+ License-File: LICENSE
230
+ License-File: LICENSE_understanding.txt
231
+ Requires-Dist: pyyaml==6.0.2
232
+ Requires-Dist: tt_tools_common>=1.4.19
233
+ Requires-Dist: pyluwen>=0.7.9
234
+ Requires-Dist: tabulate==0.9.0
235
+ Requires-Dist: tomli==2.0.1; python_version < "3.11"
236
+ Requires-Dist: importlib-metadata>=1.4.0; python_version < "3.8"
237
+ Requires-Dist: importlib-resources>=1.3.0; python_version < "3.9"
238
+ Provides-Extra: dev
239
+ Requires-Dist: black==24.10.0; python_version >= "3.9" and extra == "dev"
240
+ Requires-Dist: black==24.8.0; python_version == "3.8" and extra == "dev"
241
+ Requires-Dist: black==23.3.0; python_version == "3.7" and extra == "dev"
242
+ Dynamic: license-file
243
+
244
+ # tt-flash
245
+
246
+ This is a utility to flash firmware blobs to tenstorrent devices.
247
+
248
+ ## Official Repository
249
+
250
+ [https://github.com/tenstorrent/tt-flash](https://github.com/tenstorrent/tt-flash)
251
+
252
+ ## Getting started
253
+
254
+ ### Regardless of install path (straight pip or git clone for development)
255
+ #### Install Rust (if you don't already have it)
256
+ Note: This is only needed if you haven't already installed luwen
257
+ ##### Using Distribution packages (preferred)
258
+ * **Fedora / EL9:** <br/> `sudo dnf install cargo`
259
+ * **Ubuntu / Debian:** <br/> `sudo apt install cargo`
260
+ ##### Using Rustup
261
+ ```
262
+ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
263
+ source "$HOME/.cargo/env"
264
+ ```
265
+
266
+ #### (Optional) Virtual environment
267
+ Virtual environments allow Python to create a self-contained area where it can
268
+ install things and deal with it's own library pathing. If you aren't doing
269
+ this as a system level install a virtual environment is recommended.
270
+
271
+ ```
272
+ python -m venv venv
273
+ source venv/bin/activate
274
+ ```
275
+
276
+ ### To install without git (non-development):
277
+
278
+ If you just want to install tt-flash, and not do any development, you can just
279
+ use pip (with or without a virtual environment) to install a public version.
280
+
281
+ ```
282
+ pip install git+https://github.com/tenstorrent/tt-flash.git
283
+ ```
284
+
285
+ ***Note:*** if you fork the repository please fill in the appropriate accessible URL above to install tt-flash
286
+
287
+ tt-flash is now installed
288
+
289
+ ### To Build from git (development):
290
+
291
+ #### Clone the repository
292
+
293
+ If you haven't already cloned the repository you are reading this from clone
294
+ it now, this will vary depending on where this repository is at. The official
295
+ public repository is at https://github.com/tenstorrent/tt-flash
296
+
297
+ ```
298
+ git clone https://github.com/tenstorrent/tt-flash.git
299
+ cd tt-flash
300
+ ```
301
+
302
+ #### Building the repository
303
+
304
+ ```
305
+ pip install .
306
+ ```
307
+
308
+ or for users who would like to edit the code without re-building
309
+
310
+ ```
311
+ pip install --editable .
312
+ ```
313
+
314
+ ### Help text
315
+ ```
316
+ usage: tt-flash [-h] [-v] [--sys-config SYS_CONFIG] [--no-color] [--no-tty] {flash} ...
317
+
318
+ optional arguments:
319
+ -h, --help show this help message and exit
320
+ -v, --version show program's version number and exit
321
+ --sys-config SYS_CONFIG
322
+ Path to the pre generated sys-config json
323
+ --no-color Disable the colorful output
324
+ --no-tty Force disable the tty command output
325
+
326
+ command:
327
+ {flash}
328
+
329
+ usage: tt-flash flash [-h] [--sys-config SYS_CONFIG] --fw-tar FW_TAR [--skip-missing-fw] [--force] [--no-reset]
330
+
331
+ optional arguments:
332
+ -h, --help show this help message and exit
333
+ --sys-config SYS_CONFIG
334
+ Path to the pre generated sys-config json
335
+ --fw-tar FW_TAR Path to the firmware tarball
336
+ --skip-missing-fw If the fw packages doesn't contain the fw for a detected board, continue flashing
337
+ --force Force update the ROM
338
+ --no-reset Do not reset devices at the end of flash
339
+ ```
340
+
341
+ ## Typical usage
342
+ ```
343
+ tt-flash flash --fw-tar <firmware bundle file path goes here>
344
+ ```
345
+
346
+ ### Grayskull Note:
347
+ If you are using a Grayskull based card, the card itself does not have an on-board reset mechanism, and you will need to reboot to have the new firmware apply.
348
+
349
+ ### Firmware files
350
+ Firmware files are licensed and distributed independently of tt-flash, as this is just the system to deal with the actual flashing of the images. You can find the firmware files in a seperate repo [https://github.com/tenstorrent/tt-firmware](https://github.com/tenstorrent/tt-firmware).
351
+
352
+ ### Example output
353
+
354
+ This is an example of what you can expect the final output to look like on a system when not needing an update
355
+
356
+ ```
357
+ $ tt-flash flash --fw-tar ~/work/build-combine-flash-pkg/fw_pack.tar.gz
358
+ Stage: SETUP
359
+ Searching for default sys-config path
360
+ Checking /etc/tenstorrent/config.json: not found
361
+ Checking ~/.config/tenstorrent/config.json: not found
362
+
363
+ Could not find config in default search locations, if you need it, either pass it in explicity or generate one
364
+ Warning: continuing without sys-config, galaxy systems will not be reset
365
+ Stage: DETECT
366
+ Stage: FLASH
367
+ Sub Stage: VERIFY
368
+ Verifying fw-package can be flashed: complete
369
+ Verifying Grayskull[0] can be flashed
370
+ Verifying Wormhole[1] can be flashed
371
+ Stage: FLASH
372
+ Sub Stage FLASH Step 1: Grayskull[0]
373
+ ROM version is: (80, 9, 0, 0). tt-flash version is: (80, 9, 0, 0)
374
+ ROM does not need to be updated.
375
+ Sub Stage FLASH Step 1: Wormhole[1]
376
+ ROM version is: (80, 9, 0, 0). tt-flash version is: (80, 9, 0, 0)
377
+ ROM does not need to be updated.
378
+ FLASH SUCCESS
379
+ ```
380
+
381
+ And when forcing an update with `--force`
382
+
383
+ ```
384
+ $ tt-flash flash --fw-tar ~/work/build-combine-flash-pkg/fw_pack.tar.gz --force
385
+ Stage: SETUP
386
+ Searching for default sys-config path
387
+ Checking /etc/tenstorrent/config.json: not found
388
+ Checking ~/.config/tenstorrent/config.json: not found
389
+
390
+ Could not find config in default search locations, if you need it, either pass it in explicity or generate one
391
+ Warning: continuing without sys-config, galaxy systems will not be reset
392
+ Stage: DETECT
393
+ Stage: FLASH
394
+ Sub Stage: VERIFY
395
+ Verifying fw-package can be flashed: complete
396
+ Verifying Grayskull[0] can be flashed
397
+ Verifying Wormhole[1] can be flashed
398
+ Stage: FLASH
399
+ Sub Stage FLASH Step 1: Grayskull[0]
400
+ ROM version is: (80, 9, 0, 0). tt-flash version is: (80, 9, 0, 0)
401
+ Forced ROM update requested. ROM will now be updated.
402
+ Sub Stage FLASH Step 1: Wormhole[1]
403
+ ROM version is: (80, 9, 0, 0). tt-flash version is: (80, 9, 0, 0)
404
+ Forced ROM update requested. ROM will now be updated.
405
+ Board will require reset to complete update, checking if an automatic reset is possible
406
+ Success: Board can be auto reset; will be triggered if the flash is successful
407
+ Sub Stage FLASH Step 2: Grayskull[0] {e150}
408
+ Writing new firmware... SUCCESS
409
+ Firmware verification... SUCCESS
410
+ Sub Stage FLASH Step 2: Wormhole[1] {n300}
411
+ Writing new firmware... SUCCESS
412
+ Firmware verification... SUCCESS
413
+ Initiating local to remote data copy
414
+ Flash and verification for all chips completed, will now wait for for n300 remote copy to complete...
415
+ Remote copy completed
416
+ Stage: RESET
417
+ Starting PCI link reset on WH devices at PCI indices: 1
418
+ Finishing PCI link reset on WH devices at PCI indices: 1
419
+
420
+ FLASH SUCCESS
421
+ ```
422
+
423
+ ## License
424
+
425
+ Apache 2.0 - https://www.apache.org/licenses/LICENSE-2.0.txt