X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/5b20be02e28bb67097fc6701f7596a352b39f902..HEAD:/firmware/usbconfig.h diff --git a/firmware/usbconfig.h b/firmware/usbconfig.h index 8a1ebd087..090349011 100644 --- a/firmware/usbconfig.h +++ b/firmware/usbconfig.h @@ -1,11 +1,10 @@ /* Name: usbconfig.h * Project: AVR USB driver - * Author: Christian Starkjohann + * Author: Christian Starkjohann, Thomas Fischl * Creation Date: 2005-04-01 * Tabsize: 4 * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH - * License: Proprietary, free under certain conditions. See Documentation. - * This Revision: $Id: usbconfig.h 43 2005-04-10 21:04:36Z cs $ + * License: GNU GPL v2 (see License.txt) or proprietary (CommercialLicense.txt) */ #ifndef __usbconfig_h_included__ @@ -22,32 +21,43 @@ the newest features and options. */ /* ---------------------------- Hardware Config ---------------------------- */ - #define USB_CFG_IOPORTNAME B /* This is the port where the USB bus is connected. When you configure it to - * "PORTB", the registers PORTB, PINB (=PORTB-2) and DDRB (=PORTB-1) will be - * used. + * "B", the registers PORTB, PINB and DDRB will be used. */ #define USB_CFG_DMINUS_BIT 0 /* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. - * This MUST be bit 0 or 7. All other values will result in a compile error! + * This may be any bit in the port. */ #define USB_CFG_DPLUS_BIT 1 /* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. * This may be any bit in the port. Please note that D+ must also be connected * to interrupt pin INT0! */ +#ifdef F_CPU +#define USB_CFG_CLOCK_KHZ (F_CPU/1000) +#else +#define USB_CFG_CLOCK_KHZ 12000 +#endif +/* Clock rate of the AVR in MHz. Legal values are 12000, 16000 or 16500. + * The 16.5 MHz version of the code requires no crystal, it tolerates +/- 1% + * deviation from the nominal frequency. All other rates require a precision + * of 2000 ppm and thus a crystal! + * Default if not specified: 12 MHz + */ + +/* ----------------------- Optional Hardware Config ------------------------ */ -/* #define USB_CFG_PULLUP_IOPORTNAME B */ -/* This is the port where the USB D- pullup resistor is connected. When you - * configure it to "PORTB", the registers PORTB and DDRB (=PORTB-1) will be - * used. If this constant is defined, the macros usbDeviceConnect() and - * usbDeviceDisconnect will be available. +/* #define USB_CFG_PULLUP_IOPORTNAME D */ +/* If you connect the 1.5k pullup resistor from D- to a port pin instead of + * V+, you can connect and disconnect the device from firmware by calling + * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h). + * This constant defines the port on which the pullup resistor is connected. */ -/* #define USB_CFG_PULLUP_BIT 2 */ -/* This is the bit number in USB_CFG_PULLUP_IOPORT where the USB D- 1.5 kOhm - * pullup resistor is connected instead of VBUS. This may be any bit in - * the port. +/* #define USB_CFG_PULLUP_BIT 4 */ +/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined + * above) where the 1.5k pullup resistor is connected. See description + * above for details. */ /* --------------------------- Functional Range ---------------------------- */ @@ -56,6 +66,11 @@ the newest features and options. /* Define this to 1 if you want to compile a version with two endpoints: The * default control endpoint 0 and an interrupt-in endpoint 1. */ +#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0 +/* Define this to 1 if you want to compile a version with three endpoints: The + * default control endpoint 0, an interrupt-in endpoint 1 and an interrupt-in + * endpoint 3. You must also enable endpoint 1 above. + */ #define USB_CFG_IMPLEMENT_HALT 0 /* Define this to 1 if you also want to implement the ENDPOINT_HALT feature * for endpoint 1 (interrupt endpoint). Although you may not need this feature, @@ -76,15 +91,6 @@ the newest features and options. * The value is in milliamperes. [It will be divided by two since USB * communicates power requirements in units of 2 mA.] */ -#define USB_CFG_SAMPLE_EXACT 1 -/* This variable affects Sampling Jitter for USB receiving. When it is 0, the - * driver guarantees a sampling window of 1/2 bit. The USB spec requires - * that the receiver has at most 1/4 bit sampling window. The 1/2 bit window - * should still work reliably enough because we work at low speed. If you want - * to meet the spec, set this value to 1. This will unroll a loop which - * results in bigger code size. - * If you have problems with long cables, try setting this value to 1. - */ #define USB_CFG_IMPLEMENT_FN_WRITE 1 /* Set this to 1 if you want usbFunctionWrite() to be called for control-out * transfers. Set it to 0 if you don't need it and want to save a couple of @@ -96,6 +102,16 @@ the newest features and options. * data from a static buffer, set it to 0 and return the data from * usbFunctionSetup(). This saves a couple of bytes. */ +#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 +/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoint 1. + * You must implement the function usbFunctionWriteOut() which receives all + * interrupt/bulk data sent to endpoint 1. + */ +#define USB_CFG_HAVE_FLOWCONTROL 0 +/* Define this to 1 if you want flowcontrol over USB data. See the definition + * of the macros usbDisableAllRequests() and usbEnableAllRequests() in + * usbdrv.h. + */ /* -------------------------- Device Description --------------------------- */ @@ -111,7 +127,7 @@ the newest features and options. * you use obdev's free shared VID/PID pair. Be sure to read the rules in * USBID-License.txt! */ -#define USB_CFG_DEVICE_VERSION 0x01, 0x01 +#define USB_CFG_DEVICE_VERSION 0x04, 0x01 /* Version number of the device: Minor number first, then major number. */ #define USB_CFG_VENDOR_NAME 'w', 'w', 'w', '.', 'f', 'i', 's', 'c', 'h', 'l', '.', 'd', 'e' @@ -129,21 +145,14 @@ the newest features and options. /* Same as above for the device name. If you don't want a device name, undefine * the macros. See the file USBID-License.txt before you assign a name. */ -#define USB_CFG_SERIAL_NUMBER_LENGTH 0 -/* Set this define to the number of charcters in the serial number if your - * device should have a serial number to uniquely identify each hardware - * instance. You must supply the serial number in a string descriptor with the - * name "usbCfgSerialNumberStringDescriptor", e.g.: - * #define USB_CFG_SERIAL_NUMBER_LENGTH 5 - * int usbCfgSerialNumberStringDescriptor[] PROGMEM = { - * USB_STRING_DESCRIPTOR_HEADER(USB_CFG_SERIAL_NUMBER_LENGTH), - * '1', '2', '3', '4', '5' - * }; - * See usbdrv.h for more information about the USB_STRING_DESCRIPTOR_HEADER() - * macro or usbdrv.c for example string descriptors. - * You may want to put "usbCfgSerialNumberStringDescriptor" at a constant - * flash memory address (with magic linker commands) so that you don't need - * to recompile if you change it. +/*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */ +/*#define USB_CFG_SERIAL_NUMBER_LEN 0 */ +/* Same as above for the serial number. If you don't want a serial number, + * undefine the macros. + * It may be useful to provide the serial number through other means than at + * compile time. See the section about descriptor properties below for how + * to fine tune control over USB descriptors such as the string descriptor + * for the serial number. */ #define USB_CFG_DEVICE_CLASS 0xff #define USB_CFG_DEVICE_SUBCLASS 0 @@ -160,4 +169,75 @@ the newest features and options. * an HID device. Otherwise don't define it or define it to 0. */ +/* ------------------- Fine Control over USB Descriptors ------------------- */ +/* If you don't want to use the driver's default USB descriptors, you can + * provide our own. These can be provided as (1) fixed length static data in + * flash memory, (2) fixed length static data in RAM or (3) dynamically at + * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more + * information about this function. + * Descriptor handling is configured through the descriptor's properties. If + * no properties are defined or if they are 0, the default descriptor is used. + * Possible properties are: + * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched + * at runtime via usbFunctionDescriptor(). + * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found + * in static memory is in RAM, not in flash memory. + * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), + * the driver must know the descriptor's length. The descriptor itself is + * found at the address of a well known identifier (see below). + * List of static descriptor names (must be declared PROGMEM if in flash): + * char usbDescriptorDevice[]; + * char usbDescriptorConfiguration[]; + * char usbDescriptorHidReport[]; + * char usbDescriptorString0[]; + * int usbDescriptorStringVendor[]; + * int usbDescriptorStringDevice[]; + * int usbDescriptorStringSerialNumber[]; + * Other descriptors can't be provided statically, they must be provided + * dynamically at runtime. + * + * Descriptor properties are or-ed or added together, e.g.: + * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18)) + * + * The following descriptors are defined: + * USB_CFG_DESCR_PROPS_DEVICE + * USB_CFG_DESCR_PROPS_CONFIGURATION + * USB_CFG_DESCR_PROPS_STRINGS + * USB_CFG_DESCR_PROPS_STRING_0 + * USB_CFG_DESCR_PROPS_STRING_VENDOR + * USB_CFG_DESCR_PROPS_STRING_PRODUCT + * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER + * USB_CFG_DESCR_PROPS_HID + * USB_CFG_DESCR_PROPS_HID_REPORT + * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) + * + */ + +#define USB_CFG_DESCR_PROPS_DEVICE 0 +#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 +#define USB_CFG_DESCR_PROPS_STRINGS 0 +#define USB_CFG_DESCR_PROPS_STRING_0 0 +#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0 +#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 +#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 +#define USB_CFG_DESCR_PROPS_HID 0 +#define USB_CFG_DESCR_PROPS_HID_REPORT 0 +#define USB_CFG_DESCR_PROPS_UNKNOWN 0 + +/* ----------------------- Optional MCU Description ------------------------ */ + +/* The following configurations have working defaults in usbdrv.h. You + * usually don't need to set them explicitly. Only if you want to run + * the driver on a device which is not yet supported or with a compiler + * which is not fully supported (such as IAR C) or if you use a differnt + * interrupt than INT0, you may have to define some of these. + */ +/* #define USB_INTR_CFG MCUCR */ +/* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */ +/* #define USB_INTR_CFG_CLR 0 */ +/* #define USB_INTR_ENABLE GIMSK */ +/* #define USB_INTR_ENABLE_BIT INT0 */ +/* #define USB_INTR_PENDING GIFR */ +/* #define USB_INTR_PENDING_BIT INTF0 */ + #endif /* __usbconfig_h_included__ */