src/main/cms/cms_types.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 //
  22 // Menu element types
  23 // XXX Upon separation, all OME would be renamed to CME_ or similar.
  24 //
  25
  26 #pragma once
  27
  28 //type of elements
  29
  30 typedef enum
  31 {
  32     OME_Label,
  33     OME_Back,
  34     OME_OSD_Exit,
  35     OME_Submenu,
  36     OME_Funcall,
  37     OME_Bool,
  38     OME_INT8,
  39     OME_UINT8,
  40     OME_UINT16,
  41     OME_INT16,
  42     OME_UINT32,
  43     OME_INT32,
  44     OME_String,
  45     OME_FLOAT, //only up to 255 value and cant be 2.55 or 25.5, just for PID's
  46     //wlasciwosci elementow
  47 #ifdef USE_OSD
  48     OME_VISIBLE,
  49 #endif
  50     OME_TAB,
  51     OME_END,
  52
  53     // Debug aid
  54     OME_MENU,
  55
  56     OME_MAX = OME_MENU
  57 } OSD_MenuElement;
  58
  59 typedef const void *(*CMSEntryFuncPtr)(displayPort_t *displayPort, const void *ptr);
  60
  61 typedef struct
  62 {
  63     const char * text;
  64     // Logical OR of OSD_MenuElement and flags below
  65     uint16_t flags;
  66     CMSEntryFuncPtr func;
  67     void *data;
  68 } __attribute__((packed)) OSD_Entry;
  69
  70 // Bits in flags
  71 #define OSD_MENU_ELEMENT_MASK 0x001f
  72 #define PRINT_VALUE      0x0020  // Value has been changed, need to redraw
  73 #define PRINT_LABEL      0x0040  // Text label should be printed
  74 #define DYNAMIC          0x0080  // Value should be updated dynamically
  75 #define OPTSTRING        0x0100  // (Temporary) Flag for OME_Submenu, indicating func should be called to get a string to display.
  76 #define REBOOT_REQUIRED  0x0200  // Reboot is required if the value is changed
  77 #define SCROLLING_TICKER 0x0400  // Long values are displayed as horizontally scrolling tickers (OME_TAB only)
  78 #define SLIDER_RP        0x0800  // Value should be read only if simplified RP slider is enabled
  79 #define SLIDER_RPY       0x1000  // Value should be read only if simplified RPY slider is enabled
  80 #define SLIDER_GYRO      0x2000  // Value should be read only if simplified gyro slider is enabled
  81 #define SLIDER_DTERM     0x4000  // Value should be read only if simplified D term slider is enabled
  82
  83 #define IS_PRINTVALUE(x) ((x) & PRINT_VALUE)
  84 #define SET_PRINTVALUE(x) do { (x) |= PRINT_VALUE; } while (0)
  85 #define CLR_PRINTVALUE(x) do { (x) &= ~PRINT_VALUE; } while (0)
  86
  87 #define IS_PRINTLABEL(x) ((x) & PRINT_LABEL)
  88 #define SET_PRINTLABEL(x) do { (x) |= PRINT_LABEL; } while (0)
  89 #define CLR_PRINTLABEL(x) do { (x) &= ~PRINT_LABEL; } while (0)
  90
  91 #define IS_DYNAMIC(p) ((p)->flags & DYNAMIC)
  92
  93 #define IS_SCROLLINGTICKER(x) ((x) & SCROLLING_TICKER)
  94 #define SET_SCROLLINGTICKER(x) do { (x) |= SCROLLING_TICKER; } while (0)
  95 #define CLR_SCROLLINGTICKER(x) do { (x) &= ~SCROLLING_TICKER; } while (0)
  96
  97 typedef const void *(*CMSMenuFuncPtr)(displayPort_t *pDisp);
  98
  99 // Special return value(s) for function chaining by CMSMenuFuncPtr
 100 extern int menuChainBack;
 101 #define MENU_CHAIN_BACK  (&menuChainBack) // Causes automatic cmsMenuBack
 102
 103 /*
 104 onExit function is called with self:
 105 (1) Pointer to an OSD_Entry when cmsMenuBack() was called.
 106     Point to an OSD_Entry with type == OME_Back if BACK was selected.
 107 (2) NULL if called from menu exit (forced exit at top level).
 108 */
 109
 110 typedef const void *(*CMSMenuOnExitPtr)(displayPort_t *pDisp, const OSD_Entry *self);
 111
 112 typedef const void *(*CMSMenuOnDisplayUpdatePtr)(displayPort_t *pDisp, const OSD_Entry *selected);
 113
 114 typedef struct
 115 {
 116 #ifdef CMS_MENU_DEBUG
 117     // These two are debug aids for menu content creators.
 118     const char *GUARD_text;
 119     const OSD_MenuElement GUARD_type;
 120 #endif
 121     const CMSMenuFuncPtr onEnter;
 122     const CMSMenuOnExitPtr onExit;
 123     const CMSMenuOnDisplayUpdatePtr onDisplayUpdate;
 124     const OSD_Entry *entries;
 125 } CMS_Menu;
 126
 127 typedef struct
 128 {
 129     uint8_t *val;
 130     uint8_t min;
 131     uint8_t max;
 132     uint8_t step;
 133 } OSD_UINT8_t;
 134
 135 typedef struct
 136 {
 137     int8_t *val;
 138     int8_t min;
 139     int8_t max;
 140     int8_t step;
 141 } OSD_INT8_t;
 142
 143 typedef struct
 144 {
 145     int16_t *val;
 146     int16_t min;
 147     int16_t max;
 148     int16_t step;
 149 } OSD_INT16_t;
 150
 151 typedef struct
 152 {
 153     uint16_t *val;
 154     uint16_t min;
 155     uint16_t max;
 156     uint16_t step;
 157 } OSD_UINT16_t;
 158
 159 typedef struct
 160 {
 161     int32_t *val;
 162     int32_t min;
 163     int32_t max;
 164     int32_t step;
 165 } OSD_INT32_t;
 166
 167 typedef struct
 168 {
 169     uint32_t *val;
 170     uint32_t min;
 171     uint32_t max;
 172     uint32_t step;
 173 } OSD_UINT32_t;
 174
 175 typedef struct
 176 {
 177     uint8_t *val;
 178     uint8_t min;
 179     uint8_t max;
 180     uint8_t step;
 181     uint16_t multipler;
 182 } OSD_FLOAT_t;
 183
 184 typedef struct
 185 {
 186     uint8_t *val;
 187     uint8_t max;
 188     const char * const *names;
 189 } OSD_TAB_t;
 190
 191 typedef struct
 192 {
 193     char *val;
 194 } OSD_String_t;