// =================================================================== // // Copyright (c) 2005, Intel Corp. // All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions // are met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following // disclaimer in the documentation and/or other materials provided // with the distribution. // * Neither the name of Intel Corporation nor the names of its // contributors may be used to endorse or promote products derived // from this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE // COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED // OF THE POSSIBILITY OF SUCH DAMAGE. // =================================================================== // // bsg.h // // This file contains API's for the TPM Byte Stream functions // // ================================================================== #ifndef __BSG_H__ #define __BSG_H__ #include #include "buffer.h" typedef unsigned int BSG_UINT32; typedef unsigned char BSG_BYTE; // forward decl struct pack_const_tuple_t; struct pack_tuple_t; /** * Byte stream generator */ // this has to be manually kept in sync with the // s_fmt array!! // but now we have a self-check function which can make sure things are well // (if used!) typedef enum BSG_Type { BSG_TYPE_FIRST = 1, BSG_TYPE_UINT32 = 1, // start at 1 so that Type 0 only serves as an // unused/special value BSG_TYPE_UINT16, BSG_TYPE_BYTE, BSG_TYPE_BOOL, BSG_TPM_SIZE32_DATA, // a 32 bit unsigned size, followed by // a pointer to that much data. can pass a // struct pack_buf_t as the param BSG_TPM_TAG, BSG_TPM_HANDLE, BSG_TPM_RESULT, BSG_TPM_RESOURCE_TYPE, BSG_TPM_COMMAND_CODE, BSG_TPM_AUTH_DATA_USAGE, BSG_TPM_ALGORITHM_ID, BSG_TPM_PROTOCOL_ID, BSG_TPM_KEY_USAGE, BSG_TPM_ENC_SCHEME, BSG_TPM_SIG_SCHEME, BSG_TPM_MIGRATE_SCHEME, BSG_TPM_KEY_FLAGS, BSG_TPM_AUTHDATA, BSG_TPM_SECRET, BSG_TPM_ENCAUTH, BSG_TPM_PAYLOAD_TYPE, BSG_TPM_VERSION, BSG_TPM_DIGEST, BSG_TPM_COMPOSITE_HASH, BSG_TPM_CHOSENID_HASH, BSG_TPM_NONCE, BSG_TPM_KEY_HANDLE, BSG_TPM_KEY_HANDLE_LIST, BSG_TPM_KEY_PARMS, BSG_TPM_RSA_KEY_PARMS, BSG_TPM_STORE_PUBKEY, BSG_TPM_PUBKEY, BSG_TPM_KEY, BSG_TPM_MIGRATIONKEYAUTH, BSG_TCPA_AUDIT_EVENT, BSG_TCPA_EVENT_CERT, BSG_TPM_PCR_SELECTION, BSG_TPM_PCR_COMPOSITE, BSG_TPM_PCR_INFO, BSG_TPM_STORED_DATA, BSG_TPM_SYMMETRIC_KEY, BSG_TPM_STORE_PRIVKEY, BSG_TPM_STORE_ASYMKEY, BSG_TPM_MIGRATE_ASYMKEY, BSG_TPM_QUOTE_INFO, BSG_TPM_IDENTITY_CONTENTS, BSG_TPM_PCRVALUE, BSG_TCPA_PCR_FLAGS, BSG_TCS_AUTH, // this is the BSG_TPM_KEY struct without the encData field BSG_TPM_KEY_NONSENSITIVE, BSG_PACKED, BSG_TYPE_MAX } BSG_Type; struct pack_const_tuple_t { BSG_Type type; const void * addr; }; typedef struct pack_tuple_t { BSG_Type type; void * addr; } pack_tuple_t; int BSG_Pack(BSG_Type type, const void* src, BSG_BYTE* dst); int BSG_Unpack(BSG_Type type, const BSG_BYTE* src, void* dst); void BSG_Destroy(BSG_Type type, void* src); // wrappers of Pack and PackList which malloc the ouput buffer. to be freed // by the caller later. returns size of allocated buffer, or -1 in case // allocation failed int BSG_PackMalloc (BSG_Type type, const void* src, BSG_BYTE** o_dst); int BSG_PackListMalloc (BSG_BYTE** outBuffer, int ParamCount, ... ); // a va_list version of PackList int BSG_PackList(BSG_BYTE* outBuffer, int ParamCount, ... ); int BSG_UnpackList(const BSG_BYTE* inBuffer, int ParamCount, ... ); void BSG_DestroyList(int ParamCount, ... ); // wrapper of PackList which uses a buffer_t TPM_RESULT BSG_PackListBuf (buffer_t * o_buf, int ParamCount, ...); // and a tuple version TPM_RESULT BSG_DestroyTuple (int numParams, pack_tuple_t params[]); void BSG_PackConst(BSG_UINT32 val, int size, BSG_BYTE* dst); BSG_UINT32 BSG_UnpackConst(const BSG_BYTE* src, int size); BOOL BSG_static_selfcheck (); #endif 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 
/*
Copyright 2012-2017 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 "keymap.h"
#include "report.h"
#include "keycode.h"
#include "action_layer.h"
#if defined(__AVR__)
#    include <util/delay.h>
#    include <stdio.h>
#endif
#include "action.h"
#include "action_macro.h"
#include "debug.h"
#include "quantum.h"

#ifdef BACKLIGHT_ENABLE
#    include "backlight.h"
#endif

#ifdef MIDI_ENABLE
#    include "process_midi.h"
#endif

extern keymap_config_t keymap_config;

#include <inttypes.h>

/* converts key to action */
action_t action_for_key(uint8_t layer, keypos_t key) {
    // 16bit keycodes - important
    uint16_t keycode = keymap_key_to_keycode(layer, key);

    // keycode remapping
    keycode = keycode_config(keycode);

    action_t action = {};
    uint8_t  action_layer, when, mod;

    switch (keycode) {
        case KC_A ... KC_EXSEL:
        case KC_LCTRL ... KC_RGUI:
            action.code = ACTION_KEY(keycode);
            break;
        case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
            action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
            break;
        case KC_AUDIO_MUTE ... KC_BRIGHTNESS_DOWN:
            action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
            break;
#ifdef MOUSEKEY_ENABLE
        case KC_MS_UP ... KC_MS_ACCEL2:
            action.code = ACTION_MOUSEKEY(keycode);
            break;
#endif
        case KC_TRNS:
            action.code = ACTION_TRANSPARENT;
            break;
        case QK_MODS ... QK_MODS_MAX:;
            // Has a modifier
            // Split it up
            action.code = ACTION_MODS_KEY(keycode >> 8, keycode & 0xFF);  // adds modifier to key
            break;
#ifndef NO_ACTION_FUNCTION
        case KC_FN0 ... KC_FN31:
            action.code = keymap_function_id_to_action(FN_INDEX(keycode));
            break;
        case QK_FUNCTION ... QK_FUNCTION_MAX:;
            // Is a shortcut for function action_layer, pull last 12bits
            // This means we have 4,096 FN macros at our disposal
            action.code = keymap_function_id_to_action((int)keycode & 0xFFF);
            break;
#endif
#ifndef NO_ACTION_MACRO
        case QK_MACRO ... QK_MACRO_MAX:
            if (keycode & 0x800)  // tap macros have upper bit set
                action.code = ACTION_MACRO_TAP(keycode & 0xFF);
            else
                action.code = ACTION_MACRO(keycode & 0xFF);
            break;
#endif
        case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
            action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
            break;
        case QK_TO ... QK_TO_MAX:;
            // Layer set "GOTO"
            when         = (keycode >> 0x4) & 0x3;
            action_layer = keycode & 0xF;
            action.code  = ACTION_LAYER_SET(action_layer, when);
            break;
        case QK_MOMENTARY ... QK_MOMENTARY_MAX:;
            // Momentary action_layer
            action_layer = keycode & 0xFF;
            action.code  = ACTION_LAYER_MOMENTARY(action_layer);
            break;
        case QK_DEF_LAYER ... QK_DEF_LAYER_MAX:;
            // Set default action_layer
            action_layer = keycode & 0xFF;
            action.code  = ACTION_DEFAULT_LAYER_SET(action_layer);
            break;
        case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX:;
            // Set toggle
            action_layer = keycode & 0xFF;
            action.code  = ACTION_LAYER_TOGGLE(action_layer);
            break;
        case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX:;
            // OSL(action_layer) - One-shot action_layer
            action_layer = keycode & 0xFF;
            action.code  = ACTION_LAYER_ONESHOT(action_layer);
            break;
        case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:;
            // OSM(mod) - One-shot mod
            mod         = mod_config(keycode & 0xFF);
            action.code = ACTION_MODS_ONESHOT(mod);
            break;
        case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
            action.code = ACTION_LAYER_TAP_TOGGLE(keycode & 0xFF);
            break;
        case QK_LAYER_MOD ... QK_LAYER_MOD_MAX:
            mod          = mod_config(keycode & 0xF);
            action_layer = (keycode >> 4) & 0xF;
            action.code  = ACTION_LAYER_MODS(action_layer, mod);
            break;
        case QK_MOD_TAP ... QK_MOD_TAP_MAX:
            mod         = mod_config((keycode >> 0x8) & 0x1F);
            action.code = ACTION_MODS_TAP_KEY(mod, keycode & 0xFF);
            break;
#ifdef BACKLIGHT_ENABLE
        case BL_ON:
            action.code = ACTION_BACKLIGHT_ON();
            break;
        case BL_OFF:
            action.code = ACTION_BACKLIGHT_OFF();
            break;
        case BL_DEC:
            action.code = ACTION_BACKLIGHT_DECREASE();
            break;
        case BL_INC:
            action.code = ACTION_BACKLIGHT_INCREASE();
            break;
        case BL_TOGG:
            action.code = ACTION_BACKLIGHT_TOGGLE();
            break;
        case BL_STEP:
            action.code = ACTION_BACKLIGHT_STEP();
            break;
#endif
#ifdef SWAP_HANDS_ENABLE
        case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
            action.code = ACTION(ACT_SWAP_HANDS, keycode & 0xff);
            break;
#endif

        default:
            action.code = ACTION_NO;
            break;
    }
    return action;
}

__attribute__((weak)) const uint16_t PROGMEM fn_actions[] = {

};

/* Macro */
__attribute__((weak)) const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { return MACRO_NONE; }

/* Function */
__attribute__((weak)) void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {}

// translates key to keycode
__attribute__((weak)) uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key) {
    // Read entire word (16bits)
    return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
}

// translates function id to action
__attribute__((weak)) uint16_t keymap_function_id_to_action(uint16_t function_id) {
// The compiler sees the empty (weak) fn_actions and generates a warning
// This function should not be called in that case, so the warning is too strict
// If this function is called however, the keymap should have overridden fn_actions, and then the compile
// is comparing against the wrong array
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Warray-bounds"
    return pgm_read_word(&fn_actions[function_id]);
#pragma GCC diagnostic pop
}
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-16 14:14:54 +0000