Firmware2/Marlin/src/lcd/HD44780/lcdprint_hd44780.cpp

/**
 * @file    lcdprint_hd44780.cpp
 * @brief   LCD print api for HD44780
 * @author  Yunhui Fu (yhfudev@gmail.com)
 * @version 1.0
 * @date    2016-08-19
 * @copyright GPL/BSD
 */

/**
 * Due to the limitation of the HD44780 hardware, the current available LCD modules can only support
 *   Western(English), Cyrillic(Russian), Kana(Japanese) charsets.
 */

#include "../../inc/MarlinConfigPre.h"

#if HAS_CHARACTER_LCD

#include "../ultralcd.h"
#include "../../MarlinCore.h"

#include "ultralcd_HD44780.h"

#include <string.h>

#ifndef LCD_CLASS
  #include <LiquidCrystal.h>
  #define LCD_CLASS LiquidCrystal
#endif
extern LCD_CLASS lcd;

int lcd_glyph_height() { return 1; }

typedef struct _hd44780_charmap_t {
  wchar_t uchar; // the unicode char
  uint8_t idx;   // the glyph of the char in the ROM
  uint8_t idx2;  // the char used to be combined with the idx to simulate a single char
} hd44780_charmap_t;

#ifdef __AVR__
  #define IV(a) U##a
#else
  #define IV(a) L##a
#endif

