Usbd_hid_mouse [Common-used USB Descriptors]

Collaboration diagram for Usbd_hid_mouse:

Data Structures
struct	HIDDMouseReport
struct	HIDDMouseDriver
struct	_HIDDMouseDriverConfigurationDescriptors
struct	_HIDDMouseInputReport
Modules
	Usbd_hid_mouse_id
	HID Mouse Button bitmaps
Defines
#define	HIDDMouse_TAG   (1 << 3)
#define	HIDDMouse_Xsign   (1 << 4)
#define	HIDDMouse_Ysign   (1 << 5)
#define	HIDDMouseDriver_REPORTDESCRIPTORSIZE   50
Functions
void	HIDDMouseDriver_Initialize (const USBDDriverDescriptors *pDescriptors)
void	HIDDMouseDriver_ConfigurationChangedHandler (uint8_t cfgnum)
void	HIDDMouseDriver_RequestHandler (const USBGenericRequest *request)
uint8_t	HIDDMouseDriver_ChangePoints (uint8_t bmButtons, int8_t deltaX, int8_t deltaY)
void	HIDDMouseDriver_RemoteWakeUp (void)
struct _HIDDMouseDriverConfigurationDescriptors	__attribute__ ((__packed__)) HIDDMouseDriverConfigurationDescriptors
Variables
USBDDriverDescriptors	hiddMouseDriverDescriptors

---

Define Documentation

#define HIDDMouse_TAG   (1 << 3)

Tag bit (Always 1)

Definition at line 53 of file HIDDMouseDriver.c.

#define HIDDMouse_Xsign   (1 << 4)

Xsign bit

Definition at line 55 of file HIDDMouseDriver.c.

#define HIDDMouse_Ysign   (1 << 5)

Ysign bit

Definition at line 57 of file HIDDMouseDriver.c.

#define HIDDMouseDriver_REPORTDESCRIPTORSIZE   50

Size of the report descriptor in bytes.

Definition at line 87 of file HIDDMouseDriver.h.

---

Function Documentation

uint8_t HIDDMouseDriver_ChangePoints	(	uint8_t	bmButtons,
		int8_t	deltaX,
		int8_t	deltaY
	)

Update the Mouse button status and location changes via input report to host

Parameters:

	bmButtons	Bit map of the button status
	deltaX	Movment on X direction
	deltaY	Movment on Y direction

void HIDDMouseDriver_ConfigurationChangedHandler

(

uint8_t

cfgnum

)

Handles configureation changed event.

Parameters:

cfgnum

New configuration number

void HIDDMouseDriver_Initialize

(

const USBDDriverDescriptors *

pDescriptors

)

Initializes the HID Mouse device driver.

Parameters:

pDescriptors

Pointer to descriptor list for the HID Mouse.

void HIDDMouseDriver_RemoteWakeUp

(

void

)

Starts a remote wake-up sequence if the host has explicitely enabled it by sending the appropriate SET_FEATURE request.

void HIDDMouseDriver_RequestHandler

(

const USBGenericRequest *

request

)

Handles HID-specific SETUP request sent by the host.

Parameters:

request

Pointer to a USBGenericRequest instance

---

Variable Documentation

USBDDriverDescriptors hiddMouseDriverDescriptors

Initial value:

 {

    &deviceDescriptor,
    (USBConfigurationDescriptor *) &configurationDescriptors,
    &qualifierDescriptor,
    0, 
    0, 
    0, 
    &qualifierDescriptor,
    0, 
    stringDescriptors,
    4 
}

List of descriptors used by the HID keyboard driver.

Definition at line 237 of file USBDDriverDescriptors.c.