drivers/usb/input/map_to_7segment.h

   1 /*
   2  * drivers/usb/input/map_to_7segment.h
   3  *
   4  * Copyright (c) 2005 Henk Vergonet <Henk.Vergonet@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of
   9  * the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #ifndef MAP_TO_7SEGMENT_H
  22 #define MAP_TO_7SEGMENT_H
  23
  24 /* This file provides translation primitives and tables for the conversion
  25  * of (ASCII) characters to a 7-segments notation.
  26  *
  27  * The 7 segment's wikipedia notation below is used as standard.
  28  * See: http://en.wikipedia.org/wiki/Seven_segment_display
  29  *
  30  * Notation:    +-a-+
  31  *              f   b
  32  *              +-g-+
  33  *              e   c
  34  *              +-d-+
  35  *
  36  * Usage:
  37  *
  38  *   Register a map variable, and fill it with a character set:
  39  *      static SEG7_DEFAULT_MAP(map_seg7);
  40  *
  41  *
  42  *   Then use for conversion:
  43  *      seg7 = map_to_seg7(&map_seg7, some_char);
  44  *      ...
  45  *
  46  * In device drivers it is recommended, if required, to make the char map
  47  * accessible via the sysfs interface using the following scheme:
  48  *
  49  * static ssize_t show_map(struct device *dev, char *buf) {
  50  *      memcpy(buf, &map_seg7, sizeof(map_seg7));
  51  *      return sizeof(map_seg7);
  52  * }
  53  * static ssize_t store_map(struct device *dev, const char *buf, size_t cnt) {
  54  *      if(cnt != sizeof(map_seg7))
  55  *              return -EINVAL;
  56  *      memcpy(&map_seg7, buf, cnt);
  57  *      return cnt;
  58  * }
  59  * static DEVICE_ATTR(map_seg7, PERMS_RW, show_map, store_map);
  60  *
  61  * History:
  62  * 2005-05-31   RFC linux-kernel@vger.kernel.org
  63  */
  64 #include <linux/errno.h>
  65
  66
  67 #define BIT_SEG7_A              0
  68 #define BIT_SEG7_B              1
  69 #define BIT_SEG7_C              2
  70 #define BIT_SEG7_D              3
  71 #define BIT_SEG7_E              4
  72 #define BIT_SEG7_F              5
  73 #define BIT_SEG7_G              6
  74 #define BIT_SEG7_RESERVED       7
  75
  76 struct seg7_conversion_map {
  77         unsigned char   table[128];
  78 };
  79
  80 static inline int map_to_seg7(struct seg7_conversion_map *map, int c)
  81 {
  82         return c >= 0 && c < sizeof(map->table) ? map->table[c] : -EINVAL;
  83 }
  84
  85 #define SEG7_CONVERSION_MAP(_name, _map)        \
  86         struct seg7_conversion_map _name = { .table = { _map } }
  87
  88 /*
  89  * It is recommended to use a facility that allows user space to redefine
  90  * custom character sets for LCD devices. Please use a sysfs interface
  91  * as described above.
  92  */
  93 #define MAP_TO_SEG7_SYSFS_FILE  "map_seg7"
  94
  95 /*******************************************************************************
  96  * ASCII conversion table
  97  ******************************************************************************/
  98
  99 #define _SEG7(l,a,b,c,d,e,f,g)  \
 100       ( a<<BIT_SEG7_A | b<<BIT_SEG7_B | c<<BIT_SEG7_C | d<<BIT_SEG7_D | \
 101         e<<BIT_SEG7_E | f<<BIT_SEG7_F | g<<BIT_SEG7_G )
 102
 103 #define _MAP_0_32_ASCII_SEG7_NON_PRINTABLE      \
 104         0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
 105
 106 #define _MAP_33_47_ASCII_SEG7_SYMBOL            \
 107  _SEG7('!',0,0,0,0,1,1,0), _SEG7('"',0,1,0,0,0,1,0), _SEG7('#',0,1,1,0,1,1,0),\
 108  _SEG7('$',1,0,1,1,0,1,1), _SEG7('%',0,0,1,0,0,1,0), _SEG7('&',1,0,1,1,1,1,1),\
 109  _SEG7('\'',0,0,0,0,0,1,0),_SEG7('(',1,0,0,1,1,1,0), _SEG7(')',1,1,1,1,0,0,0),\
 110  _SEG7('*',0,1,1,0,1,1,1), _SEG7('+',0,1,1,0,0,0,1), _SEG7(',',0,0,0,0,1,0,0),\
 111  _SEG7('-',0,0,0,0,0,0,1), _SEG7('.',0,0,0,0,1,0,0), _SEG7('/',0,1,0,0,1,0,1),
 112
 113 #define _MAP_48_57_ASCII_SEG7_NUMERIC           \
 114  _SEG7('0',1,1,1,1,1,1,0), _SEG7('1',0,1,1,0,0,0,0), _SEG7('2',1,1,0,1,1,0,1),\
 115  _SEG7('3',1,1,1,1,0,0,1), _SEG7('4',0,1,1,0,0,1,1), _SEG7('5',1,0,1,1,0,1,1),\
 116  _SEG7('6',1,0,1,1,1,1,1), _SEG7('7',1,1,1,0,0,0,0), _SEG7('8',1,1,1,1,1,1,1),\
 117  _SEG7('9',1,1,1,1,0,1,1),
 118
 119 #define _MAP_58_64_ASCII_SEG7_SYMBOL            \
 120  _SEG7(':',0,0,0,1,0,0,1), _SEG7(';',0,0,0,1,0,0,1), _SEG7('<',1,0,0,0,0,1,1),\
 121  _SEG7('=',0,0,0,1,0,0,1), _SEG7('>',1,1,0,0,0,0,1), _SEG7('?',1,1,1,0,0,1,0),\
 122  _SEG7('@',1,1,0,1,1,1,1),
 123
 124 #define _MAP_65_90_ASCII_SEG7_ALPHA_UPPR        \
 125  _SEG7('A',1,1,1,0,1,1,1), _SEG7('B',1,1,1,1,1,1,1), _SEG7('C',1,0,0,1,1,1,0),\
 126  _SEG7('D',1,1,1,1,1,1,0), _SEG7('E',1,0,0,1,1,1,1), _SEG7('F',1,0,0,0,1,1,1),\
 127  _SEG7('G',1,1,1,1,0,1,1), _SEG7('H',0,1,1,0,1,1,1), _SEG7('I',0,1,1,0,0,0,0),\
 128  _SEG7('J',0,1,1,1,0,0,0), _SEG7('K',0,1,1,0,1,1,1), _SEG7('L',0,0,0,1,1,1,0),\
 129  _SEG7('M',1,1,1,0,1,1,0), _SEG7('N',1,1,1,0,1,1,0), _SEG7('O',1,1,1,1,1,1,0),\
 130  _SEG7('P',1,1,0,0,1,1,1), _SEG7('Q',1,1,1,1,1,1,0), _SEG7('R',1,1,1,0,1,1,1),\
 131  _SEG7('S',1,0,1,1,0,1,1), _SEG7('T',0,0,0,1,1,1,1), _SEG7('U',0,1,1,1,1,1,0),\
 132  _SEG7('V',0,1,1,1,1,1,0), _SEG7('W',0,1,1,1,1,1,1), _SEG7('X',0,1,1,0,1,1,1),\
 133  _SEG7('Y',0,1,1,0,0,1,1), _SEG7('Z',1,1,0,1,1,0,1),
 134
 135 #define _MAP_91_96_ASCII_SEG7_SYMBOL            \
 136  _SEG7('[',1,0,0,1,1,1,0), _SEG7('\\',0,0,1,0,0,1,1),_SEG7(']',1,1,1,1,0,0,0),\
 137  _SEG7('^',1,1,0,0,0,1,0), _SEG7('_',0,0,0,1,0,0,0), _SEG7('`',0,1,0,0,0,0,0),
 138
 139 #define _MAP_97_122_ASCII_SEG7_ALPHA_LOWER      \
 140  _SEG7('A',1,1,1,0,1,1,1), _SEG7('b',0,0,1,1,1,1,1), _SEG7('c',0,0,0,1,1,0,1),\
 141  _SEG7('d',0,1,1,1,1,0,1), _SEG7('E',1,0,0,1,1,1,1), _SEG7('F',1,0,0,0,1,1,1),\
 142  _SEG7('G',1,1,1,1,0,1,1), _SEG7('h',0,0,1,0,1,1,1), _SEG7('i',0,0,1,0,0,0,0),\
 143  _SEG7('j',0,0,1,1,0,0,0), _SEG7('k',0,0,1,0,1,1,1), _SEG7('L',0,0,0,1,1,1,0),\
 144  _SEG7('M',1,1,1,0,1,1,0), _SEG7('n',0,0,1,0,1,0,1), _SEG7('o',0,0,1,1,1,0,1),\
 145  _SEG7('P',1,1,0,0,1,1,1), _SEG7('q',1,1,1,0,0,1,1), _SEG7('r',0,0,0,0,1,0,1),\
 146  _SEG7('S',1,0,1,1,0,1,1), _SEG7('T',0,0,0,1,1,1,1), _SEG7('u',0,0,1,1,1,0,0),\
 147  _SEG7('v',0,0,1,1,1,0,0), _SEG7('W',0,1,1,1,1,1,1), _SEG7('X',0,1,1,0,1,1,1),\
 148  _SEG7('y',0,1,1,1,0,1,1), _SEG7('Z',1,1,0,1,1,0,1),
 149
 150 #define _MAP_123_126_ASCII_SEG7_SYMBOL          \
 151  _SEG7('{',1,0,0,1,1,1,0), _SEG7('|',0,0,0,0,1,1,0), _SEG7('}',1,1,1,1,0,0,0),\
 152  _SEG7('~',1,0,0,0,0,0,0),
 153
 154 /* Maps */
 155
 156 /* This set tries to map as close as possible to the visible characteristics
 157  * of the ASCII symbol, lowercase and uppercase letters may differ in
 158  * presentation on the display.
 159  */
 160 #define MAP_ASCII7SEG_ALPHANUM                  \
 161         _MAP_0_32_ASCII_SEG7_NON_PRINTABLE      \
 162         _MAP_33_47_ASCII_SEG7_SYMBOL            \
 163         _MAP_48_57_ASCII_SEG7_NUMERIC           \
 164         _MAP_58_64_ASCII_SEG7_SYMBOL            \
 165         _MAP_65_90_ASCII_SEG7_ALPHA_UPPR        \
 166         _MAP_91_96_ASCII_SEG7_SYMBOL            \
 167         _MAP_97_122_ASCII_SEG7_ALPHA_LOWER      \
 168         _MAP_123_126_ASCII_SEG7_SYMBOL
 169
 170 /* This set tries to map as close as possible to the symbolic characteristics
 171  * of the ASCII character for maximum discrimination.
 172  * For now this means all alpha chars are in lower case representations.
 173  * (This for example facilitates the use of hex numbers with uppercase input.)
 174  */
 175 #define MAP_ASCII7SEG_ALPHANUM_LC                       \
 176         _MAP_0_32_ASCII_SEG7_NON_PRINTABLE      \
 177         _MAP_33_47_ASCII_SEG7_SYMBOL            \
 178         _MAP_48_57_ASCII_SEG7_NUMERIC           \
 179         _MAP_58_64_ASCII_SEG7_SYMBOL            \
 180         _MAP_97_122_ASCII_SEG7_ALPHA_LOWER      \
 181         _MAP_91_96_ASCII_SEG7_SYMBOL            \
 182         _MAP_97_122_ASCII_SEG7_ALPHA_LOWER      \
 183         _MAP_123_126_ASCII_SEG7_SYMBOL
 184
 185 #define SEG7_DEFAULT_MAP(_name)         \
 186         SEG7_CONVERSION_MAP(_name,MAP_ASCII7SEG_ALPHANUM)
 187
 188 #endif  /* MAP_TO_7SEGMENT_H */
 189