USBLibAPIGuide  1.00.00.01
usbhhidmouse.h
Go to the documentation of this file.
1 //*****************************************************************************
2 //
3 // usbhhidmouse.h - This file holds the application interfaces for USB
4 // mouse devices.
5 //
6 // Copyright (c) 2008-2017 Texas Instruments Incorporated. All rights reserved.
7 // Software License Agreement
8 //
9 // Texas Instruments (TI) is supplying this software for use solely and
10 // exclusively on TI's microcontroller products. The software is owned by
11 // TI and/or its suppliers, and is protected under applicable copyright
12 // laws. You may not combine this software with "viral" open-source
13 // software in order to form a larger program.
14 //
15 // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
16 // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
17 // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
19 // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
20 // DAMAGES, FOR ANY REASON WHATSOEVER.
21 //
22 //*****************************************************************************
23 
24 #ifndef __USBHHIDMOUSE_H__
25 #define __USBHHIDMOUSE_H__
26 
27 //*****************************************************************************
28 //
29 // If building with a C++ compiler, make all of the definitions in this header
30 // have a C binding.
31 //
32 //*****************************************************************************
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
38 //*****************************************************************************
39 //
42 //
43 //*****************************************************************************
44 
45 typedef struct tUSBHMouse tUSBHMouse;
46 
47 //*****************************************************************************
48 //
49 // The prototype for the host USB mouse driver callback function.
50 //
51 //*****************************************************************************
52 typedef void (*tUSBHIDMouseCallback)(tUSBHMouse *psMsInstance,
53  uint32_t ui32Event,
54  uint32_t ui32MsgParam,
55  void *pvMsgData);
56 
57 extern tUSBHMouse * USBHMouseOpen(tUSBHIDMouseCallback pfnCallback,
58  uint8_t *pui8Buffer, uint32_t ui32Size);
59 extern uint32_t USBHMouseClose(tUSBHMouse *psMsInstance);
60 extern uint32_t USBHMouseInit(tUSBHMouse *psMsInstance);
61 extern uint32_t USBHMouseLPMSleep(tUSBHMouse *psMsInstance);
62 extern uint32_t USBHMouseLPMStatus(tUSBHMouse *psMsInstance);
63 
64 //*****************************************************************************
65 //
67 //
68 //*****************************************************************************
69 
70 //*****************************************************************************
71 //
72 // Mark the end of the C bindings section for C++ compilers.
73 //
74 //*****************************************************************************
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
struct tUSBHMouse tUSBHMouse
Definition: usbhhidmouse.h:45
tUSBHMouse * USBHMouseOpen(tUSBHIDMouseCallback pfnCallback, uint8_t *pui8Buffer, uint32_t ui32Size)
Definition: usbhhidmouse.c:138
uint32_t USBHMouseClose(tUSBHMouse *psMsInstance)
Definition: usbhhidmouse.c:176
uint32_t USBHMouseInit(tUSBHMouse *psMsInstance)
Definition: usbhhidmouse.c:211
uint32_t USBHMouseLPMStatus(tUSBHMouse *psMsInstance)
Definition: usbhhidmouse.c:437
uint32_t USBHMouseLPMSleep(tUSBHMouse *psMsInstance)
Definition: usbhhidmouse.c:409
void(* tUSBHIDMouseCallback)(tUSBHMouse *psMsInstance, uint32_t ui32Event, uint32_t ui32MsgParam, void *pvMsgData)
Definition: usbhhidmouse.h:52
© Copyright 1995-2020, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale