Skip to content

Commit e58a318

Browse files
Fede85Fede85
committed
add Arduino Gemma Bootloader source files
1 parent 17b840d commit e58a318

File tree

3 files changed

+389
-0
lines changed

3 files changed

+389
-0
lines changed

‎bootloaders/gemma/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Arduino Gemma Bootloader
2+
========================
3+
4+
The Arduino Gemma Bootloader is based on the Adafruit Trinket/Gemma Bootloader. In the Arduino Gemma bootloader the USB VID&PID, the Manufacturer name and the Device name parameters are changed.
5+
6+
The source code of the bootloader of the version used at the compile time can be found at the following link: https://github.com/adafruit/Adafruit-Trinket-Gemma-Bootloader/tree/3bc1bb561273535d4d493518a233a3a1fccf6b76
7+
8+
The *'usbconfig.h'* and the *'usbconfig.patch'* files are provided if you want to recompile the bootloader.
9+
You only need to replace the original *'usbconfig.h'* file with this one or patch it with the provided patch file.
10+
11+
**Please note: you cannot use the Arduino USB VID/PID for your own non-Gemma products or projects. Purchase a USB VID for yourself at** http://www.usb.org/developers/vendor/
12+
13+
14+

‎bootloaders/gemma/usbconfig.h

+351
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,351 @@
1+
/* Name: usbconfig.h
2+
* Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
3+
* Author: Christian Starkjohann
4+
* Creation Date: 2005-04-01
5+
* Tabsize: 4
6+
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH
7+
* License: GNU GPL v2 or v3 (see License.txt)
8+
*/
9+
10+
/* Modified by me@frank-zhao.com for project GemmaBoot
11+
*
12+
* GemmaBoot is a bootloader that emulates a USBtinyISP (from Adafruit Industries)
13+
*
14+
* Gemma will use GemmaBoot
15+
*
16+
* This code is heavily derived from USBaspLoader, but also from USBtiny, with USBtinyISP's settings
17+
18+
Copyright (c) 2013 Adafruit Industries
19+
All rights reserved.
20+
21+
GemmaBoot is free software: you can redistribute it and/or modify
22+
it under the terms of the GNU Lesser General Public License as
23+
published by the Free Software Foundation, either version 3 of
24+
the License, or (at your option) any later version.
25+
26+
GemmaBoot is distributed in the hope that it will be useful,
27+
but WITHOUT ANY WARRANTY; without even the implied warranty of
28+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29+
GNU Lesser General Public License for more details.
30+
31+
You should have received a copy of the GNU Lesser General Public
32+
License along with GemmaBoot. If not, see
33+
<http://www.gnu.org/licenses/>.
34+
*/
35+
36+
#ifndef __usbconfig_h_included__
37+
#define __usbconfig_h_included__
38+
39+
/* YOU SHOULD NOT NEED TO MODIFY THIS FILE! All configurations are supposed
40+
* to go into bootloaderconfig.h!
41+
*/
42+
43+
/* ---------------------------- Hardware Config ---------------------------- */
44+
45+
/* All the port and pin assignments, as well as the clock speed and CRC
46+
setting are now in bootloaderconfig.h: */
47+
48+
#include "bootloaderconfig.h"
49+
50+
/* --------------------------- Functional Range ---------------------------- */
51+
52+
#define USB_CFG_HAVE_INTRIN_ENDPOINT 0
53+
/* Define this to 1 if you want to compile a version with two endpoints: The
54+
* default control endpoint 0 and an interrupt-in endpoint (any other endpoint
55+
* number).
56+
*/
57+
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0
58+
/* Define this to 1 if you want to compile a version with three endpoints: The
59+
* default control endpoint 0, an interrupt-in endpoint 3 (or the number
60+
* configured below) and a catch-all default interrupt-in endpoint as above.
61+
* You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
62+
*/
63+
#define USB_CFG_EP3_NUMBER 3
64+
/* If the so-called endpoint 3 is used, it can now be configured to any other
65+
* endpoint number (except 0) with this macro. Default if undefined is 3.
66+
*/
67+
/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
68+
/* The above macro defines the startup condition for data toggling on the
69+
* interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
70+
* Since the token is toggled BEFORE sending any data, the first packet is
71+
* sent with the oposite value of this configuration!
72+
*/
73+
#define USB_CFG_IMPLEMENT_HALT 0
74+
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
75+
* for endpoint 1 (interrupt endpoint). Although you may not need this feature,
76+
* it is required by the standard. We have made it a config option because it
77+
* bloats the code considerably.
78+
*/
79+
#define USB_CFG_SUPPRESS_INTR_CODE 0
80+
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
81+
* want to send any data over them. If this macro is defined to 1, functions
82+
* usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
83+
* you need the interrupt-in endpoints in order to comply to an interface
84+
* (e.g. HID), but never want to send any data. This option saves a couple
85+
* of bytes in flash memory and the transmit buffers in RAM.
86+
*/
87+
#define USB_CFG_INTR_POLL_INTERVAL 10
88+
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll
89+
* interval. The value is in milliseconds and must not be less than 10 ms for
90+
* low speed devices.
91+
*/
92+
#ifndef USB_CFG_IS_SELF_POWERED // allow bootloaderconfig.h to override
93+
#define USB_CFG_IS_SELF_POWERED 0
94+
#endif
95+
/* Define this to 1 if the device has its own power supply. Set it to 0 if the
96+
* device is powered from the USB bus.
97+
*/
98+
#ifndef USB_CFG_MAX_BUS_POWER // allow bootloaderconfig.h to override
99+
#define USB_CFG_MAX_BUS_POWER 100
100+
#endif
101+
/* Set this variable to the maximum USB bus power consumption of your device.
102+
* The value is in milliamperes. [It will be divided by two since USB
103+
* communicates power requirements in units of 2 mA.]
104+
*/
105+
#define USB_CFG_IMPLEMENT_FN_WRITE 1
106+
/* Set this to 1 if you want usbFunctionWrite() to be called for control-out
107+
* transfers. Set it to 0 if you don't need it and want to save a couple of
108+
* bytes.
109+
*/
110+
#define USB_CFG_IMPLEMENT_FN_READ 1
111+
/* Set this to 1 if you need to send control replies which are generated
112+
* "on the fly" when usbFunctionRead() is called. If you only want to send
113+
* data from a static buffer, set it to 0 and return the data from
114+
* usbFunctionSetup(). This saves a couple of bytes.
115+
*/
116+
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0
117+
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
118+
* You must implement the function usbFunctionWriteOut() which receives all
119+
* interrupt/bulk data sent to any endpoint other than 0. The endpoint number
120+
* can be found in 'usbRxToken'.
121+
*/
122+
#define USB_CFG_HAVE_FLOWCONTROL 0
123+
/* Define this to 1 if you want flowcontrol over USB data. See the definition
124+
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in
125+
* usbdrv.h.
126+
*/
127+
#define USB_CFG_DRIVER_FLASH_PAGE 0
128+
/* If the device has more than 64 kBytes of flash, define this to the 64 k page
129+
* where the driver's constants (descriptors) are located. Or in other words:
130+
* Define this to 1 for boot loaders on the ATMega128.
131+
*/
132+
#define USB_CFG_LONG_TRANSFERS 0
133+
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
134+
* in a single control-in or control-out transfer. Note that the capability
135+
* for long transfers increases the driver size.
136+
*/
137+
#ifndef __ASSEMBLER__
138+
extern volatile char usbHasRxed;
139+
#endif
140+
#define USB_RX_USER_HOOK(data, len) do { usbHasRxed = 1; } while (0);
141+
/* This macro is a hook if you want to do unconventional things. If it is
142+
* defined, it's inserted at the beginning of received message processing.
143+
* If you eat the received message and don't want default processing to
144+
* proceed, do a return after doing your things. One possible application
145+
* (besides debugging) is to flash a status LED on each packet.
146+
*/
147+
/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
148+
/* This macro is a hook if you need to know when an USB RESET occurs. It has
149+
* one parameter which distinguishes between the start of RESET state and its
150+
* end.
151+
*/
152+
/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
153+
/* This macro (if defined) is executed when a USB SET_ADDRESS request was
154+
* received.
155+
*/
156+
#define USB_COUNT_SOF 0
157+
/* define this macro to 1 if you need the global variable "usbSofCount" which
158+
* counts SOF packets. This feature requires that the hardware interrupt is
159+
* connected to D- instead of D+.
160+
*/
161+
/* #ifdef __ASSEMBLER__
162+
* macro myAssemblerMacro
163+
* in YL, TCNT0
164+
* sts timer0Snapshot, YL
165+
* endm
166+
* #endif
167+
* #define USB_SOF_HOOK myAssemblerMacro
168+
* This macro (if defined) is executed in the assembler module when a
169+
* Start Of Frame condition is detected. It is recommended to define it to
170+
* the name of an assembler macro which is defined here as well so that more
171+
* than one assembler instruction can be used. The macro may use the register
172+
* YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
173+
* immediately after an SOF pulse may be lost and must be retried by the host.
174+
* What can you do with this hook? Since the SOF signal occurs exactly every
175+
* 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
176+
* designs running on the internal RC oscillator.
177+
* Please note that Start Of Frame detection works only if D- is wired to the
178+
* interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
179+
*/
180+
#define USB_CFG_CHECK_DATA_TOGGLING 0
181+
/* define this macro to 1 if you want to filter out duplicate data packets
182+
* sent by the host. Duplicates occur only as a consequence of communication
183+
* errors, when the host does not receive an ACK. Please note that you need to
184+
* implement the filtering yourself in usbFunctionWriteOut() and
185+
* usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
186+
* for each control- and out-endpoint to check for duplicate packets.
187+
*/
188+
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 1
189+
/* define this macro to 1 if you want the function usbMeasureFrameLength()
190+
* compiled in. This function can be used to calibrate the AVR's RC oscillator.
191+
*/
192+
#define USB_USE_FAST_CRC 0
193+
/* The assembler module has two implementations for the CRC algorithm. One is
194+
* faster, the other is smaller. This CRC routine is only used for transmitted
195+
* messages where timing is not critical. The faster routine needs 31 cycles
196+
* per byte while the smaller one needs 61 to 69 cycles. The faster routine
197+
* may be worth the 32 bytes bigger code size if you transmit lots of data and
198+
* run the AVR close to its limit.
199+
*/
200+
201+
/* -------------------------- Device Description --------------------------- */
202+
203+
#define USB_CFG_VENDOR_ID 0x41, 0x23 /* = 0x16c0 = 5824 = voti.nl */
204+
/* USB vendor ID for the device, low byte first. If you have registered your
205+
* own Vendor ID, define it here. Otherwise you may use one of obdev's free
206+
* shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
207+
*/
208+
#define USB_CFG_DEVICE_ID 0x9F, 0x0c /* = 0x05dc = 1500 */
209+
/* This is the ID of the product, low byte first. It is interpreted in the
210+
* scope of the vendor ID. If you have registered your own VID with usb.org
211+
* or if you have licensed a PID from somebody else, define it here. Otherwise
212+
* you may use one of obdev's free shared VID/PID pairs. See the file
213+
* USB-IDs-for-free.txt for details!
214+
*/
215+
#define USB_CFG_DEVICE_VERSION 0x00, 0x01
216+
/* Version number of the device: Minor number first, then major number.
217+
*/
218+
#define USB_CFG_VENDOR_NAME 'A','r','d','u','i','n','o','.','c','c'
219+
#define USB_CFG_VENDOR_NAME_LEN 10
220+
/* These two values define the vendor name returned by the USB device. The name
221+
* must be given as a list of characters under single quotes. The characters
222+
* are interpreted as Unicode (UTF-16) entities.
223+
* If you don't want a vendor name string, undefine these macros.
224+
* ALWAYS define a vendor name containing your Internet domain name if you use
225+
* obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
226+
* details.
227+
*/
228+
#define USB_CFG_DEVICE_NAME 'G','e','m','m','a'
229+
#define USB_CFG_DEVICE_NAME_LEN 5
230+
/* Same as above for the device name. If you don't want a device name, undefine
231+
* the macros. See the file USB-IDs-for-free.txt before you assign a name if
232+
* you use a shared VID/PID.
233+
*/
234+
/*#define USB_CFG_SERIAL_NUMBER 'N', 'o', 'n', 'e' */
235+
/*#define USB_CFG_SERIAL_NUMBER_LEN 0 */
236+
/* Same as above for the serial number. If you don't want a serial number,
237+
* undefine the macros.
238+
* It may be useful to provide the serial number through other means than at
239+
* compile time. See the section about descriptor properties below for how
240+
* to fine tune control over USB descriptors such as the string descriptor
241+
* for the serial number.
242+
*/
243+
#define USB_CFG_DEVICE_CLASS 0xFF /* set to 0 if deferred to interface */
244+
#define USB_CFG_DEVICE_SUBCLASS 0
245+
/* See USB specification if you want to conform to an existing device class.
246+
* Class 0xff is "vendor specific".
247+
*/
248+
#define USB_CFG_INTERFACE_CLASS 0 /* define class here if not at device level */
249+
#define USB_CFG_INTERFACE_SUBCLASS 0
250+
#define USB_CFG_INTERFACE_PROTOCOL 0
251+
/* See USB specification if you want to conform to an existing device class or
252+
* protocol. The following classes must be set at interface level:
253+
* HID class is 3, no subclass and protocol required (but may be useful!)
254+
* CDC class is 2, use subclass 2 and protocol 1 for ACM
255+
*/
256+
/* #define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 42 */
257+
/* Define this to the length of the HID report descriptor, if you implement
258+
* an HID device. Otherwise don't define it or define it to 0.
259+
* If you use this define, you must add a PROGMEM character array named
260+
* "usbHidReportDescriptor" to your code which contains the report descriptor.
261+
* Don't forget to keep the array and this define in sync!
262+
*/
263+
264+
#define USB_PUBLIC static
265+
/* Use the define above if you #include usbdrv.c instead of linking against it.
266+
* This technique saves a couple of bytes in flash memory.
267+
*/
268+
269+
/* ------------------- Fine Control over USB Descriptors ------------------- */
270+
/* If you don't want to use the driver's default USB descriptors, you can
271+
* provide our own. These can be provided as (1) fixed length static data in
272+
* flash memory, (2) fixed length static data in RAM or (3) dynamically at
273+
* runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
274+
* information about this function.
275+
* Descriptor handling is configured through the descriptor's properties. If
276+
* no properties are defined or if they are 0, the default descriptor is used.
277+
* Possible properties are:
278+
* + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
279+
* at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
280+
* used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
281+
* you want RAM pointers.
282+
* + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
283+
* in static memory is in RAM, not in flash memory.
284+
* + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
285+
* the driver must know the descriptor's length. The descriptor itself is
286+
* found at the address of a well known identifier (see below).
287+
* List of static descriptor names (must be declared PROGMEM if in flash):
288+
* char usbDescriptorDevice[];
289+
* char usbDescriptorConfiguration[];
290+
* char usbDescriptorHidReport[];
291+
* char usbDescriptorString0[];
292+
* int usbDescriptorStringVendor[];
293+
* int usbDescriptorStringDevice[];
294+
* int usbDescriptorStringSerialNumber[];
295+
* Other descriptors can't be provided statically, they must be provided
296+
* dynamically at runtime.
297+
*
298+
* Descriptor properties are or-ed or added together, e.g.:
299+
* #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
300+
*
301+
* The following descriptors are defined:
302+
* USB_CFG_DESCR_PROPS_DEVICE
303+
* USB_CFG_DESCR_PROPS_CONFIGURATION
304+
* USB_CFG_DESCR_PROPS_STRINGS
305+
* USB_CFG_DESCR_PROPS_STRING_0
306+
* USB_CFG_DESCR_PROPS_STRING_VENDOR
307+
* USB_CFG_DESCR_PROPS_STRING_PRODUCT
308+
* USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
309+
* USB_CFG_DESCR_PROPS_HID
310+
* USB_CFG_DESCR_PROPS_HID_REPORT
311+
* USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
312+
*
313+
* Note about string descriptors: String descriptors are not just strings, they
314+
* are Unicode strings prefixed with a 2 byte header. Example:
315+
* int serialNumberDescriptor[] = {
316+
* USB_STRING_DESCRIPTOR_HEADER(6),
317+
* 'S', 'e', 'r', 'i', 'a', 'l'
318+
* };
319+
*/
320+
321+
#define USB_CFG_DESCR_PROPS_DEVICE 0
322+
#define USB_CFG_DESCR_PROPS_CONFIGURATION 0
323+
#define USB_CFG_DESCR_PROPS_STRINGS 0
324+
#define USB_CFG_DESCR_PROPS_STRING_0 0
325+
#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0
326+
#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0
327+
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0
328+
#define USB_CFG_DESCR_PROPS_HID 0
329+
#define USB_CFG_DESCR_PROPS_HID_REPORT 0
330+
#define USB_CFG_DESCR_PROPS_UNKNOWN 0
331+
332+
#define usbMsgPtr_t unsigned short // scalar type yields shortest code
333+
334+
/* ----------------------- Optional MCU Description ------------------------ */
335+
336+
/* The following configurations have working defaults in usbdrv.h. You
337+
* usually don't need to set them explicitly. Only if you want to run
338+
* the driver on a device which is not yet supported or with a compiler
339+
* which is not fully supported (such as IAR C) or if you use a differnt
340+
* interrupt than INT0, you may have to define some of these.
341+
*/
342+
#define USB_INTR_CFG PCMSK
343+
#define USB_INTR_CFG_SET (1 << USB_CFG_DPLUS_BIT)
344+
#define USB_INTR_CFG_CLR 0
345+
#define USB_INTR_ENABLE GIMSK
346+
#define USB_INTR_ENABLE_BIT PCIE
347+
#define USB_INTR_PENDING GIFR
348+
#define USB_INTR_PENDING_BIT PCIF
349+
#define USB_INTR_VECTOR PCINT0_vect
350+
351+
#endif /* __usbconfig_h_included__ */

