Add initial Riso Kagaku Webmail Notifier ATTiny clone
authorJonathan McDowell <noodles@earth.li>
Sat, 3 Dec 2016 10:53:36 +0000 (10:53 +0000)
committerJonathan McDowell <noodles@earth.li>
Sat, 3 Dec 2016 10:53:36 +0000 (10:53 +0000)
Lightly tested under Linux using an ATTiny45.

Makefile [new file with mode: 0644]
README.md [new file with mode: 0644]
main.c [new file with mode: 0644]
usbconfig.h [new file with mode: 0644]

diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..be268f6
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,26 @@
+DEVICE = attiny45
+F_CPU = 16500000
+
+CFLAGS = -Iusbdrv -I.
+AVRCC = avr-gcc -Wall -Os -DF_CPU=$(F_CPU) $(CFLAGS) -mmcu=$(DEVICE)
+
+OBJECTS = usbdrv/usbdrv.o usbdrv/usbdrvasm.o usbdrv/oddebug.o \
+       libs-device/osccal.o main.o
+
+.c.o:
+       $(AVRCC) -c $< -o $@
+
+.S.o:
+       $(AVRCC) -x assembler-with-cpp -c $< -o $@
+
+all: main.hex
+
+main.elf: $(OBJECTS) usbconfig.h
+       $(AVRCC) -o main.elf $(OBJECTS)
+
+main.hex: main.elf
+       avr-objcopy -j .text -j .data -O ihex main.elf main.hex
+       avr-size main.hex
+
+clean:
+       rm -f $(OBJECTS) main.elf main.hex
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..479d522
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+I wrote this for my friend [Jon](https://jmtd.net/), who was after a simple notification device for his NAS but had difficulty finding anything appropriately cheap. Some discussion on IRC led to discovering the Linux kernel has support for a variety of USB HID LED devices. In particular the Riso Kagaku Webmail Notifier presents a simple 8 colour RGB device (red/green/blue can each be on or off). This seemed like the sort of thing that could easily be implemented on an Atmel ATtiny, so going from various pieces of information gleaned from Google and the Linux driver I came up with this code. It's only been tested under Linux; I'd be curious to know if it works with the Windows drivers too.
+
+It's based on [V-USB](https://www.obdev.at/products/vusb/). I've reused the Riso Kagaku USB IDs so the Linux driver picks it up without needing any patching (assuming CONFIG_HID_LED is set, or CONFIG_USB_LED for older kernels). This is probably wrong of me.
+
+`apt install avr-libc avrdude` should install the appropriate build requirements on Debian (`gcc-avr` will be automatically pulled in) assuming you already have `build-essential` installed for `make`.
+
+`make` will then build you a main.hex which you can program to your device using
+`avrdude`. With my [Bus Pirate](http://dangerousprototypes.com/docs/Bus_Pirate) I use:
+
+    avrdude -p attiny45 -c buspirate -P /dev/ttyUSB0 -U flash:w:main.hex:i
+
+The code assumes USB D- is connected to Port B pin 1, USB D+ to Port B pin 2 (INT0), red is on Port B pin 3, blue on Port B pin 4 and green on Port B pin 5. The USB definitions can be configured in usbconfig.h, the LED pins are defined at the top of main.c.
+
+Given that V-USB is GPLv2+ or commercial all of my code is released as GPLv3+, available at [https://the.earth.li/gitweb/?p=riso-kaguku-clone.git;a=summary](https://the.earth.li/gitweb/?p=riso-kaguku-clone.git;a=summary) or on GitHub for easy whatever at [https://github.com/u1f35c/riso-kaguku-clone](https://github.com/u1f35c/riso-kaguku-clone)
diff --git a/main.c b/main.c
new file mode 100644 (file)
index 0000000..2308d55
--- /dev/null
+++ b/main.c
@@ -0,0 +1,279 @@
+/*
+ * Basic firmware for an RGB LED notifier clone of the Riso Kaguku
+ * Webmail Notifier.
+ *
+ * Copyright 2016 Jonathan McDowell <noodles@earth.li>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <avr/eeprom.h>
+#include <avr/interrupt.h>
+#include <avr/io.h>
+#include <avr/wdt.h>
+#include <util/delay.h>
+
+#include <avr/pgmspace.h>
+#include "usbdrv.h"
+#include "libs-device/osccal.h"
+
+#define RED_BIT    8 /* Bit 3 on port B */
+#define GREEN_BIT 16 /* Bit 4 on port B */
+#define BLUE_BIT  32 /* Bit 5 on port B */
+#define ALL_BITS (RED_BIT | GREEN_BIT | BLUE_BIT)
+#define CMD_SET_SERIAL 0xfa
+
+uchar serno_read = 0;
+int serno_str[] = {
+       USB_STRING_DESCRIPTOR_HEADER(8),
+       'U', 'N', 'S', 'E', 'T', 'X', 'X', 'X',
+};
+
+PROGMEM const char usbDescriptorConfiguration[CONFIG_DESCRIPTOR_SIZE] = {    /* USB configuration descriptor */
+       9,          /* sizeof(usbDescriptorConfiguration): length of descriptor in bytes */
+       USBDESCR_CONFIG,    /* descriptor type */
+       18 + 7 + 7 + 9, 0,
+       /* total length of data returned (including inlined descriptors) */
+       1,          /* number of interfaces in this configuration */
+       1,          /* index of this configuration */
+       0,          /* configuration name string index */
+       (1 << 7) | USBATTR_REMOTEWAKE,      /* attributes */
+       USB_CFG_MAX_BUS_POWER/2,            /* max USB current in 2mA units */
+       /* interface descriptor follows inline: */
+       9,          /* sizeof(usbDescrInterface): length of descriptor in bytes */
+       USBDESCR_INTERFACE, /* descriptor type */
+       0,          /* index of this interface */
+       0,          /* alternate setting for this interface */
+       2,          /* endpoints excl 0: number of endpoint descriptors to follow */
+       USB_CFG_INTERFACE_CLASS,
+       USB_CFG_INTERFACE_SUBCLASS,
+       USB_CFG_INTERFACE_PROTOCOL,
+       0,          /* string index for interface */
+       9,          /* sizeof(usbDescrHID): length of descriptor in bytes */
+       USBDESCR_HID,   /* descriptor type: HID */
+       0x01, 0x01, /* BCD representation of HID version */
+       0x00,       /* target country code */
+       0x01,       /* number of HID Report (or other HID class) Descriptor infos to follow */
+       0x22,       /* descriptor type: report */
+       USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH, 0,  /* total length of report descriptor */
+       /* endpoint descriptor for endpoint 1 */
+       7,          /* sizeof(usbDescrEndpoint) */
+       USBDESCR_ENDPOINT,  /* descriptor type = endpoint */
+       (char)0x81, /* IN endpoint number 1 */
+       0x03,       /* attrib: Interrupt endpoint */
+       8, 0,       /* maximum packet size */
+       USB_CFG_INTR_POLL_INTERVAL, /* in ms */
+       /* endpoint descriptor for endpoint 2 */
+       7,          /* sizeof(usbDescrEndpoint) */
+       USBDESCR_ENDPOINT,  /* descriptor type = endpoint */
+       2,                      /* OUT endpoint number 2 */
+       0x03,       /* attrib: Interrupt endpoint */
+       5, 0,       /* maximum packet size */
+       USB_CFG_INTR_POLL_INTERVAL, /* in ms */
+};
+
+PROGMEM const char usbHidReportDescriptor[22] = {
+       0x06, 0x00, 0xff,               /* USAGE PAGE (Generic Desktop) */
+       0x09, 0x01,                     /* USAGE (Vendor Usage 1) */
+       0xa1, 0x01,                     /* COLLECTION (Application) */
+       0x15, 0x00,                     /*   LOGICAL_MINIMUM (0) */
+       0x26, 0xff, 0x00,               /*   LOGICAL_MAXIMUM (255) */
+       0x75, 0x08,                     /*   REPORT_SIZE (8 bits) */
+       0x95, 0x06,                     /*   REPORT_COUNT (6 elements) */
+       0x09, 0x00,                     /*   USAGE (Undefined) */
+       0xb2, 0x02, 0x01,               /*   FEATURE (Data, Var, Abs, Buf) */
+       0xc0                            /* END_COLLECTION */
+};
+
+inline char hexdigit(int i)
+{
+       return (i < 10) ? ('0' + i) : ('A' - 10 + i);
+}
+
+void fetch_serno(void)
+{
+       uint32_t serno;
+
+       if (!serno_read) {
+               eeprom_read_block(&serno, 0, 4);
+               if (serno == 0xffffffff) {
+                       serno_str[1] = 'U';
+                       serno_str[2] = 'N';
+                       serno_str[3] = 'S';
+                       serno_str[4] = 'E';
+                       serno_str[5] = 'T';
+                       serno_str[6] = 'X';
+                       serno_str[7] = 'X';
+                       serno_str[8] = 'X';
+               } else {
+                       serno_str[1] = hexdigit((serno >> 28));
+                       serno_str[2] = hexdigit((serno >> 24) & 0xF);
+                       serno_str[3] = hexdigit((serno >> 20) & 0xF);
+                       serno_str[4] = hexdigit((serno >> 16) & 0xF);
+                       serno_str[5] = hexdigit((serno >> 12) & 0xF);
+                       serno_str[6] = hexdigit((serno >>  8) & 0xF);
+                       serno_str[7] = hexdigit((serno >>  4) & 0xF);
+                       serno_str[8] = hexdigit( serno        & 0xF);
+               }
+               serno_read = 1;
+       }
+}
+
+void update_serno(uint32_t serno)
+{
+       eeprom_write_block(&serno, 0x00, 4);
+
+       serno_str[1] = hexdigit((serno >> 28));
+       serno_str[2] = hexdigit((serno >> 24) & 0xF);
+       serno_str[3] = hexdigit((serno >> 20) & 0xF);
+       serno_str[4] = hexdigit((serno >> 16) & 0xF);
+       serno_str[5] = hexdigit((serno >> 12) & 0xF);
+       serno_str[6] = hexdigit((serno >>  8) & 0xF);
+       serno_str[7] = hexdigit((serno >>  4) & 0xF);
+       serno_str[8] = hexdigit( serno        & 0xF);
+}
+
+usbMsgLen_t usbFunctionSetup(uchar data[8])
+{
+       usbRequest_t *rq = (void *) data;
+
+       if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) {
+               if ((rq->bRequest == USBRQ_HID_GET_REPORT) ||
+                               (rq->bRequest == USBRQ_HID_SET_REPORT)) {
+                       return 0xFF;
+               }
+       }
+
+       return 0;
+}
+
+usbMsgLen_t usbFunctionDescriptor(usbRequest_t *rq)
+{
+       if (rq->wValue.bytes[1] == USBDESCR_STRING &&
+                       rq->wValue.bytes[0] == 3) {
+               usbMsgPtr = (usbMsgPtr_t) serno_str;
+               return sizeof(serno_str);
+       }
+
+       return 0;
+}
+
+uchar usbFunctionRead(uchar *data, uchar len)
+{
+       uint8_t colour_map[8] = { 0, 2, 1, 5, 3, 6, 4, 7 };
+       uint8_t status;
+
+       if (len != 0) {
+               status = 0;
+               if (PORTB & RED_BIT)
+                       status |= 1;
+               if (PORTB & GREEN_BIT)
+                       status |= 2;
+               if (PORTB & BLUE_BIT)
+                       status |= 4;
+               /* Map RGB back to Riso Kagaku colour code. */
+               data[0] = colour_map[status];
+               return len;
+       }
+
+       return 0;
+}
+
+uchar usbFunctionWrite(uchar *data, uchar len)
+{
+       /*
+        * The Riso Kagaku has an internal colour table, map it back to an
+        * RGB bitmap.
+        */
+       uint8_t colour_map[8] = { 0, 2, 1, 4, 6, 3, 5, 7 };
+       uint8_t rgb_val, port_val;
+
+       if (data[0] < 8) {
+               rgb_val = colour_map[data[0]];
+
+               port_val = PORTB & ~ALL_BITS;
+
+               if (rgb_val & 1)
+                       port_val |= RED_BIT;
+               if (rgb_val & 2)
+                       port_val |= GREEN_BIT;
+               if (rgb_val & 4)
+                       port_val |= BLUE_BIT;
+
+               PORTB = port_val;
+       } else if (data[0] == CMD_SET_SERIAL) {
+               update_serno(*(uint32_t *) &data[1]);
+       }
+
+       return len;
+}
+
+void usbFunctionWriteOut(uchar *data, uchar len)
+{
+       /*
+        * The Riso Kagaku has an internal colour table, map it back to an
+        * RGB bitmap.
+        */
+       uint8_t colour_map[8] = { 0, 2, 1, 4, 6, 3, 5, 7 };
+       uint8_t rgb_val, port_val;
+
+       if (!len)
+               return;
+
+       if (data[0] < 8) {
+               rgb_val = colour_map[data[0]];
+
+               port_val = PORTB & ~ALL_BITS;
+
+               if (rgb_val & 1)
+                       port_val |= RED_BIT;
+               if (rgb_val & 2)
+                       port_val |= GREEN_BIT;
+               if (rgb_val & 4)
+                       port_val |= BLUE_BIT;
+
+               PORTB = port_val;
+       } else if (len == 5 && data[0] == CMD_SET_SERIAL) {
+               update_serno(*(uint32_t *) &data[1]);
+       }
+}
+
+int __attribute__((noreturn)) main(void)
+{
+       unsigned char i;
+
+       wdt_enable(WDTO_1S);
+
+       usbInit();
+       usbDeviceDisconnect();
+
+       i = 0;
+       while (--i) {
+               wdt_reset();
+               _delay_ms(1);
+       }
+
+       usbDeviceConnect();
+
+       /* Set the LED bits to output mode */
+       DDRB |= ALL_BITS;
+       /* Turn them off */
+       PORTB &= ~ALL_BITS;
+
+       sei(); /* We're ready to go; enable interrupts */
+
+       while (1) {
+               wdt_reset();
+               usbPoll();
+       }
+}
diff --git a/usbconfig.h b/usbconfig.h
new file mode 100644 (file)
index 0000000..56a980e
--- /dev/null
@@ -0,0 +1,390 @@
+/* Name: usbconfig.h
+ * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
+ * Author: Christian Starkjohann
+ * Creation Date: 2005-04-01
+ * Tabsize: 4
+ * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH
+ * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
+ */
+
+#ifndef __usbconfig_h_included__
+#define __usbconfig_h_included__
+
+/*
+General Description:
+This file is an example configuration (with inline documentation) for the USB
+driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is
+also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may
+wire the lines to any other port, as long as D+ is also wired to INT0 (or any
+other hardware interrupt, as long as it is the highest level interrupt, see
+section at the end of this file).
++ To create your own usbconfig.h file, copy this file to your project's
++ firmware source directory) and rename it to "usbconfig.h".
++ Then edit it accordingly.
+*/
+
+/* ---------------------------- Hardware Config ---------------------------- */
+
+#define USB_CFG_IOPORTNAME      B
+/* This is the port where the USB bus is connected. When you configure it to
+ * "B", the registers PORTB, PINB and DDRB will be used.
+ */
+#define USB_CFG_DMINUS_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.
+ */
+#define USB_CFG_DPLUS_BIT       2
+/* 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! [You can also use other interrupts, see section
+ * "Optional MCU Description" below, or you can connect D- to the interrupt, as
+ * it is required if you use the USB_COUNT_SOF feature. If you use D- for the
+ * interrupt, the USB interrupt will also be triggered at Start-Of-Frame
+ * markers every millisecond.]
+ */
+#define USB_CFG_CLOCK_KHZ       (F_CPU/1000)
+/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000,
+ * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code
+ * require no crystal, they tolerate +/- 1% deviation from the nominal
+ * frequency. All other rates require a precision of 2000 ppm and thus a
+ * crystal!
+ * Since F_CPU should be defined to your actual clock rate anyway, you should
+ * not need to modify this setting.
+ */
+#define USB_CFG_CHECK_CRC       0
+/* Define this to 1 if you want that the driver checks integrity of incoming
+ * data packets (CRC checks). CRC checks cost quite a bit of code size and are
+ * currently only available for 18 MHz crystal clock. You must choose
+ * USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
+ */
+
+/* ----------------------- Optional Hardware Config ------------------------ */
+
+/* #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          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 ---------------------------- */
+
+#define USB_CFG_HAVE_INTRIN_ENDPOINT    1
+/* Define this to 1 if you want to compile a version with two endpoints: The
+ * default control endpoint 0 and an interrupt-in endpoint (any other endpoint
+ * number).
+ */
+#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 3 (or the number
+ * configured below) and a catch-all default interrupt-in endpoint as above.
+ * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
+ */
+#define USB_CFG_EP3_NUMBER              3
+/* If the so-called endpoint 3 is used, it can now be configured to any other
+ * endpoint number (except 0) with this macro. Default if undefined is 3.
+ */
+/* #define USB_INITIAL_DATATOKEN           USBPID_DATA1 */
+/* The above macro defines the startup condition for data toggling on the
+ * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
+ * Since the token is toggled BEFORE sending any data, the first packet is
+ * sent with the oposite value of this configuration!
+ */
+#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,
+ * it is required by the standard. We have made it a config option because it
+ * bloats the code considerably.
+ */
+#define USB_CFG_SUPPRESS_INTR_CODE      0
+/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
+ * want to send any data over them. If this macro is defined to 1, functions
+ * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
+ * you need the interrupt-in endpoints in order to comply to an interface
+ * (e.g. HID), but never want to send any data. This option saves a couple
+ * of bytes in flash memory and the transmit buffers in RAM.
+ */
+#define USB_CFG_INTR_POLL_INTERVAL      20
+/* If you compile a version with endpoint 1 (interrupt-in), this is the poll
+ * interval. The value is in milliseconds and must not be less than 10 ms for
+ * low speed devices.
+ */
+#define USB_CFG_IS_SELF_POWERED         0
+/* Define this to 1 if the device has its own power supply. Set it to 0 if the
+ * device is powered from the USB bus.
+ */
+#define USB_CFG_MAX_BUS_POWER           100
+/* Set this variable to the maximum USB bus power consumption of your device.
+ * The value is in milliamperes. [It will be divided by two since USB
+ * communicates power requirements in units of 2 mA.]
+ */
+#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
+ * bytes.
+ */
+#define USB_CFG_IMPLEMENT_FN_READ       1
+/* Set this to 1 if you need to send control replies which are generated
+ * "on the fly" when usbFunctionRead() is called. If you only want to send
+ * 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   1
+/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
+ * You must implement the function usbFunctionWriteOut() which receives all
+ * interrupt/bulk data sent to any endpoint other than 0. The endpoint number
+ * can be found in 'usbRxToken'.
+ */
+#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.
+ */
+#define USB_CFG_DRIVER_FLASH_PAGE       0
+/* If the device has more than 64 kBytes of flash, define this to the 64 k page
+ * where the driver's constants (descriptors) are located. Or in other words:
+ * Define this to 1 for boot loaders on the ATMega128.
+ */
+#define USB_CFG_LONG_TRANSFERS          0
+/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
+ * in a single control-in or control-out transfer. Note that the capability
+ * for long transfers increases the driver size.
+ */
+/* #define USB_RX_USER_HOOK(data, len)     if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
+/* This macro is a hook if you want to do unconventional things. If it is
+ * defined, it's inserted at the beginning of received message processing.
+ * If you eat the received message and don't want default processing to
+ * proceed, do a return after doing your things. One possible application
+ * (besides debugging) is to flash a status LED on each packet.
+ */
+#ifndef __ASSEMBLER__
+#include <avr/interrupt.h>  // for sei()
+extern void calibrateOscillator(void);
+#endif
+#define USB_RESET_HOOK(resetStarts)  if(!resetStarts){cli(); calibrateOscillator(); sei();}
+/* This macro is a hook if you need to know when an USB RESET occurs. It has
+ * one parameter which distinguishes between the start of RESET state and its
+ * end.
+ */
+/* #define USB_SET_ADDRESS_HOOK()              hadAddressAssigned(); */
+/* This macro (if defined) is executed when a USB SET_ADDRESS request was
+ * received.
+ */
+#define USB_COUNT_SOF                   0
+/* define this macro to 1 if you need the global variable "usbSofCount" which
+ * counts SOF packets. This feature requires that the hardware interrupt is
+ * connected to D- instead of D+.
+ */
+/* #ifdef __ASSEMBLER__
+ * macro myAssemblerMacro
+ *     in      YL, TCNT0
+ *     sts     timer0Snapshot, YL
+ *     endm
+ * #endif
+ * #define USB_SOF_HOOK                    myAssemblerMacro
+ * This macro (if defined) is executed in the assembler module when a
+ * Start Of Frame condition is detected. It is recommended to define it to
+ * the name of an assembler macro which is defined here as well so that more
+ * than one assembler instruction can be used. The macro may use the register
+ * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
+ * immediately after an SOF pulse may be lost and must be retried by the host.
+ * What can you do with this hook? Since the SOF signal occurs exactly every
+ * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
+ * designs running on the internal RC oscillator.
+ * Please note that Start Of Frame detection works only if D- is wired to the
+ * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
+ */
+#define USB_CFG_CHECK_DATA_TOGGLING     0
+/* define this macro to 1 if you want to filter out duplicate data packets
+ * sent by the host. Duplicates occur only as a consequence of communication
+ * errors, when the host does not receive an ACK. Please note that you need to
+ * implement the filtering yourself in usbFunctionWriteOut() and
+ * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
+ * for each control- and out-endpoint to check for duplicate packets.
+ */
+#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH   1
+/* define this macro to 1 if you want the function usbMeasureFrameLength()
+ * compiled in. This function can be used to calibrate the AVR's RC oscillator.
+ */
+#define USB_USE_FAST_CRC                0
+/* The assembler module has two implementations for the CRC algorithm. One is
+ * faster, the other is smaller. This CRC routine is only used for transmitted
+ * messages where timing is not critical. The faster routine needs 31 cycles
+ * per byte while the smaller one needs 61 to 69 cycles. The faster routine
+ * may be worth the 32 bytes bigger code size if you transmit lots of data and
+ * run the AVR close to its limit.
+ */
+
+/* -------------------------- Device Description --------------------------- */
+
+#define  USB_CFG_VENDOR_ID       0x94, 0x12 /* = 0x1294 = Riso Kagaku */
+/* USB vendor ID for the device, low byte first. If you have registered your
+ * own Vendor ID, define it here. Otherwise you may use one of obdev's free
+ * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
+ * *** IMPORTANT NOTE ***
+ * This template uses obdev's shared VID/PID pair for Vendor Class devices
+ * with libusb: 0x16c0/0x5dc.  Use this VID/PID pair ONLY if you understand
+ * the implications!
+ */
+#define  USB_CFG_DEVICE_ID       0x20, 0x13 /* = 0x1320 */
+/* This is the ID of the product, low byte first. It is interpreted in the
+ * scope of the vendor ID. If you have registered your own VID with usb.org
+ * or if you have licensed a PID from somebody else, define it here. Otherwise
+ * you may use one of obdev's free shared VID/PID pairs. See the file
+ * USB-IDs-for-free.txt for details!
+ * *** IMPORTANT NOTE ***
+ * This template uses obdev's shared VID/PID pair for Vendor Class devices
+ * with libusb: 0x16c0/0x5dc.  Use this VID/PID pair ONLY if you understand
+ * the implications!
+ */
+#define USB_CFG_DEVICE_VERSION  0x00, 0x01
+/* Version number of the device: Minor number first, then major number.
+ */
+#define USB_CFG_VENDOR_NAME     'M', 'A', 'I', 'L', ' '
+#define USB_CFG_VENDOR_NAME_LEN 5
+/* These two values define the vendor name returned by the USB device. The name
+ * must be given as a list of characters under single quotes. The characters
+ * are interpreted as Unicode (UTF-16) entities.
+ * If you don't want a vendor name string, undefine these macros.
+ * ALWAYS define a vendor name containing your Internet domain name if you use
+ * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
+ * details.
+ */
+#define USB_CFG_DEVICE_NAME     'M', 'A', 'I', 'L', ' '
+#define USB_CFG_DEVICE_NAME_LEN 5
+/* Same as above for the device name. If you don't want a device name, undefine
+ * the macros. See the file USB-IDs-for-free.txt before you assign a name if
+ * you use a shared VID/PID.
+ */
+/*#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        0
+#define USB_CFG_DEVICE_SUBCLASS     0
+/* See USB specification if you want to conform to an existing device class.
+ * Class 0xff is "vendor specific".
+ */
+#define USB_CFG_INTERFACE_CLASS     3 /* HID */
+#define USB_CFG_INTERFACE_SUBCLASS  0
+#define USB_CFG_INTERFACE_PROTOCOL  0
+/* See USB specification if you want to conform to an existing device class or
+ * protocol. The following classes must be set at interface level:
+ * HID class is 3, no subclass and protocol required (but may be useful!)
+ * CDC class is 2, use subclass 2 and protocol 1 for ACM
+ */
+#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH    22
+/* Define this to the length of the HID report descriptor, if you implement
+ * an HID device. Otherwise don't define it or define it to 0.
+ * If you use this define, you must add a PROGMEM character array named
+ * "usbHidReportDescriptor" to your code which contains the report descriptor.
+ * Don't forget to keep the array and this define in sync!
+ */
+
+/* #define USB_PUBLIC static */
+/* Use the define above if you #include usbdrv.c instead of linking against it.
+ * This technique saves a couple of bytes in flash memory.
+ */
+
+/* ------------------- 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(). If the usbMsgPtr mechanism is
+ *     used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
+ *     you want RAM pointers.
+ *   + 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)
+ *
+ * Note about string descriptors: String descriptors are not just strings, they
+ * are Unicode strings prefixed with a 2 byte header. Example:
+ * int  serialNumberDescriptor[] = {
+ *     USB_STRING_DESCRIPTOR_HEADER(6),
+ *     'S', 'e', 'r', 'i', 'a', 'l'
+ * };
+ */
+
+#define CONFIG_DESCRIPTOR_SIZE 41
+
+#define USB_CFG_DESCR_PROPS_DEVICE                  0
+#define USB_CFG_DESCR_PROPS_CONFIGURATION   USB_PROP_LENGTH(CONFIG_DESCRIPTOR_SIZE)
+#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    (USB_PROP_IS_DYNAMIC | USB_PROP_IS_RAM)
+#define USB_CFG_DESCR_PROPS_HID                     0
+#define USB_CFG_DESCR_PROPS_HID_REPORT              0
+#define USB_CFG_DESCR_PROPS_UNKNOWN                 0
+
+
+//#define usbMsgPtr_t unsigned short
+/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We may define it to
+ * a scalar type here because gcc generates slightly shorter code for scalar
+ * arithmetics than for pointer arithmetics. Remove this define for backward
+ * type compatibility or define it to an 8 bit type if you use data in RAM only
+ * and all RAM is below 256 bytes (tiny memory model in IAR CC).
+ */
+
+/* ----------------------- 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 */
+/* #define USB_INTR_VECTOR         INT0_vect */
+
+#endif /* __usbconfig_h_included__ */