Port Queue to C++

Some knock-on changes to keep a simple design:
- Bake the data array into AVCLAN_frame_t
- Bundle the response/reaction with AVCLAN_frame_t
    - (Needed to maintain correct/simple ownership semantics with the
      cache and outgoing/incoming queues)
- Switch status frame update ticks to use a regular
  cache-originating/owned frame
This commit is contained in:
Allen Hill
2026-06-24 17:40:30 -07:00
parent 77ff4652fd
commit 02b370dd06
10 changed files with 251 additions and 309 deletions
+318
View File
@@ -0,0 +1,318 @@
// copyright (C) 2006 Marcin Slonicki <marcin@softservice.com.pl>
// copyright (C) 2007 Louis Frigon
// Copyright (C) 2015 Allen Hill <allenofthehills@gmail.com>
// SPDX-License-Identifier: GPL-3.0-or-later
#include <cctype>
#include <cstdint>
#include <cstring>
#include "avclandrv.h"
#include "board.h"
#include "com232.h"
#include "queue.hpp"
const char *const offon[] = {"OFF", "ON"};
static constexpr uint8_t CACHE_SIZE = 32;
static AVCLAN_frame_t frames[CACHE_SIZE];
constinit static Queue cache(frames);
constinit static Queue incoming = cache;
constinit static Queue outgoing = cache;
void Setup();
void print_help();
static void toggle_flag(bool *flag, const char *msg) {
*flag = !*flag;
RS232_Print(msg);
RS232_Print(offon[*flag]);
RS232_Print("\n");
}
static void set_flag(bool *flag, bool val, const char *msg) {
*flag = val;
RS232_Print(msg);
RS232_Print(offon[val]);
RS232_Print("\n");
}
int main() {
uint8_t hexChars[2];
uint8_t hexDigit = 0; // current digit being written to hexChars
bool readSeq = false;
bool seqIsUnicast = false;
bool readBinary = false;
bool verbose = true;
bool printAllFrames = true;
bool lastPrintAllFrames = true;
bool printBinary = false;
bool echoCharacters = true;
bool muteBus = false;
// Binary-mode REPL includes the full wire preamble (broadcast + 2*addr +
// control + length), so size for the worst case.
uint8_t data_tmp[MAXMSGLEN + sizeof(AVCLAN_frame_t)];
uint8_t seqIdx = 0; // current index in data_tmp
uint8_t err = 0;
uint8_t failedStatusReports = 0;
// Temporary, direct access is questionable since cache has ownership
for (uint8_t i = 0; i < CACHE_SIZE; ++i) {
frames[i].control = 0x0f;
}
const AVCLAN_frame_t *lastStatus = nullptr;
Setup();
print_help();
while (true) {
if (AVCLAN_busActive()) {
if (auto msg = cache.pop()) {
err = AVCLAN_readframe(msg.get(), (log_t){.print = printAllFrames,
.binary = printBinary,
.verbose = verbose});
if (!err)
incoming.push(std::move(msg));
} else {
RS232_Print("!! Dropping an incoming message; cache is empty !!\n");
}
}
if (auto in = incoming.peek()) {
if (auto out = cache.pop()) {
AVCLAN_handleframe(in, out.get());
incoming.pop();
if (out->reaction)
outgoing.push(std::move(out));
} else {
RS232_Print("!! Unable to respond; cache is empty !!\n");
}
}
if (statustimer_tickPending()) {
if (auto status = cache.pop()) {
lastStatus = status.get();
AVCLAN_generateStatus(status.get(), true, dev_STATUS);
status->reaction = r_SendOnly;
outgoing.push(std::move(status));
statustimer_clearTick();
}
}
if (auto out = outgoing.pop()) {
err = AVCLAN_sendframe(
out.get(), (log_t){.print = printAllFrames, .binary = printBinary});
if (err || (reaction_t)out->reaction == r_SendOnly) {
if (err && out.get() == lastStatus && ++failedStatusReports > 1) {
failedStatusReports = 0;
AVCLAN_stopPlaying(); // Disable periodic updates if e.g. no-one's
// listening (car was turned off?)
}
} else {
AVCLAN_statemachine(out.get());
if (out->reaction)
outgoing.push(std::move(out));
}
}
// Key handler
if (RS232_hasChar()) {
char readkey = RS232_getChar();
switch (readkey) {
case '?': print_help(); break;
case 'v': toggle_flag(&verbose, "Verbose errors: "); break;
case 'l': toggle_flag(&printAllFrames, "Logging: "); break;
case 'k': toggle_flag(&echoCharacters, "Echo characters: "); break;
case 'm':
toggle_flag(&muteBus, "Mute device: ");
AVCLAN_muteDevice(muteBus);
break;
// X/x isn't a toggle interface because this is used
// programmatically and is simpler than reading back the toggle
// state
case 'X': set_flag(&printBinary, true, "Binary: "); break;
case 'x': set_flag(&printBinary, false, "Binary: "); break;
case 'E': // Beep
if (auto out = cache.pop()) {
out->is_unicast = true;
out->controller_addr = DEVICE_ADDR;
out->peripheral_addr = HU_ADDR;
{
const uint8_t beep[] = {0x00, dev_CD_CHANGER, dev_BEEP_SPEAKERS,
0x60, 0x01};
out->length = sizeof(beep);
memcpy(out->data, beep, sizeof(beep));
}
out->reaction = r_SendOnly;
outgoing.push(std::move(out));
}
break;
case 'P':
if (auto out = cache.pop()) {
out->is_unicast = true;
out->controller_addr = DEVICE_ADDR;
out->peripheral_addr = HU_ADDR;
{
const uint8_t play[] = {0x00, dev_COMM_CTRL, dev_COMM_v1,
Ejection, dev_CD_CHANGER, 0x01};
out->length = sizeof(play);
memcpy(out->data, play, sizeof(play));
}
out->reaction = r_Ejection;
outgoing.push(std::move(out));
}
break;
#ifndef NDEBUG
case 'g': AVCLAN_micToggle(); break;
case 'p':
RS232_Print("First play/pause begin ... ");
AVCLAN_mediaFunction(MEDIA_PLAY_PAUSE);
while (AVCLAN_isMediaFunctioning()) {}
RS232_Print("end\nSecond play/pause begin ... ");
AVCLAN_mediaFunction(MEDIA_PLAY_PAUSE);
while (AVCLAN_isMediaFunctioning()) {}
RS232_Print("end\n");
break;
case 's':
RS232_Print("Skip begin ... ");
AVCLAN_mediaFunction(MEDIA_SKIP_FORWARD);
while (AVCLAN_isMediaFunctioning()) {}
RS232_Print("end\n");
break;
case 'b':
RS232_Print("Skip back begin ... ");
AVCLAN_mediaFunction(MEDIA_SKIP_BACKWARD);
while (AVCLAN_isMediaFunctioning()) {}
RS232_Print("end\n");
break;
case 'M': AVCLan_Measure(); break;
#endif
case 0x10: // Signals binary sequence incoming
if (!readSeq && !readBinary) {
readSeq = readBinary = true;
seqIdx = 0;
break;
} else
goto DEFAULT; // reading binary and this is a real data byte
case 'U': // Send command
RS232_Print("READ SEQUENCE (U)> \n");
lastPrintAllFrames = printAllFrames;
printAllFrames = false;
readSeq = true;
seqIdx = hexDigit = 0;
hexChars[0] = hexChars[1] = 0;
seqIsUnicast = true;
break;
case 'B': // Send broadcast
RS232_Print("READ SEQUENCE (B)> \n");
lastPrintAllFrames = printAllFrames;
printAllFrames = false;
readSeq = true;
seqIdx = hexDigit = 0;
hexChars[0] = hexChars[1] = 0;
seqIsUnicast = false;
break;
case '\n':
if (readSeq) {
if (readBinary) {
if (data_tmp[seqIdx] == 0x17) {
if (auto out = cache.pop()) {
if (!AVCLAN_parseframe(data_tmp, --seqIdx, out.get())) {
out->reaction = r_SendOnly;
outgoing.push(std::move(out));
}
}
readSeq = readBinary = false;
} else
goto DEFAULT; // reading binary and this is a real data byte;
// fall through to default
} else {
if (auto out = cache.pop()) {
out->is_unicast = seqIsUnicast;
out->controller_addr = DEVICE_ADDR;
out->peripheral_addr = seqIsUnicast ? HU_ADDR : 0x1FF;
out->length = seqIdx;
memcpy(out->data, data_tmp, seqIdx);
out->reaction = r_SendOnly;
outgoing.push(std::move(out));
}
printAllFrames = lastPrintAllFrames;
}
break;
}
DEFAULT:
default:
if (readSeq) {
if (readBinary) {
data_tmp[seqIdx++] = readkey;
} else {
hexChars[hexDigit++] = readkey;
if (hexDigit == 2) {
char h, l;
h = toupper(hexChars[0]);
h += (h < ':') ? 0xd0 : 0xc9; // digit or letter
l = toupper(hexChars[1]);
l += (l < ':') ? 0xd0 : 0xc9;
data_tmp[seqIdx++] = (h << 4) | l;
hexDigit = hexChars[0] = hexChars[1] = 0;
}
if (echoCharacters) {
RS232_Print("CURRENT SEQUENCE > ");
for (uint8_t i = 0; i < seqIdx; i++) {
RS232_PrintHex8(data_tmp[i]);
RS232_SendByte(' ');
}
RS232_Print("\n");
}
}
}
} // switch (readkey)
} // if (RS232_hasChar())
}
return 0;
}
void Setup() {
board_init(); // clock + GPIO bring-up (target-specific)
RS232_Init();
AVCLAN_init();
board_interruptsEnable();
}
void print_help() {
RS232_Print("AVCLAN Mockingboard v1\n");
RS232_Print("U - begin reading for unicast message\n"
"B - begin reading for broadcast message\n"
"m - Toggle mute for mockingboard bus activity\n"
"v - Toggle verbose error logging\n"
"l - Toggle message logging\n"
"X/x - Turn binary logging ON or OFF, respectively\n"
"k - Toggle character echo\n"
"E - Beep\n"
"P - Play\n"
#ifndef NDEBUG
"g - Toggle MIC_CONTROL high/low\n"
"p - double MIC play/pause pulse\n" // Confirm pulse function and
// refractory timing
"s - MIC skip forward\n"
"b - MIC skip backward\n"
"M - Measure bit-timing (pulse-widths and periods)\n"
#endif
"? - Print this message\n");
}