Update base files

README.md

@@ -1,3 +1,92 @@
-# embedded-distro-files
-
-Files required for the booting of the Snickerdoodle board. Useful for porting a distribution of preference to ARMv7
+
+     _           .    .     _
+    | \         | \  | \   / |
+    | | __  ___ | |_ | | __| |
+    | |/ / / __|| __|| |/ /| |
+    |   < | /   | |_ |   < | |
+    |_|\_\|_|    \__ |_|\_\|_|
+
+    krtkl.com
+
+    snickerdoodle Ubuntu 20.04 SD Card README
+================================================================================
+
+The BOOT partition of this SD card (where this file is located) must contain the
+bootable components for the snickerdoodle and/or baseboard that the card will
+be used on. The BOOT partition contains a set of folders; each with the
+necessary boot components for a single system. To configure the SD card for the
+corresponding system, copy the contents of the folder into the top level
+of the BOOT partition.
+
+
+Boot Components
+================================
+
+By default, this SD card image contains the Linux kernel, U-Boot script and a
+couple of configuration files at the top level directory. These are files that
+are normally used by all configurations, although some customization may be
+desired to fit a specific application.
+
+This un-configured SD card image does have the necessary bootloader or
+devicetree at the top level directory to boot the system. Before attempting to
+boot with this SD card, a boot.bin (bootloader) and devicetree.dtb (devicetree)
+must be added. To use a pre-built configuration, simply copy the contents of
+the directory to the top level of the BOOT partition. Below is an overview of
+the top-level files that should be found in the BOOT partition before booting:
+
+boot.bin*
+devicetree.dtb*
+system.bit**
+uImage
+uEnv.txt
+config.txt
+uboot.scr
+
+* Needs to be copied before booting
+** Optional, needs to be copied before booting
+
+
+Prebuilt Configurations
+================================
+
+The BOOT partition of this SD card contains basic configurations for each
+snickerdoodle variant and various baseboards. Each configuration is represented
+by a directory containing the boot files. To boot a prebuilt configuration, copy
+the contents of the directory to the top level of the BOOT partition and insert
+the SD card into J6 on the snickerdoodle.
+
+
+snickerdoodle Configuration
+================================
+
+The config.txt file is used by the Linux init scripts to configure users and
+network settings. This file can be used to pre-configure the wireless access
+point and/or station network settings before booting. It can also be used to
+pre-configure user passwords in anticipation of remote login. See the config.txt
+file for details on setting network and system configuration parameters.
+
+
+Additional Configuration
+================================
+
+The uEnv.txt file contains additional configuration options such as setting the
+ethernet MAC (hardware) address and specifying the boot arguments. This file
+is read by U-Boot and can be used to specify a bitstream (system.bit by default)
+to be loaded by U-Boot.
+
+
+Runtime and Pre-Boot Configuration
+================================
+
+Various peripheral and boot settings are configured during runtime, or during
+the boot process, by snickerdoodle's platform microcontroller. Examples include:
+customizing LED behavior, antenna selection, and setting the boot mode. The
+necessary 'spi-ctrl' application and an accompanying README can be found in the
+/usr/local/bin directory. Visit krtkl.com/downloads for updates.
+
+
+Devicetree and Linux Kernel Sources
+================================
+
+For reference, devicetree (e.g. .dts, .dtsi) and Linux kernel sources have been
+included in the /usr/local/src directory.

config.txt

@@ -0,0 +1,57 @@
+#
+# snickerdoodle configuration
+#
+# This file is used to update user and network settings during boot.
+#
+
+#### Wireless access point (AP) configuration ##################################
+
+# Set wireless access point SSID (add "double quotes" if entry includes spaces)
+#ap_ssid=mySnickerdoodleWiFi
+
+# Set wireless access point WPA passphrase
+# MUST BE AT LEAST 8 CHARACTERS
+#ap_passphrase=superSecretPassphrase
+
+# Set access point IP address (also sets DHCP subnet)
+#ap_address=10.0.110.2
+
+# Set access point mode: Can be 'hw_mode=g' (2.4GHz) or 'hw_mode=a' (5GHz)
+#ap_hw_mode=g
+
+# Set access point channel
+# 2.4GHz (hw_mode=g) available channels: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
+# 5GHz (hw_mode=a) available channels: 36, 38, 40, 42, 44, 46, 48, 149, 153, 157, 161, 165
+#ap_channel=7
+
+#### Wireless station (STA) configuration ######################################
+
+# Set wireless network mode
+#sta_mode=wpa
+
+# Set wireless network SSID (add "double quotes" if entry includes spaces)
+#sta_ssid=myNetworkName
+
+# Set wireless network key
+#sta_key=myNetworkPassphrase
+
+#### User configuration ########################################################
+
+# Update user passwords with a comma delimited list of "user:password"
+#update_users=user1:password1,user2:password2
+
+#### Ethernet (if present) network configurations ##############################
+
+# Set Ethernet IP configuration: Can be 'dhcp', 'static', or 'disabled'
+# MUST BE SET TO ENABLE INTERFACE
+#eth0_mode=static
+
+# Set Ethernet IP address (if mode is set to 'static')
+#eth0_address=10.1.1.100
+
+# Set Ethernet netmask (if not specified, uses 255.255.255.0)
+#eth0_netmask=255.255.255.0
+
+#eth1_mode=static
+#eth1_address=10.2.2.100
+#eth1_netmask=255.255.255.0

uEnv.txt

@@ -0,0 +1,8 @@
+bootargs=console=ttyPS0,115200 root=/dev/mmcblk0p2 rootfstype=ext4 rw rootwait earlyprink uio_pdrv_genirq.of_id=krtkl,generic-uio,ui_pdrv
+bitstream_image=system.bit
+#ethaddr=6c:5c:3d:a0:00:00
+#eth1addr=6c:5c:3d:a0:00:01
+script_image=uboot.scr
+script_load_address=0x4000000
+uenvcmd=if test -e mmc 0 ${script_image}; then load mmc 0 ${script_load_address} ${script_image} && source ${script_load_address}; fi
+