diff options
Diffstat (limited to 'keyboards/xelus')
33 files changed, 1911 insertions, 169 deletions
diff --git a/keyboards/xelus/dawn60/config.h b/keyboards/xelus/dawn60/config.h index 59eb828fa6..ebd231ca97 100644 --- a/keyboards/xelus/dawn60/config.h +++ b/keyboards/xelus/dawn60/config.h @@ -1,4 +1,4 @@ -/* Copyright 2017 Jason Williams (Wilba) +/* Copyright 2020 Harrison Chan (Xelus) * * 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 @@ -13,133 +13,5 @@ * 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 "config_common.h" - -// USB Device descriptor parameter -#define VENDOR_ID 0x5845 // XE -#define PRODUCT_ID 0x0060 // Dawn60 -#define DEVICE_VER 0x0001 -#define MANUFACTURER Xelus -#define PRODUCT Dawn60 -#define DESCRIPTION Dawn60 - -// key matrix size -#define MATRIX_ROWS 5 -#define MATRIX_COLS 14 - -//no underglow - prototype -//#define MATRIX_ROW_PINS { B1, B3, B7, F6, F7 } -//#define MATRIX_COL_PINS { B0, D5, B2, F5, D2, D3, D4, D6, D7, B4, B5, B6, C6, C7 } -//#define UNUSED_PINS - -//underglow -#define MATRIX_ROW_PINS { B1, B3, F1, F6, F7 } -#define MATRIX_COL_PINS { B0, D5, B2, F5, D3, D2, C7, C6, B6, B5, B4, D7, D6, D4 } -#define UNUSED_PINS - -// IS31FL3731 driver -#define DRIVER_COUNT 2 -#define DRIVER_LED_TOTAL 64 - -// COL2ROW or ROW2COL -#define DIODE_DIRECTION COL2ROW - -// Set 0 if debouncing isn't needed -#define DEBOUNCE 5 - -// Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap -#define LOCKING_SUPPORT_ENABLE -// Locking resynchronize hack -#define LOCKING_RESYNC_ENABLE - -/* - * Feature disable options - * These options are also useful to firmware size reduction. - */ - -// disable debug print -//#define NO_DEBUG - -// disable print -//#define NO_PRINT - -// disable action features -//#define NO_ACTION_LAYER -//#define NO_ACTION_TAPPING -//#define NO_ACTION_ONESHOT -//#define NO_ACTION_MACRO -//#define NO_ACTION_FUNCTION - -#define RGB_BACKLIGHT_ENABLED 1 - -// This conditionally compiles the backlight code for Dawn60 specifics -#define RGB_BACKLIGHT_DAWN60 - -//RGB Underglow defines -#define RGB_DI_PIN F0 -#define WS2812_LED_TOTAL 20 - -#define RGB_UNDERGLOW_ALPHA_TOP_START 0 -#define RGB_UNDERGLOW_ALPHA_TOP_END 6 -#define RGB_UNDERGLOW_ALPHA_BOT_START 12 -#define RGB_UNDERGLOW_ALPHA_BOT_END 15 - -// enable/disable LEDs based on layout -// switch between split backspace (1) or normal backspace(0) -#define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 1 -// switch between Tsangan (1) or Arrows Bottom Row (0) -#define RGB_BACKLIGHT_USE_7U_SPACEBAR 0 -// switch between standard split rshift (0) or arrows r shift (1) -// .------------------. .-------------------. -// | ? | Shift | Fn | vs | Shift | Up | Fn | -// `------------------' `-------------------' -#define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 1 - -//not used -#define RGB_BACKLIGHT_USE_ISO_ENTER 0 -#define RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT 0 -#define RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS 0 - -// disable backlight when USB suspended (PC sleep/hibernate/shutdown) -#define RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED 0 - -// disable backlight after timeout in minutes, 0 = no timeout -#define RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT 0 - -// the default brightness -#define RGB_BACKLIGHT_BRIGHTNESS 255 - -// the default effect (RGB test) -#define RGB_BACKLIGHT_EFFECT 255 - -// the default effect speed (0-3) -#define RGB_BACKLIGHT_EFFECT_SPEED 0 - -// the default color1 and color2 -#define RGB_BACKLIGHT_COLOR_1 { .h = 0, .s = 255 } -#define RGB_BACKLIGHT_COLOR_2 { .h = 127, .s = 255 } - -// These define which keys in the matrix are alphas/mods -// Used for backlight effects so colors are different for -// alphas vs. mods -// Each value is for a row, bit 0 is column 0 -// Alpha=0 Mod=1 -#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b0000000000000001 -#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b0010000000000001 -#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0011000000000001 -#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b0011000000000001 -#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b0011111000011111 - -#define RGB_BACKLIGHT_CAPS_LOCK_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } -#define RGB_BACKLIGHT_LAYER_1_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } -#define RGB_BACKLIGHT_LAYER_2_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } -#define RGB_BACKLIGHT_LAYER_3_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } - -// Backlight config starts after VIA's EEPROM usage, -// dynamic keymaps start after this. -#define VIA_EEPROM_CUSTOM_CONFIG_SIZE 31 - -// VIA lighting is handled by the keyboard-level code -#define VIA_CUSTOM_LIGHTING_ENABLE diff --git a/keyboards/xelus/dawn60/dawn60.c b/keyboards/xelus/dawn60/dawn60.c index bce6eea9df..3e009b3bdf 100644 --- a/keyboards/xelus/dawn60/dawn60.c +++ b/keyboards/xelus/dawn60/dawn60.c @@ -1,18 +1 @@ -/* Copyright 2017 Jason Williams (Wilba) - * - * 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/>. - */ -#ifndef RGB_BACKLIGHT_DAWN60 -#error RGB_BACKLIGHT_DAWN60 not defined, you done goofed somehao, brah -#endif +#include "dawn60.h" diff --git a/keyboards/xelus/dawn60/dawn60.h b/keyboards/xelus/dawn60/dawn60.h index fe63de10fe..e663e3bbe7 100644 --- a/keyboards/xelus/dawn60/dawn60.h +++ b/keyboards/xelus/dawn60/dawn60.h @@ -1,4 +1,4 @@ -/* Copyright 2017 Jason Williams (Wilba) +/* Copyright 2020 Harrison Chan (Xelus) * * 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 @@ -16,21 +16,7 @@ #pragma once #include "quantum.h" -#include "keyboards/wilba_tech/wt_rgb_backlight_keycodes.h" -#include "via.h" -#define XXX KC_NO - -#define LAYOUT_60_all( \ - K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K2D, \ - K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \ - K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ - K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3B, K3C, K3D, \ - K40, K41, K42, K45, K49, K4A, K4B, K4C, K4D \ -) { \ - { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D }, \ - { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D }, \ - { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D }, \ - { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, XXX, K3B, K3C, K3D }, \ - { K40, K41, K42, XXX, XXX, K45, XXX, XXX, XXX, K49, K4A, K4B, K4C, K4D } \ -} +#if defined(KEYBOARD_xelus_dawn60_rev1) + #include "rev1.h" +#endif diff --git a/keyboards/xelus/dawn60/readme.md b/keyboards/xelus/dawn60/readme.md index 3409bac1ee..8e01381939 100644 --- a/keyboards/xelus/dawn60/readme.md +++ b/keyboards/xelus/dawn60/readme.md @@ -8,6 +8,6 @@ An in-switch RGB LED keyboard with RGB underglow. Make example for this keyboard (after setting up your build environment): - make xelus/dawn60:default + make xelus/dawn60/rev1:default See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
\ No newline at end of file diff --git a/keyboards/xelus/dawn60/rev1/config.h b/keyboards/xelus/dawn60/rev1/config.h new file mode 100644 index 0000000000..375bea9486 --- /dev/null +++ b/keyboards/xelus/dawn60/rev1/config.h @@ -0,0 +1,143 @@ +/* Copyright 2020 Harrison Chan (Xelus) + * + * 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 "config_common.h" + +// USB Device descriptor parameter +#define VENDOR_ID 0x5845 // XE +#define PRODUCT_ID 0x0060 // Dawn60 +#define DEVICE_VER 0x0001 +#define MANUFACTURER Xelus +#define PRODUCT Dawn60 +// key matrix size +#define MATRIX_ROWS 5 +#define MATRIX_COLS 14 + +//no underglow - prototype +//#define MATRIX_ROW_PINS { B1, B3, B7, F6, F7 } +//#define MATRIX_COL_PINS { B0, D5, B2, F5, D2, D3, D4, D6, D7, B4, B5, B6, C6, C7 } +//#define UNUSED_PINS + +//underglow +#define MATRIX_ROW_PINS { B1, B3, F1, F6, F7 } +#define MATRIX_COL_PINS { B0, D5, B2, F5, D3, D2, C7, C6, B6, B5, B4, D7, D6, D4 } +#define UNUSED_PINS + +// IS31FL3731 driver +#define DRIVER_COUNT 2 +#define DRIVER_LED_TOTAL 64 + +// COL2ROW or ROW2COL +#define DIODE_DIRECTION COL2ROW + +// Set 0 if debouncing isn't needed +#define DEBOUNCE 5 + +// Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap +#define LOCKING_SUPPORT_ENABLE +// Locking resynchronize hack +#define LOCKING_RESYNC_ENABLE + +/* + * Feature disable options + * These options are also useful to firmware size reduction. + */ + +// disable debug print +//#define NO_DEBUG + +// disable print +//#define NO_PRINT + +// disable action features +//#define NO_ACTION_LAYER +//#define NO_ACTION_TAPPING +//#define NO_ACTION_ONESHOT +//#define NO_ACTION_MACRO +//#define NO_ACTION_FUNCTION + +#define RGB_BACKLIGHT_ENABLED 1 + +// This conditionally compiles the backlight code for Dawn60 specifics +#define RGB_BACKLIGHT_DAWN60 + +//RGB Underglow defines +#define RGB_DI_PIN F0 +#define WS2812_LED_TOTAL 20 + +#define RGB_UNDERGLOW_ALPHA_TOP_START 0 +#define RGB_UNDERGLOW_ALPHA_TOP_END 6 +#define RGB_UNDERGLOW_ALPHA_BOT_START 12 +#define RGB_UNDERGLOW_ALPHA_BOT_END 15 + +// enable/disable LEDs based on layout +// switch between split backspace (1) or normal backspace(0) +#define RGB_BACKLIGHT_USE_SPLIT_BACKSPACE 1 +// switch between Tsangan (1) or Arrows Bottom Row (0) +#define RGB_BACKLIGHT_USE_7U_SPACEBAR 0 +// switch between standard split rshift (0) or arrows r shift (1) +// .------------------. .-------------------. +// | ? | Shift | Fn | vs | Shift | Up | Fn | +// `------------------' `-------------------' +#define RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT 1 + +//not used +#define RGB_BACKLIGHT_USE_ISO_ENTER 0 +#define RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT 0 +#define RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS 0 + +// disable backlight when USB suspended (PC sleep/hibernate/shutdown) +#define RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED 0 + +// disable backlight after timeout in minutes, 0 = no timeout +#define RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT 0 + +// the default brightness +#define RGB_BACKLIGHT_BRIGHTNESS 255 + +// the default effect (RGB test) +#define RGB_BACKLIGHT_EFFECT 255 + +// the default effect speed (0-3) +#define RGB_BACKLIGHT_EFFECT_SPEED 0 + +// the default color1 and color2 +#define RGB_BACKLIGHT_COLOR_1 { .h = 0, .s = 255 } +#define RGB_BACKLIGHT_COLOR_2 { .h = 127, .s = 255 } + +// These define which keys in the matrix are alphas/mods +// Used for backlight effects so colors are different for +// alphas vs. mods +// Each value is for a row, bit 0 is column 0 +// Alpha=0 Mod=1 +#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_0 0b0000000000000001 +#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_1 0b0010000000000001 +#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_2 0b0011000000000001 +#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_3 0b0011000000000001 +#define RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 0b0011111000011111 + +#define RGB_BACKLIGHT_CAPS_LOCK_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } +#define RGB_BACKLIGHT_LAYER_1_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } +#define RGB_BACKLIGHT_LAYER_2_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } +#define RGB_BACKLIGHT_LAYER_3_INDICATOR { .color = { .h = 0, .s = 0 }, .index = 255 } + +// Backlight config starts after VIA's EEPROM usage, +// dynamic keymaps start after this. +#define VIA_EEPROM_CUSTOM_CONFIG_SIZE 31 + +// VIA lighting is handled by the keyboard-level code +#define VIA_CUSTOM_LIGHTING_ENABLE diff --git a/keyboards/xelus/dawn60/rev1/rev1.c b/keyboards/xelus/dawn60/rev1/rev1.c new file mode 100644 index 0000000000..2d0b465bcc --- /dev/null +++ b/keyboards/xelus/dawn60/rev1/rev1.c @@ -0,0 +1,18 @@ +/* Copyright 2020 Harrison Chan (Xelus) + * + * 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/>. + */ +#ifndef RGB_BACKLIGHT_DAWN60 +#error RGB_BACKLIGHT_DAWN60 not defined, you done goofed somehao, brah +#endif diff --git a/keyboards/xelus/dawn60/rev1/rev1.h b/keyboards/xelus/dawn60/rev1/rev1.h new file mode 100644 index 0000000000..53d40e5499 --- /dev/null +++ b/keyboards/xelus/dawn60/rev1/rev1.h @@ -0,0 +1,36 @@ +/* Copyright 2020 Harrison Chan (Xelus) + * + * 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" +#include "keyboards/wilba_tech/wt_rgb_backlight_keycodes.h" +#include "via.h" + +#define XXX KC_NO + +#define LAYOUT_60_all( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K2D, \ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ + K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3B, K3C, K3D, \ + K40, K41, K42, K45, K49, K4A, K4B, K4C, K4D \ +) { \ + { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D }, \ + { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D }, \ + { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, XXX, K3B, K3C, K3D }, \ + { K40, K41, K42, XXX, XXX, K45, XXX, XXX, XXX, K49, K4A, K4B, K4C, K4D } \ +} diff --git a/keyboards/xelus/dawn60/rules.mk b/keyboards/xelus/dawn60/rev1/rules.mk index 3ac5f9977d..3ac5f9977d 100644 --- a/keyboards/xelus/dawn60/rules.mk +++ b/keyboards/xelus/dawn60/rev1/rules.mk diff --git a/keyboards/xelus/valor/config.h b/keyboards/xelus/valor/rev1/config.h index a45ecbc079..a45ecbc079 100644 --- a/keyboards/xelus/valor/config.h +++ b/keyboards/xelus/valor/rev1/config.h diff --git a/keyboards/xelus/valor/keymaps/default/keymap.c b/keyboards/xelus/valor/rev1/keymaps/default/keymap.c index 3cf8111e97..3cf8111e97 100644 --- a/keyboards/xelus/valor/keymaps/default/keymap.c +++ b/keyboards/xelus/valor/rev1/keymaps/default/keymap.c diff --git a/keyboards/xelus/valor/keymaps/default/readme.md b/keyboards/xelus/valor/rev1/keymaps/default/readme.md index d596c606c7..d596c606c7 100644 --- a/keyboards/xelus/valor/keymaps/default/readme.md +++ b/keyboards/xelus/valor/rev1/keymaps/default/readme.md diff --git a/keyboards/xelus/valor/keymaps/via/keymap.c b/keyboards/xelus/valor/rev1/keymaps/via/keymap.c index b3395f1dfb..b3395f1dfb 100644 --- a/keyboards/xelus/valor/keymaps/via/keymap.c +++ b/keyboards/xelus/valor/rev1/keymaps/via/keymap.c diff --git a/keyboards/xelus/valor/keymaps/via/readme.md b/keyboards/xelus/valor/rev1/keymaps/via/readme.md index 1efb713ba9..1efb713ba9 100644 --- a/keyboards/xelus/valor/keymaps/via/readme.md +++ b/keyboards/xelus/valor/rev1/keymaps/via/readme.md diff --git a/keyboards/xelus/valor/keymaps/via/rules.mk b/keyboards/xelus/valor/rev1/keymaps/via/rules.mk index 1e5b99807c..1e5b99807c 100644 --- a/keyboards/xelus/valor/keymaps/via/rules.mk +++ b/keyboards/xelus/valor/rev1/keymaps/via/rules.mk diff --git a/keyboards/xelus/valor/readme.md b/keyboards/xelus/valor/rev1/readme.md index 85cc9ad723..decd1fe29f 100644 --- a/keyboards/xelus/valor/readme.md +++ b/keyboards/xelus/valor/rev1/readme.md @@ -8,6 +8,6 @@ An Alice replacement keyboard PCB. Make example for this keyboard (after setting up your build environment): - make xelus/valor:default + make xelus/valor/rev1:default See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). diff --git a/keyboards/xelus/valor/valor.c b/keyboards/xelus/valor/rev1/rev1.c index 5157a2c730..614899aaed 100644 --- a/keyboards/xelus/valor/valor.c +++ b/keyboards/xelus/valor/rev1/rev1.c @@ -16,4 +16,4 @@ // Nothing to see here, move along... ;-) -#include "valor.h"
\ No newline at end of file +#include "rev1.h"
\ No newline at end of file diff --git a/keyboards/xelus/valor/valor.h b/keyboards/xelus/valor/rev1/rev1.h index c43274605d..c43274605d 100644 --- a/keyboards/xelus/valor/valor.h +++ b/keyboards/xelus/valor/rev1/rev1.h diff --git a/keyboards/xelus/valor/rules.mk b/keyboards/xelus/valor/rev1/rules.mk index f244afd31c..f244afd31c 100644 --- a/keyboards/xelus/valor/rules.mk +++ b/keyboards/xelus/valor/rev1/rules.mk diff --git a/keyboards/xelus/valor_frl_tkl/chconf.h b/keyboards/xelus/valor_frl_tkl/chconf.h new file mode 100644 index 0000000000..03f63da36a --- /dev/null +++ b/keyboards/xelus/valor_frl_tkl/chconf.h @@ -0,0 +1,714 @@ +/* + ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @file rt/templates/chconf.h + * @brief Configuration file template. + * @details A copy of this file must be placed in each project directory, it + * contains the application specific kernel settings. + * + * @addtogroup config + * @details Kernel related settings and hooks. + * @{ + */ + +#ifndef CHCONF_H +#define CHCONF_H + +#define _CHIBIOS_RT_CONF_ +#define _CHIBIOS_RT_CONF_VER_6_0_ + +/*===========================================================================*/ +/** + * @name System timers settings + * @{ + */ +/*===========================================================================*/ + +/** + * @brief System time counter resolution. + * @note Allowed values are 16 or 32 bits. + */ +#if !defined(CH_CFG_ST_RESOLUTION) +#define CH_CFG_ST_RESOLUTION 32 +#endif + +/** + * @brief System tick frequency. + * @details Frequency of the system timer that drives the system ticks. This + * setting also defines the system tick time unit. + */ +#if !defined(CH_CFG_ST_FREQUENCY) +#define CH_CFG_ST_FREQUENCY 10000 +#endif + +/** + * @brief Time intervals data size. + * @note Allowed values are 16, 32 or 64 bits. + */ +#if !defined(CH_CFG_INTERVALS_SIZE) +#define CH_CFG_INTERVALS_SIZE 32 +#endif + +/** + * @brief Time types data size. + * @note Allowed values are 16 or 32 bits. + */ +#if !defined(CH_CFG_TIME_TYPES_SIZE) +#define CH_CFG_TIME_TYPES_SIZE 32 +#endif + +/** + * @brief Time delta constant for the tick-less mode. + * @note If this value is zero then the system uses the classic + * periodic tick. This value represents the minimum number + * of ticks that is safe to specify in a timeout directive. + * The value one is not valid, timeouts are rounded up to + * this value. + */ +#if !defined(CH_CFG_ST_TIMEDELTA) +#define CH_CFG_ST_TIMEDELTA 2 +#endif + +/** @} */ + +/*===========================================================================*/ +/** + * @name Kernel parameters and options + * @{ + */ +/*===========================================================================*/ + +/** + * @brief Round robin interval. + * @details This constant is the number of system ticks allowed for the + * threads before preemption occurs. Setting this value to zero + * disables the preemption for threads with equal priority and the + * round robin becomes cooperative. Note that higher priority + * threads can still preempt, the kernel is always preemptive. + * @note Disabling the round robin preemption makes the kernel more compact + * and generally faster. + * @note The round robin preemption is not supported in tickless mode and + * must be set to zero in that case. + */ +#if !defined(CH_CFG_TIME_QUANTUM) +#define CH_CFG_TIME_QUANTUM 0 +#endif + +/** + * @brief Managed RAM size. + * @details Size of the RAM area to be managed by the OS. If set to zero + * then the whole available RAM is used. The core memory is made + * available to the heap allocator and/or can be used directly through + * the simplified core memory allocator. + * + * @note In order to let the OS manage the whole RAM the linker script must + * provide the @p __heap_base__ and @p __heap_end__ symbols. + * @note Requires @p CH_CFG_USE_MEMCORE. + */ +#if !defined(CH_CFG_MEMCORE_SIZE) +#define CH_CFG_MEMCORE_SIZE 0 +#endif + +/** + * @brief Idle thread automatic spawn suppression. + * @details When this option is activated the function @p chSysInit() + * does not spawn the idle thread. The application @p main() + * function becomes the idle thread and must implement an + * infinite loop. + */ +#if !defined(CH_CFG_NO_IDLE_THREAD) +#define CH_CFG_NO_IDLE_THREAD FALSE +#endif + +/** @} */ + +/*===========================================================================*/ +/** + * @name Performance options + * @{ + */ +/*===========================================================================*/ + +/** + * @brief OS optimization. + * @details If enabled then time efficient rather than space efficient code + * is used when two possible implementations exist. + * + * @note This is not related to the compiler optimization options. + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_OPTIMIZE_SPEED) +#define CH_CFG_OPTIMIZE_SPEED FALSE +#endif + +/** @} */ + +/*===========================================================================*/ +/** + * @name Subsystem options + * @{ + */ +/*===========================================================================*/ + +/** + * @brief Time Measurement APIs. + * @details If enabled then the time measurement APIs are included in + * the kernel. + * + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_USE_TM) +#define CH_CFG_USE_TM FALSE +#endif + +/** + * @brief Threads registry APIs. + * @details If enabled then the registry APIs are included in the kernel. + * + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_USE_REGISTRY) +#define CH_CFG_USE_REGISTRY TRUE +#endif + +/** + * @brief Threads synchronization APIs. + * @details If enabled then the @p chThdWait() function is included in + * the kernel. + * + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_USE_WAITEXIT) +#define CH_CFG_USE_WAITEXIT TRUE +#endif + +/** + * @brief Semaphores APIs. + * @details If enabled then the Semaphores APIs are included in the kernel. + * + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_USE_SEMAPHORES) +#define CH_CFG_USE_SEMAPHORES TRUE +#endif + +/** + * @brief Semaphores queuing mode. + * @details If enabled then the threads are enqueued on semaphores by + * priority rather than in FIFO order. + * + * @note The default is @p FALSE. Enable this if you have special + * requirements. + * @note Requires @p CH_CFG_USE_SEMAPHORES. + */ +#if !defined(CH_CFG_USE_SEMAPHORES_PRIORITY) +#define CH_CFG_USE_SEMAPHORES_PRIORITY FALSE +#endif + +/** + * @brief Mutexes APIs. + * @details If enabled then the mutexes APIs are included in the kernel. + * + * @note The default is @p TRUE. + */ +#if !defined(CH_CFG_USE_MUTEXES) +#define CH_CFG_USE_MUTEXES TRUE +#endif + +/** + * @brief Enables recursive behavior on mutexes. + * @note Recursive mutexes are heavier and have an increased + * memory footprint. + * + * @note The default is @p FALSE. + * @note Requires @p CH_CFG_USE_MUTEXES. + */ +#if |