123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271 |
- /**
- * Marlin 3D Printer Firmware
- * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
- *
- * Based on Sprinter and grbl.
- * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
- *
- * This program 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.
- *
- * This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
- *
- */
-
- #include "../../../inc/MarlinConfigPre.h"
-
- #if HAS_DGUS_LCD_CLASSIC
-
- #if HOTENDS > 2
- #warning "More than 2 hotends not implemented on DGUS Display UI."
- #endif
-
- #include "../ui_api.h"
-
- #include "../../../MarlinCore.h"
- #include "../../../module/motion.h"
- #include "../../../gcode/queue.h"
- #include "../../../module/planner.h"
- #include "../../../libs/duration_t.h"
- #include "../../../module/printcounter.h"
- #if ENABLED(POWER_LOSS_RECOVERY)
- #include "../../../feature/powerloss.h"
- #endif
-
- #include "DGUSDisplay.h"
- #include "DGUSVPVariable.h"
- #include "DGUSDisplayDef.h"
-
- DGUSDisplay dgusdisplay;
-
- // Preamble... 2 Bytes, usually 0x5A 0xA5, but configurable
- constexpr uint8_t DGUS_HEADER1 = 0x5A;
- constexpr uint8_t DGUS_HEADER2 = 0xA5;
-
- constexpr uint8_t DGUS_CMD_WRITEVAR = 0x82;
- constexpr uint8_t DGUS_CMD_READVAR = 0x83;
-
- #if ENABLED(DEBUG_DGUSLCD)
- bool dguslcd_local_debug; // = false;
- #endif
-
- void DGUSDisplay::InitDisplay() {
- #ifndef LCD_BAUDRATE
- #define LCD_BAUDRATE 115200
- #endif
- LCD_SERIAL.begin(LCD_BAUDRATE);
-
- if (TERN1(POWER_LOSS_RECOVERY, !recovery.valid())) { // If no Power-Loss Recovery is needed...
- TERN_(DGUS_LCD_UI_MKS, delay(LOGO_TIME_DELAY)); // Show the logo for a little while
- }
-
- RequestScreen(TERN(SHOW_BOOTSCREEN, DGUSLCD_SCREEN_BOOT, DGUSLCD_SCREEN_MAIN));
- }
-
- void DGUSDisplay::WriteVariable(uint16_t adr, const void *values, uint8_t valueslen, bool isstr) {
- const char* myvalues = static_cast<const char*>(values);
- bool strend = !myvalues;
- WriteHeader(adr, DGUS_CMD_WRITEVAR, valueslen);
- while (valueslen--) {
- char x;
- if (!strend) x = *myvalues++;
- if ((isstr && !x) || strend) {
- strend = true;
- x = ' ';
- }
- LCD_SERIAL.write(x);
- }
- }
-
- void DGUSDisplay::WriteVariable(uint16_t adr, uint16_t value) {
- value = (value & 0xFFU) << 8U | (value >> 8U);
- WriteVariable(adr, static_cast<const void*>(&value), sizeof(uint16_t));
- }
-
- void DGUSDisplay::WriteVariable(uint16_t adr, int16_t value) {
- value = (value & 0xFFU) << 8U | (value >> 8U);
- WriteVariable(adr, static_cast<const void*>(&value), sizeof(uint16_t));
- }
-
- void DGUSDisplay::WriteVariable(uint16_t adr, uint8_t value) {
- WriteVariable(adr, static_cast<const void*>(&value), sizeof(uint8_t));
- }
-
- void DGUSDisplay::WriteVariable(uint16_t adr, int8_t value) {
- WriteVariable(adr, static_cast<const void*>(&value), sizeof(int8_t));
- }
-
- #if ENABLED(DGUS_LCD_UI_MKS)
- void DGUSDisplay::MKS_WriteVariable(uint16_t adr, uint8_t value) {
- WriteVariable(adr, static_cast<const void *>(&value), sizeof(uint8_t));
- }
- #endif
-
- void DGUSDisplay::WriteVariable(uint16_t adr, long value) {
- union { long l; char lb[4]; } endian;
- char tmp[4];
- endian.l = value;
- tmp[0] = endian.lb[3];
- tmp[1] = endian.lb[2];
- tmp[2] = endian.lb[1];
- tmp[3] = endian.lb[0];
- WriteVariable(adr, static_cast<const void*>(&tmp), sizeof(long));
- }
-
- void DGUSDisplay::WriteVariablePGM(uint16_t adr, const void *values, uint8_t valueslen, bool isstr) {
- const char* myvalues = static_cast<const char*>(values);
- bool strend = !myvalues;
- WriteHeader(adr, DGUS_CMD_WRITEVAR, valueslen);
- while (valueslen--) {
- char x;
- if (!strend) x = pgm_read_byte(myvalues++);
- if ((isstr && !x) || strend) {
- strend = true;
- x = ' ';
- }
- LCD_SERIAL.write(x);
- }
- }
-
- void DGUSDisplay::ProcessRx() {
-
- #if ENABLED(SERIAL_STATS_RX_BUFFER_OVERRUNS)
- if (!LCD_SERIAL.available() && LCD_SERIAL.buffer_overruns()) {
- // Overrun, but reset the flag only when the buffer is empty
- // We want to extract as many as valid datagrams possible...
- DEBUG_ECHOPGM("OVFL");
- rx_datagram_state = DGUS_IDLE;
- //LCD_SERIAL.reset_rx_overun();
- LCD_SERIAL.flush();
- }
- #endif
-
- uint8_t receivedbyte;
- while (LCD_SERIAL.available()) {
- switch (rx_datagram_state) {
-
- case DGUS_IDLE: // Waiting for the first header byte
- receivedbyte = LCD_SERIAL.read();
- //DEBUG_ECHOPAIR("< ",x);
- if (DGUS_HEADER1 == receivedbyte) rx_datagram_state = DGUS_HEADER1_SEEN;
- break;
-
- case DGUS_HEADER1_SEEN: // Waiting for the second header byte
- receivedbyte = LCD_SERIAL.read();
- //DEBUG_ECHOPAIR(" ",x);
- rx_datagram_state = (DGUS_HEADER2 == receivedbyte) ? DGUS_HEADER2_SEEN : DGUS_IDLE;
- break;
-
- case DGUS_HEADER2_SEEN: // Waiting for the length byte
- rx_datagram_len = LCD_SERIAL.read();
- DEBUG_ECHOPAIR(" (", rx_datagram_len, ") ");
-
- // Telegram min len is 3 (command and one word of payload)
- rx_datagram_state = WITHIN(rx_datagram_len, 3, DGUS_RX_BUFFER_SIZE) ? DGUS_WAIT_TELEGRAM : DGUS_IDLE;
- break;
-
- case DGUS_WAIT_TELEGRAM: // wait for complete datagram to arrive.
- if (LCD_SERIAL.available() < rx_datagram_len) return;
-
- Initialized = true; // We've talked to it, so we defined it as initialized.
- uint8_t command = LCD_SERIAL.read();
-
- DEBUG_ECHOPAIR("# ", command);
-
- uint8_t readlen = rx_datagram_len - 1; // command is part of len.
- unsigned char tmp[rx_datagram_len - 1];
- unsigned char *ptmp = tmp;
- while (readlen--) {
- receivedbyte = LCD_SERIAL.read();
- DEBUG_ECHOPAIR(" ", receivedbyte);
- *ptmp++ = receivedbyte;
- }
- DEBUG_ECHOPGM(" # ");
- // mostly we'll get this: 5A A5 03 82 4F 4B -- ACK on 0x82, so discard it.
- if (command == DGUS_CMD_WRITEVAR && 'O' == tmp[0] && 'K' == tmp[1]) {
- DEBUG_ECHOLNPGM(">");
- rx_datagram_state = DGUS_IDLE;
- break;
- }
-
- /* AutoUpload, (and answer to) Command 0x83 :
- | tmp[0 1 2 3 4 ... ]
- | Example 5A A5 06 83 20 01 01 78 01 ……
- | / / | | \ / | \ \
- | Header | | | | \_____\_ DATA (Words!)
- | DatagramLen / VPAdr |
- | Command DataLen (in Words) */
- if (command == DGUS_CMD_READVAR) {
- const uint16_t vp = tmp[0] << 8 | tmp[1];
- //const uint8_t dlen = tmp[2] << 1; // Convert to Bytes. (Display works with words)
- //DEBUG_ECHOPAIR(" vp=", vp, " dlen=", dlen);
- DGUS_VP_Variable ramcopy;
- if (populate_VPVar(vp, &ramcopy)) {
- if (ramcopy.set_by_display_handler)
- ramcopy.set_by_display_handler(ramcopy, &tmp[3]);
- else
- DEBUG_ECHOLNPGM(" VPVar found, no handler.");
- }
- else
- DEBUG_ECHOLNPAIR(" VPVar not found:", vp);
-
- rx_datagram_state = DGUS_IDLE;
- break;
- }
-
- // discard anything else
- rx_datagram_state = DGUS_IDLE;
- }
- }
- }
-
- size_t DGUSDisplay::GetFreeTxBuffer() { return SERIAL_GET_TX_BUFFER_FREE(); }
-
- void DGUSDisplay::WriteHeader(uint16_t adr, uint8_t cmd, uint8_t payloadlen) {
- LCD_SERIAL.write(DGUS_HEADER1);
- LCD_SERIAL.write(DGUS_HEADER2);
- LCD_SERIAL.write(payloadlen + 3);
- LCD_SERIAL.write(cmd);
- LCD_SERIAL.write(adr >> 8);
- LCD_SERIAL.write(adr & 0xFF);
- }
-
- void DGUSDisplay::WritePGM(const char str[], uint8_t len) {
- while (len--) LCD_SERIAL.write(pgm_read_byte(str++));
- }
-
- void DGUSDisplay::loop() {
- // protect against recursion… ProcessRx() may indirectly call idle() when injecting gcode commands.
- if (!no_reentrance) {
- no_reentrance = true;
- ProcessRx();
- no_reentrance = false;
- }
- }
-
- rx_datagram_state_t DGUSDisplay::rx_datagram_state = DGUS_IDLE;
- uint8_t DGUSDisplay::rx_datagram_len = 0;
- bool DGUSDisplay::Initialized = false;
- bool DGUSDisplay::no_reentrance = false;
-
- // A SW memory barrier, to ensure GCC does not overoptimize loops
- #define sw_barrier() asm volatile("": : :"memory");
-
- bool populate_VPVar(const uint16_t VP, DGUS_VP_Variable * const ramcopy) {
- // DEBUG_ECHOPAIR("populate_VPVar ", VP);
- const DGUS_VP_Variable *pvp = DGUSLCD_FindVPVar(VP);
- // DEBUG_ECHOLNPAIR(" pvp ", (uint16_t )pvp);
- if (!pvp) return false;
- memcpy_P(ramcopy, pvp, sizeof(DGUS_VP_Variable));
- return true;
- }
-
- #endif // HAS_DGUS_LCD_CLASSIC
|