updated readme for make

Author: daysgobye

.gitignore

@@ -1,3 +1,7 @@
 cpy/**
+__pycache__/
+debug.log
 !cpy/.gitkeep 
+kmk/**
+!kmk/.gitkeep 
 post_build.sh

Makefile

@@ -4,6 +4,8 @@
 # @version 0.4
 
 CPYPREFIX := cpy/circuitpython
+KMKPREFIX := kmk/kmk_firmware
+THIS_DIR := $(dir $(abspath $(firstword $(MAKEFILE_LIST))))
 
 .PHONY: default
 default: run
@@ -13,12 +15,15 @@ all: init build
 
 .PHONY: clean
 clean:
-	rm -rf ${CPYPREFIX}
+	sudo rm -rf ${CPYPREFIX}
+	sudo rm -rf ${KMKPREFIX}
 
+J=1
 .PHONY: run
 run:
-	python3 main.py
+	python3 main.py $(J)
 	docker pull boardsource/bs-python
-	docker run -v $(pwd)/build_out:/build_out -v $(pwd)/cpy/circuitpython:/cpy/circuitpython boardsource/bs-python && bash post_build.sh
+	docker run -v ${THIS_DIR}cpy/circuitpython:/cpy/circuitpython boardsource/bs-python 
+	bash post_build.sh
 
 # end

README.md

@@ -6,11 +6,12 @@ So the main idea here and how we are doing this differently is we as you can see
 Let me break down what's going on and how you can use this. I will start by going over the code flow then I will tell you what you need to edit (if you need to edit anything) and how you can help out
 
 ## Quick links
-[current boards](supported_boards.md)
+[Current Boards](supported_boards.md)
 
 
 
 ## **important**
+We just got a make file thanks to kdb424 <3 So at this time you can also run everything from the make file and bash scripts 
 All scripts are intended to be run from the root so
 
 **dont** do this
@@ -23,24 +24,31 @@ bash start.sh
 bash scripts/start.sh
 ```
 
+You can also make your builds faster with 
+```
+ make run J=12
+```
+J is your cpu cores 
+
+
 
 
 ## Code flow
-* scipts/start.sh <- entry point
+* scipts/start.sh OR "make run" <- entry point
     * calls main.py
         * main.py <- start of the code
             * cpy_git <- handles all things to do with git
                 * clone the repo
                 * add submodules
             * misc_file_changes <- change cpy code
             * board_mapping <- this moves BS_python boards into the right place in cpy
-                * genarates the build script and post build script
+                * generates the build script and post build script
         * pulls the docker container or uses the one you build (see below)
         * starts the new docker container
             * runs the dockersetupcmd.sh
                 *  this sets up the cloned cpy repo for building
-            * runs the genarated build script that builds all the BS_Python boards
-        * runs the genarated post build script
+            * runs the generated build script that builds all the BS_Python boards
+        * runs the generated post build script
             * this moves all of the built .u2f files into the ./build_out and renames them
 
 
@@ -51,7 +59,7 @@ below are the other scripts you can run and what they do
     * builds docker container
         * that way you only need docker and python you don't need to make sure you can compile cpy
     * tries to push it as well.
-* scripts/clean.sh
+* scripts/clean.sh or "make clean"
     * removes old cpy clones and builds.
 * scripts/bash-container.sh
     * this is mostly for debugging the docker container
@@ -66,19 +74,23 @@ So you will want to copy that board from the cpy folder (run main.py to get that
 
 ## Freeze a lib that is not in CPY
 To freeze  another library you can simply add it to the FROZEN_REPO_LIST in cpy_git.py
+### Frozen libs already available 
+* kmk_firmware
+* Adafruit_CircuitPython_DisplayIO_SSD1306
+* Adafruit_CircuitPython_SSD1306
 
-## other code changes
+## Other code changes
 Above is all that I have implemented But if you want to make random changes to the CPY code base feel free to do so. A few things I would like to ask of you. Make sure that the entry for your code is in misc_file_changes.py (unless another file is better eg: git changes should be in cpy_git.py). And make sure you add something to this file letting others know how to do your cool new change.
 
-## TODO / HELP WANTED / DISCLAMER
+## TODO / HELP WANTED / DISCLAIMER
 * typo / spelling
 * let me know if I need to make any more changes to stay legal
 * Add some boards
-* turn all my sick bash scripts into a make file LOL
-* freeze in kmk in some way. But I want it compiled to .mpy
-* I am a super python noob I barely know how to setup a python project. This one was setup using pipenv and python 3.9.x we dont have a reqerments.txt I dont know how to make one or if we need one we do have a pipfile tho.
+* I am a super python noob I barely know how to setup a python project. This one was setup using pipenv and python 3.9.x we dont have a requirements.txt I dont know how to make one or if we need one we do have a pipfile tho.
 * github action to add all the .uf2s from ./build_out to git hub releases
 * add colors to the logs (just the python parts)
+* inject custom code into circuitpython/supervisor/shared/filesystem.c to change the drive name and default code after we are freezing in kmk we will be able to have a u2f that is for cornes and it comes typing and working perfectly
+
 
 
 

board_mapping.py

@@ -13,22 +13,22 @@ def generate_build_script():
         file.write(post_build_script)
     print(f'making build script in "{build_script_path}"')
 
-def add_board_to_build_script_board(board,board_dir):
+def add_board_to_build_script_board(board,board_dir,cpu_cores):
     global build_script
     global post_build_script
     build_script+=f'cd ports/{board_dir}\n'
-    build_script+=f'make BOARD={board}\n'
-    build_script+=f'sleep 100\n'
+    build_script+=f'make -j{cpu_cores} BOARD={board}\n'
+    # build_script+=f'sleep 50\n'
     build_script+=f'cd ../..\n'
     post_build_script+=f'cp ./cpy/circuitpython/ports/{board_dir}/build-{board}/firmware.uf2 ./build_out/{board}.uf2\n'
 
-def move_boards():
+def move_boards(cpu_cores):
     for subdir in os.listdir(board_dir):
         board_type = f'{board_dir}/{subdir}'
         for board in os.listdir(board_dir+"/"+subdir):
             board_dest =f'{cpy_dir}/ports/{subdir}/boards/{board}' 
             board_src= f'{board_dir}/{subdir}/{board}'
             shutil.copytree(board_src, board_dest) 
             print(f'moving {board} from {board_src} to {board_dest}')
-            add_board_to_build_script_board(board,subdir)
+            add_board_to_build_script_board(board,subdir,cpu_cores)
     generate_build_script()

bs_python_boards/nrf/nice_nano_bs/mpconfigboard.mk

@@ -8,4 +8,5 @@ MCU_CHIP = nrf52840
 INTERNAL_FLASH_FILESYSTEM = 1
 
 FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_BLE
-FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_NeoPixel
+FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_NeoPixel
+# FROZEN_MPY_DIRS += $(TOP)/frozen/kmk

bs_python_boards/raspberrypi/boardsouce_lulu/board.c

@@ -0,0 +1,45 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "supervisor/board.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "src/rp2_common/hardware_gpio/include/hardware/gpio.h"
+#include "supervisor/shared/board.h"
+
+void board_init(void) {
+}
+
+bool board_requests_safe_mode(void) {
+    return false;
+}
+
+void reset_board(void) {
+    // turn off any left over LED
+    board_reset_user_neopixels(&pin_GPIO29, 62);
+}
+
+void board_deinit(void) {
+}

bs_python_boards/raspberrypi/boardsouce_lulu/mpconfigboard.h

@@ -0,0 +1,4 @@
+#define MICROPY_HW_BOARD_NAME "lulu"
+#define MICROPY_HW_MCU_NAME "rp2040"
+
+#define MICROPY_HW_NEOPIXEL (&pin_GPIO29)

bs_python_boards/raspberrypi/boardsouce_lulu/mpconfigboard.mk

@@ -0,0 +1,15 @@
+USB_VID = 0x4273
+USB_PID = 0x7685
+USB_PRODUCT = "Lulu"
+USB_MANUFACTURER = "Boardsource"
+
+CHIP_VARIANT = RP2040
+CHIP_FAMILY = rp2
+
+EXTERNAL_FLASH_DEVICES = "W25Q16JVxQ"
+
+FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_NeoPixel
+FROZEN_MPY_DIRS += $(TOP)/frozen/kmk
+
+
+# CIRCUITPY__EVE = 1

bs_python_boards/raspberrypi/boardsouce_lulu/pico-sdk-configboard.h

@@ -0,0 +1,4 @@
+// Put board-specific pico-sdk definitions here. This file must exist.
+
+// Allow extra time for xosc to start.
+#define PICO_XOSC_STARTUP_DELAY_MULTIPLIER 64

bs_python_boards/raspberrypi/boardsouce_lulu/pins.c

@@ -0,0 +1,49 @@
+#include "shared-bindings/board/__init__.h"
+
+STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
+    CIRCUITPYTHON_BOARD_DICT_STANDARD_ITEMS
+
+    { MP_ROM_QSTR(MP_QSTR_TX), MP_ROM_PTR(&pin_GPIO0) },
+    { MP_ROM_QSTR(MP_QSTR_RX), MP_ROM_PTR(&pin_GPIO1) },
+    { MP_ROM_QSTR(MP_QSTR_GP02), MP_ROM_PTR(&pin_GPIO2) },
+    { MP_ROM_QSTR(MP_QSTR_GP03), MP_ROM_PTR(&pin_GPIO3) },
+    { MP_ROM_QSTR(MP_QSTR_GP04), MP_ROM_PTR(&pin_GPIO4) },
+    { MP_ROM_QSTR(MP_QSTR_GP05), MP_ROM_PTR(&pin_GPIO5) },
+    { MP_ROM_QSTR(MP_QSTR_GP06), MP_ROM_PTR(&pin_GPIO6) },
+    { MP_ROM_QSTR(MP_QSTR_GP07), MP_ROM_PTR(&pin_GPIO7) },
+    { MP_ROM_QSTR(MP_QSTR_GP08), MP_ROM_PTR(&pin_GPIO8) },
+    { MP_ROM_QSTR(MP_QSTR_GP09), MP_ROM_PTR(&pin_GPIO9) },
+    { MP_ROM_QSTR(MP_QSTR_GP10), MP_ROM_PTR(&pin_GPIO10) },
+    { MP_ROM_QSTR(MP_QSTR_GP11), MP_ROM_PTR(&pin_GPIO11) },
+    { MP_ROM_QSTR(MP_QSTR_GP12), MP_ROM_PTR(&pin_GPIO12) },
+    { MP_ROM_QSTR(MP_QSTR_GP13), MP_ROM_PTR(&pin_GPIO13) },
+    { MP_ROM_QSTR(MP_QSTR_GP14), MP_ROM_PTR(&pin_GPIO14) },
+    { MP_ROM_QSTR(MP_QSTR_GP15), MP_ROM_PTR(&pin_GPIO15) },
+    { MP_ROM_QSTR(MP_QSTR_GP16), MP_ROM_PTR(&pin_GPIO16) },
+    { MP_ROM_QSTR(MP_QSTR_GP17), MP_ROM_PTR(&pin_GPIO17) },
+    { MP_ROM_QSTR(MP_QSTR_GP18), MP_ROM_PTR(&pin_GPIO18) },
+
+    { MP_ROM_QSTR(MP_QSTR_GP21), MP_ROM_PTR(&pin_GPIO21) },
+    { MP_ROM_QSTR(MP_QSTR_GP22), MP_ROM_PTR(&pin_GPIO22) },
+    { MP_ROM_QSTR(MP_QSTR_GP23), MP_ROM_PTR(&pin_GPIO23) },
+    { MP_ROM_QSTR(MP_QSTR_GP24), MP_ROM_PTR(&pin_GPIO24) },
+
+    { MP_ROM_QSTR(MP_QSTR_GP24), MP_ROM_PTR(&pin_GPIO24) },
+    { MP_ROM_QSTR(MP_QSTR_GP25), MP_ROM_PTR(&pin_GPIO25) },
+    { MP_ROM_QSTR(MP_QSTR_GP26), MP_ROM_PTR(&pin_GPIO26) },
+    { MP_ROM_QSTR(MP_QSTR_GP27), MP_ROM_PTR(&pin_GPIO27) },
+    { MP_ROM_QSTR(MP_QSTR_GP28), MP_ROM_PTR(&pin_GPIO28) },
+    { MP_ROM_QSTR(MP_QSTR_GP29), MP_ROM_PTR(&pin_GPIO29) },
+
+    { MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_GPIO22) },
+    { MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_GPIO23) },
+
+    { MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_GPIO26) },
+    { MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_GPIO28) },
+    { MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_GPIO27) },
+
+    { MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
+    { MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
+
+};
+MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);