qmk_firmware/keyboards/bastardkb/dilemma/dilemma.h
Charly Delay 50a12c06b9
[keyboard] bastardkb: restructure folder hierarchy (#16778)
* bastardkb: restructure folder hierarchy ahead of supporting other adapters/mcus

Upcoming support for the following (adapter, mcu) pairs will be
submitted in follow-up PRs:

- `v2/elitec`
- `v2/stemcell`
- `blackpill`

This PR contains the following changes:

- Move previous implementation to an inner `v1/elitec` folder
- Move keyboard USB IDs and strings to data driven
- Update headers to update maintainers list
- Run `qmk format-c`

* bastardkb/charybdis: remove broken acceleration implementation

* bastardkb/charybdis: fix debug output

* bastardkb: add support for BastardKb the `v2/elitec` (adapter, mcu) pair

* bastardkb: add Blackpill support

* bastardkb/charybdis/3x5: add `bstiq` keymap

* bastardkb/charybdis: add fake LEDs to the configuration

For the Charybdis 3x5 (respectively 4x6), the LED config now simulates
36 (respectively 58) LEDs instead of the actual 35 (respectively 56) to
prevent confusion when testing LEDs during assembly when handedness is
not set correctly.  Those fake LEDs are bound to the physical
bottom-left corner.

* bastardkbk/charybdis/readme.md: update build commands

Merge pull request #5 from Nathancooke7/update_charybdis_readme_v2_shield.

* bastardkb/charybdis: fix Via keymap with blackpill

* bastardkb/charybdis: add 3x6 configuration

* bastardkb/charybdis: remove unnecessary files

* bastardkb/charybdis: remove obsolete code

* bastardkb/charybdis/3x6: add Via keymap

* bastardkb: add support for Splinky (RP2040) board

* bastardkb: initial configuration for the Splinky (SPI not working yet)

* bastardkb/charybdis/3x5/v2/splinky: tentative change to enable trackball

* bastardkb/charybdis/3x5/v2/splinky: fix SCK, MISO, MOSI pins

* bastardkb/charybdis/3x5/v2/splinky: fix SCK, MISO, MOSI pins

* bastardkb/charybdis/4x6/v2/splinky: add SPI configuration and enable trackball

* bastardkb/charybdis/3x6: add splinky config

* bastardkb/*/v2/splinky: update drivers to `vendor`

* bastardkb/dilemma: add new board

* bastardkb/charybdis: fix infinite loop in `layer_state_set_user(…)` in the `via` keymaps

* bastardkb/dilemma: add `bstiq` keymap

* bastardkb: specify blackpill boards

* bastardkb/charybdis: fix blackpill-specific define syntax

* bastardkb: remove `NO_ACTION_MACRO` and `NO_ACTION_FUNCTION` which are no longer valid options

* bastardkb: fix `QK_BOOT` keycodes

* bastardkb/dilemma: fix mouse direction on X axis

* bastardkb/charybdis/3x6: adjust CS

* bastardkb/dilemma: adjust trackpad configuration

* charybdis: fix `PWM33XX_CS_PIN` defines

This is a follow-up of https://github.com/qmk/qmk_firmware/pull/17613.

* bastardkb: remove Vial mentions from `bstiq` keymaps

* Cleanup unnecessary comments

Co-authored-by: Nathan <nathan.cooke@compass.com>
Co-authored-by: Charly Delay <0xcharly@codesink.dev>
2022-07-25 10:11:28 +01:00

134 lines
4.6 KiB
C

/**
* Copyright 2022 Charly Delay <charly@codesink.dev> (@0xcharly)
*
* 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, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "quantum.h"
// clang-format off
#define LAYOUT_split_3x5_2( \
k00, k01, k02, k03, k04, k44, k43, k42, k41, k40, \
k10, k11, k12, k13, k14, k54, k53, k52, k51, k50, \
k20, k21, k22, k23, k24, k64, k63, k62, k61, k60, \
k30, k32, k72, k70 \
) \
{ \
{ k00, k01, k02, k03, k04 }, \
{ k10, k11, k12, k13, k14 }, \
{ k20, k21, k22, k23, k24 }, \
{ k30, KC_NO, k32, KC_NO, KC_NO }, \
{ k40, k41, k42, k43, k44 }, \
{ k50, k51, k52, k53, k54 }, \
{ k60, k61, k62, k63, k64 }, \
{ k70, KC_NO, k72, KC_NO, KC_NO }, \
}
// clang-format on
#ifdef POINTING_DEVICE_ENABLE
# ifndef NO_DILEMMA_KEYCODES
enum dilemma_keycodes {
# ifdef VIA_ENABLE
POINTER_DEFAULT_DPI_FORWARD = USER00,
# else
POINTER_DEFAULT_DPI_FORWARD = SAFE_RANGE,
# endif // VIA_ENABLE
POINTER_DEFAULT_DPI_REVERSE,
POINTER_SNIPING_DPI_FORWARD,
POINTER_SNIPING_DPI_REVERSE,
SNIPING_MODE,
SNIPING_MODE_TOGGLE,
DRAGSCROLL_MODE,
DRAGSCROLL_MODE_TOGGLE,
DILEMMA_SAFE_RANGE,
};
# define DPI_MOD POINTER_DEFAULT_DPI_FORWARD
# define DPI_RMOD POINTER_DEFAULT_DPI_REVERSE
# define S_D_MOD POINTER_SNIPING_DPI_FORWARD
# define S_D_RMOD POINTER_SNIPING_DPI_REVERSE
# define SNIPING SNIPING_MODE
# define SNP_TOG SNIPING_MODE_TOGGLE
# define DRGSCRL DRAGSCROLL_MODE
# define DRG_TOG DRAGSCROLL_MODE_TOGGLE
# endif // !NO_DILEMMA_KEYCODES
/** \brief Return the current DPI value for the pointer's default mode. */
uint16_t dilemma_get_pointer_default_dpi(void);
/**
* \brief Update the pointer's default DPI to the next or previous step.
*
* Increases the DPI value if `forward` is `true`, decreases it otherwise.
* The increment/decrement steps are equal to DILEMMA_DEFAULT_DPI_CONFIG_STEP.
*
* The new value is persisted in EEPROM.
*/
void dilemma_cycle_pointer_default_dpi(bool forward);
/**
* \brief Same as `dilemma_cycle_pointer_default_dpi`, but do not write to
* EEPROM.
*
* This means that reseting the board will revert the value to the last
* persisted one.
*/
void dilemma_cycle_pointer_default_dpi_noeeprom(bool forward);
/** \brief Return the current DPI value for the pointer's sniper-mode. */
uint16_t dilemma_get_pointer_sniping_dpi(void);
/**
* \brief Update the pointer's sniper-mode DPI to the next or previous step.
*
* Increases the DPI value if `forward` is `true`, decreases it otherwise.
* The increment/decrement steps are equal to DILEMMA_SNIPING_DPI_CONFIG_STEP.
*
* The new value is persisted in EEPROM.
*/
void dilemma_cycle_pointer_sniping_dpi(bool forward);
/**
* \brief Same as `dilemma_cycle_pointer_sniping_dpi`, but do not write to
* EEPROM.
*
* This means that reseting the board will revert the value to the last
* persisted one.
*/
void dilemma_cycle_pointer_sniping_dpi_noeeprom(bool forward);
/** \brief Whether sniper-mode is enabled. */
bool dilemma_get_pointer_sniping_enabled(void);
/**
* \brief Enable/disable sniper mode.
*
* When sniper mode is enabled the dpi is reduced to slow down the pointer for
* more accurate movements.
*/
void dilemma_set_pointer_sniping_enabled(bool enable);
/** \brief Whether drag-scroll is enabled. */
bool dilemma_get_pointer_dragscroll_enabled(void);
/**
* \brief Enable/disable drag-scroll mode.
*
* When drag-scroll mode is enabled, horizontal and vertical pointer movements
* are translated into horizontal and vertical scroll movements.
*/
void dilemma_set_pointer_dragscroll_enabled(bool enable);
#endif // POINTING_DEVICE_ENABLE