]> Git Repo - pico-vscode.git/blob - scripts/pico_project.py
162347bc5b87dc2ddaaaeb4de7d8c06c25fc5754
[pico-vscode.git] / scripts / pico_project.py
1 #!/usr/bin/env python3
2
3 #
4 # Copyright (c) 2020-2024 Raspberry Pi (Trading) Ltd.
5 #
6 # SPDX-License-Identifier: BSD-3-Clause
7 #
8
9 #
10 # Copyright (c) 2023-2024 paulober <github.com/paulober>
11 #
12 # SPDX-License-Identifier: MPL-2.0
13 #
14
15 import argparse
16 import os
17 import shutil
18 from pathlib import Path
19 import sys
20 import re
21 import platform
22 import csv
23
24 CMAKELIST_FILENAME = 'CMakeLists.txt'
25 CMAKECACHE_FILENAME = 'CMakeCache.txt'
26
27 ARM_TRIPLE = 'arm-none-eabi'
28 RISCV_TRIPLE = 'riscv32-unknown-elf'
29 COREV_TRIPLE = 'riscv32-corev-elf'
30 COMPILER_TRIPLE = ARM_TRIPLE
31 def COMPILER_NAME():
32     return f"{COMPILER_TRIPLE}-gcc"
33 def GDB_NAME():
34     return f"{COMPILER_TRIPLE}-gdb"
35 CMAKE_TOOLCHAIN_NAME = "pico_arm_gcc.cmake"
36
37 VSCODE_LAUNCH_FILENAME = 'launch.json'
38 VSCODE_C_PROPERTIES_FILENAME = 'c_cpp_properties.json'
39 VSCODE_CMAKE_KITS_FILENAME ='cmake-kits.json'
40 VSCODE_SETTINGS_FILENAME ='settings.json'
41 VSCODE_EXTENSIONS_FILENAME ='extensions.json'
42 VSCODE_TASKS_FILENAME ='tasks.json'
43 VSCODE_FOLDER='.vscode'
44
45 CONFIG_UNSET="Not set"
46
47 # Standard libraries for all builds
48 # And any more to string below, space separator
49 STANDARD_LIBRARIES = 'pico_stdlib'
50
51 # Indexed on feature name, tuple contains the C file, the H file and the CMake project name for the feature. 
52 # Some lists may contain an extra/ancillary file needed for that feature
53 GUI_TEXT = 0
54 C_FILE = 1
55 H_FILE = 2
56 LIB_NAME = 3
57 ANCILLARY_FILE = 4
58
59 features_list = {
60     'spi' :             ("SPI",             "spi.c",            "hardware/spi.h",       "hardware_spi",         ""),
61     'i2c' :             ("I2C interface",   "i2c.c",            "hardware/i2c.h",       "hardware_i2c",         ""),
62     'dma' :             ("DMA support",     "dma.c",            "hardware/dma.h",       "hardware_dma",         ""),
63     'pio' :             ("PIO interface",   "pio.c",            "hardware/pio.h",       "hardware_pio",         "blink.pio"),
64     'interp' :          ("HW interpolation", "interp.c",        "hardware/interp.h",    "hardware_interp",      ""),
65     'timer' :           ("HW timer",        "timer.c",          "hardware/timer.h",     "hardware_timer",       ""),
66     'watchdog' :        ("HW watchdog",     "watch.c",          "hardware/watchdog.h",  "hardware_watchdog",    ""),
67     'clocks' :          ("HW clocks",       "clocks.c",         "hardware/clocks.h",    "hardware_clocks",      ""),
68 }
69
70 picow_options_list = {
71     'picow_none' :      ("None", "",                            "",    "",                                                                  ""),
72     'picow_led' :       ("PicoW onboard LED", "",               "pico/cyw43_arch.h",    "pico_cyw43_arch_none",                             ""),
73     'picow_poll' :      ("Polled lwIP",     "",                 "pico/cyw43_arch.h",    "pico_cyw43_arch_lwip_poll",                        "lwipopts.h"),
74     'picow_background' :("Background lwIP", "",                 "pico/cyw43_arch.h",    "pico_cyw43_arch_lwip_threadsafe_background",       "lwipopts.h"),
75 #    'picow_freertos' :  ("Full lwIP (FreeRTOS)", "",            "pico/cyw43_arch.h",    "pico_cyw43_arch_lwip_sys_freertos",                "lwipopts.h"),
76 }
77
78 stdlib_examples_list = {
79     'uart':     ("UART",                    "uart.c",           "hardware/uart.h",      "hardware_uart"),
80     'gpio' :    ("GPIO interface",          "gpio.c",           "hardware/gpio.h",      "hardware_gpio"),
81     'div' :     ("Low level HW Divider",    "divider.c",        "hardware/divider.h",   "hardware_divider")
82 }
83
84 debugger_list = ["DebugProbe (CMSIS-DAP)", "SWD (Pi host)"]
85 debugger_config_list = ["interface/cmsis-dap.cfg", "raspberrypi-swd.cfg"]
86
87 DEFINES = 0
88 INITIALISERS = 1
89 # Could add an extra item that shows how to use some of the available functions for the feature
90 #EXAMPLE = 2
91
92 # This also contains example code for the standard library (see stdlib_examples_list)
93 code_fragments_per_feature = {
94     'uart' : [
95               (
96                 "// UART defines",
97                 "// By default the stdout UART is `uart0`, so we will use the second one",
98                 "#define UART_ID uart1",
99                 "#define BAUD_RATE 9600", "",
100                 "// Use pins 4 and 5 for UART1",
101                 "// Pins can be changed, see the GPIO function select table in the datasheet for information on GPIO assignments",
102                 "#define UART_TX_PIN 4",
103                 "#define UART_RX_PIN 5"
104               ),
105               (
106                 "// Set up our UART",
107                 "uart_init(UART_ID, BAUD_RATE);",
108                 "// Set the TX and RX pins by using the function select on the GPIO",
109                 "// Set datasheet for more information on function select",
110                 "gpio_set_function(UART_TX_PIN, GPIO_FUNC_UART);",
111                 "gpio_set_function(UART_RX_PIN, GPIO_FUNC_UART);",
112                 "// For more examples of UART use see https://github.com/raspberrypi/pico-examples/tree/master/uart"
113               )
114             ],
115     'spi' : [
116               (
117                 "// SPI Defines",
118                 "// We are going to use SPI 0, and allocate it to the following GPIO pins",
119                 "// Pins can be changed, see the GPIO function select table in the datasheet for information on GPIO assignments",
120                 "#define SPI_PORT spi0",
121                 "#define PIN_MISO 16",
122                 "#define PIN_CS   17",
123                 "#define PIN_SCK  18",
124                 "#define PIN_MOSI 19"
125               ),
126               (
127                 "// SPI initialisation. This example will use SPI at 1MHz.",
128                 "spi_init(SPI_PORT, 1000*1000);",
129                 "gpio_set_function(PIN_MISO, GPIO_FUNC_SPI);",
130                 "gpio_set_function(PIN_CS,   GPIO_FUNC_SIO);",
131                 "gpio_set_function(PIN_SCK,  GPIO_FUNC_SPI);",
132                 "gpio_set_function(PIN_MOSI, GPIO_FUNC_SPI);", "",
133                 "// Chip select is active-low, so we'll initialise it to a driven-high state",
134                 "gpio_set_dir(PIN_CS, GPIO_OUT);",
135                 "gpio_put(PIN_CS, 1);",
136                 "// For more examples of SPI use see https://github.com/raspberrypi/pico-examples/tree/master/spi"
137               )
138             ],
139     'i2c' : [
140               (
141                 "// I2C defines",
142                 "// This example will use I2C0 on GPIO8 (SDA) and GPIO9 (SCL) running at 400KHz.",
143                 "// Pins can be changed, see the GPIO function select table in the datasheet for information on GPIO assignments",
144                 "#define I2C_PORT i2c0",
145                 "#define I2C_SDA 8",
146                 "#define I2C_SCL 9",
147               ),
148               (
149                 "// I2C Initialisation. Using it at 400Khz.",
150                 "i2c_init(I2C_PORT, 400*1000);","",
151                 "gpio_set_function(I2C_SDA, GPIO_FUNC_I2C);",
152                 "gpio_set_function(I2C_SCL, GPIO_FUNC_I2C);",
153                 "gpio_pull_up(I2C_SDA);",
154                 "gpio_pull_up(I2C_SCL);",
155                 "// For more examples of I2C use see https://github.com/raspberrypi/pico-examples/tree/master/i2c",
156               )
157             ],
158     "dma" : [
159               (
160                 '// Data will be copied from src to dst',
161                 'const char src[] = "Hello, world! (from DMA)";',
162                 'char dst[count_of(src)];',
163               ),
164               (
165                 '// Get a free channel, panic() if there are none',
166                 'int chan = dma_claim_unused_channel(true);',
167                 '',
168                 '// 8 bit transfers. Both read and write address increment after each',
169                 '// transfer (each pointing to a location in src or dst respectively).',
170                 '// No DREQ is selected, so the DMA transfers as fast as it can.',
171                 '',
172                 'dma_channel_config c = dma_channel_get_default_config(chan);',
173                 'channel_config_set_transfer_data_size(&c, DMA_SIZE_8);',
174                 'channel_config_set_read_increment(&c, true);',
175                 'channel_config_set_write_increment(&c, true);',
176                 '',
177                 'dma_channel_configure(',
178                 '    chan,          // Channel to be configured',
179                 '    &c,            // The configuration we just created',
180                 '    dst,           // The initial write address',
181                 '    src,           // The initial read address',
182                 '    count_of(src), // Number of transfers; in this case each is 1 byte.',
183                 '    true           // Start immediately.',
184                 ');',
185                 '',
186                 '// We could choose to go and do something else whilst the DMA is doing its',
187                 '// thing. In this case the processor has nothing else to do, so we just',
188                 '// wait for the DMA to finish.',
189                 'dma_channel_wait_for_finish_blocking(chan);',
190                 '',
191                 '// The DMA has now copied our text from the transmit buffer (src) to the',
192                 '// receive buffer (dst), so we can print it out from there.',
193                 'puts(dst);',
194               )
195             ],
196
197     "pio" : [
198               (
199                 '#include "blink.pio.h"','',
200                 'void blink_pin_forever(PIO pio, uint sm, uint offset, uint pin, uint freq) {',
201                 '    blink_program_init(pio, sm, offset, pin);',
202                 '    pio_sm_set_enabled(pio, sm, true);',
203                 '',
204                 '    printf("Blinking pin %d at %d Hz\\n", pin, freq);',
205                 '',
206                 '    // PIO counter program takes 3 more cycles in total than we pass as',
207                 '    // input (wait for n + 1; mov; jmp)',
208                 '    pio->txf[sm] = (125000000 / (2 * freq)) - 3;',
209                 '}',
210               ),
211               (
212                 '// PIO Blinking example',
213                 'PIO pio = pio0;',
214                 'uint offset = pio_add_program(pio, &blink_program);',
215                 'printf("Loaded program at %d\\n", offset);',
216                 '',
217                 '#ifdef PICO_DEFAULT_LED_PIN',
218                 'blink_pin_forever(pio, 0, offset, PICO_DEFAULT_LED_PIN, 3);',
219                 '#else',
220                 'blink_pin_forever(pio, 0, offset, 6, 3);',
221                 '#endif',
222                 '// For more pio examples see https://github.com/raspberrypi/pico-examples/tree/master/pio',
223               )
224             ],
225
226     "clocks" :  [
227                   (),
228                   (
229                     'printf("System Clock Frequency is %d Hz\\n", clock_get_hz(clk_sys));',
230                     'printf("USB Clock Frequency is %d Hz\\n", clock_get_hz(clk_usb));',
231                     '// For more examples of clocks use see https://github.com/raspberrypi/pico-examples/tree/master/clocks',
232                   )
233                 ],
234
235     "gpio" : [
236               (
237                 "// GPIO defines",
238                 "// Example uses GPIO 2",
239                 "#define GPIO 2"
240               ),
241               (
242                 "// GPIO initialisation.",
243                 "// We will make this GPIO an input, and pull it up by default",
244                 "gpio_init(GPIO);",
245                 "gpio_set_dir(GPIO, GPIO_IN);",
246                 "gpio_pull_up(GPIO);",
247                 "// See https://github.com/raspberrypi/pico-examples/tree/master/gpio for other gpio examples, including using interrupts",
248               )
249             ],
250     "interp" :[
251                (),
252                (
253                 "// Interpolator example code",
254                 "interp_config cfg = interp_default_config();",
255                 "// Now use the various interpolator library functions for your use case",
256                 "// e.g. interp_config_clamp(&cfg, true);",
257                 "//      interp_config_shift(&cfg, 2);",
258                 "// Then set the config ",
259                 "interp_set_config(interp0, 0, &cfg);",
260                 "// For examples of interpolator use see https://github.com/raspberrypi/pico-examples/tree/master/interp"
261                )
262               ],
263
264     "timer"  : [
265                 (
266                  "int64_t alarm_callback(alarm_id_t id, void *user_data) {",
267                  "    // Put your timeout handler code in here",
268                  "    return 0;",
269                  "}"
270                 ),
271                 (
272                  "// Timer example code - This example fires off the callback after 2000ms",
273                  "add_alarm_in_ms(2000, alarm_callback, NULL, false);",
274                  "// For more examples of timer use see https://github.com/raspberrypi/pico-examples/tree/master/timer"
275                 )
276               ],
277
278     "watchdog":[ (),
279                 (
280                     "// Watchdog example code",
281                     "if (watchdog_caused_reboot()) {",
282                     "    printf(\"Rebooted by Watchdog!\\n\");",
283                     "    // Whatever action you may take if a watchdog caused a reboot",
284                     "}","",
285                     "// Enable the watchdog, requiring the watchdog to be updated every 100ms or the chip will reboot",
286                     "// second arg is pause on debug which means the watchdog will pause when stepping through code",
287                     "watchdog_enable(100, 1);","",
288                     "// You need to call this function at least more often than the 100ms in the enable call to prevent a reboot",
289                     "watchdog_update();",
290                 )
291               ],
292
293     "div"    : [ (),
294                  (
295                     "// Example of using the HW divider. The pico_divider library provides a more user friendly set of APIs ",
296                     "// over the divider (and support for 64 bit divides), and of course by default regular C language integer",
297                     "// divisions are redirected thru that library, meaning you can just use C level `/` and `%` operators and",
298                     "// gain the benefits of the fast hardware divider.",
299                     "int32_t dividend = 123456;",
300                     "int32_t divisor = -321;",
301                     "// This is the recommended signed fast divider for general use.",
302                     "divmod_result_t result = hw_divider_divmod_s32(dividend, divisor);",
303                     "printf(\"%d/%d = %d remainder %d\\n\", dividend, divisor, to_quotient_s32(result), to_remainder_s32(result));",
304                     "// This is the recommended unsigned fast divider for general use.",
305                     "int32_t udividend = 123456;",
306                     "int32_t udivisor = 321;",
307                     "divmod_result_t uresult = hw_divider_divmod_u32(udividend, udivisor);",
308                     "printf(\"%d/%d = %d remainder %d\\n\", udividend, udivisor, to_quotient_u32(uresult), to_remainder_u32(uresult));",
309                     "// See https://github.com/raspberrypi/pico-examples/tree/master/divider for more complex use"
310                  )
311                 ],
312
313     "picow_led":[ (),
314                   (
315                     "// Example to turn on the Pico W LED",
316                     "cyw43_arch_gpio_put(CYW43_WL_GPIO_LED_PIN, 1);"
317                   )
318                 ],
319
320     "picow_wifi":[ (),
321                   (
322                     '// Enable wifi station',
323                     'cyw43_arch_enable_sta_mode();\n',
324                     'printf("Connecting to Wi-Fi...\\n");',
325                     'if (cyw43_arch_wifi_connect_timeout_ms("Your Wi-Fi SSID", "Your Wi-Fi Password", CYW43_AUTH_WPA2_AES_PSK, 30000)) {',
326                     '    printf("failed to connect.\\n");',
327                     '    return 1;',
328                     '} else {',
329                     '    printf("Connected.\\n");',
330                     '    // Read the ip address in a human readable way',
331                     '    uint8_t *ip_address = (uint8_t*)&(cyw43_state.netif[0].ip_addr.addr);',
332                     '    printf("IP address %d.%d.%d.%d\\n", ip_address[0], ip_address[1], ip_address[2], ip_address[3]);',
333                     '}',
334                   )
335                 ]
336 }
337
338 # Add wifi example for poll and background modes
339 code_fragments_per_feature["picow_poll"] = code_fragments_per_feature["picow_wifi"]
340 code_fragments_per_feature["picow_background"] = code_fragments_per_feature["picow_wifi"]
341
342 configuration_dictionary = list(dict())
343
344 isMac = False
345 isWindows = False
346 isx86 = False
347 compilerPath = Path(f"/usr/bin/{COMPILER_NAME()}")
348
349 def relativeSDKPath(sdkVersion):
350     return f"/.pico-sdk/sdk/{sdkVersion}"
351
352 def relativeToolchainPath(toolchainVersion):
353     return f"/.pico-sdk/toolchain/{toolchainVersion}"
354
355 def relativeToolsPath(sdkVersion):
356     return f"/.pico-sdk/tools/{sdkVersion}"
357
358 def relativePicotoolPath(picotoolVersion):
359     return f"/.pico-sdk/picotool/{picotoolVersion}"
360
361 def relativeOpenOCDPath(openocdVersion):
362     return f"/.pico-sdk/openocd/{openocdVersion}"
363
364 def cmakeIncPath():
365     return "${USERHOME}/.pico-sdk/cmake/pico-vscode.cmake"
366
367 def propertiesSdkPath(sdkVersion, force_windows=False, force_non_windows=False):
368     if (isWindows or force_windows) and not force_non_windows:
369         return f"${{env:USERPROFILE}}{relativeSDKPath(sdkVersion)}"
370     else:
371         return f"${{env:HOME}}{relativeSDKPath(sdkVersion)}"
372     
373 def propertiesPicotoolPath(picotoolVersion, force_windows=False, force_non_windows=False):
374     if (isWindows or force_windows) and not force_non_windows:
375         return f"${{env:USERPROFILE}}{relativePicotoolPath(picotoolVersion)}"
376     else:
377         return f"${{env:HOME}}{relativePicotoolPath(picotoolVersion)}"
378
379 def codeSdkPath(sdkVersion):
380     return f"${{userHome}}{relativeSDKPath(sdkVersion)}"
381
382 def codeOpenOCDPath(openocdVersion):
383     return f"${{userHome}}{relativeOpenOCDPath(openocdVersion)}"
384
385 def propertiesToolchainPath(toolchainVersion, force_windows=False, force_non_windows=False):
386     if (isWindows or force_windows) and not force_non_windows:
387         return f"${{env:USERPROFILE}}{relativeToolchainPath(toolchainVersion)}"
388     else:
389         return f"${{env:HOME}}{relativeToolchainPath(toolchainVersion)}"
390
391 def codeToolchainPath(toolchainVersion):
392     return f"${{userHome}}{relativeToolchainPath(toolchainVersion)}"
393
394 def semver_compare_ge(first, second):
395     """ Compare two semantic version strings and return True if the first is greater or equal to the second """
396     first_tuple = tuple(map(int, first.split(".")))
397     second_tuple = tuple(map(int, second.split(".")))
398     
399     assert len(first_tuple) == 3
400     assert len(second_tuple) == 3
401
402     return first_tuple >= second_tuple
403
404 def CheckPrerequisites():
405     global isMac, isWindows, isx86
406     isMac = (platform.system() == 'Darwin')
407     isWindows = (platform.system() == 'Windows')
408     isx86 = (platform.machine().lower() in ['x86_64', 'amd64'])
409
410     # Do we have a compiler?
411     return shutil.which(COMPILER_NAME(), 1, os.environ["Path" if isWindows else "PATH"])
412
413
414 def CheckSDKPath(gui):
415     sdkPath = os.getenv('PICO_SDK_PATH')
416
417     if sdkPath == None:
418         m = 'Unable to locate the Raspberry Pi Pico SDK, PICO_SDK_PATH is not set'
419         print(m)
420     elif not os.path.isdir(sdkPath):
421         m = 'Unable to locate the Raspberry Pi Pico SDK, PICO_SDK_PATH does not point to a directory'
422         print(m)
423         sdkPath = None
424
425     return sdkPath
426
427 def GetFilePath(filename):
428     if os.path.islink(__file__):
429         script_file = os.readlink(__file__)
430     else:
431         script_file = __file__
432     return os.path.join(os.path.dirname(script_file), filename)
433
434 def ParseCommandLine():
435     debugger_flags = ', '.join('{} = {}'.format(i, v) for i, v in enumerate(debugger_list))
436     parser = argparse.ArgumentParser(description='Pico Project generator')
437     parser.add_argument("name", nargs="?", help="Name of the project")
438     parser.add_argument("-t", "--tsv", help="Select an alternative pico_configs.tsv file", default=GetFilePath("pico_configs.tsv"))
439     parser.add_argument("-o", "--output", help="Set an alternative CMakeList.txt filename", default="CMakeLists.txt")
440     parser.add_argument("-x", "--examples", action='store_true', help="Add example code for the Pico standard library")
441     parser.add_argument("-l", "--list", action='store_true', help="List available features")
442     parser.add_argument("-c", "--configs", action='store_true', help="List available project configuration items")
443     parser.add_argument("-f", "--feature", action='append', help="Add feature to generated project")
444     parser.add_argument("-over", "--overwrite", action='store_true', help="Overwrite any existing project AND files")
445     parser.add_argument("-conv", "--convert", action='store_true', help="Convert any existing project - risks data loss")
446     parser.add_argument("-exam", "--example", action='store_true', help="Convert an examples folder to standalone project")
447     parser.add_argument("-b", "--build", action='store_true', help="Build after project created")
448     parser.add_argument("-g", "--gui", action='store_true', help="Run a GUI version of the project generator")
449     parser.add_argument("-p", "--project", action='append', help="Generate projects files for IDE. Options are: vscode")
450     parser.add_argument("-r", "--runFromRAM", action='store_true', help="Run the program from RAM rather than flash")
451     parser.add_argument("-uart", "--uart", action='store_true', default=1, help="Console output to UART (default)")
452     parser.add_argument("-nouart", "--nouart", action='store_true', default=0, help="Disable console output to UART")
453     parser.add_argument("-usb", "--usb", action='store_true', help="Console output to USB (disables other USB functionality")
454     parser.add_argument("-cpp", "--cpp", action='store_true', default=0, help="Generate C++ code")
455     parser.add_argument("-cpprtti", "--cpprtti", action='store_true', default=0, help="Enable C++ RTTI (Uses more memory)")
456     parser.add_argument("-cppex", "--cppexceptions", action='store_true', default=0, help="Enable C++ exceptions (Uses more memory)")
457     parser.add_argument("-d", "--debugger", type=int, help="Select debugger ({})".format(debugger_flags), default=0)
458     parser.add_argument("-board", "--boardtype", action="store", default='pico', help="Select board type (see --boardlist for available boards)")
459     parser.add_argument("-bl", "--boardlist", action="store_true", help="List available board types")
460     parser.add_argument("-cp", "--cpath", help="Override default VSCode compiler path")
461     parser.add_argument("-root", "--projectRoot", help="Override default project root where the new project will be created")
462     parser.add_argument("-sdkVersion", "--sdkVersion", help="Pico SDK version to use (required)")
463     parser.add_argument("-tcVersion", "--toolchainVersion", help="ARM/RISCV Embeded Toolchain version to use (required)")
464     parser.add_argument("-picotoolVersion", "--picotoolVersion", help="Picotool version to use (required)")
465     parser.add_argument("-np", "--ninjaPath", help="Ninja path")
466     parser.add_argument("-cmp", "--cmakePath", help="CMake path")
467     parser.add_argument("-cupy", "--customPython", action='store_true', help="Custom python path used to execute the script.")
468     parser.add_argument("-openOCDVersion", "--openOCDVersion", help="OpenOCD version to use - defaults to 0", default=0)
469
470     return parser.parse_args()
471
472
473 def GenerateMain(folder, projectName, features, cpp):
474
475     if cpp:
476         filename = Path(folder) / (projectName + '.cpp')
477     else:
478         filename = Path(folder) / (projectName + '.c')
479
480     file = open(filename, 'w')
481
482     main = ('#include <stdio.h>\n'
483             '#include "pico/stdlib.h"\n'
484             )
485     file.write(main)
486
487     if (features):
488
489         # Add any includes
490         for feat in features:
491             if (feat in features_list):
492                 if len(features_list[feat][H_FILE]) == 0:
493                     continue
494                 o = f'#include "{features_list[feat][H_FILE]}"\n'
495                 file.write(o)
496             if (feat in stdlib_examples_list):
497                 if len(stdlib_examples_list[feat][H_FILE]) == 0:
498                     continue
499                 o = f'#include "{stdlib_examples_list[feat][H_FILE]}"\n'
500                 file.write(o)
501             if (feat in picow_options_list):
502                 if len(picow_options_list[feat][H_FILE]) == 0:
503                     continue
504                 o = f'#include "{picow_options_list[feat][H_FILE]}"\n'
505                 file.write(o)
506
507         file.write('\n')
508
509         # Add any defines
510         for feat in features:
511             if (feat in code_fragments_per_feature):
512                 for s in code_fragments_per_feature[feat][DEFINES]:
513                     file.write(s)
514                     file.write('\n')
515                 file.write('\n')
516
517     main = ('\n\n'
518             'int main()\n'
519             '{\n'
520             '    stdio_init_all();\n\n'
521             )
522
523     if any([feat in picow_options_list and feat != "picow_none" for feat in features]):
524         main += (
525             '    // Initialise the Wi-Fi chip\n'
526             '    if (cyw43_arch_init()) {\n'
527             '        printf("Wi-Fi init failed\\n");\n'
528             '        return -1;\n'
529             '    }\n\n')
530
531     if (features):
532         # Add any initialisers
533         indent = 4
534         for feat in features:
535             if (feat in code_fragments_per_feature):
536                 for s in code_fragments_per_feature[feat][INITIALISERS]:
537                     main += (" " * indent)
538                     main += s
539                     main += '\n'
540                 main += '\n'
541
542     main += ('    while (true) {\n'
543              '        printf("Hello, world!\\n");\n'
544              '        sleep_ms(1000);\n'
545              '    }\n'
546              '}\n'
547             )
548
549     file.write(main)
550
551     file.close()
552
553
554 def GenerateCMake(folder, params):
555     filename = Path(folder) / CMAKELIST_FILENAME
556     projectName = params['projectName']
557     board_type = params['boardtype']
558
559     # OK, for the path, CMake will accept forward slashes on Windows, and thats
560     # seemingly a bit easier to handle than the backslashes
561     # macOS and Linux do accept backslashes in folder names, therefore it needs an extra case
562     p = str(params['sdkPath']).replace('\\','/') if not isWindows else str(params['sdkPath'])
563
564     cmake_header1 = (f"# Generated Cmake Pico project file\n\n"
565                  "cmake_minimum_required(VERSION 3.13)\n\n"
566                  "set(CMAKE_C_STANDARD 11)\n"
567                  "set(CMAKE_CXX_STANDARD 17)\n"
568                  "set(CMAKE_EXPORT_COMPILE_COMMANDS ON)\n\n"
569                  "# Initialise pico_sdk from installed location\n"
570                  "# (note this can come from environment, CMake cache etc)\n\n"
571                 )
572
573     # if you change the do never edit headline you need to change the check for it in extension.mts
574     cmake_header_us = (
575                 "# == DO NEVER EDIT THE NEXT LINES for Raspberry Pi Pico VS Code Extension to work ==\n"
576                 "if(WIN32)\n"
577                 "    set(USERHOME $ENV{USERPROFILE})\n"
578                 "else()\n"
579                 "    set(USERHOME $ENV{HOME})\n"
580                 "endif()\n"
581                 f"set(sdkVersion {params['sdkVersion']})\n"
582                 f"set(toolchainVersion {params['toolchainVersion']})\n"
583                 f"set(picotoolVersion {params['picotoolVersion']})\n"
584                 f"include({cmakeIncPath()})\n"
585                 "# ====================================================================================\n"
586                 )
587
588     cmake_header2 = (
589                  f"set(PICO_BOARD {board_type} CACHE STRING \"Board type\")\n\n"
590                  "# Pull in Raspberry Pi Pico SDK (must be before project)\n"
591                  "include(pico_sdk_import.cmake)\n\n"
592                  f"project({projectName} C CXX ASM)\n"
593                 )
594
595     cmake_header3 = (
596                 "\n# Initialise the Raspberry Pi Pico SDK\n"
597                 "pico_sdk_init()\n\n"
598                 "# Add executable. Default name is the project name, version 0.1\n\n"
599                 )
600
601
602     if params['wantConvert']:
603         with open(filename, 'r+') as file:
604             content = file.read()
605             file.seek(0)
606             lines = file.readlines()
607             file.seek(0)
608             if not params['wantExample']:
609                 # Prexisting CMake configuration - just adding cmake_header_us
610                 file.write(cmake_header_us)
611                 file.write(content)
612             else:
613                 if any(["pico_cyw43_arch_lwip_threadsafe_background" in line for line in lines]):
614                     print("Threadsafe Background")
615                     params["wantThreadsafeBackground"] = True
616                 if any(["pico_cyw43_arch_lwip_poll" in line for line in lines]):
617                     print("Poll")
618                     params["wantPoll"] = True
619                 # Get project name
620                 for line in lines:
621                     if "add_executable" in line:
622                         newProjectName = line.split('(')[1].split()[0].strip().strip("()")
623                         if params["wantThreadsafeBackground"] or params["wantPoll"]:
624                             newProjectName = newProjectName.replace("_background", "")
625                             newProjectName = newProjectName.replace("_poll", "")
626                         print("New project name", newProjectName)
627                         cmake_header2 = cmake_header2.replace(projectName, newProjectName)
628                 # Write all headers
629                 file.write(cmake_header1)
630                 file.write(cmake_header_us)
631                 file.write(cmake_header2)
632                 file.write(cmake_header3)
633                 file.flush()
634                 # Remove example_auto_set_url
635                 for i, line in enumerate(lines):
636                     if "example_auto_set_url" in line:
637                         lines[i] = ""
638                         print("Removed", line, lines[i])
639                 file.writelines(lines)
640         return
641
642
643     file = open(filename, 'w')
644
645     file.write(cmake_header1)
646     file.write(cmake_header_us)
647     file.write(cmake_header2)
648
649     if params['exceptions']:
650         file.write("\nset(PICO_CXX_ENABLE_EXCEPTIONS 1)\n")
651
652     if params['rtti']:
653         file.write("\nset(PICO_CXX_ENABLE_RTTI 1)\n")
654
655     file.write(cmake_header3)
656
657     # add the preprocessor defines for overall configuration
658     if params['configs']:
659         file.write('# Add any PICO_CONFIG entries specified in the Advanced settings\n')
660         for c, v in params['configs'].items():
661             if v == "True":
662                 v = "1"
663             elif v == "False":
664                 v = "0"
665             file.write(f'add_compile_definitions({c} = {v})\n')
666         file.write('\n')
667
668     # No GUI/command line to set a different executable name at this stage
669     executableName = projectName
670
671     if params['wantCPP']:
672         file.write(f'add_executable({projectName} {projectName}.cpp )\n\n')
673     else:
674         file.write(f'add_executable({projectName} {projectName}.c )\n\n')
675
676     file.write(f'pico_set_program_name({projectName} "{executableName}")\n')
677     file.write(f'pico_set_program_version({projectName} "0.1")\n\n')
678
679     if params['wantRunFromRAM']:
680         file.write(f'# no_flash means the target is to run from RAM\n')
681         file.write(f'pico_set_binary_type({projectName} no_flash)\n\n')
682
683     # Add pio output
684     if params['features'] and "pio" in params['features']:
685         file.write(f'# Generate PIO header\n')
686         file.write(f'pico_generate_pio_header({projectName} ${{CMAKE_CURRENT_LIST_DIR}}/blink.pio)\n\n')
687
688     # Console output destinations
689     file.write("# Modify the below lines to enable/disable output over UART/USB\n")
690     if params['wantUART']:
691         file.write(f'pico_enable_stdio_uart({projectName} 1)\n')
692     else:
693         file.write(f'pico_enable_stdio_uart({projectName} 0)\n')
694
695     if params['wantUSB']:
696         file.write(f'pico_enable_stdio_usb({projectName} 1)\n\n')
697     else:
698         file.write(f'pico_enable_stdio_usb({projectName} 0)\n\n')
699
700     # If we need wireless, check for SSID and password
701     # removed for the moment as these settings are currently only needed for the pico-examples
702     # but may be required in here at a later date.
703     if False:
704         if 'ssid' in params or 'password' in params:
705             file.write('# Add any wireless access point information\n')
706             file.write(f'target_compile_definitions({projectName} PRIVATE\n')
707             if 'ssid' in params:
708                 file.write(f'WIFI_SSID=\" {params["ssid"]} \"\n')
709             else:
710                 file.write(f'WIFI_SSID=\"${WIFI_SSID}\"')
711
712             if 'password' in params:
713                 file.write(f'WIFI_PASSWORD=\"{params["password"]}\"\n')
714             else:
715                 file.write(f'WIFI_PASSWORD=\"${WIFI_PASSWORD}\"')
716             file.write(')\n\n')
717
718     # Standard libraries
719     file.write('# Add the standard library to the build\n')
720     file.write(f'target_link_libraries({projectName}\n')
721     file.write("        " + STANDARD_LIBRARIES)
722     file.write(')\n\n')
723
724     # Standard include directories
725     file.write('# Add the standard include files to the build\n')
726     file.write(f'target_include_directories({projectName} PRIVATE\n')
727     file.write("  ${CMAKE_CURRENT_LIST_DIR}\n")
728     file.write("  ${CMAKE_CURRENT_LIST_DIR}/.. # for our common lwipopts or any other standard includes, if required\n")
729     file.write(')\n\n')
730
731     # Selected libraries/features
732     if (params['features']):
733         file.write('# Add any user requested libraries\n')
734         file.write(f'target_link_libraries({projectName} \n')
735         for feat in params['features']:
736             if (feat in features_list):
737                 file.write("        " + features_list[feat][LIB_NAME] + '\n')
738             if (feat in picow_options_list):
739                 file.write("        " + picow_options_list[feat][LIB_NAME] + '\n')
740         file.write('        )\n\n')
741
742     file.write(f'pico_add_extra_outputs({projectName})\n\n')
743
744     file.close()
745
746
747 # Generates the requested project files, if any
748 def generateProjectFiles(projectPath, projectName, sdkPath, projects, debugger, sdkVersion, toolchainVersion, picotoolVersion, ninjaPath, cmakePath, customPython, openOCDVersion):
749
750     oldCWD = os.getcwd()
751
752     os.chdir(projectPath)
753
754     debugger = debugger_config_list[debugger]
755
756     if debugger == "raspberrypi-swd.cfg":
757         shutil.copyfile(sourcefolder + "/" +  "raspberrypi-swd.cfg", projectPath / "raspberrypi-swd.cfg")
758
759     # Need to escape windows files paths backslashes
760     # TODO: env in currently not supported in compilerPath var
761     #cPath = f"${{env:PICO_TOOLCHAIN_PATH_{envSuffix}}}" + os.path.sep + os.path.basename(str(compilerPath).replace('\\', '\\\\' ))
762     cPath = compilerPath.as_posix() + (".exe" if isWindows else "")
763
764     # if this is a path in the .pico-sdk homedir tell the settings to use the homevar
765     user_home = os.path.expanduser("~").replace("\\", "/")
766     use_home_var = f"{user_home}/.pico-sdk" in ninjaPath
767
768     openocd_path = ""
769     server_path = "\n            \"serverpath\"" # Because no \ in f-strings
770     openocd_path_os = Path(user_home, relativeOpenOCDPath(openOCDVersion).replace("/", "", 1), "openocd.exe")
771     if os.path.exists(openocd_path_os):
772         openocd_path = f'{codeOpenOCDPath(openOCDVersion)}/openocd.exe'
773
774     for p in projects :
775         if p == 'vscode':
776             launch = f'''{{
777     "version": "0.2.0",
778     "configurations": [
779         {{
780             "name": "Pico Debug (Cortex-Debug)",
781             "cwd": "{"${workspaceRoot}" if not openocd_path else f"{codeOpenOCDPath(openOCDVersion)}/scripts"}",
782             "executable": "${{command:raspberry-pi-pico.launchTargetPath}}",
783             "request": "launch",
784             "type": "cortex-debug",
785             "servertype": "openocd",\
786 {f'{server_path}: "{openocd_path}",' if openocd_path else ""}
787             "gdbPath": "${{command:raspberry-pi-pico.getGDBPath}}",
788             "device": "${{command:raspberry-pi-pico.getChip}}",
789             "configFiles": [
790                 "{debugger}",
791                 "target/${{command:raspberry-pi-pico.getTarget}}.cfg"
792             ],
793             "svdFile": "{codeSdkPath(sdkVersion)}/src/${{command:raspberry-pi-pico.getChip}}/hardware_regs/${{command:raspberry-pi-pico.getChip}}.svd",
794             "runToEntryPoint": "main",
795             // Fix for no_flash binaries, where monitor reset halt doesn't do what is expected
796             // Also works fine for flash binaries
797             "overrideLaunchCommands": [
798                 "monitor reset init",
799                 "load \\"${{command:raspberry-pi-pico.launchTargetPath}}\\""
800             ],
801             "openOCDLaunchCommands": [
802                 "adapter speed 5000"
803             ]
804         }},
805         {{
806             "name": "Pico Debug (Cortex-Debug with external OpenOCD)",
807             "cwd": "${{workspaceRoot}}",
808             "executable": "${{command:raspberry-pi-pico.launchTargetPath}}",
809             "request": "launch",
810             "type": "cortex-debug",
811             "servertype": "external",
812             "gdbTarget": "localhost:3333",
813             "gdbPath": "${{command:raspberry-pi-pico.getGDBPath}}",
814             "device": "${{command:raspberry-pi-pico.getChip}}",
815             "svdFile": "{codeSdkPath(sdkVersion)}/src/${{command:raspberry-pi-pico.getChip}}/hardware_regs/${{command:raspberry-pi-pico.getChip}}.svd",
816             "runToEntryPoint": "main",
817             // Give restart the same functionality as runToEntryPoint - main
818             "postRestartCommands": [
819                 "break main",
820                 "continue"
821             ]
822         }},
823         {{
824             "name": "Pico Debug (C++ Debugger)",
825             "type": "cppdbg",
826             "request": "launch",
827             "cwd": "${{workspaceRoot}}",
828             "program": "${{command:raspberry-pi-pico.launchTargetPath}}",
829             "MIMode": "gdb",
830             "miDebuggerPath": "${{command:raspberry-pi-pico.getGDBPath}}",
831             "miDebuggerServerAddress": "localhost:3333",
832             "debugServerPath": "{openocd_path if openocd_path else "openocd"}",
833             "debugServerArgs": "-f {debugger} -f target/${{command:raspberry-pi-pico.getTarget}}.cfg -c \\"adapter speed 5000\\"",
834             "serverStarted": "Listening on port .* for gdb connections",
835             "filterStderr": true,
836             "hardwareBreakpoints": {{
837                 "require": true,
838                 "limit": 4
839             }},
840             "preLaunchTask": "Flash",
841             "svdPath": "{codeSdkPath(sdkVersion)}/src/${{command:raspberry-pi-pico.getChip}}/hardware_regs/${{command:raspberry-pi-pico.getChip}}.svd"
842         }},
843     ]
844 }}
845 '''
846
847             base_headers_folder_name = "pico_base_headers" if semver_compare_ge(sdkVersion, "2.0.0") else "pico_base"
848             properties = f'''{{
849     "configurations": [
850         {{
851             "name": "Pico",
852             "includePath": [
853                 "${{workspaceFolder}}/**",
854                 "{codeSdkPath(sdkVersion)}/**"
855             ],
856             "forcedInclude": [
857                 "{codeSdkPath(sdkVersion)}/src/common/{base_headers_folder_name}/include/pico.h",
858                 "${{workspaceFolder}}/build/generated/pico_base/pico/config_autogen.h"
859             ],
860             "defines": [],
861             "compilerPath": "{cPath}",
862             "compileCommands": "${{workspaceFolder}}/build/compile_commands.json",
863             "cStandard": "c17",
864             "cppStandard": "c++14",
865             "intelliSenseMode": "linux-gcc-arm"
866         }}
867     ],
868     "version": 4
869 }}
870 '''
871
872             pythonExe = sys.executable.replace("\\", "/").replace(user_home, "${HOME}") if use_home_var else sys.executable
873
874             # kits
875             kits = f'''[
876     {{
877         "name": "Pico",
878         "compilers": {{
879             "C": "{cPath}",
880             "CXX": "{cPath}"
881         }},
882         "toolchainFile": "{propertiesSdkPath(sdkVersion)}/cmake/preload/toolchains/{CMAKE_TOOLCHAIN_NAME}",
883         "environmentVariables": {{
884             "PATH": "${{command:raspberry-pi-pico.getEnvPath}};${{env:PATH}}"
885         }},
886         "cmakeSettings": {{
887             "Python3_EXECUTABLE": "${{command:raspberry-pi-pico.getPythonPath}}"
888         }}
889     }}
890 ]'''
891
892             # settings
893             settings = f'''{{
894     "cmake.options.statusBarVisibility": "hidden",
895     "cmake.options.advanced": {{
896         "build": {{
897             "statusBarVisibility": "hidden"
898         }},
899         "launch": {{
900             "statusBarVisibility": "hidden"
901         }},
902         "debug": {{
903             "statusBarVisibility": "hidden"
904         }}
905     }},
906     "cmake.configureOnEdit": false,
907     "cmake.automaticReconfigure": false,
908     "cmake.configureOnOpen": false,
909     "cmake.generator": "Ninja",
910     "cmake.cmakePath": "{cmakePath.replace(user_home, "${userHome}") if use_home_var else cmakePath}",
911     "C_Cpp.debugShortcut": false,
912     "terminal.integrated.env.windows": {{
913         "PICO_SDK_PATH": "{propertiesSdkPath(sdkVersion, force_windows=True)}",
914         "PICO_TOOLCHAIN_PATH": "{propertiesToolchainPath(toolchainVersion, force_windows=True)}",
915         "Path": "\
916 {propertiesToolchainPath(toolchainVersion, force_windows=True)}/bin;\
917 {propertiesPicotoolPath(picotoolVersion, force_windows=True)}/picotool;\
918 {os.path.dirname(cmakePath.replace(user_home, "${env:USERPROFILE}") if use_home_var else cmakePath)};\
919 {os.path.dirname(ninjaPath.replace(user_home, "${env:USERPROFILE}") if use_home_var else ninjaPath)};\
920 ${{env:PATH}}"
921     }},
922     "terminal.integrated.env.osx": {{
923         "PICO_SDK_PATH": "{propertiesSdkPath(sdkVersion, force_non_windows=True)}",
924         "PICO_TOOLCHAIN_PATH": "{propertiesToolchainPath(toolchainVersion, force_non_windows=True)}",
925         "PATH": "\
926 {propertiesToolchainPath(toolchainVersion, force_non_windows=True)}/bin:\
927 {propertiesPicotoolPath(picotoolVersion, force_non_windows=True)}/picotool:\
928 {os.path.dirname(cmakePath.replace(user_home, "${env:HOME}") if use_home_var else cmakePath)}:\
929 {os.path.dirname(ninjaPath.replace(user_home, "${env:HOME}") if use_home_var else ninjaPath)}:\
930 ${{env:PATH}}"
931     }},
932     "terminal.integrated.env.linux": {{
933         "PICO_SDK_PATH": "{propertiesSdkPath(sdkVersion, force_non_windows=True)}",
934         "PICO_TOOLCHAIN_PATH": "{propertiesToolchainPath(toolchainVersion, force_non_windows=True)}",
935         "PATH": "\
936 {propertiesToolchainPath(toolchainVersion, force_non_windows=True)}/bin:\
937 {propertiesPicotoolPath(picotoolVersion, force_non_windows=True)}/picotool:\
938 {os.path.dirname(cmakePath.replace(user_home, "${env:HOME}") if use_home_var else cmakePath)}:\
939 {os.path.dirname(ninjaPath.replace(user_home, "${env:HOME}") if use_home_var else ninjaPath)}:\
940 ${{env:PATH}}"
941     }},
942     "raspberry-pi-pico.cmakeAutoConfigure": true,
943     "raspberry-pi-pico.useCmakeTools": false,
944     "raspberry-pi-pico.cmakePath": "{cmakePath.replace(user_home, "${HOME}") if use_home_var else cmakePath}",
945     "raspberry-pi-pico.ninjaPath": "{ninjaPath.replace(user_home, "${HOME}") if use_home_var else ninjaPath}"'''
946
947             if customPython:
948                 settings += f''',
949     "raspberry-pi-pico.python3Path": "{pythonExe}"'''
950                 
951             settings += '\n}\n'
952
953             # extensions
954             extensions = f'''{{
955     "recommendations": [
956         "marus25.cortex-debug",
957         "ms-vscode.cpptools",
958         "ms-vscode.cpptools-extension-pack",
959         "ms-vscode.vscode-serial-monitor",
960         "raspberry-pi.raspberry-pi-pico",
961     ]
962 }}
963 '''
964             tasks = f'''{{
965     "version": "2.0.0",
966     "tasks": [
967         {{
968             "label": "Compile Project",
969             "type": "process",
970             "isBuildCommand": true,
971             "command": "{ninjaPath.replace(user_home, "${userHome}") if use_home_var else ninjaPath}",
972             "args": ["-C", "${{workspaceFolder}}/build"],
973             "group": "build",
974             "presentation": {{
975                 "reveal": "always",
976                 "panel": "dedicated"
977             }},
978             "problemMatcher": "$gcc",
979             "windows": {{
980                 "command": "{ninjaPath.replace(user_home, "${env:USERPROFILE}") if use_home_var else ninjaPath}.exe"
981             }}
982         }},
983         {{
984             "label": "Run Project",
985             "type": "process",
986             "command": "{propertiesPicotoolPath(picotoolVersion, force_non_windows=True)}/picotool/picotool",
987             "args": [
988                 "load",
989                 "${{command:raspberry-pi-pico.launchTargetPath}}",
990                 "-fx"
991             ],
992             "presentation": {{
993                 "reveal": "always",
994                 "panel": "dedicated"
995             }},
996             "problemMatcher": [],
997             "windows": {{
998                 "command": "{propertiesPicotoolPath(picotoolVersion, force_windows=True)}/picotool/picotool.exe"
999             }}
1000         }},
1001         {{
1002             "label": "Flash",
1003             "type": "process",
1004             "command": "{openocd_path if openocd_path else "openocd"}",
1005             "args": [
1006                 "-s",
1007                 "{codeOpenOCDPath(openOCDVersion)}/scripts",
1008                 "-f",
1009                 "{debugger}",
1010                 "-f",
1011                 "target/${{command:raspberry-pi-pico.getTarget}}.cfg",
1012                 "-c",
1013                 "adapter speed 5000; program \\"${{command:raspberry-pi-pico.launchTargetPath}}\\" verify reset exit"
1014             ],
1015             "problemMatcher": [],
1016             "windows": {{
1017                 "command": "{openocd_path.replace("${userHome}", "${env:USERPROFILE}") if openocd_path else "openocd"}",
1018             }}
1019         }}
1020     ]
1021 }}
1022 '''
1023
1024             # Create a build folder, and run our cmake project build from it
1025             if not os.path.exists(VSCODE_FOLDER):
1026                 os.mkdir(VSCODE_FOLDER)
1027
1028             os.chdir(VSCODE_FOLDER)
1029
1030             file = open(VSCODE_TASKS_FILENAME, 'w')
1031             file.write(tasks)
1032             file.close()
1033
1034             filename = VSCODE_LAUNCH_FILENAME
1035             file = open(filename, 'w')
1036             file.write(launch)
1037             file.close()
1038
1039             file = open(VSCODE_C_PROPERTIES_FILENAME, 'w')
1040             file.write(properties)
1041             file.close()
1042
1043             file = open(VSCODE_CMAKE_KITS_FILENAME, 'w')
1044             file.write(kits)
1045             file.close()
1046
1047             file = open(VSCODE_SETTINGS_FILENAME, 'w')
1048             file.write(settings)
1049             file.close()
1050
1051             file = open(VSCODE_EXTENSIONS_FILENAME, 'w')
1052             file.write(extensions)
1053             file.close()
1054
1055         else :
1056             print('Unknown project type requested')
1057
1058     os.chdir(oldCWD)
1059
1060
1061 def LoadConfigurations():
1062     try:
1063         with open(args.tsv) as tsvfile:
1064             reader = csv.DictReader(tsvfile, dialect='excel-tab')
1065             for row in reader:
1066                 configuration_dictionary.append(row)
1067     except:
1068         print("No Pico configurations file found. Continuing without")
1069
1070 def LoadBoardTypes(sdkPath):
1071     # Scan the boards folder for all header files, extract filenames, and make a list of the results
1072     # default folder is <PICO_SDK_PATH>/src/boards/include/boards/*
1073     # If the PICO_BOARD_HEADER_DIRS environment variable is set, use that as well
1074
1075     loc = sdkPath / "src/boards/include/boards"
1076     boards=[]
1077     for x in Path(loc).iterdir():
1078         if x.suffix == '.h':
1079             boards.append(x.stem)
1080
1081     loc = os.getenv('PICO_BOARD_HEADER_DIRS')
1082
1083     if loc != None:
1084         for x in Path(loc).iterdir():
1085             if x.suffix == '.h':
1086                 boards.append(x.stem)
1087
1088     return boards
1089
1090 def DoEverything(parent, params):
1091     global CMAKE_TOOLCHAIN_NAME
1092
1093     if not os.path.exists(params['projectRoot']):
1094         print('Invalid project path')
1095         sys.exit(-1)
1096
1097     oldCWD = os.getcwd()
1098     os.chdir(params['projectRoot'])
1099
1100     # Create our project folder as subfolder
1101     os.makedirs(params['projectName'], exist_ok=True)
1102
1103     os.chdir(params['projectName'])
1104
1105     projectPath = params['projectRoot'] / params['projectName']
1106
1107     # First check if there is already a project in the folder
1108     # If there is we abort unless the overwrite flag it set
1109     if os.path.exists(CMAKELIST_FILENAME):
1110         if not (params['wantOverwrite'] or params['wantConvert']):
1111             print('There already appears to be a project in this folder. Use the --overwrite option to overwrite the existing project')
1112             sys.exit(-1)
1113
1114         # We should really confirm the user wants to overwrite
1115         #print('Are you sure you want to overwrite the existing project files? (y/N)')
1116         #c = input().split(" ")[0]
1117         #if c != 'y' and c != 'Y' :
1118         #    sys.exit(0)
1119
1120     # Copy the SDK finder cmake file to our project folder
1121     # Can be found here <PICO_SDK_PATH>/external/pico_sdk_import.cmake
1122     shutil.copyfile(params['sdkPath'] / 'external' / 'pico_sdk_import.cmake', projectPath / 'pico_sdk_import.cmake' )
1123
1124     if params['features']:
1125         features_and_examples = params['features'][:]
1126     else:
1127         features_and_examples= []
1128
1129     if params['wantExamples']:
1130         features_and_examples = list(stdlib_examples_list.keys()) + features_and_examples
1131
1132     if not (params['wantConvert']):
1133         GenerateMain(projectPath, params['projectName'], features_and_examples, params['wantCPP'])
1134
1135         # If we have any ancilliary files, copy them to our project folder
1136         # Currently only the picow with lwIP support needs an extra file, so just check that list
1137         for feat in features_and_examples:
1138             if feat in features_list:
1139                 if features_list[feat][ANCILLARY_FILE] != "":
1140                     shutil.copy(sourcefolder + "/" + features_list[feat][ANCILLARY_FILE], projectPath / features_list[feat][ANCILLARY_FILE])
1141             if feat in picow_options_list:
1142                 if picow_options_list[feat][ANCILLARY_FILE] != "":
1143                     shutil.copy(sourcefolder + "/" + picow_options_list[feat][ANCILLARY_FILE], projectPath / picow_options_list[feat][ANCILLARY_FILE])
1144
1145     GenerateCMake(projectPath, params)
1146
1147     if params['wantExample']:
1148         if params['wantThreadsafeBackground'] or params['wantPoll']:
1149             # Write lwipopts for examples
1150             shutil.copy(sourcefolder + "/" + "lwipopts.h", projectPath / "lwipopts.h")
1151
1152     # Create a build folder, and run our cmake project build from it
1153     if not os.path.exists('build'):
1154         os.mkdir('build')
1155
1156     os.chdir('build')
1157
1158     # If we are overwriting a previous project, we should probably clear the folder, but that might delete something the users thinks is important, so
1159     # for the moment, just delete the CMakeCache.txt file as certain changes may need that to be recreated.
1160
1161     if os.path.exists(CMAKECACHE_FILENAME):
1162         os.remove(CMAKECACHE_FILENAME)
1163
1164     cpus = os.cpu_count()
1165     if cpus == None:
1166         cpus = 1
1167
1168     if isWindows:
1169         if shutil.which("ninja") or (params["ninjaPath"] != None and params["ninjaPath"] != ""):
1170             # When installing SDK version 1.5.0 on windows with installer pico-setup-windows-x64-standalone.exe, ninja is used 
1171             cmakeCmd = params['cmakePath'] + ' -DCMAKE_BUILD_TYPE=Debug -G Ninja ..'
1172             makeCmd = params['ninjaPath'] + ' '        
1173         else:
1174             # Everything else assume nmake
1175             cmakeCmd = params['cmakePath'] + ' -DCMAKE_BUILD_TYPE=Debug -G "NMake Makefiles" ..'
1176             makeCmd = 'nmake '
1177     else:
1178         # Ninja now works OK under Linux, so if installed use it by default. It's faster.
1179         if shutil.which("ninja") or (params["ninjaPath"] != None and params["ninjaPath"] != ""):
1180             cmakeCmd = params['cmakePath'] + ' -DCMAKE_BUILD_TYPE=Debug -G Ninja ..'
1181             makeCmd = params['ninjaPath'] + ' '
1182         else:
1183             cmakeCmd = params['cmakePath'] + ' -DCMAKE_BUILD_TYPE=Debug ..'
1184             makeCmd = 'make -j' + str(cpus)
1185
1186     os.system(cmakeCmd)
1187
1188     # Extract CMake Toolchain File
1189     if os.path.exists(CMAKECACHE_FILENAME):
1190         cacheFile = open(CMAKECACHE_FILENAME, "r")
1191         for line in cacheFile:
1192             if re.search("CMAKE_TOOLCHAIN_FILE:FILEPATH=", line):
1193                 CMAKE_TOOLCHAIN_NAME = line.split("=")[-1].split("/")[-1].strip()
1194
1195     if params['projects']:
1196         generateProjectFiles(
1197             projectPath, 
1198             params['projectName'], 
1199             params['sdkPath'], 
1200             params['projects'], 
1201             params['debugger'], 
1202             params["sdkVersion"], 
1203             params["toolchainVersion"], 
1204             params["picotoolVersion"], 
1205             params["ninjaPath"], 
1206             params["cmakePath"],
1207             params["customPython"],
1208             params["openOCDVersion"])
1209
1210     if params['wantBuild']:
1211         os.system(makeCmd)
1212         print('\nIf the application has built correctly, you can now transfer it to the Raspberry Pi Pico board')
1213
1214     os.chdir(oldCWD)
1215
1216
1217 ###################################################################################
1218 # main execution starteth here
1219
1220 sourcefolder = os.path.dirname(os.path.abspath(__file__))
1221
1222 args = ParseCommandLine()
1223
1224 if args.nouart:
1225     args.uart = False
1226
1227 if args.debugger > len(debugger_list) - 1:
1228     args.debugger = 0
1229
1230 if "RISCV" in args.toolchainVersion:
1231     if "COREV" in args.toolchainVersion:
1232         COMPILER_TRIPLE = COREV_TRIPLE
1233     else:
1234         COMPILER_TRIPLE = RISCV_TRIPLE
1235
1236 # Check we have everything we need to compile etc
1237 c = CheckPrerequisites()
1238
1239 ## TODO Do both warnings in the same error message so user does have to keep coming back to find still more to do
1240
1241 if c == None:
1242     m = f'Unable to find the `{COMPILER_NAME()}` compiler\n'
1243     m +='You will need to install an appropriate compiler to build a Raspberry Pi Pico project\n'
1244     m += 'See the Raspberry Pi Pico documentation for how to do this on your particular platform\n'
1245
1246     print(m)
1247     sys.exit(-1)
1248
1249 if args.name == None and not args.gui and not args.list and not args.configs and not args.boardlist:
1250     print("No project name specfied\n")
1251     sys.exit(-1)
1252
1253 # Check if we were provided a compiler path, and override the default if so
1254 if args.cpath:
1255     compilerPath = Path(args.cpath)
1256 elif args.toolchainVersion:
1257     compilerPath = Path(codeToolchainPath(args.toolchainVersion)+"/bin/"+COMPILER_NAME())
1258 else:
1259     compilerPath = Path(c)
1260
1261 # load/parse any configuration dictionary we may have
1262 LoadConfigurations()
1263
1264 p = CheckSDKPath(args.gui)
1265
1266 if p == None:
1267     sys.exit(-1)
1268
1269 sdkPath = Path(p)
1270
1271 boardtype_list = LoadBoardTypes(sdkPath)
1272 boardtype_list.sort()
1273
1274 projectRoot = Path(os.getcwd()) if not args.projectRoot else Path(args.projectRoot)
1275
1276 if args.list or args.configs or args.boardlist:
1277     if args.list:
1278         print("Available project features:\n")
1279         for feat in features_list:
1280             print(feat.ljust(6), '\t', features_list[feat][GUI_TEXT])
1281         print('\n')
1282
1283     if args.configs:
1284         print("Available project configuration items:\n")
1285         for conf in configuration_dictionary:
1286             print(conf['name'].ljust(40), '\t', conf['description'])
1287         print('\n')
1288
1289     if args.boardlist:
1290         print("Available board types:\n")
1291         for board in boardtype_list:
1292             print(board)
1293         print('\n')
1294
1295     sys.exit(0)
1296 else :
1297     params={
1298         'sdkPath'       : sdkPath,
1299         'projectRoot'   : projectRoot,
1300         'projectName'   : args.name,
1301         'wantGUI'       : False,
1302         'wantOverwrite' : args.overwrite,
1303         'wantConvert'   : args.convert or args.example,
1304         'wantExample'   : args.example,
1305         'wantThreadsafeBackground'  : False,
1306         'wantPoll'                  : False,
1307         'boardtype'     : args.boardtype,
1308         'wantBuild'     : args.build,
1309         'features'      : args.feature,
1310         'projects'      : args.project,
1311         'configs'       : (),
1312         'wantRunFromRAM': args.runFromRAM,
1313         'wantExamples'  : args.examples,
1314         'wantUART'      : args.uart,
1315         'wantUSB'       : args.usb,
1316         'wantCPP'       : args.cpp,
1317         'debugger'      : args.debugger,
1318         'exceptions'    : args.cppexceptions,
1319         'rtti'          : args.cpprtti,
1320         'ssid'          : '',
1321         'password'      : '',
1322         'sdkVersion'    : args.sdkVersion,
1323         'toolchainVersion': args.toolchainVersion,
1324         'picotoolVersion': args.picotoolVersion,
1325         'ninjaPath'     : args.ninjaPath,
1326         'cmakePath'     : args.cmakePath,
1327         'customPython'  : args.customPython,
1328         'openOCDVersion': args.openOCDVersion
1329         }
1330
1331     DoEverything(None, params)
1332     sys.exit(0)
This page took 0.102125 seconds and 2 git commands to generate.