Debian Codegraph @

debian/README.Debian

raw
1 Additional hints about the arduino-core-avr package in Debian
2 -------------------------------------------------------------
3
4 1. Bootloaders - differences between Debian and upstream on provided .hex
5 files
6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7
8 This Debian package can't provide all the various *.hex files that are
9 present within the upstream archive.
10 Due the DFSG [1] we are required to build all binary stuff from source, and
11 also have to remove any prebuilt binary stuff from the source tarball.
12 Due this circumstances there are some differences between the included *.hex
13 files in /usr/share/arduino/hardware/bootloaders and data provided by
14 upstream. In detail there are the following differences.
15
16 Folder bootloaders/atmega
17 This folder is fully rebuildable, Debian is providing all possible *.hex
18 files.
19
20 Folder bootloaders/atmega8
21 This folder is fully rebuildable, Debian is providing all possible *.hex
22 files.
23
24 Folder bootloaders/bt:
25 The file ATmegaBOOT_168_atmega328_bt.hex we aren't able to rebuild, the
26 package isn't including this file.
27
28 Folder bootloaders/caterina,
29 bootloaders/caterina-Arduino_Robot,
30 bootloaders/caterina-LilyPadUSB
31 All the various *.hex files can't be rebuilded right now. Rebuilding
32 requires LUFA [2] as resource which isn't available as package right now
33 nor is it included as additional tarball to the source package.
34
35 Folder bootloaders/gemma
36 To rebuild the file gemma_v1.hex we need to include the source of the
37 Adafruit-Trinket-Gemma-Bootloader somehow, the complete source is not fully
38 included and we can't build the file gemma_v1.hex.
39
40 Folder bootloaders/optiboot
41 For the file optiboot_atmega328-Mini.hex isn't a Make target nor a read me
42 or a hint provided how to rebuild that file. Therefore we cant's build and
43 ship that file.
44
45 Folder bootloaders/stk500v2
46 The file Mega2560-prod-firmware-2011-06-29.hex can't be built from source
47 because the Makefile has no information about this file or instructions how
48 to build the .hex file.
49
50 In case you really need one of the *.hex files from one of these folders
51 you can mostly pull the desired file from the original upstream git tree.
52 It certainly would be better if upstream can provide information how the
53 files can be built by ourself!
54
55 https://github.com/arduino/ArduinoCore-avr
56
57 [1] https://www.debian.org/social_contract#guidelines
58 [2] http://www.lufa-lib.org/
59
60
61 3. Firmware - impossibility to provide any .hex files as firmware
62 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63
64 The situation for all *.hex files within the folder firmware/ is mostly the
65 same as for the *.hex files within the some subfolders in bootloader/.
66 For a successful rebuild of the various *.hex files in the folders
67
68 firmware/atmegaxxu2
69 firmware/atmegaxxu2/arduino-usbserial
70
71 the Lightweight USB Framework for AVRs (LUFA) [1] is required. For now this
72 software isn't packaged yet and by this the package can't provide any *.hex
73 files built up on top of the Makefiles. The existing *.hex files are build
74 with LUFA version 100807 according to the file
75
76 'firmwares/atmegaxxu2/README.txt'.
77
78 For now we can just provide the available source files.
79
80 Please have a look at the upstream resource for the package
81 arduino-core-avr [2] in case you need a pre compiled *.hex file.
82
83 [1] http://www.lufa-lib.org/
84 [2] https://github.com/arduino/ArduinoCore-avr/tree/master/firmwares
85
86 If you have any questions or suggestions for improving this README file
87 please do not hesitate to write your opinions to the mailing list, no
88 subscription is required.
89
90 [email protected]
91
92 -- Carsten Schoenert <[email protected]> Thu, 17 Dec 2020 20:20:00 +0100