Added extra note about missing OUT endpoint configuration to the HID Device mode...
authorDean Camera <dean@fourwalledcubicle.com>
Thu, 27 Aug 2009 07:10:00 +0000 (07:10 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Thu, 27 Aug 2009 07:10:00 +0000 (07:10 +0000)
Added pinout information to the AVRISP project.

LUFA/Drivers/USB/Class/Device/HID.h
Projects/AVRISP/AVRISP.txt

index e3f091b..ccd7426 100644 (file)
                        /** Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
                        /** Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
+                        *\r
+                        *  \note Due to technical limitations, the HID device class driver does not utilize a seperate OUT\r
+                        *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to\r
+                        *        the device via the control endpoint.\r
                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r
index 8d299e2..a9d5507 100644 (file)
  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models\r
  *  without an ADC converter, VTARGET will report at a fixed 5V level.\r
  *\r
  *  set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models\r
  *  without an ADC converter, VTARGET will report at a fixed 5V level.\r
  *\r
+ *  Connections to the device are simple:\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Programmer Pin:</b></td>\r
+ *    <td><b>Target Device Pin:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MOSI</td>\r
+ *    <td>PDI</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>MISO</td>\r
+ *    <td>PDO</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>SCLK</td>\r
+ *    <td>SCLK</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>GND</td>\r
+ *    <td>GND</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>ADCx <b><sup>1</sup></b></td>\r
+ *    <td>VTARGET</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>PORTx.y <b><sup>2</sup></b></td>\r
+ *    <td>/RESET</td>\r
+ *   </tr>\r
+ *  </table>\r
+ *\r
+ *  <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n\r
+ *  <b><sup>2</sup></b> <i>See \ref SSec_Options section</i>\r
+ *\r
  *  \section SSec_Options Project Options\r
  *\r
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
  *  \section SSec_Options Project Options\r
  *\r
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
  *   <tr>\r
  *    <td>RESET_LINE_MASK</td>\r
  *    <td>Makefile CDEFS</td>\r
  *   <tr>\r
  *    <td>RESET_LINE_MASK</td>\r
  *    <td>Makefile CDEFS</td>\r
- *    <td>Mask for the programmer's target RESET line on the chosen port.</td>\r
+ *    <td>Mask for the programmer's target RESET line on the chosen port. <b>Must not be the AVR's /SS pin.</b></td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>VTARGET_ADC_CHANNEL</td>\r
  *   </tr>\r
  *   <tr>\r
  *    <td>VTARGET_ADC_CHANNEL</td>\r