1 /* 2 * kbdif.h -- Xen virtual keyboard/mouse 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a copy 5 * of this software and associated documentation files (the "Software"), to 6 * deal in the Software without restriction, including without limitation the 7 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 8 * sell copies of the Software, and to permit persons to whom the Software is 9 * furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included in 12 * all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 19 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 20 * DEALINGS IN THE SOFTWARE. 21 * 22 * Copyright (C) 2005 Anthony Liguori <aliguori@us.ibm.com> 23 * Copyright (C) 2006 Red Hat, Inc., Markus Armbruster <armbru@redhat.com> 24 */ 25 26 #ifndef __XEN_PUBLIC_IO_KBDIF_H__ 27 #define __XEN_PUBLIC_IO_KBDIF_H__ 28 29 /* In events (backend -> frontend) */ 30 31 /* 32 * Frontends should ignore unknown in events. 33 */ 34 35 /* Pointer movement event */ 36 #define XENKBD_TYPE_MOTION 1 37 /* Event type 2 currently not used */ 38 /* Key event (includes pointer buttons) */ 39 #define XENKBD_TYPE_KEY 3 40 /* 41 * Pointer position event 42 * Capable backend sets feature-abs-pointer in xenstore. 43 * Frontend requests ot instead of XENKBD_TYPE_MOTION by setting 44 * request-abs-update in xenstore. 45 */ 46 #define XENKBD_TYPE_POS 4 47 48 struct xenkbd_motion { 49 uint8_t type; /* XENKBD_TYPE_MOTION */ 50 int32_t rel_x; /* relative X motion */ 51 int32_t rel_y; /* relative Y motion */ 52 }; 53 54 struct xenkbd_key { 55 uint8_t type; /* XENKBD_TYPE_KEY */ 56 uint8_t pressed; /* 1 if pressed; 0 otherwise */ 57 uint32_t keycode; /* KEY_* from linux/input.h */ 58 }; 59 60 struct xenkbd_position { 61 uint8_t type; /* XENKBD_TYPE_POS */ 62 int32_t abs_x; /* absolute X position (in FB pixels) */ 63 int32_t abs_y; /* absolute Y position (in FB pixels) */ 64 }; 65 66 #define XENKBD_IN_EVENT_SIZE 40 67 68 union xenkbd_in_event { 69 uint8_t type; 70 struct xenkbd_motion motion; 71 struct xenkbd_key key; 72 struct xenkbd_position pos; 73 char pad[XENKBD_IN_EVENT_SIZE]; 74 }; 75 76 /* Out events (frontend -> backend) */ 77 78 /* 79 * Out events may be sent only when requested by backend, and receipt 80 * of an unknown out event is an error. 81 * No out events currently defined. 82 */ 83 84 #define XENKBD_OUT_EVENT_SIZE 40 85 86 union xenkbd_out_event { 87 uint8_t type; 88 char pad[XENKBD_OUT_EVENT_SIZE]; 89 }; 90 91 /* shared page */ 92 93 #define XENKBD_IN_RING_SIZE 2048 94 #define XENKBD_IN_RING_LEN (XENKBD_IN_RING_SIZE / XENKBD_IN_EVENT_SIZE) 95 #define XENKBD_IN_RING_OFFS 1024 96 #define XENKBD_IN_RING(page) \ 97 ((union xenkbd_in_event *)((char *)(page) + XENKBD_IN_RING_OFFS)) 98 #define XENKBD_IN_RING_REF(page, idx) \ 99 (XENKBD_IN_RING((page))[(idx) % XENKBD_IN_RING_LEN]) 100 101 #define XENKBD_OUT_RING_SIZE 1024 102 #define XENKBD_OUT_RING_LEN (XENKBD_OUT_RING_SIZE / XENKBD_OUT_EVENT_SIZE) 103 #define XENKBD_OUT_RING_OFFS (XENKBD_IN_RING_OFFS + XENKBD_IN_RING_SIZE) 104 #define XENKBD_OUT_RING(page) \ 105 ((union xenkbd_out_event *)((char *)(page) + XENKBD_OUT_RING_OFFS)) 106 #define XENKBD_OUT_RING_REF(page, idx) \ 107 (XENKBD_OUT_RING((page))[(idx) % XENKBD_OUT_RING_LEN]) 108 109 struct xenkbd_page { 110 uint32_t in_cons, in_prod; 111 uint32_t out_cons, out_prod; 112 }; 113 114 #endif 115