wacom_wac.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * drivers/input/tablet/wacom_wac.h
  4. */
  5. #ifndef WACOM_WAC_H
  6. #define WACOM_WAC_H
  7. #include <linux/types.h>
  8. #include <linux/hid.h>
  9. #include <linux/kfifo.h>
  10. /* maximum packet length for USB/BT devices */
  11. #define WACOM_PKGLEN_MAX 361
  12. #define WACOM_NAME_MAX 64
  13. #define WACOM_MAX_REMOTES 5
  14. #define WACOM_STATUS_UNKNOWN 255
  15. /* packet length for individual models */
  16. #define WACOM_PKGLEN_BBFUN 9
  17. #define WACOM_PKGLEN_TPC1FG 5
  18. #define WACOM_PKGLEN_TPC1FG_B 10
  19. #define WACOM_PKGLEN_TPC2FG 14
  20. #define WACOM_PKGLEN_BBTOUCH 20
  21. #define WACOM_PKGLEN_BBTOUCH3 64
  22. #define WACOM_PKGLEN_BBPEN 10
  23. #define WACOM_PKGLEN_WIRELESS 32
  24. #define WACOM_PKGLEN_PENABLED 8
  25. #define WACOM_PKGLEN_BPAD_TOUCH 32
  26. #define WACOM_PKGLEN_BPAD_TOUCH_USB 64
  27. /* wacom data size per MT contact */
  28. #define WACOM_BYTES_PER_MT_PACKET 11
  29. #define WACOM_BYTES_PER_24HDT_PACKET 14
  30. #define WACOM_BYTES_PER_QHDTHID_PACKET 6
  31. /* device IDs */
  32. #define STYLUS_DEVICE_ID 0x02
  33. #define TOUCH_DEVICE_ID 0x03
  34. #define CURSOR_DEVICE_ID 0x06
  35. #define ERASER_DEVICE_ID 0x0A
  36. #define PAD_DEVICE_ID 0x0F
  37. /* wacom data packet report IDs */
  38. #define WACOM_REPORT_PENABLED 2
  39. #define WACOM_REPORT_PENABLED_BT 3
  40. #define WACOM_REPORT_INTUOS_ID1 5
  41. #define WACOM_REPORT_INTUOS_ID2 6
  42. #define WACOM_REPORT_INTUOSPAD 12
  43. #define WACOM_REPORT_INTUOS5PAD 3
  44. #define WACOM_REPORT_DTUSPAD 21
  45. #define WACOM_REPORT_TPC1FG 6
  46. #define WACOM_REPORT_TPC2FG 13
  47. #define WACOM_REPORT_TPCMT 13
  48. #define WACOM_REPORT_TPCMT2 3
  49. #define WACOM_REPORT_TPCHID 15
  50. #define WACOM_REPORT_CINTIQ 16
  51. #define WACOM_REPORT_CINTIQPAD 17
  52. #define WACOM_REPORT_TPCST 16
  53. #define WACOM_REPORT_DTUS 17
  54. #define WACOM_REPORT_TPC1FGE 18
  55. #define WACOM_REPORT_24HDT 1
  56. #define WACOM_REPORT_WL 128
  57. #define WACOM_REPORT_USB 192
  58. #define WACOM_REPORT_BPAD_PEN 3
  59. #define WACOM_REPORT_BPAD_TOUCH 16
  60. #define WACOM_REPORT_DEVICE_LIST 16
  61. #define WACOM_REPORT_INTUOS_PEN 16
  62. #define WACOM_REPORT_REMOTE 17
  63. #define WACOM_REPORT_INTUOSHT2_ID 8
  64. /* wacom command report ids */
  65. #define WAC_CMD_WL_LED_CONTROL 0x03
  66. #define WAC_CMD_LED_CONTROL 0x20
  67. #define WAC_CMD_ICON_START 0x21
  68. #define WAC_CMD_ICON_XFER 0x23
  69. #define WAC_CMD_ICON_BT_XFER 0x26
  70. #define WAC_CMD_DELETE_PAIRING 0x20
  71. #define WAC_CMD_LED_CONTROL_GENERIC 0x32
  72. #define WAC_CMD_UNPAIR_ALL 0xFF
  73. #define WAC_CMD_WL_INTUOSP2 0x82
  74. /* device quirks */
  75. #define WACOM_QUIRK_BBTOUCH_LOWRES 0x0001
  76. #define WACOM_QUIRK_SENSE 0x0002
  77. #define WACOM_QUIRK_AESPEN 0x0004
  78. #define WACOM_QUIRK_BATTERY 0x0008
  79. #define WACOM_QUIRK_TOOLSERIAL 0x0010
  80. /* device types */
  81. #define WACOM_DEVICETYPE_NONE 0x0000
  82. #define WACOM_DEVICETYPE_PEN 0x0001
  83. #define WACOM_DEVICETYPE_TOUCH 0x0002
  84. #define WACOM_DEVICETYPE_PAD 0x0004
  85. #define WACOM_DEVICETYPE_WL_MONITOR 0x0008
  86. #define WACOM_DEVICETYPE_DIRECT 0x0010
  87. #define WACOM_POWER_SUPPLY_STATUS_AUTO -1
  88. #define WACOM_HID_UP_WACOMDIGITIZER 0xff0d0000
  89. #define WACOM_HID_SP_PAD 0x00040000
  90. #define WACOM_HID_SP_BUTTON 0x00090000
  91. #define WACOM_HID_SP_DIGITIZER 0x000d0000
  92. #define WACOM_HID_SP_DIGITIZERINFO 0x00100000
  93. #define WACOM_HID_WD_DIGITIZER (WACOM_HID_UP_WACOMDIGITIZER | 0x01)
  94. #define WACOM_HID_WD_PEN (WACOM_HID_UP_WACOMDIGITIZER | 0x02)
  95. #define WACOM_HID_WD_SENSE (WACOM_HID_UP_WACOMDIGITIZER | 0x36)
  96. #define WACOM_HID_WD_DIGITIZERFNKEYS (WACOM_HID_UP_WACOMDIGITIZER | 0x39)
  97. #define WACOM_HID_WD_SERIALNUMBER (WACOM_HID_UP_WACOMDIGITIZER | 0x5b)
  98. #define WACOM_HID_WD_SERIALHI (WACOM_HID_UP_WACOMDIGITIZER | 0x5c)
  99. #define WACOM_HID_WD_TOOLTYPE (WACOM_HID_UP_WACOMDIGITIZER | 0x77)
  100. #define WACOM_HID_WD_DISTANCE (WACOM_HID_UP_WACOMDIGITIZER | 0x0132)
  101. #define WACOM_HID_WD_TOUCHSTRIP (WACOM_HID_UP_WACOMDIGITIZER | 0x0136)
  102. #define WACOM_HID_WD_TOUCHSTRIP2 (WACOM_HID_UP_WACOMDIGITIZER | 0x0137)
  103. #define WACOM_HID_WD_TOUCHRING (WACOM_HID_UP_WACOMDIGITIZER | 0x0138)
  104. #define WACOM_HID_WD_TOUCHRINGSTATUS (WACOM_HID_UP_WACOMDIGITIZER | 0x0139)
  105. #define WACOM_HID_WD_REPORT_VALID (WACOM_HID_UP_WACOMDIGITIZER | 0x01d0)
  106. #define WACOM_HID_WD_ACCELEROMETER_X (WACOM_HID_UP_WACOMDIGITIZER | 0x0401)
  107. #define WACOM_HID_WD_ACCELEROMETER_Y (WACOM_HID_UP_WACOMDIGITIZER | 0x0402)
  108. #define WACOM_HID_WD_ACCELEROMETER_Z (WACOM_HID_UP_WACOMDIGITIZER | 0x0403)
  109. #define WACOM_HID_WD_BATTERY_CHARGING (WACOM_HID_UP_WACOMDIGITIZER | 0x0404)
  110. #define WACOM_HID_WD_TOUCHONOFF (WACOM_HID_UP_WACOMDIGITIZER | 0x0454)
  111. #define WACOM_HID_WD_BATTERY_LEVEL (WACOM_HID_UP_WACOMDIGITIZER | 0x043b)
  112. #define WACOM_HID_WD_EXPRESSKEY00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0910)
  113. #define WACOM_HID_WD_EXPRESSKEYCAP00 (WACOM_HID_UP_WACOMDIGITIZER | 0x0940)
  114. #define WACOM_HID_WD_MODE_CHANGE (WACOM_HID_UP_WACOMDIGITIZER | 0x0980)
  115. #define WACOM_HID_WD_MUTE_DEVICE (WACOM_HID_UP_WACOMDIGITIZER | 0x0981)
  116. #define WACOM_HID_WD_CONTROLPANEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0982)
  117. #define WACOM_HID_WD_ONSCREEN_KEYBOARD (WACOM_HID_UP_WACOMDIGITIZER | 0x0983)
  118. #define WACOM_HID_WD_BUTTONCONFIG (WACOM_HID_UP_WACOMDIGITIZER | 0x0986)
  119. #define WACOM_HID_WD_BUTTONHOME (WACOM_HID_UP_WACOMDIGITIZER | 0x0990)
  120. #define WACOM_HID_WD_BUTTONUP (WACOM_HID_UP_WACOMDIGITIZER | 0x0991)
  121. #define WACOM_HID_WD_BUTTONDOWN (WACOM_HID_UP_WACOMDIGITIZER | 0x0992)
  122. #define WACOM_HID_WD_BUTTONLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0993)
  123. #define WACOM_HID_WD_BUTTONRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0994)
  124. #define WACOM_HID_WD_BUTTONCENTER (WACOM_HID_UP_WACOMDIGITIZER | 0x0995)
  125. #define WACOM_HID_WD_FINGERWHEEL (WACOM_HID_UP_WACOMDIGITIZER | 0x0d03)
  126. #define WACOM_HID_WD_OFFSETLEFT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d30)
  127. #define WACOM_HID_WD_OFFSETTOP (WACOM_HID_UP_WACOMDIGITIZER | 0x0d31)
  128. #define WACOM_HID_WD_OFFSETRIGHT (WACOM_HID_UP_WACOMDIGITIZER | 0x0d32)
  129. #define WACOM_HID_WD_OFFSETBOTTOM (WACOM_HID_UP_WACOMDIGITIZER | 0x0d33)
  130. #define WACOM_HID_WD_DATAMODE (WACOM_HID_UP_WACOMDIGITIZER | 0x1002)
  131. #define WACOM_HID_WD_DIGITIZERINFO (WACOM_HID_UP_WACOMDIGITIZER | 0x1013)
  132. #define WACOM_HID_WD_TOUCH_RING_SETTING (WACOM_HID_UP_WACOMDIGITIZER | 0x1032)
  133. #define WACOM_HID_UP_G9 0xff090000
  134. #define WACOM_HID_G9_PEN (WACOM_HID_UP_G9 | 0x02)
  135. #define WACOM_HID_G9_TOUCHSCREEN (WACOM_HID_UP_G9 | 0x11)
  136. #define WACOM_HID_UP_G11 0xff110000
  137. #define WACOM_HID_G11_PEN (WACOM_HID_UP_G11 | 0x02)
  138. #define WACOM_HID_G11_TOUCHSCREEN (WACOM_HID_UP_G11 | 0x11)
  139. #define WACOM_HID_UP_WACOMTOUCH 0xff000000
  140. #define WACOM_HID_WT_TOUCHSCREEN (WACOM_HID_UP_WACOMTOUCH | 0x04)
  141. #define WACOM_HID_WT_TOUCHPAD (WACOM_HID_UP_WACOMTOUCH | 0x05)
  142. #define WACOM_HID_WT_CONTACTMAX (WACOM_HID_UP_WACOMTOUCH | 0x55)
  143. #define WACOM_HID_WT_SERIALNUMBER (WACOM_HID_UP_WACOMTOUCH | 0x5b)
  144. #define WACOM_HID_WT_X (WACOM_HID_UP_WACOMTOUCH | 0x130)
  145. #define WACOM_HID_WT_Y (WACOM_HID_UP_WACOMTOUCH | 0x131)
  146. #define WACOM_HID_WT_REPORT_VALID (WACOM_HID_UP_WACOMTOUCH | 0x1d0)
  147. #define WACOM_BATTERY_USAGE(f) (((f)->hid == HID_DG_BATTERYSTRENGTH) || \
  148. ((f)->hid == WACOM_HID_WD_BATTERY_CHARGING) || \
  149. ((f)->hid == WACOM_HID_WD_BATTERY_LEVEL))
  150. #define WACOM_PAD_FIELD(f) (((f)->physical == HID_DG_TABLETFUNCTIONKEY) || \
  151. ((f)->physical == WACOM_HID_WD_DIGITIZERFNKEYS) || \
  152. ((f)->physical == WACOM_HID_WD_DIGITIZERINFO))
  153. #define WACOM_PEN_FIELD(f) (((f)->logical == HID_DG_STYLUS) || \
  154. ((f)->physical == HID_DG_STYLUS) || \
  155. ((f)->physical == HID_DG_PEN) || \
  156. ((f)->application == HID_DG_PEN) || \
  157. ((f)->application == HID_DG_DIGITIZER) || \
  158. ((f)->application == WACOM_HID_WD_PEN) || \
  159. ((f)->application == WACOM_HID_WD_DIGITIZER) || \
  160. ((f)->application == WACOM_HID_G9_PEN) || \
  161. ((f)->application == WACOM_HID_G11_PEN))
  162. #define WACOM_FINGER_FIELD(f) (((f)->logical == HID_DG_FINGER) || \
  163. ((f)->physical == HID_DG_FINGER) || \
  164. ((f)->application == HID_DG_TOUCHSCREEN) || \
  165. ((f)->application == WACOM_HID_G9_TOUCHSCREEN) || \
  166. ((f)->application == WACOM_HID_G11_TOUCHSCREEN) || \
  167. ((f)->application == WACOM_HID_WT_TOUCHPAD) || \
  168. ((f)->application == HID_DG_TOUCHPAD))
  169. #define WACOM_DIRECT_DEVICE(f) (((f)->application == HID_DG_TOUCHSCREEN) || \
  170. ((f)->application == WACOM_HID_WT_TOUCHSCREEN) || \
  171. ((f)->application == HID_DG_PEN) || \
  172. ((f)->application == WACOM_HID_WD_PEN))
  173. enum {
  174. PENPARTNER = 0,
  175. GRAPHIRE,
  176. GRAPHIRE_BT,
  177. WACOM_G4,
  178. PTU,
  179. PL,
  180. DTU,
  181. DTUS,
  182. DTUSX,
  183. INTUOS,
  184. INTUOS3S,
  185. INTUOS3,
  186. INTUOS3L,
  187. INTUOS4S,
  188. INTUOS4,
  189. INTUOS4WL,
  190. INTUOS4L,
  191. INTUOS5S,
  192. INTUOS5,
  193. INTUOS5L,
  194. INTUOSPS,
  195. INTUOSPM,
  196. INTUOSPL,
  197. INTUOSP2_BT,
  198. INTUOSP2S_BT,
  199. INTUOSHT3_BT,
  200. WACOM_21UX2,
  201. WACOM_22HD,
  202. DTK,
  203. WACOM_24HD,
  204. WACOM_27QHD,
  205. CINTIQ_HYBRID,
  206. CINTIQ_COMPANION_2,
  207. CINTIQ,
  208. WACOM_BEE,
  209. WACOM_13HD,
  210. WACOM_MO,
  211. BAMBOO_PEN,
  212. INTUOSHT,
  213. INTUOSHT2,
  214. BAMBOO_TOUCH,
  215. BAMBOO_PT,
  216. WACOM_24HDT,
  217. WACOM_27QHDT,
  218. BAMBOO_PAD,
  219. WIRELESS,
  220. REMOTE,
  221. TABLETPC, /* add new TPC below */
  222. TABLETPCE,
  223. TABLETPC2FG,
  224. MTSCREEN,
  225. MTTPC,
  226. MTTPC_B,
  227. HID_GENERIC,
  228. MAX_TYPE
  229. };
  230. struct wacom_features {
  231. const char *name;
  232. int x_max;
  233. int y_max;
  234. int pressure_max;
  235. int distance_max;
  236. int type;
  237. int x_resolution;
  238. int y_resolution;
  239. int numbered_buttons;
  240. int offset_left;
  241. int offset_right;
  242. int offset_top;
  243. int offset_bottom;
  244. int device_type;
  245. int x_phy;
  246. int y_phy;
  247. unsigned unit;
  248. int unitExpo;
  249. int x_fuzz;
  250. int y_fuzz;
  251. int pressure_fuzz;
  252. int distance_fuzz;
  253. int tilt_fuzz;
  254. unsigned quirks;
  255. unsigned touch_max;
  256. int oVid;
  257. int oPid;
  258. int pktlen;
  259. bool check_for_hid_type;
  260. int hid_type;
  261. };
  262. struct wacom_shared {
  263. bool stylus_in_proximity;
  264. bool touch_down;
  265. /* for wireless device to access USB interfaces */
  266. unsigned touch_max;
  267. int type;
  268. struct input_dev *touch_input;
  269. struct hid_device *pen;
  270. struct hid_device *touch;
  271. bool has_mute_touch_switch;
  272. bool is_touch_on;
  273. };
  274. struct hid_data {
  275. __s16 inputmode; /* InputMode HID feature, -1 if non-existent */
  276. __s16 inputmode_index; /* InputMode HID feature index in the report */
  277. bool sense_state;
  278. bool inrange_state;
  279. bool invert_state;
  280. bool tipswitch;
  281. bool barrelswitch;
  282. bool barrelswitch2;
  283. bool confidence;
  284. int x;
  285. int y;
  286. int pressure;
  287. int width;
  288. int height;
  289. int id;
  290. int cc_report;
  291. int cc_index;
  292. int cc_value_index;
  293. int last_slot_field;
  294. int num_expected;
  295. int num_received;
  296. int bat_status;
  297. int battery_capacity;
  298. int bat_charging;
  299. int bat_connected;
  300. int ps_connected;
  301. bool pad_input_event_flag;
  302. };
  303. struct wacom_remote_data {
  304. struct {
  305. u32 serial;
  306. bool connected;
  307. } remote[WACOM_MAX_REMOTES];
  308. };
  309. struct wacom_wac {
  310. char name[WACOM_NAME_MAX];
  311. char pen_name[WACOM_NAME_MAX];
  312. char touch_name[WACOM_NAME_MAX];
  313. char pad_name[WACOM_NAME_MAX];
  314. unsigned char data[WACOM_PKGLEN_MAX];
  315. int tool[2];
  316. int id[2];
  317. __u64 serial[2];
  318. bool reporting_data;
  319. struct wacom_features features;
  320. struct wacom_shared *shared;
  321. struct input_dev *pen_input;
  322. struct input_dev *touch_input;
  323. struct input_dev *pad_input;
  324. struct kfifo_rec_ptr_2 *pen_fifo;
  325. int pid;
  326. int num_contacts_left;
  327. u8 bt_features;
  328. u8 bt_high_speed;
  329. int mode_report;
  330. int mode_value;
  331. struct hid_data hid_data;
  332. bool has_mute_touch_switch;
  333. bool has_mode_change;
  334. bool is_direct_mode;
  335. bool is_invalid_bt_frame;
  336. };
  337. #endif