KrzysztofC/nRF52840_PTT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Doxygen, clang-format, cppcheck, and Gitea CI
Some checks failed
CI / Build firmware (push) Failing after 2m1s
Details
CI / Check formatting (push) Successful in 5s
Details
CI / Static analysis (push) Failing after 5s
Details
CI / Build documentation (push) Successful in 4s
Details

Browse Source 
Doxygen:
- Doxyfile: minimal config, HTML output to docs/, no LaTeX
- @file/@brief on all source files, full @param/@return on public API
- docs/ added to .gitignore

clang-format (14, Linux brace style, 4-space, column 100):
- .clang-format added
- Applied to entire codebase; this commit is the canonical baseline
- just format rewrites in-place; just format-check is the CI gate

cppcheck (--enable=warning,style,performance,portability):
- Linker-symbol pointer comparisons in startup.c suppressed with
  inline cppcheck-suppress (false positives, not real bugs)
- just lint runs cppcheck; zero warnings required to pass

Dockerfile gains clang-format, cppcheck, doxygen packages so all
tools run inside the existing container -- host stays clean.

Gitea Actions (.gitea/workflows/ci.yml):
- Four parallel jobs: build, format, lint, docs
- All jobs use the same Dockerfile-based image
- Doxygen job fails on any warning line in output
This commit is contained in:
Krzysztof Cieślik
2026-05-21 23:07:05 +02:00
parent 0e348414f8
commit 39a89036cc
15 changed files with 460 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/fhss.c
View File

@@ -1,13 +1,15 @@
/** @file fhss.c
* @brief FHSS channel sequencer implementation.
*/
#include "fhss.h"
#include <aes.h>
#define FHSS_CHANNELS 40u
#define FHSS_DWELL_MS 2u
#define FHSS_CHANNELS 40u
#define FHSS_DWELL_MS 2u
/* TODO: replace with a real shared secret before deployment */
static const uint8_t shared_key[16] = {
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
};
static uint32_t slot;
@@ -25,11 +27,11 @@ uint8_t fhss_next_channel(void)
/* encode slot counter big-endian into the AES input block */
block[0] = (uint8_t)(slot >> 24);
block[1] = (uint8_t)(slot >> 16);
block[2] = (uint8_t)(slot >> 8);
block[3] = (uint8_t)(slot );
block[2] = (uint8_t)(slot >> 8);
block[3] = (uint8_t)(slot);
AES_init_ctx(&ctx, shared_key);
AES_ECB_encrypt(&ctx, block); /* encrypts block in-place */
AES_ECB_encrypt(&ctx, block); /* encrypts block in-place */
slot++;
return block[0] % FHSS_CHANNELS;

5
src/main.c
View File

@@ -1,8 +1,11 @@
/** @file main.c
* @brief Entry point: initialise peripherals and run the PTT event loop.
*/
#include "radio.h"
#include "power.h"
#include <stdint.h>
static const uint8_t test_frame[] = { 0xDE, 0xAD, 0xBE, 0xEF };
static const uint8_t test_frame[] = {0xDE, 0xAD, 0xBE, 0xEF};
int main(void)
{

16
src/power.c
View File

@@ -1,10 +1,13 @@
/** @file power.c
* @brief Power management implementation.
*/
#include "power.h"
#include "regs.h"
#include <nrf52840.h>
#include <cmsis_gcc.h>
/* P0.02 on XIAO BLE - adjust to match your schematic */
#define BUTTON_PIN 2u
#define BUTTON_PIN 2u
void power_init(void)
{
@@ -13,14 +16,13 @@ void power_init(void)
NRF_GPIOTE->CONFIG[0] = (gpiote_config_t){
.bit = {
.MODE = GPIOTE_MODE_EVENT,
.PSEL = BUTTON_PIN,
.PORT = 0u,
.MODE = GPIOTE_MODE_EVENT,
.PSEL = BUTTON_PIN,
.PORT = 0u,
.POLARITY = GPIOTE_POL_LOTOHI,
}
}.reg;
}}.reg;
NRF_GPIOTE->INTENSET = (gpiote_inten_t){ .bit.IN0 = 1u }.reg;
NRF_GPIOTE->INTENSET = (gpiote_inten_t){.bit.IN0 = 1u}.reg;
NVIC_EnableIRQ(GPIOTE_IRQn);
}

