docs/hardware_avr.md

   1 # Keyboards with AVR Processors
   2
   3 This page describes the support for for AVR processors in QMK. AVR processors include the atmega32u4, atmega32u2, at90usb1286, and other processors from Atmel Corporation. AVR processors are 8-bit MCU's that are designed to be easy to work with. The most common AVR processors in keyboards have on-board USB and plenty of GPIO for supporting large keyboard matrices. They are the most popular MCU for use in keyboards today.
   4
   5 If you have not yet you should read the [Keyboard Guidelines](hardware_keyboard_guidelines.md) to get a sense of how keyboards fit into QMK.
   6
   7 ## Adding Your AVR Keyboard to QMK
   8
   9 QMK has a number of features to simplify working with AVR keyboards. For most keyboards you don't have to write a single line of code. To get started run the `util/new_project.sh` script:
  10
  11 ```bash
  12 $ util/new_project.sh my_awesome_keyboard
  13 ######################################################
  14 # /keyboards/my_awesome_keyboard project created. To start
  15 # working on things, cd into keyboards/my_awesome_keyboard
  16 ######################################################
  17 ```
  18
  19 This will create all the files needed to support your new keyboard, and populate the settings with default values. Now you just need to customize it for your keyboard.
  20
  21 ## `readme.md`
  22
  23 This is where you'll describe your keyboard. Please follow the [Keyboard Readme Template](documentation_templates.md#keyboard-readmemd-template) when writing your `readme.md`. You're encouraged to place an image at the top of your `readme.md`, please use an external service such as [Imgur](http://imgur.com) to host the images.
  24
  25 ## `<keyboard>.c`
  26
  27 This is where all the custom logic for your keyboard goes. Many keyboards do not need to put anything at all in here. You can learn more about writing custom logic in [Custom Quantum Functions](custom_quantum_functions.md).
  28
  29 ## `<keyboard>.h`
  30
  31 This is the file you define your [Layout Macro(s)](feature_layouts.md) in. At minimum you should have a `#define LAYOUT` for your keyboard that looks something like this:
  32
  33 ```c
  34 #define LAYOUT(          \
  35       k00, k01, k02,     \
  36       k10,   k11         \
  37 ) {                      \
  38     { k00, k01,   k02 }, \
  39     { k10, KC_NO, k11 }, \
  40 }
  41 ```
  42
  43 The first half of the `LAYOUT` pre-processor macro defines the physical arrangement of keys. The second half of the macro defines the matrix the switches are connected to. This allows you to have a physical arrangement of keys that differs from the wiring matrix.
  44
  45 Each of the `k__` variables needs to be unique, and typically they follow the format `k<row><col>`.
  46
  47 The physical matrix (the second half) must have a number of rows equaling `MATRIX_ROWS`, and each row must have exactly `MATRIX_COLS` elements in it. If you do not have this many physical keys you can use `KC_NO` to fill in the blank spots.
  48
  49 ## `config.h`
  50
  51 The `config.h` file is where you configure the hardware and feature set for your keyboard. There are a lot of options that can be placed in that file, too many to list there. For a complete overview of available options see the [Config Options](config_options.md) page.
  52
  53 ### Hardware Configuration
  54
  55
  56 At the top of the `config.h` you'll find USB related settings. These control how your keyboard appears to the Operating System. If you don't have a good reason to change you should leave the `VENDOR_ID` as `0xFEED`. For the `PRODUCT_ID` you should pick a number that is not yet in use.
  57
  58 Do change the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` lines to accurately reflect your keyboard.
  59
  60 ```c
  61 #define VENDOR_ID       0xFEED
  62 #define PRODUCT_ID      0x6060
  63 #define DEVICE_VER      0x0001
  64 #define MANUFACTURER    You
  65 #define PRODUCT         my_awesome_keyboard
  66 #define DESCRIPTION     A custom keyboard
  67 ```
  68
  69 ?> Note: On Windows and macOS the `MANUFACTURER`, `PRODUCT`, and `DESCRIPTION` fields will be displayed in the list of USB devices. ?> On Linux these values will not be visible in lsusb by default, since Linux takes the information from the list maintained by [USB ID Repository](http://www.linux-usb.org/usb-ids.html) by default. lsusb will show the information reported by the device when executed with -v option. It is also present in kernel logs after plugging in the device.
  70
  71 ### Keyboard Matrix Configuration
  72
  73 The next section of the `config.h` file deals with your keyboard's matrix. The first thing you should set is the matrix's size. This is usually, but not always, the same number of rows and columns as the physical key arrangement.
  74
  75 ```c
  76 #define MATRIX_ROWS 2
  77 #define MATRIX_COLS 3
  78 ```
  79
  80 Once you've defined the size of your matrix you need to define which pins on your MCU are connected to rows and columns. To do so simply specify the names of those pins:
  81
  82 ```c
  83 #define MATRIX_ROW_PINS { D0, D5 }
  84 #define MATRIX_COL_PINS { F1, F0, B0 }
  85 #define UNUSED_PINS
  86 ```
  87
  88 The number of `MATRIX_ROW_PINS` entries must be the same as the number you assigned to `MATRIX_ROWS`, and likewise for `MATRIX_COL_PINS` and `MATRIX_COLS`. You do not have to specify `UNUSED_PINS`, but you can if you want to document what pins are open.
  89
  90 Finally, you can specify the direction your diodes point. This can be `COL2ROW` or `ROW2COL`.
  91
  92 ```c
  93 #define DIODE_DIRECTION COL2ROW
  94 ```
  95
  96 ### Backlight Configuration
  97
  98 By default QMK supports backlighting on pins `B5`, `B6`, and `B7`. If you are using one of those you can simply enable it here. For more details see the [Backlight Documentation](feature_backlight.md).
  99
 100 ```c
 101 #define BACKLIGHT_PIN B7
 102 #define BACKLIGHT_LEVELS 3
 103 #define BACKLIGHT_BREATHING
 104 #define BREATHING_PERIOD 6
 105 ```
 106
 107 ?> You can use backlighting on any pin you like, but you will have to do more work to support that. See the [Backlight Documentation](feature_backlight.md) for more details.
 108
 109 ### Other Configuration Options
 110
 111 There are a lot of features that can be configured or tuned in `config.h`. You should see the [Config Options](config_options.md) page for more details.
 112
 113 ## `rules.mk`
 114
 115 You use the `rules.mk` file to tell QMK what files to build and what features to enable. If you are building around an atmega32u4 you can largely leave these defaults alone. If you are using another MCU you may have to tweak some parameters.
 116
 117 ### MCU Options
 118
 119 These options tell the build system what CPU to build for. Be very careful if you change any of these settings, you can render your keyboard inoperable.
 120
 121 ```make
 122 MCU = atmega32u4
 123 F_CPU = 16000000
 124 ARCH = AVR8
 125 F_USB = $(F_CPU)
 126 OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
 127 ```
 128
 129 ### Bootloaders
 130
 131 The bootloader is a special section of your MCU that allows you to upgrade the code stored on the MCU. Think of it like a Rescue Partition for your keyboard.
 132
 133 #### Teensy Bootloader Example
 134
 135 ```make
 136 BOOTLOADER = halfkay
 137 ```
 138
 139 #### Atmel DFU Loader Example
 140
 141 ```make
 142 BOOTLOADER = atmel-dfu
 143 ```
 144
 145 #### Pro Micro Bootloader Example
 146
 147 ```make
 148 BOOTLOADER = caterina
 149 ```
 150
 151 ### Build Options
 152
 153 There are a number of features that can be turned on or off in `rules.mk`. See the [Config Options](config_options.md#feature-options) page for a detailed list and description.