You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+37-2
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,11 @@ For full usage details, please refer to the [official VS Code debugger documenta
182
182
183
183
# Configuration
184
184
## Project Settings
185
-
`.vscode/settings.json` is the main project configuration file. Values set here are parsed into the other .json config files. When a change is made to this file, VS Code should be restarted (or alternatively reloaded with CTRL+SHIFT+P -> Reload Window) to force a re-parse.
185
+
`.vscode/settings.json` is the main project configuration file. Values set here are parsed into the other .json config files.
186
+
187
+
**When a change is made to this file, VS Code should be reloaded with CTRL+SHIFT+P -> Reload Window (or alternatively restarted completely) to force a re-parse.**
188
+
189
+

186
190
187
191
The default project configuration should work for most use cases as long as `"target"` and `"board"` are set correctly.
188
192
@@ -235,22 +239,26 @@ The following configuration options are available:
235
239
236
240
* `"M4_OCD_interface_file"`
237
241
* Sets the OpenOCD interface file to use to connect to the Arm M4 core. This should match the debugger being used for the M4 core.
242
+
* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting.
238
243
* `.cfg` file extension must be included.
239
244
* Default value: `"cmsis-dap.cfg"`
240
245
241
246
* `"M4_OCD_target_file"`
242
247
* Sets the OpenOCD target file to use for the Arm M4 core. This should match the target microcontroller.
243
248
* `.cfg` file extension must be included.
244
249
* **On Linux there is a case-sensitivity issue with this setting**. OpenOCD config files are all lowercase, but `"target"` must be uppercase. On Linux, manually set this value to the lowercase target .cfg file matching the `"target"` config option. Ex: `""M4_OCD_target_file":"max32670.cfg"`
250
+
* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting.
245
251
* Default value: `"${config:target}.cfg"`
246
252
247
253
* `"RV_OCD_interface_file"`
248
254
* Sets the OpenOCD interface file to use to connect to the RISC-V core. This should match the debugger being used for the RISC-V core.
255
+
* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting.
249
256
* `.cfg` file extension must be included.
250
257
* Default value: `"cmsis-dap.cfg"`
251
258
252
259
* `"RV_OCD_target_file"`
253
260
* Sets the OpenOCD target file to use for the RISC-V core.
261
+
* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting.
254
262
* `.cfg` file extension must be included.
255
263
* Default value: `"${config:target}_riscv.cfg"`
256
264
@@ -284,7 +292,7 @@ To add additional search paths :
284
292
285
293
2. Add the include path(s) to the `configurations > includePath` list. The paths set here should contain header files, and will be searched by the Intellisense engine and when using "Go to Declaration" in the editor.
286
294
287
-
3. Add the path(s) to any relevant implementation files to the `"browse":"path"` list. This list contains the paths that will be searched when using "Go to Definition".
295
+
3. Add the path(s) to any relevant implementation files to the `"browse":"path"` list. This list contains the paths that will be searched when using "Go to Definition".
288
296
289
297
# Project Creation
290
298
### Option 1. Copying a Pre-Made Project
@@ -323,6 +331,24 @@ If you want to start from scratch, take this option.
323
331
324
332
6. Fundamentally, that's it. Your new empty project can now be opened with `File > Open Folder` from within VS Code. However, you'll probably want to add some source code. See [Configuring the Makefile](#configuring-the-makefile).
325
333
334
+
# Die Types to Part Numbers
335
+
The MaximSDK's peripheral driver filenames are written using die types instead of external part numbers. This table shows which part numbers correspond to each die type, which is useful through source file definitions.
336
+
337
+
| Die Type | Part Number |
338
+
| -------- | ----------- |
339
+
| ES17 | MAX32520 |
340
+
| ME10 | MAX32650 |
341
+
| ME11 | MAX32660 |
342
+
| ME13 | MAX32570 |
343
+
| ME14 | MAX32665 |
344
+
| ME15 | MAX32670 |
345
+
| ME16 | MAX32675 |
346
+
| ME17 | MAX32655 |
347
+
| ME18 | MAX32690 |
348
+
| ME21 | MAX32672 |
349
+
| AI85 | MAX78000 |
350
+
| AI87 | MAX78002 |
351
+
326
352
# Troubleshooting
327
353
## Testing the Setup
328
354
Opening a VSCode-Maxim project with `File > Open Folder` should make Maxim's toolchain accessible from the integrated terminal. To test that everything is working properly :
@@ -343,3 +369,12 @@ Opening a VSCode-Maxim project with `File > Open Folder` should make Maxim's too
343
369

344
370
345
371
If the tools are not accessible from the terminal, then the system settings and/or project settings must be examined further. (Troubleshooting guide is in progress)
372
+
373
+
# Issue Tracker
374
+
Bug reports, feature requests, and contributions are welcome via the [issues](https://github.com/MaximIntegratedTechSupport/VSCode-Maxim/issues) tracker on Github.
375
+
376
+
New issues should contain _at minimum_ the following information:
377
+
* Visual Studio Code version #s (see `Help -> About`)
378
+
* C/C++ Extension version #
379
+
* Target microcontroller and evaluation platform
380
+
* The projects `.vscode` folder and `Makefile` (where applicable). Standard compression formats such as `.zip`, `.rar`, `.tar.gz`, etc. are all acceptable.
0 commit comments