[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseAbsolutePointerDxe / MouseHid.c

/** @file\r
  Helper functions to parse HID report descriptor and items.\r
\r
Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "UsbMouseAbsolutePointer.h"\r
\r
\r
/**\r
  Get next HID item from report descriptor.\r
\r
  This function retrieves next HID item from report descriptor, according to\r
  the start position.\r
  According to USB HID Specification, An item is piece of information\r
  about the device. All items have a one-byte prefix that contains\r
  the item tag, item type, and item size.\r
  There are two basic types of items: short items and long items.\r
  If the item is a short item, its optional data size may be 0, 1, 2, or 4 bytes.\r
  Only short item is supported here.\r
\r
  @param  StartPos          Start position of the HID item to get.\r
  @param  EndPos            End position of the range to get the the next HID item.\r
  @param  HidItem           Buffer for the HID Item to return.\r
\r
  @return Pointer to end of the HID item returned.\r
          NULL if no HID item retrieved.\r
\r
**/\r
UINT8 *\r
GetNextHidItem (\r
  IN  UINT8    *StartPos,\r
  IN  UINT8    *EndPos,\r
  OUT HID_ITEM *HidItem\r
  )\r
{\r
  UINT8 Temp;\r
\r
  if (EndPos <= StartPos) {\r
    return NULL;\r
  }\r
\r
  Temp = *StartPos;\r
  StartPos++;\r
\r
  //\r
  // Bit format of prefix byte:\r
  // Bits 0-1: Size\r
  // Bits 2-3: Type\r
  // Bits 4-7: Tag\r
  //\r
  HidItem->Type = BitFieldRead8 (Temp, 2, 3);\r
  HidItem->Tag  = BitFieldRead8 (Temp, 4, 7);\r
\r
  if (HidItem->Tag == HID_ITEM_TAG_LONG) {\r
    //\r
    // Long Items are not supported, although we try to parse it.\r
    //\r
    HidItem->Format = HID_ITEM_FORMAT_LONG;\r
\r
    if ((EndPos - StartPos) >= 2) {\r
      HidItem->Size = *StartPos++;\r
      HidItem->Tag  = *StartPos++;\r
\r
      if ((EndPos - StartPos) >= HidItem->Size) {\r
        HidItem->Data.LongData = StartPos;\r
        StartPos += HidItem->Size;\r
        return StartPos;\r
      }\r
    }\r
  } else {\r
    HidItem->Format = HID_ITEM_FORMAT_SHORT;\r
    HidItem->Size   = BitFieldRead8 (Temp, 0, 1);\r
\r
    switch (HidItem->Size) {\r
    case 0:\r
      //\r
      // No data\r
      //\r
      return StartPos;\r
\r
    case 1:\r
      //\r
      // 1-byte data\r
      //\r
      if ((EndPos - StartPos) >= 1) {\r
        HidItem->Data.Uint8 = *StartPos++;\r
        return StartPos;\r
      }\r
\r
    case 2:\r
      //\r
      // 2-byte data\r
      //\r
      if ((EndPos - StartPos) >= 2) {\r
        CopyMem (&HidItem->Data.Uint16, StartPos, sizeof (UINT16));\r
        StartPos += 2;\r
        return StartPos;\r
      }\r
\r
    case 3:\r
      //\r
      // 4-byte data, adjust size\r
      //\r
      HidItem->Size = 4;\r
      if ((EndPos - StartPos) >= 4) {\r
        CopyMem (&HidItem->Data.Uint32, StartPos, sizeof (UINT32));\r
        StartPos += 4;\r
        return StartPos;\r
      }\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
\r
/**\r
  Get data from HID item.\r
\r
  This function retrieves data from HID item.\r
  It only supports short items, which has 4 types of data:\r
  0, 1, 2, or 4 bytes.\r
\r
  @param  HidItem       Pointer to the HID item.\r
\r
  @return The data of HID item.\r
\r
**/\r
UINT32\r
GetItemData (\r
  IN  HID_ITEM *HidItem\r
  )\r
{\r
  //\r
  // Get data from HID item.\r
  //\r
  switch (HidItem->Size) {\r
  case 1:\r
    return HidItem->Data.Uint8;\r
  case 2:\r
    return HidItem->Data.Uint16;\r
  case 4:\r
    return HidItem->Data.Uint32;\r
  }\r
  return 0;\r
}\r
\r
/**\r
  Parse HID item from report descriptor.\r
\r
  There are three item types: Main, Global, and Local.\r
  This function parses these types of HID items according\r
  to tag info.\r
\r
  @param  UsbMouse          The instance of USB_MOUSE_ABSOLUTE_POINTER_DEV\r
  @param  HidItem           The HID item to parse\r
\r
**/\r
VOID\r
ParseHidItem (\r
  IN  USB_MOUSE_ABSOLUTE_POINTER_DEV   *UsbMouse,\r
  IN  HID_ITEM                         *HidItem\r
  )\r
{\r
  UINT8  Data;\r
\r
  switch (HidItem->Type) {\r
\r
  case HID_ITEM_TYPE_MAIN:\r
    //\r
    // we don't care any main items, just skip\r
    //\r
    return ;\r
\r
  case HID_ITEM_TYPE_GLOBAL:\r
    //\r
    // For global items, we only care Usage Page tag for Button Page here\r
    //\r
    if (HidItem->Tag == HID_GLOBAL_ITEM_TAG_USAGE_PAGE) {\r
      Data = (UINT8) GetItemData (HidItem);\r
      if (Data == 0x09) {\r
        //\r
        // Button Page\r
        //\r
        UsbMouse->PrivateData.ButtonDetected = TRUE;\r
      }\r
  }\r
    return;\r
\r
  case HID_ITEM_TYPE_LOCAL:\r
    if (HidItem->Size == 0) {\r
    //\r
      // No expected data for local item\r
    //\r
    return ;\r
    }\r
\r
    Data = (UINT8) GetItemData (HidItem);\r
\r
    switch (HidItem->Tag) {\r
    case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:\r
      if (UsbMouse->PrivateData.ButtonDetected) {\r
        UsbMouse->PrivateData.ButtonMinIndex = Data;\r
    }\r
    return ;\r
\r
    case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:\r
    {\r
      if (UsbMouse->PrivateData.ButtonDetected) {\r
        UsbMouse->PrivateData.ButtonMaxIndex = Data;\r
      }\r
      return ;\r
    }\r
\r
    default:\r
        return ;\r
      }\r
  }\r
}\r
\r
\r
/**\r
  Parse Mouse Report Descriptor.\r
\r
  According to USB HID Specification, report descriptors are\r
  composed of pieces of information. Each piece of information\r
  is called an Item. This function retrieves each item from\r
  the report descriptor and updates USB_MOUSE_ABSOLUTE_POINTER_DEV.\r
\r
  @param  UsbMouseAbsolutePointer  The instance of USB_MOUSE_ABSOLUTE_POINTER_DEV\r
  @param  ReportDescriptor         Report descriptor to parse\r
  @param  ReportSize               Report descriptor size\r
\r
  @retval EFI_SUCCESS              Report descriptor successfully parsed.\r
  @retval EFI_UNSUPPORTED          Report descriptor contains long item.\r
\r
**/\r
EFI_STATUS\r
ParseMouseReportDescriptor (\r
  OUT USB_MOUSE_ABSOLUTE_POINTER_DEV   *UsbMouseAbsolutePointer,\r
  IN  UINT8                            *ReportDescriptor,\r
  IN  UINTN                            ReportSize\r
  )\r
{\r
  UINT8     *DescriptorEnd;\r
  UINT8     *Ptr;\r
  HID_ITEM  HidItem;\r
\r
  DescriptorEnd = ReportDescriptor + ReportSize;\r
\r
  Ptr = GetNextHidItem (ReportDescriptor, DescriptorEnd, &HidItem);\r
  while (Ptr != NULL) {\r
    if (HidItem.Format != HID_ITEM_FORMAT_SHORT) {\r
      //\r
      // Long Item is not supported at current HID revision\r
      //\r
      return EFI_UNSUPPORTED;\r
    }\r
\r
    ParseHidItem (UsbMouseAbsolutePointer, &HidItem);\r
\r
    Ptr = GetNextHidItem (Ptr, DescriptorEnd, &HidItem);\r
  }\r
\r
  UsbMouseAbsolutePointer->NumberOfButtons = (UINT8) (UsbMouseAbsolutePointer->PrivateData.ButtonMaxIndex - UsbMouseAbsolutePointer->PrivateData.ButtonMinIndex + 1);\r
  UsbMouseAbsolutePointer->XLogicMax = 1023;\r
  UsbMouseAbsolutePointer->YLogicMax = 1023;\r
  UsbMouseAbsolutePointer->XLogicMin = -1023;\r
  UsbMouseAbsolutePointer->YLogicMin = -1023;\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
	1	/** @file\r
	2	Helper functions to parse HID report descriptor and items.\r
	3	\r
	4	Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>\r
	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
	6	\r
	7	**/\r
	8	\r
	9	#include "UsbMouseAbsolutePointer.h"\r
	10	\r
	11	\r
	12	/**\r
	13	Get next HID item from report descriptor.\r
	14	\r
	15	This function retrieves next HID item from report descriptor, according to\r
	16	the start position.\r
	17	According to USB HID Specification, An item is piece of information\r
	18	about the device. All items have a one-byte prefix that contains\r
	19	the item tag, item type, and item size.\r
	20	There are two basic types of items: short items and long items.\r
	21	If the item is a short item, its optional data size may be 0, 1, 2, or 4 bytes.\r
	22	Only short item is supported here.\r
	23	\r
	24	@param StartPos Start position of the HID item to get.\r
	25	@param EndPos End position of the range to get the the next HID item.\r
	26	@param HidItem Buffer for the HID Item to return.\r
	27	\r
	28	@return Pointer to end of the HID item returned.\r
	29	NULL if no HID item retrieved.\r
	30	\r
	31	**/\r
	32	UINT8 *\r
	33	GetNextHidItem (\r
	34	IN UINT8 *StartPos,\r
	35	IN UINT8 *EndPos,\r
	36	OUT HID_ITEM *HidItem\r
	37	)\r
	38	{\r
	39	UINT8 Temp;\r
	40	\r
	41	if (EndPos <= StartPos) {\r
	42	return NULL;\r
	43	}\r
	44	\r
	45	Temp = *StartPos;\r
	46	StartPos++;\r
	47	\r
	48	//\r
	49	// Bit format of prefix byte:\r
	50	// Bits 0-1: Size\r
	51	// Bits 2-3: Type\r
	52	// Bits 4-7: Tag\r
	53	//\r
	54	HidItem->Type = BitFieldRead8 (Temp, 2, 3);\r
	55	HidItem->Tag = BitFieldRead8 (Temp, 4, 7);\r
	56	\r
	57	if (HidItem->Tag == HID_ITEM_TAG_LONG) {\r
	58	//\r
	59	// Long Items are not supported, although we try to parse it.\r
	60	//\r
	61	HidItem->Format = HID_ITEM_FORMAT_LONG;\r
	62	\r
	63	if ((EndPos - StartPos) >= 2) {\r
	64	HidItem->Size = *StartPos++;\r
	65	HidItem->Tag = *StartPos++;\r
	66	\r
	67	if ((EndPos - StartPos) >= HidItem->Size) {\r
	68	HidItem->Data.LongData = StartPos;\r
	69	StartPos += HidItem->Size;\r
	70	return StartPos;\r
	71	}\r
	72	}\r
	73	} else {\r
	74	HidItem->Format = HID_ITEM_FORMAT_SHORT;\r
	75	HidItem->Size = BitFieldRead8 (Temp, 0, 1);\r
	76	\r
	77	switch (HidItem->Size) {\r
	78	case 0:\r
	79	//\r
	80	// No data\r
	81	//\r
	82	return StartPos;\r
	83	\r
	84	case 1:\r
	85	//\r
	86	// 1-byte data\r
	87	//\r
	88	if ((EndPos - StartPos) >= 1) {\r
	89	HidItem->Data.Uint8 = *StartPos++;\r
	90	return StartPos;\r
	91	}\r
	92	\r
	93	case 2:\r
	94	//\r
	95	// 2-byte data\r
	96	//\r
	97	if ((EndPos - StartPos) >= 2) {\r
	98	CopyMem (&HidItem->Data.Uint16, StartPos, sizeof (UINT16));\r
	99	StartPos += 2;\r
	100	return StartPos;\r
	101	}\r
	102	\r
	103	case 3:\r
	104	//\r
	105	// 4-byte data, adjust size\r
	106	//\r
	107	HidItem->Size = 4;\r
	108	if ((EndPos - StartPos) >= 4) {\r
	109	CopyMem (&HidItem->Data.Uint32, StartPos, sizeof (UINT32));\r
	110	StartPos += 4;\r
	111	return StartPos;\r
	112	}\r
	113	}\r
	114	}\r
	115	\r
	116	return NULL;\r
	117	}\r
	118	\r
	119	\r
	120	/**\r
	121	Get data from HID item.\r
	122	\r
	123	This function retrieves data from HID item.\r
	124	It only supports short items, which has 4 types of data:\r
	125	0, 1, 2, or 4 bytes.\r
	126	\r
	127	@param HidItem Pointer to the HID item.\r
	128	\r
	129	@return The data of HID item.\r
	130	\r
	131	**/\r
	132	UINT32\r
	133	GetItemData (\r
	134	IN HID_ITEM *HidItem\r
	135	)\r
	136	{\r
	137	//\r
	138	// Get data from HID item.\r
	139	//\r
	140	switch (HidItem->Size) {\r
	141	case 1:\r
	142	return HidItem->Data.Uint8;\r
	143	case 2:\r
	144	return HidItem->Data.Uint16;\r
	145	case 4:\r
	146	return HidItem->Data.Uint32;\r
	147	}\r
	148	return 0;\r
	149	}\r
	150	\r
	151	/**\r
	152	Parse HID item from report descriptor.\r
	153	\r
	154	There are three item types: Main, Global, and Local.\r
	155	This function parses these types of HID items according\r
	156	to tag info.\r
	157	\r
	158	@param UsbMouse The instance of USB_MOUSE_ABSOLUTE_POINTER_DEV\r
	159	@param HidItem The HID item to parse\r
	160	\r
	161	**/\r
	162	VOID\r
	163	ParseHidItem (\r
	164	IN USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouse,\r
	165	IN HID_ITEM *HidItem\r
	166	)\r
	167	{\r
	168	UINT8 Data;\r
	169	\r
	170	switch (HidItem->Type) {\r
	171	\r
	172	case HID_ITEM_TYPE_MAIN:\r
	173	//\r
	174	// we don't care any main items, just skip\r
	175	//\r
	176	return ;\r
	177	\r
	178	case HID_ITEM_TYPE_GLOBAL:\r
	179	//\r
	180	// For global items, we only care Usage Page tag for Button Page here\r
	181	//\r
	182	if (HidItem->Tag == HID_GLOBAL_ITEM_TAG_USAGE_PAGE) {\r
	183	Data = (UINT8) GetItemData (HidItem);\r
	184	if (Data == 0x09) {\r
	185	//\r
	186	// Button Page\r
	187	//\r
	188	UsbMouse->PrivateData.ButtonDetected = TRUE;\r
	189	}\r
	190	}\r
	191	return;\r
	192	\r
	193	case HID_ITEM_TYPE_LOCAL:\r
	194	if (HidItem->Size == 0) {\r
	195	//\r
	196	// No expected data for local item\r
	197	//\r
	198	return ;\r
	199	}\r
	200	\r
	201	Data = (UINT8) GetItemData (HidItem);\r
	202	\r
	203	switch (HidItem->Tag) {\r
	204	case HID_LOCAL_ITEM_TAG_USAGE_MINIMUM:\r
	205	if (UsbMouse->PrivateData.ButtonDetected) {\r
	206	UsbMouse->PrivateData.ButtonMinIndex = Data;\r
	207	}\r
	208	return ;\r
	209	\r
	210	case HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM:\r
	211	{\r
	212	if (UsbMouse->PrivateData.ButtonDetected) {\r
	213	UsbMouse->PrivateData.ButtonMaxIndex = Data;\r
	214	}\r
	215	return ;\r
	216	}\r
	217	\r
	218	default:\r
	219	return ;\r
	220	}\r
	221	}\r
	222	}\r
	223	\r
	224	\r
	225	/**\r
	226	Parse Mouse Report Descriptor.\r
	227	\r
	228	According to USB HID Specification, report descriptors are\r
	229	composed of pieces of information. Each piece of information\r
	230	is called an Item. This function retrieves each item from\r
	231	the report descriptor and updates USB_MOUSE_ABSOLUTE_POINTER_DEV.\r
	232	\r
	233	@param UsbMouseAbsolutePointer The instance of USB_MOUSE_ABSOLUTE_POINTER_DEV\r
	234	@param ReportDescriptor Report descriptor to parse\r
	235	@param ReportSize Report descriptor size\r
	236	\r
	237	@retval EFI_SUCCESS Report descriptor successfully parsed.\r
	238	@retval EFI_UNSUPPORTED Report descriptor contains long item.\r
	239	\r
	240	**/\r
	241	EFI_STATUS\r
	242	ParseMouseReportDescriptor (\r
	243	OUT USB_MOUSE_ABSOLUTE_POINTER_DEV *UsbMouseAbsolutePointer,\r
	244	IN UINT8 *ReportDescriptor,\r
	245	IN UINTN ReportSize\r
	246	)\r
	247	{\r
	248	UINT8 *DescriptorEnd;\r
	249	UINT8 *Ptr;\r
	250	HID_ITEM HidItem;\r
	251	\r
	252	DescriptorEnd = ReportDescriptor + ReportSize;\r
	253	\r
	254	Ptr = GetNextHidItem (ReportDescriptor, DescriptorEnd, &HidItem);\r
	255	while (Ptr != NULL) {\r
	256	if (HidItem.Format != HID_ITEM_FORMAT_SHORT) {\r
	257	//\r
	258	// Long Item is not supported at current HID revision\r
	259	//\r
	260	return EFI_UNSUPPORTED;\r
	261	}\r
	262	\r
	263	ParseHidItem (UsbMouseAbsolutePointer, &HidItem);\r
	264	\r
	265	Ptr = GetNextHidItem (Ptr, DescriptorEnd, &HidItem);\r
	266	}\r
	267	\r
	268	UsbMouseAbsolutePointer->NumberOfButtons = (UINT8) (UsbMouseAbsolutePointer->PrivateData.ButtonMaxIndex - UsbMouseAbsolutePointer->PrivateData.ButtonMinIndex + 1);\r
	269	UsbMouseAbsolutePointer->XLogicMax = 1023;\r
	270	UsbMouseAbsolutePointer->YLogicMax = 1023;\r
	271	UsbMouseAbsolutePointer->XLogicMin = -1023;\r
	272	UsbMouseAbsolutePointer->YLogicMin = -1023;\r
	273	\r
	274	return EFI_SUCCESS;\r
	275	}\r