Code style

firmware/application/
├── lib/              # Core libraries and drivers
│   ├── bt/          # Bluetooth module drivers (BM83, BC127)
│   ├── ibus.c/h     # I-Bus protocol implementation
│   ├── uart.c/h     # UART communication
│   ├── i2c.c/h      # I2C bus driver
│   ├── timer.c/h    # Timer and scheduling
│   ├── config.c/h   # EEPROM configuration
│   └── utils.c/h    # Utility functions
├── handler/         # Event handlers
│   ├── handler_bt.c/h     # Bluetooth event handling
│   ├── handler_ibus.c/h   # I-Bus event handling
│   └── handler_common.c/h # Shared handler logic
├── ui/              # User interface implementations
│   ├── bmbt.c/h     # Board Monitor interface
│   ├── mid.c/h      # Multi-Information Display
│   ├── cd53.c/h     # CD53 radio interface
│   └── cli.c/h      # Command-line interface
├── main.c           # Application entry point
├── sysconfig.h      # System configuration pragmas
└── mappings.h       # Pin and hardware mappings

/*
 * File: filename.c
 * Author: Your Name <[email protected]>
 * Description:
 *     Brief description of the file's purpose
 */

// Good
void IBusInit(void);
uint8_t ConfigGetBootloaderMode(void);
void TimerDelayMicroseconds(uint32_t microseconds);

// Bad
void ibus_init(void);      // Wrong: snake_case
void initIBus(void);       // Wrong: no module prefix
void Init(void);           // Wrong: too generic

uint8_t boardVersion = UtilsGetBoardVersion();
char *deviceName = "BlueBus";
int32_t sleepCount = 0;

static int8_t BOARD_VERSION = -1;

#define IBUS_DEVICE_CDC 0x18
#define IBUS_DEVICE_RAD 0x68
#define IBUS_PKT_SRC 0
#define IBUS_PKT_DST 2

#define CONFIG_SN_ADDRESS_MSB 0x00
#define CONFIG_FIRMWARE_VERSION_MAJOR_ADDRESS 0x02

#define UART_BAUD_115200 115200
#define UART_PARITY_NONE 0

typedef struct {
    struct UART_t uart;
    uint8_t status;
    uint8_t deviceId;
} IBus_t;

typedef struct {
    char text[UTILS_DISPLAY_TEXT_SIZE];
    uint8_t index;
    uint16_t timeout;
    uint8_t status;
    uint8_t length;
} UtilsAbstractDisplayValue_t;

int main(void)
{
    // Set the IVT mode
    IVT_MODE = IVT_MODE_APP;

    // Initialize low level modules
    EEPROMInit();
    TimerInit();
    I2CInit();

    struct BT_t bt = BTInit();
    struct IBus_t ibus = IBusInit();

    return 0;
}

// Good
void UtilsReset(void)
{
    asm("reset");
}

if (condition)
{
    doSomething();
}
else
{
    doSomethingElse();
}

// Also acceptable for simple statements
if (condition) {
    doSomething();
}

// Good
struct UART_t systemUart = UARTInit(
    SYSTEM_UART_MODULE,
    SYSTEM_UART_RX_RPIN,
    SYSTEM_UART_TX_RPIN,
    SYSTEM_UART_RX_PRIORITY,
    SYSTEM_UART_TX_PRIORITY,
    UART_BAUD_115200,
    UART_PARITY_NONE
);

// Good
uint8_t result = (value * 2) + offset;
if (a == b && c != d) {
    process();
}

// Bad
uint8_t result=(value*2)+offset;
if(a==b&&c!=d){
    process();
}

/**
 * UtilsConvertCmToIn()
 *     Description:
 *         Convert Centimeters to the nearest whole inch
 *     Params:
 *         uint8_t cm - Centimeters
 *     Returns:
 *         uint8_t The converted and rounded value in inches
 */
uint8_t UtilsConvertCmToIn(uint8_t cm)
{
    float impVal = cm / 2.54;
    return (int)(impVal < 0 ? (impVal - 0.5) : (impVal + 0.5));
}

// Enable the pull-down on the board version pin
BOARD_VERSION_PD = 1;

// Set the UART mode to MCU for the remainder of this application code
UART_SEL = UART_SEL_MCU;

// SPDIF_RST is reused from version one where it was TEL_MUTE
// Do not alter its state on v1.x boards
if (boardVersion == BOARD_VERSION_TWO) {
    SPDIF_RST = 1;
}

// I/O Pin Modes
#define BT_MFB_MODE TRISFbits.TRISF4
#define BT_RST_MODE TRISFbits.TRISF5
#define IBUS_EN_MODE TRISEbits.TRISE0

// I/O Pin States
#define BT_MFB LATFbits.LATF4
#define BT_RST LATFbits.LATF5
#define IBUS_EN LATEbits.LATE0

if (boardVersion == BOARD_VERSION_ONE) {
    WM88XXInit();
} else if (boardVersion == BOARD_VERSION_TWO) {
    SPDIF_RST = 1;
}

void __attribute__ ((__interrupt__, auto_psv)) _AltOscillatorFail()
{
    // Clear the trap flag
    INTCON1bits.OSCFAIL = 0;
    ConfigSetTrapIncrement(CONFIG_TRAP_OSC);
    TrapWait();
}

// Good
#define UART_STATUS_OK 0
#define UART_STATUS_ERROR 1
#define UART_STATUS_TIMEOUT 2

uint8_t UARTSendData(struct UART_t *uart, uint8_t *data, uint16_t len)
{
    if (uart == NULL || data == NULL) {
        return UART_STATUS_ERROR;
    }
    // ... send data ...
    return UART_STATUS_OK;
}

// Good
uint8_t byte;
uint16_t word;
uint32_t dword;
int8_t signedByte;

// Bad
char byte;           // Size may vary by platform
int word;            // Size may vary by platform
long dword;          // Size may vary by platform

// Good
uint8_t count = 0;
char *name = NULL;

// Bad
uint8_t count;
char *name;

// Good
#define IBUS_DEVICE_CDC 0x18
if (device == IBUS_DEVICE_CDC) {
    // ...
}

// Bad
if (device == 0x18) {
    // ...
}

// Good - Static allocation
static char buffer[256];

// Good - Stack allocation
void function(void) {
    char localBuffer[64];
    // ...
}

// Bad - Dynamic allocation (not supported)
void function(void) {
    char *buffer = malloc(256);  // Don't do this!
    free(buffer);
}