/** ****************************************************************************** * @file stm32f10x_dbgmcu.c * @author MCD Application Team * @version V3.1.0 * @date 06/19/2009 * @brief This file provides all the DBGMCU firmware functions. ****************************************************************************** * @copy * * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. * *

© COPYRIGHT 2009 STMicroelectronics

*/ /* Includes ------------------------------------------------------------------*/ #include "stm32f10x_dbgmcu.h" /** @addtogroup STM32F10x_StdPeriph_Driver * @{ */ /** @defgroup DBGMCU * @brief DBGMCU driver modules * @{ */ /** @defgroup DBGMCU_Private_TypesDefinitions * @{ */ /** * @} */ /** @defgroup DBGMCU_Private_Defines * @{ */ #define IDCODE_DEVID_Mask ((uint32_t)0x00000FFF) /** * @} */ /** @defgroup DBGMCU_Private_Macros * @{ */ /** * @} */ /** @defgroup DBGMCU_Private_Variables * @{ */ /** * @} */ /** @defgroup DBGMCU_Private_FunctionPrototypes * @{ */ /** * @} */ /** @defgroup DBGMCU_Private_Functions * @{ */ /** * @brief Returns the device revision identifier. * @param None * @retval Device revision identifier */ uint32_t DBGMCU_GetREVID(void) { return(DBGMCU->IDCODE >> 16); } /** * @brief Returns the device identifier. * @param None * @retval Device identifier */ uint32_t DBGMCU_GetDEVID(void) { return(DBGMCU->IDCODE & IDCODE_DEVID_Mask); } /** * @brief Configures the specified peripheral and low power mode behavior * when the MCU under Debug mode. * @param DBGMCU_Periph: specifies the peripheral and low power mode. * This parameter can be any combination of the following values: * @arg DBGMCU_SLEEP: Keep debugger connection during SLEEP mode * @arg DBGMCU_STOP: Keep debugger connection during STOP mode * @arg DBGMCU_STANDBY: Keep debugger connection during STANDBY mode * @arg DBGMCU_IWDG_STOP: Debug IWDG stopped when Core is halted * @arg DBGMCU_WWDG_STOP: Debug WWDG stopped when Core is halted * @arg DBGMCU_TIM1_STOP: TIM1 counter stopped when Core is halted * @arg DBGMCU_TIM2_STOP: TIM2 counter stopped when Core is halted * @arg DBGMCU_TIM3_STOP: TIM3 counter stopped when Core is halted * @arg DBGMCU_TIM4_STOP: TIM4 counter stopped when Core is halted * @arg DBGMCU_CAN1_STOP: Debug CAN2 stopped when Core is halted * @arg DBGMCU_I2C1_SMBUS_TIMEOUT: I2C1 SMBUS timeout mode stopped when Core is halted * @arg DBGMCU_I2C2_SMBUS_TIMEOUT: I2C2 SMBUS timeout mode stopped when Core is halted * @arg DBGMCU_TIM5_STOP: TIM5 counter stopped when Core is halted * @arg DBGMCU_TIM6_STOP: TIM6 counter stopped when Core is halted * @arg DBGMCU_TIM7_STOP: TIM7 counter stopped when Core is halted * @arg DBGMCU_TIM8_STOP: TIM8 counter stopped when Core is halted * @arg DBGMCU_CAN2_STOP: Debug CAN2 stopped when Core is halted * @param NewState: new state of the specified peripheral in Debug mode. * This parameter can be: ENABLE or DISABLE. * @retval None */ void DBGMCU_Config(uint32_t DBGMCU_Periph, FunctionalState NewState) { /* Check the parameters */ assert_param(IS_DBGMCU_PERIPH(DBGMCU_Periph)); assert_param(IS_FUNCTIONAL_STATE(NewState)); if (NewState != DISABLE) { DBGMCU->CR |= DBGMCU_Periph; } else { DBGMCU->CR &= ~DBGMCU_Periph; } } /** * @} */ /** * @} */ /** * @} */ /******************* (C) COPYRIGHT 2009 STMicroelectronics *****END OF FILE****/ ' href='#n48'>48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
# Keycodes Overview

When defining a [keymap](keymap.md) each key needs a valid key definition. This page documents the symbols that correspond to keycodes that are available to you in QMK.

This is a reference only. Each group of keys links to the page documenting their functionality in more detail.

## [Basic Keycodes](keycodes_basic.md)

