Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Refactor platform logic within print.h (#11863)

Browse source 
* Remove GCC check from debug

* Remove platform logic from common.mk

* Refactor platform logic within print.h

* restore debug.c format

* headers

* Rename function pointer type

* review comments

* Update tmk_core/common/printf.c

Co-authored-by: Nick Brassel <nick@tzarc.org>

* Format

Co-authored-by: Nick Brassel <nick@tzarc.org>
This commit is contained in:
Joel Challis 2021-02-14 01:44:22 +00:00 committed by GitHub
parent 72e515547a
commit 1f2fe2eab9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 224 additions and 283 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
tmk_core/common.mk
View file

@ -1,5 +1,3 @@
PRINTF_PATH = $(LIB_PATH)/printf
COMMON_DIR = common COMMON_DIR = common
PLATFORM_COMMON_DIR = $(COMMON_DIR)/$(PLATFORM_KEY) PLATFORM_COMMON_DIR = $(COMMON_DIR)/$(PLATFORM_KEY)
@ -10,7 +8,6 @@ TMK_COMMON_SRC += $(COMMON_DIR)/host.c \
$(COMMON_DIR)/action_macro.c \ $(COMMON_DIR)/action_macro.c \
$(COMMON_DIR)/action_layer.c \ $(COMMON_DIR)/action_layer.c \
$(COMMON_DIR)/action_util.c \ $(COMMON_DIR)/action_util.c \
$(COMMON_DIR)/print.c \
$(COMMON_DIR)/debug.c \ $(COMMON_DIR)/debug.c \
$(COMMON_DIR)/sendchar_null.c \ $(COMMON_DIR)/sendchar_null.c \
$(COMMON_DIR)/eeconfig.c \ $(COMMON_DIR)/eeconfig.c \
@ -20,17 +17,11 @@ TMK_COMMON_SRC += $(COMMON_DIR)/host.c \
$(COMMON_DIR)/sync_timer.c \ $(COMMON_DIR)/sync_timer.c \
$(PLATFORM_COMMON_DIR)/bootloader.c \ $(PLATFORM_COMMON_DIR)/bootloader.c \
ifeq ($(PLATFORM),AVR) # Use platform provided print - fall back to lib/printf
TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/xprintf.S ifneq ("$(wildcard $(TMK_PATH)/$(PLATFORM_COMMON_DIR)/printf.mk)","")
else ifeq ($(PLATFORM),CHIBIOS) include $(TMK_PATH)/$(PLATFORM_COMMON_DIR)/printf.mk
TMK_COMMON_SRC += $(PRINTF_PATH)/printf.c else
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_FLOAT include $(TMK_PATH)/$(COMMON_DIR)/lib_printf.mk
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_EXPONENTIAL
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_LONG_LONG
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_PTRDIFF_T
VPATH += $(PRINTF_PATH)
else ifeq ($(PLATFORM),ARM_ATSAM)
TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/printf.c
endif endif
# Option modules # Option modules

33
tmk_core/common/print.c → tmk_core/common/arm_atsam/_print.h
View file

@ -1,4 +1,4 @@
/* Copyright 2012,2013 Jun Wako <wakojun@gmail.com> */ /* Copyright 2012 Jun Wako <wakojun@gmail.com> */
/* Very basic print functions, intended to be used with usb_debug_only.c /* Very basic print functions, intended to be used with usb_debug_only.c
* http://www.pjrc.com/teensy/ * http://www.pjrc.com/teensy/
* Copyright (c) 2008 PJRC.COM, LLC * Copyright (c) 2008 PJRC.COM, LLC
@ -21,27 +21,14 @@
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE. * THE SOFTWARE.
*/ */
#pragma once
#include <stdint.h> #include "arm_atsam/printf.h"
#include "print.h"
#ifndef NO_PRINT // Create user & normal print defines
#define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
# if defined(__AVR__) #define print(s) xprintf(s)
#define println(s) xprintf(s "\r\n")
# define sendchar(c) xputc(c) #define uprint(s) print(s)
#define uprintln(s) println(s)
void print_set_sendchar(int8_t (*sendchar_func)(uint8_t)) { xdev_out(sendchar_func); } #define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
# elif defined(PROTOCOL_CHIBIOS) /* __AVR__ */
// don't need anything extra
# elif defined(__arm__) /* __AVR__ */
// TODO
// void print_set_sendchar(int8_t (*sendchar_func)(uint8_t)) { }
# endif /* __AVR__ */
#endif

6
tmk_core/common/arm_atsam/printf.c
View file

@ -15,11 +15,13 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
#include "printf.h"
#include "sendchar.h"
#ifdef CONSOLE_ENABLE #ifdef CONSOLE_ENABLE
# include "samd51j18a.h" # include "samd51j18a.h"
# include "arm_atsam_protocol.h" # include "arm_atsam_protocol.h"
# include "printf.h"
# include <string.h> # include <string.h>
# include <stdarg.h> # include <stdarg.h>
@ -66,3 +68,5 @@ void console_printf(char *fmt, ...) {
} }
#endif // CONSOLE_ENABLE #endif // CONSOLE_ENABLE
void print_set_sendchar(sendchar_func_t send) {}

