aboutsummaryrefslogtreecommitdiffstats
path: root/Demos/Mouse
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-03-19 14:16:12 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-03-19 14:16:12 +0000
commit88051e78a281f5776538558aec113ff2b66e056c (patch)
treecfdd65c067c9c660b7e3d3f6edcefe25596f5f6f /Demos/Mouse
parent48400df13c7f9f4f0fd8e7f841d49f9502557cb1 (diff)
downloadlufa-88051e78a281f5776538558aec113ff2b66e056c.tar.gz
lufa-88051e78a281f5776538558aec113ff2b66e056c.tar.bz2
lufa-88051e78a281f5776538558aec113ff2b66e056c.zip
Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.
Corrections to Keyboard demo. Removed AVRISP_Programmer project due to code quality concerns.
Diffstat (limited to 'Demos/Mouse')
-rw-r--r--Demos/Mouse/Mouse.c149
-rw-r--r--Demos/Mouse/Mouse.h5
-rw-r--r--Demos/Mouse/Mouse.txt54
-rw-r--r--Demos/Mouse/makefile1
4 files changed, 163 insertions, 46 deletions
diff --git a/Demos/Mouse/Mouse.c b/Demos/Mouse/Mouse.c
index f8ec0a0f5..b61850abe 100644
--- a/Demos/Mouse/Mouse.c
+++ b/Demos/Mouse/Mouse.c
@@ -45,8 +45,13 @@ BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
/* Scheduler Task List */
TASK_LIST
{
+ #if !defined(INTERRUPT_CONTROL_ENDPOINT)
{ Task: USB_USBTask , TaskStatus: TASK_STOP },
+ #endif
+
+ #if !defined(INTERRUPT_DATA_ENDPOINT)
{ Task: USB_Mouse_Report , TaskStatus: TASK_STOP },
+ #endif
};
/* Global Variables */
@@ -118,14 +123,34 @@ EVENT_HANDLER(USB_Connect)
UsingReportProtocol = true;
}
+/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the
+ * enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled
+ * asynchronously when they arrive rather than when the control endpoint is polled manually.
+ */
+EVENT_HANDLER(USB_Reset)
+{
+ #if defined(INTERRUPT_CONTROL_ENDPOINT)
+ /* Select the control endpoint */
+ Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);
+
+ /* Enable the endpoint SETUP interrupt ISR for the control endpoint */
+ USB_INT_Enable(ENDPOINT_INT_SETUP);
+ #endif
+}
+
/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
* the status LEDs and stops the USB management and Mouse reporting tasks.
*/
EVENT_HANDLER(USB_Disconnect)
{
- /* Stop running mouse reporting and USB management tasks */
+ /* Stop running keyboard reporting and USB management tasks */
+ #if !defined(INTERRUPT_DATA_ENDPOINT)
Scheduler_SetTaskMode(USB_Mouse_Report, TASK_STOP);
+ #endif
+
+ #if !defined(INTERRUPT_CONTROL_ENDPOINT)
Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
+ #endif
/* Indicate USB not ready */
UpdateStatus(Status_USBNotReady);
@@ -141,11 +166,18 @@ EVENT_HANDLER(USB_ConfigurationChanged)
ENDPOINT_DIR_IN, MOUSE_EPSIZE,
ENDPOINT_BANK_SINGLE);
+ #if defined(INTERRUPT_DATA_ENDPOINT)
+ /* Enable the endpoint IN interrupt ISR for the report endpoint */
+ USB_INT_Enable(ENDPOINT_INT_IN);
+ #endif
+
/* Indicate USB connected and ready */
UpdateStatus(Status_USBReady);
+ #if !defined(INTERRUPT_DATA_ENDPOINT)
/* Start running mouse reporting task */
Scheduler_SetTaskMode(USB_Mouse_Report, TASK_RUN);
+ #endif
}
/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
@@ -163,7 +195,7 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
USB_MouseReport_Data_t MouseReportData;
/* Create the next mouse report for transmission to the host */
- GetNextReport(&MouseReportData);
+ CreateMouseReport(&MouseReportData);
/* Ignore report type and ID number value */
Endpoint_Discard_Word();
@@ -278,7 +310,7 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
*
* \return Boolean true if the new report differs from the last report, false otherwise
*/
-bool GetNextReport(USB_MouseReport_Data_t* ReportData)
+bool CreateMouseReport(USB_MouseReport_Data_t* ReportData)
{
static uint8_t PrevJoyStatus = 0;
static bool PrevHWBStatus = false;
@@ -315,6 +347,45 @@ bool GetNextReport(USB_MouseReport_Data_t* ReportData)
return InputChanged;
}
+/** Sends the next HID report to the host, via the keyboard data endpoint. */
+static inline void SendNextReport(void)
+{
+ USB_MouseReport_Data_t MouseReportData;
+ bool SendReport = true;
+
+ /* Create the next mouse report for transmission to the host */
+ CreateMouseReport(&MouseReportData);
+
+ /* Check if the idle period is set*/
+ if (IdleCount)
+ {
+ /* Determine if the idle period has elapsed */
+ if (!(IdleMSRemaining))
+ {
+ /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */
+ IdleMSRemaining = (IdleCount << 2);
+ }
+ else
+ {
+ /* Idle period not elapsed, indicate that a report must not be sent */
+ SendReport = false;
+ }
+ }
+
+ /* Select the Mouse Report Endpoint */
+ Endpoint_SelectEndpoint(MOUSE_EPNUM);
+
+ /* Check if Mouse Endpoint Ready for Read/Write and if we should send a new report */
+ if (Endpoint_ReadWriteAllowed() && SendReport)
+ {
+ /* Write Mouse Report Data */
+ Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
+
+ /* Finalize the stream transfer to send the last packet */
+ Endpoint_ClearCurrentBank();
+ }
+}
+
/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
* log to a serial port, or anything else that is suitable for status updates.
*
@@ -342,45 +413,57 @@ void UpdateStatus(uint8_t CurrentStatus)
LEDs_SetAllLEDs(LEDMask);
}
+#if !defined(INTERRUPT_DATA_ENDPOINT)
/** Task to manage HID report generation and transmission to the host, when in report mode. */
TASK(USB_Mouse_Report)
{
- USB_MouseReport_Data_t MouseReportData;
- bool SendReport = true;
-
- /* Create the next mouse report for transmission to the host */
- GetNextReport(&MouseReportData);
-
- /* Check if the idle period is set*/
- if (IdleCount)
+ /* Check if the USB system is connected to a host */
+ if (USB_IsConnected)
{
- /* Determine if the idle period has elapsed */
- if (!(IdleMSRemaining))
- {
- /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */
- IdleMSRemaining = (IdleCount << 2);
- }
- else
- {
- /* Idle period not elapsed, indicate that a report must not be sent */
- SendReport = false;
- }
+ /* Send the next mouse report to the host */
+ SendNextReport();
}
+}
+#endif
+
+/** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as
+ * a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send
+ * HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB
+ * controller. It is also used to respond to standard and class specific requests send to the device on the control
+ * endpoint, by handing them off to the LUFA library when they are received.
+ */
+ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
+{
+ #if defined(INTERRUPT_CONTROL_ENDPOINT)
+ /* Check if the control endpoint has received a request */
+ if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))
+ {
+ /* Clear the endpoint interrupt */
+ Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);
+
+ /* Process the control request */
+ USB_USBTask();
+
+ /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */
+ USB_INT_Clear(ENDPOINT_INT_SETUP);
+ }
+ #endif
- /* Check if the USB system is connected to a host */
- if (USB_IsConnected)
+ #if defined(INTERRUPT_DATA_ENDPOINT)
+ /* Check if mouse endpoint has interrupted */
+ if (Endpoint_HasEndpointInterrupted(MOUSE_EPNUM))
{
/* Select the Mouse Report Endpoint */
Endpoint_SelectEndpoint(MOUSE_EPNUM);
- /* Check if Mouse Endpoint Ready for Read/Write and if we should send a new report */
- if (Endpoint_ReadWriteAllowed() && SendReport)
- {
- /* Write Mouse Report Data */
- Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
-
- /* Finalize the stream transfer to send the last packet */
- Endpoint_ClearCurrentBank();
- }
+ /* Clear the endpoint IN interrupt flag */
+ USB_INT_Clear(ENDPOINT_INT_IN);
+
+ /* Clear the Mouse Report endpoint interrupt and select the endpoint */
+ Endpoint_ClearEndpointInterrupt(MOUSE_EPNUM);
+
+ /* Send the next mouse report to the host */
+ SendNextReport();
}
+ #endif
}
diff --git a/Demos/Mouse/Mouse.h b/Demos/Mouse/Mouse.h
index 50908129a..8723b7840 100644
--- a/Demos/Mouse/Mouse.h
+++ b/Demos/Mouse/Mouse.h
@@ -103,6 +103,9 @@
/** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */
HANDLES_EVENT(USB_Disconnect);
+ /** Indicates that this module will catch the USB_Reset event when thrown by the library. */
+ HANDLES_EVENT(USB_Reset);
+
/** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */
HANDLES_EVENT(USB_ConfigurationChanged);
@@ -110,7 +113,7 @@
HANDLES_EVENT(USB_UnhandledControlPacket);
/* Function Prototypes: */
- bool GetNextReport(USB_MouseReport_Data_t* ReportData);
+ bool CreateMouseReport(USB_MouseReport_Data_t* ReportData);
void UpdateStatus(uint8_t CurrentStatus);
#endif
diff --git a/Demos/Mouse/Mouse.txt b/Demos/Mouse/Mouse.txt
index 7b7360f0e..6764275ce 100644
--- a/Demos/Mouse/Mouse.txt
+++ b/Demos/Mouse/Mouse.txt
@@ -6,17 +6,9 @@
/** \mainpage Mouse Device Demo
*
- * Mouse demonstration application. This gives a simple reference
- * application for implementing a USB Mouse using the basic USB HID
- * drivers in all modern OSes (i.e. no special drivers required). It is
- * boot protocol compatible, and thus works under compatible BIOS as if
- * it was a native mouse (e.g. PS/2).
- *
- * On startup the system will automatically enumerate and function
- * as a mouse when the USB connection to a host is present. To use
- * the mouse, move the joystick to move the pointer, and push the
- * joystick inwards to simulate a left-button click. The HWB serves as
- * the right mouse button.
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -40,4 +32,44 @@
* <td>Low Speed Mode, Full Speed Mode</td>
* </tr>
* </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Mouse demonstration application. This gives a simple reference
+ * application for implementing a USB Mouse using the basic USB HID
+ * drivers in all modern OSes (i.e. no special drivers required). It is
+ * boot protocol compatible, and thus works under compatible BIOS as if
+ * it was a native mouse (e.g. PS/2).
+ *
+ * On startup the system will automatically enumerate and function
+ * as a mouse when the USB connection to a host is present. To use
+ * the mouse, move the joystick to move the pointer, and push the
+ * joystick inwards to simulate a left-button click. The HWB serves as
+ * the right mouse button.
+ *
+ * \section SSec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>INTERRUPT_CONTROL_ENDPOINT</td>
+ * <td>Makefile CDEFS</td>
+ * <td>When defined, this causes the demo to enable interrupts for the control endpoint,
+ * which services control requests from the host. If not defined, the control endpoint
+ * is serviced via polling using the task scheduler.</td>
+ * </tr>
+ * <tr>
+ * <td>INTERRUPT_DATA_ENDPOINT</td>
+ * <td>Makefile CDEFS</td>
+ * <td>When defined, this causes the demo to enable interrupts for the data endpoint,
+ * which services outgoing mouse button and movement reports to the host. If not defined,
+ * the data endpoint is serviced via polling using the task scheduler.</td>
+ * </tr>
+ * </table>
*/ \ No newline at end of file
diff --git a/Demos/Mouse/makefile b/Demos/Mouse/makefile
index a731e205e..27ca1d809 100644
--- a/Demos/Mouse/makefile
+++ b/Demos/Mouse/makefile
@@ -177,7 +177,6 @@ CDEFS = -DF_CPU=$(F_CPU)UL -DF_CLOCK=$(F_CLOCK)UL -DBOARD=BOARD_$(BOARD)
CDEFS += -DUSE_NONSTANDARD_DESCRIPTOR_NAMES -DNO_STREAM_CALLBACKS -DUSB_DEVICE_ONLY
CDEFS += -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"
-
# Place -D or -U options here for ASM sources
ADEFS = -DF_CPU=$(F_CPU)