language.h 4.8 KB

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