1
tmk_core/common/arm_atsam/printf.mk Normal file
View file

@ -0,0 +1 @@
TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/printf.c

33
tmk_core/common/avr/_print.h Normal file
View file

@ -0,0 +1,33 @@
/* Copyright 2012 Jun Wako <wakojun@gmail.com> */
/* Very basic print functions, intended to be used with usb_debug_only.c
* http://www.pjrc.com/teensy/
* Copyright (c) 2008 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
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#pragma once
#include "avr/xprintf.h"
// Create user & normal print defines
#define print(s) xputs(PSTR(s))
#define println(s) xputs(PSTR(s "\r\n"))
#define uprint(s) print(s)
#define uprintln(s) println(s)
#define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)

20
tmk_core/common/avr/printf.c Normal file
View file

@ -0,0 +1,20 @@
/*
Copyright 2011 Jun Wako <wakojun@gmail.com>
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/>.
*/
#include "xprintf.h"
#include "sendchar.h"
void print_set_sendchar(sendchar_func_t func) { xdev_out(func); }

2
tmk_core/common/avr/printf.mk Normal file
View file

@ -0,0 +1,2 @@
TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/xprintf.S
TMK_COMMON_SRC += $(PLATFORM_COMMON_DIR)/printf.c

41
tmk_core/common/debug.c
View file

@ -1,24 +1,25 @@
#include <stdbool.h> /*
Copyright 2011 Jun Wako <wakojun@gmail.com>
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/>.
*/
#include "debug.h" #include "debug.h"
#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
debug_config_t debug_config = { debug_config_t debug_config = {
/* GCC Bug 10676 - Using unnamed fields in initializers .enable = false, //
* https://gcc.gnu.org/bugzilla/show_bug.cgi?id=10676 */ .matrix = false, //
#if GCC_VERSION >= 40600 .keyboard = false, //
.enable = false, .mouse = false, //
.matrix = false, .reserved = 0 //
.keyboard = false,
.mouse = false,
.reserved = 0
#else
{
false, // .enable
false, // .matrix
false, // .keyboard
false, // .mouse
0 // .reserved
}
#endif
}; };

1
tmk_core/common/keyboard.c
View file

@ -229,6 +229,7 @@ void keyboard_setup(void) {
#ifndef NO_JTAG_DISABLE #ifndef NO_JTAG_DISABLE
disable_jtag(); disable_jtag();
#endif #endif
print_set_sendchar(sendchar);
matrix_setup(); matrix_setup();
keyboard_pre_init_kb(); keyboard_pre_init_kb();
} }

9
tmk_core/common/lib_printf.mk Normal file
View file

@ -0,0 +1,9 @@
PRINTF_PATH = $(LIB_PATH)/printf
TMK_COMMON_SRC += $(PRINTF_PATH)/printf.c
TMK_COMMON_SRC += $(COMMON_DIR)/printf.c
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_FLOAT
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_EXPONENTIAL
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_LONG_LONG
TMK_COMMON_DEFS += -DPRINTF_DISABLE_SUPPORT_PTRDIFF_T
VPATH += $(PRINTF_PATH)

183
tmk_core/common/print.h
View file

