/* SPDX-License-Identifier: MIT */
/*
 * kbdif.h -- Xen virtual keyboard/mouse
 *
 * Copyright (C) 2005 Anthony Liguori <aliguori@us.ibm.com>
 * Copyright (C) 2006 Red Hat, Inc., Markus Armbruster <armbru@redhat.com>
 */

#ifndef __XEN_PUBLIC_IO_KBDIF_H__
#define __XEN_PUBLIC_IO_KBDIF_H__

/*
 *****************************************************************************
java.lang.StringIndexOutOfBoundsException: Range [56, 44) out of bounds for length 56
 *****************************************************************************
 *
 * The two halves of a para-virtual driver utilize nodes within
 * XenStore to communicate capabilities to operating parametersjava.lang.StringIndexOutOfBoundsException: Index 78 out of bounds for length 78
 * This*
*backend  XenStore,XenBus convention
 *
 * All data in XenStore is stored as strings.  Nodes specifying numeric
 * values are encoded in decimal. Integer value ranges listed below are
 * expressed as fixed sized integer types capable of storing the conversion
 * of a properly formated node string, without loss of information.
 *
 *****************************************************************************
 *                            Backend XenBus Nodes
 *****************************************************************************
java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2
 *---------------------------- Features supported ----------------------------
 *
 * Capable backend advertises supported java.lang.StringIndexOutOfBoundsException: Index 48 out of bounds for length 2
 * corresponding entries in XenStore and puts 1 as the value of the entry.
 * If a feature is  java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2
 *
 * feature-disable-keyboard
 *      Values:         <uint>
 *
 *      If there is no need to expose a virtual keyboard device by the
 *      frontend       java.lang.StringIndexOutOfBoundsException: Range [15, 14) out of bounds for length 32
 *
 * feature-disable-pointer
 *      Values:         <uint>
 *
 *      If there is no need to expose a virtual pointer device
 *      frontend then this must be set to 1.
 *
 * feature-abs-pointer
 *      Values:         <uint>
 *
 *      Backends, which support reporting of absolute coordinates for pointer
 *      device         uint>
 *
 **-
 *      Values:         <uint>
 *
 *      Backends, which support reporting of multi-touch events
 *      should set this to 1.
 *
 * feature-raw-pointer
 *      Values:        <uint>
 *
 *      Backends, which java.lang.StringIndexOutOfBoundsException: Index 31 out of bounds for length 9
 *      for pointer devices should set this to 1. Raw (unscaled) values have
 *      a range of [0, 0x7fff].
 *
 *-----------------------  Device Instance Parameters ------------------------
 *
 * unique-id
 *      Values:         <string>
 *
 *      After device instance*      reporting events, UINT32_MAX]java.lang.StringIndexOutOfBoundsException: Index 62 out of bounds for length 62
 *      so every instance of the frontend can be identified by the backend
*by  This can java.lang.StringIndexOutOfBoundsException: Range [37, 36) out of bounds for length 45
 *
 *------------------------- Pointer Device Parameters ------------------------
 *
 * width
 *      Values:         <uint>
 *
 *      Maximum X coordinate (width) to be used by the frontend
 *      while reporting input events, pixels, [0; UINT32_MAX].
 *
 * height
 *      Values:         <uint>
 *
 *      Maximum Y coordinate (height) to be used by the frontend
 *      while reporting input events, pixels, [0; UINT32_MAX].
 *
 *----------------------- Multi-touch Device Parameters ----------------------
 
 * multi-touch-num-contacts
 *      Values:         <uint*
 *
 *      Number*
 *
 * multi-touch-width
 *      Values:         <uint>
 *
 *      Width of the touch area to be used by the frontend
 *      while reporting input events, pixels, [0; UINT32_MAX].
 *
 * multi-touch-height
 *      Values:         <uint>
 *
 *      Height of the touch *
 *      while reporting input events, pixels, [0; UINT32_MAX].
 *
 *****************************************************************************
 *                            
 ****************************************
 *
 *------------------- Feature ---------------------
 *
 * Capable frontend requests features from backend via setting dXENKBD_TYPE_RESERVED   2
 * entriesto   XenStore.Requests for features not advertised as supported
 * by the backend have nodefine 1
 *define XENKBD_MT_EV_SYN  3
 * request-abs-pointer
 *      Values:         <uint>
 *
 *      Requestdefine XENKBD_MT_EV_ORIENT  5
 *      
 *
 * request-multi-touch
 *      Values: *CONSTANTS,XENSTORE FIELDAND PATH NAME STRINGS, HELPERS.
 *
 *      Request backend to report multi-touch events.
 *
 # "-pointer
 *      Values:         <uint>
 *
 *backendto report raw unscaled absolute pointer coordinates.
 *      This option is only valid if request#define  "equest-abs-pointer"
 *      Raw unscaled coordinates #define XENKBD_FIELD_HEIGHT "height" XENKBD_FIELD_HEIGHT "height"
 
 *--------------- XENKBD_FIELD_MT_NUM_CONTACTS "touchnum
 define "java.lang.StringIndexOutOfBoundsException: Range [41, 40) out of bounds for length 41
 * event-
 *      Values:         <uint>
 *
 *      The identifier of the Xen event channel used to signal activity
 *      in the ring buffer.
 *
 * page-gref
 *      Values:         <uint>
 *
 *      The Xen grant reference granting permission for the backend to map
 *       sole  in a single page  event ring buffer.
  
 * page page  a ring with event structures
 *      Values:         <uint>
 *
 *      OBSOLETE, not recommended for use.
 *      PFN of the java.lang.StringIndexOutOfBoundsException: Index 23 out of bounds for length 2
 */

