dlls/winebus.sys/controller.h

   1 /*
   2  * Common controller functions and structures
   3  *
   4  * Copyright 2018 Aric Stewart
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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 GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 /* Blocks of data for building HID device descriptions */
  22
  23 static const BYTE REPORT_HEADER[] = {
  24     0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
  25     0x09, 0x00, /* USAGE (??) */
  26     0xa1, 0x01, /* COLLECTION (Application) */
  27     0x09, 0x01, /*   USAGE () */
  28     0xa1, 0x00, /*   COLLECTION (Physical) */
  29 };
  30 #define IDX_HEADER_PAGE 1
  31 #define IDX_HEADER_USAGE 3
  32
  33 static const BYTE REPORT_BUTTONS[] = {
  34     0x05, 0x09, /* USAGE_PAGE (Button) */
  35     0x19, 0x01, /* USAGE_MINIMUM (Button 1) */
  36     0x29, 0x03, /* USAGE_MAXIMUM (Button 3) */
  37     0x15, 0x00, /* LOGICAL_MINIMUM (0) */
  38     0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
  39     0x35, 0x00, /* LOGICAL_MINIMUM (0) */
  40     0x45, 0x01, /* LOGICAL_MAXIMUM (1) */
  41     0x95, 0x03, /* REPORT_COUNT (3) */
  42     0x75, 0x01, /* REPORT_SIZE (1) */
  43     0x81, 0x02, /* INPUT (Data,Var,Abs) */
  44 };
  45 #define IDX_BUTTON_MIN_USAGE 3
  46 #define IDX_BUTTON_MAX_USAGE 5
  47 #define IDX_BUTTON_COUNT 11
  48
  49 static const BYTE REPORT_PADDING[] = {
  50     0x95, 0x03, /* REPORT_COUNT (3) */
  51     0x75, 0x01, /* REPORT_SIZE (1) */
  52     0x81, 0x03, /* INPUT (Cnst,Var,Abs) */
  53 };
  54 #define IDX_PADDING_BIT_COUNT 1
  55
  56 static const BYTE REPORT_AXIS_HEADER[] = {
  57     0x05, 0x01,  /* USAGE_PAGE (Generic Desktop) */
  58 };
  59 #define IDX_AXIS_PAGE 1
  60
  61 static const BYTE REPORT_AXIS_USAGE[] = {
  62     0x09, 0x30,  /* USAGE (X) */
  63 };
  64 #define IDX_AXIS_USAGE 1
  65
  66 static const BYTE REPORT_REL_AXIS_TAIL[] = {
  67     0x15, 0x81,    /* LOGICAL_MINIMUM (0) */
  68     0x25, 0x7f,    /* LOGICAL_MAXIMUM (0xffff) */
  69     0x75, 0x08,    /* REPORT_SIZE (16) */
  70     0x95, 0x02,    /* REPORT_COUNT (2) */
  71     0x81, 0x06,    /* INPUT (Data,Var,Rel) */
  72 };
  73 #define IDX_REL_AXIS_COUNT 7
  74
  75 static const BYTE REPORT_HATSWITCH[] = {
  76     0x05, 0x01,  /* USAGE_PAGE (Generic Desktop) */
  77     0x09, 0x39,  /* USAGE (Hatswitch) */
  78     0x15, 0x00,  /* LOGICAL_MINIMUM (0) */
  79     0x25, 0x08,  /* LOGICAL_MAXIMUM (0x08) */
  80     0x35, 0x00,  /* PHYSICAL_MINIMUM (0) */
  81     0x45, 0x08,  /* PHYSICAL_MAXIMUM (8) */
  82     0x75, 0x08,  /* REPORT_SIZE (8) */
  83     0x95, 0x01,  /* REPORT_COUNT (1) */
  84     0x81, 0x02,  /* INPUT (Data,Var,Abs) */
  85 };
  86 #define IDX_HATSWITCH_COUNT 15
  87
  88 static const BYTE REPORT_TAIL[] = {
  89     0xc0, /*   END_COLLECTION */
  90     0xc0  /* END_COLLECTION */
  91 };
  92
  93 static inline BYTE *add_button_block(BYTE* report_ptr, BYTE usage_min, BYTE usage_max)
  94 {
  95     memcpy(report_ptr, REPORT_BUTTONS, sizeof(REPORT_BUTTONS));
  96     report_ptr[IDX_BUTTON_MIN_USAGE] = usage_min;
  97     report_ptr[IDX_BUTTON_MAX_USAGE] = usage_max;
  98     report_ptr[IDX_BUTTON_COUNT] = (usage_max - usage_min) + 1;
  99     return report_ptr + sizeof(REPORT_BUTTONS);
 100 }
 101
 102
 103 static inline BYTE *add_padding_block(BYTE *report_ptr, BYTE bitcount)
 104 {
 105     memcpy(report_ptr, REPORT_PADDING, sizeof(REPORT_PADDING));
 106     report_ptr[IDX_PADDING_BIT_COUNT] = bitcount;
 107     return report_ptr + sizeof(REPORT_PADDING);
 108 }
 109
 110 static inline BYTE *add_hatswitch(BYTE *report_ptr, INT count)
 111 {
 112     memcpy(report_ptr, REPORT_HATSWITCH, sizeof(REPORT_HATSWITCH));
 113     report_ptr[IDX_HATSWITCH_COUNT] = count;
 114     return report_ptr + sizeof(REPORT_HATSWITCH);
 115 }
 116
 117 static inline void set_button_value(int index, int value, BYTE* buffer)
 118 {
 119     int bindex = index / 8;
 120     int b = index % 8;
 121     BYTE mask;
 122
 123     mask = 1<<b;
 124     if (value)
 125         buffer[bindex] = buffer[bindex] | mask;
 126     else
 127     {
 128         mask = ~mask;
 129         buffer[bindex] = buffer[bindex] & mask;
 130     }
 131 }