‎bootloaders/gemma/usbconfig.patch

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
203c203
2+
< #define USB_CFG_VENDOR_ID 0x81, 0x17 /* = 0x16c0 = 5824 = voti.nl */
3+
---
4+
> #define USB_CFG_VENDOR_ID 0x41, 0x23 /* = 0x16c0 = 5824 = voti.nl */
5+
208c208
6+
< #define USB_CFG_DEVICE_ID 0x9F, 0x0C /* = 0x05dc = 1500 */
7+
---
8+
> #define USB_CFG_DEVICE_ID 0x9F, 0x0c /* = 0x05dc = 1500 */
9+
215c215
10+
< #define USB_CFG_DEVICE_VERSION 0x05, 0x01
11+
---
12+
> #define USB_CFG_DEVICE_VERSION 0x00, 0x01
13+
218,219c218,219
14+
< #define USB_CFG_VENDOR_NAME 'A','d','a','f','r','u','i','t'
15+
< #define USB_CFG_VENDOR_NAME_LEN 8
16+
---
17+
> #define USB_CFG_VENDOR_NAME 'A','r','d','u','i','n','o','.','c','c'
18+
> #define USB_CFG_VENDOR_NAME_LEN 10
19+
228,229c228,229
20+
< #define USB_CFG_DEVICE_NAME 'T','r','i','n','k','e','t'
21+
< #define USB_CFG_DEVICE_NAME_LEN 7
22+
---
23+
> #define USB_CFG_DEVICE_NAME 'G','e','m','m','a'
24+
> #define USB_CFG_DEVICE_NAME_LEN 5

0 commit comments

Comments
 (0)