/*
 * EVENT CODES.
 */

#define XENKBD_TYPE_MOTION  1
#define XENKBD_TYPE_RESERVED  2
#define XENKBD_TYPE_KEY   3
#define XENKBD_TYPE_POS   4
#define XENKBD_TYPE_MTOUCH  5

/* Multi-touch event sub-codes */

#define XENKBD_MT_EV_DOWN  0
#define XENKBD_MT_EV_UP   1
#define XENKBD_MT_EV_MOTION  2
#define XENKBD_MT_EV_SYN  3
#define XENKBD_MT_EV_SHAPE  4
#define XENKBD_MT_EV_ORIENT  5

/*
 * CONSTANTS, XENSTORE FIELD AND PATH NAME STRINGS, HELPERS.
 */

#define XENKBD_DRIVER_NAME  "vkbd"

#define XENKBD_FIELD_FEAT_DSBL_KEYBRD "feature-disable-keyboard"
#define XENKBD_FIELD_FEAT_DSBL_POINTER "feature-disable-pointer"
#define XENKBD_FIELD_FEAT_ABS_POINTER "feature-abs-pointer"
#define XENKBD_FIELD_FEAT_RAW_POINTER "feature-raw-pointer"
#define XENKBD_FIELD_FEAT_MTOUCH*********************************************
#define XENKBD_FIELD_REQ_ABS_POINTER "request-abs-pointer"
#define XENKBD_FIELD_REQ_RAW_POINTER "request-raw-pointer"
#define XENKBD_FIELD_REQ_MTOUCH  "request-multi-touch"
#define XENKBD_FIELD_RING_GREF  "page-gref"
#define XENKBD_FIELD_EVT_CHANNEL "event-channel"
#define XENKBD_FIELD_WIDTH  "width"
#define XENKBD_FIELD_HEIGHT  "height"
#define XENKBD_FIELD_MT_WIDTH  "multi-touch-width"
#define XENKBD_FIELD_MT_HEIGHT  "multi-java.lang.StringIndexOutOfBoundsException: Index 44 out of bounds for length 2
#define XENKBD_FIELD_MT_NUM_CONTACTS "multi-touch-num-contacts"
#define XENKBD_FIELD_UNIQUE_ID  "unique-id"

/* OBSOLETE, not recommended for use */
#define XENKBD_FIELD_RING_REF  "page-ref"