static const hd44780_charmap_t g_hd44780_charmap_device[] PROGMEM = {
  // sorted by uchar:
  #if DISPLAY_CHARSET_HD44780 == JAPANESE

    {IV('¢'), 0xEC, 0}, // A2
    {IV('°'), 0xDF, 0}, // B0, Marlin special: '°'  LCD_STR_DEGREE (0x09)
    {IV('ä'), 0xE1, 0}, // E4
    {IV('ö'), 0xEF, 0}, // F6
    {IV('÷'), 0xFD, 0}, // 00F7
    {IV('ü'), 0xF5, 0}, // 00FC
    {IV('ˣ'), 0xEB, 0}, // 02E3

    {IV('·'), 0xA5, 0}, // 0387
    {IV('Ώ'), 0xF4, 0}, // 038F
    {IV('Θ'), 0xF2, 0}, // 0398, Theta
    {IV('Ξ'), 0xE3, 0}, // 039E, Xi
    {IV('Σ'), 0xF6, 0}, // 03A3, Sigma
    {IV('Ω'), 0xF4, 0}, // 03A9, Omega
    {IV('ά'), 0xE0, 0}, // 03AC
    {IV('έ'), 0xE3, 0}, // 03AD
    {IV('α'), 0xE0, 0}, // 03B1, alpha
    {IV('β'), 0xE2, 0}, // 03B2, beta
    {IV('ε'), 0xE3, 0}, // 03B5, epsilon
    {IV('θ'), 0xF2, 0}, // 03B8, theta
    {IV('μ'), 0xE4, 0}, // 03BC, mu
    {IV('ξ'), 0xE3, 0}, // 03BE, xi
    {IV('π'), 0xF7, 0}, // 03C0, pi
    {IV('ρ'), 0xE6, 0}, // 03C1, rho
    {IV('σ'), 0xE5, 0}, // 03C3, sigma

    {IV('←'), 0x7F, 0}, // 2190
    {IV('→'), 0x7E, 0}, // 2192, Marlin special: '⮈⮉⮊⮋➤→' LCD_STR_ARROW_RIGHT (0x03)
    {IV('√'), 0xE8, 0}, // 221A
    {IV('∞'), 0xF3, 0}, // 221E
    {IV('█'), 0xFF, 0}, // 2588

    //{IV(''), 0xA0, 0},
    {IV('。'), 0xA1, 0},
    {IV('「'), 0xA2, 0},
    {IV('」'), 0xA3, 0},
    {IV('゛'), 0xDE, 0}, // ‶
    {IV('゜'), 0xDF, 0}, // '〫'
    {IV('゠'), '=', 0},
    {IV('ァ'), 0xA7, 0},
    {IV('ア'), 0xB1, 0},
    {IV('ィ'), 0xA8, 0},
    {IV('イ'), 0xB2, 0},
    {IV('ゥ'), 0xA9, 0},
    {IV('ウ'), 0xB3, 0},
    {IV('ェ'), 0xAA, 0},
    {IV('エ'), 0xB4, 0},
    {IV('ォ'), 0xAB, 0},

    {IV('オ'), 0xB5, 0},
    {IV('カ'), 0xB6, 0},
    {IV('ガ'), 0xB6, 0xDE},
    {IV('キ'), 0xB7, 0},
    {IV('ギ'), 0xB7, 0xDE},
    {IV('ク'), 0xB8, 0},
    {IV('グ'), 0xB8, 0xDE},
    {IV('ケ'), 0xB9, 0},
    {IV('ゲ'), 0xB9, 0xDE},
    {IV('コ'), 0xBA, 0},
    {IV('ゴ'), 0xBA, 0xDE},
    {IV('サ'), 0xBB, 0},
    {IV('ザ'), 0xBB, 0xDE},
    {IV('シ'), 0xBC, 0},
    {IV('ジ'), 0xBC, 0xDE},
    {IV('ス'), 0xBD, 0},
    {IV('ズ'), 0xBD, 0xDE},
    {IV('セ'), 0xBE, 0},
    {IV('ゼ'), 0xBE, 0xDE},
    {IV('ソ'), 0xBF, 0},
    {IV('ゾ'), 0xBF, 0xDE},

    {IV('タ'), 0xC0, 0},
    {IV('ダ'), 0xC0, 0xDE},
    {IV('チ'), 0xC1, 0},
    {IV('ヂ'), 0xC1, 0xDE},
    {IV('ッ'), 0xAF, 0},
    {IV('ツ'), 0xC2, 0},
    {IV('ヅ'), 0xC2, 0xDE},
    {IV('テ'), 0xC3, 0},
    {IV('デ'), 0xC3, 0xDE},
    {IV('ト'), 0xC4, 0},
    {IV('ド'), 0xC4, 0xDE},
    {IV('ナ'), 0xC5, 0},
    {IV('ニ'), 0xC6, 0},
    {IV('ヌ'), 0xC7, 0},
    {IV('ネ'), 0xC8, 0},
    {IV('ノ'), 0xC9, 0},
    {IV('ハ'), 0xCA, 0},
    {IV('バ'), 0xCA, 0xDE},
    {IV('パ'), 0xCA, 0xDF},
    {IV('ヒ'), 0xCB, 0},
    {IV('ビ'), 0xCB, 0xDE},
    {IV('ピ'), 0xCB, 0xDF},
    {IV('フ'), 0xCC, 0},
    {IV('ブ'), 0xCC, 0xDE},
    {IV('プ'), 0xCC, 0xDF},
    {IV('ヘ'), 0xCD, 0},
    {IV('ベ'), 0xCD, 0xDE},
    {IV('ペ'), 0xCD, 0xDF},
    {IV('ホ'), 0xCE, 0},
    {IV('ボ'), 0xCE, 0xDE},
    {IV('ポ'), 0xCE, 0xDF},
    {IV('マ'), 0xCF, 0},

    {IV('ミ'), 0xD0, 0},
    {IV('ム'), 0xD1, 0},
    {IV('メ'), 0xD2, 0},
    {IV('モ'), 0xD3, 0},
    {IV('ャ'), 0xAC, 0},
    {IV('ヤ'), 0xD4, 0},
    {IV('ュ'), 0xAD, 0},
    {IV('ユ'), 0xD5, 0},
    {IV('ョ'), 0xAE, 0},
    {IV('ヨ'), 0xD6, 0},
    {IV('ラ'), 0xD7, 0},
    {IV('リ'), 0xD8, 0},
    {IV('ル'), 0xD9, 0},
    {IV('レ'), 0xDA, 0},
    {IV('ロ'), 0xDB, 0},
    {IV('ワ'), 0xDC, 0},
    {IV('ヲ'), 0xA6, 0},
    {IV('ン'), 0xDD, 0},
    {IV('ヴ'), 0xB3, 0xDE},
    {IV('ヷ'), 0xDC, 0xDE},
    {IV('ヺ'), 0xA6, 0xDE},
    {IV('・'), 0xA5, 0},
    {IV('ー'), 0xB0, 0},
    {IV('ヽ'), 0xA4, 0},

    //{IV('g'), 0xE7, 0}, // error
    //{IV(''), 0xE9, 0},
    //{IV('j'), 0xEA, 0}, // error
    //{IV(''), 0xED, 0},
    //{IV(''), 0xEE, 0},

    //{IV('p'), 0xF0, 0}, // error
    //{IV('q'), 0xF1, 0}, // error
    //{IV(''), 0xF8, 0},
    //{IV('y'), 0xF9, 0}, // error
    {IV('万'), 0xFB, 0},
    {IV('円'), 0xFC, 0},
    {IV('千'), 0xFA, 0},
    //{IV(''), 0xFE, 0},

    //､･ｦｧｨｩｪｫｬｭｮｯｰ
    {IV('､'), 0xA4, 0}, //ヽ
    {IV('･'), 0xA5, 0}, //・
    {IV('ｦ'), 0xA6, 0}, //ヲ
    {IV('ｧ'), 0xA7, 0}, //ァ
    {IV('ｨ'), 0xA8, 0}, //ィ
    {IV('ｩ'), 0xA9, 0}, //ゥ
    {IV('ｪ'), 0xAA, 0}, //ェ
    {IV('ｫ'), 0xAB, 0}, //ォ
    {IV('ｬ'), 0xAC, 0}, //ャ
    {IV('ｭ'), 0xAD, 0}, //ュ
    {IV('ｮ'), 0xAE, 0}, //ョ
    {IV('ｯ'), 0xAF, 0}, //ッ
    {IV('ｰ'), 0xB0, 0}, //ー

    //ｱｲｳｴｵｶｷｸｹｺｻｼｽｾ
    {IV('ｱ'), 0xB1, 0}, //ア
    {IV('ｲ'), 0xB2, 0}, //イ
    {IV('ｳ'), 0xB3, 0}, //ウ
    {IV('ｴ'), 0xB4, 0}, //エ
    {IV('ｵ'), 0xB5, 0}, //オ
    {IV('ｶ'), 0xB6, 0}, //カ
    {IV('ｷ'), 0xB7, 0}, //キ
    {IV('ｸ'), 0xB8, 0}, //ク
    {IV('ｹ'), 0xB9, 0}, //ケ
    {IV('ｺ'), 0xBA, 0}, //コ
    {IV('ｻ'), 0xBB, 0}, //サ
    {IV('ｼ'), 0xBC, 0}, //シ
    {IV('ｽ'), 0xBD, 0}, //ス
    {IV('ｾ'), 0xBE, 0}, //セ

    //ｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌ
    {IV('ｿ'), 0xBF, 0}, //ソ
    {IV('ﾀ'), 0xC0, 0}, //タ
    {IV('ﾁ'), 0xC1, 0}, //チ
    {IV('ﾂ'), 0xC2, 0}, //ツ
    {IV('ﾃ'), 0xC3, 0}, //テ
    {IV('ﾄ'), 0xC4, 0}, //ト
    {IV('ﾅ'), 0xC5, 0}, //ナ
    {IV('ﾆ'), 0xC6, 0}, //ニ
    {IV('ﾇ'), 0xC7, 0}, //ヌ
    {IV('ﾈ'), 0xC8, 0}, //ネ
    {IV('ﾉ'), 0xC9, 0}, //ノ
    {IV('ﾊ'), 0xCA, 0}, //ハ
    {IV('ﾋ'), 0xCB, 0}, //ヒ
    {IV('ﾌ'), 0xCC, 0}, //フ

    //ﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜﾝﾞﾟ
    {IV('ﾍ'), 0xCD, 0}, //ヘ
    {IV('ﾎ'), 0xCE, 0}, //ホ
    {IV('ﾏ'), 0xCF, 0}, //マ
    {IV('ﾐ'), 0xD0, 0}, //ミ
    {IV('ﾑ'), 0xD1, 0}, //ム
    {IV('ﾒ'), 0xD2, 0}, //メ
    {IV('ﾓ'), 0xD3, 0}, //モ
    {IV('ﾔ'), 0xD4, 0}, //ヤ
    {IV('ﾕ'), 0xD5, 0}, //ユ
    {IV('ﾖ'), 0xD6, 0}, //ヨ
    {IV('ﾗ'), 0xD7, 0}, //ラ
    {IV('ﾘ'), 0xD8, 0}, //リ
    {IV('ﾙ'), 0xD9, 0}, //ル
    {IV('ﾚ'), 0xDA, 0}, //レ
    {IV('ﾛ'), 0xDB, 0}, //ロ
    {IV('ﾜ'), 0xDC, 0}, //ワ
    {IV('ﾝ'), 0xDD, 0}, //ン
    {IV('ﾞ'), 0xDE, 0}, // ゛
    {IV('ﾟ'), 0xDF, 0}, // ゜

    {IV('￥'), 0x5C, 0},

  #elif DISPLAY_CHARSET_HD44780 == WESTERN
    // 0x10 -- 0x1F (except 0x1C)
    // 0x80 -- 0xFF (except 0xA7,0xB0,0xB1,0xB3,0xB4,0xBF,0xD1,0xF8,0xFA,0xFC-0xFF)

    {IV('¡'), 0xA9, 0},
    {IV('¢'), 0xA4, 0},
    {IV('£'), 0xA5, 0},
    {IV('¥'), 0xA6, 0},
    {IV('§'), 0xD2, 0}, // section sign
    {IV('©'), 0xCF, 0},

    {IV('ª'), 0x9D, 0},
    {IV('«'), 0xBB, 0},
    {IV('®'), 0xCE, 0},

    {IV('°'), 0xB2, 0}, // Marlin special: '°'  LCD_STR_DEGREE (0x09)
    //{IV(''), 0xD1, 0},
    {IV('±'), 0x10, 0}, //∓±
    //{'='), 0x1C, 0}, // error
    {IV('²'), 0x1E, 0},
    {IV('³'), 0x1F, 0},
    {IV('¶'), 0xD3, 0}, // pilcrow sign
    {IV('º'), 0x9E, 0},
    {IV('»'), 0xBC, 0}, // 00BB
    //{IV(''), 0xB3, 0}, // error
    //{IV(''), 0xB4, 0}, // error
    {IV('¼'), 0xB6, 0}, // 00BC
    {IV('½'), 0xB5, 0}, // 00BD
    //{IV('¾'), '3', 0}, // 00BE
    {IV('¿'), 0x9F, 0}, // 00BF

    {IV('Â'), 0x8F, 0},
    {IV('Ã'), 0xAA, 0},
    {IV('Ä'), 0x8E, 0},
    {IV('Æ'), 0x92, 0},
    {IV('Ç'), 0x80, 0},
    {IV('É'), 0x90, 0},
    {IV('Ñ'), 0x9C, 0},
    {IV('Õ'), 0xAC, 0},
    {IV('Ö'), 0x99, 0},
    {IV('×'), 0xB7, 0},
    {IV('Ø'), 0xAE, 0},
    {IV('Ü'), 0x9A, 0},
    {IV('à'), 0x85, 0},
    {IV('á'), 0xA0, 0},
    {IV('â'), 0x83, 0},
    {IV('ã'), 0xAB, 0},
    {IV('ä'), 0x84, 0},
    {IV('å'), 0x86, 0},
    {IV('æ'), 0x91, 0},
    {IV('ç'), 0x87, 0},
    {IV('è'), 0x8A, 0},
    {IV('é'), 0x82, 0},
    {IV('ê'), 0x88, 0},
    {IV('ë'), 0x89, 0},
    {IV('ì'), 0x8D, 0},
    {IV('í'), 0xA1, 0},
    {IV('î'), 0x8C, 0},
    {IV('ï'), 0x8B, 0},

    {IV('ñ'), 0x9B, 0},
    {IV('ò'), 0x95, 0},
    {IV('ó'), 0xA2, 0},
    {IV('ô'), 0x93, 0},
    {IV('õ'), 0xAD, 0},
    {IV('ö'), 0x94, 0},
    {IV('÷'), 0xB8, 0},
    {IV('ø'), 0xAF, 0},
    {IV('ù'), 0x97, 0},
    {IV('ú'), 0xA3, 0},
    {IV('û'), 0x96, 0},
    {IV('ü'), 0x81, 0},
    {IV('ÿ'), 0x98, 0},

    //{IV(''), 0xB0, 0}, // error
    //{IV(''), 0xB1, 0}, // error
    {IV('ƒ'), 0xA8, 0}, // 0192

    {IV('Ύ'), 0xDB, 0}, // 038E
    {IV('Ώ'), 0xDE, 0}, // 038F
    {IV('ΐ'), 0xE7, 0}, // 0390

    {IV('Γ'), 0xD4, 0}, // 0393, Gamma
    {IV('Δ'), 0xD5, 0}, // 0394, Delta, ◿
    {IV('Θ'), 0xD6, 0}, // 0398, Theta
    {IV('Λ'), 0xD7, 0}, // 039B, Lambda
    {IV('Ξ'), 0xD8, 0}, // 039E, Xi
    {IV('Π'), 0xD9, 0}, // Pi
    {IV('Σ'), 0xDA, 0}, // Sigma
    {IV('Υ'), 0xDB, 0}, // Upsilon
    {IV('Φ'), 0xDC, 0}, // Phi
    {IV('Ψ'), 0xDD, 0}, // Psi
    {IV('Ω'), 0xDE, 0}, // Omega

    {IV('ά'), 0xDF, 0}, // 03AC
    {IV('έ'), 0xE3, 0}, // 03AD
    {IV('ή'), 0xE5, 0}, // 03AE
    {IV('ί'), 0xE7, 0}, // 03AF
    {IV('ΰ'), 0xF1, 0}, // 03B0

    {IV('α'), 0xDF, 0}, // alpha
    {IV('β'), 0xE0, 0}, // beta
    {IV('γ'), 0xE1, 0}, // gamma
    {IV('δ'), 0xE2, 0}, // delta
    {IV('ε'), 0xE3, 0}, // epsilon
    {IV('ζ'), 0xE4, 0}, // zeta
    {IV('η'), 0xE5, 0}, // eta
    {IV('θ'), 0xE6, 0}, // theta
    {IV('ι'), 0xE7, 0}, // lota
    {IV('κ'), 0xE8, 0}, // kappa
    {IV('λ'), 0xE9, 0}, // lambda
    {IV('μ'), 0xEA, 0}, // mu
    {IV('ν'), 0xEB, 0}, // nu
    {IV('ξ'), 0xEC, 0}, // xi
    {IV('π'), 0xED, 0}, // pi
    {IV('ρ'), 0xEE, 0}, // rho
    {IV('σ'), 0xEF, 0}, // sigma

    {IV('τ'), 0xF0, 0}, // tau
    {IV('υ'), 0xF1, 0}, // upsilon
    {IV('χ'), 0xF2, 0}, // chi
    {IV('ψ'), 0xF3, 0}, // psi
    {IV('ω'), 0xF4, 0}, // 03C9, omega
    {IV('ϊ'), 0xE7, 0}, // 03CA
    {IV('ϋ'), 0xF1, 0}, // 03CB
    {IV('ύ'), 0xF1, 0}, // 03CD
    {IV('ώ'), 0xF4, 0}, // 03CE

    {IV('•'), 0xCD, 0}, // ·
    {IV('℞'), 0xA7, 0}, // ℞ Pt ASCII 158
    {IV('™'), 0xD0, 0},
    {IV('↤'), 0xF9, 0}, // ⟻
    {IV('↵'), 0xC4, 0},
    {IV('↻'), 0x04, 0}, // Marlin special: '↻↺⟳⟲'  LCD_STR_REFRESH (0x01)
    {IV('⇥'), 0xFB, 0},
    {IV('√'), 0xBE, 0}, // √
    {IV('∞'), 0xC2, 0}, // infinity
    {IV('∫'), 0x1B, 0},
    {IV('∼'), 0x1D, 0},
    {IV('≈'), 0x1A, 0},
    {IV('≠'), 0xBD, 0},
    {IV('≡'), 0x11, 0},
    {IV('≤'), 0xB9, 0},// ≤≥ ⩽⩾
    {IV('≥'), 0xBA, 0},
    //{IV(''), 0xBF, 0}, // error

    {IV('⌠'), 0xC0, 0},
    {IV('⌡'), 0xC1, 0},

    {IV('⎧'), 0x14, 0},
    {IV('⎩'), 0x15, 0},
    {IV('⎫'), 0x16, 0},
    {IV('⎭'), 0x17, 0},
    {IV('⎰'), 0x18, 0},
    {IV('⎱'), 0x19, 0},

    {IV('⎲'), 0x12, 0},
    {IV('⎳'), 0x13, 0},

    {IV('⏱'), 0x07, 0}, // Marlin special: '🕐🕑🕒🕓🕔🕕🕖🕗🕘🕙🕚🕛🕜🕝🕞🕟🕠🕡🕢🕣🕤🕥🕦🕧 ⌚⌛⏰⏱⏳⧖⧗'  LCD_STR_CLOCK (0x05)
    {IV('┌'), 0xC9, 0},
    {IV('┐'), 0xCA, 0},
    {IV('└'), 0xCB, 0},
    {IV('┘'), 0xCC, 0},
    {IV('◸'), 0xC3, 0}, // ◿
    {IV('⭠'), 0xC8, 0},
    {IV('⭡'), 0xC5, 0},
    {IV('⭢'), 0xC7, 0},
    {IV('⭣'), 0xC6, 0},


    {IV('⯆'), 0xF5, 0},
    {IV('⯇'), 0xF7, 0}, // ⯅
    {IV('⯈'), 0xF6, 0},
    //{IV(''), 0xF8, 0}, // error
    //{IV(''), 0xFA, 0}, // error
    //{IV(''), 0xFC, 0}, // error
    //{IV(''), 0xFD, 0}, // error
    //{IV(''), 0xFE, 0}, // error
    //{IV(''), 0xFF, 0}, // error

  #elif DISPLAY_CHARSET_HD44780 == CYRILLIC

    {IV('¢'), 0x5C, 0}, // 00A2
    {IV('£'), 0xCF, 0}, // 00A3
    {IV('°'), 0x01, 0}, // 00B0, Marlin special: '°'  LCD_STR_DEGREE (0x09)

    //{IV(''), 0x80, 0},
    //{IV(''), 0x81, 0},
    //{IV(''), 0x82, 0},
    //{IV(''), 0x83, 0},
    //{IV(''), 0x84, 0},
    //{IV(''), 0x85, 0},
    //{IV(''), 0x86, 0},
    //{IV(''), 0x87, 0},
    //{IV(''), 0x88, 0},
    //{IV(''), 0x89, 0},
    //{IV(''), 0x8A, 0},
    //{IV(''), 0x8B, 0},
    //{IV(''), 0x8C, 0},
    //{IV(''), 0x8D, 0},
    //{IV(''), 0x8E, 0},
    //{IV(''), 0x8F, 0},

    //{IV(''), 0x90, 0},
    //{IV(''), 0x91, 0},
    //{IV(''), 0x92, 0},
    //{IV(''), 0x93, 0},
    //{IV(''), 0x94, 0},
    //{IV(''), 0x95, 0},
    //{IV(''), 0x96, 0},
    //{IV(''), 0x97, 0},
    //{IV(''), 0x98, 0},
    //{IV(''), 0x99, 0},
    //{IV(''), 0x9A, 0},
    //{IV(''), 0x9B, 0},
    //{IV(''), 0x9C, 0},
    //{IV(''), 0x9D, 0},
    //{IV(''), 0x9E, 0},
    //{IV(''), 0x9F, 0},


    {IV('¼'), 0xF0, 0}, // 00BC
    {IV('⅓'), 0xF1, 0},
    {IV('½'), 0xF2, 0}, // 00BD
    {IV('¾'), 0xF3, 0}, // 00BE
    {IV('¿'), 0xCD, 0}, // 00BF

    #if ENABLED(DISPLAY_CHARSET_ISO10646_5)

      // Map Cyrillic to HD44780 extended CYRILLIC where possible
      {IV('Ё'), 0xA2, 0}, // 0401
      {IV('А'), 'A', 0}, // 0410
      {IV('Б'), 0xA0, 0},
      {IV('В'), 'B', 0},
      {IV('Г'), 0xA1, 0},
      {IV('Д'), 0xE0, 0},
      {IV('Е'), 'E', 0},
      {IV('Ж'), 0xA3, 0},
      {IV('З'), 0xA4, 0},
      {IV('И'), 0xA5, 0},
      {IV('Й'), 0xA6, 0},
      {IV('К'), 'K', 0},
      {IV('Л'), 0xA7, 0},
      {IV('М'), 'M', 0},
      {IV('Н'), 'H', 0},
      {IV('О'), 'O', 0},
      {IV('П'), 0xA8, 0},
      {IV('Р'), 'P', 0},
      {IV('С'), 'C', 0},
      {IV('Т'), 'T', 0},
      {IV('У'), 0xA9, 0},
      {IV('Ф'), 0xAA, 0},
      {IV('Х'), 'X', 0},
      {IV('Ц'), 0xE1, 0},
      {IV('Ч'), 0xAB, 0},
      {IV('Ш'), 0xAC, 0},
      {IV('Щ'), 0xE2, 0},
      {IV('Ъ'), 0xAD, 0},
      {IV('Ы'), 0xAE, 0},
      {IV('Ь'), 'b', 0},
      {IV('Э'), 0xAF, 0},
      {IV('Ю'), 0xB0, 0},
      {IV('Я'), 0xB1, 0},
      {IV('а'), 'a', 0},

      {IV('б'), 0xB2, 0},
      {IV('в'), 0xB3, 0},
      {IV('г'), 0xB4, 0},
      {IV('д'), 0xE3, 0},
      {IV('е'), 'e', 0},
      {IV('ж'), 0xB6, 0},
      {IV('з'), 0xB7, 0},
      {IV('и'), 0xB8, 0},
      {IV('й'), 0xB9, 0},
      {IV('к'), 0xBA, 0}, //клмноп
      {IV('л'), 0xBB, 0},
      {IV('м'), 0xBC, 0},
      {IV('н'), 0xBD, 0},
      {IV('о'), 'o', 0},
      {IV('п'), 0xBE, 0},
      {IV('р'), 'p', 0},
      {IV('с'), 'c', 0},
      {IV('т'), 0xBF, 0},

      {IV('у'), 'y', 0},
      {IV('ф'), 0xE4, 0},
      {IV('х'), 'x', 0},
      {IV('ц'), 0xE5, 0},
      {IV('ч'), 0xC0, 0},
      {IV('ш'), 0xC1, 0},
      {IV('щ'), 0xE6, 0},
      {IV('ъ'), 0xC2, 0},
      {IV('ы'), 0xC3, 0},
      {IV('ь'), 0xC4, 0},
      {IV('э'), 0xC5, 0},
      {IV('ю'), 0xC6, 0},
      {IV('я'), 0xC7, 0}, // 044F
      {IV('ё'), 0xB5, 0}, // 0451
      //{IV(''), 0xC8, 0},
      //{IV(''), 0xC9, 0},
      //{IV(''), 0xCA, 0},
      //{IV(''), 0xCB, 0},
      //{IV(''), 0xCC, 0},
      //{IV(''), 0xCD, 0},
      //{IV(''), 0xCE, 0},

      //{IV(''), 0xD0, 0},
      //{IV(''), 0xD1, 0},
      //{IV(''), 0xD2, 0},
      //{IV(''), 0xD3, 0},
      //{IV(''), 0xD4, 0},
      //{IV(''), 0xD5, 0},
      //{IV(''), 0xD6, 0},
      //{IV(''), 0xD7, 0},
      //{IV(''), 0xD8, 0},
      //{IV(''), 0xDB, 0},
      //{IV(''), 0xDC, 0},
      //{IV(''), 0xDD, 0},
      //{IV(''), 0xDE, 0},
      //{IV(''), 0xDF, 0},

      //{IV(''), 0xE7, 0},
      //{IV(''), 0xE8, 0},
      //{IV(''), 0xE9, 0},
      //{IV(''), 0xEA, 0},
      //{IV(''), 0xEB, 0},
      //{IV(''), 0xEC, 0},
      //{IV(''), 0xED, 0},
      //{IV(''), 0xEE, 0},
      //{IV(''), 0xEF, 0},

      //{IV(''), 0xF4, 0},
      //{IV(''), 0xF5, 0},
      //{IV(''), 0xF6, 0},
      //{IV(''), 0xF7, 0},
      //{IV(''), 0xF8, 0},
      //{IV(''), 0xF9, 0},
      //{IV(''), 0xFA, 0},
      //{IV(''), 0xFB, 0},
      //{IV(''), 0xFC, 0},
      //{IV(''), 0xFD, 0},
      //{IV(''), 0xFE, 0},
      //{IV(''), 0xFF, 0},

    #endif

    {IV('↑'), 0xD9, 0}, // 2191 ←↑→↓
    {IV('↓'), 0xDA, 0}, // 2193
  #endif
};