62
src/radio.c
View File

@@ -1,3 +1,6 @@
/** @file radio.c
* @brief RADIO peripheral driver implementation.
*/
#include "radio.h"
#include "regs.h"
#include <nrf52840.h>
@@ -13,8 +16,8 @@
* TX is synchronous: function returns after EVENTS_END fires.
*/
#define MAX_PAYLOAD 255u
#define BUF_SIZE (1u + MAX_PAYLOAD)
#define MAX_PAYLOAD 255u
#define BUF_SIZE (1u + MAX_PAYLOAD)
static uint8_t pkt_buf[BUF_SIZE];
@@ -22,59 +25,52 @@ static uint8_t pkt_buf[BUF_SIZE];
#define DEFAULT_CHANNEL 20u
/* 4-byte base address (3-byte BALEN field means 3+1=4 total address bytes) */
#define RADIO_BASE0 0x12345678u
#define RADIO_PREFIX0 0xABu /* logical address 0: RADIO_BASE0 + RADIO_PREFIX0[7:0] */
#define RADIO_BASE0 0x12345678u
#define RADIO_PREFIX0 0xABu /* logical address 0: RADIO_BASE0 + RADIO_PREFIX0[7:0] */
void radio_init(void)
{
NRF_RADIO->MODE = (radio_mode_t){
.bit = { .MODE = RADIO_MODE_NRF_1MBIT }
}.reg;
NRF_RADIO->MODE = (radio_mode_t){.bit = {.MODE = RADIO_MODE_NRF_1MBIT}}.reg;
/* 8-bit LENGTH field, no S0/S1, 8-bit preamble, CRC not part of LENGTH */
NRF_RADIO->PCNF0 = (radio_pcnf0_t){
.bit = { .LFLEN = 8, .S0LEN = 0, .S1LEN = 0, .PLEN = 0, .CRCINC = 0 }
}.reg;
NRF_RADIO->PCNF0 =
(radio_pcnf0_t){.bit = {.LFLEN = 8, .S0LEN = 0, .S1LEN = 0, .PLEN = 0, .CRCINC = 0}}.reg;
/* max 255-byte payload, 3-byte base address, little-endian, no whitening */
NRF_RADIO->PCNF1 = (radio_pcnf1_t){
.bit = { .MAXLEN = MAX_PAYLOAD, .STATLEN = 0, .BALEN = 3,
.ENDIAN = 0, .WHITEEN = 0 }
}.reg;
NRF_RADIO->PCNF1 =
(radio_pcnf1_t){
.bit = {.MAXLEN = MAX_PAYLOAD, .STATLEN = 0, .BALEN = 3, .ENDIAN = 0, .WHITEEN = 0}}
.reg;
NRF_RADIO->BASE0 = RADIO_BASE0;
NRF_RADIO->BASE0 = RADIO_BASE0;
NRF_RADIO->PREFIX0 = RADIO_PREFIX0;
NRF_RADIO->TXADDRESS = 0; /* transmit on logical address 0 */
NRF_RADIO->RXADDRESSES = 1; /* receive on logical address 0 */
NRF_RADIO->TXADDRESS = 0; /* transmit on logical address 0 */
NRF_RADIO->RXADDRESSES = 1; /* receive on logical address 0 */
/* 2-byte CRC, skip address field */
NRF_RADIO->CRCCNF = (radio_crccnf_t){
.bit = { .LEN = RADIO_CRCCNF_LEN_TWO, .SKIPADDR = 1 }
}.reg;
NRF_RADIO->CRCPOLY = 0x11021u; /* CRC-16/CCITT */
NRF_RADIO->CRCCNF = (radio_crccnf_t){.bit = {.LEN = RADIO_CRCCNF_LEN_TWO, .SKIPADDR = 1}}.reg;
NRF_RADIO->CRCPOLY = 0x11021u; /* CRC-16/CCITT */
NRF_RADIO->CRCINIT = 0xFFFFu;
NRF_RADIO->TXPOWER = (radio_txpower_t){
.bit = { .TXPOWER = 0 } /* 0 dBm */
}.reg;
NRF_RADIO->TXPOWER =
(radio_txpower_t){
.bit = {.TXPOWER = 0} /* 0 dBm */
}
.reg;
NRF_RADIO->FREQUENCY = (radio_frequency_t){
.bit = { .FREQUENCY = DEFAULT_CHANNEL, .MAP = RADIO_MAP_DEFAULT }
}.reg;
NRF_RADIO->FREQUENCY =
(radio_frequency_t){.bit = {.FREQUENCY = DEFAULT_CHANNEL, .MAP = RADIO_MAP_DEFAULT}}.reg;
/* READY -> START and END -> DISABLE shortcuts so CPU only triggers TXEN */
NRF_RADIO->SHORTS = (radio_shorts_t){
.bit = { .READY_START = 1, .END_DISABLE = 1 }
}.reg;
NRF_RADIO->SHORTS = (radio_shorts_t){.bit = {.READY_START = 1, .END_DISABLE = 1}}.reg;
NRF_RADIO->PACKETPTR = (uint32_t)pkt_buf;
}
void radio_set_channel(uint8_t ch)
{
NRF_RADIO->FREQUENCY = (radio_frequency_t){
.bit = { .FREQUENCY = ch, .MAP = RADIO_MAP_DEFAULT }
}.reg;
NRF_RADIO->FREQUENCY =
(radio_frequency_t){.bit = {.FREQUENCY = ch, .MAP = RADIO_MAP_DEFAULT}}.reg;
}
void radio_tx(const uint8_t *data, uint8_t len)