|Key                    |Aliases                       |Description                                    |
|-----------------------|------------------------------|-----------------------------------------------|
|`KC_NO`                |`XXXXXXX`                     |Ignore this key (NOOP)                         |
|`KC_TRANSPARENT`       |`KC_TRNS`, `_______`          |Use the next lowest non-transparent key        |
|`KC_A`                 |                              |`a` and `A`                                    |
|`KC_B`                 |                              |`b` and `B`                                    |
|`KC_C`                 |                              |`c` and `C`                                    |
|`KC_D`                 |                              |`d` and `D`                                    |
|`KC_E`                 |                              |`e` and `E`                                    |
|`KC_F`                 |                              |`f` and `F`                                    |
|`KC_G`                 |                              |`g` and `G`                                    |
|`KC_H`                 |                              |`h` and `H`                                    |
|`KC_I`                 |                              |`i` and `I`                                    |
|`KC_J`                 |                              |`j` and `J`                                    |
|`KC_K`                 |                              |`k` and `K`                                    |
|`KC_L`                 |                              |`l` and `L`                                    |
|`KC_M`                 |                              |`m` and `M`                                    |
|`KC_N`                 |                              |`n` and `N`                                    |
|`KC_O`                 |                              |`o` and `O`                                    |
|`KC_P`                 |                              |`p` and `P`                                    |
|`KC_Q`                 |                              |`q` and `Q`                                    |
|`KC_R`                 |                              |`r` and `R`                                    |
|`KC_S`                 |                              |`s` and `S`                                    |
|`KC_T`                 |                              |`t` and `T`                                    |
|`KC_U`                 |                              |`u` and `U`                                    |
|`KC_V`                 |                              |`v` and `V`                                    |
|`KC_W`                 |                              |`w` and `W`                                    |
|`KC_X`                 |                              |`x` and `X`                                    |
|`KC_Y`                 |                              |`y` and `Y`                                    |
|`KC_Z`                 |                              |`z` and `Z`                                    |
|`KC_1`                 |                              |`1` and `!`                                    |
|`KC_2`                 |                              |`2` and `@`                                    |
|`KC_3`                 |                              |`3` and `#`                                    |
|`KC_4`                 |                              |`4` and `$`                                    |
|`KC_5`                 |                              |`5` and `%`                                    |
|`KC_6`                 |                              |`6` and `^`                                    |
|`KC_7`                 |                              |`7` and `&`                                    |
|`KC_8`                 |                              |`8` and `*`                                    |
|`KC_9`                 |                              |`9` and `(`                                    |
|`KC_0`                 |                              |`0` and `)`                                    |
|`KC_ENTER`             |`KC_ENT`                      |Return (Enter)                                 |
|`KC_ESCAPE`            |`KC_ESC`                      |Escape                                         |
|`KC_BSPACE`            |`KC_BSPC`                     |Delete (Backspace)                             |
|`KC_TAB`               |                              |Tab                                            |
|`KC_SPACE`             |`KC_SPC`                      |Spacebar                                       |
|`KC_MINUS`             |`KC_MINS`                     |`-` and `_`                                    |
|`KC_EQUAL`             |`KC_EQL`                      |`=` and `+`                                    |
|`KC_LBRACKET`          |`KC_LBRC`                     |`[` and `{`                                    |
|`KC_RBRACKET`          |`KC_RBRC`                     |`]` and `}`                                    |
|`KC_BSLASH`            |`KC_BSLS`                     |`\` and <code>&#124;</code>                    |
|`KC_NONUS_HASH`        |`KC_NUHS`                     |Non-US `#` and `~`                             |
|`KC_SCOLON`            |`KC_SCLN`                     |`;` and `:`                                    |
|`KC_QUOTE`             |`KC_QUOT`                     |`'` and `"`                                    |
|`KC_GRAVE`             |`KC_GRV`, `KC_ZKHK`           |<code>&#96;</code> and `~`, JIS Zenkaku/Hankaku|
|`KC_COMMA`             |`KC_COMM`                     |`,` and `<`                                    |
|`KC_DOT`               |                              |`.` and `>`                                    |
|`KC_SLASH`             |`KC_SLSH`                     |`/` and `?`                                    |
|`KC_CAPSLOCK`          |`KC_CLCK`, `KC_CAPS`          |Caps Lock                                      |
|`KC_F1`                |                              |F1                                             |
|`KC_F2`                |                              |F2                                             |
|`KC_F3`                |                              |F3                                             |
|`KC_F4`                |                              |F4                                             |
|`KC_F5`                |                              |F5                                             |
|`KC_F6`                |                              |F6                                             |
|`KC_F7`                |                              |F7                                             |
|`KC_F8`                |                              |F8                                             |
|`KC_F9`                |                              |F9                                             |
|`KC_F10`               |                              |F10                                            |
|`KC_F11`               |                              |F11                                            |
|`KC_F12`               |                              |F12                                            |
|`KC_PSCREEN`           |`KC_PSCR`                     |Print Screen                                   |
|`KC_SCROLLLOCK`        |`KC_SLCK`, `KC_BRMD`          |Scroll Lock, Brightness Down (macOS)           |
|`KC_PAUSE`             |`KC_PAUS`, `KC_BRK`, `KC_BRMU`|Pause, Brightness Up (macOS)                   |
|`KC_INSERT`            |`KC_INS`                      |Insert                                         |
|`KC_HOME`              |                              |Home                                           |
|`KC_PGUP`              |                              |Page Up                                        |
|`KC_DELETE`            |`KC_DEL`                      |Forward Delete                                 |
|`KC_END`               |                              |End                                            |
|`KC_PGDOWN`            |`KC_PGDN`                     |Page Down                                      |
|`KC_RIGHT`             |`KC_RGHT`                     |Right Arrow                                    |
|`KC_LEFT`              |                              |Left Arrow                                     |
|`KC_DOWN`              |                              |Down Arrow                                     |
|`KC_UP`                |                              |Up Arrow                                       |
|`KC_NUMLOCK`           |`KC_NLCK`                     |Keypad Num Lock and Clear                      |
|`KC_KP_SLASH`          |`KC_PSLS`                     |Keypad `/`                                     |
|`KC_KP_ASTERISK`       |`KC_PAST`                     |Keypad `*`                                     |
|`KC_KP_MINUS`          |`KC_PMNS`                     |Keypad `-`                                     |
|`KC_KP_PLUS`           |`KC_PPLS`                     |Keypad `+`                                     |
|`KC_KP_ENTER`          |`KC_PENT`                     |Keypad Enter                                   |
|`KC_KP_1`              |`KC_P1`                       |Keypad `1` and End                             |
|`KC_KP_2`              |`KC_P2`                       |Keypad `2` and Down Arrow                      |
|`KC_KP_3`              |`KC_P3`                       |Keypad `3` and Page Down                       |
|`KC_KP_4`              |`KC_P4`                       |Keypad `4` and Left Arrow                      |
|`KC_KP_5`              |`KC_P5`                       |Keypad `5`                                     |
|`KC_KP_6`              |`KC_P6`                       |Keypad `6` and Right Arrow                     |
|`KC_KP_7`              |`KC_P7`                       |Keypad `7` and Home                            |
|`KC_KP_8`              |`KC_P8`                       |Keypad `8` and Up Arrow                        |
|`KC_KP_9`              |`KC_P9`                       |Keypad `9` and Page Up                         |
|`KC_KP_0`              |`KC_P0`                       |Keypad `0` and Insert                          |
|`KC_KP_DOT`            |`KC_PDOT`                     |Keypad `.` and Delete                          |
|`KC_NONUS_BSLASH`      |`KC_NUBS`                     |Non-US `\` and <code>&#124;</code>             |
|`KC_APPLICATION`       |`KC_APP`                      |Application (Windows Menu Key)                 |
|`KC_POWER`             |                              |System Power (macOS)                           |
|`KC_KP_EQUAL`          |`KC_PEQL`                     |Keypad `=`                                     |
|`KC_F13`               |                              |F13                                            |
|`KC_F14`               |                              |F14                                            |
|`KC_F15`               |                              |F15                                            |
|`KC_F16`               |                              |F16                                            |
|`KC_F17`               |                              |F17                                            |
|`KC_F18`               |                              |F18                                            |
|`KC_F19`               |                              |F19                                            |
|`KC_F20`               |                              |F20                                            |
|`KC_F21`               |                              |F21                                            |
|`KC_F22`               |                              |F22                                            |
|`KC_F23`               |                              |F23                                            |
|`KC_F24`               |                              |F24                                            |
|`KC_EXECUTE`           |`KC_EXEC`                     |Execute                                        |
|`KC_HELP`              |                              |Help                                           |
|`KC_MENU`              |                              |Menu                                           |
|`KC_SELECT`            |`KC_SLCT`                     |Select                                         |
|`KC_STOP`              |                              |Stop                                           |
|`KC_AGAIN`             |`KC_AGIN`                     |Again                                          |
|`KC_UNDO`              |                              |Undo                                           |
|`KC_CUT`               |                              |Cut                                            |
|`KC_COPY`              |                              |Copy                                           |
|`KC_PASTE`             |`KC_PSTE`                     |Paste                                          |
|`KC_FIND`              |                              |Find                                           |
|`KC__MUTE`             |                              |Mute (macOS)                                   |
|`KC__VOLUP`            |                              |Volume Up (macOS)                              |
|`KC__VOLDOWN`          |                              |Volume Down (macOS)                            |
|`KC_LOCKING_CAPS`      |`KC_LCAP`                     |Locking Caps Lock                              |
|`KC_LOCKING_NUM`       |`KC_LNUM`                     |Locking Num Lock                               |
|`KC_LOCKING_SCROLL`    |`KC_LSCR`                     |Locking Scroll Lock                            |
|`KC_KP_COMMA`          |`KC_PCMM`                     |Keypad `,`                                     |
|`KC_KP_EQUAL_AS400`    |                              |Keypad `=` on AS/400 keyboards                 |
|`KC_INT1`              |`KC_RO`                       |JIS `\` and `_`                                |
|`KC_INT2`              |`KC_KANA`                     |JIS Katakana/Hiragana                          |
|`KC_INT3`              |`KC_JYEN`                     |JIS `¥` and <code>&#124;</code>                |
|`KC_INT4`              |`KC_HENK`                     |JIS Henkan                                     |
|`KC_INT5`              |`KC_MHEN`                     |JIS Muhenkan                                   |
|`KC_INT6`              |                              |JIS Numpad `,`                                 |
|`KC_INT7`              |                              |International 7                                |
|`KC_INT8`              |                              |International 8                                |
|`KC_INT9`              |                              |International 9                                |
|`KC_LANG1`             |`KC_HAEN`                     |Hangul/English                                 |
|`KC_LANG2`             |`KC_HANJ`                     |Hanja                                          |
|`KC_LANG3`             |                              |JIS Katakana                                   |
|`KC_LANG4`             |                              |JIS Hiragana                                   |
|`KC_LANG5`             |                              |JIS Zenkaku/Hankaku                            |
|`KC_LANG6`             |                              |Language 6                                     |
|`KC_LANG7`             |                              |Language 7                                     |
|`KC_LANG8`             |                              |Language 8                                     |
|`KC_LANG9`             |                              |Language 9                                     |
|`KC_ALT_ERASE`         |`KC_ERAS`                     |Alternate Erase                                |
|`KC_SYSREQ`            |                              |SysReq/Attention                               |
|`KC_CANCEL`            |                              |Cancel                                         |
|`KC_CLEAR`             |`KC_CLR`                      |Clear                                          |
|`KC_PRIOR`             |                              |Prior                                          |
|`KC_RETURN`            |                              |Return                                         |
|`KC_SEPARATOR`         |                              |Separator                                      |
|`KC_OUT`               |                              |Out                                            |
|`KC_OPER`              |                              |Oper                                           |
|`KC_CLEAR_AGAIN`       |                              |Clear/Again                                    |
|`KC_CRSEL`             |                              |CrSel/Props                                    |
|`KC_EXSEL`             |                              |ExSel                                          |
|`KC_LCTRL`             |`KC_LCTL`                     |Left Control                                   |
|`KC_LSHIFT`            |`KC_LSFT`                     |Left Shift                                     |
|`KC_LALT`              |                              |Left Alt                                       |
|`KC_LGUI`              |`KC_LCMD`, `KC_LWIN`          |Left GUI (Windows/Command/Meta key)            |
|`KC_RCTRL`             |`KC_RCTL`                     |Right Control                                  |
|`KC_RSHIFT`            |`KC_RSFT`                     |Right Shift                                    |
|`KC_RALT`              |`KC_ALGR`                     |Right Alt (AltGr)                              |
|`KC_RGUI`              |`KC_RCMD`, `KC_RWIN`          |Right GUI (Windows/Command/Meta key)           |
|`KC_SYSTEM_POWER`      |`KC_PWR`                      |System Power Down                              |
|`KC_SYSTEM_SLEEP`      |`KC_SLEP`                     |System Sleep                                   |
|`KC_SYSTEM_WAKE`       |`KC_WAKE`                     |System Wake                                    |