aboutsummaryrefslogtreecommitdiff
path: root/quantum
diff options
context:
space:
mode:
authorRyan <[email protected]>2024-07-03 17:18:27 +1000
committerGitHub <[email protected]>2024-07-03 17:18:27 +1000
commitbc0c69570b8a8b1d9a754a280053e49a825b24d7 (patch)
tree2c04582e424871f6b242bd5295aa06eefce007a6 /quantum
parent8471dcc5633a8654327acd30c359d054243541f6 (diff)
downloadqmk_firmware-bc0c69570b8a8b1d9a754a280053e49a825b24d7.tar.gz
qmk_firmware-bc0c69570b8a8b1d9a754a280053e49a825b24d7.zip
Rename encoder pins defines (#24003)
Diffstat (limited to 'quantum')
-rw-r--r--quantum/encoder.h31
-rw-r--r--quantum/encoder/tests/config_mock.h4
-rw-r--r--quantum/encoder/tests/config_mock_split_left_eq_right.h8
-rw-r--r--quantum/encoder/tests/config_mock_split_left_gt_right.h8
-rw-r--r--quantum/encoder/tests/config_mock_split_left_lt_right.h8
-rw-r--r--quantum/encoder/tests/config_mock_split_no_left.h8
-rw-r--r--quantum/encoder/tests/config_mock_split_no_right.h8
-rw-r--r--quantum/encoder/tests/config_mock_split_role.h8
8 files changed, 46 insertions, 37 deletions
diff --git a/quantum/encoder.h b/quantum/encoder.h
index 317a91f1da..1d2f1f46c7 100644
--- a/quantum/encoder.h
+++ b/quantum/encoder.h
@@ -22,6 +22,21 @@
#include "gpio.h"
#include "util.h"
+// ======== DEPRECATED DEFINES - DO NOT USE ========
+#ifdef ENCODERS_PAD_A
+# define ENCODER_A_PINS ENCODERS_PAD_A
+#endif
+#ifdef ENCODERS_PAD_B
+# define ENCODER_B_PINS ENCODERS_PAD_B
+#endif
+#ifdef ENCODERS_PAD_A_RIGHT
+# define ENCODER_A_PINS_RIGHT ENCODERS_PAD_A_RIGHT
+#endif
+#ifdef ENCODERS_PAD_B_RIGHT
+# define ENCODER_B_PINS_RIGHT ENCODERS_PAD_B_RIGHT
+#endif
+// ========
+
#ifdef ENCODER_ENABLE
__attribute__((weak)) bool should_process_encoder(void);
@@ -36,16 +51,16 @@ bool encoder_update_user(uint8_t index, bool clockwise);
# ifdef SPLIT_KEYBOARD
-# if defined(ENCODERS_PAD_A_RIGHT)
+# if defined(ENCODER_A_PINS_RIGHT)
# ifndef NUM_ENCODERS_LEFT
-# define NUM_ENCODERS_LEFT ARRAY_SIZE(((pin_t[])ENCODERS_PAD_A))
+# define NUM_ENCODERS_LEFT ARRAY_SIZE(((pin_t[])ENCODER_A_PINS))
# endif
# ifndef NUM_ENCODERS_RIGHT
-# define NUM_ENCODERS_RIGHT ARRAY_SIZE(((pin_t[])ENCODERS_PAD_A_RIGHT))
+# define NUM_ENCODERS_RIGHT ARRAY_SIZE(((pin_t[])ENCODER_A_PINS_RIGHT))
# endif
# else
# ifndef NUM_ENCODERS_LEFT
-# define NUM_ENCODERS_LEFT ARRAY_SIZE(((pin_t[])ENCODERS_PAD_A))
+# define NUM_ENCODERS_LEFT ARRAY_SIZE(((pin_t[])ENCODER_A_PINS))
# endif
# ifndef NUM_ENCODERS_RIGHT
# define NUM_ENCODERS_RIGHT NUM_ENCODERS_LEFT
@@ -58,19 +73,13 @@ bool encoder_update_user(uint8_t index, bool clockwise);
# else // SPLIT_KEYBOARD
# ifndef NUM_ENCODERS
-# define NUM_ENCODERS ARRAY_SIZE(((pin_t[])ENCODERS_PAD_A))
+# define NUM_ENCODERS ARRAY_SIZE(((pin_t[])ENCODER_A_PINS))
# endif
# define NUM_ENCODERS_LEFT NUM_ENCODERS
# define NUM_ENCODERS_RIGHT 0
# endif // SPLIT_KEYBOARD
-# ifndef NUM_ENCODERS
-# define NUM_ENCODERS 0
-# define NUM_ENCODERS_LEFT 0
-# define NUM_ENCODERS_RIGHT 0
-# endif // NUM_ENCODERS
-
# define NUM_ENCODERS_MAX_PER_SIDE MAX(NUM_ENCODERS_LEFT, NUM_ENCODERS_RIGHT)
# ifndef MAX_QUEUED_ENCODER_EVENTS
diff --git a/quantum/encoder/tests/config_mock.h b/quantum/encoder/tests/config_mock.h
index 9eb59ddc88..b5a1537d8a 100644
--- a/quantum/encoder/tests/config_mock.h
+++ b/quantum/encoder/tests/config_mock.h
@@ -7,9 +7,9 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1 }
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_left_eq_right.h b/quantum/encoder/tests/config_mock_split_left_eq_right.h
index ea795657ef..a4aa051ef1 100644
--- a/quantum/encoder/tests/config_mock_split_left_eq_right.h
+++ b/quantum/encoder/tests/config_mock_split_left_eq_right.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0, 2 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1, 3 }
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{ 4, 6 }
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{ 5, 7 }
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_left_gt_right.h b/quantum/encoder/tests/config_mock_split_left_gt_right.h
index abcfe03918..77190797ad 100644
--- a/quantum/encoder/tests/config_mock_split_left_gt_right.h
+++ b/quantum/encoder/tests/config_mock_split_left_gt_right.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0, 2, 4 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1, 3, 5 }
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{ 6, 8 }
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{ 7, 9 }
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_left_lt_right.h b/quantum/encoder/tests/config_mock_split_left_lt_right.h
index 075c774b0d..61808e866e 100644
--- a/quantum/encoder/tests/config_mock_split_left_lt_right.h
+++ b/quantum/encoder/tests/config_mock_split_left_lt_right.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0, 2 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1, 3 }
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{ 4, 6, 8 }
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{ 5, 7, 9 }
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_no_left.h b/quantum/encoder/tests/config_mock_split_no_left.h
index dfd8358929..599e584ff1 100644
--- a/quantum/encoder/tests/config_mock_split_no_left.h
+++ b/quantum/encoder/tests/config_mock_split_no_left.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{}
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{}
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{ 0, 2 }
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{ 1, 3 }
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_no_right.h b/quantum/encoder/tests/config_mock_split_no_right.h
index 5683eade8c..c3f753014c 100644
--- a/quantum/encoder/tests/config_mock_split_no_right.h
+++ b/quantum/encoder/tests/config_mock_split_no_right.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0, 2 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1, 3 }
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{}
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{}
#ifdef __cplusplus
diff --git a/quantum/encoder/tests/config_mock_split_role.h b/quantum/encoder/tests/config_mock_split_role.h
index ea795657ef..a4aa051ef1 100644
--- a/quantum/encoder/tests/config_mock_split_role.h
+++ b/quantum/encoder/tests/config_mock_split_role.h
@@ -7,13 +7,13 @@
#define MATRIX_COLS 1
/* Here, "pins" from 0 to 31 are allowed. */
-#define ENCODERS_PAD_A \
+#define ENCODER_A_PINS \
{ 0, 2 }
-#define ENCODERS_PAD_B \
+#define ENCODER_B_PINS \
{ 1, 3 }
-#define ENCODERS_PAD_A_RIGHT \
+#define ENCODER_A_PINS_RIGHT \
{ 4, 6 }
-#define ENCODERS_PAD_B_RIGHT \
+#define ENCODER_B_PINS_RIGHT \
{ 5, 7 }
#ifdef __cplusplus