Adding a protocol mode to the Bus Pirate

ian · October 31, 2023, 5:30pm

There is a dummy mode in the source that demonstrates how the modes work. I’ve updated it and added a bunch of comments and simple demos:

github.com

DangerousPrototypes/BusPirate5-firmware/blob/main/mode/dummy1.c

// This is an example mode for Bus Pirate 5
// How modes work:
// Bus Pirate 5 uses a three step process to get tight timings between operations.
// This means it is no longer possible to just spit out data from printf directly from the mode.
// All messages and data must be handed back in the result struct to be shown later.
// Eventually I will make syntax processing optional for modes so you can opt for a more relaxed environment (ask me, I wont make it a priority until someone actually wants it)
// 1. The syntax system pre-processes the user input into a simple bytecode
// 2. A loop hands each user command to a mode function below for actual IO or other actions
// 3. A final loop post-processes the result and outputs to the user terminal 
// To enable dummy mode open pirate.h and uncomment "#define BP_USE_DUMMY1"
// The dummy functions are implemented in mode.c. To create a new mode make a copy of the dummy portion of the mode struck and link to your new functions
#include <stdio.h>
#include "pico/stdlib.h"
#include "pirate.h"
#include "system_config.h" 
#include "bytecode.h" // Bytecode structure for data IO
#include "dummy1.h"
#include "bio.h" // Buffered pin IO functions
static uint32_t returnval;

This file has been truncated. show original

Enable the dummy mode in pirate.h and compile.

While writing this up, it occurred to me that maybe we should have a syntax processor override option. Right now everything is compiled, executed, and post-processed for speed, but it’s more restrictive that just using printf to spit out info from the mode itself. I will look into that a bit later, it may not be a big deal to implement.