Linted firmware files, added descriptions to functions (#942)

Added descriptions to most functions in the firmware and cleaned up the
mess of a code in general in anticipation for the v2 kit release

Friend/firmware/firmware_v1.0/CMakeLists.txt

@@ -10,14 +10,13 @@ target_sources(app PRIVATE
     src/transport.c
     src/mic.c
     src/led.c
-    src/audio.c
     src/codec.c
-	src/nfc.c
     src/lib/battery/battery.c
     src/button.c
     src/speaker.c
     src/sdcard.c
     src/storage.c
+	# src/nfc.c future release
 )
 
 target_sources_ifdef(CONFIG_CODEC_OPUS app PRIVATE
@@ -168,3 +167,4 @@ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DHAVE_CONFIG_H")
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DHAVE_ALLOCA_H")
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsingle-precision-constant") # A lot of constants are written as doubles
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DHAVE_LRINT -DHAVE_LRINTF")
+

Friend/firmware/firmware_v1.0/prj_xiao_ble_sense_devkitv2-adafruit.conf

@@ -22,15 +22,17 @@ CONFIG_BT_MAX_PAIRED=1
 CONFIG_BT_DEVICE_APPEARANCE=22
 CONFIG_BT_GATT_DYNAMIC_DB=y
 
+#
 # Max transmit power supported by nRF52840
+#
+
 CONFIG_BT_CTLR_TX_PWR_ANTENNA=8
 CONFIG_BT_PHY_UPDATE=y
 
-# CONFIG_BT_L2CAP_DYNAMIC_CHANNEL=y
-# CONFIG_BT_SMP=y
-# CONFIG_BT_LL_SW_SPLIT=y # Alternative implementation
-
+#
 # Battery and Device Information services
+#
+
 CONFIG_BT_BAS=y
 CONFIG_BT_DIS=y
 CONFIG_BT_DIS_PNP=n
@@ -41,7 +43,10 @@ CONFIG_BT_DIS_HW_REV=y
 CONFIG_BT_DIS_FW_REV_STR="1.0.5"
 CONFIG_BT_DIS_HW_REV_STR="Seeed Xiao BLE Sense"
 
-# Large packets
+#
+# Large BLE packets / BLE Buffers 
+#
+
 CONFIG_BT_L2CAP_TX_MTU=498
 CONFIG_BT_L2CAP_TX_BUF_COUNT=10
 # CONFIG_BT_ATT_TX_COUNT=10
@@ -55,27 +60,32 @@ CONFIG_BT_AUTO_DATA_LEN_UPDATE=y
 CONFIG_BT_USER_PHY_UPDATE=y
 CONFIG_BT_AUTO_PHY_UPDATE=y
 
-# Codecs
-# CONFIG_LIBLC3=y
-
+#
 # Debug
+#
 # Enable the lines below to enable debug logs via UART/USB
 
 # CONFIG_DEBUG=y
-# CONFIG_DEBUG_OPTIMIZATIONS=y
 # CONFIG_LOG=y
 # CONFIG_LOG_PRINTK=y
 # CONFIG_LOG_MODE_IMMEDIATE=y
+# CONFIG_DEBUG_OPTIMIZATIONS=y
 # CONFIG_SERIAL=y
 # CONFIG_UART_CONSOLE=y
 # CONFIG_LOG_BACKEND_UART=y
 # CONFIG_LOG_BACKEND_UART_OUTPUT_TEXT=y
 # CONFIG_LOG_DEFAULT_LEVEL=3
 
+#
 # Debug (This value breaks some builds)
+#
+
 # CONFIG_ASSERT=y
 
+#
 # Log Levels
+#
+
 # CONFIG_BT_DEBUG_LOG=y
 # CONFIG_BT_L2CAP_LOG_LEVEL_DBG=y
 # CONFIG_BT_LOG_LEVEL_DBG=y
@@ -90,14 +100,15 @@ CONFIG_BT_AUTO_PHY_UPDATE=y
 # CONFIG_BT_RX_STACK_SIZE=4096
 # CONFIG_BT_CTLR_RX_PRIO_STACK_SIZE=4096
 
-# RTT
-# CONFIG_UART_CONSOLE=n
-# CONFIG_SEGGER_RTT_BUFFER_SIZE_UP=2048
-# CONFIG_RTT_CONSOLE=y
-# CONFIG_LOG_BACKEND_RTT=y
+#
+# Codecs
+#
 CONFIG_CODEC_OPUS=y
 
+#
 # SD Card Support (all devices required)
+#
+
 CONFIG_OFFLINE_STORAGE=y
 CONFIG_DISK_ACCESS=y
 CONFIG_FILE_SYSTEM=y
@@ -110,62 +121,52 @@ CONFIG_MAIN_STACK_SIZE=5096
 # CONFIG_SPI=y
 CONFIG_HEAP_MEM_POOL_SIZE=3048
 
-# # SD Card for Arduino Audio BFF (v2 device)
-# CONFIG_MMC_STACK=y
-# CONFIG_SDMMC_STACK=y
-# # CONFIG_SDIO_STACK=y
-# CONFIG_DISK_DRIVER_SDMMC=y
-# CONFIG_SDHC=y
-# CONFIG_SPI_SDHC=y
-
-# SD Card Support
-# CONFIG_DISK_DRIVER_SDMMC=y
-# CONFIG_MMC_STACK=y
-# CONFIG_SDMMC_STACK=y
-# CONFIG_SPI=y
-# CONFIG_SDHC=y
-# CONFIG_SPI_SDHC=y
-
-# File System
-# CONFIG_FILE_SYSTEM=y
-# CONFIG_FAT_FILESYSTEM_ELM=y
-# CONFIG_FS_FATFS_LFN=y
-# CONFIG_FS_FATFS_READ_ONLY=n
-# CONFIG_FS_FATFS_MOUNT_MKFS=y
-# CONFIG_FS_FATFS_EXFAT=y
-
+#
 # Increase stack and heap sizes
+#
+
 CONFIG_MAIN_STACK_SIZE=8192
 CONFIG_HEAP_MEM_POOL_SIZE=4096
 
+#
 # Disable unused peripherals
-# CONFIG_I2C=n
+#
+CONFIG_I2C=n
 # CONFIG_NRFX_TWIM0=n
 # CONFIG_NRFX_TWIM1=n
 
-# Disable LSM6DSL sensor (accelerometer and gyroscope)
-CONFIG_LSM6DSL=n
+#
+# LSM6DSL sensor (accelerometer and gyroscope)
+#
+CONFIG_LSM6DSL=y
 CONFIG_LSM6DSL_ENABLE_TEMP=n
-CONFIG_LSM6DSL_TRIGGER_GLOBAL_THREAD=y
+# CONFIG_LSM6DSL_TRIGGER_GLOBAL_THREAD=y
 CONFIG_SENSOR=y
+
+#
 # Speaker
+#
 CONFIG_I2S=y
 CONFIG_I2S_NRFX=y
 CONFIG_SPI_NRFX=y
 
-# NFC
-CONFIG_NFC_T2T_NRFXLIB=y
-CONFIG_NFC_NDEF=y
-CONFIG_NFC_NDEF_MSG=y
-CONFIG_NFC_NDEF_RECORD=y
-CONFIG_NFC_NDEF_URI_MSG=y
-CONFIG_NFC_NDEF_URI_REC=y
-CONFIG_HWINFO=y
-
-#THE ACCELEROMETER
-CONFIG_ACCELEROMETER=n
-#ENABLE THE BUTTON!
-CONFIG_ENABLE_BUTTON=n
-#ENABLE THE SPEAKER
-CONFIG_ENABLE_SPEAKER=n
+#
+# NFC (in the future)
+#
+
+# CONFIG_NFC_T2T_NRFXLIB=y
+# CONFIG_NFC_NDEF=y
+# CONFIG_NFC_NDEF_MSG=y
+# CONFIG_NFC_NDEF_RECORD=y
+# CONFIG_NFC_NDEF_URI_MSG=y
+# CONFIG_NFC_NDEF_URI_REC=y
+# CONFIG_HWINFO=y
+
+#
+#EVERYTHING ELSE
+#
+
+CONFIG_ACCELEROMETER=y
+CONFIG_ENABLE_BUTTON=y
+CONFIG_ENABLE_SPEAKER=y