Atmel Software Framework

hid/device/mouse/example/main.h File Reference

Declaration of main function used by HID mouse example.

Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.

Functions

void main_mouse_disable (void)
 Called by HID interface Callback running when USB Host disable mouse interface. More...
 
bool main_mouse_enable (void)
 Called by HID interface Callback running when USB Host enable mouse interface. More...
 
void main_remotewakeup_disable (void)
 Called by UDC when USB Host request to disable remote wakeup. More...
 
void main_remotewakeup_enable (void)
 Called by UDC when USB Host request to enable remote wakeup. More...
 
void main_resume_action (void)
 Called by UDD when the USB line exit of suspend state. More...
 
void main_sof_action (void)
 Called when a start of frame is received on USB line. More...
 
void main_suspend_action (void)
 Enters the application in low power mode Callback called when USB host sets USB line in suspend state. More...
 

void main_mouse_disable ( void  )

Called by HID interface Callback running when USB Host disable mouse interface.

Called by HID interface Callback running when USB Host disable mouse interface.

Called by the USB stack when the host disables the mouse interface.

bool main_mouse_enable ( void  )

Called by HID interface Callback running when USB Host enable mouse interface.

Return values
trueif mouse startup is ok

Called by HID interface Callback running when USB Host enable mouse interface.

Called by the USB stack when the host enables the mouse interface.

Return values
trueSignal that mouse started up OK
void main_remotewakeup_disable ( void  )

Called by UDC when USB Host request to disable remote wakeup.

Called by UDC when USB Host request to disable remote wakeup.

This is called by the USB stack when the host requests remote wake-up to be disabled, and will request the user interface to disable wake-up.

void main_remotewakeup_enable ( void  )

Called by UDC when USB Host request to enable remote wakeup.

Called by UDC when USB Host request to enable remote wakeup.

This is called by the USB stack when the host requests remote wake-up to be enabled, and will request the user interface to enable wake-up.

void main_resume_action ( void  )

Called by UDD when the USB line exit of suspend state.

Turn on a led to notify active mode Called when the USB line is resumed from the suspend state.

Turn on a led to notify active mode Called when the USB line is resumed from the suspend state.

Called by UDD when the USB line exit of suspend state.

Called by USB stack when the bus resumes from suspend.

void main_sof_action ( void  )

Called when a start of frame is received on USB line.

Manages the leds behaviors Called when a start of frame is received on USB line each 1ms.

Manages the leds behaviors Called when a start of frame is received on USB line each 1ms.

Called when a start of frame is received on USB line.

Called by USB stack when a start of frame is received, i.e., every millisecond during normal operation. This function triggers processing of the user interface if the HID interface has been enabled.

void main_suspend_action ( void  )

Enters the application in low power mode Callback called when USB host sets USB line in suspend state.

Enters the application in low power mode Callback called when USB host sets USB line in suspend state.

Called by USB stack when host suspends the bus.