~ruther/qmk_firmware

558f3ec1eb325caf706efc15e2fab26121aba442 — IBNobody 9 years ago f0388a5
Use keyboard config for nkro (#7)

* removing nkro references - wip

* changed NKRO to be defined by keymap_config
M keyboards/planck/keymaps/pvc/Makefile => keyboards/planck/keymaps/pvc/Makefile +2 -2
@@ 1,9 1,9 @@

# Build Options
#   change to "no" to disable the options, or define them in the Makefile in 
#   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 = yes # Virtual DIP switch configuration(+1000)
BOOTMAGIC_ENABLE = no  # Virtual DIP switch configuration(+1000)
MOUSEKEY_ENABLE  = yes # Mouse keys(+4700)
EXTRAKEY_ENABLE  = yes # Audio control and System control(+450)
CONSOLE_ENABLE   = no  # Console for debug(+400)

M keyboards/planck/keymaps/pvc/keymap.c => keyboards/planck/keymaps/pvc/keymap.c +3 -2
@@ 83,6 83,7 @@ enum keyboard_macros {
#define SC_ACLS             LALT(KC_F4)
#define SC_CCLS             LCTL(KC_F4)

#define TG_NKRO             MAGIC_TOGGLE_NKRO
#define OS_SHFT             KC_FN0

#define _______             KC_TRNS


@@ 206,7 207,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[LAYER_ADJUST] = {
  { XXXXXXX, M_BRTOG, M_BSPDU, M_BSPDD, M_BDFLT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, MU_TOG , AU_TOG  },
  { XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX },
  { XXXXXXX, M_QWRTY, XXXXXXX, XXXXXXX, M_BACKL, RESET  , XXXXXXX, M_MOUSE, XXXXXXX, XXXXXXX, MUV_IN , XXXXXXX },
  { XXXXXXX, M_QWRTY, XXXXXXX, XXXXXXX, M_BACKL, RESET  , TG_NKRO, M_MOUSE, XXXXXXX, XXXXXXX, MUV_IN , XXXXXXX },
  { XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, M_UPPER, XXXXXXX, XXXXXXX, M_LOWER, XXXXXXX, TMPO_DN, MUV_DE , TMPO_UP }
},



@@ 236,7 237,7 @@ void persistant_default_layer_set(uint16_t default_layer)
}

const uint16_t PROGMEM fn_actions[] = {
    [0] = ACTION_MODS_ONESHOT(MOD_LSFT),
    [0] = ACTION_MODS_ONESHOT(MOD_RSFT),
};

const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)

M quantum/keycode_config.h => quantum/keycode_config.h +5 -0
@@ 1,6 1,9 @@
#include "eeconfig.h"
#include "keycode.h"

#ifndef KEYCODE_CONFIG_H
#define KEYCODE_CONFIG_H

uint16_t keycode_config(uint16_t keycode);

/* NOTE: Not portable. Bit field order depends on implementation */


@@ 19,3 22,5 @@ typedef union {
} keymap_config_t;

extern keymap_config_t keymap_config;

#endif /* KEYCODE_CONFIG_H */