136
src/startup.c
View File

@@ -1,12 +1,15 @@
/** @file startup.c
* @brief Vector table and Reset_Handler for nRF52840 (no SoftDevice).
*/
#include <stdint.h>
/* linker script symbols */
extern uint32_t _sidata; /* load address of .data in Flash */
extern uint32_t _sdata; /* start of .data in RAM */
extern uint32_t _edata; /* end of .data in RAM */
extern uint32_t _sidata; /* load address of .data in Flash */
extern uint32_t _sdata; /* start of .data in RAM */
extern uint32_t _edata; /* end of .data in RAM */
extern uint32_t _sbss;
extern uint32_t _ebss;
extern uint32_t _estack; /* address equals initial SP value */
extern uint32_t _estack; /* address equals initial SP value */
extern int main(void);
@@ -14,71 +17,73 @@ void Reset_Handler(void);
static void __attribute__((used)) Default_Handler(void)
{
while (1);
while (1)
;
}
/* ARM Cortex-M4 core exceptions */
void NMI_Handler(void) __attribute__((weak, alias("Default_Handler")));
void HardFault_Handler(void) __attribute__((weak, alias("Default_Handler")));
void MemManage_Handler(void) __attribute__((weak, alias("Default_Handler")));
void BusFault_Handler(void) __attribute__((weak, alias("Default_Handler")));
void NMI_Handler(void) __attribute__((weak, alias("Default_Handler")));
void HardFault_Handler(void) __attribute__((weak, alias("Default_Handler")));
void MemManage_Handler(void) __attribute__((weak, alias("Default_Handler")));
void BusFault_Handler(void) __attribute__((weak, alias("Default_Handler")));
void UsageFault_Handler(void) __attribute__((weak, alias("Default_Handler")));
void SVC_Handler(void) __attribute__((weak, alias("Default_Handler")));
void DebugMon_Handler(void) __attribute__((weak, alias("Default_Handler")));
void PendSV_Handler(void) __attribute__((weak, alias("Default_Handler")));
void SysTick_Handler(void) __attribute__((weak, alias("Default_Handler")));
void SVC_Handler(void) __attribute__((weak, alias("Default_Handler")));
void DebugMon_Handler(void) __attribute__((weak, alias("Default_Handler")));
void PendSV_Handler(void) __attribute__((weak, alias("Default_Handler")));
void SysTick_Handler(void) __attribute__((weak, alias("Default_Handler")));
/* nRF52840 peripheral IRQs (IRQ0-IRQ47) */
void POWER_CLOCK_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RADIO_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void UARTE0_UART0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM1_SPIS1_TWIM1_TWIS1_SPI1_TWI1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void NFCT_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void GPIOTE_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SAADC_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TEMP_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RNG_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void ECB_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void CCM_AAR_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void WDT_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void QDEC_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void COMP_LPCOMP_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI0_EGU0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI1_EGU1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI2_EGU2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI3_EGU3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI4_EGU4_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI5_EGU5_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER4_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PDM_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void MWU_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM2_SPIS2_SPI2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void I2S_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void FPU_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void USBD_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void UARTE1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void QSPI_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void CRYPTOCELL_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void POWER_CLOCK_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RADIO_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void UARTE0_UART0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQHandler(void)
__attribute__((weak, alias("Default_Handler")));
void SPIM1_SPIS1_TWIM1_TWIS1_SPI1_TWI1_IRQHandler(void)
__attribute__((weak, alias("Default_Handler")));
void NFCT_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void GPIOTE_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SAADC_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TEMP_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RNG_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void ECB_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void CCM_AAR_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void WDT_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void QDEC_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void COMP_LPCOMP_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI0_EGU0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI1_EGU1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI2_EGU2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI3_EGU3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI4_EGU4_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SWI5_EGU5_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void TIMER4_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM0_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PDM_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void MWU_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM2_SPIS2_SPI2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void RTC2_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void I2S_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void FPU_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void USBD_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void UARTE1_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void QSPI_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void CRYPTOCELL_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void PWM3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
void SPIM3_IRQHandler(void) __attribute__((weak, alias("Default_Handler")));
/* vector table: 64 entries (16 core + 48 IRQs) */
typedef void (*vector_fn)(void);
__attribute__((section(".isr_vector"), used))
const vector_fn vectors[64] = {
__attribute__((section(".isr_vector"), used)) const vector_fn vectors[64] = {
/* 0 */ (vector_fn)&_estack,
/* 1 */ Reset_Handler,
/* 2 */ NMI_Handler,
@@ -126,8 +131,8 @@ const vector_fn vectors[64] = {
/* IRQ27 */ TIMER4_IRQHandler,
/* IRQ28 */ PWM0_IRQHandler,
/* IRQ29 */ PDM_IRQHandler,
/* IRQ30 */ 0, /* reserved */
/* IRQ31 */ 0, /* reserved */
/* IRQ30 */ 0, /* reserved */
/* IRQ31 */ 0, /* reserved */
/* IRQ32 */ MWU_IRQHandler,
/* IRQ33 */ PWM1_IRQHandler,
/* IRQ34 */ PWM2_IRQHandler,
@@ -139,10 +144,10 @@ const vector_fn vectors[64] = {
/* IRQ40 */ UARTE1_IRQHandler,
/* IRQ41 */ QSPI_IRQHandler,
/* IRQ42 */ CRYPTOCELL_IRQHandler,
/* IRQ43 */ 0, /* reserved */
/* IRQ44 */ 0, /* reserved */
/* IRQ43 */ 0, /* reserved */
/* IRQ44 */ 0, /* reserved */
/* IRQ45 */ PWM3_IRQHandler,
/* IRQ46 */ 0, /* reserved */
/* IRQ46 */ 0, /* reserved */
/* IRQ47 */ SPIM3_IRQHandler,
};
@@ -153,16 +158,19 @@ void Reset_Handler(void)
/* copy .data initializers from Flash to RAM */
uint32_t *src = &_sidata;
uint32_t *dst = &_sdata;
// cppcheck-suppress comparePointers
while (dst < &_edata) {
*dst++ = *src++;
}
/* zero .bss */
dst = &_sbss;
// cppcheck-suppress comparePointers
while (dst < &_ebss) {
*dst++ = 0u;
}
main();
while (1);
while (1)
;
}