xref: /btstack/port/stm32-f4discovery-usb/Middlewares/ST/STM32_USB_Host_Library/Class/HID/Inc/usbh_hid_mouse.h (revision a8f7f3fcbcd51f8d2e92aca076b6a9f812db358c)
1 /**
2   ******************************************************************************
3   * @file    usbh_hid_mouse.h
4   * @author  MCD Application Team
5   * @brief   This file contains all the prototypes for the usbh_hid_mouse.c
6   ******************************************************************************
7   * @attention
8   *
9   * <h2><center>&copy; Copyright (c) 2015 STMicroelectronics.
10   * All rights reserved.</center></h2>
11   *
12   * This software component is licensed by ST under Ultimate Liberty license
13   * SLA0044, the "License"; You may not use this file except in compliance with
14   * the License. You may obtain a copy of the License at:
15   *                      www.st.com/SLA0044
16   *
17   ******************************************************************************
18   */
19 
20 /* Define to prevent recursive  ----------------------------------------------*/
21 #ifndef __USBH_HID_MOUSE_H
22 #define __USBH_HID_MOUSE_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "usbh_hid.h"
30 
31 /** @addtogroup USBH_LIB
32   * @{
33   */
34 
35 /** @addtogroup USBH_CLASS
36   * @{
37   */
38 
39 /** @addtogroup USBH_HID_CLASS
40   * @{
41   */
42 
43 /** @defgroup USBH_HID_MOUSE
44   * @brief This file is the Header file for usbh_hid_mouse.c
45   * @{
46   */
47 
48 
49 /** @defgroup USBH_HID_MOUSE_Exported_Types
50   * @{
51   */
52 
53 typedef struct _HID_MOUSE_Info
54 {
55   uint8_t              x;
56   uint8_t              y;
57   uint8_t              buttons[3];
58 }
59 HID_MOUSE_Info_TypeDef;
60 
61 /**
62   * @}
63   */
64 
65 /** @defgroup USBH_HID_MOUSE_Exported_Defines
66   * @{
67   */
68 /**
69   * @}
70   */
71 
72 /** @defgroup USBH_HID_MOUSE_Exported_Macros
73   * @{
74   */
75 /**
76   * @}
77   */
78 
79 /** @defgroup USBH_HID_MOUSE_Exported_Variables
80   * @{
81   */
82 /**
83   * @}
84   */
85 
86 /** @defgroup USBH_HID_MOUSE_Exported_FunctionsPrototype
87   * @{
88   */
89 USBH_StatusTypeDef USBH_HID_MouseInit(USBH_HandleTypeDef *phost);
90 HID_MOUSE_Info_TypeDef *USBH_HID_GetMouseInfo(USBH_HandleTypeDef *phost);
91 
92 /**
93   * @}
94   */
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 #endif /* __USBH_HID_MOUSE_H */
101 
102 /**
103   * @}
104   */
105 
106 /**
107   * @}
108   */
109 
110 /**
111   * @}
112   */
113 
114 /**
115   * @}
116   */
117 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
118