From 41bf9204127842e852ce4fa0ad35998a3b3d79c5 Mon Sep 17 00:00:00 2001 From: tmk Date: Fri, 29 Mar 2013 10:56:19 +0900 Subject: [PATCH] Refine README.md --- README.md | 149 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 86 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index 3b700970..39abe718 100644 --- a/README.md +++ b/README.md @@ -66,35 +66,43 @@ You can find some keyboard specific projects under `converter` and `keyboard` di -Build & Program ---------------- -### Install Tools +Download and Install +-------------------- +### 1. Install Tools First, you need tools to build firmware and program your controller. I assume you are on Windows here. -1. Install [WinAVR][winavr]. This is old but works well for this purpose. `WinAVR` is a tool set to build firmware including C compiler(gcc) and make commands. You can use [CrossPack][crosspack] instead if you are on Mac. +1. **Toolchain** Install [WinAVR][winavr]. This is old but works well for this purpose. `WinAVR` is a tool set to build firmware including C compiler(gcc) and make commands. You can use [CrossPack][crosspack] instead if you are on Mac. -2. Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller(ATMega32u4) via DFU bootloader. ATMega32u4 has DFU bootloader by factory default. You can use [dfu-programmer][dfu-prog] instead if you are on Mac. +2. **Programmer** Install [Atmel FLIP][flip]. `FLIP` is a tool to program(load) firmware into AVR controller via DFU bootloader. AVR USB chips including ATmega32U4 has DFU bootloader by factory default. You can also use [dfu-programmer][dfu-prog] instead if you are on Mac or Linux. -3. Install driver for DFU bootloader. At first time you start DFU bootloader on Chip 'Found New Hardware Wizard' will come up on Windows. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you shall need to update its driver on 'Device Manager'. You will find the driver in `FLIP` install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. If you use `dfu-programmer` install its driver. +3. **Driver** At first time you start DFU bootloader on Chip 'Found New Hardware Wizard' will come up on Windows. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you shall need to update its driver on 'Device Manager'. You will find the driver in `FLIP` install directory like: C:\Program Files (x86)\Atmel\Flip 3.4.5\usb\. If you use `dfu-programmer` install its driver. -If you use PJRC Teensy you don't need step 2 and 3, just get [Teensy loader][teensy-loader]. +If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader]. -### Download source -You can find firmware source at github: https://github.com/tmk/tmk_keyboard +### 2. Download source +You can find firmware source at github: -If you are familiar with `Git` tools you are recommended to use it. -If not you can download zip archive from: https://github.com/tmk/tmk_keyboard/archive/master.zip +- + +If you are familiar with `Git` tools you are recommended to use it but you can also download zip archive from: + +- -### Build firmware -1. Open terminal window to get access to commands. You can use `cmd` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in Run command dialog showing up. +Build firmware +-------------- +### 1. Open terminal +Open terminal window to get access to commands. You can use `cmd` in Windows or `Terminal.app` on Mac OSX. In Windows press `Windows` key and `R` then enter `cmd` in 'Run command' dialog showing up. -2. Move to project directory in the firmware source. +### 2. Change directory +Move to project directory in the firmware source. - cd tmk_keyboard/{keyboard or converter}/ + cd tmk_keyboard/{'keyboard' or 'converter'}/ + +### 3. Make +Build firmware using GNU `make` command. You'll see `_.hex` file in that directory unless something unexpected occurs in build process. -3. Build firmware using GNU `make` command. You'll see _.hex file in that directory unless something unexpected occurs in build process. mkae -f Makefile. clean make -f Makefile. @@ -102,36 +110,28 @@ If not you can download zip archive from: https://github.com/tmk/tmk_keyboard/ar -### Program Controller -Sock AVR USB chip including ATmega32U4 has DFU bootloader by factory default, you can use DFU tools for this purpose. `FLIP` is a DFU tool on Windows offered by Atmel. Open source command line DFU tool `dfu-programmer` also supports AVR chips, which run on Linux, Mac OSX and even Windows. If you have a PJRC Teensy you should use `Teensy Loader`. +Program Controller +------------------ +Now you have **hex** file to program on current directory. This **hex** is only needed to program your controller, other files are used for development and you may leave and forget them. + +### 1. Start bootloader +How to program controller depends on controller chip and its board design. To program AVR USB chips you'll need to start it up in bootloader mode. Most of boards with the chip have a push button to let bootloader come up. Consult with your controller board manual. + +### 2. Program with DFU bootloader +Stock AVR USB chip including ATmega32U4 has DFU bootloader by factory default. `FLIP` is a DFU programmer on Windows offered by Atmel. Open source command line tool `dfu-programmer` also supports AVR chips, it runs on Linux, Mac OSX and even Windows. -#### DFU bootloader To program AVR chip with DFU bootloader use `FLIP` or `dfu-programmer`. If you have a proper program command in `Makefile` just type this. -`FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial section below. +`FLIP` has two version of tool, GUI app and command line program. If you want GUI see tutorial below. To use command line tool run this command. Note that you need to set PATH variable properly. $ make -f Makefile. flip -To program with `dfu-programmer` run: +Or to program with `dfu-programmer` run: $ make -f Makefile. dfu -#### Teensy -If you have PJRC Teensy see instruction of `Teensy Loader` at: -Or use this command if you have command line version of Teensy Loader installed. - - $ make -f Makefile. teensy - - -#### Other programmer -You may want to use other you favorite programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring PROGRAM_CMD in Makefile. - - $ make -f Makefile. program - - - #### FLIP GUI tutorial 1. On menu bar click Device -> Select, then. `ATmega32u4`. 2. On menu bar click Settings -> Communication -> USB, then click 'Open' button on 'USB Port Connection' dialog. @@ -148,6 +148,22 @@ See also these instaructions if you need. - +### 3. Program with Teensy Loader +If you have PJRC Teensy see instruction of `Teensy Loader`. + +- + +Or use this command if you have command line version of Teensy Loader installed. + + $ make -f Makefile. teensy + + +### 4. Program with Other programmer +You may want to use other programmer like `avrdude` with AVRISPmkII, Aruduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile. + + $ make -f Makefile. program + + [winavr]: http://winavr.sourceforge.net/ [crosspack]: http://www.obdev.at/products/crosspack/index.html [flip]: http://www.atmel.com/tools/FLIP.aspx @@ -164,8 +180,14 @@ Makefile Options #MCU = at90usb1286 # Teensy++ 2.0 F_CPU = 16000000 + # Boot Section Size in *bytes* + # Teensy halfKay 512 + # Atmel DFU loader 4096 + # LUFA bootloader 4096 + OPT_DEFS += -DBOOTLOADER_SIZE=4096 + ### 2. Features -Note that ***comment out*** to disable them. +Optional. Note that ***comment out*** to disable them. BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000) MOUSEKEY_ENABLE = yes # Mouse keys(+4700) @@ -174,47 +196,34 @@ Note that ***comment out*** to disable them. COMMAND_ENABLE = yes # Commands for debug and configuration SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend #NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA - #PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support ### 3. Programmer -Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. +Optional. Set proper command for your controller, bootloader and programmer. This command can be used with `make program`. Not needed if you use `FLIP`, `dfu-programmer` or `Teesy Loader`. - # for PJRC Teensy - PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex - - # for Atmel chip with DFU bootloader - PROGRAM_CMD = dfu-programmer $(MCU) flash $(TARGET).hex - - # avrdude with other methods + # avrdude with AVRISPmkII PROGRAM_CMD = avrdude -p $(MCU) -c avrispmkII -P USB -U flash:w:$(TARGET).hex + + # avrdude with USBaspLoader PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex + + # avrdude with arduino PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex Config.h Options ---------------- -### 1. USB vendor/product ID and device description - #define VENDOR_ID 0xFEED - #define PRODUCT_ID 0xBEEF - /* device description */ - #define MANUFACTURER t.m.k. - #define PRODUCT Macway mod - #define DESCRIPTION t.m.k. keyboard firmware for Macway mod - -### 2. Keyboard matrix configuration - #define MATRIX_ROWS 8 - #define MATRIX_COLS 8 - #define MATRIX_HAS_GHOST - -### 3. Mouse keys - -### 4. PS/2 mouse - -### 5. COMMAND key combination +### 1. Magic command key combination #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT))) +### 2. Mechanical Locking Support for CapsLock + + /* Mechanical locking CapsLock support. Use KC_LCAP instead of KC_CAPS in keymap */ + #define CAPSLOCK_LOCKING_ENABLE + /* Locking CapsLock resynchronize hack */ + #define CAPSLOCK_LOCKING_RESYNC_ENABLE + Change your keymap ------------------ @@ -311,6 +320,20 @@ To enable this feature define these two macros in `config.h` and use `KC_LCAP` f Start Your Own Project ----------------------- **TBD** +### Config.h Options +#### 1. USB vendor/product ID and device description + #define VENDOR_ID 0xFEED + #define PRODUCT_ID 0xBEEF + /* device description */ + #define MANUFACTURER t.m.k. + #define PRODUCT Macway mod + #define DESCRIPTION t.m.k. keyboard firmware for Macway mod + +#### 2. Keyboard matrix configuration + #define MATRIX_ROWS 8 + #define MATRIX_COLS 8 + #define MATRIX_HAS_GHOST +