M quantum/keymap.h => quantum/keymap.h +1 -0
@@ 111,6 111,7 @@ enum quantum_keycodes {
    MAGIC_UNSWAP_BACKSLASH_BACKSPACE,
    MAGIC_UNHOST_NKRO,
    MAGIC_UNSWAP_ALT_GUI,
    MAGIC_TOGGLE_NKRO,

    // Leader key
#ifndef DISABLE_LEADER

M quantum/quantum.c => quantum/quantum.c +68 -56
@@ 27,10 27,6 @@ static void do_code16 (uint16_t code, void (*f) (uint8_t)) {
    f(KC_RGUI);
}

#ifdef NKRO_ENABLE
  extern bool keyboard_nkro;
#endif

void register_code16 (uint16_t code) {
  do_code16 (code, register_code);
  register_code (code);


@@ 203,7 199,7 @@ bool process_record_quantum(keyrecord_t *record) {
	  return false;
      break;
	#endif
    case MAGIC_SWAP_CONTROL_CAPSLOCK ... MAGIC_UNSWAP_ALT_GUI:
    case MAGIC_SWAP_CONTROL_CAPSLOCK ... MAGIC_TOGGLE_NKRO:
      if (record->event.pressed) {
        // MAGIC actions (BOOTMAGIC without the boot)
        if (!eeconfig_is_enabled()) {


@@ 211,57 207,73 @@ bool process_record_quantum(keyrecord_t *record) {
        }
        /* keymap config */
        keymap_config.raw = eeconfig_read_keymap();
        if (keycode == MAGIC_SWAP_CONTROL_CAPSLOCK) {
            keymap_config.swap_control_capslock = 1;
        } else if (keycode == MAGIC_CAPSLOCK_TO_CONTROL) {
            keymap_config.capslock_to_control = 1;
        } else if (keycode == MAGIC_SWAP_LALT_LGUI) {
            keymap_config.swap_lalt_lgui = 1;
        } else if (keycode == MAGIC_SWAP_RALT_RGUI) {
            keymap_config.swap_ralt_rgui = 1;
        } else if (keycode == MAGIC_NO_GUI) {
            keymap_config.no_gui = 1;
        } else if (keycode == MAGIC_SWAP_GRAVE_ESC) {
            keymap_config.swap_grave_esc = 1;
        } else if (keycode == MAGIC_SWAP_BACKSLASH_BACKSPACE) {
            keymap_config.swap_backslash_backspace = 1;
        } else if (keycode == MAGIC_HOST_NKRO) {
            keymap_config.nkro = 1;

#ifdef NKRO_ENABLE
            clear_keyboard(); // clear to prevent stuck keys
            keyboard_nkro = keymap_config.nkro;
#endif
        } else if (keycode == MAGIC_SWAP_ALT_GUI) {
            keymap_config.swap_lalt_lgui = 1;
            keymap_config.swap_ralt_rgui = 1;
        }
        /* UNs */
        else if (keycode == MAGIC_UNSWAP_CONTROL_CAPSLOCK) {
            keymap_config.swap_control_capslock = 0;
        } else if (keycode == MAGIC_UNCAPSLOCK_TO_CONTROL) {
            keymap_config.capslock_to_control = 0;
        } else if (keycode == MAGIC_UNSWAP_LALT_LGUI) {
            keymap_config.swap_lalt_lgui = 0;
        } else if (keycode == MAGIC_UNSWAP_RALT_RGUI) {
            keymap_config.swap_ralt_rgui = 0;
        } else if (keycode == MAGIC_UNNO_GUI) {
            keymap_config.no_gui = 0;
        } else if (keycode == MAGIC_UNSWAP_GRAVE_ESC) {
            keymap_config.swap_grave_esc = 0;
        } else if (keycode == MAGIC_UNSWAP_BACKSLASH_BACKSPACE) {
            keymap_config.swap_backslash_backspace = 0;
        } else if (keycode == MAGIC_UNHOST_NKRO) {
            keymap_config.nkro = 0;
#ifdef NKRO_ENABLE
            clear_keyboard(); // clear to prevent stuck keys
            keyboard_nkro = keymap_config.nkro;
#endif
        } else if (keycode == MAGIC_UNSWAP_ALT_GUI) {
            keymap_config.swap_lalt_lgui = 0;
            keymap_config.swap_ralt_rgui = 0;
        switch (keycode)
        {
          case MAGIC_SWAP_CONTROL_CAPSLOCK:
            keymap_config.swap_control_capslock = true;
            break;
          case MAGIC_CAPSLOCK_TO_CONTROL:
            keymap_config.capslock_to_control = true;
            break;
          case MAGIC_SWAP_LALT_LGUI:
            keymap_config.swap_lalt_lgui = true;
            break;
          case MAGIC_SWAP_RALT_RGUI:
            keymap_config.swap_ralt_rgui = true;
            break;
          case MAGIC_NO_GUI:
            keymap_config.no_gui = true;
            break;
          case MAGIC_SWAP_GRAVE_ESC:
            keymap_config.swap_grave_esc = true;
            break;
          case MAGIC_SWAP_BACKSLASH_BACKSPACE:
            keymap_config.swap_backslash_backspace = true;
            break;
          case MAGIC_HOST_NKRO:
            keymap_config.nkro = true;
            break;
          case MAGIC_SWAP_ALT_GUI:
            keymap_config.swap_lalt_lgui = true;
            keymap_config.swap_ralt_rgui = true;
            break;
          case MAGIC_UNSWAP_CONTROL_CAPSLOCK:
            keymap_config.swap_control_capslock = false;
            break;
          case MAGIC_UNCAPSLOCK_TO_CONTROL:
            keymap_config.capslock_to_control = false;
            break;
          case MAGIC_UNSWAP_LALT_LGUI:
            keymap_config.swap_lalt_lgui = false;
            break;
          case MAGIC_UNSWAP_RALT_RGUI:
            keymap_config.swap_ralt_rgui = false;
            break;
          case MAGIC_UNNO_GUI:
            keymap_config.no_gui = false;
            break;
          case MAGIC_UNSWAP_GRAVE_ESC:
            keymap_config.swap_grave_esc = false;
            break;
          case MAGIC_UNSWAP_BACKSLASH_BACKSPACE:
            keymap_config.swap_backslash_backspace = false;
            break;
          case MAGIC_UNHOST_NKRO:
            keymap_config.nkro = false;
            break;
          case MAGIC_UNSWAP_ALT_GUI:
            keymap_config.swap_lalt_lgui = false;
            keymap_config.swap_ralt_rgui = false;
            break;
          case MAGIC_TOGGLE_NKRO:
            keymap_config.nkro = !keymap_config.nkro;
            break;
          default:
            break;
        }
        eeconfig_update_keymap(keymap_config.raw);
        clear_keyboard(); // clear to prevent stuck keys

        return false;
      }
      break;


@@ 284,7 296,7 @@ bool process_record_quantum(keyrecord_t *record) {
        unregister_mods(MOD_BIT(KC_LSFT));
      }
      return false;
      break;
      // break;
    }

    case KC_RSPC: {


@@ 306,7 318,7 @@ bool process_record_quantum(keyrecord_t *record) {
        unregister_mods(MOD_BIT(KC_RSFT));
      }
      return false;
      break;
      // break;
    }
    default: {
      shift_interrupted[0] = true;

M tmk_core/common/action_util.c => tmk_core/common/action_util.c +7 -3
@@ 20,6 20,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
#include "action_util.h"
#include "action_layer.h"
#include "timer.h"
#include "keycode_config.h"

extern keymap_config_t keymap_config;


static inline void add_key_byte(uint8_t code);
static inline void del_key_byte(uint8_t code);


@@ 139,7 143,7 @@ void send_keyboard_report(void) {
void add_key(uint8_t key)
{
#ifdef NKRO_ENABLE
    if (keyboard_protocol && keyboard_nkro) {
    if (keyboard_protocol && keymap_config.nkro) {
        add_key_bit(key);
        return;
    }


@@ 150,7 154,7 @@ void add_key(uint8_t key)
void del_key(uint8_t key)
{
#ifdef NKRO_ENABLE
    if (keyboard_protocol && keyboard_nkro) {
    if (keyboard_protocol && keymap_config.nkro) {
        del_key_bit(key);
        return;
    }


@@ 231,7 235,7 @@ uint8_t has_anymod(void)
uint8_t get_first_key(void)
{
#ifdef NKRO_ENABLE
    if (keyboard_protocol && keyboard_nkro) {
    if (keyboard_protocol && keymap_config.nkro) {
        uint8_t i = 0;
        for (; i < KEYBOARD_REPORT_BITS && !keyboard_report->nkro.bits[i]; i++)
            ;

M tmk_core/common/bootmagic.c => tmk_core/common/bootmagic.c +0 -4
@@ 83,10 83,6 @@ void bootmagic(void)
    }
    eeconfig_update_keymap(keymap_config.raw);

#ifdef NKRO_ENABLE
    keyboard_nkro = keymap_config.nkro;
#endif

    /* default layer */
    uint8_t default_layer = 0;
    if (bootmagic_scan_keycode(BOOTMAGIC_KEY_DEFAULT_LAYER_0)) { default_layer |= (1<<0); }

M tmk_core/common/command.c => tmk_core/common/command.c +3 -3
@@ 238,7 238,7 @@ static void print_status(void)
    print_val_hex8(keyboard_protocol);
    print_val_hex8(keyboard_idle);
#ifdef NKRO_ENABLE
    print_val_hex8(keyboard_nkro);
    print_val_hex8(keymap_config.nkro);
#endif
    print_val_hex32(timer_read32());



@@ 435,8 435,8 @@ static bool command_common(uint8_t code)
		// NKRO toggle
        case MAGIC_KC(MAGIC_KEY_NKRO):
            clear_keyboard(); // clear to prevent stuck keys
            keyboard_nkro = !keyboard_nkro;
            if (keyboard_nkro) {
            keymap_config.nkro = !keymap_config.nkro;
            if (keymap_config.nkro) {
                print("NKRO: on\n");
            } else {
                print("NKRO: off\n");

M tmk_core/common/host.c => tmk_core/common/host.c +0 -5
@@ 22,11 22,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
#include "util.h"
#include "debug.h"


#ifdef NKRO_ENABLE
bool keyboard_nkro = true;
#endif

static host_driver_t *driver;
static uint16_t last_system_report = 0;
static uint16_t last_consumer_report = 0;

M tmk_core/common/host.h => tmk_core/common/host.h +0 -4
@@ 28,10 28,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
extern "C" {
#endif

#ifdef NKRO_ENABLE
extern bool keyboard_nkro;
#endif

extern uint8_t keyboard_idle;
extern uint8_t keyboard_protocol;


M tmk_core/common/keyboard.c => tmk_core/common/keyboard.c +3 -1
@@ 57,6 57,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
#   include "visualizer/visualizer.h"
#endif



#ifdef MATRIX_HAS_GHOST
static bool has_ghost_in_row(uint8_t row)
{


@@ 106,7 108,7 @@ void keyboard_init(void) {
    rgblight_init();
#endif
#if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
	keyboard_nkro = true;
    keymap_config.nkro = 1;
#endif
}


M tmk_core/common/magic.c => tmk_core/common/magic.c +0 -4
@@ 27,10 27,6 @@ void magic(void)
    /* keymap config */
    keymap_config.raw = eeconfig_read_keymap();

#ifdef NKRO_ENABLE
    keyboard_nkro = keymap_config.nkro;
#endif

    uint8_t default_layer = 0;
    default_layer = eeconfig_read_default_layer();
    default_layer_set((uint32_t)default_layer);

M tmk_core/protocol/chibios/usb_main.c => tmk_core/protocol/chibios/usb_main.c +11 -8
@@ 28,6 28,12 @@
#include "led.h"
#endif

#ifdef NKRO_ENABLE
  #include "keycode_config.h"

  extern keymap_config_t keymap_config;
#endif

/* ---------------------------------------------------------
 *       Global interface variables and declarations
 * ---------------------------------------------------------


@@ 39,9 45,6 @@ uint16_t keyboard_led_stats __attribute__((aligned(2))) = 0;
volatile uint16_t keyboard_idle_count = 0;
static virtual_timer_t keyboard_idle_timer;
static void keyboard_idle_timer_cb(void *arg);
#ifdef NKRO_ENABLE
extern bool keyboard_nkro;
#endif /* NKRO_ENABLE */

report_keyboard_t keyboard_report_sent = {{0}};
#ifdef MOUSE_ENABLE


@@ 943,8 946,8 @@ static bool usb_request_hook_cb(USBDriver *usbp) {
        if((usbp->setup[4] == KBD_INTERFACE) && (usbp->setup[5] == 0)) {   /* wIndex */
          keyboard_protocol = ((usbp->setup[2]) != 0x00);   /* LSB(wValue) */
#ifdef NKRO_ENABLE
          keyboard_nkro = !!keyboard_protocol;
          if(!keyboard_nkro && keyboard_idle) {
          keymap_config.nkro = !!keyboard_protocol;
          if(!keymap_config.nkro && keyboard_idle) {
#else /* NKRO_ENABLE */
          if(keyboard_idle) {
#endif /* NKRO_ENABLE */


@@ 962,7 965,7 @@ static bool usb_request_hook_cb(USBDriver *usbp) {
        keyboard_idle = usbp->setup[3];     /* MSB(wValue) */
        /* arm the timer */
#ifdef NKRO_ENABLE
        if(!keyboard_nkro && keyboard_idle) {
        if(!keymap_config.nkro && keyboard_idle) {
#else /* NKRO_ENABLE */
        if(keyboard_idle) {
#endif /* NKRO_ENABLE */


@@ 1089,7 1092,7 @@ static void keyboard_idle_timer_cb(void *arg) {
  }

#ifdef NKRO_ENABLE
  if(!keyboard_nkro && keyboard_idle) {
  if(!keymap_config.nkro && keyboard_idle) {
#else /* NKRO_ENABLE */
  if(keyboard_idle) {
#endif /* NKRO_ENABLE */


@@ 1122,7 1125,7 @@ void send_keyboard(report_keyboard_t *report) {
  osalSysUnlock();

#ifdef NKRO_ENABLE
  if(keyboard_nkro) {  /* NKRO protocol */
  if(keymap_config.nkro) {  /* NKRO protocol */
    /* need to wait until the previous packet has made it through */
    /* can rewrite this using the synchronous API, then would wait
     * until *after* the packet has been transmitted. I think

M tmk_core/protocol/lufa/lufa.c => tmk_core/protocol/lufa/lufa.c +8 -1
@@ 52,6 52,13 @@
#include "descriptor.h"
#include "lufa.h"

#ifdef NKRO_ENABLE
  #include "keycode_config.h"

  extern keymap_config_t keymap_config;
#endif


#ifdef AUDIO_ENABLE
    #include <audio.h>
#endif


@@ 502,7 509,7 @@ static void send_keyboard(report_keyboard_t *report)

    /* Select the Keyboard Report Endpoint */
#ifdef NKRO_ENABLE
    if (keyboard_protocol && keyboard_nkro) {
    if (keyboard_protocol && keymap_config.nkro) {
        /* Report protocol - NKRO */
        Endpoint_SelectEndpoint(NKRO_IN_EPNUM);


M tmk_core/protocol/pjrc/usb.c => tmk_core/protocol/pjrc/usb.c +12 -6
@@ 1,17 1,17 @@
/* USB Keyboard Plus Debug Channel Example for Teensy USB Development Board
 * http://www.pjrc.com/teensy/usb_keyboard.html
 * Copyright (c) 2009 PJRC.COM, LLC
 * 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE


@@ 41,6 41,12 @@
#include "action.h"
#include "action_util.h"

#ifdef NKRO_ENABLE
  #include "keycode_config.h"

  extern keymap_config_t keymap_config;
#endif


/**************************************************************************
 *


@@ 694,7 700,7 @@ ISR(USB_GEN_vect)
		}
                /* TODO: should keep IDLE rate on each keyboard interface */
#ifdef NKRO_ENABLE
		if (!keyboard_nkro && keyboard_idle && (++div4 & 3) == 0) {
		if (!keymap_config.nkro && keyboard_idle && (++div4 & 3) == 0) {
#else
		if (keyboard_idle && (++div4 & 3) == 0) {
#endif


@@ 881,7 887,7 @@ ISR(USB_COM_vect)
#endif
                    if (bmRequestType == 0x00 && wValue == DEVICE_REMOTE_WAKEUP) {
                        if (bRequest == SET_FEATURE) {
                            remote_wakeup = true;   
                            remote_wakeup = true;
                        } else {
                            remote_wakeup = false;
                        }


@@ 932,7 938,7 @@ ISR(USB_COM_vect)
				if (bRequest == HID_SET_PROTOCOL) {
					keyboard_protocol = wValue;
#ifdef NKRO_ENABLE
                                        keyboard_nkro = !!keyboard_protocol;
                                        keymap_config.nkro = !!keyboard_protocol;
#endif
                                        clear_keyboard();
					//usb_wait_in_ready();

M tmk_core/protocol/pjrc/usb_keyboard.c => tmk_core/protocol/pjrc/usb_keyboard.c +7 -1
@@ 30,6 30,12 @@
#include "util.h"
#include "host.h"

#ifdef NKRO_ENABLE
  #include "keycode_config.h"

  extern keymap_config_t keymap_config;
#endif


// protocol setting from the host.  We use exactly the same report
// either way, so this variable only stores the setting since we


@@ 56,7 62,7 @@ int8_t usb_keyboard_send_report(report_keyboard_t *report)
    int8_t result = 0;

#ifdef NKRO_ENABLE
    if (keyboard_nkro)
    if (keymap_config.nkro)
        result = send_report(report, KBD2_ENDPOINT, 0, KBD2_SIZE);
    else
#endif

M tmk_core/readme.md => tmk_core/readme.md +1 -1
@@ 23,7 23,7 @@ These features can be used in your keyboard.
* 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
* USB NKRO            - 240 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