I2C driver docs (#4298 )

* I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix
Keymap for random key presses for the scrabblepad (#4356 )
2018-11-10 15:26:39 -05:00 · 2018-11-10 08:22:36 -08:00 · 2018-11-10 08:21:24 -08:00 · 2018-11-09 12:15:37 -08:00 · 2018-11-09 11:16:08 -08:00 · 2018-11-09 08:49:29 -08:00
173 changed files with 1439 additions and 162 deletions
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@ -79,6 +79,7 @@
  * [Hand Wiring Guide](hand_wire.md)
  * [ISP Flashing Guide](isp_flashing_guide.md)
  * [ARM Debugging Guide](arm_debugging.md)
+  * [I2C Driver](i2c_driver.md)

 * For a Deeper Understanding
  * [How Keyboards Work](how_keyboards_work.md)
--- a/docs/_summary.md
+++ b/docs/_summary.md
@ -79,6 +79,7 @@
  * [Hand Wiring Guide](hand_wire.md)
  * [ISP Flashing Guide](isp_flashing_guide.md)
  * [ARM Debugging Guide](arm_debugging.md)
+  * [I2C Driver](i2c_driver.md)

 * For a Deeper Understanding
  * [How Keyboards Work](how_keyboards_work.md)
--- a/docs/i2c_driver.md
+++ b/docs/i2c_driver.md
@ -0,0 +1,83 @@
+# I2C Master Driver
+
+The I2C Master drivers used in QMK have a set of common functions to allow portability between MCUs.
+
+## Available functions
+
+|Function                                                                                                          |Description                                                                                                                                                                  |
+|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+|`void i2c_init(void);`                                                                                            |Initializes the I2C driver. This function should be called once before any transaction is initiated.                                                                         |
+|`uint8_t i2c_start(uint8_t address);`                                                                             |Starts an I2C transaction. Address is the 7-bit slave address without the direction bit.                                                                                     |
+|`uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);`                        |Transmit data over I2C. Address is the 7-bit slave address without the direction.                                                                                            |
+|`uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);`                        |Transmit data over I2C. Address is the 7-bit slave address without the direction. Returns status of transaction.                                                             |
+|`uint8_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);`                         |Receive data over I2C. Address is the 7-bit slave address without the direction. Saves number of bytes specified by `length` in `data` array. Returns status of transaction. |
+|`uint8_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);`       |Same as the `i2c_transmit` function but `regaddr` sets where in the slave the data will be written.                                                                          |
+|`uint8_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);`        |Same as the `i2c_receive` function but `regaddr` sets from where in the slave the data will be read.                                                                         |
+|`uint8_t i2c_stop(uint16_t timeout);`                                                                             |Stops the I2C driver.                                                                                                                                                        |
+
+### Function Return
+
+All the above functions, except `void i2c_init(void);` return the following truth table:
+
+|Return Value   |Description                                        |
+|---------------|---------------------------------------------------|
+|0              |Operation executed successfully.                   |
+|-1             |Operation failed.                                  |
+|-2             |Operation timed out.                               |
+
+
+## AVR
+
+### Configuration
+
+The following defines can be used to configure the I2C master driver.
+
+|Variable          |Description                                        |Default|
+|------------------|---------------------------------------------------|-------|
+|`#F_SCL`          |Clock frequency in Hz                              |400KHz |
+|`#Prescaler`      |Divides master clock to aid in I2C clock selection |1      |
+
+AVRs usually have set GPIO which turn into I2C pins, therefore no further configuration is required.
+
+## ARM
+
+For ARM the Chibios I2C HAL driver is under the hood.
+This section assumes an STM32 MCU.
+
+### Configuration
+
+The configuration for ARM MCUs can be quite complex as often there are multiple I2C drivers which can be assigned to a variety of ports.
+
+Firstly the `mcuconf.h` file must be setup to enable the necessary hardware drivers.
+
+|Variable                      |Description                                                                        |Default|
+|------------------------------|------------------------------------------------------------------------------------|-------|
+|`#STM32_I2C_USE_XXX`          |Enable/Disable the hardware driver XXX (each driver should be explicitly listed)    |FALSE  |
+|`#STM32_I2C_BUSY_TIMEOUT`     |Time in ms until the I2C command is aborted if no response is received              |50     |
+|`#STM32_I2C_XXX_IRQ_PRIORITY` |Interrupt priority for hardware driver XXX (THIS IS AN EXPERT SETTING)              |10     |
+|`#STM32_I2C_USE_DMA`          |Enable/Disable the ability of the MCU to offload the data transfer to the DMA unit  |TRUE   |
+|`#STM32_I2C_XXX_DMA_PRIORITY` |Priority of DMA unit for hardware driver XXX (THIS IS AN EXPERT SETTING)            |1      |
+
+Secondly, in the `halconf.h` file, `#define HAL_USE_I2C` must be set to `TRUE`. This allows ChibiOS to load its I2C driver.
+
+Lastly, we need to assign the correct GPIO pins depending on the I2C hardware driver we want to use.
+
+By default the I2C1 hardware driver is assumed to be used. If another hardware driver is used,  `#define I2C_DRIVER I2CDX` should be added to the `config.h` file with X being the number of hardware driver used. For example is I2C3 is enabled, the `config.h` file should contain `#define I2C_DRIVER I2CD3`. This aligns the QMK I2C driver with the Chibios I2C driver.
+
+STM32 MCUs allows a variety of pins to be configured as I2C pins depending on the hardware driver used. By default B6 and B7 are set to I2C.
+
+This can be changed by declaring the `i2c_init` function which intentionally has a weak attribute. Please consult the datasheet of your MCU for the available GPIO configurations. The following is an example initialization function:
+
+```C
+void i2c_init(void)
+{
+  setPinInput(B6); // Try releasing special pins for a short time
+  setPinInput(B7);
+  chThdSleepMilliseconds(10); // Wait for the release to happen
+
+  palSetPadMode(GPIOB, 6, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B6 to I2C function
+  palSetPadMode(GPIOB, 7, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B7 to I2C function
+}
+```
+
+
--- a/drivers/arm/i2c_master.c
+++ b/drivers/arm/i2c_master.c
@ -26,6 +26,7 @@
 */

 #include "i2c_master.h"
+#include "quantum.h"
 #include <string.h>
 #include <hal.h>

@ -41,9 +42,11 @@ static const I2CConfig i2cconfig = {
  0
 };

+__attribute__ ((weak))
 void i2c_init(void)
 {
-  palSetGroupMode(GPIOB, GPIOB_PIN6 | GPIOB_PIN7, 0, PAL_MODE_INPUT); // Try releasing special pins for a short time
+  setPinInput(B6); // Try releasing special pins for a short time
+  setPinInput(B7);
  chThdSleepMilliseconds(10);

  palSetPadMode(GPIOB, 6, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP);
--- a/keyboards/1upkeyboards/1up60hse/keymaps/default/config.h
+++ b/keyboards/1upkeyboards/1up60hse/keymaps/default/config.h
@ -1,4 +1,5 @@
 /* Copyright 2018 MechMerlin
+ * Copyright 2018 Logan Huskins
 *
 * 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
--- a/keyboards/1upkeyboards/1up60hse/keymaps/default/keymap.c
+++ b/keyboards/1upkeyboards/1up60hse/keymaps/default/keymap.c
@ -1,4 +1,5 @@
 /* Copyright 2018 MechMerlin
+ * Copyright 2018 Logan Huskins
 *
 * 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
@ -17,28 +18,34 @@

 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [0] = LAYOUT_60_ansi(
-		KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, 
-		KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, 
-		MO(1), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, 
-		KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_LSFT, 
-		KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(2), KC_RGUI, KC_RCTL),
+    KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
+    KC_EQL, KC_BSPC, KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O,
+    KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H,
+    KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B,
+    KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_LCTL, KC_LGUI, KC_LALT, KC_SPC,
+    KC_RALT, KC_RGUI, MO(1), KC_LCTL
+  ),

-	[1] = LAYOUT_60_ansi(
-		KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, 
-		KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_TRNS, KC_LEFT, KC_DOWN, KC_RGHT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_LSFT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+  [1] = LAYOUT_60_ansi(
+    KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10,
+    KC_F11, KC_F12, KC_DEL, KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_PSCR, KC_SLCK, KC_PAUS, KC_TRNS, KC_TRNS, KC_LEFT, KC_DOWN,
+    KC_RGHT, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_INS, KC_HOME, KC_PGUP, KC_TRNS,
+    KC_TRNS, KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_END,
+    KC_PGDN, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, MO(2), KC_TRNS, KC_TRNS
+  ),

  [2] = LAYOUT_60_ansi(
-		RESET, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_CAPS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, BL_STEP, BL_DEC, BL_INC, BL_TOGG, KC_TRNS, KC_TRNS, KC_TRNS, 
-		KC_TRNS, KC_TRNS, KC_TRNS, RGB_VAD, RGB_VAI, RGB_SAI, RGB_HUD, RGB_HUI, RGB_MOD, RGB_TOG, KC_TRNS, KC_TRNS, 
-		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, RESET, BL_TOGG, BL_INC, BL_DEC, BL_STEP, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUI,
+    RGB_SAI, RGB_VAI, RGB_SPI, RGB_M_P, RGB_M_B, RGB_M_R, RGB_M_SW, KC_TRNS, KC_TRNS, KC_TRNS,
+    KC_TRNS, RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, RGB_SPD, RGB_M_SN, RGB_M_K, RGB_M_X, RGB_M_G,
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+  ),
 };

-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+bool process_record_user(uint16_t keycode, keyrecord_t *record)
+{
  return true;
 }
-
--- a/keyboards/1upkeyboards/1up60hse/keymaps/default/readme.md
+++ b/keyboards/1upkeyboards/1up60hse/keymaps/default/readme.md
@ -1,6 +1,4 @@
-# 1up60hse default keymap
+# 1up60hse default keymap generated by QMK Configurator

-This is the default keymap provided by [1upkeyboards](https://www.1upkeyboards.com).  
+This is the keymap used by [QMK Configurator](https://config.qmk.fm/#/1upkeyboards/1up60hse/LAYOUT_60_ansi) as default.  

-## Notes
- Software reset key is located on `Esc` on the third layer.
--- a/keyboards/30wer/30wer.c
+++ b/keyboards/30wer/30wer.c
@ -0,0 +1 @@
+#include "30wer.h"
--- a/keyboards/30wer/30wer.h
+++ b/keyboards/30wer/30wer.h
@ -0,0 +1,14 @@
+#pragma once
+
+#include "quantum.h"
+
+#define LAYOUT( \
+	k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, \
+	k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, \
+	     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b \
+) \
+{ \
+	{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c }, \
+	{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c }, \
+	{      k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b } \
+}
--- a/keyboards/30wer/config.h
+++ b/keyboards/30wer/config.h
@ -0,0 +1,31 @@
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x1234
+#define PRODUCT_ID      0x5678
+#define DEVICE_VER      0x0000
+#define MANUFACTURER    8o7wer
+#define PRODUCT         30wer
+#define DESCRIPTION     Gherkin style construction 30% staggered pcb kit
+
+/* key matrix size */
+#define MATRIX_ROWS 3
+#define MATRIX_COLS 13
+
+/* pcb default pin-out */
+#define MATRIX_ROW_PINS { E6, B4, B5 }
+#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B6, D1, D0, D4, C6, D7 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* key combination for command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/* prevent stuck modifiers */
+#define PREVENT_STUCK_MODIFIERS
--- a/keyboards/30wer/info.json
+++ b/keyboards/30wer/info.json
@ -0,0 +1,51 @@
+{
+    "keyboard_name": "30wer", 
+    "url": "", 
+    "maintainer": "qmk", 
+    "width": 13.25, 
+    "height": 3, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label":"Tab", "x":0, "y":0},
+                {"label":"Q", "x":1, "y":0},
+                {"label":"W", "x":2, "y":0},
+                {"label":"E", "x":3, "y":0},
+                {"label":"R", "x":4, "y":0},
+                {"label":"T", "x":5, "y":0},
+                {"label":"Y", "x":6, "y":0},
+                {"label":"U", "x":7, "y":0},
+                {"label":"I", "x":8, "y":0},
+                {"label":"O", "x":9, "y":0},
+                {"label":"P", "x":10, "y":0},
+                {"label":"Bksp", "x":11, "y":0},
+                {"label":"Delete", "x":12, "y":0, "w":1.25},
+                {"label":"Ctrl", "x":0, "y":1, "w":1.25},
+                {"label":"A", "x":1.25, "y":1},
+                {"label":"S", "x":2.25, "y":1},
+                {"label":"D", "x":3.25, "y":1},
+                {"label":"F", "x":4.25, "y":1},
+                {"label":"G", "x":5.25, "y":1},
+                {"label":"H", "x":6.25, "y":1},
+                {"label":"J", "x":7.25, "y":1},
+                {"label":"K", "x":8.25, "y":1},
+                {"label":"L", "x":9.25, "y":1},
+                {"label":":", "x":10.25, "y":1},
+                {"label":"\"", "x":11.25, "y":1},
+                {"label":"Enter", "x":12.25, "y":1},
+                {"label":"Shift", "x":0, "y":2, "w":1.75},
+                {"label":"Z", "x":1.75, "y":2},
+                {"label":"X", "x":2.75, "y":2},
+                {"label":"C", "x":3.75, "y":2},
+                {"label":"V", "x":4.75, "y":2},
+                {"label":"B", "x":5.75, "y":2},
+                {"label":"N", "x":6.75, "y":2},
+                {"label":"M", "x":7.75, "y":2},
+                {"label":"<", "x":8.75, "y":2},
+                {"label":">", "x":9.75, "y":2},
+                {"label":"?", "x":10.75, "y":2},
+                {"label":"Space", "x":11.75, "y":2, "w":1.5}
+            ]
+        }
+    }
+}
--- a/keyboards/30wer/keymaps/default/keymap.c
+++ b/keyboards/30wer/keymaps/default/keymap.c
@ -0,0 +1,17 @@
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[0] = LAYOUT( \
+  KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_BSPC, \
+  KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT, \
+           KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, LT(1, KC_SPC) \
+),
+
+[1] = LAYOUT( \
+  KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_UP,   KC_DEL, \
+  _______, _______, _______, _______, RESET,   _______, _______, _______, _______, _______, KC_LEFT, KC_RGHT, _______, \
+           KC_LALT, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DOWN, _______ \
+),
+
+};
--- a/keyboards/30wer/readme.md
+++ b/keyboards/30wer/readme.md
@ -0,0 +1,16 @@
+30wer by 8o7wer
+===
+
+![30wer](https://i.imgur.com/ZYbRvY7.png)
+
+Keyboard Maintainer: [Filip Sund](https://github.com/FSund)  
+Hardware Supported: Pro Micro  
+Hardware Availability: Group buy
+
+More info in the [group by thread at Keebtalk](https://www.keebtalk.com/t/gb-30wer-by-8o7wer/3618/).
+
+Make example for this keyboard (after setting up your build environment):
+
+    make 30wer:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
--- a/keyboards/30wer/rules.mk
+++ b/keyboards/30wer/rules.mk
@ -0,0 +1,60 @@
+# MCU name
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+# Bootloader
+#     This definition is optional, and if your keyboard supports multiple bootloaders of
+#     different sizes, comment this out, and the correct address will be loaded
+#     automatically (+60). See bootloader.mk for all options.
+BOOTLOADER = caterina
+
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = yes        # Console for debug(+400)
+COMMAND_ENABLE = no         # Commands for debug and configuration
+NKRO_ENABLE = yes           # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no 		# Enable WS2812 RGB underlight.
--- a/keyboards/40percentclub/4x4/4x4.c
+++ b/keyboards/40percentclub/4x4/4x4.c
--- a/keyboards/40percentclub/4x4/4x4.h
+++ b/keyboards/40percentclub/4x4/4x4.h
--- a/keyboards/40percentclub/4x4/config.h
+++ b/keyboards/40percentclub/4x4/config.h
--- a/keyboards/40percentclub/4x4/keymaps/default/config.h
+++ b/keyboards/40percentclub/4x4/keymaps/default/config.h
--- a/keyboards/40percentclub/4x4/keymaps/default/keymap.c
+++ b/keyboards/40percentclub/4x4/keymaps/default/keymap.c
--- a/keyboards/40percentclub/4x4/readme.md
+++ b/keyboards/40percentclub/4x4/readme.md
@ -17,7 +17,8 @@ Hardware Availability: [4x4x4x4x4 project on 40% Keyboards](http://www.40percent

 Make example for this keyboard (after setting up your build environment):  

-    make 4x4:default
+    make 40percentclub/4x4:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

-See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.  
 First pass at adding support for the 4x4 keyboard. Compiles but completely untested. Intended to kick-start development.  
--- a/keyboards/40percentclub/4x4/rules.mk
+++ b/keyboards/40percentclub/4x4/rules.mk
@ -1,5 +1,4 @@
 # MCU name
-#MCU = at90usb1286
 MCU = atmega32u4

 # Processor frequency.
@ -43,11 +42,11 @@ OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
 #   Atmel DFU loader 4096
 #   LUFA bootloader  4096
 #   USBaspLoader     2048
-OPT_DEFS += -DBOOTLOADER_SIZE=4096
+# OPT_DEFS += -DBOOTLOADER_SIZE=4096

 # Bootloader
 #     This definition is optional, and if your keyboard supports multiple bootloaders of
-#     different sizes, comment this out, and the correct address will be loaded 
+#     different sizes, comment this out, and the correct address will be loaded
 #     automatically (+60). See bootloader.mk for all options.
 BOOTLOADER = caterina

@ -71,4 +70,5 @@ AUDIO_ENABLE = no           # Audio output on port C6
 FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
 HD44780_ENABLE = no 		# Enable support for HD44780 based LCDs (+400)

-LAYOUTS = ortho_4x4  ortho_4x8  ortho_4x12  ortho_4x16 
+#FIXME: Community keymap build are currently failing due to missing functionality
+#LAYOUTS = ortho_4x4  ortho_4x8  ortho_4x12  ortho_4x16
--- a/keyboards/40percentclub/5x5/5x5.c
+++ b/keyboards/40percentclub/5x5/5x5.c
--- a/keyboards/40percentclub/5x5/5x5.h
+++ b/keyboards/40percentclub/5x5/5x5.h
--- a/keyboards/40percentclub/5x5/config.h
+++ b/keyboards/40percentclub/5x5/config.h
--- a/keyboards/40percentclub/5x5/keymaps/default/config.h
+++ b/keyboards/40percentclub/5x5/keymaps/default/config.h
--- a/keyboards/40percentclub/5x5/keymaps/default/keymap.c
+++ b/keyboards/40percentclub/5x5/keymaps/default/keymap.c
--- a/keyboards/40percentclub/5x5/readme.md
+++ b/keyboards/40percentclub/5x5/readme.md
@ -17,7 +17,8 @@ Hardware Availability: [5x5 project on 40% Keyboards](http://www.40percent.club/

 Make example for this keyboard (after setting up your build environment):

-    make 5x5:default
+    make 40percentclub/5x5:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

-See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.    
 First pass at adding support for the 4x4 keyboard. Compiles but completely untested. Intended to kick-start development.  
--- a/keyboards/40percentclub/5x5/rules.mk
+++ b/keyboards/40percentclub/5x5/rules.mk
@ -1,5 +1,4 @@
 # MCU name
-#MCU = at90usb1286
 MCU = atmega32u4

 # Processor frequency.
@ -43,7 +42,7 @@ OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
 #   Atmel DFU loader 4096
 #   LUFA bootloader  4096
 #   USBaspLoader     2048
-OPT_DEFS += -DBOOTLOADER_SIZE=4096
+# OPT_DEFS += -DBOOTLOADER_SIZE=4096

 # Bootloader
 #     This definition is optional, and if your keyboard supports multiple bootloaders of
@ -71,4 +70,5 @@ AUDIO_ENABLE = no           # Audio output on port C6
 FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
 HD44780_ENABLE = no 		# Enable support for HD44780 based LCDs (+400)

-LAYOUTS = ortho_5x5  ortho_5x10  ortho_5x15
+#FIXME: Community keymap build are currently failing due to missing functionality
+#LAYOUTS = ortho_5x5  ortho_5x10  ortho_5x15
--- a/keyboards/40percentclub/6lit/6lit.c
+++ b/keyboards/40percentclub/6lit/6lit.c
--- a/keyboards/40percentclub/6lit/6lit.h
+++ b/keyboards/40percentclub/6lit/6lit.h
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
yiancar	4083614023	I2C driver docs (#4298 ) * I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix	2018-11-10 15:26:39 -05:00
gorbachev	3ba242cc3f	Keymap for random key presses for the scrabblepad (#4356 ) * Random key presses for scrabblepad * Fix keymap code comments * Remove unused methods as per code review	2018-11-10 08:22:36 -08:00
Logan Huskins	b3853e7d40	Keymap: Add default keymap from web for 1up60hse (#4351 )	2018-11-10 08:21:24 -08:00
MechMerlin	d6184be67a	IDOBO Keyboard Support (75Keys Aluminum Keyboard) (#4401 ) * initial commit * put my name everywhere * get the switch matrix correct * add a basic keymap * use a better LAYOUT macro * update readme * Add QMK Configurator support	2018-11-09 12:15:37 -08:00
mcmadhatter	519ce723fb	Added support for backlight on diverge3 , and added a UK iso layout (#4392 ) * Added support for backlight , and a UK iso layout Added support for backlight , and a UK iso layout. Now uses the SPLIT_KEYBOARD #define rather than relying on lets split * Update keyboards/diverge3/keymaps/isoUK/keymap.c Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/isoUK/keymap.c Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Simplified the lower layer Simplified the lower layer * dir rename to snake case dir rename to snake case * changed dir case changed dir case * Update keyboards/diverge3/rules.mk Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/keymap.c Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/keymap.c Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/keymap.c Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * Update keyboards/diverge3/keymaps/iso_uk/config.h Co-Authored-By: mcmadhatter <mcmadhatter@hotmail.com> * aligned and tidyied up aligned and tidyied up	2018-11-09 11:16:08 -08:00
Jason Thigpen	6ae409dd55	Add my new ANSI layout dz60 setup (#4397 ) * minor additions to alps64 and dz60 * Rename crd keymap to represent 2u lshift layout * Add crd's new ANSI layout dz60 with preferred layers	2018-11-09 08:49:29 -08:00
dlgoodr	fa2183a64a	Keymap: dlg's tada68 keymap (#4289 ) * dlg's keymap * fix list order * remove cruft * pragma Co-Authored-By: dlgoodr <dlg@dsrw.org> * turn on bootmagic, enable swapping ` and Esc while I figure out which compromise is least bad	2018-11-08 17:01:16 -08:00
zvecr	73883425a5	relocate 40percent.club boards to new parent folder (#4380 ) * Initial move of 40percent.club boards to common parent folder. * Refactor readme files to be consistent * Refactor readme files to be consistent - fix make command examples. * Refactor readme files to be consistent - align readme filenames. * Refactor readme files to be consistent - fix repo url. * Disable Community keymap builds as they are currently failing due to missing functionality * Move more of 40percent.club boards to common parent folder. * Refactor readme files to be consistent - align readme filenames. * Refactor readme files to be consistent - fix make command examples.	2018-11-08 15:17:41 -08:00
Filip Sund	ef84bd9799	Keyboard: Add 30wer config and keymap (#4386 ) * Preliminary 30wer firmware. Not tested on real board yet. * Added a layer to default 30wer keymap. * Wrote readme for 30wer. * Added 30wer info.json.	2018-11-08 15:12:42 -08:00
Ryoichi KATO	5eb69ca224	Keyboard: fix ifdef for crkbd's default/keymap.c undef SSD1306OLED should not kill entire process_record_user() function.	2018-11-08 06:45:09 -08:00
Abhinav	ba76fcfb8b	Add Layout-b for GH60 satan (#4123 ) * Add Layout-b for GH60 satan * Update layout, toggle for colemak layout * Rename layout, replace function with KC_GESC * Update Layer order, Readme * Remove unnecessary code * Add backspace in extend layer	2018-11-07 21:39:29 -08:00
Konstantin Đorđević	945dd946ab	Fix misspelled make option, format rules.mk files (#4382 )	2018-11-07 09:29:57 -08:00