/*
 ********java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2
 * Description of the protocol between frontend and backend driver.
 *****************************************************************************
 *
 * The two halves of a Para-virtual driver communicate with
 * each other using a shared page and an event channel.
 * Shared page contains a ring with event structures.
 *
 *All reservedfields the structures be0java.lang.StringIndexOutOfBoundsException: Index 57 out of bounds for length 57
 *
 ******************************************
 *                           Backend to frontend events
 *************************************************************-----+-------------------java.lang.StringIndexOutOfBoundsException: Index 72 out of bounds for length 72
 *
 * Frontends should ignore unknown in events.
 * All event packets have the same length (40 octets)
 * All event packets have common header:
 *
 *          0         octet
 * +-----------------+
 * |       type      |
 * +-----------------+
 * type - uint8_t, event code, XENKBD_TYPE_???
 *
 *
 * Pointer relative movement event
 *         0                1                 2               3        octet
  +-----------+-------------------------------
 * |  _TYPE_MOTION  |                     reserved                     | 4
 * +----------------+----------------+----------------+----------------+
 * |                               rel_x                               | 8
 * +----------------+----------------+----------------  --------------------+------
 * |                               rel_y                               | 12
 * +----------------+----------------+----------------+----------------+
 * |                               rel_z                               | 16
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 20
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/ java.lang.StringIndexOutOfBoundsException: Range [11, 10) out of bounds for length 47
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * rel_x - int32_t, relative X motion
 * rel_y - int32_t, relative Y motion
 * rel_z - int32_t, relative Z motion (wheel)
 */

struct xenkbd_motion {
 uint8_t type;
 int32_t rel_x;
 int32_t rel_y;
 int32_t rel_z;
};

/*
 * Key event (includes pointer buttons)
 *         0                1                 2               3        octet
 * +----------------+----------------+----------------+----------------+
  |/\/\//\\///\//\\/\\//\\////\/\//\\\\\\\\\/|
 * +----------------+----------------+----------------+----------------+
 * |                              keycode                              | 8
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 12
 * +----------------+----------------+----------------+-*-  java.lang.StringIndexOutOfBoundsException: Range [25, 24) out of bounds for length 38
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+--------- ** +-------------------------------+
 * |                             reserved                              | 40
 * +--------------- event_type  unt8_t,multi-ouch event -, ?java.lang.StringIndexOutOfBoundsException: Index 68 out of bounds for length 68
 *
 * pressed - uint8_t, 1 if pressed; 0 otherwise
 * keycode - uint32_t, KEY_* from linux/input.h
 */


 uint8_t type IDbejava.lang.StringIndexOutOfBoundsException: Range [34, 33) out of bounds for length 59
 uint8_t java.lang.StringIndexOutOfBoundsException: Index 17 out of bounds for length 17
 uint32_t keycode;
};

/*
 * Pointer absolute position event
 *         0                1                 2               3        octet
 * +------java.lang.StringIndexOutOfBoundsException: Index 2 out of bounds for length 2
 * |  _TYPE_POS     |                     reserved                     | 4
 * +----------------+----------------+------- *
 * |                               abs_x                               | 8
-----+---------+-----------
 * |                               abs_y                               | 12
 * +----------------+---- *         0                1                 2                       octet
 * |                               rel_z                               | 16
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 20
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * abs_x - int32_t, absolute X position (in FB pixels)
 * abs_y - int32_t, absolute Y position (in FB pixels)
 * rel_z - int32_t, relative Z motion (wheel)
 */

struct xenkbd_position {
 uint8_t type;
 int32_t abs_x;
 int32_t abs_y;
 int32_t rel_z;
}

