Merge pull request #70 from uhi22/copilot/add-release-qcaflash-build-config

Add ReleaseQCAFlash build with integrated QCA7k flash programming

Author: uhi22

Makefile

@@ -23,6 +23,7 @@ BINARY		= stm32_ccs
 SIZE        = $(PREFIX)-size
 CC		      = $(PREFIX)-gcc
 CPP	      = $(PREFIX)-g++
+AS		      = $(PREFIX)-g++
 LD		      = $(PREFIX)-gcc
 OBJCOPY		= $(PREFIX)-objcopy
 OBJDUMP		= $(PREFIX)-objdump
@@ -33,6 +34,7 @@ CFLAGS		= -Os -Iinclude/ -Ilibopeninv/include -Ilibopencm3/include -Iexi -Iccs \
 CPPFLAGS    = -Os -ggdb -Wall -Wextra -Iinclude/ -Ilibopeninv/include -Ilibopencm3/include -Iexi -Iccs \
 				-fno-common -std=c++11 -pedantic -DSTM32F1 -DUSART_BAUDRATE=921600 \
 				-ffunction-sections -fdata-sections -fno-builtin -fno-rtti -fno-exceptions -fno-unwind-tables -mcpu=cortex-m3 -mthumb
+ASFLAGS     = $(CPPFLAGS) -x assembler-with-cpp
 # Check if the variable GITHUB_RUN_NUMBER exists. When running on the github actions running, this
 # variable is automatically available.
 # Create a compiler define with the content of the variable. Or, if it does not exist, use replacement value 0.
@@ -56,11 +58,19 @@ OBJSL		  = main.o hwinit.o stm32scheduler.o params.o terminal.o terminal_prj.o \
 				 BitInputStream.o dinEXIDatatypesEncoder.o MethodsBag.o \
 				 BitOutputStream.o dinEXIDatatypes.o projectExiConnector.o
 
+ifneq ($(filter ReleaseQCAFlash,$(MAKECMDGOALS)),)
+CFLAGS      += -Iplcboot -DENABLE_PLCBOOT
+CPPFLAGS    += -Iplcboot -DENABLE_PLCBOOT
+ASFLAGS     += -Iplcboot -DENABLE_PLCBOOT
+OBJSL       += plcboot/plcboot.o plcboot/embedded_images.o plcboot/embedded_images_data.o
+endif
+
 
 OBJS     = $(patsubst %.o,obj/%.o, $(OBJSL))
 DEPENDS := $(patsubst %.o,obj/%.d, $(OBJSL))
 vpath %.c src/ libopeninv/src exi/ ccs/
 vpath %.cpp src/ libopeninv/src exi/ ccs/
+vpath %.s plcboot/
 
 OPENOCD_BASE	= /usr
 OPENOCD		= $(OPENOCD_BASE)/bin/openocd
@@ -95,6 +105,7 @@ LDFLAGS	+= $(call ld-option,--no-warn-rwx-segments)
 all: directories images
 Debug:images
 Release: images
+ReleaseQCAFlash: images
 cleanDebug:clean
 images: $(BINARY)
 	@printf "  OBJCOPY $(BINARY).bin\n"
@@ -116,12 +127,19 @@ $(BINARY): $(OBJS) $(LDSCRIPT)
 
 $(OUT_DIR)/%.o: %.c Makefile
 	@printf "  CC      $(subst $(shell pwd)/,,$(@))\n"
+	$(Q)$(MKDIR_P) $(dir $@)
 	$(Q)$(CC) $(CFLAGS) -MMD -MP -o $@ -c $<
 
 $(OUT_DIR)/%.o: %.cpp Makefile
 	@printf "  CPP     $(subst $(shell pwd)/,,$(@))\n"
+	$(Q)$(MKDIR_P) $(dir $@)
 	$(Q)$(CPP) $(CPPFLAGS) $(EXTRACOMPILERFLAGS) -MMD -MP -o $@ -c $<
 
