219 lines
19 KiB
HTML
219 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en">
|
|
<head>
|
|
<title>Flashing Firmware - QMK Firmware</title>
|
|
<meta name="description" content="Keyboard controller firmware for Atmel AVR and ARM USB families">
|
|
<meta name="author" content="QMK Community">
|
|
<meta charset="UTF-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
<link rel="icon" href="../themes/daux/img/favicon-navy.png" type="image/x-icon">
|
|
|
|
<!-- Mobile -->
|
|
<meta name="apple-mobile-web-app-capable" content="yes" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<!-- Font -->
|
|
|
|
<!-- CSS -->
|
|
<link href='../themes/daux/css/theme-navy.min.css' rel='stylesheet' type='text/css'>
|
|
<!-- Tipue Search -->
|
|
<link href="../tipuesearch/tipuesearch.css" rel="stylesheet">
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../themes/daux/js/html5shiv-3.7.3.min.js"></script>
|
|
<![endif]-->
|
|
</head>
|
|
<body class=" ">
|
|
<div class="Columns content">
|
|
<aside class="Columns__left Collapsible">
|
|
<button type="button" class="Button Collapsible__trigger">
|
|
<span class="Collapsible__trigger__bar"></span>
|
|
<span class="Collapsible__trigger__bar"></span>
|
|
<span class="Collapsible__trigger__bar"></span>
|
|
</button>
|
|
|
|
<a class="Brand" href="../index.html">QMK Firmware</a>
|
|
|
|
<div class="Search">
|
|
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
|
|
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
|
|
</svg>
|
|
<input type="search" id="tipue_search_input" class="Search__field" placeholder="Search..." autocomplete="on"
|
|
results=25 autosave=text_search>
|
|
</div>
|
|
|
|
<div class="Collapsible__content">
|
|
<!-- Navigation -->
|
|
<ul class='Nav'><li class='Nav__item Nav__item--open has-children'><a href="../Getting_Started/index.html" class="folder"><i class="Nav__arrow"> </i>Getting Started</a><ul class='Nav'><li class='Nav__item has-children'><a href="../Getting_Started/Install_Build_Tools/index.html" class="folder"><i class="Nav__arrow"> </i>Install Build Tools</a><ul class='Nav'><li class='Nav__item '><a href="../Getting_Started/Install_Build_Tools/Vagrant.html">Vagrant</a></li></ul></li><li class='Nav__item '><a href="../Getting_Started/Build_Compile_Instructions.html">Build Compile Instructions</a></li><li class='Nav__item Nav__item--active'><a href="../Getting_Started/Flashing_Firmware.html">Flashing Firmware</a></li><li class='Nav__item '><a href="../Getting_Started/Contributing.html">Contributing</a></li><li class='Nav__item '><a href="../Getting_Started/How_to_Use_GitHub.html">How to Use GitHub</a></li><li class='Nav__item '><a href="../Getting_Started/Getting_Help.html">Getting Help</a></li></ul></li><li class='Nav__item has-children'><a href="../Complete_Newbs_Guide/index.html" class="folder"><i class="Nav__arrow"> </i>Complete Newbs Guide</a><ul class='Nav'><li class='Nav__item '><a href="../Complete_Newbs_Guide/Complete_Newbie's_Guide.html">Complete Newbie's Guide</a></li><li class='Nav__item '><a href="../Complete_Newbs_Guide/Building_Your_First_Firmware.html">Building Your First Firmware</a></li><li class='Nav__item '><a href="../Complete_Newbs_Guide/Flashing_Firmware.html">Flashing Firmware</a></li><li class='Nav__item '><a href="../Complete_Newbs_Guide/Testing_and_Debugging.html">Testing and Debugging</a></li></ul></li><li class='Nav__item has-children'><a href="../FAQ/index.html" class="folder"><i class="Nav__arrow"> </i>FAQ</a><ul class='Nav'><li class='Nav__item '><a href="../FAQ/General_FAQ.html">General FAQ</a></li><li class='Nav__item '><a href="../FAQ/Build_Compile_QMK.html">Build Compile QMK</a></li><li class='Nav__item '><a href="../FAQ/Debugging_and_Troubleshooting.html">Debugging and Troubleshooting</a></li><li class='Nav__item '><a href="../FAQ/Keymaps.html">Keymaps</a></li></ul></li><li class='Nav__item has-children'><a href="../Hardware/index.html" class="folder"><i class="Nav__arrow"> </i>Hardware</a><ul class='Nav'><li class='Nav__item '><a href="../Hardware/AVR_Processors.html">AVR Processors</a></li><li class='Nav__item '><a href="../Hardware/Drivers.html">Drivers</a></li></ul></li><li class='Nav__item has-children'><a href="../Features/index.html" class="folder"><i class="Nav__arrow"> </i>Features</a><ul class='Nav'><li class='Nav__item '><a href="../Features/Advanced_Keycodes.html">Advanced Keycodes</a></li><li class='Nav__item '><a href="../Features/Audio.html">Audio</a></li><li class='Nav__item '><a href="../Features/Auto_Shift.html">Auto Shift</a></li><li class='Nav__item '><a href="../Features/Backlight.html">Backlight</a></li><li class='Nav__item '><a href="../Features/Bluetooth.html">Bluetooth</a></li><li class='Nav__item '><a href="../Features/Bootmagic.html">Bootmagic</a></li><li class='Nav__item '><a href="../Features/Command.html">Command</a></li><li class='Nav__item '><a href="../Features/Dynamic_Macros.html">Dynamic Macros</a></li><li class='Nav__item '><a href="../Features/Grave_Escape.html">Grave Escape</a></li><li class='Nav__item '><a href="../Features/Key_Lock.html">Key Lock</a></li><li class='Nav__item '><a href="../Features/Layouts.html">Layouts</a></li><li class='Nav__item '><a href="../Features/Leader_Key.html">Leader Key</a></li><li class='Nav__item '><a href="../Features/Macros.html">Macros</a></li><li class='Nav__item '><a href="../Features/Mouse_Keys.html">Mouse Keys</a></li><li class='Nav__item '><a href="../Features/Pointing_Device.html">Pointing Device</a></li><li class='Nav__item '><a href="../Features/PS_2_Mouse.html">PS 2 Mouse</a></li><li class='Nav__item '><a href="../Features/RGB_Lighting.html">RGB Lighting</a></li><li class='Nav__item '><a href="../Features/Space_Cadet_Shift.html">Space Cadet Shift</a></li><li class='Nav__item '><a href="../Features/Space_Cadet_Shift_Enter.html">Space Cadet Shift Enter</a></li><li class='Nav__item '><a href="../Features/Stenography.html">Stenography</a></li><li class='Nav__item '><a href="../Features/Swap_Hands.html">Swap Hands</a></li><li class='Nav__item '><a href="../Features/Tap_Dance.html">Tap Dance</a></li><li class='Nav__item '><a href="../Features/Terminal.html">Terminal</a></li><li class='Nav__item '><a href="../Features/Thermal_Printer.html">Thermal Printer</a></li><li class='Nav__item '><a href="../Features/Unicode.html">Unicode</a></li><li class='Nav__item '><a href="../Features/Userspace.html">Userspace</a></li></ul></li><li class='Nav__item has-children'><a href="../Keycodes/index.html" class="folder"><i class="Nav__arrow"> </i>Keycodes</a><ul class='Nav'><li class='Nav__item '><a href="../Keycodes/Advanced_Keycodes.html">Advanced Keycodes</a></li><li class='Nav__item '><a href="../Keycodes/Backlight.html">Backlight</a></li><li class='Nav__item '><a href="../Keycodes/Basic.html">Basic</a></li><li class='Nav__item '><a href="../Keycodes/Bluetooth.html">Bluetooth</a></li><li class='Nav__item '><a href="../Keycodes/Bootmagic.html">Bootmagic</a></li><li class='Nav__item '><a href="../Keycodes/Quantum_Keycodes.html">Quantum Keycodes</a></li><li class='Nav__item '><a href="../Keycodes/RGB_Lighting.html">RGB Lighting</a></li><li class='Nav__item '><a href="../Keycodes/Stenography.html">Stenography</a></li><li class='Nav__item '><a href="../Keycodes/Thermal_Printer.html">Thermal Printer</a></li><li class='Nav__item '><a href="../Keycodes/US_ANSI_Shifted_keys.html">US ANSI Shifted keys</a></li></ul></li><li class='Nav__item has-children'><a href="../Reference/index.html" class="folder"><i class="Nav__arrow"> </i>Reference</a><ul class='Nav'><li class='Nav__item '><a href="../Reference/Keyboard_Guidelines.html">Keyboard Guidelines</a></li><li class='Nav__item '><a href="../Reference/Compatable_Microcontrollers.html">Compatable Microcontrollers</a></li><li class='Nav__item '><a href="../Reference/Config_Options.html">Config Options</a></li><li class='Nav__item '><a href="../Reference/Custom_Code.html">Custom Code</a></li><li class='Nav__item '><a href="../Reference/Documentation_Best_Practices.html">Documentation Best Practices</a></li><li class='Nav__item '><a href="../Reference/Documentation_Templates.html">Documentation Templates</a></li><li class='Nav__item '><a href="../Reference/Glossary.html">Glossary</a></li><li class='Nav__item '><a href="../Reference/Keymap_Overview.html">Keymap Overview</a></li><li class='Nav__item '><a href="../Reference/Unit_Testing.html">Unit Testing</a></li></ul></li><li class='Nav__item has-children'><a href="../For_Makers_And_Modders/index.html" class="folder"><i class="Nav__arrow"> </i>For Makers And Modders</a><ul class='Nav'><li class='Nav__item '><a href="../For_Makers_And_Modders/Hand_Wiring_Guide.html">Hand Wiring Guide</a></li><li class='Nav__item '><a href="../For_Makers_And_Modders/ISP_Flashing_Guide.html">ISP Flashing Guide</a></li></ul></li><li class='Nav__item has-children'><a href="../IDEs/index.html" class="folder"><i class="Nav__arrow"> </i>IDEs</a><ul class='Nav'><li class='Nav__item '><a href="../IDEs/Eclipse.html">Eclipse</a></li></ul></li><li class='Nav__item has-children'><a href="../For_a_Deeper_Understanding/index.html" class="folder"><i class="Nav__arrow"> </i>For a Deeper Understanding</a><ul class='Nav'><li class='Nav__item '><a href="../For_a_Deeper_Understanding/How_Keyboards_Work.html">How Keyboards Work</a></li><li class='Nav__item '><a href="../For_a_Deeper_Understanding/Understanding_QMK.html">Understanding QMK</a></li></ul></li></ul>
|
|
|
|
<div class="Links">
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
<div class="Columns__right Columns__right--full">
|
|
<div class="Columns__right__content">
|
|
<div class="doc_content">
|
|
<article class="Page">
|
|
|
|
<div class="Page__header">
|
|
<h1><a href="../Getting_Started/index.html">Getting Started</a> <svg class="Page__header--separator" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 477.175 477.175"><path d="M360.73 229.075l-225.1-225.1c-5.3-5.3-13.8-5.3-19.1 0s-5.3 13.8 0 19.1l215.5 215.5-215.5 215.5c-5.3 5.3-5.3 13.8 0 19.1 2.6 2.6 6.1 4 9.5 4 3.4 0 6.9-1.3 9.5-4l225.1-225.1c5.3-5.2 5.3-13.8.1-19z"/></svg> <a href="../Getting_Started/Flashing_Firmware.html">Flashing Firmware</a></h1>
|
|
<span class="EditOn">
|
|
<a href="https://github.com/qmk/qmk_firmware/blob/master/docs/01_Getting_Started/04_Flashing_Firmware.md" target="_blank">
|
|
Edit on GitHub </a>
|
|
</span>
|
|
</div>
|
|
|
|
<div class="s-content">
|
|
<ul class="TableOfContents">
|
|
<li>
|
|
<p><a href="#page_Flashing-Instructions-and-Bootloader-Information">Flashing Instructions and Bootloader Information</a></p>
|
|
<ul class="TableOfContents">
|
|
<li>
|
|
<p><a href="#page_DFU">DFU</a></p>
|
|
<ul class="TableOfContents">
|
|
<li>
|
|
<p><a href="#page_QMK-DFU">QMK DFU</a></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><a href="#page_Caterina">Caterina</a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="#page_Halfkay">Halfkay</a></p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="page_Flashing-Instructions-and-Bootloader-Information">Flashing Instructions and Bootloader Information</h1>
|
|
<p>There are quite a few different types of bootloaders that keyboards use, and just about all of the use a different flashing method. Luckily, projects like the <a href="https://github.com/qmk/qmk_toolbox/releases" class="Link--external">QMK Toolbox</a> aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them.</p>
|
|
<p>If you have a bootloader selected with the <code>BOOTLOADER</code> variable in your <code>rules.mk</code>, QMK will automatically calculate if your .hex file is the right size to be flashed to the device, and output the total size it bytes (along with the max). To run this process manually, compile with the target <code>check-size</code>, eg <code>make planck/rev4:default:check-size</code>.</p>
|
|
<h2 id="page_DFU">DFU</h2>
|
|
<p>Atmel's DFU bootloader comes on all atmega32u4 chips by default, and is used by many keyboards that have their own ICs on their PCBs (Older OLKB boards, Clueboards). Some keyboards may also use LUFA's DFU bootloader (or QMK's fork) (Newer OLKB boards) that adds in additional features specific to that hardware.</p>
|
|
<p>To ensure compatibility with the DFU bootloader, make sure this block is present your <code>rules.mk</code> (optionally with <code>lufa-dfu</code> or <code>qmk-dfu</code> instead):</p>
|
|
<pre><code># Bootloader
|
|
# This definition is optional, and if your keyboard supports multiple bootloaders of
|
|
# different sizes, comment this out, and the correct address will be loaded
|
|
# automatically (+60). See bootloader.mk for all options.
|
|
BOOTLOADER = atmel-dfu
|
|
</code></pre>
|
|
<p>Compatible flashers:</p>
|
|
<ul>
|
|
<li>
|
|
<a href="https://github.com/qmk/qmk_toolbox/releases" class="Link--external">QMK Toolbox</a> (recommended GUI)</li>
|
|
<li>
|
|
<a href="https://github.com/dfu-programmer/dfu-programmer" class="Link--external">dfu-programmer</a> / <code>:dfu</code> in QMK (recommended command line)</li>
|
|
<li>
|
|
<a href="http://www.microchip.com/developmenttools/productdetails.aspx?partno=flip" class="Link--external">Atmel's Flip</a> (not recommended)</li>
|
|
</ul>
|
|
<p>Flashing sequence:</p>
|
|
<ol>
|
|
<li>Press the <code>RESET</code> keycode, or tap the RESET button (or short RST to GND).</li>
|
|
<li>Wait for the OS to detect the device</li>
|
|
<li>Erase the memory (may be done automatically)</li>
|
|
<li>Flash a .hex file</li>
|
|
<li>Reset the device into application mode (may be done automatically)</li>
|
|
</ol>
|
|
<p>or:</p>
|
|
<pre><code>make <keyboard>:<keymap>:dfu
|
|
</code></pre>
|
|
<h3 id="page_QMK-DFU">QMK DFU</h3>
|
|
<p>QMK has a fork of the LUFA DFU bootloader that allows for a simple matrix scan for exiting the bootloader and returning to the application, as well as flashing an LED/making a ticking noise with a speaker when things are happening. To enable these features, use this block in your <code>config.h</code> (The key that exits the bootloader needs to be hooked-up to the INPUT and OUTPUT defined here):</p>
|
|
<pre><code>#define QMK_ESC_OUTPUT F1 // usually COL
|
|
#define QMK_ESC_INPUT D5 // usually ROW
|
|
#define QMK_LED E6
|
|
#define QMK_SPEAKER C6
|
|
</code></pre>
|
|
<p>The Manufacturer and Product names are automatically pulled from your <code>config.h</code>, and "Bootloader" is added to the product.</p>
|
|
<p>To generate this bootloader, use the <code>bootloader</code> target, eg <code>make planck/rev4:default:bootloader</code>.</p>
|
|
<p>To generate a production-ready .hex file (containing the application and the bootloader), use the <code>production</code> target, eg <code>make planck/rev4:default:production</code>.</p>
|
|
<h2 id="page_Caterina">Caterina</h2>
|
|
<p>Arduino boards and their clones use the <a href="https://github.com/arduino/Arduino/tree/master/hardware/arduino/avr/bootloaders/caterina" class="Link--external">Caterina bootloader</a> (any keyboard built with a Pro Micro, or clone), and uses the avr109 protocol to communicate through virtual serial. Bootloaders like <a href="https://www.pololu.com/docs/0J61/9" class="Link--external">A-Star</a> are based on Caterina.</p>
|
|
<p>To ensure compatibility with the Caterina bootloader, make sure this block is present your <code>rules.mk</code>:</p>
|
|
<pre><code># Bootloader
|
|
# This definition is optional, and if your keyboard supports multiple bootloaders of
|
|
# different sizes, comment this out, and the correct address will be loaded
|
|
# automatically (+60). See bootloader.mk for all options.
|
|
BOOTLOADER = caterina
|
|
</code></pre>
|
|
<p>Compatible flashers:</p>
|
|
<ul>
|
|
<li>
|
|
<a href="https://github.com/qmk/qmk_toolbox/releases" class="Link--external">QMK Toolbox</a> (recommended GUI)</li>
|
|
<li>
|
|
<a href="http://www.nongnu.org/avrdude/" class="Link--external">avrdude</a> with avr109 / <code>:avrdude</code> (recommended command line)</li>
|
|
<li>
|
|
<a href="https://github.com/zkemble/AVRDUDESS" class="Link--external">AVRDUDESS</a>
|
|
</li>
|
|
</ul>
|
|
<p>Flashing sequence:</p>
|
|
<ol>
|
|
<li>Press the <code>RESET</code> keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters)</li>
|
|
<li>Wait for the OS to detect the device</li>
|
|
<li>Flash a .hex file</li>
|
|
<li>Wait for the device to reset automatically</li>
|
|
</ol>
|
|
<p>or</p>
|
|
<pre><code>make <keyboard>:<keymap>:avrdude
|
|
</code></pre>
|
|
<h2 id="page_Halfkay">Halfkay</h2>
|
|
<p>Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0).</p>
|
|
<p>To ensure compatibility with the Halfkay bootloader, make sure this block is present your <code>rules.mk</code>:</p>
|
|
<pre><code># Bootloader
|
|
# This definition is optional, and if your keyboard supports multiple bootloaders of
|
|
# different sizes, comment this out, and the correct address will be loaded
|
|
# automatically (+60). See bootloader.mk for all options.
|
|
BOOTLOADER = halfkay
|
|
</code></pre>
|
|
<p>Compatible flashers:</p>
|
|
<ul>
|
|
<li>
|
|
<a href="https://github.com/qmk/qmk_toolbox/releases" class="Link--external">QMK Toolbox</a> (recommended GUI)</li>
|
|
<li>
|
|
<a href="https://www.pjrc.com/teensy/loader.html" class="Link--external">Teensy Loader</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://www.pjrc.com/teensy/loader_cli.html" class="Link--external">Teensy Loader Command Line</a> (recommended command line)</li>
|
|
</ul>
|
|
<p>Flashing sequence:</p>
|
|
<ol>
|
|
<li>Press the <code>RESET</code> keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters)</li>
|
|
<li>Wait for the OS to detect the device</li>
|
|
<li>Flash a .hex file</li>
|
|
<li>Reset the device into application mode (may be done automatically)</li>
|
|
</ol>
|
|
</div>
|
|
|
|
<nav>
|
|
<ul class="Pager">
|
|
<li class=Pager--prev><a href="../Getting_Started/Build_Compile_Instructions.html">Previous</a></li> <li class=Pager--next><a href="../Getting_Started/Contributing.html">Next</a></li> </ul>
|
|
</nav>
|
|
</article>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<!-- JS -->
|
|
<script src="../themes/daux/js/jquery-1.11.3.min.js"></script><script src="../themes/daux/js/highlight.pack.js"></script><script src="../themes/daux/js/daux.js"></script>
|
|
<!-- Tipue Search -->
|
|
<script type="text/javascript" src="../tipuesearch/tipuesearch.js"></script>
|
|
|
|
<script>
|
|
window.onunload = function(){}; // force $(document).ready to be called on back/forward navigation in firefox
|
|
$(function() {
|
|
tipuesearch({
|
|
'base_url': '../'
|
|
});
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|