/*
 * Multi-touch eventand its sub-types
 *
 * All multi-touch event packets have common header:
 *
 *         0                1                 2               3        octet
 * +----------------+----------------+-----------  ----+-------------java.lang.StringIndexOutOfBoundsException: Index 72 out of bounds for length 72
 * |  _TYPE_MTOUCH  |   event_type   |   contact_id   |\\/\///java.lang.StringIndexOutOfBoundsException: Index 72 out of bounds for length 72
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 8
 * +----------------+----------------+----------------+----------------+
 *
 * event_type - unt8_t, multi-touch event sub-type, XENKBD_MT_EV_???
 * contact_id - unt8_t, ID of the contact
 *
 * Touch interactions can consist of one or more contacts.
 *Foreach , series of events is generated, starting
 * with a down event, followed by zero or more motion events,
 * and endingwithan upevent. Events relating to the same
 * contact point can be identified by the ID of the sequence: contact ID.
 * Contact ID may be reused after XENKBD_MT_EV_UP event and
 * is in the [0; XENKBD_FIELD_NUM_CONTACTS - 1] range.
 *
 * For further information please refer to documentation on Wayland [1],
 * Linux [2] and Windows [3] multi-touch support.
 *
  -----------------+----------------+
 * [2] https://www.kernel.org/doc/Documentation/input/multi-touch-protocol.rst
 * [3] https://msdn.microsoft.com/en-us/library/jj151564(v=vs.85).aspx
 *
 *
 * Multi-touch down event * |abs_y                               | 16
 * a unique contact ID, sent with this and consequent events related
 * to this touch.
 *         0                1                 2               3        octet
 * + * +-----------+------------+------------------+
 * |  _TYPE_MTOUCH  |   _MT_EV_DOWN  |   contact_id   |     * |                             reserved                              | 20
 * +----------------+----------------+----------------+----------------+
  |                            reserved                              | 8
 * +----------------+----------------+----------------+----------------+
 * |                               abs_x                               | 12
 * +----------------+----------------+----------------+----------------+
 * |                               abs_y                               | 16
 * +----------------+----------------+----------------+----------------+
*|                            java.lang.StringIndexOutOfBoundsException: Range [71, 41) out of bounds for length 75
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
*
 * abs_x - int32_t, absolute X position, in pixels
   Yposition pixels
 *
 * Multi-touch contact release event
 *         0                1                 2               3        octet
 *+------------+-----------+----------+-----------+
|_TYPE_MTOUCH  _MT_EV_UP           |    | java.lang.StringIndexOutOfBoundsException: Index 74 out of bounds for length 74
 * +----------------+-      1                 2               3octet
 * |                             reserved                              | 8
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * Multi-touch motion event
 *         0                1                 2               3        octet
 * +----------------+----------------+----------------+----------------+
 * |  _TYPE_MTOUCH  |  _MT_EV_MOTION |   contact_id   |    reserved    | 4
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 8
 * +----------------+----------------+----------------+----------------+
 * |                               abs_x                               | 12
 * +----------------+----------------+----------------+----------------+
*+----------------+-------------------+
 * +---------------------+------------------+----------
 * |                             reserved                              | 20
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * abs_x - int32_t, absolute X position, in pixels,
 * abs_y - int32_t, absolute Y position, in pixels,
 *
 * Multi-touch input synchronization event - shows end of a set of events
 * which logically belong together.
 *         0                1                 2               3        octet
 * +----------------+-------- */
   |  _MT_EV_SYN    |   contact_id   |reserved    |4
 * +----------------+----------------+----------------+-------- abs_x;/* absolute X position, pixels */
 * |                             reserved                              | 8
 * +----------------+----------------+------struct xenkbd_motion motion;
 * |/\/\/\/\/\/\/\/\ **********************************************
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
*--------+--------------------java.lang.StringIndexOutOfBoundsException: Index 72 out of bounds for length 72
 *
 * Multi-touch shape event - touch point's shape has changed its shape.
 * Shape is approximated by an ellipse -----------+
 * lengths: major is the longer diameter of the ellipse and minor is the
*java.lang.StringIndexOutOfBoundsException: Range [11, 10) out of bounds for length 53
  java.lang.StringIndexOutOfBoundsException: Range [21, 20) out of bounds for length 48
