Skip to content

Commit

Permalink
bcm4389c1: adding basic patch for firmware version 20.80.87.3 (wlan=r…
Browse files Browse the repository at this point in the history
…1050079 c1 release) with ucode compression and ioctl handler
  • Loading branch information
jlinktu committed Oct 30, 2024
1 parent 76fade6 commit ef25ce3
Show file tree
Hide file tree
Showing 11 changed files with 547 additions and 0 deletions.
252 changes: 252 additions & 0 deletions patches/bcm4389c1/20_80_87_3_r1050079_sta/nexmon/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
ifndef NEXMON_SETUP_ENV
$(error run 'source setup_env.sh' first in the repository\'s root directory)
endif

GIT_VERSION := $(shell git describe --abbrev=4 --dirty --always --tags)
SHELL := /bin/bash
include ../version.mk
include $(FW_PATH)/definitions.mk

LOCAL_SRCS=$(wildcard src/*.c) src/ucode0_compressed.c src/ucode1_compressed.c src/ucode2_compressed.c src/templateram0.c src/templateram1.c src/templateram2.c src/templateram3.c
COMMON_SRCS=$(NEXMON_ROOT)/patches/common/ucode_compression_code.c $(NEXMON_ROOT)/patches/common/objmem.c $(NEXMON_ROOT)/patches/common/helper.c $(NEXMON_ROOT)/patches/common/wrapper.c
FW_SRCS=$(wildcard $(FW_PATH)/*.c)

OBJS=$(addprefix obj/,$(notdir $(LOCAL_SRCS:.c=.o)) $(notdir $(COMMON_SRCS:.c=.o)) $(notdir $(FW_SRCS:.c=.o)))

DATETIME := $(shell date -u +'%b %e %Y %T')

CFLAGS= \
-fplugin=$(CCPLUGIN) \
-fplugin-arg-nexmon-objfile=$@ \
-fplugin-arg-nexmon-prefile=gen/nexmon.pre \
-fplugin-arg-nexmon-chipver=$(NEXMON_CHIP_NUM) \
-fplugin-arg-nexmon-fwver=$(NEXMON_FW_VERSION_NUM) \
-fno-strict-aliasing \
-DBCMPKTIDMAP=1 \
-DNEXMON_CHIP=$(NEXMON_CHIP) \
-DNEXMON_FW_VERSION=$(NEXMON_FW_VERSION) \
-DWLC_UCODE_WRITE_BL_HOOK_ADDR=$(WLC_UCODE_WRITE_BL_HOOK_ADDR) \
-DMMU_PROTECT_ON_BL_ADDR=$(MMU_PROTECT_ON_BL_ADDR) \
-DHNDRTE_RECLAIM_3_END_PTR_0=$(HNDRTE_RECLAIM_3_END_PTR_0) \
-DHNDRTE_RECLAIM_3_END_PTR_1=$(HNDRTE_RECLAIM_3_END_PTR_1) \
-DHNDRTE_RECLAIM_3_END_PTR_2=$(HNDRTE_RECLAIM_3_END_PTR_2) \
-DFP_CONFIG_BASE=$(FP_CONFIG_BASE) \
-DTEMPLATERAM0START_PTR=$(TEMPLATERAM0START_PTR) \
-DTEMPLATERAM1START_PTR=$(TEMPLATERAM1START_PTR) \
-DTEMPLATERAM2START_PTR=$(TEMPLATERAM2START_PTR) \
-DTEMPLATERAM3START_PTR=$(TEMPLATERAM3START_PTR) \
-DPATCHSTART=$(PATCHSTART) \
-DUCODE0START_PTR=$(UCODE0START_PTR) \
-DUCODE0SIZE_PTR=$(UCODE0SIZE_PTR) \
-DUCODE1START_PTR=$(UCODE1START_PTR) \
-DUCODE1SIZE_PTR=$(UCODE1SIZE_PTR) \
-DUCODE2START_PTR=$(UCODE2START_PTR) \
-DUCODE2SIZE_PTR=$(UCODE2SIZE_PTR) \
-DVERSION_PTR_1=$(VERSION_PTR_1) \
-DVERSION_PTR_2=$(VERSION_PTR_2) \
-DVERSION_PTR_3=$(VERSION_PTR_3) \
-DVERSION_PTR_4=$(VERSION_PTR_4) \
-DDATETIME_PTR=$(DATETIME_PTR) \
-DDATETIME=\""$(DATETIME)"\" \
-DGIT_VERSION=\"$(GIT_VERSION)\" \
-DBUILD_NUMBER=\"$$(cat BUILD_NUMBER)\" \
-Wall -Werror -O2 -nostdlib -nostartfiles -ffreestanding -mthumb -march=$(NEXMON_ARCH) \
-Wno-unused-function \
-ffunction-sections -fdata-sections \
-I$(NEXMON_ROOT)/patches/include \
-Iinclude \
-I$(FW_PATH)

all: clean nexmon-magisk.zip

nexmon-magisk/system/vendor/firmware/wifi:
@printf "\033[0;32m CREATING\033[0m magisk module structure %s\n" $@
$(Q)mkdir -p $@

nexmon-magisk/system/bin:
@printf "\033[0;32m CREATING\033[0m magisk module structure %s\n" $@
$(Q)mkdir -p $@

$(NEXMON_ROOT)/utilities/nexutil/libs/arm64-v8a/nexutil: $(NEXMON_ROOT)/utilities/nexutil
@printf "\033[0;32m BUILDING\033[0m nexutil %s\n" $@
$(Q)make APP_ABI=arm64-v8a -C $<

nexmon-magisk/system/bin/nexutil: $(NEXMON_ROOT)/utilities/nexutil/libs/arm64-v8a/nexutil nexmon-magisk/system/bin
@printf "\033[0;32m COPYING\033[0m nexutil %s\n" $@
$(Q)cp $(NEXMON_ROOT)/utilities/nexutil/libs/arm64-v8a/nexutil $@

nexmon-magisk.zip: $(RAM_FILE) nexmon-magisk nexmon-magisk/system/bin/nexutil nexmon-magisk/system/vendor/firmware/wifi
@printf "\033[0;32m BUILDING\033[0m magisk module %s (details: log/magisk.log)\n" $@
$(Q)cp $< nexmon-magisk/system/vendor/firmware/wifi/
$(Q)cd nexmon-magisk && zip -r -Z deflate ../$@ * 2>&1 > ../log/magisk.log && cd ..

init: FORCE
$(Q)if ! test -f BUILD_NUMBER; then echo 0 > BUILD_NUMBER; fi
$(Q)echo $$(($$(cat BUILD_NUMBER) + 1)) > BUILD_NUMBER
$(Q)touch src/version.c
$(Q)make -s -f $(NEXMON_ROOT)/patches/common/header.mk
$(Q)mkdir -p obj gen log

obj/%.o: src/%.c
@printf "\033[0;32m COMPILING\033[0m %s => %s (details: log/compiler.log)\n" $< $@
$(Q)cat gen/nexmon.pre 2>>log/error.log | gawk '{ if ($$3 != "$@") print; }' > tmp && mv tmp gen/nexmon.pre
$(Q)$(CC)gcc $(CFLAGS) -c $< -o $@ >>log/compiler.log

obj/%.o: $(NEXMON_ROOT)/patches/common/%.c
@printf "\033[0;32m COMPILING\033[0m %s => %s (details: log/compiler.log)\n" $< $@
$(Q)cat gen/nexmon.pre 2>>log/error.log | gawk '{ if ($$3 != "$@") print; }' > tmp && mv tmp gen/nexmon.pre
$(Q)$(CC)gcc $(CFLAGS) -c $< -o $@ >>log/compiler.log

obj/%.o: $(FW_PATH)/%.c
@printf "\033[0;32m COMPILING\033[0m %s => %s (details: log/compiler.log)\n" $< $@
$(Q)cat gen/nexmon.pre 2>>log/error.log | gawk '{ if ($$3 != "$@") print; }' > tmp && mv tmp gen/nexmon.pre
$(Q)$(CC)gcc $(CFLAGS) -c $< -o $@ >>log/compiler.log

gen/nexmon2.pre: $(OBJS)
@printf "\033[0;32m PREPARING\033[0m %s => %s\n" "gen/nexmon.pre" $@
$(Q)cat gen/nexmon.pre | awk '{ if ($$3 != "obj/flashpatches.o" && $$3 != "obj/wrapper.o") { print $$0; } }' > tmp
$(Q)cat gen/nexmon.pre | awk '{ if ($$3 == "obj/flashpatches.o" || $$3 == "obj/wrapper.o") { print $$0; } }' >> tmp
$(Q)cat tmp | awk '{ if ($$1 ~ /^0x/) { if ($$3 != "obj/flashpatches.o" && $$3 != "obj/wrapper.o") { if (!x[$$1]++) { print $$0; } } else { if (!x[$$1]) { print $$0; } } } else { print $$0; } }' > gen/nexmon2.pre

gen/nexmon.ld: gen/nexmon2.pre $(OBJS)
@printf "\033[0;32m GENERATING LINKER FILE\033[0m gen/nexmon.pre => %s\n" $@
$(Q)sort gen/nexmon2.pre | gawk -f $(NEXMON_ROOT)/buildtools/scripts/nexmon.ld.awk > $@

gen/nexmon.mk: gen/nexmon2.pre $(OBJS) $(FW_PATH)/definitions.mk
@printf "\033[0;32m GENERATING MAKE FILE\033[0m gen/nexmon.pre => %s\n" $@
$(Q)printf "$(RAM_FILE): gen/patch.elf FORCE\n" > $@
$(Q)sort gen/nexmon2.pre | \
gawk -v src_file=gen/patch.elf -f $(NEXMON_ROOT)/buildtools/scripts/nexmon.mk.1.awk | \
gawk -v ramstart=$(RAMSTART) -f $(NEXMON_ROOT)/buildtools/scripts/nexmon.mk.2.awk >> $@
$(Q)printf "\nFORCE:\n" >> $@
$(Q)gawk '!a[$$0]++' $@ > tmp && mv tmp $@

gen/flashpatches.ld: gen/nexmon2.pre $(OBJS)
@printf "\033[0;32m GENERATING LINKER FILE\033[0m gen/nexmon.pre => %s\n" $@
$(Q)sort gen/nexmon2.pre | \
gawk -f $(NEXMON_ROOT)/buildtools/scripts/flashpatches.ld.awk > $@

gen/flashpatches.mk: gen/nexmon2.pre $(OBJS) $(FW_PATH)/definitions.mk
@printf "\033[0;32m GENERATING MAKE FILE\033[0m gen/nexmon.pre => %s\n" $@
$(Q)cat gen/nexmon2.pre | gawk \
-v fp_data_base=$(FP_DATA_BASE) \
-v fp_config_base=$(FP_CONFIG_BASE) \
-v fp_data_last_ptr=$(FP_DATA_LAST_PTR) \
-v fp_config_base_ptr_1=$(FP_CONFIG_BASE_PTR_1) \
-v fp_config_end_ptr_1=$(FP_CONFIG_END_PTR_1) \
-v fp_config_base_ptr_2=$(FP_CONFIG_BASE_PTR_2) \
-v fp_config_end_ptr_2=$(FP_CONFIG_END_PTR_2) \
-v fp_config_base_ptr_3=$(FP_CONFIG_BASE_PTR_3) \
-v fp_config_end_ptr_3=$(FP_CONFIG_END_PTR_3) \
-v fp_config_base_ptr_4=$(FP_CONFIG_BASE_PTR_4) \
-v fp_config_end_ptr_4=$(FP_CONFIG_END_PTR_4) \
-v ramstart=$(RAMSTART) \
-v out_file=$(RAM_FILE) \
-v src_file=gen/patch.elf \
-f $(NEXMON_ROOT)/buildtools/scripts/flashpatches.bcm4389.mk.awk > $@

gen/memory.ld: $(FW_PATH)/definitions.mk
@printf "\033[0;32m GENERATING LINKER FILE\033[0m %s\n" $@
$(Q)printf "rom : ORIGIN = 0x%08x, LENGTH = 0x%08x\n" $(ROMSTART) $(ROMSIZE) > $@
$(Q)printf "ram : ORIGIN = 0x%08x, LENGTH = 0x%08x\n" $(RAMSTART) $(RAMSIZE) >> $@
$(Q)printf "ucode : ORIGIN = 0x%08x, LENGTH = 0x%08x\n" $(UCODEREGIONSTART) $(UCODEREGIONSIZE) >> $@
$(Q)printf "patch : ORIGIN = 0x%08x, LENGTH = 0x%08x\n" $(PATCHSTART) $(PATCHSIZE) >> $@
$(Q)printf "fpconfig : ORIGIN = 0x%08x, LENGTH = 0x%08x\n" $(FP_CONFIG_BASE) $(FP_CONFIG_SIZE) >> $@

gen/patch.elf: patch.ld gen/nexmon.ld gen/flashpatches.ld gen/memory.ld $(OBJS)
@printf "\033[0;32m LINKING OBJECTS\033[0m => %s (details: log/linker.log, log/linker.err)\n" $@
$(Q)$(CC)ld -T $< -o $@ --gc-sections --print-gc-sections -M >>log/linker.log 2>>log/linker.err

$(RAM_FILE): init gen/patch.elf $(FW_PATH)/$(RAM_FILE) gen/nexmon.mk gen/flashpatches.mk
$(Q)cp $(FW_PATH)/$(RAM_FILE) $@
@printf "\033[0;32m APPLYING FLASHPATCHES\033[0m gen/flashpatches.mk => %s (details: log/flashpatches.log)\n" $@
$(Q)make -f gen/flashpatches.mk >>log/flashpatches.log 2>>log/flashpatches.log
@printf "\033[0;32m APPLYING PATCHES\033[0m gen/nexmon.mk => %s (details: log/patches.log)\n" $@
$(Q)make -f gen/nexmon.mk >>log/patches.log 2>>log/patches.log

###################################################################
# ucode compression related
###################################################################

gen/ucode0.bin: $(FW_PATH)/ucode0.bin
@printf "\033[0;32m COPYING FIRST UCODE\033[0m %s => %s\n" $< $@
$(Q)cp $< $@

gen/ucode1.bin: $(FW_PATH)/ucode1.bin
@printf "\033[0;32m COPYING SECOND UCODE\033[0m %s => %s\n" $< $@
$(Q)cp $< $@

gen/ucode2.bin: $(FW_PATH)/ucode2.bin
@printf "\033[0;32m COPYING THIRD UCODE\033[0m %s => %s\n" $< $@
$(Q)cp $< $@

gen/ucode0_compressed.bin: gen/ucode0.bin
@printf "\033[0;32m COMPRESSING FIRST UCODE\033[0m %s => %s\n" $< $@
$(Q)cat $< | $(ZLIBFLATE) > $@

gen/ucode1_compressed.bin: gen/ucode1.bin
@printf "\033[0;32m COMPRESSING SECOND UCODE\033[0m %s => %s\n" $< $@
$(Q)cat $< | $(ZLIBFLATE) > $@

gen/ucode2_compressed.bin: gen/ucode2.bin
@printf "\033[0;32m COMPRESSING THIRD UCODE\033[0m %s => %s\n" $< $@
$(Q)cat $< | $(ZLIBFLATE) > $@

src/ucode0_compressed.c: gen/ucode0_compressed.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/ucode1_compressed.c: gen/ucode1_compressed.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/ucode2_compressed.c: gen/ucode2_compressed.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/templateram0.c: $(FW_PATH)/templateram0.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/templateram1.c: $(FW_PATH)/templateram1.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/templateram2.c: $(FW_PATH)/templateram2.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

src/templateram3.c: $(FW_PATH)/templateram3.bin
@printf "\033[0;32m GENERATING C FILE\033[0m %s => %s\n" $< $@
$(Q)printf "#pragma NEXMON targetregion \"ucode\"\n\n" > $@
$(Q)cd $(dir $<) && xxd -i $(notdir $<) >> $(shell pwd)/$@

###################################################################

backup-firmware:
@printf "\033[0;32m BACKING UP\033[0m /vendor/firmware/wifi/%s => %s.backup\n" $(RAM_FILE) $(RAM_FILE).backup
$(Q)adb shell 'su -c "cp /vendor/firmware/wifi/$(RAM_FILE) /sdcard/$(RAM_FILE).backup"' 2>&1 >> log/adb.log
$(Q)adb pull "/sdcard/$(RAM_FILE).backup" "$(RAM_FILE).backup" 2>&1 >> log/adb.log

install-firmware: nexmon-magisk.zip
@printf "\033[0;32m COPYING TO PHONE\033[0m %s => /sdcard/%s\n" $< $<
$(Q)adb push $< /sdcard/ >> log/adb.log 2>> log/adb.log
@printf "\033[0;32m INSTALLING\033[0m /sdcard/%s using Magisk\033[0m\n" $<
$(Q)adb shell 'su -c "magisk --install-module /sdcard/$<"' 2>&1 >> log/adb.log
@printf "\033[0;33m ANDROID REBOOT REQUIRED\033[0m run: adb reboot\033[0m\n" $<
$(Q)-bash -c 'read -p "Reboot attached device now?(y/N)" adbreboot; [[ $${adbreboot,,} == "y" ]] && adb reboot'

clean-firmware: FORCE
@printf "\033[0;32m CLEANING\033[0m\n"
$(Q)rm -fr $(RAM_FILE) obj gen log src/ucode0_compressed.c src/ucode1_compressed.c src/ucode2_compressed.c src/templateram0.c src/templateram1.c src/templateram2.c src/templateram3.c nexmon-magisk.zip nexmon-magisk/system

clean: clean-firmware
$(Q)rm -f BUILD_NUMBER

FORCE:
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#!/sbin/sh

#################
# Initialization
#################

umask 022

# echo before loading util_functions
ui_print() { echo "$1"; }

require_new_magisk() {
ui_print "*******************************"
ui_print " Please install Magisk v20.4+! "
ui_print "*******************************"
exit 1
}

#########################
# Load util_functions.sh
#########################

OUTFD=$2
ZIPFILE=$3

mount /data 2>/dev/null

[ -f /data/adb/magisk/util_functions.sh ] || require_new_magisk
. /data/adb/magisk/util_functions.sh
[ $MAGISK_VER_CODE -lt 20400 ] && require_new_magisk

install_module
exit 0
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#MAGISK
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
set_perm $MODPATH/system/bin/nexutil root root 755
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
id=nexmon-magisk
name=nexmon-magisk
version=1.0
versionCode=1
author=Jakob Link <[email protected]>
description=Overwrite wifi firmware, install nexutil, allow upd_socket ioctl in magisk context
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
allowxperm magisk magisk udp_socket ioctl { 0x8914 0x891d 0x8927 0x8946 0x8970 0x89f0 }
10 changes: 10 additions & 0 deletions patches/bcm4389c1/20_80_87_3_r1050079_sta/nexmon/patch.ld
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MEMORY
{
INCLUDE gen/memory.ld
}

SECTIONS
{
INCLUDE gen/flashpatches.ld
INCLUDE gen/nexmon.ld
}
74 changes: 74 additions & 0 deletions patches/bcm4389c1/20_80_87_3_r1050079_sta/nexmon/src/ioctl.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/***************************************************************************
* *
* ########### ########### ########## ########## *
* ############ ############ ############ ############ *
* ## ## ## ## ## ## ## *
* ## ## ## ## ## ## ## *
* ########### #### ###### ## ## ## ## ###### *
* ########### #### # ## ## ## ## # # *
* ## ## ###### ## ## ## ## # # *
* ## ## # ## ## ## ## # # *
* ############ ##### ###### ## ## ## ##### ###### *
* ########### ########### ## ## ## ########## *
* *
* S E C U R E M O B I L E N E T W O R K I N G *
* *
* This file is part of NexMon. *
* *
* Copyright (c) 2024 NexMon Team *
* Copyright (c) 2024 Jakob Link <[email protected]> *
* *
* NexMon is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* NexMon is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with NexMon. If not, see <http://www.gnu.org/licenses/>. *
* *
**************************************************************************/

#pragma NEXMON targetregion "patch"

#include <firmware_version.h> // definition of firmware version macros
#include <wrapper.h> // wrapper definitions for functions that already exist in the firmware
#include <structs.h> // structures that are used by the code in the firmware
#include <patcher.h> // macros used to create patches such as BLPatch, BPatch, ...
#include <nexioctls.h> // ioctls added in the nexmon patch

int
wlc_doioctl_hook(struct wlc_info *wlc, int cmd, char *arg, int len, void *wlc_if)
{
int ret = IOCTL_ERROR;

switch (cmd) {

case NEX_GET_CONSOLE:
{
uint32 offset, read_len;
struct hnd_debug *hnd_debug = (struct hnd_debug *)hnd_debug_info_get();
if (len >= sizeof(uint32)) {
offset = *(uint32 *)arg;
if (offset >= hnd_debug->console->buf_size)
break;
read_len = ((offset + len) >= hnd_debug->console->buf_size) ? (hnd_debug->console->buf_size - offset) : len;
memcpy(arg, hnd_debug->console->buf + offset, read_len);
ret = IOCTL_SUCCESS;
}
break;
}

default:
ret = wlc_doioctl(wlc, cmd, arg, len, wlc_if);
}

return ret;
}

__attribute__((at(0x31BA1C, "", CHIP_VER_BCM4389c1, FW_VER_20_80_87_3_r1050079_sta)))
GenericPatch4(wlc_doioctl_hook, wlc_doioctl_hook + 1);
Loading

0 comments on commit ef25ce3

Please sign in to comment.