// the plain ASCII replacement for various char
static const hd44780_charmap_t g_hd44780_charmap_common[] PROGMEM = {
  {IV('¡'), 'i', 0}, // A1
  {IV('¢'), 'c', 0}, // A2
  {IV('°'), 0x09, 0}, // B0 Marlin special: '°'  LCD_STR_DEGREE (0x09)

  // Map WESTERN code to plain ASCII
  {IV('Á'), 'A', 0}, // C1
  {IV('Â'), 'A', 0}, // C2
  {IV('Ã'), 'A', 0}, // C3
  {IV('Ä'), 'A', 0}, // C4
  {IV('Å'), 'A', 0}, // C5
  {IV('Æ'), 'A', 'E'}, // C6
  {IV('Ç'), 'C', 0}, // C7
  {IV('È'), 'E', 0}, // C8
  {IV('É'), 'E', 0}, // C9
  {IV('Í'), 'I', 0}, // CD
  {IV('Ñ'), 'N', 0}, // D1
  {IV('Õ'), 'O', 0}, // D5
  {IV('Ö'), 'O', 0}, // D6
  {IV('×'), 'x', 0}, // D7
  {IV('Ü'), 'U', 0}, // DC
  {IV('Ý'), 'Y', 0}, // DD
  {IV('à'), 'a', 0}, // E0
  {IV('á'), 'a', 0},
  {IV('â'), 'a', 0},
  {IV('ã'), 'a', 0},
  {IV('ä'), 'a', 0},
  {IV('å'), 'a', 0},
  {IV('æ'), 'a', 'e'},
  {IV('ç'), 'c', 0},
  {IV('è'), 'e', 0}, // 00E8
  {IV('é'), 'e', 0},
  {IV('ê'), 'e', 0},
  {IV('ë'), 'e', 0},
  {IV('ì'), 'i', 0}, // 00EC
  {IV('í'), 'i', 0},
  {IV('î'), 'i', 0},
  {IV('ï'), 'i', 0}, // 00EF

  {IV('ñ'), 'n', 0}, // 00F1
  {IV('ò'), 'o', 0},
  {IV('ó'), 'o', 0},
  {IV('ô'), 'o', 0},
  {IV('õ'), 'o', 0},
  {IV('ö'), 'o', 0},
  //{IV('÷'), 0xB8, 0},
  {IV('ø'), 'o', 0},
  {IV('ù'), 'u', 0},
  {IV('ú'), 'u', 0},
  {IV('û'), 'u', 0},
  {IV('ü'), 'u', 0}, // FC
  {IV('ý'), 'y', 0}, // FD
  {IV('ÿ'), 'y', 0}, // FF

  {IV('Ą'), 'A', 0}, // 0104
  {IV('ą'), 'a', 0}, // 0105
  {IV('Ć'), 'C', 0}, // 0106
  {IV('ć'), 'c', 0}, // 0107
  {IV('Č'), 'C', 0}, // 010C
  {IV('č'), 'c', 0}, // 010D
  {IV('Ď'), 'D', 0}, // 010E
  {IV('ď'), 'd', 0}, // 010F
  {IV('đ'), 'd', 0}, // 0111
  {IV('ę'), 'e', 0}, // 0119
  {IV('ğ'), 'g', 0}, // 011F
  {IV('İ'), 'I', 0}, // 0130
  {IV('ı'), 'i', 0}, // 0131

  {IV('Ł'), 'L', 0}, // 0141
  {IV('ł'), 'l', 0}, // 0142
  {IV('Ń'), 'N', 0}, // 0143
  {IV('ń'), 'n', 0}, // 0144
  {IV('ň'), 'n', 0}, // 0148

  {IV('ř'), 'r', 0}, // 0159
  {IV('Ś'), 'S', 0}, // 015A
  {IV('ś'), 's', 0}, // 015B
  {IV('ş'), 's', 0}, // 015F
  {IV('Š'), 'S', 0}, // 0160
  {IV('š'), 's', 0}, // 0161
  {IV('ť'), 't', 0}, // 0165
  {IV('ů'), 'u', 0}, // 016F
  {IV('ż'), 'z', 0}, // 017C
  {IV('Ž'), 'Z', 0}, // 017D
  {IV('ž'), 'z', 0}, // 017E
  {IV('ƒ'), 'f', 0}, // 0192

  {IV('ˣ'), 'x', 0}, // 02E3

  #if ENABLED(DISPLAY_CHARSET_ISO10646_VI)

    // Map Vietnamese phonetics

    //{IV('à'), 'a', 0}, {IV('À'), 'A', 0},
    {IV('ạ'), 'a', 0}, {IV('Ạ'), 'A', 0},
    {IV('ả'), 'a', 0}, {IV('Ả'), 'A', 0},
    //{IV('ã'), 'a', 0}, {IV('Ã'), 'A', 0},
    //{IV('á'), 'á', 0}, {IV('Á'), 'A', 0},
    {IV('Ạ'), 'A', 0},
    {IV('ă'), 'a', 0}, {IV('Ă'), 'A', 0},
    {IV('ằ'), 'a', 0}, {IV('Ằ'), 'A', 0},
    {IV('ẳ'), 'a', 0}, {IV('Ẳ'), 'A', 0},
    {IV('ẵ'), 'a', 0}, {IV('Ẵ'), 'A', 0},
    {IV('ắ'), 'a', 0}, {IV('Ắ'), 'A', 0},
    {IV('ặ'), 'a', 0}, {IV('Ặ'), 'A', 0},
    {IV('â'), 'a', 0}, {IV('Â'), 'A', 0},
    {IV('ầ'), 'a', 0}, {IV('Ầ'), 'A', 0},
    {IV('ẩ'), 'a', 0}, {IV('Ẩ'), 'A', 0},
    {IV('ẫ'), 'a', 0}, {IV('Ẫ'), 'A', 0},
    {IV('ấ'), 'a', 0}, {IV('Ấ'), 'A', 0},
    {IV('ậ'), 'a', 0}, {IV('Ậ'), 'A', 0},
    //{IV('đ'), 'd', 0},
                       {IV('Đ'), 'D', 0},
    {IV('e'), 'e', 0}, {IV('E'), 'E', 0},
    {IV('è'), 'e', 0}, {IV('È'), 'E', 0},
    {IV('ẻ'), 'e', 0}, {IV('Ẻ'), 'E', 0},
    {IV('ẽ'), 'e', 0}, {IV('Ẽ'), 'E', 0},
    {IV('é'), 'e', 0}, {IV('É'), 'E', 0},
    {IV('ẹ'), 'e', 0}, {IV('Ẹ'), 'E', 0},
    {IV('ê'), 'e', 0}, {IV('Ê'), 'E', 0},
    {IV('ề'), 'e', 0}, {IV('Ề'), 'E', 0},
    {IV('ể'), 'e', 0}, {IV('Ể'), 'E', 0},
    {IV('ễ'), 'e', 0}, {IV('Ễ'), 'E', 0},
    {IV('ế'), 'e', 0}, {IV('Ế'), 'E', 0},
    {IV('ệ'), 'e', 0}, {IV('Ệ'), 'E', 0},
    {IV('i'), 'i', 0}, {IV('I'), 'I', 0},
    //{IV('ì'), 'ì', 0}, {IV('Ì'), 'Ì', 0},
    {IV('ỉ'), 'ỉ', 0}, {IV('Ỉ'), 'Ỉ', 0},
    {IV('ĩ'), 'ĩ', 0}, {IV('Ĩ'), 'Ĩ', 0},
    {IV('í'), 'í', 0}, {IV('Í'), 'Í', 0},
    {IV('ị'), 'ị', 0}, {IV('Ị'), 'Ị', 0},
    {IV('o'), 'o', 0}, {IV('O'), 'O', 0},
    {IV('ò'), 'o', 0}, {IV('Ò'), 'O', 0},
    {IV('ỏ'), 'o', 0}, {IV('Ỏ'), 'O', 0},
    {IV('õ'), 'o', 0}, {IV('Õ'), 'O', 0},
    {IV('ó'), 'o', 0}, {IV('Ó'), 'O', 0},
    {IV('ọ'), 'o', 0}, {IV('Ọ'), 'O', 0},
    {IV('ô'), 'o', 0}, {IV('Ô'), 'O', 0},
    {IV('ồ'), 'o', 0}, {IV('Ồ'), 'O', 0},
    {IV('ổ'), 'o', 0}, {IV('Ổ'), 'O', 0},
    {IV('ỗ'), 'o', 0}, {IV('Ỗ'), 'O', 0},
    {IV('ố'), 'o', 0}, {IV('Ố'), 'O', 0},
    {IV('ộ'), 'o', 0}, {IV('Ộ'), 'O', 0},
    {IV('ơ'), 'o', 0}, {IV('Ơ'), 'O', 0},
    {IV('ờ'), 'o', 0}, {IV('Ờ'), 'O', 0},
    {IV('ở'), 'o', 0}, {IV('Ở'), 'O', 0},
    {IV('ỡ'), 'o', 0}, {IV('Ỡ'), 'O', 0},
    {IV('ớ'), 'o', 0}, {IV('Ớ'), 'O', 0},
    {IV('ợ'), 'o', 0}, {IV('Ợ'), 'O', 0},
    {IV('ù'), 'u', 0}, {IV('Ù'), 'U', 0},
    {IV('ủ'), 'u', 0}, {IV('Ủ'), 'U', 0},
    {IV('ũ'), 'u', 0}, {IV('Ũ'), 'U', 0},
    //{IV('ú'), 'u', 0}, {IV('Ú'), 'U', 0},
    {IV('ụ'), 'u', 0}, {IV('Ụ'), 'U', 0},
    {IV('ư'), 'u', 0}, {IV('Ư'), 'U', 0},
    {IV('ừ'), 'u', 0}, {IV('Ừ'), 'U', 0},
    {IV('ử'), 'u', 0}, {IV('Ử'), 'U', 0},
    {IV('ữ'), 'u', 0}, {IV('Ữ'), 'U', 0},
    {IV('ứ'), 'u', 0}, {IV('Ứ'), 'U', 0},
    {IV('ự'), 'u', 0}, {IV('Ự'), 'U', 0},
    {IV('y'), 'y', 0}, {IV('Y'), 'Y', 0},

  #endif

  #if ENABLED(DISPLAY_CHARSET_ISO10646_GREEK)

    {IV('΄'), '\'', 0}, // 0384
    {IV('΅'), '\'', 0}, // 0385
    {IV('Ά'), 'A', 0}, // 0386
    {IV('·'), '.', 0}, // 0387
    {IV('Έ'), 'E', 0}, // 0388
    {IV('Ή'), 'H', 0}, // 0389
    {IV('Ί'), 'I', 0}, // 038A
    {IV('Ό'), 'O', 0}, // 038C
    {IV('Ύ'), 'Y', 0}, // 038E
    {IV('Ώ'), 'O', 0}, // 038F
    {IV('ΐ'), 'i', 0}, // 0390
    {IV('Α'), 'A', 0}, // 0391
    {IV('Β'), 'B', 0}, // 0392
    {IV('Γ'), 'T', 0}, // 0393, Gamma
    {IV('Δ'), '4', 0}, // 0394, Delta, ◿
    {IV('Ε'), 'E', 0}, // 0395
    {IV('Ζ'), 'Z', 0}, // 0396
    {IV('Η'), 'H', 0}, // 0397
    {IV('Θ'), '0', 0}, // 0398, Theta
    {IV('Ι'), 'I', 0}, // 0399
    {IV('Κ'), 'K', 0}, // 039A
    {IV('Λ'), '^', 0}, // 039B, Lambda
    {IV('Μ'), 'M', 0}, // 039C
    {IV('Ν'), 'N', 0}, // 039D
    {IV('Ξ'), '3', 0}, // 039E, Xi
    {IV('Ο'), 'O', 0}, // 039F
    {IV('Π'), 'n', 0}, // 03A0, Pi
    {IV('Ρ'), 'P', 0}, // 03A1
    {IV('Σ'), 'E', 0}, // 03A3, Sigma
    {IV('Τ'), 'T', 0}, // 03A4
    {IV('Υ'), 'Y', 0}, // 03A5, Upsilon
    {IV('Φ'), 'p', 0}, // 03A6, Phi
    {IV('Χ'), 'X', 0}, // 03A7
    {IV('Ψ'), 'P', 0}, // 03A8, Psi
    {IV('Ω'), 'O', 0}, // 03A9, Omega
    {IV('Ϊ'), 'I', 0}, // 03AA
    {IV('Ϋ'), 'Y', 0}, // 03AB
    {IV('ά'), 'a', 0}, // 03AC
    {IV('έ'), 'e', 0}, // 03AD
    {IV('ή'), 'n', 0}, // 03AE
    {IV('ί'), 'i', 0}, // 03AF
    {IV('ΰ'), 'v', 0}, // 03B0
    {IV('α'), 'a', 0}, // 03B1, alpha
    {IV('β'), 'B', 0}, // 03B2, beta
    {IV('γ'), 'v', 0}, // 03B3, gamma
    {IV('δ'), 'd', 0}, // 03B4, delta
    {IV('ε'), 'e', 0}, // 03B5, epsilon
    {IV('ζ'), 'Z', 0}, // 03B6, zeta
    {IV('η'), 'n', 0}, // 03B7, eta
    {IV('θ'), '0', 0}, // 03B8, theta
    {IV('ι'), 'i', 0}, // 03B9, lota
    {IV('κ'), 'k', 0}, // 03BA, kappa
    {IV('λ'), 'L', 0}, // 03BB, lambda
    {IV('μ'), 'u', 0}, // 03BC, mu
    {IV('ν'), 'v', 0}, // 03BD, nu
    {IV('ξ'), 'e', 0}, // 03BE, xi
    {IV('ο'), 'o', 0}, // 03BF
    {IV('π'), 'n', 0}, // 03C0, pi
    {IV('ρ'), 'p', 0}, // 03C1, rho
    {IV('ς'), 'c', 0}, // 03C2
    {IV('σ'), 'o', 0}, // 03C3, sigma
    {IV('τ'), 't', 0}, // 03C4, tau
    {IV('υ'), 'v', 0}, // 03C5, upsilon
    {IV('φ'), 'p', 0}, // 03C6
    {IV('χ'), 'X', 0}, // 03C7, chi
    {IV('ψ'), 'W', 0}, // 03C8, psi
    {IV('ω'), 'w', 0}, // 03C9, omega
    {IV('ϊ'), 'i', 0}, // 03CA
    {IV('ϋ'), 'v', 0}, // 03CB
    {IV('ό'), 'o', 0}, // 03CC
    {IV('ύ'), 'v', 0}, // 03CD
    {IV('ώ'), 'w', 0}, // 03CE

  #endif

  #if ENABLED(DISPLAY_CHARSET_ISO10646_5)
    // Map CYRILLIC code to plain ASCII
    {IV('Ё'), 'E', 0}, // 0401
    {IV('А'), 'A', 0}, // 0410
    {IV('Б'), 'b', 0}, // 0411
    {IV('В'), 'B', 0}, // 0412
    {IV('Г'), 'T', 0}, // 0413
    {IV('Д'), 'Q', 0}, // 0414
    {IV('Е'), 'E', 0}, // 0415
    {IV('Ж'), '*', 0}, // 0416
    {IV('З'), 'E', 0}, // 0417
    {IV('И'), 'N', 0}, // 0418
    {IV('Й'), 'N', 0}, // 0419
    {IV('К'), 'K', 0}, // 041A
    {IV('Л'), 'T', 0}, // 041B
    {IV('М'), 'M', 0}, // 041C
    {IV('Н'), 'H', 0}, // 041D
    {IV('О'), 'O', 0}, // 041E
    {IV('П'), 'n', 0}, // 041F
    {IV('Р'), 'P', 0}, // 0420
    {IV('С'), 'C', 0}, // 0421
    {IV('Т'), 'T', 0}, // 0422
    {IV('У'), 'Y', 0},
    {IV('Ф'), 'o', 0},
    {IV('Х'), 'X', 0},
    {IV('Ц'), 'U', 0},
    {IV('Ч'), 'y', 0},
    {IV('Ш'), 'W', 0},
    {IV('Щ'), 'W', 0},
    {IV('Ъ'), 'b', 0},
    {IV('Ы'), 'b', '|'},
    {IV('Ь'), 'b'},
    {IV('Э'), 'e'},
    {IV('Ю'), '|', 'O'},
    {IV('Я'), '9', '|'}, // 042F

    {IV('а'), 'a', 0}, // 0430
    {IV('б'), '6', 0}, // 0431
    {IV('в'), 'B', 0}, // 0432,
    {IV('г'), 'r', 0}, // 0433
    {IV('д'), 'a', 0}, // 0434,
    {IV('е'), 'e', 0}, // 0435
    {IV('ж'), '*', 0}, // 0436
    {IV('з'), 'e', 0}, // 0437,
    {IV('и'), 'u', 0}, // 0438
    {IV('й'), 'u', 0}, // 0439,
    {IV('к'), 'k', 0}, // 043A
    {IV('л'), 'n', 0},
    {IV('м'), 'm', 0},
    {IV('н'), 'H', 0},
    {IV('о'), 'o', 0},
    {IV('п'), 'n', 0},
    {IV('р'), 'p', 0},
    {IV('с'), 'c', 0},
    {IV('т'), 't', 0},
    {IV('у'), 'y', 0},
    {IV('ф'), 'q', 'p'},
    {IV('х'), 'x', 0},
    {IV('ц'), 'u', 0},
    {IV('ч'), 'y', 0},
    {IV('ш'), 'w', 0},
    {IV('щ'), 'w', 0},
    {IV('ъ'), 'b', 0},
    {IV('ы'), 'b', '|'},
    {IV('ь'), 'b', 0},
    {IV('э'), 'e', 0},
    {IV('ю'), '|', 'o'},
    {IV('я'), 'g', 0}, // 044F
    {IV('ё'), 'e', 0}, // 0451
  #endif

  {IV('•'), '.', 0}, // 2022 ·
  {IV('℞'), 'P', 'x'}, // 211E ℞ Pt ASCII 158
  {IV('™'), 'T', 'M'}, // 2122
  {IV('←'), '<', '-'}, // 2190
  {IV('→'), '-', '>'}, // 2192, Marlin special: '⮈⮉⮊⮋➤→⏵➟➠➡' LCD_STR_ARROW_RIGHT (0x03)
  //{IV('↰'), '<', 0}, // 21B0, Marlin special: '⮥⮭⮉⇧↑↰⤴'  LCD_STR_UPLEVEL (0x04)
  {IV('↰'), 0x03, 0}, // 21B0, Marlin special: '⮥⮭⮉⇧↑↰⤴'  LCD_STR_UPLEVEL (0x04)
  {IV('↻'), 0x04, 0}, // 21BB Marlin special: '↻↺⟳⟲'  LCD_STR_REFRESH (0x01)
  {IV('∼'), '~', 0}, // 223C
  {IV('≈'), '~', '='}, // 2248
  {IV('≠'), '!', '='}, // 2260
  {IV('≡'), '=', 0}, // 2261
  {IV('≤'), '<', '='},// 2264, ≤≥ ⩽⩾
  {IV('≥'), '>', '='}, // 2265
  {IV('⏱'), 0x07, 0}, // 23F1, Marlin special: '🕐🕑🕒🕓🕔🕕🕖🕗🕘🕙🕚🕛🕜🕝🕞🕟🕠🕡🕢🕣🕤🕥🕦🕧 ⌚⌛⏰⏱⏳⧖⧗'  LCD_STR_CLOCK (0x05)

  {IV('゠'), '=', 0}, // 30A0

  // ⏰⏱⏲⏳◴◵◶◷
  // ⏻⏼♁♂
  //{IV(''), 0x00, 0}, // Marlin special: ''  LCD_STR_BEDTEMP (0x07)
  {IV('🌡'), 0x02, 0}, // D83CDF21 Marlin special: '🌡'  LCD_STR_THERMOMETER (0x08)
  {IV('📂'), 0x05, 0}, // D83DDCC2 Marlin special: '📁📂'  LCD_STR_FOLDER (0x02)
  //{IV(''), 0x06, 0}, // Marlin special: ''  LCD_STR_FEEDRATE (0x06)
};