@ -27,65 +27,18 @@
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>
#include "util.h" #include "util.h"
#include "sendchar.h"
#include "progmem.h"
#if defined(PROTOCOL_CHIBIOS) || defined(PROTOCOL_ARM_ATSAM) void print_set_sendchar(sendchar_func_t func);
# define PSTR(x) x
#endif
#ifndef NO_PRINT #ifndef NO_PRINT
# if __has_include_next("_print.h")
# if defined(__AVR__) /* __AVR__ */ # include_next "_print.h" /* Include the platforms print.h */
# else
# include "avr/xprintf.h" // Fall back to lib/printf
# ifdef USER_PRINT /* USER_PRINT */
// Remove normal print defines
# define print(s)
# define println(s)
# undef xprintf
# define xprintf(fmt, ...)
// Create user print defines
# define uprint(s) xputs(PSTR(s))
# define uprintln(s) xputs(PSTR(s "\r\n"))
# define uprintf(fmt, ...) __xprintf(PSTR(fmt), ##__VA_ARGS__)
# else /* NORMAL PRINT */
// Create user & normal print defines
# define print(s) xputs(PSTR(s))
# define println(s) xputs(PSTR(s "\r\n"))
# define uprint(s) print(s)
# define uprintln(s) println(s)
# define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
# endif /* USER_PRINT / NORMAL PRINT */
# ifdef __cplusplus
extern "C"
# endif
/* function pointer of sendchar to be used by print utility */
void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
# elif defined(PROTOCOL_CHIBIOS) /* PROTOCOL_CHIBIOS */
# include "printf.h" // lib/printf/printf.h # include "printf.h" // lib/printf/printf.h
# ifdef USER_PRINT /* USER_PRINT */
// Remove normal print defines
# define print(s)
# define println(s)
# define xprintf(fmt, ...)
// Create user print defines
# define uprint(s) printf(s)
# define uprintln(s) printf(s "\r\n")
# define uprintf printf
# else /* NORMAL PRINT */
// Create user & normal print defines // Create user & normal print defines
# define print(s) printf(s) # define print(s) printf(s)
# define println(s) printf(s "\r\n") # define println(s) printf(s "\r\n")
@ -94,77 +47,29 @@ extern "C"
# define uprintln(s) printf(s "\r\n") # define uprintln(s) printf(s "\r\n")
# define uprintf printf # define uprintf printf
# endif /* USER_PRINT / NORMAL PRINT */ # endif /* __AVR__ / PROTOCOL_CHIBIOS / PROTOCOL_ARM_ATSAM */
#else /* NO_PRINT */
# elif defined(PROTOCOL_ARM_ATSAM) /* PROTOCOL_ARM_ATSAM */ # undef xprintf
// Remove print defines
# include "arm_atsam/printf.h"
# ifdef USER_PRINT /* USER_PRINT */
// Remove normal print defines
# define print(s) # define print(s)
# define println(s) # define println(s)
# define xprintf(fmt, ...) # define xprintf(fmt, ...)
# define uprintf(fmt, ...)
# define uprint(s)
# define uprintln(s)
// Create user print defines #endif /* NO_PRINT */
# define uprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
# define uprint(s) xprintf(s)
# define uprintln(s) xprintf(s "\r\n")
# else /* NORMAL PRINT */
// Create user & normal print defines
# define xprintf(fmt, ...) __xprintf(fmt, ##__VA_ARGS__)
# define print(s) xprintf(s)
# define println(s) xprintf(s "\r\n")
# define uprint(s) print(s)
# define uprintln(s) println(s)
# define uprintf(fmt, ...) xprintf(fmt, ##__VA_ARGS__)
# endif /* USER_PRINT / NORMAL PRINT */
# endif /* __AVR__ / PROTOCOL_CHIBIOS / PROTOCOL_ARM_ATSAM */
// User print disables the normal print messages in the body of QMK/TMK code and
// is meant as a lightweight alternative to NOPRINT. Use it when you only want to do
// a spot of debugging but lack flash resources for allowing all of the codebase to
// print (and store their wasteful strings).
//
// !!! DO NOT USE USER PRINT CALLS IN THE BODY OF QMK/TMK !!!
//
#ifdef USER_PRINT #ifdef USER_PRINT
// Remove normal print defines
# undef print
# undef println
# undef xprintf
# define print(s)
# define println(s)
# define xprintf(fmt, ...)
#endif
// Disable normal print
# define print_dec(data)
# define print_decs(data)
# define print_hex4(data)
# define print_hex8(data)
# define print_hex16(data)
# define print_hex32(data)
# define print_bin4(data)
# define print_bin8(data)
# define print_bin16(data)
# define print_bin32(data)
# define print_bin_reverse8(data)
# define print_bin_reverse16(data)
# define print_bin_reverse32(data)
# define print_val_dec(v)
# define print_val_decs(v)
# define print_val_hex8(v)
# define print_val_hex16(v)
# define print_val_hex32(v)
# define print_val_bin8(v)
# define print_val_bin16(v)
# define print_val_bin32(v)
# define print_val_bin_reverse8(v)
# define print_val_bin_reverse16(v)
# define print_val_bin_reverse32(v)
# else /* NORMAL_PRINT */
// Enable normal print
/* decimal */
#define print_dec(i) xprintf("%u", i) #define print_dec(i) xprintf("%u", i)
#define print_decs(i) xprintf("%d", i) #define print_decs(i) xprintf("%d", i)
/* hex */ /* hex */
@ -193,9 +98,12 @@ extern "C"
#define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v)) #define print_val_bin_reverse16(v) xprintf(#v ": %016b\n", bitrev16(v))
#define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v)) #define print_val_bin_reverse32(v) xprintf(#v ": %032lb\n", bitrev32(v))
# endif /* USER_PRINT / NORMAL_PRINT */ // User print disables the normal print messages in the body of QMK/TMK code and
// is meant as a lightweight alternative to NOPRINT. Use it when you only want to do
// User Print // a spot of debugging but lack flash resources for allowing all of the codebase to
// print (and store their wasteful strings).
//
// !!! DO NOT USE USER PRINT CALLS IN THE BODY OF QMK/TMK !!!
/* decimal */ /* decimal */
#define uprint_dec(i) uprintf("%u", i) #define uprint_dec(i) uprintf("%u", i)
@ -225,36 +133,3 @@ extern "C"
#define uprint_val_bin_reverse8(v) uprintf(#v ": %08b\n", bitrev(v)) #define uprint_val_bin_reverse8(v) uprintf(#v ": %08b\n", bitrev(v))
#define uprint_val_bin_reverse16(v) uprintf(#v ": %016b\n", bitrev16(v)) #define uprint_val_bin_reverse16(v) uprintf(#v ": %016b\n", bitrev16(v))
#define uprint_val_bin_reverse32(v) uprintf(#v ": %032lb\n", bitrev32(v)) #define uprint_val_bin_reverse32(v) uprintf(#v ": %032lb\n", bitrev32(v))
#else /* NO_PRINT */
# define xprintf(fmt, ...)
# define print(s)
# define println(s)
# define print_set_sendchar(func)
# define print_dec(data)
# define print_decs(data)
# define print_hex4(data)
# define print_hex8(data)
# define print_hex16(data)
# define print_hex32(data)
# define print_bin4(data)
# define print_bin8(data)
# define print_bin16(data)
# define print_bin32(data)
# define print_bin_reverse8(data)
# define print_bin_reverse16(data)
# define print_bin_reverse32(data)
# define print_val_dec(v)
# define print_val_decs(v)
# define print_val_hex8(v)
# define print_val_hex16(v)
# define print_val_hex32(v)
# define print_val_bin8(v)
# define print_val_bin16(v)
# define print_val_bin32(v)
# define print_val_bin_reverse8(v)
# define print_val_bin_reverse16(v)
# define print_val_bin_reverse32(v)
#endif /* NO_PRINT */