+$(OUT_DIR)/%.o: %.s Makefile
+	@printf "  AS      $(subst $(shell pwd)/,,$(@))\n"
+	$(Q)$(MKDIR_P) $(dir $@)
+	$(Q)$(AS) $(ASFLAGS) $(EXTRACOMPILERFLAGS) -MMD -MP -o $@ -c $<
+
 clean:
 	@printf "  CLEAN   ${OUT_DIR}\n"
 	$(Q)rm -rf ${OUT_DIR}

ccs/homeplug.cpp

@@ -1,6 +1,9 @@
 /* Homeplug message handling */
 
 #include "ccs32_globals.h"
+#ifdef ENABLE_PLCBOOT
+#include "plcboot.h"
+#endif
 
 
 
@@ -509,7 +512,6 @@ void evaluateGetSwCnf(void)
    uint8_t i, x;
    char strMac[20];
    addToTrace(MOD_HOMEPLUG, "[PEVSLAC] received GET_SW.CNF");
-   numberOfSoftwareVersionResponses+=1;
    for (i=0; i<6; i++)
    {
       sourceMac[i] = myethreceivebuffer[6+i];
@@ -519,6 +521,7 @@ void evaluateGetSwCnf(void)
    if ((verLen>0) && (verLen<0x30))
    {
       char strVersion[200];
+      bool handledByPlcboot = false;
 
       for (i=0; i<verLen; i++)
       {
@@ -530,6 +533,9 @@ void evaluateGetSwCnf(void)
          strVersion[i]=x;
       }
       strVersion[i] = 0;
+#ifdef ENABLE_PLCBOOT
+      handledByPlcboot = plcboot_handle_software_version(strVersion, sourceMac);
+#endif
       if (Param::GetInt(Param::logging) & MOD_HOMEPLUG) {
          sprintf(strMac, "%02x:%02x:%02x:%02x:%02x:%02x", sourceMac[0], sourceMac[1], sourceMac[2], sourceMac[3], sourceMac[4], sourceMac[5]);
          printf("For MAC %s ", strMac);
@@ -545,6 +551,13 @@ void evaluateGetSwCnf(void)
       OledLine3 = StringVersion.substring(22, 33);
       OledLine4 = StringVersion.substring(33, 44);
 #endif
+      if (!handledByPlcboot)
+      {
+         /* BootLoader responses start the flashing path and must not be counted as
+            an operational modem, otherwise the normal SLAC flow would continue in
+            parallel with the flash sequence. */
+         numberOfSoftwareVersionResponses+=1;
+      }
    }
 }
 
@@ -837,14 +850,20 @@ static void evaluateGetKeyCnf(void) {}
 
 void evaluateReceivedHomeplugPacket(void)
 {
+   uint16_t mmtype = getManagementMessageType();
+
    if (connMgr_getConnectionLevel()==100) {
        /* we have TCP traffic running, so we ignore all homeplug management packets. This
        makes us robust against cross-talk from other charging cables.
        Discussion here: https://github.com/uhi22/ccs32clara/issues/24 */
        addToTrace(MOD_HOMEPLUG, "[HOMEPLUG] Ignoring homeplug message, because high level communication is ongoing.");
        return;
    }
-   switch (getManagementMessageType())
+#ifdef ENABLE_PLCBOOT
+   if (plcboot_handle_homeplug_packet(mmtype, myethreceivebuffer, myethreceivebufferLen))
+      return;
+#endif
+   switch (mmtype)
    {
    case CM_GET_KEY + MMTYPE_CNF:
       evaluateGetKeyCnf();

ccs/qca7000.h

@@ -2,9 +2,15 @@
 
 /* Global Defines */
 
+#ifdef ENABLE_PLCBOOT
+#define MY_SPI_TX_RX_BUFFER_SIZE 1600
+#define MY_ETH_TRANSMIT_BUFFER_LEN 1500
+#define MY_ETH_RECEIVE_BUFFER_LEN 1500
+#else
 #define MY_SPI_TX_RX_BUFFER_SIZE 1100
 #define MY_ETH_TRANSMIT_BUFFER_LEN 250
 #define MY_ETH_RECEIVE_BUFFER_LEN 250
+#endif
 
 #ifdef __cplusplus
 extern "C" {

plcboot/embedded_images.cpp

@@ -0,0 +1,24 @@
+#include "embedded_images.h"
+
+extern "C" {
+extern const uint8_t _binary_softloader_nvm_start[];
+extern const uint8_t _binary_softloader_nvm_end[];
+extern const uint8_t _binary_firmware_nvm_start[];
+extern const uint8_t _binary_firmware_nvm_end[];
+extern const uint8_t _binary_pev_pib_start[];
+extern const uint8_t _binary_pev_pib_end[];
+}
+
+const embedded_images_t *embedded_images(void)
+{
+    static embedded_images_t img;
+
+    img.softloader.data = _binary_softloader_nvm_start;
+    img.softloader.size = (uint32_t)(_binary_softloader_nvm_end - _binary_softloader_nvm_start);
+    img.firmware.data = _binary_firmware_nvm_start;
+    img.firmware.size = (uint32_t)(_binary_firmware_nvm_end - _binary_firmware_nvm_start);
+    img.pib.data = _binary_pev_pib_start;
+    img.pib.size = (uint32_t)(_binary_pev_pib_end - _binary_pev_pib_start);
+
+    return &img;
+}

plcboot/embedded_images.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <stdint.h>
+
+typedef struct {
+    const uint8_t *data;
+    uint32_t size;
+} embedded_image_t;
+
+typedef struct {
+    embedded_image_t softloader;
+    embedded_image_t firmware;
+    embedded_image_t pib;
+} embedded_images_t;
+
+const embedded_images_t *embedded_images(void);

plcboot/embedded_images_data.s

@@ -0,0 +1,32 @@
+/* Embedded QCA flash images */
+
+    .section .rodata
+    .align 4
+
+    .global _binary_softloader_nvm_start
+    .type   _binary_softloader_nvm_start, %object
+_binary_softloader_nvm_start:
+    .incbin "flash/softloader.nvm"
+_binary_softloader_nvm_end:
+    .global _binary_softloader_nvm_end
+    .type   _binary_softloader_nvm_end, %object
+
+    .align 4
+
+    .global _binary_firmware_nvm_start
+    .type   _binary_firmware_nvm_start, %object
+_binary_firmware_nvm_start:
+    .incbin "flash/firmware.nvm"
+_binary_firmware_nvm_end:
+    .global _binary_firmware_nvm_end
+    .type   _binary_firmware_nvm_end, %object
+
+    .align 4
+
+    .global _binary_pev_pib_start
+    .type   _binary_pev_pib_start, %object
+_binary_pev_pib_start:
+    .incbin "flash/pev.pib"
+_binary_pev_pib_end:
+    .global _binary_pev_pib_end
+    .type   _binary_pev_pib_end, %object

plcboot/nvm.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <stdint.h>
+
+typedef struct __attribute__((packed)) {
+    uint16_t MajorVersion;
+    uint16_t MinorVersion;
+    uint32_t ExecuteMask;
+    uint32_t ImageNvmAddress;
+    uint32_t ImageAddress;
+    uint32_t ImageLength;
+    uint32_t ImageChecksum;
+    uint32_t EntryPoint;
+    uint32_t NextHeader;
+    uint32_t PrevHeader;
+    uint32_t ImageType;
+    uint16_t ModuleID;
+    uint16_t ModuleSubID;
+    uint16_t AppletEntryVersion;
+    uint16_t Reserved0;
+    uint32_t Reserved[11];
+    uint32_t HeaderChecksum;
+} nvm_header2_t;
+
+#define NVM_NO_NEXT_HEADER  0xFFFFFFFFu
+
+#define NVM_IMAGE_MEMCTL        0x0007u
+#define NVM_IMAGE_FIRMWARE      0x0004u
+#define NVM_IMAGE_SOFTLOADER    0x000Bu
+#define NVM_IMAGE_PIB           0x000Fu