language.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. /** @file */
  2. //language.h
  3. #ifndef LANGUAGE_H
  4. #define LANGUAGE_H
  5. #include "config.h"
  6. #include "macros.h"
  7. #include <inttypes.h>
  8. #ifdef DEBUG_SEC_LANG
  9. #include <stdio.h>
  10. #endif //DEBUG_SEC_LANG
  11. #define PROTOCOL_VERSION "1.0"
  12. #ifndef CUSTOM_MENDEL_NAME
  13. #define MACHINE_NAME "Mendel"
  14. #endif
  15. #ifndef MACHINE_UUID
  16. #define MACHINE_UUID "00000000-0000-0000-0000-000000000000"
  17. #endif
  18. #define MSG_FW_VERSION "Firmware"
  19. #if (LANG_MODE == 0) //primary language only
  20. #define PROGMEM_I2 __attribute__((section(".progmem0")))
  21. #define PROGMEM_I1 __attribute__((section(".progmem1")))
  22. #define PROGMEM_N1 __attribute__((section(".progmem2")))
  23. #define _I(s) (__extension__({static const char __c[] PROGMEM_I1 = s; &__c[0];}))
  24. #define ISTR(s) s
  25. #define _i(s) _I(s)
  26. #define _T(s) s
  27. #else //(LANG_MODE == 0)
  28. // section .loc_sec (originaly .progmem0) will be used for localized translated strings
  29. #define PROGMEM_I2 __attribute__((section(".loc_sec")))
  30. // section .loc_pri (originaly .progmem1) will be used for localized strings in english
  31. #define PROGMEM_I1 __attribute__((section(".loc_pri")))
  32. // section .noloc (originaly progmem2) will be used for not localized strings in english
  33. #define PROGMEM_N1 __attribute__((section(".noloc")))
  34. #define _I(s) (__extension__({static const char __c[] PROGMEM_I1 = "\xff\xff" s; &__c[0];}))
  35. #define ISTR(s) "\xff\xff" s
  36. #define _i(s) lang_get_translation(_I(s))
  37. #define _T(s) lang_get_translation(s)
  38. #endif //(LANG_MODE == 0)
  39. #define _N(s) (__extension__({static const char __c[] PROGMEM_N1 = s; &__c[0];}))
  40. #define _n(s) _N(s)
  41. /** @brief lang_table_header_t structure - (size= 16byte) */
  42. typedef struct
  43. {
  44. uint32_t magic; //+0
  45. uint16_t size; //+4
  46. uint16_t count; //+6
  47. uint16_t checksum; //+8
  48. uint16_t code; //+10
  49. uint32_t signature; //+12
  50. } lang_table_header_t;
  51. /** @brief lang_table_t structure - (size= 16byte + 2*count) */
  52. typedef struct
  53. {
  54. lang_table_header_t header;
  55. uint16_t table[];
  56. } lang_table_t;
  57. /** @name Language indices into their particular symbol tables.*/
  58. ///@{
  59. #define LANG_ID_PRI 0
  60. #define LANG_ID_SEC 1
  61. ///@}
  62. /** @def LANG_ID_FORCE_SELECTION
  63. * @brief Language is not defined and it shall be selected from the menu.*/
  64. #define LANG_ID_FORCE_SELECTION 254
  65. /** @def LANG_ID_UNDEFINED
  66. * @brief Language is not defined on a virgin RAMBo board. */
  67. #define LANG_ID_UNDEFINED 255
  68. /** @def LANG_ID_DEFAULT
  69. * @brief Default language ID, if no language is selected. */
  70. #define LANG_ID_DEFAULT LANG_ID_PRI
  71. /** @def LANG_MAGIC
  72. * @brief Magic number at begin of lang table. */
  73. #define LANG_MAGIC 0x4bb45aa5
  74. /** @name Language codes (ISO639-1)*/
  75. ///@{
  76. #define LANG_CODE_XX 0x3f3f //!<'??'
  77. #define LANG_CODE_EN 0x656e //!<'en'
  78. #define LANG_CODE_CZ 0x6373 //!<'cs'
  79. #define LANG_CODE_DE 0x6465 //!<'de'
  80. #define LANG_CODE_ES 0x6573 //!<'es'
  81. #define LANG_CODE_FR 0x6672 //!<'fr'
  82. #define LANG_CODE_IT 0x6974 //!<'it'
  83. #define LANG_CODE_PL 0x706c //!<'pl'
  84. #ifdef COMMUNITY_LANG_SUPPORT //Community language support
  85. #ifdef COMMUNITY_LANG_NL
  86. #define LANG_CODE_NL 0x6e6c //!<'nl'
  87. #endif // COMMUNITY_LANG_NL
  88. //Use the 3 lines below as a template and replace 'QR', '0X7172' and 'qr'
  89. //#ifdef COMMUNITY_LANG_QR
  90. //#define LANG_CODE_QR 0x7172 //!<'qr'
  91. //#endif // COMMUNITY_LANG_QR
  92. #endif // COMMUNITY_LANG_SUPPORT
  93. ///@}
  94. #if defined(__cplusplus)
  95. extern "C" {
  96. #endif //defined(__cplusplus)
  97. /** @brief Currectly active language selection.*/
  98. extern uint8_t lang_selected;
  99. #if (LANG_MODE != 0)
  100. extern const char _SEC_LANG[LANG_SIZE_RESERVED];
  101. extern const char* lang_get_translation(const char* s);
  102. /** @def _SEC_LANG_TABLE
  103. * @brief Align table to start of 256 byte page */
  104. #define _SEC_LANG_TABLE ((((uint16_t)&_SEC_LANG) + 0x00ff) & 0xff00)
  105. #endif //(LANG_MODE != 0)
  106. /** @brief selects language, eeprom is updated in case of success */
  107. extern uint8_t lang_select(uint8_t lang);
  108. /** @brief performs checksum test of secondary language data */
  109. extern uint8_t lang_check(uint16_t addr);
  110. /** @return total number of languages (primary + all in xflash) */
  111. extern uint8_t lang_get_count(void);
  112. /** @brief reads lang table header and offset in xflash or progmem */
  113. extern uint8_t lang_get_header(uint8_t lang, lang_table_header_t* header, uint32_t* offset);
  114. /** @brief reads lang code from xflash or progmem */
  115. extern uint16_t lang_get_code(uint8_t lang);
  116. /** @return localized language name (text for menu item) */
  117. extern const char* lang_get_name_by_code(uint16_t code);
  118. /** @brief reset language to "LANG_ID_FORCE_SELECTION", epprom is updated */
  119. extern void lang_reset(void);
  120. /** @retval 1 language is selected */
  121. extern uint8_t lang_is_selected(void);
  122. #ifdef DEBUG_SEC_LANG
  123. extern const char* lang_get_sec_lang_str_by_id(uint16_t id);
  124. extern uint16_t lang_print_sec_lang(FILE* out);
  125. #endif //DEBUG_SEC_LANG
  126. extern void lang_boot_update_start(uint8_t lang);
  127. #if defined(__cplusplus)
  128. }
  129. #endif //defined(__cplusplus)
  130. #define CAT2(_s1, _s2) _s1
  131. #define CAT4(_s1, _s2, _s3, _s4) _s1
  132. #include "messages.h"
  133. #endif //LANGUAGE_H