#include "StreamAPI.h" #include "PowerFSM.h" #include "RTC.h" #include "Throttle.h" #include "concurrency/LockGuard.h" #include "configuration.h" #define START1 0x94 #define START2 0xc3 #define HEADER_LEN 4 int32_t StreamAPI::runOncePart() { auto result = readStream(); writeStream(); checkConnectionTimeout(); return result; } int32_t StreamAPI::runOncePart(char *buf, uint16_t bufLen) { auto result = readStream(buf, bufLen); writeStream(); checkConnectionTimeout(); return result; } /** * Read any rx chars from the link and call handleRecStream */ int32_t StreamAPI::readStream(const char *buf, uint16_t bufLen) { if (bufLen < 1) { // Nothing available this time, if the computer has talked to us recently, poll often, otherwise let CPU sleep a long time bool recentRx = Throttle::isWithinTimespanMs(lastRxMsec, 2000); return recentRx ? 5 : 250; } else { handleRecStream(buf, bufLen); // we had bytes available this time, so assume we might have them next time also lastRxMsec = millis(); return 0; } } /** * call getFromRadio() and deliver encapsulated packets to the Stream */ void StreamAPI::writeStream() { if (canWrite) { uint32_t len; do { // Send every packet we can len = getFromRadio(txBuf + HEADER_LEN); if (len != 0 && !emitTxBuffer(len)) break; } while (len); } } int32_t StreamAPI::handleRecStream(const char *buf, uint16_t bufLen) { uint16_t index = 0; while (bufLen > index) { // Currently we never want to block int cInt = buf[index++]; if (cInt < 0) break; // We ran out of characters (even though available said otherwise) - this can happen on rf52 adafruit // arduino uint8_t c = (uint8_t)cInt; // Use the read pointer for a little state machine, first look for framing, then length bytes, then payload size_t ptr = rxPtr; rxPtr++; // assume we will probably advance the rxPtr rxBuf[ptr] = c; // store all bytes (including framing) // console->printf("rxPtr %d ptr=%d c=0x%x\n", rxPtr, ptr, c); if (ptr == 0) { // looking for START1 if (c != START1) rxPtr = 0; // failed to find framing } else if (ptr == 1) { // looking for START2 if (c != START2) rxPtr = 0; // failed to find framing } else if (ptr >= HEADER_LEN - 1) { // we have at least read our 4 byte framing uint32_t len = (rxBuf[2] << 8) + rxBuf[3]; // big endian 16 bit length follows framing // console->printf("len %d\n", len); if (ptr == HEADER_LEN - 1) { // we _just_ finished our 4 byte header, validate length now (note: a length of zero is a valid // protobuf also) if (len > MAX_TO_FROM_RADIO_SIZE) rxPtr = 0; // length is bogus, restart search for framing } if (rxPtr != 0) // Is packet still considered 'good'? if (ptr + 1 >= len + HEADER_LEN) { // have we received all of the payload? rxPtr = 0; // start over again on the next packet // If we didn't just fail the packet and we now have the right # of bytes, parse it handleToRadio(rxBuf + HEADER_LEN, len); } } } return 0; } /** * Read any rx chars from the link and call handleToRadio */ int32_t StreamAPI::readStream() { if (!stream->available()) { // Nothing available this time, if the computer has talked to us recently, poll often, otherwise let CPU sleep a long time bool recentRx = Throttle::isWithinTimespanMs(lastRxMsec, 2000); return recentRx ? 5 : 250; } else { while (stream->available()) { // Currently we never want to block int cInt = stream->read(); if (cInt < 0) break; // We ran out of characters (even though available said otherwise) - this can happen on rf52 adafruit // arduino uint8_t c = (uint8_t)cInt; // Use the read pointer for a little state machine, first look for framing, then length bytes, then payload size_t ptr = rxPtr; rxPtr++; // assume we will probably advance the rxPtr rxBuf[ptr] = c; // store all bytes (including framing) // console->printf("rxPtr %d ptr=%d c=0x%x\n", rxPtr, ptr, c); if (ptr == 0) { // looking for START1 if (c != START1) rxPtr = 0; // failed to find framing } else if (ptr == 1) { // looking for START2 if (c != START2) rxPtr = 0; // failed to find framing } else if (ptr >= HEADER_LEN - 1) { // we have at least read our 4 byte framing uint32_t len = (rxBuf[2] << 8) + rxBuf[3]; // big endian 16 bit length follows framing // console->printf("len %d\n", len); if (ptr == HEADER_LEN - 1) { // we _just_ finished our 4 byte header, validate length now (note: a length of zero is a valid // protobuf also) if (len > MAX_TO_FROM_RADIO_SIZE) rxPtr = 0; // length is bogus, restart search for framing } if (rxPtr != 0) // Is packet still considered 'good'? if (ptr + 1 >= len + HEADER_LEN) { // have we received all of the payload? rxPtr = 0; // start over again on the next packet // If we didn't just fail the packet and we now have the right # of bytes, parse it handleToRadio(rxBuf + HEADER_LEN, len); } } } // we had bytes available this time, so assume we might have them next time also lastRxMsec = millis(); return 0; } } /** * Send the current txBuffer over our stream */ bool StreamAPI::writeFrame(uint8_t *buf, size_t len) { if (len == 0 || !canWrite) return false; buf[0] = START1; buf[1] = START2; buf[2] = (len >> 8) & 0xff; buf[3] = len & 0xff; auto totalLen = len + HEADER_LEN; // Serialize write-readiness checks, writes and write-failure handling // against concurrent stream writes/close. concurrency::LockGuard guard(&streamLock); if (!canWriteFrame(totalLen)) return false; size_t written = stream->write(buf, totalLen); if (written == totalLen) { stream->flush(); return true; } onFrameWriteFailed(totalLen, written); return false; } bool StreamAPI::emitTxBuffer(size_t len) { return writeFrame(txBuf, len); } void StreamAPI::emitRebooted() { // In case we send a FromRadio packet memset(&fromRadioScratch, 0, sizeof(fromRadioScratch)); fromRadioScratch.which_payload_variant = meshtastic_FromRadio_rebooted_tag; fromRadioScratch.rebooted = true; // LOG_DEBUG("Emitting reboot packet for serial shell"); emitTxBuffer(pb_encode_to_bytes(txBuf + HEADER_LEN, meshtastic_FromRadio_size, &meshtastic_FromRadio_msg, &fromRadioScratch)); } void StreamAPI::emitLogRecord(meshtastic_LogRecord_Level level, const char *src, const char *format, va_list arg) { // IMPORTANT: do NOT touch `fromRadioScratch` or `txBuf` here — those // belong to the main packet-emission path and a LOG_ firing during // `writeStream()` would corrupt an in-flight encode. We keep a // dedicated `fromRadioScratchLog` + `txBufLog` for log records and // only serialize the actual `stream->write` call via `streamLock` so // a concurrent packet emission doesn't interleave bytes on the wire. memset(&fromRadioScratchLog, 0, sizeof(fromRadioScratchLog)); fromRadioScratchLog.which_payload_variant = meshtastic_FromRadio_log_record_tag; fromRadioScratchLog.log_record.level = level; uint32_t rtc_sec = getValidTime(RTCQuality::RTCQualityDevice, true); fromRadioScratchLog.log_record.time = rtc_sec; strncpy(fromRadioScratchLog.log_record.source, src, sizeof(fromRadioScratchLog.log_record.source) - 1); auto num_printed = vsnprintf(fromRadioScratchLog.log_record.message, sizeof(fromRadioScratchLog.log_record.message) - 1, format, arg); if (num_printed > 0 && fromRadioScratchLog.log_record.message[num_printed - 1] == '\n') // Strip any ending newline, because we have records for framing instead. fromRadioScratchLog.log_record.message[num_printed - 1] = '\0'; size_t len = pb_encode_to_bytes(txBufLog + HEADER_LEN, meshtastic_FromRadio_size, &meshtastic_FromRadio_msg, &fromRadioScratchLog); writeFrame(txBufLog, len); } /// Hookable to find out when connection changes void StreamAPI::onConnectionChanged(bool connected) { // FIXME do reference counting instead if (connected) { // To prevent user confusion, turn off bluetooth while using the serial port api powerFSM.trigger(EVENT_SERIAL_CONNECTED); } else { // FIXME, we get no notice of serial going away, we should instead automatically generate this event if we haven't // received a packet in a while powerFSM.trigger(EVENT_SERIAL_DISCONNECTED); } }