--- /dev/null
--- /dev/null
++.dep
++*.o
++*.eep
++*.elf
++*.hex
++*.lss
++*.lst
++*.map
++*.sym
++tags
++*~
++build/
++*.bak
--- /dev/null
--- /dev/null
++[submodule "protocol/lufa/LUFA-git"]
++ path = protocol/lufa/LUFA-git
++ url = https://github.com/abcminiuser/lufa.git
++[submodule "protocol/usb_hid/USB_Host_Shield_2.0"]
++ path = protocol/usb_hid/USB_Host_Shield_2.0
++ url = https://github.com/felis/USB_Host_Shield_2.0.git
--- /dev/null
--- /dev/null
++TMK Keyboard Firmware Collection
++================================
++This is a keyboard firmware with some useful features for Atmel AVR controller.
++
++Source code is available here: <http://github.com/tmk/tmk_keyboard>
++
++
++Features
++--------
++These features can be used in your keyboard.
++
++* Multi-layer Keymap - Multiple keyboard layouts with layer switching
++* Mouse key - Mouse control with keyboard
++* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
++* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
++* USB NKRO - 120 keys(+ 8 modifiers) simultaneously
++* PS/2 mouse support - PS/2 mouse(TrackPoint) as composite device
++* Keyboard protocols - PS/2, ADB, M0110, Sun and other old keyboard protocols
++* User Function - Customizable function of key with writing code
++* Macro - Very primitive at this time
++* Keyboard Tricks - Oneshot modifier and modifier with tapping feature
++* Debug Console - Messages for debug and interaction with firmware
++* Virtual DIP Switch - Configurations stored EEPROM(Boot Magic)
++* Locking CapsLock - Mechanical switch support for CapsLock
++* Breathing Sleep LED - Sleep indicator with charm during USB suspend
++* Backlight - Control backlight levels
++
++
++Projects
++--------
++You can find some keyboard specific projects under `converter` and `keyboard` directory.
++
++### converter
++* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
++* [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
++* [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
++* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
++* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
++* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
++* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
++* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
++* [usb_usb](converter/usb_usb/) - USB to USB(experimental)
++* [ascii_usb](converter/ascii_usb/) - ASCII(Serial console terminal) to USB
++* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard Converter][GH_ibm4704]
++
++### keyboard
++* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
++* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
++* [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
++* [hid_liber](keyboard/hid_liber/) - [HID liberation][HID_liber] controller (by alaricljs)
++* [phantom](keyboard/phantom/) - [Phantom] keyboard (by Tranquilite)
++* [IIgs_Standard](keyboard/IIgs/) - Apple [IIGS] keyboard mod(by JeffreySung)
++* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] [retired]
++* [KMAC](keyboard/kmac/) - Korean custom keyboard
++* [Lightsaber](keyboard/lightsaber/) - Korean custom keyboard
++* [Infinity](keyboard/infinity/) - Massdrop [Infinity keyboard][Infinity]
++* [NerD](keyboard/nerd/) - Korean custom keyboard
++* [KittenPaw](keyboard/kitten_paw) - Custom Majestouch controller
++* [Lightpad](keyboard/lightpad) - Korean custom keypad
++* [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt]
++
++### Extenal projects using tmk_keyboard
++* [ErgoDox_cub-uanic][cub-uanic] - Split Ergonomic Keyboard [ErgoDox][ergodox_org]
++* [mcdox][mcdox_tmk] - [mcdox][mcdox]
++
++
++[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
++[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
++[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
++[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
++[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
++[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
++[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
++[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
++[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
++[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
++[GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0
++[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
++[Phantom]: http://geekhack.org/index.php?topic=26742
++[GH60]: http://geekhack.org/index.php?topic=34959
++[GH60_proto]: http://geekhack.org/index.php?topic=37570.0
++[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
++[Sun]: http://en.wikipedia.org/wiki/Sun-3
++[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
++[Infinity]: https://www.massdrop.com/buy/infinity-keyboard-kit
++[ghost_squid]: http://deskthority.net/wiki/Costar_replacement_controllers#The_Ghost_Squid
++[cmxt]: http://gaming.coolermaster.com/en/products/keyboards/quickfirext/
++[ergodox_org]: http://ergodox.org/
++[cub-uanic]: https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox
++[mcdox]: https://github.com/DavidMcEwan/mcdox
++[mcdox_tmk]: https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox
++
++
++
++License
++-------
++**GPLv2** or later. Some protocol files are under **Modified BSD License**.
++LUFA, PJRC and V-USB stack have their own license respectively.
++
++
++
++Build Firmware and Program Controller
++-------------------------------------
++See [doc/build.md](doc/build.md).
++
++
++
++Change your keymap
++------------------
++See [doc/keymap.md](doc/keymap.md).
++
++
++
++Magic Commands
++--------------
++To see help press `Magic` + `H`.
++
++ `Magic` key bind may be `LShift` + `RShift` in many project, but `Power` key on ADB converter. `Magic` keybind can be vary on each project, check `config.h` in project directory.
++
++Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
++
++ ----- Command Help -----
++ c: enter console mode
++ d: toggle debug enable
++ x: toggle matrix debug
++ k: toggle keyboard debug
++ m: toggle mouse debug
++ v: print device version & info
++ t: print timer count
++ s: print status
++ e: print eeprom config
++ n: toggle NKRO
++ 0/F10: switch to Layer0
++ 1/F1: switch to Layer1
++ 2/F2: switch to Layer2
++ 3/F3: switch to Layer3
++ 4/F4: switch to Layer4
++ PScr: power down/remote wake-up
++ Caps: Lock Keyboard(Child Proof)
++ Paus: jump to bootloader
++
++**TBD**
++
++### Boot Magic Configuration - Virtual DIP Switch
++Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
++Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
++
++To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [common/bootmagic.h](common/bootmagic.h).
++
++#### General
++- Skip reading EEPROM to start with default configuration(`ESC`)
++- Clear configuration stored in EEPROM to reset configuration(`Backspace`)
++
++#### Bootloader
++- Kick up Bootloader(`B`)
++
++#### Debug
++- Debug enable(`D`)
++- Debug matrix enable(`D`+`X`)
++- Debug keyboard enable(`D`+`K`)
++- Debug mouse enable(`D`+`M`)
++
++#### Keymap
++- Swap Control and CapsLock(`Left Control`)
++- Change CapsLock to Control(`Caps Lock`)
++- Swap LeftAlt and Gui(`Left Alt`)
++- Swap RightAlt and Gui(`Right Alt`)
++- Disable Gui(`Left Gui`)
++- Swap Grave and Escape(`Grave`)
++- Swap BackSlash and BackSpace(`Back Slash`)
++- Enable NKRO on boot(`N`)
++
++#### Default Layer
++- Set Default Layer to 0(`0`)
++- Set Default Layer to 1(`1`)
++- Set Default Layer to 2(`2`)
++- Set Default Layer to 3(`3`)
++- Set Default Layer to 4(`4`)
++- Set Default Layer to 5(`5`)
++- Set Default Layer to 6(`6`)
++- Set Default Layer to 7(`7`)
++
++#### Caution
++Unintentional use of this feature will cause user confusion.
++
++TODO: Magic key combination to avoid unintentional press during plug in
++
++**TBD**
++
++
++Mechanical Locking support
++--------------------------
++This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state.
++
++ #define LOCKING_SUPPORT_ENABLE
++ #define LOCKING_RESYNC_ENABLE
++
++
++Start Your Own Project
++-----------------------
++**TBD**
++### Config.h Options
++#### 1. USB vendor/product ID and device description
++ #define VENDOR_ID 0xFEED
++ #define PRODUCT_ID 0xBEEF
++ #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
++
++
++
++Architecture
++------------
++ Architecture Diagram
++ +---------------+---------------+-------------+
++ | Host | Keyboard | Matrix, LED |
++ ___________ |-----------+-+ +-------------+ | +-----------|
++ / /| Keys/Mouse | Protocol |d| | Action | | | Protocol |
++ /__________/ |<-----------| LUFA |r| | Layer, Tap | | | Matrix |
++ |.--------.| | LED | V-USB |i| |-------------| | | PS/2,IBM | __________________
++ || || |----------->| PJRC |v| | Keymap | | | ADB,M0110| Keys / /_/_/_/_/_/_/_/ /|
++ || Host || | Console | iWRAP(BT)|e| | Mousekey | | | SUN/NEWS |<----------/ /_/_/_/_/_/_/_/ / /
++ ||________||/.<-----------| UART |r| | Report | | | X68K/PC98| Control / /_/_/_/_/_/_/_/ / /
++ `_========_'/| |---------------------------------------------|-------->/___ /_______/ ___/ /
++ |_o______o_|/ | Sendchar, Print, Debug, Command, ... | |_________________|/
++ +---------------------------------------------+ Keyboard
++
++
++
++Debugging
++--------
++Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
++
++You can use xprintf() to display debug info on `hid_listen`, see `common/xprintf.h`.
++
++
++
++Files and Directories
++-------------------
++### Top
++* common/ - common codes
++* protocol/ - keyboard protocol support
++* keyboard/ - keyboard projects
++* converter/ - protocol converter projects
++* doc/ - documents
++* common.mk - Makefile for common
++* protocol.mk - Makefile for protocol
++* rules.mk - Makefile for build rules
++
++### Common
++* host.h
++* host_driver.h
++* keyboard.h
++* command.h
++* keymap.h
++* action.h
++* keycode.h
++* matrix.h
++* led.h
++* mousekey.h
++* report.h
++* debug.h
++* print.h
++* bootloader.h
++* sendchar.h
++* timer.h
++* util.h
++
++### Keyboard Protocols
++* lufa/ - LUFA USB stack
++* pjrc/ - PJRC USB stack
++* vusb/ - Objective Development V-USB
++* iwrap/ - Bluetooth HID for Bluegiga iWRAP
++* ps2.c - PS/2 protocol
++* adb.c - Apple Desktop Bus protocol
++* m0110.c - Macintosh 128K/512K/Plus keyboard protocol
++* news.c - Sony NEWS keyboard protocol
++* x68k.c - Sharp X68000 keyboard protocol
++* serial_soft.c - Asynchronous Serial protocol implemented by software
++
++
++
++Coding Style
++-------------
++- Doesn't use Tab to indent, use 4-spaces instead.
++
++
++
++Other Keyboard Firmware Projects
++------------------
++You can learn a lot about keyboard firmware from these. See [doc/other_projects.md](doc/other_projects.md).
--- /dev/null
--- /dev/null
++ GNU GENERAL PUBLIC LICENSE
++ Version 2, June 1991
++
++ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
++ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
++ Everyone is permitted to copy and distribute verbatim copies
++ of this license document, but changing it is not allowed.
++
++ Preamble
++
++ The licenses for most software are designed to take away your
++freedom to share and change it. By contrast, the GNU General Public
++License is intended to guarantee your freedom to share and change free
++software--to make sure the software is free for all its users. This
++General Public License applies to most of the Free Software
++Foundation's software and to any other program whose authors commit to
++using it. (Some other Free Software Foundation software is covered by
++the GNU Lesser General Public License instead.) You can apply it to
++your programs, too.
++
++ When we speak of free software, we are referring to freedom, not
++price. Our General Public Licenses are designed to make sure that you
++have the freedom to distribute copies of free software (and charge for
++this service if you wish), that you receive source code or can get it
++if you want it, that you can change the software or use pieces of it
++in new free programs; and that you know you can do these things.
++
++ To protect your rights, we need to make restrictions that forbid
++anyone to deny you these rights or to ask you to surrender the rights.
++These restrictions translate to certain responsibilities for you if you
++distribute copies of the software, or if you modify it.
++
++ For example, if you distribute copies of such a program, whether
++gratis or for a fee, you must give the recipients all the rights that
++you have. You must make sure that they, too, receive or can get the
++source code. And you must show them these terms so they know their
++rights.
++
++ We protect your rights with two steps: (1) copyright the software, and
++(2) offer you this license which gives you legal permission to copy,
++distribute and/or modify the software.
++
++ Also, for each author's protection and ours, we want to make certain
++that everyone understands that there is no warranty for this free
++software. If the software is modified by someone else and passed on, we
++want its recipients to know that what they have is not the original, so
++that any problems introduced by others will not reflect on the original
++authors' reputations.
++
++ Finally, any free program is threatened constantly by software
++patents. We wish to avoid the danger that redistributors of a free
++program will individually obtain patent licenses, in effect making the
++program proprietary. To prevent this, we have made it clear that any
++patent must be licensed for everyone's free use or not licensed at all.
++
++ The precise terms and conditions for copying, distribution and
++modification follow.
++
++ GNU GENERAL PUBLIC LICENSE
++ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
++
++ 0. This License applies to any program or other work which contains
++a notice placed by the copyright holder saying it may be distributed
++under the terms of this General Public License. The "Program", below,
++refers to any such program or work, and a "work based on the Program"
++means either the Program or any derivative work under copyright law:
++that is to say, a work containing the Program or a portion of it,
++either verbatim or with modifications and/or translated into another
++language. (Hereinafter, translation is included without limitation in
++the term "modification".) Each licensee is addressed as "you".
++
++Activities other than copying, distribution and modification are not
++covered by this License; they are outside its scope. The act of
++running the Program is not restricted, and the output from the Program
++is covered only if its contents constitute a work based on the
++Program (independent of having been made by running the Program).
++Whether that is true depends on what the Program does.
++
++ 1. You may copy and distribute verbatim copies of the Program's
++source code as you receive it, in any medium, provided that you
++conspicuously and appropriately publish on each copy an appropriate
++copyright notice and disclaimer of warranty; keep intact all the
++notices that refer to this License and to the absence of any warranty;
++and give any other recipients of the Program a copy of this License
++along with the Program.
++
++You may charge a fee for the physical act of transferring a copy, and
++you may at your option offer warranty protection in exchange for a fee.
++
++ 2. You may modify your copy or copies of the Program or any portion
++of it, thus forming a work based on the Program, and copy and
++distribute such modifications or work under the terms of Section 1
++above, provided that you also meet all of these conditions:
++
++ a) You must cause the modified files to carry prominent notices
++ stating that you changed the files and the date of any change.
++
++ b) You must cause any work that you distribute or publish, that in
++ whole or in part contains or is derived from the Program or any
++ part thereof, to be licensed as a whole at no charge to all third
++ parties under the terms of this License.
++
++ c) If the modified program normally reads commands interactively
++ when run, you must cause it, when started running for such
++ interactive use in the most ordinary way, to print or display an
++ announcement including an appropriate copyright notice and a
++ notice that there is no warranty (or else, saying that you provide
++ a warranty) and that users may redistribute the program under
++ these conditions, and telling the user how to view a copy of this
++ License. (Exception: if the Program itself is interactive but
++ does not normally print such an announcement, your work based on
++ the Program is not required to print an announcement.)
++
++These requirements apply to the modified work as a whole. If
++identifiable sections of that work are not derived from the Program,
++and can be reasonably considered independent and separate works in
++themselves, then this License, and its terms, do not apply to those
++sections when you distribute them as separate works. But when you
++distribute the same sections as part of a whole which is a work based
++on the Program, the distribution of the whole must be on the terms of
++this License, whose permissions for other licensees extend to the
++entire whole, and thus to each and every part regardless of who wrote it.
++
++Thus, it is not the intent of this section to claim rights or contest
++your rights to work written entirely by you; rather, the intent is to
++exercise the right to control the distribution of derivative or
++collective works based on the Program.
++
++In addition, mere aggregation of another work not based on the Program
++with the Program (or with a work based on the Program) on a volume of
++a storage or distribution medium does not bring the other work under
++the scope of this License.
++
++ 3. You may copy and distribute the Program (or a work based on it,
++under Section 2) in object code or executable form under the terms of
++Sections 1 and 2 above provided that you also do one of the following:
++
++ a) Accompany it with the complete corresponding machine-readable
++ source code, which must be distributed under the terms of Sections
++ 1 and 2 above on a medium customarily used for software interchange; or,
++
++ b) Accompany it with a written offer, valid for at least three
++ years, to give any third party, for a charge no more than your
++ cost of physically performing source distribution, a complete
++ machine-readable copy of the corresponding source code, to be
++ distributed under the terms of Sections 1 and 2 above on a medium
++ customarily used for software interchange; or,
++
++ c) Accompany it with the information you received as to the offer
++ to distribute corresponding source code. (This alternative is
++ allowed only for noncommercial distribution and only if you
++ received the program in object code or executable form with such
++ an offer, in accord with Subsection b above.)
++
++The source code for a work means the preferred form of the work for
++making modifications to it. For an executable work, complete source
++code means all the source code for all modules it contains, plus any
++associated interface definition files, plus the scripts used to
++control compilation and installation of the executable. However, as a
++special exception, the source code distributed need not include
++anything that is normally distributed (in either source or binary
++form) with the major components (compiler, kernel, and so on) of the
++operating system on which the executable runs, unless that component
++itself accompanies the executable.
++
++If distribution of executable or object code is made by offering
++access to copy from a designated place, then offering equivalent
++access to copy the source code from the same place counts as
++distribution of the source code, even though third parties are not
++compelled to copy the source along with the object code.
++
++ 4. You may not copy, modify, sublicense, or distribute the Program
++except as expressly provided under this License. Any attempt
++otherwise to copy, modify, sublicense or distribute the Program is
++void, and will automatically terminate your rights under this License.
++However, parties who have received copies, or rights, from you under
++this License will not have their licenses terminated so long as such
++parties remain in full compliance.
++
++ 5. You are not required to accept this License, since you have not
++signed it. However, nothing else grants you permission to modify or
++distribute the Program or its derivative works. These actions are
++prohibited by law if you do not accept this License. Therefore, by
++modifying or distributing the Program (or any work based on the
++Program), you indicate your acceptance of this License to do so, and
++all its terms and conditions for copying, distributing or modifying
++the Program or works based on it.
++
++ 6. Each time you redistribute the Program (or any work based on the
++Program), the recipient automatically receives a license from the
++original licensor to copy, distribute or modify the Program subject to
++these terms and conditions. You may not impose any further
++restrictions on the recipients' exercise of the rights granted herein.
++You are not responsible for enforcing compliance by third parties to
++this License.
++
++ 7. If, as a consequence of a court judgment or allegation of patent
++infringement or for any other reason (not limited to patent issues),
++conditions are imposed on you (whether by court order, agreement or
++otherwise) that contradict the conditions of this License, they do not
++excuse you from the conditions of this License. If you cannot
++distribute so as to satisfy simultaneously your obligations under this
++License and any other pertinent obligations, then as a consequence you
++may not distribute the Program at all. For example, if a patent
++license would not permit royalty-free redistribution of the Program by
++all those who receive copies directly or indirectly through you, then
++the only way you could satisfy both it and this License would be to
++refrain entirely from distribution of the Program.
++
++If any portion of this section is held invalid or unenforceable under
++any particular circumstance, the balance of the section is intended to
++apply and the section as a whole is intended to apply in other
++circumstances.
++
++It is not the purpose of this section to induce you to infringe any
++patents or other property right claims or to contest validity of any
++such claims; this section has the sole purpose of protecting the
++integrity of the free software distribution system, which is
++implemented by public license practices. Many people have made
++generous contributions to the wide range of software distributed
++through that system in reliance on consistent application of that
++system; it is up to the author/donor to decide if he or she is willing
++to distribute software through any other system and a licensee cannot
++impose that choice.
++
++This section is intended to make thoroughly clear what is believed to
++be a consequence of the rest of this License.
++
++ 8. If the distribution and/or use of the Program is restricted in
++certain countries either by patents or by copyrighted interfaces, the
++original copyright holder who places the Program under this License
++may add an explicit geographical distribution limitation excluding
++those countries, so that distribution is permitted only in or among
++countries not thus excluded. In such case, this License incorporates
++the limitation as if written in the body of this License.
++
++ 9. The Free Software Foundation may publish revised and/or new versions
++of the General Public License from time to time. Such new versions will
++be similar in spirit to the present version, but may differ in detail to
++address new problems or concerns.
++
++Each version is given a distinguishing version number. If the Program
++specifies a version number of this License which applies to it and "any
++later version", you have the option of following the terms and conditions
++either of that version or of any later version published by the Free
++Software Foundation. If the Program does not specify a version number of
++this License, you may choose any version ever published by the Free Software
++Foundation.
++
++ 10. If you wish to incorporate parts of the Program into other free
++programs whose distribution conditions are different, write to the author
++to ask for permission. For software which is copyrighted by the Free
++Software Foundation, write to the Free Software Foundation; we sometimes
++make exceptions for this. Our decision will be guided by the two goals
++of preserving the free status of all derivatives of our free software and
++of promoting the sharing and reuse of software generally.
++
++ NO WARRANTY
++
++ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
++FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
++OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
++PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
++OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
++MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
++TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
++PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
++REPAIR OR CORRECTION.
++
++ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
++WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
++REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
++INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
++OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
++TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
++YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
++PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
++POSSIBILITY OF SUCH DAMAGES.
++
++ END OF TERMS AND CONDITIONS
++
++ How to Apply These Terms to Your New Programs
++
++ If you develop a new program, and you want it to be of the greatest
++possible use to the public, the best way to achieve this is to make it
++free software which everyone can redistribute and change under these terms.
++
++ To do so, attach the following notices to the program. It is safest
++to attach them to the start of each source file to most effectively
++convey the exclusion of warranty; and each file should have at least
++the "copyright" line and a pointer to where the full notice is found.
++
++ <one line to give the program's name and a brief idea of what it does.>
++ Copyright (C) <year> <name of author>
++
++ This program is free software; you can redistribute it and/or modify
++ it under the terms of the GNU General Public License as published by
++ the Free Software Foundation; either version 2 of the License, or
++ (at your option) any later version.
++
++ This program is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++
++ You should have received a copy of the GNU General Public License along
++ with this program; if not, write to the Free Software Foundation, Inc.,
++ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
++
++Also add information on how to contact you by electronic and paper mail.
++
++If the program is interactive, make it output a short notice like this
++when it starts in an interactive mode:
++
++ Gnomovision version 69, Copyright (C) year name of author
++ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
++ This is free software, and you are welcome to redistribute it
++ under certain conditions; type `show c' for details.
++
++The hypothetical commands `show w' and `show c' should show the appropriate
++parts of the General Public License. Of course, the commands you use may
++be called something other than `show w' and `show c'; they could even be
++mouse-clicks or menu items--whatever suits your program.
++
++You should also get your employer (if you work as a programmer) or your
++school, if any, to sign a "copyright disclaimer" for the program, if
++necessary. Here is a sample; alter the names:
++
++ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
++ `Gnomovision' (which makes passes at compilers) written by James Hacker.
++
++ <signature of Ty Coon>, 1 April 1989
++ Ty Coon, President of Vice
++
++This General Public License does not permit incorporating your program into
++proprietary programs. If your program is a subroutine library, you may
++consider it more useful to permit linking proprietary applications with the
++library. If this is what you want to do, use the GNU Lesser General
++Public License instead of this License.
--- /dev/null
--- /dev/null
++ GNU GENERAL PUBLIC LICENSE
++ Version 3, 29 June 2007
++
++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
++ Everyone is permitted to copy and distribute verbatim copies
++ of this license document, but changing it is not allowed.
++
++ Preamble
++
++ The GNU General Public License is a free, copyleft license for
++software and other kinds of works.
++
++ The licenses for most software and other practical works are designed
++to take away your freedom to share and change the works. By contrast,
++the GNU General Public License is intended to guarantee your freedom to
++share and change all versions of a program--to make sure it remains free
++software for all its users. We, the Free Software Foundation, use the
++GNU General Public License for most of our software; it applies also to
++any other work released this way by its authors. You can apply it to
++your programs, too.
++
++ When we speak of free software, we are referring to freedom, not
++price. Our General Public Licenses are designed to make sure that you
++have the freedom to distribute copies of free software (and charge for
++them if you wish), that you receive source code or can get it if you
++want it, that you can change the software or use pieces of it in new
++free programs, and that you know you can do these things.
++
++ To protect your rights, we need to prevent others from denying you
++these rights or asking you to surrender the rights. Therefore, you have
++certain responsibilities if you distribute copies of the software, or if
++you modify it: responsibilities to respect the freedom of others.
++
++ For example, if you distribute copies of such a program, whether
++gratis or for a fee, you must pass on to the recipients the same
++freedoms that you received. You must make sure that they, too, receive
++or can get the source code. And you must show them these terms so they
++know their rights.
++
++ Developers that use the GNU GPL protect your rights with two steps:
++(1) assert copyright on the software, and (2) offer you this License
++giving you legal permission to copy, distribute and/or modify it.
++
++ For the developers' and authors' protection, the GPL clearly explains
++that there is no warranty for this free software. For both users' and
++authors' sake, the GPL requires that modified versions be marked as
++changed, so that their problems will not be attributed erroneously to
++authors of previous versions.
++
++ Some devices are designed to deny users access to install or run
++modified versions of the software inside them, although the manufacturer
++can do so. This is fundamentally incompatible with the aim of
++protecting users' freedom to change the software. The systematic
++pattern of such abuse occurs in the area of products for individuals to
++use, which is precisely where it is most unacceptable. Therefore, we
++have designed this version of the GPL to prohibit the practice for those
++products. If such problems arise substantially in other domains, we
++stand ready to extend this provision to those domains in future versions
++of the GPL, as needed to protect the freedom of users.
++
++ Finally, every program is threatened constantly by software patents.
++States should not allow patents to restrict development and use of
++software on general-purpose computers, but in those that do, we wish to
++avoid the special danger that patents applied to a free program could
++make it effectively proprietary. To prevent this, the GPL assures that
++patents cannot be used to render the program non-free.
++
++ The precise terms and conditions for copying, distribution and
++modification follow.
++
++ TERMS AND CONDITIONS
++
++ 0. Definitions.
++
++ "This License" refers to version 3 of the GNU General Public License.
++
++ "Copyright" also means copyright-like laws that apply to other kinds of
++works, such as semiconductor masks.
++
++ "The Program" refers to any copyrightable work licensed under this
++License. Each licensee is addressed as "you". "Licensees" and
++"recipients" may be individuals or organizations.
++
++ To "modify" a work means to copy from or adapt all or part of the work
++in a fashion requiring copyright permission, other than the making of an
++exact copy. The resulting work is called a "modified version" of the
++earlier work or a work "based on" the earlier work.
++
++ A "covered work" means either the unmodified Program or a work based
++on the Program.
++
++ To "propagate" a work means to do anything with it that, without
++permission, would make you directly or secondarily liable for
++infringement under applicable copyright law, except executing it on a
++computer or modifying a private copy. Propagation includes copying,
++distribution (with or without modification), making available to the
++public, and in some countries other activities as well.
++
++ To "convey" a work means any kind of propagation that enables other
++parties to make or receive copies. Mere interaction with a user through
++a computer network, with no transfer of a copy, is not conveying.
++
++ An interactive user interface displays "Appropriate Legal Notices"
++to the extent that it includes a convenient and prominently visible
++feature that (1) displays an appropriate copyright notice, and (2)
++tells the user that there is no warranty for the work (except to the
++extent that warranties are provided), that licensees may convey the
++work under this License, and how to view a copy of this License. If
++the interface presents a list of user commands or options, such as a
++menu, a prominent item in the list meets this criterion.
++
++ 1. Source Code.
++
++ The "source code" for a work means the preferred form of the work
++for making modifications to it. "Object code" means any non-source
++form of a work.
++
++ A "Standard Interface" means an interface that either is an official
++standard defined by a recognized standards body, or, in the case of
++interfaces specified for a particular programming language, one that
++is widely used among developers working in that language.
++
++ The "System Libraries" of an executable work include anything, other
++than the work as a whole, that (a) is included in the normal form of
++packaging a Major Component, but which is not part of that Major
++Component, and (b) serves only to enable use of the work with that
++Major Component, or to implement a Standard Interface for which an
++implementation is available to the public in source code form. A
++"Major Component", in this context, means a major essential component
++(kernel, window system, and so on) of the specific operating system
++(if any) on which the executable work runs, or a compiler used to
++produce the work, or an object code interpreter used to run it.
++
++ The "Corresponding Source" for a work in object code form means all
++the source code needed to generate, install, and (for an executable
++work) run the object code and to modify the work, including scripts to
++control those activities. However, it does not include the work's
++System Libraries, or general-purpose tools or generally available free
++programs which are used unmodified in performing those activities but
++which are not part of the work. For example, Corresponding Source
++includes interface definition files associated with source files for
++the work, and the source code for shared libraries and dynamically
++linked subprograms that the work is specifically designed to require,
++such as by intimate data communication or control flow between those
++subprograms and other parts of the work.
++
++ The Corresponding Source need not include anything that users
++can regenerate automatically from other parts of the Corresponding
++Source.
++
++ The Corresponding Source for a work in source code form is that
++same work.
++
++ 2. Basic Permissions.
++
++ All rights granted under this License are granted for the term of
++copyright on the Program, and are irrevocable provided the stated
++conditions are met. This License explicitly affirms your unlimited
++permission to run the unmodified Program. The output from running a
++covered work is covered by this License only if the output, given its
++content, constitutes a covered work. This License acknowledges your
++rights of fair use or other equivalent, as provided by copyright law.
++
++ You may make, run and propagate covered works that you do not
++convey, without conditions so long as your license otherwise remains
++in force. You may convey covered works to others for the sole purpose
++of having them make modifications exclusively for you, or provide you
++with facilities for running those works, provided that you comply with
++the terms of this License in conveying all material for which you do
++not control copyright. Those thus making or running the covered works
++for you must do so exclusively on your behalf, under your direction
++and control, on terms that prohibit them from making any copies of
++your copyrighted material outside their relationship with you.
++
++ Conveying under any other circumstances is permitted solely under
++the conditions stated below. Sublicensing is not allowed; section 10
++makes it unnecessary.
++
++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
++
++ No covered work shall be deemed part of an effective technological
++measure under any applicable law fulfilling obligations under article
++11 of the WIPO copyright treaty adopted on 20 December 1996, or
++similar laws prohibiting or restricting circumvention of such
++measures.
++
++ When you convey a covered work, you waive any legal power to forbid
++circumvention of technological measures to the extent such circumvention
++is effected by exercising rights under this License with respect to
++the covered work, and you disclaim any intention to limit operation or
++modification of the work as a means of enforcing, against the work's
++users, your or third parties' legal rights to forbid circumvention of
++technological measures.
++
++ 4. Conveying Verbatim Copies.
++
++ You may convey verbatim copies of the Program's source code as you
++receive it, in any medium, provided that you conspicuously and
++appropriately publish on each copy an appropriate copyright notice;
++keep intact all notices stating that this License and any
++non-permissive terms added in accord with section 7 apply to the code;
++keep intact all notices of the absence of any warranty; and give all
++recipients a copy of this License along with the Program.
++
++ You may charge any price or no price for each copy that you convey,
++and you may offer support or warranty protection for a fee.
++
++ 5. Conveying Modified Source Versions.
++
++ You may convey a work based on the Program, or the modifications to
++produce it from the Program, in the form of source code under the
++terms of section 4, provided that you also meet all of these conditions:
++
++ a) The work must carry prominent notices stating that you modified
++ it, and giving a relevant date.
++
++ b) The work must carry prominent notices stating that it is
++ released under this License and any conditions added under section
++ 7. This requirement modifies the requirement in section 4 to
++ "keep intact all notices".
++
++ c) You must license the entire work, as a whole, under this
++ License to anyone who comes into possession of a copy. This
++ License will therefore apply, along with any applicable section 7
++ additional terms, to the whole of the work, and all its parts,
++ regardless of how they are packaged. This License gives no
++ permission to license the work in any other way, but it does not
++ invalidate such permission if you have separately received it.
++
++ d) If the work has interactive user interfaces, each must display
++ Appropriate Legal Notices; however, if the Program has interactive
++ interfaces that do not display Appropriate Legal Notices, your
++ work need not make them do so.
++
++ A compilation of a covered work with other separate and independent
++works, which are not by their nature extensions of the covered work,
++and which are not combined with it such as to form a larger program,
++in or on a volume of a storage or distribution medium, is called an
++"aggregate" if the compilation and its resulting copyright are not
++used to limit the access or legal rights of the compilation's users
++beyond what the individual works permit. Inclusion of a covered work
++in an aggregate does not cause this License to apply to the other
++parts of the aggregate.
++
++ 6. Conveying Non-Source Forms.
++
++ You may convey a covered work in object code form under the terms
++of sections 4 and 5, provided that you also convey the
++machine-readable Corresponding Source under the terms of this License,
++in one of these ways:
++
++ a) Convey the object code in, or embodied in, a physical product
++ (including a physical distribution medium), accompanied by the
++ Corresponding Source fixed on a durable physical medium
++ customarily used for software interchange.
++
++ b) Convey the object code in, or embodied in, a physical product
++ (including a physical distribution medium), accompanied by a
++ written offer, valid for at least three years and valid for as
++ long as you offer spare parts or customer support for that product
++ model, to give anyone who possesses the object code either (1) a
++ copy of the Corresponding Source for all the software in the
++ product that is covered by this License, on a durable physical
++ medium customarily used for software interchange, for a price no
++ more than your reasonable cost of physically performing this
++ conveying of source, or (2) access to copy the
++ Corresponding Source from a network server at no charge.
++
++ c) Convey individual copies of the object code with a copy of the
++ written offer to provide the Corresponding Source. This
++ alternative is allowed only occasionally and noncommercially, and
++ only if you received the object code with such an offer, in accord
++ with subsection 6b.
++
++ d) Convey the object code by offering access from a designated
++ place (gratis or for a charge), and offer equivalent access to the
++ Corresponding Source in the same way through the same place at no
++ further charge. You need not require recipients to copy the
++ Corresponding Source along with the object code. If the place to
++ copy the object code is a network server, the Corresponding Source
++ may be on a different server (operated by you or a third party)
++ that supports equivalent copying facilities, provided you maintain
++ clear directions next to the object code saying where to find the
++ Corresponding Source. Regardless of what server hosts the
++ Corresponding Source, you remain obligated to ensure that it is
++ available for as long as needed to satisfy these requirements.
++
++ e) Convey the object code using peer-to-peer transmission, provided
++ you inform other peers where the object code and Corresponding
++ Source of the work are being offered to the general public at no
++ charge under subsection 6d.
++
++ A separable portion of the object code, whose source code is excluded
++from the Corresponding Source as a System Library, need not be
++included in conveying the object code work.
++
++ A "User Product" is either (1) a "consumer product", which means any
++tangible personal property which is normally used for personal, family,
++or household purposes, or (2) anything designed or sold for incorporation
++into a dwelling. In determining whether a product is a consumer product,
++doubtful cases shall be resolved in favor of coverage. For a particular
++product received by a particular user, "normally used" refers to a
++typical or common use of that class of product, regardless of the status
++of the particular user or of the way in which the particular user
++actually uses, or expects or is expected to use, the product. A product
++is a consumer product regardless of whether the product has substantial
++commercial, industrial or non-consumer uses, unless such uses represent
++the only significant mode of use of the product.
++
++ "Installation Information" for a User Product means any methods,
++procedures, authorization keys, or other information required to install
++and execute modified versions of a covered work in that User Product from
++a modified version of its Corresponding Source. The information must
++suffice to ensure that the continued functioning of the modified object
++code is in no case prevented or interfered with solely because
++modification has been made.
++
++ If you convey an object code work under this section in, or with, or
++specifically for use in, a User Product, and the conveying occurs as
++part of a transaction in which the right of possession and use of the
++User Product is transferred to the recipient in perpetuity or for a
++fixed term (regardless of how the transaction is characterized), the
++Corresponding Source conveyed under this section must be accompanied
++by the Installation Information. But this requirement does not apply
++if neither you nor any third party retains the ability to install
++modified object code on the User Product (for example, the work has
++been installed in ROM).
++
++ The requirement to provide Installation Information does not include a
++requirement to continue to provide support service, warranty, or updates
++for a work that has been modified or installed by the recipient, or for
++the User Product in which it has been modified or installed. Access to a
++network may be denied when the modification itself materially and
++adversely affects the operation of the network or violates the rules and
++protocols for communication across the network.
++
++ Corresponding Source conveyed, and Installation Information provided,
++in accord with this section must be in a format that is publicly
++documented (and with an implementation available to the public in
++source code form), and must require no special password or key for
++unpacking, reading or copying.
++
++ 7. Additional Terms.
++
++ "Additional permissions" are terms that supplement the terms of this
++License by making exceptions from one or more of its conditions.
++Additional permissions that are applicable to the entire Program shall
++be treated as though they were included in this License, to the extent
++that they are valid under applicable law. If additional permissions
++apply only to part of the Program, that part may be used separately
++under those permissions, but the entire Program remains governed by
++this License without regard to the additional permissions.
++
++ When you convey a copy of a covered work, you may at your option
++remove any additional permissions from that copy, or from any part of
++it. (Additional permissions may be written to require their own
++removal in certain cases when you modify the work.) You may place
++additional permissions on material, added by you to a covered work,
++for which you have or can give appropriate copyright permission.
++
++ Notwithstanding any other provision of this License, for material you
++add to a covered work, you may (if authorized by the copyright holders of
++that material) supplement the terms of this License with terms:
++
++ a) Disclaiming warranty or limiting liability differently from the
++ terms of sections 15 and 16 of this License; or
++
++ b) Requiring preservation of specified reasonable legal notices or
++ author attributions in that material or in the Appropriate Legal
++ Notices displayed by works containing it; or
++
++ c) Prohibiting misrepresentation of the origin of that material, or
++ requiring that modified versions of such material be marked in
++ reasonable ways as different from the original version; or
++
++ d) Limiting the use for publicity purposes of names of licensors or
++ authors of the material; or
++
++ e) Declining to grant rights under trademark law for use of some
++ trade names, trademarks, or service marks; or
++
++ f) Requiring indemnification of licensors and authors of that
++ material by anyone who conveys the material (or modified versions of
++ it) with contractual assumptions of liability to the recipient, for
++ any liability that these contractual assumptions directly impose on
++ those licensors and authors.
++
++ All other non-permissive additional terms are considered "further
++restrictions" within the meaning of section 10. If the Program as you
++received it, or any part of it, contains a notice stating that it is
++governed by this License along with a term that is a further
++restriction, you may remove that term. If a license document contains
++a further restriction but permits relicensing or conveying under this
++License, you may add to a covered work material governed by the terms
++of that license document, provided that the further restriction does
++not survive such relicensing or conveying.
++
++ If you add terms to a covered work in accord with this section, you
++must place, in the relevant source files, a statement of the
++additional terms that apply to those files, or a notice indicating
++where to find the applicable terms.
++
++ Additional terms, permissive or non-permissive, may be stated in the
++form of a separately written license, or stated as exceptions;
++the above requirements apply either way.
++
++ 8. Termination.
++
++ You may not propagate or modify a covered work except as expressly
++provided under this License. Any attempt otherwise to propagate or
++modify it is void, and will automatically terminate your rights under
++this License (including any patent licenses granted under the third
++paragraph of section 11).
++
++ However, if you cease all violation of this License, then your
++license from a particular copyright holder is reinstated (a)
++provisionally, unless and until the copyright holder explicitly and
++finally terminates your license, and (b) permanently, if the copyright
++holder fails to notify you of the violation by some reasonable means
++prior to 60 days after the cessation.
++
++ Moreover, your license from a particular copyright holder is
++reinstated permanently if the copyright holder notifies you of the
++violation by some reasonable means, this is the first time you have
++received notice of violation of this License (for any work) from that
++copyright holder, and you cure the violation prior to 30 days after
++your receipt of the notice.
++
++ Termination of your rights under this section does not terminate the
++licenses of parties who have received copies or rights from you under
++this License. If your rights have been terminated and not permanently
++reinstated, you do not qualify to receive new licenses for the same
++material under section 10.
++
++ 9. Acceptance Not Required for Having Copies.
++
++ You are not required to accept this License in order to receive or
++run a copy of the Program. Ancillary propagation of a covered work
++occurring solely as a consequence of using peer-to-peer transmission
++to receive a copy likewise does not require acceptance. However,
++nothing other than this License grants you permission to propagate or
++modify any covered work. These actions infringe copyright if you do
++not accept this License. Therefore, by modifying or propagating a
++covered work, you indicate your acceptance of this License to do so.
++
++ 10. Automatic Licensing of Downstream Recipients.
++
++ Each time you convey a covered work, the recipient automatically
++receives a license from the original licensors, to run, modify and
++propagate that work, subject to this License. You are not responsible
++for enforcing compliance by third parties with this License.
++
++ An "entity transaction" is a transaction transferring control of an
++organization, or substantially all assets of one, or subdividing an
++organization, or merging organizations. If propagation of a covered
++work results from an entity transaction, each party to that
++transaction who receives a copy of the work also receives whatever
++licenses to the work the party's predecessor in interest had or could
++give under the previous paragraph, plus a right to possession of the
++Corresponding Source of the work from the predecessor in interest, if
++the predecessor has it or can get it with reasonable efforts.
++
++ You may not impose any further restrictions on the exercise of the
++rights granted or affirmed under this License. For example, you may
++not impose a license fee, royalty, or other charge for exercise of
++rights granted under this License, and you may not initiate litigation
++(including a cross-claim or counterclaim in a lawsuit) alleging that
++any patent claim is infringed by making, using, selling, offering for
++sale, or importing the Program or any portion of it.
++
++ 11. Patents.
++
++ A "contributor" is a copyright holder who authorizes use under this
++License of the Program or a work on which the Program is based. The
++work thus licensed is called the contributor's "contributor version".
++
++ A contributor's "essential patent claims" are all patent claims
++owned or controlled by the contributor, whether already acquired or
++hereafter acquired, that would be infringed by some manner, permitted
++by this License, of making, using, or selling its contributor version,
++but do not include claims that would be infringed only as a
++consequence of further modification of the contributor version. For
++purposes of this definition, "control" includes the right to grant
++patent sublicenses in a manner consistent with the requirements of
++this License.
++
++ Each contributor grants you a non-exclusive, worldwide, royalty-free
++patent license under the contributor's essential patent claims, to
++make, use, sell, offer for sale, import and otherwise run, modify and
++propagate the contents of its contributor version.
++
++ In the following three paragraphs, a "patent license" is any express
++agreement or commitment, however denominated, not to enforce a patent
++(such as an express permission to practice a patent or covenant not to
++sue for patent infringement). To "grant" such a patent license to a
++party means to make such an agreement or commitment not to enforce a
++patent against the party.
++
++ If you convey a covered work, knowingly relying on a patent license,
++and the Corresponding Source of the work is not available for anyone
++to copy, free of charge and under the terms of this License, through a
++publicly available network server or other readily accessible means,
++then you must either (1) cause the Corresponding Source to be so
++available, or (2) arrange to deprive yourself of the benefit of the
++patent license for this particular work, or (3) arrange, in a manner
++consistent with the requirements of this License, to extend the patent
++license to downstream recipients. "Knowingly relying" means you have
++actual knowledge that, but for the patent license, your conveying the
++covered work in a country, or your recipient's use of the covered work
++in a country, would infringe one or more identifiable patents in that
++country that you have reason to believe are valid.
++
++ If, pursuant to or in connection with a single transaction or
++arrangement, you convey, or propagate by procuring conveyance of, a
++covered work, and grant a patent license to some of the parties
++receiving the covered work authorizing them to use, propagate, modify
++or convey a specific copy of the covered work, then the patent license
++you grant is automatically extended to all recipients of the covered
++work and works based on it.
++
++ A patent license is "discriminatory" if it does not include within
++the scope of its coverage, prohibits the exercise of, or is
++conditioned on the non-exercise of one or more of the rights that are
++specifically granted under this License. You may not convey a covered
++work if you are a party to an arrangement with a third party that is
++in the business of distributing software, under which you make payment
++to the third party based on the extent of your activity of conveying
++the work, and under which the third party grants, to any of the
++parties who would receive the covered work from you, a discriminatory
++patent license (a) in connection with copies of the covered work
++conveyed by you (or copies made from those copies), or (b) primarily
++for and in connection with specific products or compilations that
++contain the covered work, unless you entered into that arrangement,
++or that patent license was granted, prior to 28 March 2007.
++
++ Nothing in this License shall be construed as excluding or limiting
++any implied license or other defenses to infringement that may
++otherwise be available to you under applicable patent law.
++
++ 12. No Surrender of Others' Freedom.
++
++ If conditions are imposed on you (whether by court order, agreement or
++otherwise) that contradict the conditions of this License, they do not
++excuse you from the conditions of this License. If you cannot convey a
++covered work so as to satisfy simultaneously your obligations under this
++License and any other pertinent obligations, then as a consequence you may
++not convey it at all. For example, if you agree to terms that obligate you
++to collect a royalty for further conveying from those to whom you convey
++the Program, the only way you could satisfy both those terms and this
++License would be to refrain entirely from conveying the Program.
++
++ 13. Use with the GNU Affero General Public License.
++
++ Notwithstanding any other provision of this License, you have
++permission to link or combine any covered work with a work licensed
++under version 3 of the GNU Affero General Public License into a single
++combined work, and to convey the resulting work. The terms of this
++License will continue to apply to the part which is the covered work,
++but the special requirements of the GNU Affero General Public License,
++section 13, concerning interaction through a network will apply to the
++combination as such.
++
++ 14. Revised Versions of this License.
++
++ The Free Software Foundation may publish revised and/or new versions of
++the GNU General Public License from time to time. Such new versions will
++be similar in spirit to the present version, but may differ in detail to
++address new problems or concerns.
++
++ Each version is given a distinguishing version number. If the
++Program specifies that a certain numbered version of the GNU General
++Public License "or any later version" applies to it, you have the
++option of following the terms and conditions either of that numbered
++version or of any later version published by the Free Software
++Foundation. If the Program does not specify a version number of the
++GNU General Public License, you may choose any version ever published
++by the Free Software Foundation.
++
++ If the Program specifies that a proxy can decide which future
++versions of the GNU General Public License can be used, that proxy's
++public statement of acceptance of a version permanently authorizes you
++to choose that version for the Program.
++
++ Later license versions may give you additional or different
++permissions. However, no additional obligations are imposed on any
++author or copyright holder as a result of your choosing to follow a
++later version.
++
++ 15. Disclaimer of Warranty.
++
++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
++APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
++HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
++OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
++THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
++PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
++IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
++ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
++
++ 16. Limitation of Liability.
++
++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
++WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
++THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
++GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
++USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
++DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
++PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
++EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
++SUCH DAMAGES.
++
++ 17. Interpretation of Sections 15 and 16.
++
++ If the disclaimer of warranty and limitation of liability provided
++above cannot be given local legal effect according to their terms,
++reviewing courts shall apply local law that most closely approximates
++an absolute waiver of all civil liability in connection with the
++Program, unless a warranty or assumption of liability accompanies a
++copy of the Program in return for a fee.
++
++ END OF TERMS AND CONDITIONS
++
++ How to Apply These Terms to Your New Programs
++
++ If you develop a new program, and you want it to be of the greatest
++possible use to the public, the best way to achieve this is to make it
++free software which everyone can redistribute and change under these terms.
++
++ To do so, attach the following notices to the program. It is safest
++to attach them to the start of each source file to most effectively
++state the exclusion of warranty; and each file should have at least
++the "copyright" line and a pointer to where the full notice is found.
++
++ <one line to give the program's name and a brief idea of what it does.>
++ Copyright (C) <year> <name of author>
++
++ This program is free software: you can redistribute it and/or modify
++ it under the terms of the GNU General Public License as published by
++ the Free Software Foundation, either version 3 of the License, or
++ (at your option) any later version.
++
++ This program is distributed in the hope that it will be useful,
++ but WITHOUT ANY WARRANTY; without even the implied warranty of
++ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
++ GNU General Public License for more details.
++
++ You should have received a copy of the GNU General Public License
++ along with this program. If not, see <http://www.gnu.org/licenses/>.
++
++Also add information on how to contact you by electronic and paper mail.
++
++ If the program does terminal interaction, make it output a short
++notice like this when it starts in an interactive mode:
++
++ <program> Copyright (C) <year> <name of author>
++ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
++ This is free software, and you are welcome to redistribute it
++ under certain conditions; type `show c' for details.
++
++The hypothetical commands `show w' and `show c' should show the appropriate
++parts of the General Public License. Of course, your program's commands
++might be different; for a GUI interface, you would use an "about box".
++
++ You should also get your employer (if you work as a programmer) or school,
++if any, to sign a "copyright disclaimer" for the program, if necessary.
++For more information on this, and how to apply and follow the GNU GPL, see
++<http://www.gnu.org/licenses/>.
++
++ The GNU General Public License does not permit incorporating your program
++into proprietary programs. If your program is a subroutine library, you
++may consider it more useful to permit linking proprietary applications with
++the library. If this is what you want to do, use the GNU Lesser General
++Public License instead of this License. But first, please read
++<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null
--- /dev/null
++ATMega168P Fuse/Lock Bits
++=========================
++This configuration is from usbasploader's Makefile.
++
++ HFUSE 0xD6
++ LFUSE 0xDF
++ EFUSE 0x00
++ LOCK 0x3F(intact)
++
++#---------------------------------------------------------------------
++# ATMega168P
++#---------------------------------------------------------------------
++# Fuse extended byte:
++# 0x00 = 0 0 0 0 0 0 0 0 <-- BOOTRST (boot reset vector at 0x1800)
++# \+/
++# +------- BOOTSZ (00 = 2k bytes)
++# Fuse high byte:
++# 0xd6 = 1 1 0 1 0 1 1 0
++# ^ ^ ^ ^ ^ \-+-/
++# | | | | | +------ BODLEVEL 0..2 (110 = 1.8 V)
++# | | | | + --------- EESAVE (preserve EEPROM over chip erase)
++# | | | +-------------- WDTON (if 0: watchdog always on)
++# | | +---------------- SPIEN (allow serial programming)
++# | +------------------ DWEN (debug wire enable)
++# +-------------------- RSTDISBL (reset pin is enabled)
++# Fuse low byte:
++# 0xdf = 1 1 0 1 1 1 1 1
++# ^ ^ \ / \--+--/
++# | | | +------- CKSEL 3..0 (external >8M crystal)
++# | | +--------------- SUT 1..0 (crystal osc, BOD enabled)
++# | +------------------ CKOUT (if 0: Clock output enabled)
++# +-------------------- CKDIV8 (if 0: divide by 8)
++
++
++# Lock Bits
++# 0x3f = - - 1 1 1 1 1 1
++# \ / \-/ \-/
++# | | +----- LB 2..1 (No memory lock features enabled)
++# | +--------- BLB0 2..1 (No restrictions for SPM or LPM accessing the Application section)
++# +--------------- BLB1 2..1 (No restrictions for SPM or LPM accessing the Boot Loader section)
--- /dev/null
--- /dev/null
++Time to Sleep
++=============
++USB suspend no activity on USB line for 3ms
++No Interaction no user interaction
++ matrix has no change
++ matrix has no switch on
++
++
++AVR Power Management
++====================
++
++V-USB suspend
++ USB suspend
++ http://vusb.wikidot.com/examples
++
++MCUSR MCU Status Register
++ WDRF Watchdog Reset Flag
++ BORF
++ EXTRF
++ PORF Power-on Reset Flag
++
++SMCR Sleep Mode Control Register
++ SE Sleep Enable
++ SM2:0
++ #define set_sleep_mode(mode) \
++ #define SLEEP_MODE_IDLE (0)
++ #define SLEEP_MODE_ADC _BV(SM0)
++ #define SLEEP_MODE_PWR_DOWN _BV(SM1)
++ #define SLEEP_MODE_PWR_SAVE (_BV(SM0) | _BV(SM1))
++ #define SLEEP_MODE_STANDBY (_BV(SM1) | _BV(SM2))
++ #define SLEEP_MODE_EXT_STANDBY (_BV(SM0) | _BV(SM1) | _BV(SM2))
++
++
++ACSR Analog Comparator Control and Status Register
++ To disable Analog Comparator
++ ACSR = 0x80;
++ or
++ ACSR &= ~_BV(ACIE);
++ ACSR |= _BV(ACD);
++
++ ACD: Analog Comparator Disable
++ When this bit is written logic one, the power to the Analog Comparator is
++ switched off. This bit can be set at any time to turn off the Analog
++ Comparator. This will reduce power consumption in Active and Idle mode.
++ When changing the ACD bit, the Analog Comparator Interrupt must be disabled
++ by clearing the ACIE bit in ACSR. Otherwise an interrupt can occur when
++ the bit is changed.
++
++DIDR1 Digital Input Disable Register 1
++ AIN1D
++ AIN0D
++ When this bit is written logic one, the digital input buffer on the AIN1/0 pin is disabled. The corresponding PIN Register bit will always read as zero when this bit is set. When an analog signal is applied to the AIN1/0 pin and the digital input from this pin is not needed, this bit should be written logic one to reduce power consumption in the digital input buffer.
++
++
++PRR Power Reduction Register
++ PRTWI
++ PRTIM2
++ PRTIM0
++ PRTIM1
++ PRSPI
++ PRUSART0
++ PRADC
--- /dev/null
--- /dev/null
++USB NKRO MEMO
++=============
++2010/12/09
++
++
++References
++----------
++USB - boot mode, NKRO, compatibility, etc...
++ http://geekhack.org/showthread.php?t=13162
++NKey Rollover - Overview, Testing Methodology, and Results
++ http://geekhack.org/showwiki.php?title=NKey+Rollover+-+Overview+Testing+Methodology+and+Results
++dfj's NKRO(2010/06)
++ http://geekhack.org/showpost.php?p=191195&postcount=251
++ http://geekhack.org/showthread.php?p=204389#post204389
++
++
++Terminology
++---------
++NKRO
++ghost
++matrix
++mechanical with diodes
++membrane
++
++
++OS Support Status
++-----------------
++USB NKRO is possible *without* a custom driver.
++At least following OS's supports.
++ Windows7 64bit
++ WindowsXP
++ Windows2000 SP4
++ Ubuntu10.4(Linux 2.6)
++ MacOSX(To be tested)
++
++
++Custom Driver for USB NKRO
++--------------------------
++NOT NEEDED
++at least when using following report formats on Windows, Linux or MacOSX.
++
++
++USB NKRO methods
++----------------
++1. Virtual keyboards
++ Keyboard can increase its KRO by using virtual keyboards with Standard or Extended report.
++ If the keyboard has 2 virtual keyboard with Standard report(6KRO), it gets 12KRO.
++ Using this method means the keyboard is a composite device.
++
++2. Extended report
++ It needs large report size for this method to achieve NKRO.
++ If a keyboard has 101keys, it needs 103byte report. It seems to be inefficient.
++
++3. Bitmap report
++ If the keyboard has less than 128keys, 16byte report will be enough for NKRO.
++ The 16byte report seems to be reasonable cost to get NKRO.
++
++
++Report Format
++-------------
++Other report formats than followings are possible, though these format are typical one.
++
++1. Standard 8bytes
++ modifiers(bitmap) 1byte
++ reserved 1byte(not used)
++ keys(array) 1byte*6
++Standard report can send 6keys plus 8modifiers simultaneously.
++Standard report is used by most keyboards in the marketplace.
++Standard report is identical to boot protocol report.
++Standard report is hard to suffer from compatibility problems.
++
++2. Extended standard 16,32,64bytes
++ modifiers(bitmap) 1byte
++ reserved 1byte(not used)
++ keys(array) 1byte*(14,32,62)
++Extended report can send N-keys by using N+2bytes.
++Extended report is expected to be compatible with boot protocol.
++
++3. Bitmap 16,32,64bytes
++ keys(bitmap) (16,32)bytes
++Bitmap report can send at most 128keys by 16bytes and 256keys by 32bytes.
++Bitmap report can achieve USB NKRO efficiently in terms of report size.
++Bitmap report needs a deliberation for boot protocol implementation.
++Bitmap report descriptor sample:
++ 0x05, 0x01, // Usage Page (Generic Desktop),
++ 0x09, 0x06, // Usage (Keyboard),
++ 0xA1, 0x01, // Collection (Application),
++ // bitmap of modifiers
++ 0x75, 0x01, // Report Size (1),
++ 0x95, 0x08, // Report Count (8),
++ 0x05, 0x07, // Usage Page (Key Codes),
++ 0x19, 0xE0, // Usage Minimum (224),
++ 0x29, 0xE7, // Usage Maximum (231),
++ 0x15, 0x00, // Logical Minimum (0),
++ 0x25, 0x01, // Logical Maximum (1),
++ 0x81, 0x02, // Input (Data, Variable, Absolute), ;Modifier byte
++ // LED output report
++ 0x95, 0x05, // Report Count (5),
++ 0x75, 0x01, // Report Size (1),
++ 0x05, 0x08, // Usage Page (LEDs),
++ 0x19, 0x01, // Usage Minimum (1),
++ 0x29, 0x05, // Usage Maximum (5),
++ 0x91, 0x02, // Output (Data, Variable, Absolute),
++ 0x95, 0x01, // Report Count (1),
++ 0x75, 0x03, // Report Size (3),
++ 0x91, 0x03, // Output (Constant),
++ // bitmap of keys
++ 0x95, (REPORT_BYTES-1)*8, // Report Count (),
++ 0x75, 0x01, // Report Size (1),
++ 0x15, 0x00, // Logical Minimum (0),
++ 0x25, 0x01, // Logical Maximum(1),
++ 0x05, 0x07, // Usage Page (Key Codes),
++ 0x19, 0x00, // Usage Minimum (0),
++ 0x29, (REPORT_BYTES-1)*8-1, // Usage Maximum (),
++ 0x81, 0x02, // Input (Data, Variable, Absolute),
++ 0xc0 // End Collection
++where REPORT_BYTES is a report size in bytes.
++
++
++Considerations
++--------------
++Compatibility
++ boot protocol
++ minor/old system
++ Some BIOS doesn't send SET_PROTOCOL request, a keyboard can't switch to boot protocol mode.
++ This may cause a problem on a keyboard which uses other report than Standard.
++Reactivity
++ USB polling time
++ OS/Driver processing time
++
++
++Windows Problem
++---------------
++1. Windows accepts only 6keys in case of Standard report.
++ It should be able to send 6keys plus 8modifiers.
++2. Windows accepts only 10keys in case of 16bytes Extended report.
++ It should be able to send 14keys plus 8modifiers.
++3. Windows accepts only 18keys in case of 32bytes Extended report.
++ It should be able to send 30keys plus 8modifiers.
++If keys are pressed in excess of the number, wrong keys are registered on Windows.
++
++This problem will be reportedly fixed soon.(2010/12/05)
++ http://forums.anandtech.com/showpost.php?p=30873364&postcount=17
++
++
++Tools for testing NKRO
++----------------------
++Browser App:
++http://www.microsoft.com/appliedsciences/content/projects/KeyboardGhostingDemo.aspx
++http://random.xem.us/rollover.html
++
++Windows:
++AquaKeyTest.exe http://geekhack.org/showthread.php?t=6643
++
++Linux:
++xkeycaps
++xev
++showkeys
++
++EOF
--- /dev/null
--- /dev/null
++Build Firmware and Program Controller
++=====================================
++
++
++Download and Install
++--------------------
++### 1. Install Tools
++
++1. **Toolchain** On Windows install [MHV AVR Tools][mhv] for AVR GCC compiler and [Cygwin][cygwin](or [MinGW][mingw]) for shell terminal. On Mac you can use [CrossPack][crosspack]. On Linux you can install AVR GCC with your favorite package manager.
++
++2. **Programmer** On Windows install [Atmel FLIP][flip]. On Mac and Linux install [dfu-programmer][dfu-prog].
++
++3. **Driver** On Windows you start DFU bootloader on the chip first time you will see 'Found New Hardware Wizard' to install driver. 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\. In case of `dfu-programmer` use its driver.
++
++If you use PJRC Teensy you don't need step 2 and 3 above, just get [Teensy loader][teensy-loader].
++
++
++### 2. Download source
++You can find firmware source at github:
++
++- <https://github.com/tmk/tmk_keyboard>
++
++If you are familiar with `Git` tools you are recommended to use it but you can also download zip archive from:
++
++- <https://github.com/tmk/tmk_keyboard/archive/master.zip>
++
++
++Build firmware
++--------------
++### 1. Open terminal
++Open terminal window to get access to commands. Use Cygwin(or MingGW) `shell terminal` 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. Change directory
++Move to project directory in the firmware source.
++
++ cd tmk_keyboard/{'keyboard' or 'converter'}/<project>
++
++### 3. Make
++Build firmware using GNU `make` command. You'll see `<project>_<variant>.hex` file in that directory unless something unexpected occurs in build process.
++
++
++ make -f Makefile.<variant> clean
++ make -f Makefile.<variant>
++
++
++
++
++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.
++
++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 below.
++To use command line tool run this command. Note that you need to set PATH variable properly.
++
++ $ make -f Makefile.<variant> flip
++
++Or to program with `dfu-programmer` run:
++
++ $ make -f Makefile.<variant> dfu
++
++#### 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.
++At this point you'll see grey-outed widgets on the app get colored and ready.
++
++3. On menu bar click File -> Load HEX File, then select your firmware hex file on File Selector dialog.
++4. On 'Operations Flow' panel click 'Run' button to load the firmware binary to the chip. Note that you should keep 'Erase', 'Blank Check', 'Program' and 'Verify' check boxes selected.
++5. Re-plug USB cord or click 'Start Application' button to restart your controller.
++Done.
++
++See also these instructions if you need.
++
++- <http://code.google.com/p/micropendous/wiki/LoadingFirmwareWithFLIP>
++- <http://www.atmel.com/Images/doc7769.pdf>
++
++
++### 3. Program with Teensy Loader
++If you have PJRC Teensy see instruction of `Teensy Loader`.
++
++- <http://www.pjrc.com/teensy/loader.html>
++
++Or use this command if you have command line version of Teensy Loader installed.
++
++ $ make -f Makefile.<variant> teensy
++
++
++### 4. Program with Other programmer
++You may want to use other programmer like `avrdude` with AVRISPmkII, Arduino or USBasp. In that case you can still use make target `program` for build with configuring `PROGRAM_CMD` in Makefile.
++
++ $ make -f Makefile.<variant> program
++
++
++[cygwin]: https://www.cygwin.com/
++[mingw]: http://www.mingw.org/
++[mhv]: https://infernoembedded.com/products/avr-tools
++[winavr]: http://winavr.sourceforge.net/
++[crosspack]: http://www.obdev.at/products/crosspack/index.html
++[flip]: http://www.atmel.com/tools/FLIP.aspx
++[dfu-prog]: http://dfu-programmer.sourceforge.net/
++[teensy-loader]:http://www.pjrc.com/teensy/loader.html
++
++
++
++Makefile Options
++----------------
++### 1. MCU and Frequency.
++
++ MCU = atmega32u4 # Teensy 2.0
++ #MCU = at90usb1286 # Teensy++ 2.0
++ F_CPU = 16000000
++
++Set your MCU and its clock in Hz.
++
++ # Boot Section Size in *bytes*
++ # Teensy halfKay 512
++ # Atmel DFU loader 4096
++ # LUFA bootloader 4096
++ OPT_DEFS += -DBOOTLOADER_SIZE=4096
++
++If you are using PJRC Teensy use `512` for `BOOTLOADER_SIZE`, otherwise use `4096` unless you are sure.
++
++### 2. Features
++Optional. Note that ***comment out*** with `#` to disable them.
++
++ BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
++ MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
++ EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
++ CONSOLE_ENABLE = yes # Console for debug(+400)
++ 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
++ #BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
++
++### 3. Programmer
++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 `Teensy Loader`.
++
++ # 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. 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 re-synchronize hack */
++ #define CAPSLOCK_LOCKING_RESYNC_ENABLE
++
++### 3. Disable Debug and Print
++
++ /* disable debug print */
++ #define NO_DEBUG
++
++ /* disable print */
++ #define NO_PRINT
++
++### 4. Disable Action Features
++
++ #define NO_ACTION_LAYER
++ #define NO_ACTION_TAPPING
++ #define NO_ACTION_ONESHOT
++ #define NO_ACTION_MACRO
++ #define NO_ACTION_FUNCTION
++
++***TBD***
--- /dev/null
--- /dev/null
++Keycode Symbol Table
++====================
++Keycodes are defined in `common/keycode.h`.
++Range of 00-A4 and E0-E7 are identical with HID Usage:
++<http://www.usb.org/developers/devclass_docs/Hut1_11.pdf>
++Virtual keycodes are defined out of above range to support special actions.
++
++
++Keycode Symbol Short name Description
++--------------------------------------------------------------------------------
++KC_NO 00 Reserved (no event indicated)
++KC_ROLL_OVER 01 Keyboard ErrorRollOver
++KC_POST_FAIL 02 Keyboard POSTFail
++KC_UNDEFINED 03 Keyboard ErrorUndefined
++KC_A 04 Keyboard a and A
++KC_B 05 Keyboard b and B
++KC_C 06 Keyboard c and C
++KC_D 07 Keyboard d and D
++KC_E 08 Keyboard e and E
++KC_F 09 Keyboard f and F
++KC_G 0A Keyboard g and G
++KC_H 0B Keyboard h and H
++KC_I 0C Keyboard i and I
++KC_J 0D Keyboard j and J
++KC_K 0E Keyboard k and K
++KC_L 0F Keyboard l and L
++KC_M 10 Keyboard m and M
++KC_N 11 Keyboard n and N
++KC_O 12 Keyboard o and O
++KC_P 13 Keyboard p and P
++KC_Q 14 Keyboard q and Q
++KC_R 15 Keyboard r and R
++KC_S 16 Keyboard s and S
++KC_T 17 Keyboard t and T
++KC_U 18 Keyboard u and U
++KC_V 19 Keyboard v and V
++KC_W 1A Keyboard w and W
++KC_X 1B Keyboard x and X
++KC_Y 1C Keyboard y and Y
++KC_Z 1D Keyboard z and Z
++KC_1 1E Keyboard 1 and !
++KC_2 1F Keyboard 2 and @
++KC_3 20 Keyboard 3 and #
++KC_4 21 Keyboard 4 and $
++KC_5 22 Keyboard 5 and %
++KC_6 23 Keyboard 6 and ^
++KC_7 24 Keyboard 7 and &
++KC_8 25 Keyboard 8 and *
++KC_9 26 Keyboard 9 and (
++KC_0 27 Keyboard 0 and )
++KC_ENTER KC_ENT 28 Keyboard Return (ENTER)
++KC_ESCAPE KC_ESC 29 Keyboard ESCAPE
++KC_BSPACE KC_BSPC 2A Keyboard DELETE (Backspace)
++KC_TAB 2B Keyboard Tab
++KC_SPACE KC_SPC 2C Keyboard Spacebar
++KC_MINUS KC_MINS 2D Keyboard - and (underscore)
++KC_EQUAL KC_EQL 2E Keyboard = and +
++KC_LBRACKET KC_LBRC 2F Keyboard [ and {
++KC_RBRACKET KC_RBRC 30 Keyboard ] and }
++KC_BSLASH KC_BSLS 31 Keyboard \ and |
++KC_NONUS_HASH KC_NUHS 32 Keyboard Non-US # and ~
++KC_SCOLON KC_SCLN 33 Keyboard ; and :
++KC_QUOTE KC_QUOT 34 Keyboard ‘ and “
++KC_GRAVE KC_GRV 35 Keyboard Grave Accent and Tilde
++KC_COMMA KC_COMM 36 Keyboard, and <
++KC_DOT 37 Keyboard . and >
++KC_SLASH KC_SLSH 38 Keyboard / and ?
++KC_CAPSLOCK KC_CAPS 39 Keyboard Caps Lock
++KC_F1 3A Keyboard F1
++KC_F2 3B Keyboard F2
++KC_F3 3C Keyboard F3
++KC_F4 3D Keyboard F4
++KC_F5 3E Keyboard F5
++KC_F6 3F Keyboard F6
++KC_F7 40 Keyboard F7
++KC_F8 41 Keyboard F8
++KC_F9 42 Keyboard F9
++KC_F10 43 Keyboard F10
++KC_F11 44 Keyboard F11
++KC_F12 45 Keyboard F12
++KC_PSCREEN KC_PSCR 46 Keyboard PrintScreen1
++KC_SCKLOCK KC_SLCK 47 Keyboard Scroll Lock11
++KC_PAUSE KC_PAUS 48 Keyboard Pause1
++KC_INSERT KC_INS 49 Keyboard Insert1
++KC_HOME 4A Keyboard Home1
++KC_PGUP 4B Keyboard PageUp1
++KC_DELETE KC_DELETE 4C Keyboard Delete Forward
++KC_END 4D Keyboard End1
++KC_PGDOWN KC_PGDN 4E Keyboard PageDown1
++KC_RIGHT KC_RGHT 4F Keyboard RightArrow1
++KC_LEFT 50 Keyboard LeftArrow1
++KC_DOWN 51 Keyboard DownArrow1
++KC_UP 52 Keyboard UpArrow1
++KC_NUMLOCK KC_NLCK 53 Keypad Num Lock and Clear11
++KC_KP_SLASH KC_PSLS 54 Keypad /1
++KC_KP_ASTERISK KC_PAST 55 Keypad *
++KC_KP_MINUS KC_PMNS 56 Keypad -
++KC_KP_PLUS KC_PPLS 57 Keypad +
++KC_KP_ENTER KC_PENT 58 Keypad ENTER5
++KC_KP_1 KC_P1 59 Keypad 1 and End
++KC_KP_2 KC_P2 5A Keypad 2 and Down Arrow
++KC_KP_3 KC_P3 5B Keypad 3 and PageDn
++KC_KP_4 KC_P4 5C Keypad 4 and Left Arrow
++KC_KP_5 KC_P5 5D Keypad 5
++KC_KP_6 KC_P6 5E Keypad 6 and Right Arrow
++KC_KP_7 KC_P7 5F Keypad 7 and Home
++KC_KP_8 KC_P8 60 Keypad 8 and Up Arrow
++KC_KP_9 KC_P9 61 Keypad 9 and PageUp
++KC_KP_0 KC_P0 62 Keypad 0 and Insert
++KC_KP_DOT KC_PDOT 63 Keypad . and Delete
++KC_NONUS_BSLASH KC_NUBS 64 Keyboard Non-US \ and |
++KC_APPLICATION KC_APP 65 Keyboard Application10
++KC_POWER 66 Keyboard Power9
++KC_KP_EQUAL KC_PEQL 67 Keypad =
++KC_F13 68 Keyboard F13
++KC_F14 69 Keyboard F14
++KC_F15 6A Keyboard F15
++KC_F16 6B Keyboard F16
++KC_F17 6C Keyboard F17
++KC_F18 6D Keyboard F18
++KC_F19 6E Keyboard F19
++KC_F20 6F Keyboard F20
++KC_F21 70 Keyboard F21
++KC_F22 71 Keyboard F22
++KC_F23 72 Keyboard F23
++KC_F24 73 Keyboard F24
++KC_EXECUTE 74 Keyboard Execute
++KC_HELP 75 Keyboard Help
++KC_MENU 76 Keyboard Menu
++KC_SELECT 77 Keyboard Select
++KC_STOP 78 Keyboard Stop
++KC_AGAIN 79 Keyboard Again
++KC_UNDO 7A Keyboard Undo
++KC_CUT 7B Keyboard Cut
++KC_COPY 7C Keyboard Copy
++KC_PASTE 7D Keyboard Paste
++KC_FIND 7E Keyboard Find
++KC__MUTE 7F Keyboard Mute
++KC__VOLUP 80 Keyboard Volume Up
++KC__VOLDOWN 81 Keyboard Volume Down
++KC_LOCKING_CAPS 82 Keyboard Locking Caps Lock12
++KC_LOCKING_NUM 83 Keyboard Locking Num Lock12
++KC_LOCKING_SCROLL 84 Keyboard Locking Scroll Lock12
++KC_KP_COMMA KC_PCMM 85 Keypad Comma27
++KC_KP_EQUAL_AS400 86 Keypad Equal Sign29
++KC_INT1 KC_RO 87 Keyboard International115,28
++KC_INT2 KC_KANA 88 Keyboard International216
++KC_INT3 KC_JYEN 89 Keyboard International317
++KC_INT4 KC_HENK 8A Keyboard International418
++KC_INT5 KC_MHEN 8B Keyboard International519
++KC_INT6 8C Keyboard International620
++KC_INT7 8D Keyboard International721
++KC_INT8 8E Keyboard International822
++KC_INT9 8F Keyboard International922
++KC_LANG1 90 Keyboard LANG125
++KC_LANG2 91 Keyboard LANG226
++KC_LANG3 92 Keyboard LANG330
++KC_LANG4 93 Keyboard LANG431
++KC_LANG5 94 Keyboard LANG532
++KC_LANG6 95 Keyboard LANG68
++KC_LANG7 96 Keyboard LANG78
++KC_LANG8 97 Keyboard LANG88
++KC_LANG9 98 Keyboard LANG98
++KC_ALT_ERASE 99 Keyboard Alternate Erase7
++KC_SYSREQ 9A Keyboard SysReq/Attention1
++KC_CANCEL 9B Keyboard Cancel
++KC_CLEAR 9C Keyboard Clear
++KC_PRIOR 9D Keyboard Prior
++KC_RETURN 9E Keyboard Return
++KC_SEPARATOR 9F Keyboard Separator
++KC_OUT A0 Keyboard Out
++KC_OPER A1 Keyboard Oper
++KC_CLEAR_AGAIN A2 Keyboard Clear/Again
++KC_CRSEL A3 Keyboard CrSel/Props
++KC_EXSEL A4 Keyboard ExSel
++/* Modifiers */
++KC_LCTRL KC_LCTRL E0 Keyboard LeftControl
++KC_LSHIFT KC_LSFT E1 Keyboard LeftShift
++KC_LALT E2 Keyboard LeftAlt
++KC_LGUI E3 Keyboard Left GUI(Windows/Apple/Meta key)
++KC_RCTRL KC_RCTL E4 Keyboard RightControl
++KC_RSHIFT KC_RSFT E5 Keyboard RightShift
++KC_RALT E6 Keyboard RightAlt
++KC_RGUI E7 Keyboard Right GUI(Windows/Apple/Meta key)
++
++/*
++ * Virtual keycodes
++ */
++/* System Control */
++KC_SYSTEM_POWER KC_PWR System Power Down
++KC_SYSTEM_SLEEP KC_SLEP System Sleep
++KC_SYSTEM_WAKE KC_WAKE System Wake
++/* Consumer Page */
++KC_AUDIO_MUTE KC_MUTE
++KC_AUDIO_VOL_UP KC_VOLU
++KC_AUDIO_VOL_DOWN KC_VOLD
++KC_MEDIA_NEXT_TRACK KC_MNXT
++KC_MEDIA_PREV_TRACK KC_MPRV
++KC_MEDIA_STOP KC_MSTP
++KC_MEDIA_PLAY_PAUSE KC_MPLY
++KC_MEDIA_SELECT KC_MSEL
++KC_MAIL KC_MAIL
++KC_CALCULATOR KC_CALC
++KC_MY_COMPUTER KC_MYCM
++KC_WWW_SEARCH KC_WSCH
++KC_WWW_HOME KC_WHOM
++KC_WWW_BACK KC_WBAK
++KC_WWW_FORWARD KC_WFWD
++KC_WWW_STOP KC_WSTP
++KC_WWW_REFRESH KC_WREF
++KC_WWW_FAVORITES KC_WFAV
++/* Mousekey */
++KC_MS_UP KC_MS_U Mouse Cursor Up
++KC_MS_DOWN KC_MS_D Mouse Cursor Down
++KC_MS_LEFT KC_MS_L Mouse Cursor Left
++KC_MS_RIGHT KC_MS_R Mouse Cursor Right
++KC_MS_BTN1 KC_BTN1 Mouse Button 1
++KC_MS_BTN2 KC_BTN2 Mouse Button 2
++KC_MS_BTN3 KC_BTN3 Mouse Button 3
++KC_MS_BTN4 KC_BTN4 Mouse Button 4
++KC_MS_BTN5 KC_BTN5 Mouse Button 5
++KC_MS_WH_UP KC_WH_U Mouse Wheel Up
++KC_MS_WH_DOWN KC_WH_D Mouse Wheel Down
++KC_MS_WH_LEFT KC_WH_L Mouse Wheel Left
++KC_MS_WH_RIGHT KC_WH_R Mouse Wheel Right
++KC_MS_ACCEL0 KC_ACL0 Mouse Acceleration 0
++KC_MS_ACCEL1 KC_ACL1 Mouse Acceleration 1
++KC_MS_ACCEL2 KC_ACL2 Mouse Acceleration 2
++/* Fn key */
++KC_FN0
++KC_FN1
++KC_FN2
++KC_FN3
++KC_FN4
++KC_FN5
++KC_FN6
++KC_FN7
++KC_FN8
++KC_FN9
++KC_FN10
++KC_FN11
++KC_FN12
++KC_FN13
++KC_FN14
++KC_FN15
++KC_FN16
++KC_FN17
++KC_FN18
++KC_FN19
++KC_FN20
++KC_FN21
++KC_FN22
++KC_FN23
++KC_FN24
++KC_FN25
++KC_FN26
++KC_FN27
++KC_FN28
++KC_FN29
++KC_FN30
++KC_FN31
--- /dev/null
--- /dev/null
++Keymap framework - how to define your keymap
++============================================
++***NOTE: This is not final version, may be inconsistent with source code and changed occasionally for a while.***
++
++## 0. Keymap and layers
++**Keymap** is comprised of multiple layers of key layout, you can define **32 layers** at most.
++**Layer** is an array of **keycodes** to define **actions** for each physical keys.
++respective layers can be validated simultaneously. Layers are indexed with 0 to 31 and higher layer has precedence.
++
++ Keymap: 32 Layers Layer: Keycode matrix
++ ----------------- ---------------------
++ stack of layers array_of_keycode[row][column]
++ ____________ precedence _______________________
++ / / | high / ESC / F1 / F2 / F3 ....
++ 31 /___________// | /-----/-----/-----/-----
++ 30 /___________// | / TAB / Q / W / E ....
++ 29 /___________/ | /-----/-----/-----/-----
++ : _:_:_:_:_:__ | : /LCtrl/ A / S / D ....
++ : / : : : : : / | : / : : : :
++ 2 /___________// | 2 `--------------------------
++ 1 /___________// | 1 `--------------------------
++ 0 /___________/ V low 0 `--------------------------
++
++
++
++### 0.1 Keymap status
++Keymap has its state in two parameters:
++**`default_layer`** indicates a base keymap layer(0-31) which is always valid and to be referred, **`keymap_stat`** is 16bit variable which has current on/off status of layers on its each bit.
++
++Keymap layer '0' is usually `default_layer` and which is the only valid layer and other layers is initially off after boot up firmware, though, you can configured them in `config.h`.
++To change `default_layer` will be useful when you switch key layout completely, say you want Colmak instead of Qwerty.
++
++ Initial state of Keymap Change base layout
++ ----------------------- ------------------
++
++ 31 31
++ 30 30
++ 29 29
++ : :
++ : : ____________
++ 2 ____________ 2 / /
++ 1 / / ,->1 /___________/
++ ,->0 /___________/ | 0
++ | |
++ `--- default_layer = 0 `--- default_layer = 1
++ layer_state = 0x00000001 layer_state = 0x00000002
++
++On the other hand, you shall change `layer_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions.
++
++ Overlay feature layer
++ --------------------- bit|status
++ ____________ ---+------
++ 31 / / 31 | 0
++ 30 /___________// -----> 30 | 1
++ 29 /___________/ -----> 29 | 1
++ : : | :
++ : ____________ : | :
++ 2 / / 2 | 0
++ ,->1 /___________/ -----> 1 | 1
++ | 0 0 | 0
++ | +
++ `--- default_layer = 1 |
++ layer_state = 0x60000002 <-'
++
++
++
++### 0.2 Layer Precedence and Transparency
++Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
++
++You can place `KC_TRNS` on overlay layer changes just part of layout to fall back on lower or base layer.
++Key with `KC_TRANS` doesn't has its own keycode and refers to lower valid layers for keycode, instead.
++See example below.
++
++
++### 0.3 Keymap Example
++Keymap is **`keymaps[]`** C array in fact and you can define layers in it with **`KEYMAP()`** C macro and keycodes. To use complex actions you need to define `Fn` keycode in **`fn_actions[]`** array.
++
++This is a keymap example for [HHKB](http://en.wikipedia.org/wiki/Happy_Hacking_Keyboard) keyboard.
++This example has three layers, 'Qwerty' as base layer, 'Cursor' and 'Mousekey'.
++In this example,
++
++ `Fn0` is a **momentary layer switching** key, you can use keys on Cursor layer while holding the key.
++
++ `Fn1` is a momentary layer switching key with tapping feature, you can get semicolon **';'** with taping the key and switch layers while holding the key. The word **'tap'** or **'tapping'** mean to press and release a key quickly.
++
++ `Fn2` is a **toggle layer switch** key, you can stay switched layer after releasing the key unlike momentary switching.
++
++You can find other keymap definitions in file `keymap.c` located on project directories.
++
++ static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
++ /* 0: Qwerty
++ * ,-----------------------------------------------------------.
++ * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
++ * |-----------------------------------------------------------|
++ * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
++ * |-----------------------------------------------------------|
++ * |Contro| A| S| D| F| G| H| J| K| L|Fn1| '|Enter |
++ * |-----------------------------------------------------------|
++ * |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |Fn0|
++ * `-----------------------------------------------------------'
++ * |Gui|Alt |Space |Alt |Fn2|
++ * `-------------------------------------------'
++ */
++ KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
++ TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
++ LCTL,A, S, D, F, G, H, J, K, L, FN1, QUOT,ENT, \
++ LSFT,Z, X, C, V, B, N, M, COMM,DOT, SLSH,RSFT,FN0, \
++ LGUI,LALT, SPC, RALT,FN2),
++ /* 1: Cursor(HHKB mode)
++ * ,-----------------------------------------------------------.
++ * |Pwr| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
++ * |-----------------------------------------------------------|
++ * |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
++ * |-----------------------------------------------------------|
++ * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
++ * |-----------------------------------------------------------|
++ * |Shift | | | | | | +| -|End|PgD|Dow|Shift | |
++ * `-----------------------------------------------------------'
++ * |Gui |Alt |Space |Alt |Gui|
++ * `--------------------------------------------'
++ */
++ KEYMAP(PWR, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
++ CAPS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,PSCR,SLCK,PAUS,UP, TRNS,BSPC, \
++ LCTL,VOLD,VOLU,MUTE,TRNS,TRNS,PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
++ LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,PPLS,PMNS,END, PGDN,DOWN,RSFT,TRNS, \
++ LGUI,LALT, SPC, RALT,RGUI),
++ /* 2: Mousekey
++ * ,-----------------------------------------------------------.
++ * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
++ * |-----------------------------------------------------------|
++ * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
++ * |-----------------------------------------------------------|
++ * |Contro| | | | | |McL|McD|McU|McR| | |Return |
++ * |-----------------------------------------------------------|
++ * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
++ * `-----------------------------------------------------------'
++ * |Gui |Alt |Mb1 |Alt | |
++ * `--------------------------------------------'
++ * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
++ */
++ KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
++ TAB, TRNS,TRNS,TRNS,TRNS,TRNS,WH_L,WH_D,WH_U,WH_R,TRNS,TRNS,TRNS,BSPC, \
++ LCTL,TRNS,ACL0,ACL1,ACL2,TRNS,MS_L,MS_D,MS_U,MS_R,TRNS,QUOT,ENT, \
++ LSFT,TRNS,TRNS,TRNS,TRNS,BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,TRNS, \
++ LGUI,LALT, BTN1, RALT,TRNS),
++ };
++
++ static const uint16_t PROGMEM fn_actions[] = {
++ ACTION_LAYER_MOMENTARY(1), // FN0
++ ACTION_LAYER_TAP_KEY(2, KC_SCLN), // FN1
++ ACTION_LAYER_TOGGLE(2), // FN2
++ };
++
++
++
++
++## 1. Keycode
++See [`common/keycode.h`](../common/keycode.h) or keycode table below for the detail. Keycode is internal **8bit code** to indicate action performed on key in keymap. Keycode has `KC_` prefixed symbol respectively. Most of keycodes like `KC_A` have simple action registers key to host on press and unregister on release, while some of other keycodes has some special actions like `Fn` keys, Media control keys, System control keys and Mousekeys.
++
++ ***In `KEYMAP()` macro you should omit prefix part `KC_` of keycode to keep keymap compact.*** For example, just use `A` instead you place `KC_A` in `KEYMAP()`. Some keycodes has 4-letter **short name** in addition to descriptive name, you'll prefer short one in `KEYMAP()`.
++
++### 1.0 Other key
++- `KC_NO` for no action
++- `KC_TRNS` for layer transparency (See above)
++
++### 1.1 Normal key
++- `KC_A` to `KC_Z`, `KC_1` to `KC_0` for alpha numeric key
++- `KC_MINS`, `KC_EQL`, `KC_GRV`, `KC_RBRC`, `KC_LBRC`, `KC_COMM`, `KC_DOT`, `KC_BSLS`, `KC_SLSH`, `KC_SCLN`, `KC_QUOT`
++- `KC_ESC`, `KC_TAB`, `KC_SPC`, `KC_BSPC`, `KC_ENT`, `KC_DEL`, `KC_INS`
++- `KC_UP`, `KC_DOWN`, `KC_RGHT`, `KC_LEFT`, `KC_PGUP`, `KC_PGDN`, `KC_HOME`, `KC_END`
++- `KC_CAPS`, `KC_NLCK`, `KC_SLCK`, `KC_PSCR`, `KC_PAUS`, `KC_APP`, `KC_F1` to `KC_F24`
++- `KC_P1` to `KC_P0`, `KC_PDOT`, `KC_PCMM`, `KC_PSLS`, `KC_PAST`, `KC_PMNS`, `KC_PPLS`, `KC_PEQL`, `KC_PENT` for keypad.
++
++### 1.2 Modifier
++There are 8 modifiers which has discrimination between left and right.
++
++- `KC_LCTL` and `KC_RCTL` for Control
++- `KC_LSFT` and `KC_RSFT` for Shift
++- `KC_LALT` and `KC_RALT` for Alt
++- `KC_LGUI` and `KC_RGUI` for Windows key or Command key in Mac
++
++### 1.3 Mousekey
++- `KC_MS_U`, `KC_MS_D`, `KC_MS_L`, `KC_MS_R` for mouse cursor
++- `KC_WH_U`, `KC_WH_D`, `KC_WH_L`, `KC_WH_R` for mouse wheel
++- `KC_BTN1`, `KC_BTN2`, `KC_BTN3`, `KC_BTN4`, `KC_BTN5` for mouse buttons
++
++### 1.4 System & Media key
++- `KC_PWR`, `KC_SLEP`, `KC_WAKE` for Power, Sleep, Wake
++- `KC_MUTE`, `KC_VOLU`, `KC_VOLD` for audio volume control
++- `KC_MNXT`, `KC_MPRV`, `KC_MSTP`, `KC_MPLY`, `KC_MSEL` for media control
++- `KC_MAIL`, `KC_CALC`, `KC_MYCM` for application launch
++- `KC_WSCH`, `KC_WHOM`, `KC_WBAK`, `KC_WFWD`, `KC_WSTP`, `KC_WREF`, `KC_WFAV` for web browser operation
++
++### 1.5 Fn key
++`KC_FNnn` are keycodes for `Fn` key which not given any actions at the beginning unlike most of keycodes has its own inborn action. To use these keycodes in `KEYMAP()` you need to assign action you want at first. Action of `Fn` key is defined in `fn_actions[]` and its index of the array is identical with number part of `KC_FNnn`. Thus `KC_FN0` keycode indicates the action defined in first element of the array. ***32 `Fn` keys can be defined at most.***
++
++### 1.6 Keycode Table
++ See keycode table in [`doc/keycode.txt`](./keycode.txt) for description of keycodes.
++
++ In regard to implementation side most of keycodes are identical with [HID usage][HID_usage](pdf) sent to host for real and some virtual keycodes are defined to support special actions.
++[HID_usage]: http://www.usb.org/developers/devclass_docs/Hut1_11.pdf
++
++
++
++## 2. Action
++See [`common/action_code.h`](../common/action_code.h). Action is a **16bit code** and defines function to perform on events of a key like press, release, holding and tapping.
++
++Most of keys just register 8bit scancode to host, but to support other complex features needs 16bit extended action codes internally. However, using 16bit action codes in keymap results in double size in memory compared to using just keycodes. To avoid this waste 8bit keycodes are used in `KEYMAP()` instead of action codes.
++
++***You can just use keycodes of `Normal key`, `Modifier`, `Mousekey` and `System & Media key` in keymap*** to indicate corresponding actions instead of using action codes. While ***to use other special actions you should use keycode of `Fn` key defined in `fn_actions[]`.***
++
++
++### 2.1 Key Action
++This is a simple action that registers scancodes(HID usage in fact) to host on press event of key and unregister on release.
++
++#### Parameters
+++ **mods**: { ` MOD_LCTL`, ` MOD_LSFT`, ` MOD_LALT`, ` MOD_LGUI`,
++ ` MOD_RCTL`, ` MOD_RSFT`, ` MOD_RALT`, ` MOD_RGUI` }
+++ **key**: keycode
++
++
++#### 2.1.1 Normal key and Modifier
++***This action usually won't be used expressly in keymap*** because you can just use keycodes in `KEYMAP()` instead.
++
++You can define these actions on *'A'* key and *'left shift'* modifier with:
++
++ ACTION_KEY(KC_A)
++ ACTION_KEY(KC_LSFT)
++
++#### 2.1.2 Modified key
++This action is comprised of strokes of modifiers and a key. `Macro` action is needed if you want more complex key strokes.
++
++Say you want to assign a key to `Shift + 1` to get character *'!'* or `Alt + Tab` to switch application windows.
++
++ ACTION_MODS_KEY(MOD_LSFT, KC_1)
++ ACTION_MODS_KEY(MOD_LALT, KC_TAB)
++
++Or `Alt,Shift + Tab` can be defined. `ACTION_MODS_KEY(mods, key)` requires **4-bit modifier state** and a **keycode** as arguments. See `keycode.h` for `MOD_BIT()` macro.
++
++ ACTION_MODS_KEY(MOD_LALT | MOD_LSFT, KC_TAB)
++
++#### 2.1.3 Multiple Modifiers
++Registers multiple modifiers with pressing a key. To specify multiple modifiers use `|`.
++
++ ACTION_MODS(MOD_ALT | MOD_LSFT)
++
++#### 2.1.3 Modifier with Tap key([Dual role][dual_role])
++Works as a modifier key while holding, but registers a key on tap(press and release quickly).
++
++
++ ACTION_MODS_TAP_KEY(MOD_RCTL, KC_ENT)
++
++
++
++### 2.2 Layer Action
++These actions operate layers of keymap.
++
++#### Parameters
++You can specify a **target layer** of action and **when the action is executed**. Some actions take a **bit value** for bitwise operation.
++
++
+++ **layer**: `0`-`31`
+++ **on**: { `ON_PRESS` | `ON_RELEASE` | `ON_BOTH` }
+++ **bits**: 4-bit value and 1-bit mask bit
++
++
++#### 2.2.1 Default Layer
++Default Layer is a layer which always is valid and referred to when actions is not defined on other overlay layers.
++
++This sets Default Layer to given parameter `layer` and activate it.
++
++ ACTION_DEFAULT_LAYER_SET(layer)
++
++
++#### 2.2.2 Momentary
++Turns on `layer` momentarily while holding, in other words it activates when key is pressed and deactivate when released.
++
++ ACTION_LAYER_MOMENTARY(layer)
++
++
++#### 2.2.3 Toggle Switch
++Turns on `layer` with first type(press and release) and turns off with next.
++
++ ACTION_LAYER_TOGGLE(layer)
++
++
++#### 2.2.4 Momentary Switch with tap key
++Turns on `layer` momentary while holding, but registers key on tap(press and release quickly).
++
++ ACTION_LAYER_TAP_KEY(layer, key)
++
++
++#### 2.2.5 Momentary Switch with tap toggle
++Turns on `layer` momentary while holding and toggles it with serial taps.
++
++ ACTION_LAYER_TAP_TOGGLE(layer)
++
++
++#### 2.2.6 Invert state of layer
++Inverts current state of `layer`. If the layer is on it becomes off with this action.
++
++ ACTION_LAYER_INVERT(layer, on)
++
++
++#### 2.2.7 Turn On layer
++Turns on layer state.
++
++ ACTION_LAYER_ON(layer, on)
++
++Turns on layer state on press and turns off on release.
++
++ ACTION_LAYER_ON_OFF(layer)
++
++
++#### 2.2.8 Turn Off layer
++Turns off layer state.
++
++ ACTION_LAYER_OFF(layer, on)
++
++Turns off layer state on press and activates on release.
++
++ ACTION_LAYER_OFF_ON(layer)
++
++
++#### 2.2.9 Set layer
++Turn on layer only.
++`layer_state = (1<<layer) [layer: 0-31]`
++
++ ACTION_LAYER_SET(layer, on)
++
++Turns on layer only and clear all layer on release..
++
++ ACTION_LAYER_SET_CLEAR(layer)
++
++
++#### 2.2.10 Bitwise operation
++
++**part** indicates which part of 32bit layer state(0-7). **bits** is 5-bit value. **on** indicates when the action is executed.
++
++ ACTION_LAYER_BIT_AND(part, bits, on)
++ ACTION_LAYER_BIT_OR(part, bits, on)
++ ACTION_LAYER_BIT_XOR(part, bits, on)
++ ACTION_LAYER_BIT_SET(part, bits, on)
++
++These actions works with parameters as following code.
++
++ uint8_t shift = part*4;
++ uint32_t mask = (bits&0x10) ? ~(0xf<<shift) : 0;
++ uint32_t layer_state = layer_state <bitop> ((bits<<shift)|mask);
++
++
++Default Layer also has bitwise operations, they are executed when key is released.
++
++ ACTION_DEFAULT_LAYER_BIT_AND(part, bits)
++ ACTION_DEFAULT_LAYER_BIT_OR(part, bits)
++ ACTION_DEFAULT_LAYER_BIT_XOR(part, bits)
++ ACTION_DEFAULT_LAYER_BIT_SET(part, bits)
++
++
++
++### 2.3 Macro action
++***TBD***
++
++`Macro` action indicates complex key strokes.
++
++ MACRO( D(LSHIFT), D(D), END )
++ MACRO( U(D), U(LSHIFT), END )
++ MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END )
++
++#### 2.3.1 Macro Commands
++- **I()** change interval of stroke.
++- **D()** press key
++- **U()** release key
++- **T()** type key(press and release)
++- **W()** wait
++- **END** end mark
++
++#### 2.3.2 Examples
++
++***TODO: sample implementation***
++See `keyboard/hhkb/keymap.c` for sample.
++
++
++
++### 2.4 Function action
++***TBD***
++
++There are two type of action, normal `Function` and tappable `Function`.
++These actions call user defined function with `id`, `opt`, and key event information as arguments.
++
++#### 2.4.1 Function
++To define normal `Function` action in keymap use this.
++
++ ACTION_FUNCTION(id, opt)
++
++#### 2.4.2 Function with tap
++To define tappable `Function` action in keymap use this.
++
++ ACTION_FUNCTION_TAP(id, opt)
++
++#### 2.4.3 Implement user function
++`Function` actions can be defined freely with C by user in callback function:
++
++ void keymap_call_function(keyrecord_t *event, uint8_t id, uint8_t opt)
++
++This C function is called every time key is operated, argument `id` selects action to be performed and `opt` can be used for option. Function `id` can be 0-255 and `opt` can be 0-15.
++
++ `keyrecord_t` is comprised of key event and tap count. `keyevent_t` indicates which and when key is pressed or released. From `tap_count` you can know tap state, 0 means no tap. These information will be used in user function to decide how action of key is performed.
++
++ typedef struct {
++ keyevent_t event;
++ uint8_t tap_count;
++ } keyrecord_t;
++
++ typedef struct {
++ key_t key;
++ bool pressed;
++ uint16_t time;
++ } keyevent_t;
++
++ typedef struct {
++ uint8_t col;
++ uint8_t row;
++ } key_t;
++
++***TODO: sample implementation***
++See `keyboard/hhkb/keymap.c` for sample.
++
++
++
++### 2.5 Backlight Action
++These actions control the backlight.
++
++#### 2.5.1 Change backlight level
++Increase backlight level.
++
++ ACTION_BACKLIGHT_INCREASE()
++
++Decrease backlight level.
++
++ ACTION_BACKLIGHT_DECREASE()
++
++Step through backlight levels.
++
++ ACTION_BACKLIGHT_STEP()
++
++Turn a specific backlight level on or off.
++
++ ACTION_BACKLIGHT_LEVEL(1)
++
++#### 2.5.2 Turn on / off backlight
++Turn the backlight on and off without changing level.
++
++ ACTION_BACKLIGHT_TOGGLE()
++
++
++
++## 3. Layer switching Example
++There are some ways to switch layer with 'Layer' actions.
++
++### 3.1 Momentary switching
++Momentary switching changes layer only while holding Fn key.
++
++This action makes 'Layer 1' active(valid) on key press event and inactive on release event. Namely you can overlay a layer on lower layers or default layer temporarily with this action.
++
++ ACTION_LAYER_MOMENTARY(1)
++
++
++Note that after switching on press the actions on destination layer(Layer 1) are performed.
++***Thus you shall need to place an action to go back on destination layer***, or you will be stuck in destination layer without way to get back. Usually you need to place same action or 'KC_TRNS` on destination layer to get back.
++
++
++### 3.2 Toggle switching
++Toggle switching performed after releasing a key. With this action you can keep staying on the destination layer until you type the key again to return.
++
++This performs toggle switching action of 'Layer 2'.
++
++ ACTION_LAYER_TOGGLE(2)
++
++
++
++### 3.3 Momentary switching with Tap key
++These actions switch a layer only while holding a key but register the key on tap. **Tap** means to press and release a key quickly.
++
++ ACTION_LAYER_TAP_KEY(2, KC_SCLN)
++
++With this you can place a layer switching action on normal key like ';' without losing its original key register function. This action allows you to have layer switching action without necessity of a dedicated key. It means you can have it even on home row of keyboard.
++
++
++
++### 3.4 Momentary switching with Tap Toggle
++This switches layer only while holding a key but toggle layer with several taps. **Tap** means to press and release key quickly.
++
++ ACTION_LAYER_TAP_TOGGLE(1)
++
++Number of taps can be configured with `TAPPING_TOGGLE` in `config.h`, `5` by default.
++
++
++
++### 3.5 Momentary switching with Modifiers
++This registers modifier key(s) simultaneously with layer switching.
++
++ ACTION_LAYER_MODS(2, MOD_LSFT | MOD_LALT)
++
++
++
++## 4. Tapping
++Tapping is to press and release a key quickly. Tapping speed is determined with setting of `TAPPING_TERM`, which can be defined in `config.h`, 200ms by default.
++
++### 4.1 Tap Key
++This is a feature to assign normal key action and modifier including layer switching to just same one physical key. This is a kind of [Dual role key][dual_role]. It works as modifier when holding the key but registers normal key when tapping.
++
++Modifier with tap key:
++
++ ACTION_MODS_TAP_KEY(MOD_RSFT, KC_GRV)
++
++Layer switching with tap key:
++
++ ACTION_LAYER_TAP_KEY(2, KC_SCLN)
++
++[dual_role]: http://en.wikipedia.org/wiki/Modifier_key#Dual-role_keys
++
++
++### 4.2 Tap Toggle
++This is a feature to assign both toggle layer and momentary switch layer action to just same one physical key. It works as momentary layer switch when holding a key but toggle switch with several taps.
++
++ ACTION_LAYER_TAP_TOGGLE(1)
++
++
++### 4.3 Oneshot Modifier
++This runs onetime effects which modify only on just one following key. It works as normal modifier key when holding down while oneshot modifier when tapping.
++
++ ACTION_MODS_ONESHOT(MOD_LSFT)
++
++Say you want to type 'The', you have to push and hold Shift key before type 't' then release it before type 'h' and 'e', otherwise you'll get 'THe' or 'the' unintentionally. With Oneshot Modifier you can tap Shift then type 't', 'h' and 'e' normally, you don't need to holding Shift key properly here. This mean you can release Shift before 't' is pressed down.
++
++Oneshot effect is cancel unless following key is pressed down within `ONESHOT_TIMEOUT` of `config.h`. No timeout when it is `0` or not defined.
++
++
++### 4.4 Tap Toggle Mods
++Similar to layer tap toggle, this works as a momentary modifier when holding, but toggles on with several taps. A single tap will 'unstick' the modifier again.
++
++ ACTION_MODS_TAP_TOGGLE(MOD_LSFT)
++
++
++
++
++## 5. Legacy Keymap
++This was used in prior version and still works due to legacy support code in `common/keymap.c`. Legacy keymap doesn't support many of features that new keymap offers. ***It is not recommended to use Legacy Keymap for new project.***
++
++To enable Legacy Keymap support define this macro in `config.h`.
++
++ #define USE_LEGACY_KEYMAP
++
++Legacy Keymap uses two arrays `fn_layer[]` and `fn_keycode[]` to define Fn key. The index of arrays corresponds with postfix number of `Fn` key. Array `fn_layer[]` indicates destination layer to switch and `fn_keycode[]` has keycodes to send when tapping `Fn` key.
++
++In following setting example, `Fn0`, `Fn1` and `Fn2` switch layer to 1, 2 and 2 respectively. `Fn2` registers `Space` key when tapping while `Fn0` and `Fn1` doesn't send any key.
++
++ static const uint8_t PROGMEM fn_layer[] = {
++ 1, // Fn0
++ 2, // Fn1
++ 2, // Fn2
++ };
++
++ static const uint8_t PROGMEM fn_keycode[] = {
++ KC_NO, // Fn0
++ KC_NO, // Fn1
++ KC_SPC, // Fn2
++ };
++
++
++## 6. Terminology
++***TBD***
++### keymap
++is comprised of multiple layers.
++### layer
++is matrix of keycodes.
++### key
++is physical button on keyboard or logical switch on software.
++### keycode
++is codes used on firmware.
++### action
++is a function assigned on a key.
++### layer transparency
++Using transparent keycode one layer can refer key definition on other lower layer.
++### layer precedence
++Top layer has higher precedence than lower layers.
++### tapping
++is to press and release a key quickly.
++### Fn key
++is key which executes a special action like layer switching, mouse key, macro or etc.
++### dual role key
++<http://en.wikipedia.org/wiki/Modifier_key#Dual-role_keys>
--- /dev/null
--- /dev/null
++Other Keyboard Firmware Projects
++================================
++## PJRC USB Keyboard/Mouse Example[USB][PJRC][Teensy][AVR]
++- <http://www.pjrc.com/teensy/usb_keyboard.html>
++- <http://www.pjrc.com/teensy/usb_mouse.html>
++
++## kbupgrade[USB][V-USB][AVR]
++- <http://github.com/rhomann/kbupgrade>
++- <http://geekhack.org/showwiki.php?title=Island:8406>
++
++## c64key[USB][V-USB][AVR]
++- <http://symlink.dk/projects/c64key/>
++
++## rump[USB][V-USB][AVR]
++- <http://mg8.org/rump/>
++- <http://github.com/clee/rump>
++
++## dulcimer[USB][V-USB][AVR]
++- <http://www.schatenseite.de/dulcimer.html>
++
++## humblehacker-keyboard[USB][LUFA][AVR][Ergo]
++- <http://github.com/humblehacker>
++- <http://www.humblehacker.com/keyboard/>
++- <http://geekhack.org/showwiki.php?title=Island:6292>
++
++## ps2avr[PS/2][AVR]
++- <http://sourceforge.net/projects/ps2avr/>
++
++## ErgoDox[Ergo][Split][USB][AVR]
++- <http://geekhack.org/index.php?topic=22780.0>
++- <https://github.com/benblazak/ergodox-firmware>
++- <https://github.com/cub-uanic/tmk_keyboard>
++
++## Suka's keyboard collection[Ergo][Split][3DPrinting][USB][AVR]
++- <http://deskthority.net/workshop-f7/my-diy-keyboard-collection-or-how-i-became-a-kb-geek-t2534.html>
++- <https://github.com/frobiac/adnw>
++
++## bpiphany's AVR-Keyboard[PJRC][AVR][USB]
++- <https://github.com/BathroomEpiphanies/AVR-Keyboard>
++- <http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions>
++- <http://deskthority.net/wiki/Phantom>
++
++## USB-USB keyboard remapper[converter][USB-USB][AVR][Arduino]
++- <http://forum.colemak.com/viewtopic.php?pid=10837>
++- <https://github.com/darkytoothpaste/keymapper>
++
++## USB-USB converter threads[converter][USB-USB]
++- <http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html>
++- <http://geekhack.org/index.php?topic=19458.0>
++
++## kbdbabel.org[converter][vintage][protocol][8051]
++Great resource of vintage keyboard protocol information and code
++
++- <http://www.kbdbabel.org/>
++
++## Haata's kiibohd Controller[converter][vintage][protocol][AVR][PJRC][Cortex]
++A lots of vintage keyboard protocol supports
++
++- <http://gitorious.org/kiibohd-controller>
++
++## Kinesis ergonomic keyboard firmware replacement[V-USB][LUFA][Ergo]
++- <https://github.com/chrisandreae/kinesis-firmware>
--- /dev/null
--- /dev/null
++#ifndef SUART\r
++#define SUART\r
++\r
++void xmit(uint8_t);\r
++uint8_t rcvr(void);\r
++uint8_t recv(void);\r
++\r
++#endif /* SUART */\r
projects / max / tmk_keyboard.git / commitdiff