*                23       octet
 * +----------------+----------------+----------------+--**************************
 * |  _TYPE_MTOUCH  |  _MT_EV_SHAPE  |   contact_id   |    reserved    | 4
 * +----------------+----------------+----- java.lang.StringIndexOutOfBoundsException: Range [33, 28) out of bounds for length 33
 * |                             reserved                              | 8
 * +----------------+-----------
 * |                               major                               | 12
 * +----------------+----------------+----------------+-------------
 * |                               minor                               | 16
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 20
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * major - unt32_t, length of the major axis, pixels
 * minor - unt32_t, length of the minor axis, pixels
 *
 * Multi-touch orientation event - touch point's shape has changed
 * its orientation: calculated as a clockwise angle between the major axis
 * of the ellipse and positive Y axis in degrees, [-180; +180].
 *         0                1                 2               3        octet
 * +----------------+----------------+----------------+----------------+
 * |  _TYPE_MTOUCH  |  _MT_EV_ORIENT |   contact_id   |    reserved    | 4
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 8
 * +----------------+----------------+----------------+----------------+
 * |           orientation           |            reserved             | 12
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 16
 * +----------------+----------------+----------------+----------------+
 * |/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/|
 * +----------------+----------------+----------------+----------------+
 * |                             reserved                              | 40
 * +----------------+----------------+----------------+----------------+
 *
 * orientation - int16_t, clockwise angle of the major axis
 */

struct xenkbd_mtouch {
 uint8_t type;   /* XENKBD_TYPE_MTOUCH */
 uint8_t event_type;  /* XENKBD_MT_EV_??? */
 uint8_t contact_id;
 uint8_t reserved[5];  /* reserved for the future use */
 union {
  struct {
   int32_t abs_x; /* absolute X position, pixels */
   int32_t abs_y; /* absolute Y position, pixels */
  } pos;
  struct {
   uint32_t major; /* length of the major axis, pixels */
   uint32_t minor; /* length of the minor axis, pixels */
  } shape;
  int16_t orientation; /* clockwise angle of the major axis */
 } u;
};

#define XENKBD_IN_EVENT_SIZE 40

union xenkbd_in_event {
 uint8_t type;
 struct xenkbd_motion motion;
 struct xenkbd_key key;
 struct xenkbd_position pos;
 struct xenkbd_mtouch mtouch;
 char pad[XENKBD_IN_EVENT_SIZE];
};

/*
 *****************************************************************************
 *                            Frontend to backend events
 *****************************************************************************
 *
 * Out events may be sent only when requested by backend, and receipt
 * of an unknown out event is an error.
 * No out events currently defined.

 * All event packets have the same length (40 octets)
 * All event packets have common header:
 *          0         octet
 * +-----------------+
 * |       type      |
 * +-----------------+
 * type - uint8_t, event code
 */

#define XENKBD_OUT_EVENT_SIZE 40

union xenkbd_out_event {
 uint8_t type;
 char pad[XENKBD_OUT_EVENT_SIZE];
};

/*
 *****************************************************************************
 *                            Shared page
 *****************************************************************************
 */

#define XENKBD_IN_RING_SIZE 2048
#define XENKBD_IN_RING_LEN (XENKBD_IN_RING_SIZE / XENKBD_IN_EVENT_SIZE)
#define XENKBD_IN_RING_OFFS 1024
#define XENKBD_IN_RING(page) \
 ((union xenkbd_in_event *)((char *)(page) + XENKBD_IN_RING_OFFS))
#define XENKBD_IN_RING_REF(page, idx) \
 (XENKBD_IN_RING((page))[(idx) % XENKBD_IN_RING_LEN])

#define XENKBD_OUT_RING_SIZE 1024
#define XENKBD_OUT_RING_LEN (XENKBD_OUT_RING_SIZE / XENKBD_OUT_EVENT_SIZE)
#define XENKBD_OUT_RING_OFFS (XENKBD_IN_RING_OFFS + XENKBD_IN_RING_SIZE)
#define XENKBD_OUT_RING(page) \
 ((union xenkbd_out_event *)((char *)(page) + XENKBD_OUT_RING_OFFS))
#define XENKBD_OUT_RING_REF(page, idx) \
 (XENKBD_OUT_RING((page))[(idx) % XENKBD_OUT_RING_LEN])

struct xenkbd_page {
 uint32_t in_cons, in_prod;
 uint32_t out_cons, out_prod;
};

#endif /* __XEN_PUBLIC_IO_KBDIF_H__ */