From 77de25099619f0bf7060dd857127e312c3ecf3f5 Mon Sep 17 00:00:00 2001 From: Asbelos Date: Sat, 28 Sep 2024 08:59:47 +0100 Subject: [PATCH] Add IO_I2CRailcom --- DCCWaveform.cpp | 34 ++++++- DCCWaveform.h | 10 +- IODevice.h | 1 + IO_I2CRailcom.h | 258 +++++++++++++++++++++++++++++++++++++++++++++++ TrackManager.cpp | 4 +- 5 files changed, 297 insertions(+), 10 deletions(-) create mode 100644 IO_I2CRailcom.h diff --git a/DCCWaveform.cpp b/DCCWaveform.cpp index 0cfc719..9c43730 100644 --- a/DCCWaveform.cpp +++ b/DCCWaveform.cpp @@ -24,7 +24,6 @@ #ifndef ARDUINO_ARCH_ESP32 // This code is replaced entirely on an ESP32 #include - #include "DCCWaveform.h" #include "TrackManager.h" #include "DCCTimer.h" @@ -77,6 +76,7 @@ void DCCWaveform::interruptHandler() { // member functions would be cleaner but have more overhead if (cutoutNextTime) { cutoutNextTime=false; + railcomSampleWindow=false; // about to cutout, stop reading railcom data. DCCTimer::startRailcomTimer(9); } byte sigMain=signalTransform[mainTrack.state]; @@ -120,12 +120,30 @@ DCCWaveform::DCCWaveform( byte preambleBits, bool isMain) { bytes_sent = 0; bits_sent = 0; } - + +bool DCCWaveform::railcomPossible=false; // High accuracy only volatile bool DCCWaveform::railcomActive=false; // switched on by user volatile bool DCCWaveform::railcomDebug=false; // switched on by user +volatile bool DCCWaveform::railcomSampleWindow=false; // true during packet transmit + +bool DCCWaveform::isRailcom() { + return railcomActive; +} + +bool DCCWaveform::isRailcomSampleWindow() { + return railcomSampleWindow; +} +bool DCCWaveform::isRailcomPossible() { + return railcomPossible; +} + +void DCCWaveform::setRailcomPossible(bool yes) { + railcomPossible=yes; + if (!yes) setRailcom(false,false); +} bool DCCWaveform::setRailcom(bool on, bool debug) { - if (on) { + if (on && railcomPossible) { // TODO check possible railcomActive=true; railcomDebug=debug; @@ -133,6 +151,7 @@ bool DCCWaveform::setRailcom(bool on, bool debug) { else { railcomActive=false; railcomDebug=false; + railcomSampleWindow=false; } return railcomActive; } @@ -158,7 +177,12 @@ void DCCWaveform::interrupt2() { // that the reminder doesn't block a more urgent packet. reminderWindowOpen=transmitRepeats==0 && remainingPreambles<4 && remainingPreambles>1; if (remainingPreambles==1) promotePendingPacket(); - else if (remainingPreambles==14 && isMainTrack && railcomActive) DCCTimer::ackRailcomTimer(); + else if (isMainTrack && railcomActive) { + // cutout has ended so its now possible to poll the railcom detectors + if (remainingPreambles==5) railcomSampleWindow=true; + // cutout can be ended when read + else if (remainingPreambles==14) DCCTimer::ackRailcomTimer(); + } // Update free memory diagnostic as we don't have anything else to do this time. // Allow for checkAck and its called functions using 22 bytes more. else DCCTimer::updateMinimumFreeMemoryISR(22); @@ -235,7 +259,7 @@ void DCCWaveform::promotePendingPacket() { // Fortunately reset and idle packets are the same length // Note: If railcomDebug is on, then we send resets to the main // track instead of idles. This means that all data will be zeros - // and only the porersets will be ones, making it much + // and only the presets will be ones, making it much // easier to read on a logic analyser. memcpy( transmitPacket, (isMainTrack && (!railcomDebug)) ? idlePacket : resetPacket, sizeof(idlePacket)); transmitLength = sizeof(idlePacket); diff --git a/DCCWaveform.h b/DCCWaveform.h index 56ef29b..95de554 100644 --- a/DCCWaveform.h +++ b/DCCWaveform.h @@ -23,8 +23,6 @@ */ #ifndef DCCWaveform_h #define DCCWaveform_h - -#include "MotorDriver.h" #ifdef ARDUINO_ARCH_ESP32 #include "DCCRMT.h" #include "TrackManager.h" @@ -86,8 +84,10 @@ class DCCWaveform { bool isReminderWindowOpen(); void promotePendingPacket(); static bool setRailcom(bool on, bool debug); - static bool isRailcom() {return railcomActive;} - + static bool isRailcom(); + static bool isRailcomSampleWindow(); + static bool isRailcomPossible(); + static void setRailcomPossible(bool yes); private: #ifndef ARDUINO_ARCH_ESP32 volatile bool packetPending; @@ -112,8 +112,10 @@ class DCCWaveform { byte pendingPacket[MAX_PACKET_SIZE+1]; // +1 for checksum byte pendingLength; byte pendingRepeats; + static bool railcomPossible; // High accuracy mode only static volatile bool railcomActive; // switched on by user static volatile bool railcomDebug; // switched on by user + static volatile bool railcomSampleWindow; // when safe to sample static bool cutoutNextTime; // railcom #ifdef ARDUINO_ARCH_ESP32 static RMTChannel *rmtMainChannel; diff --git a/IODevice.h b/IODevice.h index 05df4df..17ade9d 100644 --- a/IODevice.h +++ b/IODevice.h @@ -570,6 +570,7 @@ protected: #include "IO_EncoderThrottle.h" #include "IO_TCA8418.h" #include "IO_NeoPixel.h" +#include "IO_I2CRailcom.h" #endif // iodevice_h diff --git a/IO_I2CRailcom.h b/IO_I2CRailcom.h new file mode 100644 index 0000000..609795d --- /dev/null +++ b/IO_I2CRailcom.h @@ -0,0 +1,258 @@ + /* + * © 2024, Henk Kruisbrink & Chris Harlow. All rights reserved. + * © 2023, Neil McKechnie. All rights reserved. + * + * This file is part of DCC++EX API + * + * This is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * It is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with CommandStation. If not, see . + */ + +/* + * + * Dec 2023, Added NXP SC16IS752 I2C Dual UART + * The SC16IS752 has 64 bytes TX & RX FIFO buffer + * First version without interrupts from I2C UART and only RX/TX are used, interrupts may not be + * needed as the RX Fifo holds the reply + * + * Jan 2024, Issue with using both UARTs simultaniously, the secod uart seems to work but the first transmit + * corrupt data. This need more analysis and experimenatation. + * Will push this driver to the dev branch with the uart fixed to 0 + * Both SC16IS750 (single uart) and SC16IS752 (dual uart, but only uart 0 is enable) + * + * myHall.cpp configuration syntax: + * + * I2CRailcom::create(1st vPin, vPins, I2C address); + * + * myAutomation configuration + * HAL(I2CRailcom, 1st vPin, vPins, I2C address) + * Parameters: + * 1st vPin : First virtual pin that EX-Rail can control to play a sound, use PLAYSOUND command (alias of ANOUT) + * vPins : Total number of virtual pins allocated (2 vPins are supported, one for each UART) + * 1st vPin for UART 0, 2nd for UART 1 + * I2C Address : I2C address of the serial controller, in 0x format + */ + +#ifndef IO_I2CRailcom_h +#define IO_I2CRailcom_h + +#include "IODevice.h" +#include "I2CManager.h" +#include "DIAG.h" +#include "DCCWaveform.h" + +// Debug and diagnostic defines, enable too many will result in slowing the driver +#define DIAG_I2CRailcom +#define DIAG_I2CRailcom_data + +class I2CRailcom : public IODevice { +private: + // SC16IS752 defines + uint8_t _UART_CH=0x00; + byte _inbuf[65]; + byte _outbuf[2]; +public: + // Constructor + I2CRailcom(VPIN firstVpin, int nPins, I2CAddress i2cAddress){ + _firstVpin = firstVpin; + _nPins = nPins; + _I2CAddress = i2cAddress; + addDevice(this); + } + +public: + static void create(VPIN firstVpin, int nPins, I2CAddress i2cAddress) { + if (nPins>2) nPins=2; + if (checkNoOverlap(firstVpin, nPins, i2cAddress)) + new I2CRailcom(firstVpin, nPins, i2cAddress); + } + + void _begin() override { + I2CManager.setClock(1000000); // TODO do we need this? + I2CManager.begin(); + auto exists=I2CManager.exists(_I2CAddress); + DIAG(F("I2CRailcom: %s UART%S detected"), + _I2CAddress.toString(), exists?F(""):F(" NOT")); + if (!exists) return; + + _UART_CH=0; + Init_SC16IS752(); // Initialize UART0 + if (_nPins>1) { + _UART_CH=1; + Init_SC16IS752(); // Initialize UART1 + } + if (_deviceState==DEVSTATE_INITIALISING) _deviceState=DEVSTATE_NORMAL; + _display(); + } + + + void _loop(unsigned long currentMicros) override { + // Read responses from device + if (_deviceState!=DEVSTATE_NORMAL) return; + + // return if in cutout or cutout very soon. + if (!DCCWaveform::isRailcomSampleWindow()) return; + + // flip channels each loop + if (_nPins>1) _UART_CH=_UART_CH?0:1; + + // Read incoming raw Railcom data, and process accordingly + auto inlength= UART_ReadRegister(REG_RXLV); + if (inlength==0) return; + { + #ifdef DIAG_I2CRailcom + DIAG(F("Railcom: %s/%d RX Fifo: %d"),_I2CAddress.toString(), _UART_CH, inlength); + #endif + _outbuf[0]=(byte)(REG_RHR << 3 | _UART_CH << 1); + I2CManager.read(_I2CAddress, _inbuf, inlength, _outbuf, 1); + #ifdef DIAG_I2CRailcom_data + DIAG(F("Railcom %s/%d RX FIFO Data"), _I2CAddress.toString(), _UART_CH); + for (int i = 0; i < inlength; i++){ + DIAG(F("[0x%x]: 0x%x"), i, _inbuf[i]); + } + #endif + } + + } + + + void _display() override { + DIAG(F("I2CRailcom Configured on Vpins:%u-%u %S"), _firstVpin, _firstVpin+_nPins-1, + (_deviceState!=DEVSTATE_NORMAL) ? F("OFFLINE") : F("")); + } + +private: + + + // SC16IS752 functions + // Initialise SC16IS752 only for this channel + // First a software reset + // Enable FIFO and clear TX & RX FIFO + // Need to set the following registers + // IOCONTROL set bit 1 and 2 to 0 indicating that they are GPIO + // IODIR set all bit to 1 indicating al are output + // IOSTATE set only bit 0 to 1 for UART 0, or only bit 1 for UART 1 // + // LCR bit 7=0 divisor latch (clock division registers DLH & DLL, they store 16 bit divisor), + // WORD_LEN, STOP_BIT, PARITY_ENA and PARITY_TYPE + // MCR bit 7=0 clock divisor devide-by-1 clock input + // DLH most significant part of divisor + // DLL least significant part of divisor + // + // BAUD_RATE, WORD_LEN, STOP_BIT, PARITY_ENA and PARITY_TYPE have been defined and initialized + // + // Communication parameters 8 bit, No parity, 1 stopbit + static const uint8_t WORD_LEN = 0x03; // Value LCR bit 0,1 + static const uint8_t STOP_BIT = 0x00; // Value LCR bit 2 + static const uint8_t PARITY_ENA = 0x00; // Value LCR bit 3 + static const uint8_t PARITY_TYPE = 0x00; // Value LCR bit 4 + static const uint32_t BAUD_RATE = 250000; + static const uint8_t PRESCALER = 0x01; // Value MCR bit 7 + static const unsigned long SC16IS752_XTAL_FREQ_RAILCOM = 16000000; // Baud rate for Railcom signal + static const uint16_t _divisor = (SC16IS752_XTAL_FREQ_RAILCOM / PRESCALER) / (BAUD_RATE * 16); + + void Init_SC16IS752(){ + + if (_UART_CH==0) { + // only reset on channel 0} + UART_WriteRegister(REG_IOCONTROL, 0x08,false); // UART Software reset + _deviceState=DEVSTATE_INITIALISING; // ignores error during reset which seems normal. + } + + UART_WriteRegister(REG_FCR, 0x07,false); // Reset FIFO, clear RX & TX FIFO (write only) + UART_WriteRegister(REG_MCR, 0x00); // Set MCR to all 0, includes Clock divisor + UART_WriteRegister(REG_LCR, 0x80); // Divisor latch enabled + UART_WriteRegister(REG_DLL, _divisor); // Write DLL + UART_WriteRegister(REG_DLH, (uint8_t)(_divisor >> 8)); // Write DLH + UART_WriteRegister(REG_LCR, WORD_LEN | STOP_BIT | PARITY_ENA | PARITY_TYPE); // Divisor latch disabled + UART_WriteRegister(REG_FCR, 0x07,false); // Reset FIFO, clear RX & TX FIFO (write only) + + if (_deviceState==DEVSTATE_INITIALISING) { + DIAG(F("UART %d init complete"),_UART_CH); + } + + } + + + + + void UART_WriteRegister(uint8_t reg, uint8_t val, bool readback=true){ + _outbuf[0] = (byte)( reg << 3 | _UART_CH << 1); + _outbuf[1]=val; + auto status=I2CManager.write(_I2CAddress, _outbuf, (uint8_t)2); + if(status!=I2C_STATUS_OK) { + DIAG(F("I2CRailcom %s/%d write reg=0x%x,data=0x%x,I2Cstate=%d"), + _I2CAddress.toString(), _UART_CH, reg, val, status); + _deviceState=DEVSTATE_FAILED; + } + if (readback) { // Read it back to cross check + auto readback=UART_ReadRegister(reg); + if (readback!=val) { + DIAG(F("I2CRailcom %s/%d reg:0x%x write=0x%x read=0x%x"),_I2CAddress.toString(),_UART_CH,reg,val,readback); + } + } + } + + + uint8_t UART_ReadRegister(uint8_t reg){ + _outbuf[0] = (byte)(reg << 3 | _UART_CH << 1); // _outbuffer[0] has now UART_REG and UART_CH + _inbuf[0]=0; + auto status=I2CManager.read(_I2CAddress, _inbuf, 1, _outbuf, 1); + if (status!=I2C_STATUS_OK) { + DIAG(F("I2CRailcom %s/%d read reg=0x%x,I2Cstate=%d"), + _I2CAddress.toString(), _UART_CH, reg, status); + _deviceState=DEVSTATE_FAILED; + } + return _inbuf[0]; + } + +// SC16IS752 General register set (from the datasheet) +enum : uint8_t { + REG_RHR = 0x00, // FIFO Read + REG_THR = 0x00, // FIFO Write + REG_IER = 0x01, // Interrupt Enable Register R/W + REG_FCR = 0x02, // FIFO Control Register Write + REG_IIR = 0x02, // Interrupt Identification Register Read + REG_LCR = 0x03, // Line Control Register R/W + REG_MCR = 0x04, // Modem Control Register R/W + REG_LSR = 0x05, // Line Status Register Read + REG_MSR = 0x06, // Modem Status Register Read + REG_SPR = 0x07, // Scratchpad Register R/W + REG_TCR = 0x06, // Transmission Control Register R/W + REG_TLR = 0x07, // Trigger Level Register R/W + REG_TXLV = 0x08, // Transmitter FIFO Level register Read + REG_RXLV = 0x09, // Receiver FIFO Level register Read + REG_IODIR = 0x0A, // Programmable I/O pins Direction register R/W + REG_IOSTATE = 0x0B, // Programmable I/O pins State register R/W + REG_IOINTENA = 0x0C, // I/O Interrupt Enable register R/W + REG_IOCONTROL = 0x0E, // I/O Control register R/W + REG_EFCR = 0x0F, // Extra Features Control Register R/W + }; + +// SC16IS752 Special register set +enum : uint8_t{ + REG_DLL = 0x00, // Division registers R/W + REG_DLH = 0x01, // Division registers R/W + }; + +// SC16IS752 Enhanced regiter set +enum : uint8_t{ + REG_EFR = 0X02, // Enhanced Features Register R/W + REG_XON1 = 0x04, // R/W + REG_XON2 = 0x05, // R/W + REG_XOFF1 = 0x06, // R/W + REG_XOFF2 = 0x07, // R/W + }; + +}; + +#endif // IO_I2CRailcom_h diff --git a/TrackManager.cpp b/TrackManager.cpp index ba9776b..e1bd6d4 100644 --- a/TrackManager.cpp +++ b/TrackManager.cpp @@ -334,7 +334,8 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr canDo &= track[t]->trackPWM; } } - if (!canDo) { + if (canDo) DIAG(F("HA mode")); + else { // if we discover that HA mode was globally impossible // we must adjust the trackPWM capabilities FOR_EACH_TRACK(t) { @@ -343,6 +344,7 @@ bool TrackManager::setTrackMode(byte trackToSet, TRACK_MODE mode, int16_t dcAddr } DCCTimer::clearPWM(); // has to be AFTER trackPWM changes because if trackPWM==true this is undone for that track } + DCCWaveform::setRailcomPossible(canDo); #else // For ESP32 we just reinitialize the DCC Waveform DCCWaveform::begin();