/* return v1 - v2 */
static int hd44780_charmap_compare(hd44780_charmap_t * v1, hd44780_charmap_t * v2) {
  return (v1->uchar < v2->uchar) ? -1 : (v1->uchar > v2->uchar) ? 1 : 0;
}

static int pf_bsearch_cb_comp_hd4map_pgm(void *userdata, size_t idx, void * data_pin) {
  hd44780_charmap_t localval;
  hd44780_charmap_t *p_hd44780_charmap = (hd44780_charmap_t *)userdata;
  memcpy_P(&localval, p_hd44780_charmap + idx, sizeof(localval));
  return hd44780_charmap_compare(&localval, (hd44780_charmap_t *)data_pin);
}

void lcd_moveto(const lcd_uint_t col, const lcd_uint_t row) { lcd.setCursor(col, row); }

void lcd_put_int(const int i) { lcd.print(i); }

// return < 0 on error
// return the advanced cols
int lcd_put_wchar_max(wchar_t c, pixel_len_t max_length) {

  // find the HD44780 internal ROM first
  int ret;
  size_t idx = 0;
  hd44780_charmap_t pinval;
  hd44780_charmap_t *copy_address = nullptr;
  pinval.uchar = c;
  pinval.idx = -1;

  if (max_length < 1) return 0;

  // TODO: fix the '\\' that doesnt exist in the HD44870
  if (c < 128) {
    lcd.write((uint8_t)c);
    return 1;
  }
  copy_address = nullptr;
  ret = pf_bsearch_r((void *)g_hd44780_charmap_device, COUNT(g_hd44780_charmap_device), pf_bsearch_cb_comp_hd4map_pgm, (void *)&pinval, &idx);
  if (ret >= 0) {
    copy_address = (hd44780_charmap_t *)(g_hd44780_charmap_device + idx);
  }
  else {
    ret = pf_bsearch_r((void *)g_hd44780_charmap_common, COUNT(g_hd44780_charmap_common), pf_bsearch_cb_comp_hd4map_pgm, (void *)&pinval, &idx);
    if (ret >= 0) copy_address = (hd44780_charmap_t *)(g_hd44780_charmap_common + idx);
  }

  if (ret >= 0) {
    hd44780_charmap_t localval;
    // found
    memcpy_P(&localval, copy_address, sizeof(localval));
    lcd.write(localval.idx);
    if (max_length >= 2 && localval.idx2 > 0) {
      lcd.write(localval.idx2);
      return 2;
    }
    return 1;
  }

  // Not found, print '?' instead
  lcd.write((uint8_t)'?');
  return 1;
}