27
tmk_core/common/printf.c Normal file
View file

@ -0,0 +1,27 @@
/*
Copyright 2011 Jun Wako <wakojun@gmail.com>
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/>.
*/
#include <stddef.h>
#include "sendchar.h"
// bind lib/printf to console interface - sendchar
static int8_t null_sendchar_func(uint8_t c) { return 0; }
static sendchar_func_t func = null_sendchar_func;
void print_set_sendchar(sendchar_func_t send) { func = send; }
void _putchar(char character) { func(character); }

1
tmk_core/common/progmem.h
View file

@ -4,6 +4,7 @@
# include <avr/pgmspace.h> # include <avr/pgmspace.h>
#else #else
# define PROGMEM # define PROGMEM
# define PSTR(x) x
# define PGM_P const char* # define PGM_P const char*
# define memcpy_P(dest, src, n) memcpy(dest, src, n) # define memcpy_P(dest, src, n) memcpy(dest, src, n)
# define pgm_read_byte(address_short) *((uint8_t*)(address_short)) # define pgm_read_byte(address_short) *((uint8_t*)(address_short))

2
tmk_core/common/sendchar.h
View file

@ -23,6 +23,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
extern "C" { extern "C" {
#endif #endif
typedef int8_t (*sendchar_func_t)(uint8_t c);
/* transmit a character. return 0 on success, -1 on error. */ /* transmit a character. return 0 on success, -1 on error. */
int8_t sendchar(uint8_t c); int8_t sendchar(uint8_t c);

7
tmk_core/protocol/chibios/usb_main.c
View file

@ -953,15 +953,8 @@ void console_task(void) {
} while (size > 0); } while (size > 0);
} }
#else /* CONSOLE_ENABLE */
int8_t sendchar(uint8_t c) {
(void)c;
return 0;
}
#endif /* CONSOLE_ENABLE */ #endif /* CONSOLE_ENABLE */
void _putchar(char character) { sendchar(character); }
#ifdef RAW_ENABLE #ifdef RAW_ENABLE
void raw_hid_send(uint8_t *data, uint8_t length) { void raw_hid_send(uint8_t *data, uint8_t length) {
// TODO: implement variable size packet // TODO: implement variable size packet

1
tmk_core/protocol/lufa/lufa.c
View file

@ -1025,7 +1025,6 @@ static void setup_usb(void) {
// for Console_Task // for Console_Task
USB_Device_EnableSOFEvents(); USB_Device_EnableSOFEvents();
print_set_sendchar(sendchar);
} }
/** \brief Main /** \brief Main

7
tmk_core/protocol/vusb/main.c
View file

@ -74,12 +74,7 @@ static void usb_remote_wakeup(void) {
* *
* FIXME: Needs doc * FIXME: Needs doc
*/ */
static void setup_usb(void) { static void setup_usb(void) { initForUsbConnectivity(); }
initForUsbConnectivity();
// for Console_Task
print_set_sendchar(sendchar);
}
/** \brief Main /** \brief Main
* *