From f7cde02b80c001875231c8ef21211214ebc742ed Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Thu, 27 Aug 2009 07:10:00 +0000
Subject: [PATCH] Added extra note about missing OUT endpoint configuration to
the HID Device mode Class driver.
Added pinout information to the AVRISP project.
---
LUFA/Drivers/USB/Class/Device/HID.h | 4 +++
Projects/AVRISP/AVRISP.txt | 38 ++++++++++++++++++++++++++++-
2 files changed, 41 insertions(+), 1 deletion(-)
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index e3f091bfb..ccd7426e1 100644
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -60,6 +60,10 @@
/** Class state structure. An instance of this structure should be made for each HID interface
* within the user application, and passed to each of the HID class driver functions as the
* HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.
+ *
+ * \note Due to technical limitations, the HID device class driver does not utilize a seperate OUT
+ * endpoint for host->device communications. Instead, the host->device data (if any) is sent to
+ * the device via the control endpoint.
*/
typedef struct
{
diff --git a/Projects/AVRISP/AVRISP.txt b/Projects/AVRISP/AVRISP.txt
index 8d299e25a..a9d550786 100644
--- a/Projects/AVRISP/AVRISP.txt
+++ b/Projects/AVRISP/AVRISP.txt
@@ -66,6 +66,42 @@
* set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
* without an ADC converter, VTARGET will report at a fixed 5V level.
*
+ * Connections to the device are simple:
+ *
+ * <table>
+ * <tr>
+ * <td><b>Programmer Pin:</b></td>
+ * <td><b>Target Device Pin:</b></td>
+ * </tr>
+ * <tr>
+ * <td>MOSI</td>
+ * <td>PDI</td>
+ * </tr>
+ * <tr>
+ * <td>MISO</td>
+ * <td>PDO</td>
+ * </tr>
+ * <tr>
+ * <td>SCLK</td>
+ * <td>SCLK</td>
+ * </tr>
+ * <tr>
+ * <td>GND</td>
+ * <td>GND</td>
+ * </tr>
+ * <tr>
+ * <td>ADCx <b><sup>1</sup></b></td>
+ * <td>VTARGET</td>
+ * </tr>
+ * <tr>
+ * <td>PORTx.y <b><sup>2</sup></b></td>
+ * <td>/RESET</td>
+ * </tr>
+ * </table>
+ *
+ * <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n
+ * <b><sup>2</sup></b> <i>See \ref SSec_Options section</i>
+ *
* \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.
@@ -89,7 +125,7 @@
* <tr>
* <td>RESET_LINE_MASK</td>
* <td>Makefile CDEFS</td>
- * <td>Mask for the programmer's target RESET line on the chosen port.</td>
+ * <td>Mask for the programmer's target RESET line on the chosen port. <b>Must not be the AVR's /SS pin.</b></td>
* </tr>
* <tr>
* <td>VTARGET_ADC_CHANNEL</td>
--
GitLab