Skip to content

Commit

Permalink
Remove SERIAL_LINK feature (#14727)
Browse files Browse the repository at this point in the history
* Remove SERIAL_LINK

* more stale paths in doxygen-todo

* Fix

* More refs

* Update testing docs

* Update doxygen-todo

Co-authored-by: Ryan <[email protected]>

Co-authored-by: Ryan <[email protected]>
  • Loading branch information
zvecr and fauxpark authored Oct 7, 2021
1 parent 60297a1 commit 1c0347b
Show file tree
Hide file tree
Showing 36 changed files with 7 additions and 2,252 deletions.
1 change: 0 additions & 1 deletion build_test.mk
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ include common_features.mk
include $(TMK_PATH)/common.mk
include $(QUANTUM_PATH)/debounce/tests/rules.mk
include $(QUANTUM_PATH)/sequencer/tests/rules.mk
include $(QUANTUM_PATH)/serial_link/tests/rules.mk
include $(TMK_PATH)/common/test/rules.mk
ifneq ($(filter $(FULL_TESTS),$(TEST)),)
include build_full_test.mk
Expand Down
13 changes: 0 additions & 13 deletions common_features.mk
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

SERIAL_PATH := $(QUANTUM_PATH)/serial_link

QUANTUM_SRC += \
$(QUANTUM_DIR)/quantum.c \
$(QUANTUM_DIR)/send_string.c \
Expand Down Expand Up @@ -363,17 +361,6 @@ ifeq ($(strip $(PRINTING_ENABLE)), yes)
SRC += $(TMK_DIR)/protocol/serial_uart.c
endif

ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
SERIAL_SRC := $(wildcard $(SERIAL_PATH)/protocol/*.c)
SERIAL_SRC += $(wildcard $(SERIAL_PATH)/system/*.c)
SERIAL_DEFS += -DSERIAL_LINK_ENABLE
COMMON_VPATH += $(SERIAL_PATH)

SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
OPT_DEFS += $(SERIAL_DEFS)
VAPTH += $(SERIAL_PATH)
endif

VARIABLE_TRACE ?= no
ifneq ($(strip $(VARIABLE_TRACE)),no)
SRC += $(QUANTUM_DIR)/variable_trace.c
Expand Down
1 change: 0 additions & 1 deletion disable_features.mk
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ FEATURE_NAMES += PS2_MOUSE
FEATURE_NAMES += RGBLIGHT
FEATURE_NAMES += RGB_MATRIX
FEATURE_NAMES += SLEEP_LED
FEATURE_NAMES += SERIAL_LINK
FEATURE_NAMES += STENO
FEATURE_NAMES += SWAP_HANDS
FEATURE_NAMES += WATCHDOG
Expand Down
4 changes: 2 additions & 2 deletions docs/unit_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ One thing to remember, is that you have to append `extern "C"` around all of you

## Adding Tests for New or Existing Features

If you want to unit test some feature, then take a look at the existing serial_link tests, in the `quantum/serial_link/tests folder`, and follow the steps below to create a similar structure.
If you want to unit test a feature, take a look at some of the existing tests, for example those in the `quantum/sequencer/tests` folder. Then follow the steps below to create a similar structure.

1. If it doesn't already exist, add a test subfolder to the folder containing the feature.
2. Create a `testlist.mk` and a `rules.mk` file in that folder.
3. Include those files from the root folder `testlist.mk`and `build_test.mk` respectively.
4. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the serial_link tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
4. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the existing tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
5. Define the source files and required options in the `rules.mk` file.
* `_SRC` for source files
* `_DEFS` for additional defines
Expand Down
8 changes: 0 additions & 8 deletions doxygen-todo
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,8 @@ tmk_core/protocol/midi/bytequeue
tmk_core/protocol/midi/Config
tmk_core/protocol/usb_hid
tmk_core/protocol/vusb
tmk_core/tool
tmk_core/tool/chibios
quantum
quantum/api
quantum/audio
quantum/keymap_extras
quantum/process_keycode
quantum/serial_link
quantum/serial_link/protocol
quantum/serial_link/system
quantum/serial_link/tests
quantum/tools
drivers
1 change: 0 additions & 1 deletion keyboards/ergodox_infinity/ergodox_infinity.c
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
#include <hal.h>
#include <string.h>
#include "eeconfig.h"
#include "serial_link/system/serial_link.h"

#define RED_PIN 1
#define GREEN_PIN 2
Expand Down
7 changes: 0 additions & 7 deletions quantum/keyboard.c
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifdef STENO_ENABLE
# include "process_steno.h"
#endif
#ifdef SERIAL_LINK_ENABLE
# include "serial_link/system/serial_link.h"
#endif
#ifdef POINTING_DEVICE_ENABLE
# include "pointing_device.h"
#endif
Expand Down Expand Up @@ -511,10 +508,6 @@ void keyboard_task(void) {
adb_mouse_task();
#endif

#ifdef SERIAL_LINK_ENABLE
serial_link_update();
#endif

#ifdef POINTING_DEVICE_ENABLE
pointing_device_task();
#endif
Expand Down
2 changes: 1 addition & 1 deletion quantum/sequencer/tests/rules.mk
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# The letter case of these variables might seem odd. However:
# - it is consistent with the serial_link example that is used as a reference in the Unit Testing article (https://docs.qmk.fm/#/unit_testing?id=adding-tests-for-new-or-existing-features)
# - it is consistent with the example that is used as a reference in the Unit Testing article (https://docs.qmk.fm/#/unit_testing?id=adding-tests-for-new-or-existing-features)
# - Neither `make test:sequencer` or `make test:SEQUENCER` work when using SCREAMING_SNAKE_CASE

sequencer_DEFS := -DNO_DEBUG -DMIDI_MOCKED
Expand Down
19 changes: 0 additions & 19 deletions quantum/serial_link/LICENSE

This file was deleted.

1 change: 0 additions & 1 deletion quantum/serial_link/README.md

This file was deleted.

135 changes: 0 additions & 135 deletions quantum/serial_link/protocol/byte_stuffer.c

This file was deleted.

34 changes: 0 additions & 34 deletions quantum/serial_link/protocol/byte_stuffer.h

This file was deleted.

64 changes: 0 additions & 64 deletions quantum/serial_link/protocol/frame_router.c

This file was deleted.

Loading

0 comments on commit 1c0347b

Please sign in to comment.