/**
 * @brief Draw a UTF-8 string
 *
 * @param utf8_str : the UTF-8 string
 * @param cb_read_byte : the callback function to read one byte from the utf8_str (from RAM or ROM)
 * @param max_length : the pixel length of the string allowed (or number of slots in HD44780)
 *
 * @return the number of pixels advanced
 *
 * Draw a UTF-8 string
 */
static int lcd_put_u8str_max_cb(const char * utf8_str, uint8_t (*cb_read_byte)(uint8_t * str), pixel_len_t max_length) {
  pixel_len_t ret = 0;
  uint8_t *p = (uint8_t *)utf8_str;
  while (ret < max_length) {
    wchar_t ch = 0;
    p = get_utf8_value_cb(p, cb_read_byte, &ch);
    if (!ch) break;
    ret += lcd_put_wchar_max(ch, max_length - ret);
  }
  return (int)ret;
}

int lcd_put_u8str_max(const char * utf8_str, pixel_len_t max_length) {
  return lcd_put_u8str_max_cb(utf8_str, read_byte_ram, max_length);
}

int lcd_put_u8str_max_P(PGM_P utf8_str_P, pixel_len_t max_length) {
  return lcd_put_u8str_max_cb(utf8_str_P, read_byte_rom, max_length);
}

#if ENABLED(DEBUG_LCDPRINT)

  int test_hd44780_charmap(hd44780_charmap_t *data, size_t size, char *name, char flg_show_contents) {
    int ret;
    size_t idx = 0;
    hd44780_charmap_t preval = {0, 0, 0};
    hd44780_charmap_t pinval = {0, 0, 0};
    char flg_error = 0;

    int i;

    TRACE("Test %s\n", name);

    for (i = 0; i < size; i ++) {
      memcpy_P(&pinval, &(data[i]), sizeof(pinval));

      if (flg_show_contents) {
        #if 1
          TRACE("[% 4d] % 6" PRIu32 "(0x%04" PRIX32 ") --> 0x%02X,0x%02X%s\n", i, pinval.uchar, pinval.uchar, (unsigned int)(pinval.idx), (unsigned int)(pinval.idx2), (preval.uchar < pinval.uchar?"":" <--- ERROR"));
        #else
          TRACE("[% 4d]", i);
          TRACE("% 6" PRIu32 "(0x%04" PRIX32 "),", pinval.uchar, pinval.uchar);
          TRACE("0x%02X,", (unsigned int)(pinval.idx));
          TRACE("0x%02X,", (unsigned int)(pinval.idx2));
          TRACE("%s", (preval.uchar < pinval.uchar?"":" <--- ERROR"));
        #endif
      }
      if (preval.uchar >= pinval.uchar) {
        flg_error = 1;
        //TRACE("Error: out of order in array %s: idx=%d, val=%d(0x%x)\n", name, i, pinval.uchar, pinval.uchar);
        //return -1;
      }
      memcpy(&preval, &pinval, sizeof(pinval));

      ret = pf_bsearch_r((void *)data, size, pf_bsearch_cb_comp_hd4map_pgm, (void *)&pinval, &idx);
      if (ret < 0) {
        flg_error = 1;
        TRACE("Error: not found item in array %s: idx=%d, val=%d(0x%x)\n", name, i, pinval.uchar, pinval.uchar);
        //return -1;
      }
      if (idx != i) {
        flg_error = 1;
        TRACE("Error: wrong index found item in array %s: idx=%d, val=%d(0x%x)\n", name, i, pinval.uchar, pinval.uchar);
        //return -1;
      }
    }
    if (flg_error) {
      TRACE("\nError: in array %s\n\n", name);
      return -1;
    }
    TRACE("\nPASS array %s\n\n", name);
    return 0;
  }

  int test_hd44780_charmap_all() {
    int flg_error = 0;
    if (test_hd44780_charmap(g_hd44780_charmap_device, COUNT(g_hd44780_charmap_device), "g_hd44780_charmap_device", 0) < 0) {
      flg_error = 1;
      test_hd44780_charmap(g_hd44780_charmap_device, COUNT(g_hd44780_charmap_device), "g_hd44780_charmap_device", 1);
    }
    if (test_hd44780_charmap(g_hd44780_charmap_common, COUNT(g_hd44780_charmap_common), "g_hd44780_charmap_common", 0) < 0) {
      flg_error = 1;
      test_hd44780_charmap(g_hd44780_charmap_common, COUNT(g_hd44780_charmap_common), "g_hd44780_charmap_common", 1);
    }
    if (flg_error) {
      TRACE("\nFAILED in hd44780 tests!\n");
      return -1;
    }
    TRACE("\nPASS in hd44780 tests.\n");
    return 0;
  }

#endif // DEBUG_LCDPRINT

#endif // HAS_CHARACTER_LCD