summaryrefslogtreecommitdiff
path: root/tmk_core/common
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-26 11:36:28 +1100
committerAlex Ong <the.onga@gmail.com>2019-01-26 11:36:28 +1100
commitd977daa8dc9136746425f9e1414e1f93cb161877 (patch)
tree209ab8082580e5fdf37f1a8b7c1169250b7548c0 /tmk_core/common
parent47c91fc7f75ae0a477e55b687aa0fc30da0a283c (diff)
parent0306e487e2cd6a77ad840d0a441b478747b7ccd0 (diff)
Merge branch 'master' of https://github.com/qmk/qmk_firmware
Diffstat (limited to 'tmk_core/common')
-rw-r--r--tmk_core/common/action.c10
-rw-r--r--tmk_core/common/action.h1
-rw-r--r--tmk_core/common/action_layer.c303
-rw-r--r--tmk_core/common/action_util.c4
-rw-r--r--tmk_core/common/arm_atsam/timer.c20
-rwxr-xr-xtmk_core/common/chibios/eeprom_stm32.c710
-rwxr-xr-xtmk_core/common/chibios/eeprom_stm32.h68
-rwxr-xr-xtmk_core/common/chibios/flash_stm32.c15
-rwxr-xr-xtmk_core/common/chibios/flash_stm32.h1
-rw-r--r--tmk_core/common/eeconfig.c4
-rw-r--r--tmk_core/common/eeconfig.h21
-rw-r--r--tmk_core/common/eeprom.h1
-rw-r--r--tmk_core/common/host.h11
-rw-r--r--tmk_core/common/keyboard.h2
-rw-r--r--tmk_core/common/keycode.h20
-rw-r--r--tmk_core/common/progmem.h6
-rw-r--r--tmk_core/common/report.h8
-rw-r--r--tmk_core/common/wait.h4
18 files changed, 371 insertions, 838 deletions
diff --git a/tmk_core/common/action.c b/tmk_core/common/action.c
index b99c2acaa7..ec8d6ed7b9 100644
--- a/tmk_core/common/action.c
+++ b/tmk_core/common/action.c
@@ -653,7 +653,7 @@ void process_action(keyrecord_t *record, action_t action)
#ifndef NO_ACTION_TAPPING
#ifdef RETRO_TAPPING
- if (!is_tap_key(record->event.key)) {
+ if (!is_tap_action(action)) {
retro_tapping_counter = 0;
} else {
if (event.pressed) {
@@ -929,7 +929,15 @@ void clear_keyboard_but_mods_and_keys()
bool is_tap_key(keypos_t key)
{
action_t action = layer_switch_get_action(key);
+ return is_tap_action(action);
+}
+/** \brief Utilities for actions. (FIXME: Needs better description)
+ *
+ * FIXME: Needs documentation.
+ */
+bool is_tap_action(action_t action)
+{
switch (action.kind.id) {
case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
diff --git a/tmk_core/common/action.h b/tmk_core/common/action.h
index 8e47e5339e..799e3bb0ef 100644
--- a/tmk_core/common/action.h
+++ b/tmk_core/common/action.h
@@ -97,6 +97,7 @@ void clear_keyboard_but_mods(void);
void clear_keyboard_but_mods_and_keys(void);
void layer_switch(uint8_t new_layer);
bool is_tap_key(keypos_t key);
+bool is_tap_action(action_t action);
#ifndef NO_ACTION_TAPPING
void process_record_tap_hint(keyrecord_t *record);
diff --git a/tmk_core/common/action_layer.c b/tmk_core/common/action_layer.c
index 120ce3f51b..6ff8c5549b 100644
--- a/tmk_core/common/action_layer.c
+++ b/tmk_core/common/action_layer.c
@@ -17,82 +17,76 @@ uint32_t default_layer_state = 0;
/** \brief Default Layer State Set At user Level
*
- * FIXME: Needs docs
+ * Run user code on default layer state change
*/
__attribute__((weak))
uint32_t default_layer_state_set_user(uint32_t state) {
- return state;
+ return state;
}
/** \brief Default Layer State Set At Keyboard Level
*
- * FIXME: Needs docs
+ * Run keyboard code on default layer state change
*/
__attribute__((weak))
uint32_t default_layer_state_set_kb(uint32_t state) {
- return default_layer_state_set_user(state);
+ return default_layer_state_set_user(state);
}
/** \brief Default Layer State Set
*
- * FIXME: Needs docs
+ * Static function to set the default layer state, prints debug info and clears keys
*/
-static void default_layer_state_set(uint32_t state)
-{
- state = default_layer_state_set_kb(state);
- debug("default_layer_state: ");
- default_layer_debug(); debug(" to ");
- default_layer_state = state;
- default_layer_debug(); debug("\n");
+static void default_layer_state_set(uint32_t state) {
+ state = default_layer_state_set_kb(state);
+ debug("default_layer_state: ");
+ default_layer_debug(); debug(" to ");
+ default_layer_state = state;
+ default_layer_debug(); debug("\n");
#ifdef STRICT_LAYER_RELEASE
- clear_keyboard_but_mods(); // To avoid stuck keys
+ clear_keyboard_but_mods(); // To avoid stuck keys
#else
- clear_keyboard_but_mods_and_keys(); // Don't reset held keys
+ clear_keyboard_but_mods_and_keys(); // Don't reset held keys
#endif
}
/** \brief Default Layer Print
*
- * FIXME: Needs docs
+ * Print out the hex value of the 32-bit default layer state, as well as the value of the highest bit.
*/
-void default_layer_debug(void)
-{
- dprintf("%08lX(%u)", default_layer_state, biton32(default_layer_state));
+void default_layer_debug(void) {
+ dprintf("%08lX(%u)", default_layer_state, biton32(default_layer_state));
}
/** \brief Default Layer Set
*
- * FIXME: Needs docs
+ * Sets the default layer state.
*/
-void default_layer_set(uint32_t state)
-{
- default_layer_state_set(state);
+void default_layer_set(uint32_t state) {
+ default_layer_state_set(state);
}
#ifndef NO_ACTION_LAYER
/** \brief Default Layer Or
*
- * FIXME: Needs docs
+ * Turns on the default layer based on matching bits between specifed layer and existing layer state
*/
-void default_layer_or(uint32_t state)
-{
- default_layer_state_set(default_layer_state | state);
+void default_layer_or(uint32_t state) {
+ default_layer_state_set(default_layer_state | state);
}
/** \brief Default Layer And
*
- * FIXME: Needs docs
+ * Turns on default layer based on matching enabled bits between specifed layer and existing layer state
*/
-void default_layer_and(uint32_t state)
-{
- default_layer_state_set(default_layer_state & state);
+void default_layer_and(uint32_t state) {
+ default_layer_state_set(default_layer_state & state);
}
/** \brief Default Layer Xor
*
- * FIXME: Needs docs
+ * Turns on default layer based on non-matching bits between specifed layer and existing layer state
*/
-void default_layer_xor(uint32_t state)
-{
- default_layer_state_set(default_layer_state ^ state);
+void default_layer_xor(uint32_t state) {
+ default_layer_state_set(default_layer_state ^ state);
}
#endif
@@ -104,170 +98,168 @@ uint32_t layer_state = 0;
/** \brief Layer state set user
*
- * FIXME: Needs docs
+ * Runs user code on layer state change
*/
__attribute__((weak))
uint32_t layer_state_set_user(uint32_t state) {
- return state;
+ return state;
}
/** \brief Layer state set keyboard
*
- * FIXME: Needs docs
+ * Runs keyboard code on layer state change
*/
__attribute__((weak))
uint32_t layer_state_set_kb(uint32_t state) {
- return layer_state_set_user(state);
+ return layer_state_set_user(state);
}
/** \brief Layer state set
*
- * FIXME: Needs docs
+ * Sets the layer to match the specifed state (a bitmask)
*/
-void layer_state_set(uint32_t state)
-{
- state = layer_state_set_kb(state);
- dprint("layer_state: ");
- layer_debug(); dprint(" to ");
- layer_state = state;
- layer_debug(); dprintln();
+void layer_state_set(uint32_t state) {
+ state = layer_state_set_kb(state);
+ dprint("layer_state: ");
+ layer_debug(); dprint(" to ");
+ layer_state = state;
+ layer_debug(); dprintln();
#ifdef STRICT_LAYER_RELEASE
- clear_keyboard_but_mods(); // To avoid stuck keys
+ clear_keyboard_but_mods(); // To avoid stuck keys
#else
- clear_keyboard_but_mods_and_keys(); // Don't reset held keys
+ clear_keyboard_but_mods_and_keys(); // Don't reset held keys
#endif
}
/** \brief Layer clear
*
- * FIXME: Needs docs
+ * Turn off all layers
*/
-void layer_clear(void)
-{
- layer_state_set(0);
+void layer_clear(void) {
+ layer_state_set(0);
}
/** \brief Layer state is
*
- * FIXME: Needs docs
+ * Return whether the given state is on (it might still be shadowed by a higher state, though)
*/
-bool layer_state_is(uint8_t layer)
-{
- return layer_state_cmp(layer_state, layer);
+bool layer_state_is(uint8_t layer) {
+ return layer_state_cmp(layer_state, layer);
}
/** \brief Layer state compare
*
- * FIXME: Needs docs
+ * Used for comparing layers {mostly used for unit testing}
*/
bool layer_state_cmp(uint32_t cmp_layer_state, uint8_t layer) {
- if (!cmp_layer_state) { return layer == 0; }
- return (cmp_layer_state & (1UL<<layer)) != 0;
+ if (!cmp_layer_state) { return layer == 0; }
+ return (cmp_layer_state & (1UL<<layer)) != 0;
}
/** \brief Layer move
*
- * FIXME: Needs docs
+ * Turns on the given layer and turn off all other layers
*/
-void layer_move(uint8_t layer)
-{
- layer_state_set(1UL<<layer);
+void layer_move(uint8_t layer) {
+ layer_state_set(1UL<<layer);
}
/** \brief Layer on
*
- * FIXME: Needs docs
+ * Turns on given layer
*/
-void layer_on(uint8_t layer)
-{
- layer_state_set(layer_state | (1UL<<layer));
+void layer_on(uint8_t layer) {
+ layer_state_set(layer_state | (1UL<<layer));
}
/** \brief Layer off
*
- * FIXME: Needs docs
+ * Turns off given layer
*/
-void layer_off(uint8_t layer)
-{
- layer_state_set(layer_state & ~(1UL<<layer));
+void layer_off(uint8_t layer) {
+ layer_state_set(layer_state & ~(1UL<<layer));
}
/** \brief Layer invert
*
- * FIXME: Needs docs
+ * Toggle the given layer (set it if it's unset, or unset it if it's set)
*/
-void layer_invert(uint8_t layer)
-{
- layer_state_set(layer_state ^ (1UL<<layer));
+void layer_invert(uint8_t layer) {
+ layer_state_set(layer_state ^ (1UL<<layer));
}
/** \brief Layer or
*
- * FIXME: Needs docs
+ * Turns on layers based on matching bits between specifed layer and existing layer state
*/
-void layer_or(uint32_t state)
-{
- layer_state_set(layer_state | state);
+void layer_or(uint32_t state) {
+ layer_state_set(layer_state | state);
}
/** \brief Layer and
*
- * FIXME: Needs docs
+ * Turns on layers based on matching enabled bits between specifed layer and existing layer state
*/
-void layer_and(uint32_t state)
-{
- layer_state_set(layer_state & state);
+void layer_and(uint32_t state) {
+ layer_state_set(layer_state & state);
}
/** \brief Layer xor
*
- * FIXME: Needs docs
+ * Turns on layers based on non-matching bits between specifed layer and existing layer state
*/
-void layer_xor(uint32_t state)
-{
- layer_state_set(layer_state ^ state);
+void layer_xor(uint32_t state) {
+ layer_state_set(layer_state ^ state);
}
/** \brief Layer debug printing
*
- * FIXME: Needs docs
+ * Print out the hex value of the 32-bit layer state, as well as the value of the highest bit.
*/
-void layer_debug(void)
-{
- dprintf("%08lX(%u)", layer_state, biton32(layer_state));
+void layer_debug(void) {
+ dprintf("%08lX(%u)", layer_state, biton32(layer_state));
}
#endif
#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
+/** \brief source layer cache
+ */
+
uint8_t source_layers_cache[(MATRIX_ROWS * MATRIX_COLS + 7) / 8][MAX_LAYER_BITS] = {{0}};
-void update_source_layers_cache(keypos_t key, uint8_t layer)
-{
- const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
- const uint8_t storage_row = key_number / 8;
- const uint8_t storage_bit = key_number % 8;
-
- for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
- source_layers_cache[storage_row][bit_number] ^=
- (-((layer & (1U << bit_number)) != 0)
- ^ source_layers_cache[storage_row][bit_number])
- & (1U << storage_bit);
- }
+/** \brief update source layers cache
+ *
+ * Updates the cached keys when changing layers
+ */
+void update_source_layers_cache(keypos_t key, uint8_t layer) {
+ const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
+ const uint8_t storage_row = key_number / 8;
+ const uint8_t storage_bit = key_number % 8;
+
+ for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
+ source_layers_cache[storage_row][bit_number] ^=
+ (-((layer & (1U << bit_number)) != 0)
+ ^ source_layers_cache[storage_row][bit_number])
+ & (1U << storage_bit);
+ }
}
-uint8_t read_source_layers_cache(keypos_t key)
-{
- const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
- const uint8_t storage_row = key_number / 8;
- const uint8_t storage_bit = key_number % 8;
- uint8_t layer = 0;
-
- for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
- layer |=
- ((source_layers_cache[storage_row][bit_number]
- & (1U << storage_bit)) != 0)
- << bit_number;
- }
-
- return layer;
+/** \brief read source layers cache
+ *
+ * reads the cached keys stored when the layer was changed
+ */
+uint8_t read_source_layers_cache(keypos_t key) {
+ const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
+ const uint8_t storage_row = key_number / 8;
+ const uint8_t storage_bit = key_number % 8;
+ uint8_t layer = 0;
+
+ for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
+ layer |=
+ ((source_layers_cache[storage_row][bit_number]
+ & (1U << storage_bit)) != 0)
+ << bit_number;
+ }
+
+ return layer;
}
#endif
@@ -278,61 +270,58 @@ uint8_t read_source_layers_cache(keypos_t key)
* when the layer is switched after the down event but before the up
* event as they may get stuck otherwise.
*/
-action_t store_or_get_action(bool pressed, keypos_t key)
-{
+action_t store_or_get_action(bool pressed, keypos_t key) {
#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
- if (disable_action_cache) {
- return layer_switch_get_action(key);
- }
-
- uint8_t layer;
-
- if (pressed) {
- layer = layer_switch_get_layer(key);
- update_source_layers_cache(key, layer);
- }
- else {
- layer = read_source_layers_cache(key);
- }
- return action_for_key(layer, key);
-#else
+ if (disable_action_cache) {
return layer_switch_get_action(key);
+ }
+
+ uint8_t layer;
+
+ if (pressed) {
+ layer = layer_switch_get_layer(key);
+ update_source_layers_cache(key, layer);
+ }
+ else {
+ layer = read_source_layers_cache(key);
+ }
+ return action_for_key(layer, key);
+#else
+ return layer_switch_get_action(key);
#endif
}
/** \brief Layer switch get layer
*
- * FIXME: Needs docs
+ * Gets the layer based on key info
*/
-int8_t layer_switch_get_layer(keypos_t key)
-{
+int8_t layer_switch_get_layer(keypos_t key) {
#ifndef NO_ACTION_LAYER
- action_t action;
- action.code = ACTION_TRANSPARENT;
-
- uint32_t layers = layer_state | default_layer_state;
- /* check top layer first */
- for (int8_t i = 31; i >= 0; i--) {
- if (layers & (1UL<<i)) {
- action = action_for_key(i, key);
- if (action.code != ACTION_TRANSPARENT) {
- return i;
- }
- }
+ action_t action;
+ action.code = ACTION_TRANSPARENT;
+
+ uint32_t layers = layer_state | default_layer_state;
+ /* check top layer first */
+ for (int8_t i = 31; i >= 0; i--) {
+ if (layers & (1UL<<i)) {
+ action = action_for_key(i, key);
+ if (action.code != ACTION_TRANSPARENT) {
+ return i;
+ }
}
- /* fall back to layer 0 */
- return 0;
+ }
+ /* fall back to layer 0 */
+ return 0;
#else
- return biton32(default_layer_state);
+ return biton32(default_layer_state);
#endif
}
/** \brief Layer switch get layer
*
- * FIXME: Needs docs
+ * Gets action code based on key position
*/
-action_t layer_switch_get_action(keypos_t key)
-{
- return action_for_key(layer_switch_get_layer(key), key);
+action_t layer_switch_get_action(keypos_t key) {
+ return action_for_key(layer_switch_get_layer(key), key);
}
diff --git a/tmk_core/common/action_util.c b/tmk_core/common/action_util.c
index afd4ae8b25..58401ace55 100644
--- a/tmk_core/common/action_util.c
+++ b/tmk_core/common/action_util.c
@@ -54,7 +54,7 @@ int8_t get_oneshot_locked_mods(void) { return oneshot_locked_mods; }
void set_oneshot_locked_mods(int8_t mods) { oneshot_locked_mods = mods; }
void clear_oneshot_locked_mods(void) { oneshot_locked_mods = 0; }
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
-static int16_t oneshot_time = 0;
+static uint16_t oneshot_time = 0;
bool has_oneshot_mods_timed_out(void) {
return TIMER_DIFF_16(timer_read(), oneshot_time) >= ONESHOT_TIMEOUT;
}
@@ -79,7 +79,7 @@ inline uint8_t get_oneshot_layer(void) { return oneshot_layer_data >> 3; }
inline uint8_t get_oneshot_layer_state(void) { return oneshot_layer_data & 0b111; }
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
-static int16_t oneshot_layer_time = 0;
+static uint16_t oneshot_layer_time = 0;
inline bool has_oneshot_layer_timed_out() {
return TIMER_DIFF_16(timer_read(), oneshot_layer_time) >= ONESHOT_TIMEOUT &&
!(get_oneshot_layer_state() & ONESHOT_TOGGLED);
diff --git a/tmk_core/common/arm_atsam/timer.c b/tmk_core/common/arm_atsam/timer.c
index bcfe5002c3..6c3905e308 100644
--- a/tmk_core/common/arm_atsam/timer.c
+++ b/tmk_core/common/arm_atsam/timer.c
@@ -9,7 +9,7 @@ void set_time(uint64_t tset)
void timer_init(void)
{
- ms_clk = 0;
+ timer_clear();
}
uint16_t timer_read(void)
@@ -37,23 +37,7 @@ uint32_t timer_elapsed32(uint32_t tlast)
return TIMER_DIFF_32(timer_read32(), tlast);
}
-uint32_t timer_elapsed64(uint32_t tlast)
-{
- uint64_t tnow = timer_read64();
- return (tnow >= tlast ? tnow - tlast : UINT64_MAX - tlast + tnow);
-}
-
void timer_clear(void)
{
- ms_clk = 0;
-}
-
-void wait_ms(uint64_t msec)
-{
- CLK_delay_ms(msec);
-}
-
-void wait_us(uint16_t usec)
-{
- CLK_delay_us(usec);
+ set_time(0);
}
diff --git a/tmk_core/common/chibios/eeprom_stm32.c b/tmk_core/common/chibios/eeprom_stm32.c
index a869985501..a15430d676 100755
--- a/tmk_core/common/chibios/eeprom_stm32.c
+++ b/tmk_core/common/chibios/eeprom_stm32.c
@@ -10,664 +10,206 @@
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
- * This files are free to use from https://github.com/rogerclarkmelbourne/Arduino_STM32 and
- * https://github.com/leaflabs/libmaple
+ * This files are free to use from http://engsta.com/stm32-flash-memory-eeprom-emulator/ by
+ * Artur F.
*
* Modifications for QMK and STM32F303 by Yiancar
*/
+#include <stdio.h>
+#include <string.h>
#include "eeprom_stm32.h"
+/*****************************************************************************
+ * Allows to use the internal flash to store non volatile data. To initialize
+ * the functionality use the EEPROM_Init() function. Be sure that by reprogramming
+ * of the controller just affected pages will be deleted. In other case the non
+ * volatile data will be lost.
+******************************************************************************/
+
+/* Private macro -------------------------------------------------------------*/
+/* Private variables ---------------------------------------------------------*/
+/* Functions -----------------------------------------------------------------*/
+
+uint8_t DataBuf[FEE_PAGE_SIZE];
+/*****************************************************************************
+* Delete Flash Space used for user Data, deletes the whole space between
+* RW_PAGE_BASE_ADDRESS and the last uC Flash Page
+******************************************************************************/
+uint16_t EEPROM_Init(void) {
+ // unlock flash
+ FLASH_Unlock();
- FLASH_Status EE_ErasePage(uint32_t);
-
- uint16_t EE_CheckPage(uint32_t, uint16_t);
- uint16_t EE_CheckErasePage(uint32_t, uint16_t);
- uint16_t EE_Format(void);
- uint32_t EE_FindValidPage(void);
- uint16_t EE_GetVariablesCount(uint32_t, uint16_t);
- uint16_t EE_PageTransfer(uint32_t, uint32_t, uint16_t);
- uint16_t EE_VerifyPageFullWriteVariable(uint16_t, uint16_t);
-
- uint32_t PageBase0 = EEPROM_PAGE0_BASE;
- uint32_t PageBase1 = EEPROM_PAGE1_BASE;
- uint32_t PageSize = EEPROM_PAGE_SIZE;
- uint16_t Status = EEPROM_NOT_INIT;
-
-// See http://www.st.com/web/en/resource/technical/document/application_note/CD00165693.pdf
-
-/**
- * @brief Check page for blank
- * @param page base address
- * @retval Success or error
- * EEPROM_BAD_FLASH: page not empty after erase
- * EEPROM_OK: page blank
- */
-uint16_t EE_CheckPage(uint32_t pageBase, uint16_t status)
-{
- uint32_t pageEnd = pageBase + (uint32_t)PageSize;
-
- // Page Status not EEPROM_ERASED and not a "state"
- if ((*(__IO uint16_t*)pageBase) != EEPROM_ERASED && (*(__IO uint16_t*)pageBase) != status)
- return EEPROM_BAD_FLASH;
- for(pageBase += 4; pageBase < pageEnd; pageBase += 4)
- if ((*(__IO uint32_t*)pageBase) != 0xFFFFFFFF) // Verify if slot is empty
- return EEPROM_BAD_FLASH;
- return EEPROM_OK;
-}
-
-/**
- * @brief Erase page with increment erase counter (page + 2)
- * @param page base address
- * @retval Success or error
- * FLASH_COMPLETE: success erase
- * - Flash error code: on write Flash error
- */
-FLASH_Status EE_ErasePage(uint32_t pageBase)
-{
- FLASH_Status FlashStatus;
- uint16_t data = (*(__IO uint16_t*)(pageBase));
- if ((data == EEPROM_ERASED) || (data == EEPROM_VALID_PAGE) || (data == EEPROM_RECEIVE_DATA))
- data = (*(__IO uint16_t*)(pageBase + 2)) + 1;
- else
- data = 0;
-
- FlashStatus = FLASH_ErasePage(pageBase);
- if (FlashStatus == FLASH_COMPLETE)
- FlashStatus = FLASH_ProgramHalfWord(pageBase + 2, data);
-
- return FlashStatus;
-}
+ // Clear Flags
+ //FLASH_ClearFlag(FLASH_SR_EOP|FLASH_SR_PGERR|FLASH_SR_WRPERR);
-/**
- * @brief Check page for blank and erase it
- * @param page base address
- * @retval Success or error
- * - Flash error code: on write Flash error
- * - EEPROM_BAD_FLASH: page not empty after erase
- * - EEPROM_OK: page blank
- */
-uint16_t EE_CheckErasePage(uint32_t pageBase, uint16_t status)
-{
- uint16_t FlashStatus;
- if (EE_CheckPage(pageBase, status) != EEPROM_OK)
- {
- FlashStatus = EE_ErasePage(pageBase);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
- return EE_CheckPage(pageBase, status);
- }
- return EEPROM_OK;
+ return FEE_DENSITY_BYTES;
}
+/*****************************************************************************
+* Erase the whole reserved Flash Space used for user Data
+******************************************************************************/
+void EEPROM_Erase (void) {
-/**
- * @brief Find valid Page for write or read operation
- * @param Page0: Page0 base address
- * Page1: Page1 base address
- * @retval Valid page address (PAGE0 or PAGE1) or NULL in case of no valid page was found
- */
-uint32_t EE_FindValidPage(void)
-{
- uint16_t status0 = (*(__IO uint16_t*)PageBase0); // Get Page0 actual status
- uint16_t status1 = (*(__IO uint16_t*)PageBase1); // Get Page1 actual status
-
- if (status0 == EEPROM_VALID_PAGE && status1 == EEPROM_ERASED)
- return PageBase0;
- if (status1 == EEPROM_VALID_PAGE && status0 == EEPROM_ERASED)
- return PageBase1;
-
- return 0;
-}
+ int page_num = 0;
-/**
- * @brief Calculate unique variables in EEPROM
- * @param start: address of first slot to check (page + 4)
- * @param end: page end address
- * @param address: 16 bit virtual address of the variable to excluse (or 0XFFFF)
- * @retval count of variables
- */
-uint16_t EE_GetVariablesCount(uint32_t pageBase, uint16_t skipAddress)
-{
- uint16_t varAddress, nextAddress;
- uint32_t idx;
- uint32_t pageEnd = pageBase + (uint32_t)PageSize;
- uint16_t count = 0;
-
- for (pageBase += 6; pageBase < pageEnd; pageBase += 4)
- {
- varAddress = (*(__IO uint16_t*)pageBase);
- if (varAddress == 0xFFFF || varAddress == skipAddress)
- continue;
-
- count++;
- for(idx = pageBase + 4; idx < pageEnd; idx += 4)
- {
- nextAddress = (*(__IO uint16_t*)idx);
- if (nextAddress == varAddress)
- {
- count--;
- break;
- }
- }
- }
- return count;
+ // delete all pages from specified start page to the last page
+ do {
+ FLASH_ErasePage(FEE_PAGE_BASE_ADDRESS + (page_num * FEE_PAGE_SIZE));
+ page_num++;
+ } while (page_num < FEE_DENSITY_PAGES);
}
+/*****************************************************************************
+* Writes once data byte to flash on specified address. If a byte is already
+* written, the whole page must be copied to a buffer, the byte changed and
+* the manipulated buffer written after PageErase.
+*******************************************************************************/
+uint16_t EEPROM_WriteDataByte (uint16_t Address, uint8_t DataByte) {
-/**
- * @brief Transfers last updated variables data from the full Page to an empty one.
- * @param newPage: new page base address
- * @param oldPage: old page base address
- * @param SkipAddress: 16 bit virtual address of the variable (or 0xFFFF)
- * @retval Success or error status:
- * - FLASH_COMPLETE: on success
- * - EEPROM_OUT_SIZE: if valid new page is full
- * - Flash error code: on write Flash error
- */
-uint16_t EE_PageTransfer(uint32_t newPage, uint32_t oldPage, uint16_t SkipAddress)
-{
- uint32_t oldEnd, newEnd;
- uint32_t oldIdx, newIdx, idx;
- uint16_t address, data, found;
- FLASH_Status FlashStatus;
-
- // Transfer process: transfer variables from old to the new active page
- newEnd = newPage + ((uint32_t)PageSize);
-
- // Find first free element in new page
- for (newIdx = newPage + 4; newIdx < newEnd; newIdx += 4)
- if ((*(__IO uint32_t*)newIdx) == 0xFFFFFFFF) // Verify if element
- break; // contents are 0xFFFFFFFF
- if (newIdx >= newEnd)
- return EEPROM_OUT_SIZE;
-
- oldEnd = oldPage + 4;
- oldIdx = oldPage + (uint32_t)(PageSize - 2);
-
- for (; oldIdx > oldEnd; oldIdx -= 4)
- {
- address = *(__IO uint16_t*)oldIdx;
- if (address == 0xFFFF || address == SkipAddress)
- continue; // it's means that power off after write data
-
- found = 0;
- for (idx = newPage + 6; idx < newIdx; idx += 4)
- if ((*(__IO uint16_t*)(idx)) == address)
- {
- found = 1;
- break;
- }
-
- if (found)
- continue;
-
- if (newIdx < newEnd)
- {
- data = (*(__IO uint16_t*)(oldIdx - 2));
-
- FlashStatus = FLASH_ProgramHalfWord(newIdx, data);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
+ FLASH_Status FlashStatus = FLASH_COMPLETE;
- FlashStatus = FLASH_ProgramHalfWord(newIdx + 2, address);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
+ uint32_t page;
+ int i;
- newIdx += 4;
- }
- else
- return EEPROM_OUT_SIZE;
+ // exit if desired address is above the limit (e.G. under 2048 Bytes for 4 pages)
+ if (Address > FEE_DENSITY_BYTES) {
+ return 0;
}
- // Erase the old Page: Set old Page status to EEPROM_EEPROM_ERASED status
- data = EE_CheckErasePage(oldPage, EEPROM_ERASED);
- if (data != EEPROM_OK)
- return data;
+ // calculate which page is affected (Pagenum1/Pagenum2...PagenumN)
+ page = (FEE_PAGE_BASE_ADDRESS + FEE_ADDR_OFFSET(Address)) & 0x00000FFF;
- // Set new Page status
- FlashStatus = FLASH_ProgramHalfWord(newPage, EEPROM_VALID_PAGE);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
+ if (page % FEE_PAGE_SIZE) page = page + FEE_PAGE_SIZE;
+ page = (page / FEE_PAGE_SIZE) - 1;
- return EEPROM_OK;
-}
+ // if current data is 0xFF, the byte is empty, just overwrite with the new one
+ if ((*(__IO uint16_t*)(FEE_PAGE_BASE_ADDRESS + FEE_ADDR_OFFSET(Address))) == FEE_EMPTY_WORD) {
-/**
- * @brief Verify if active page is full and Writes variable in EEPROM.
- * @param Address: 16 bit virtual address of the variable
- * @param Data: 16 bit data to be written as variable value
- * @retval Success or error status:
- * - FLASH_COMPLETE: on success
- * - EEPROM_PAGE_FULL: if valid page is full (need page transfer)
- * - EEPROM_NO_VALID_PAGE: if no valid page was found
- * - EEPROM_OUT_SIZE: if EEPROM size exceeded
- * - Flash error code: on write Flash error
- */
-uint16_t EE_VerifyPageFullWriteVariable(uint16_t Address, uint16_t Data)
-{
- FLASH_Status FlashStatus;
- uint32_t idx, pageBase, pageEnd, newPage;
- uint16_t count;
-
- // Get valid Page for write operation
- pageBase = EE_FindValidPage();
- if (pageBase == 0)
- return EEPROM_NO_VALID_PAGE;
-
- // Get the valid Page end Address
- pageEnd = pageBase + PageSize; // Set end of page
-
- for (idx = pageEnd - 2; idx > pageBase; idx -= 4)
- {
- if ((*(__IO uint16_t*)idx) == Address) // Find last value for address
- {
- count = (*(__IO uint16_t*)(idx - 2)); // Read last data
- if (count == Data)
- return EEPROM_OK;
- if (count == 0xFFFF)
- {
- FlashStatus = FLASH_ProgramHalfWord(idx - 2, Data); // Set variable data
- if (FlashStatus == FLASH_COMPLETE)
- return EEPROM_OK;
- }
- break;
- }
+ FlashStatus = FLASH_ProgramHalfWord(FEE_PAGE_BASE_ADDRESS + FEE_ADDR_OFFSET(Address), (uint16_t)(0x00FF & DataByte));
}
+ else {
- // Check each active page address starting from begining
- for (idx = pageBase + 4; idx < pageEnd; idx += 4)
- if ((*(__IO uint32_t*)idx) == 0xFFFFFFFF) // Verify if element
- { // contents are 0xFFFFFFFF
- FlashStatus = FLASH_ProgramHalfWord(idx, Data); // Set variable data
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
- FlashStatus = FLASH_ProgramHalfWord(idx + 2, Address); // Set variable virtual address
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
- return EEPROM_OK;
- }
-
- // Empty slot not found, need page transfer
- // Calculate unique variables in page
- count = EE_GetVariablesCount(pageBase, Address) + 1;
- if (count >= (PageSize / 4 - 1))
- return EEPROM_OUT_SIZE;
-
- if (pageBase == PageBase1)
- newPage = PageBase0; // New page address where variable will be moved to
- else
- newPage = PageBase1;
-
- // Set the new Page status to RECEIVE_DATA status
- FlashStatus = FLASH_ProgramHalfWord(newPage, EEPROM_RECEIVE_DATA);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
-
- // Write the variable passed as parameter in the new active page
- FlashStatus = FLASH_ProgramHalfWord(newPage + 4, Data);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
-
- FlashStatus = FLASH_ProgramHalfWord(newPage + 6, Address);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
-
- return EE_PageTransfer(newPage, pageBase, Address);
-}
-
-/*EEPROMClass::EEPROMClass(void)
-{
- PageBase0 = EEPROM_PAGE0_BASE;
- PageBase1 = EEPROM_PAGE1_BASE;
- PageSize = EEPROM_PAGE_SIZE;
- Status = EEPROM_NOT_INIT;
-}*/
-/*
-uint16_t EEPROM_init(uint32_t pageBase0, uint32_t pageBase1, uint32_t pageSize)
-{
- PageBase0 = pageBase0;
- PageBase1 = pageBase1;
- PageSize = pageSize;
- return EEPROM_init();
-}*/
+ // Copy Page to a buffer
+ memcpy(DataBuf, (uint8_t*)FEE_PAGE_BASE_ADDRESS + (page * FEE_PAGE_SIZE), FEE_PAGE_SIZE); // !!! Calculate base address for the desired page
-uint16_t EEPROM_init(void)
-{
- uint16_t status0 = 6, status1 = 6;
- FLASH_Status FlashStatus;
+ // check if new data is differ to current data, return if not, proceed if yes
+ if (DataByte == *(__IO uint8_t*)(FEE_PAGE_BASE_ADDRESS + FEE_ADDR_OFFSET(Address))) {
+ return 0;
+ }
- FLASH_Unlock();
- Status = EEPROM_NO_VALID_PAGE;
+ // manipulate desired data byte in temp data array if new byte is differ to the current
+ DataBuf[FEE_ADDR_OFFSET(Address)] = DataByte;
- status0 = (*(__IO uint16_t *)PageBase0);
- status1 = (*(__IO uint16_t *)PageBase1);
+ //Erase Page
+ FlashStatus = FLASH_ErasePage(FEE_PAGE_BASE_ADDRESS + page);
- switch (status0)
- {
-/*
- Page0 Page1
- ----- -----
- EEPROM_ERASED EEPROM_VALID_PAGE Page1 valid, Page0 erased
- EEPROM_RECEIVE_DATA Page1 need set to valid, Page0 erased
- EEPROM_ERASED make EE_Format
- any Error: EEPROM_NO_VALID_PAGE
-*/
- case EEPROM_ERASED:
- if (status1 == EEPROM_VALID_PAGE) // Page0 erased, Page1 valid
- Status = EE_CheckErasePage(PageBase0, EEPROM_ERASED);
- else if (status1 == EEPROM_RECEIVE_DATA) // Page0 erased, Page1 receive
- {
- FlashStatus = FLASH_ProgramHalfWord(PageBase1, EEPROM_VALID_PAGE);
- if (FlashStatus != FLASH_COMPLETE)
- Status = FlashStatus;
- else
- Status = EE_CheckErasePage(PageBase0, EEPROM_ERASED);
- }
- else if (status1 == EEPROM_ERASED) // Both in erased state so format EEPROM
- Status = EEPROM_format();
- break;
-/*
- Page0 Page1
- ----- -----
- EEPROM_RECEIVE_DATA EEPROM_VALID_PAGE Transfer Page1 to Page0
- EEPROM_ERASED Page0 need set to valid, Page1 erased
- any EEPROM_NO_VALID_PAGE
-*/
- case EEPROM_RECEIVE_DATA:
- if (status1 == EEPROM_VALID_PAGE) // Page0 receive, Page1 valid
- Status = EE_PageTransfer(PageBase0, PageBase1, 0xFFFF);
- else if (status1 == EEPROM_ERASED) // Page0 receive, Page1 erased
- {
- Status = EE_CheckErasePage(PageBase1, EEPROM_ERASED);
- if (Status == EEPROM_OK)
- {
- FlashStatus = FLASH_ProgramHalfWord(PageBase0, EEPROM_VALID_PAGE);
- if (FlashStatus != FLASH_COMPLETE)
- Status = FlashStatus;
- else
- Status = EEPROM_OK;
+ // Write new data (whole page) to flash if data has beed changed
+ for(i = 0; i < (FEE_PAGE_SIZE / 2); i++) {
+ if ((__IO uint16_t)(0xFF00 | DataBuf[FEE_ADDR_OFFSET(i)]) != 0xFFFF) {
+ FlashStatus = FLASH_ProgramHalfWord((FEE_PAGE_BASE_ADDRESS + (page * FEE_PAGE_SIZE)) + (i * 2), (uint16_t)(0xFF00 | DataBuf[FEE_ADDR_OFFSET(i)]));
}
}
- break;
-/*
- Page0 Page1
- ----- -----
- EEPROM_VALID_PAGE EEPROM_VALID_PAGE Error: EEPROM_NO_VALID_PAGE
- EEPROM_RECEIVE_DATA Transfer Page0 to Page1
- any Page0 valid, Page1 erased
-*/
- case EEPROM_VALID_PAGE:
- if (status1 == EEPROM_VALID_PAGE) // Both pages valid
- Status = EEPROM_NO_VALID_PAGE;
- else if (status1 == EEPROM_RECEIVE_DATA)
- Status = EE_PageTransfer(PageBase1, PageBase0, 0xFFFF);
- else
- Status = EE_CheckErasePage(PageBase1, EEPROM_ERASED);
- break;
-/*
- Page0 Page1
- ----- -----
- any EEPROM_VALID_PAGE Page1 valid, Page0 erased
- EEPROM_RECEIVE_DATA Page1 valid, Page0 erased
- any EEPROM_NO_VALID_PAGE
-*/
- default:
- if (status1 == EEPROM_VALID_PAGE)
- Status = EE_CheckErasePage(PageBase0, EEPROM_ERASED); // Check/Erase Page0
- else if (status1 == EEPROM_RECEIVE_DATA)
- {
- FlashStatus = FLASH_ProgramHalfWord(PageBase1, EEPROM_VALID_PAGE);
- if (FlashStatus != FLASH_COMPLETE)
- Status = FlashStatus;
- else
- Status = EE_CheckErasePage(PageBase0, EEPROM_ERASED);
- }
- break;
- }
- return Status;
-}
-
-/**
- * @brief Erases PAGE0 and PAGE1 and writes EEPROM_VALID_PAGE / 0 header to PAGE0
- * @param PAGE0 and PAGE1 base addresses
- * @retval Status of the last operation (Flash write or erase) done during EEPROM formating
- */
-uint16_t EEPROM_format(void)
-{
- uint16_t status;
- FLASH_Status FlashStatus;
- FLASH_Unlock();
-
- // Erase Page0
- status = EE_CheckErasePage(PageBase0, EEPROM_VALID_PAGE);
- if (status != EEPROM_OK)
- return status;
- if ((*(__IO uint16_t*)PageBase0) == EEPROM_ERASED)
- {
- // Set Page0 as valid page: Write VALID_PAGE at Page0 base address
- FlashStatus = FLASH_ProgramHalfWord(PageBase0, EEPROM_VALID_PAGE);
- if (FlashStatus != FLASH_COMPLETE)
- return FlashStatus;
}
- // Erase Page1
- return EE_CheckErasePage(PageBase1, EEPROM_ERASED);
-}
-
-/**
- * @brief Returns the erase counter for current page
- * @param Data: Global variable contains the read variable value
- * @retval Success or error status:
- * - EEPROM_OK: if erases counter return.
- * - EEPROM_NO_VALID_PAGE: if no valid page was found.
- */
-uint16_t EEPROM_erases(uint16_t *Erases)
-{
- uint32_t pageBase;
- if (Status != EEPROM_OK)
- if (EEPROM_init() != EEPROM_OK)
- return Status;
-
- // Get active Page for read operation
- pageBase = EE_FindValidPage();
- if (pageBase == 0)
- return EEPROM_NO_VALID_PAGE;
-
- *Erases = (*(__IO uint16_t*)pageBase+2);
- return EEPROM_OK;
-}
-
-/**
- * @brief Returns the last stored variable data, if found,
- * which correspond to the passed virtual address
- * @param Address: Variable virtual address
- * @retval Data for variable or EEPROM_DEFAULT_DATA, if any errors
- */
-/*
-uint16_t EEPROM_read (uint16_t Address)
-{
- uint16_t data;
- EEPROM_read(Address, &data);
- return data;
-}*/
-
-/**
- * @brief Returns the last stored variable data, if found,
- * which correspond to the passed virtual address
- * @param Address: Variable virtual address
- * @param Data: Pointer to data variable
- * @retval Success or error status:
- * - EEPROM_OK: if variable was found
- * - EEPROM_BAD_ADDRESS: if the variable was not found
- * - EEPROM_NO_VALID_PAGE: if no valid page was found.
- */
-uint16_t EEPROM_read(uint16_t Address, uint16_t *Data)
-{
- uint32_t pageBase, pageEnd;
-
- // Set default data (empty EEPROM)
- *Data = EEPROM_DEFAULT_DATA;
-
- if (Status == EEPROM_NOT_INIT)
- if (EEPROM_init() != EEPROM_OK)
- return Status;
-
- // Get active Page for read operation
- pageBase = EE_FindValidPage();
- if (pageBase == 0)
- return EEPROM_NO_VALID_PAGE;
-
- // Get the valid Page end Address
- pageEnd = pageBase + ((uint32_t)(PageSize - 2));
-
- // Check each active page address starting from end
- for (pageBase += 6; pageEnd >= pageBase; pageEnd -= 4)
- if ((*(__IO uint16_t*)pageEnd) == Address) // Compare the read address with the virtual address
- {
- *Data = (*(__IO uint16_t*)(pageEnd - 2)); // Get content of Address-2 which is variable value
- return EEPROM_OK;
- }
-
- // Return ReadStatus value: (0: variable exist, 1: variable doesn't exist)
- return EEPROM_BAD_ADDRESS;
-}
-
-/**
- * @brief Writes/upadtes variable data in EEPROM.
- * @param VirtAddress: Variable virtual address
- * @param Data: 16 bit data to be written
- * @retval Success or error status:
- * - FLASH_COMPLETE: on success
- * - EEPROM_BAD_ADDRESS: if address = 0xFFFF
- * - EEPROM_PAGE_FULL: if valid page is full
- * - EEPROM_NO_VALID_PAGE: if no valid page was found
- * - EEPROM_OUT_SIZE: if no empty EEPROM variables
- * - Flash error code: on write Flash error
- */
-uint16_t EEPROM_write(uint16_t Address, uint16_t Data)
-{
- if (Status == EEPROM_NOT_INIT)
- if (EEPROM_init() != EEPROM_OK)
- return Status;
-
- if (Address == 0xFFFF)
- return EEPROM_BAD_ADDRESS;
-
- // Write the variable virtual address and value in the EEPROM
- uint16_t status = EE_VerifyPageFullWriteVariable(Address, Data);
- return status;
-}
-
-/**
- * @brief Writes/upadtes variable data in EEPROM.
- The value is written only if differs from the one already saved at the same address.
- * @param VirtAddress: Variable virtual address
- * @param Data: 16 bit data to be written
- * @retval Success or error status:
- * - EEPROM_SAME_VALUE: If new Data matches existing EEPROM Data
- * - FLASH_COMPLETE: on success
- * - EEPROM_BAD_ADDRESS: if address = 0xFFFF
- * - EEPROM_PAGE_FULL: if valid page is full
- * - EEPROM_NO_VALID_PAGE: if no valid page was found
- * - EEPROM_OUT_SIZE: if no empty EEPROM variables
- * - Flash error code: on write Flash error
- */
-uint16_t EEPROM_update(uint16_t Address, uint16_t Data)
-{
- uint16_t temp;
- EEPROM_read(Address, &temp);
- if (temp == Data)
- return EEPROM_SAME_VALUE;
- else
- return EEPROM_write(Address, Data);
+ return FlashStatus;
}
+/*****************************************************************************
+* Read once data byte from a specified address.
+*******************************************************************************/
+uint8_t EEPROM_ReadDataByte (uint16_t Address) {
-/**
- * @brief Return number of variable
- * @retval Number of variables
- */
-uint16_t EEPROM_count(uint16_t *Count)
-{
- if (Status == EEPROM_NOT_INIT)
- if (EEPROM_init() != EEPROM_OK)
- return Status;
-
- // Get valid Page for write operation
- uint32_t pageBase = EE_FindValidPage();
- if (pageBase == 0)
- return EEPROM_NO_VALID_PAGE; // No valid page, return max. numbers
+ uint8_t DataByte = 0xFF;
- *Count = EE_GetVariablesCount(pageBase, 0xFFFF);
- return EEPROM_OK;
-}
+ // Get Byte from specified address
+ DataByte = (*(__IO uint8_t*)(FEE_PAGE_BASE_ADDRESS + FEE_ADDR_OFFSET(Address)));
-uint16_t EEPROM_maxcount(void)
-{
- return ((PageSize / 4)-1);
+ return DataByte;
}
-
+/*****************************************************************************
+* Wrap library in AVR style functions.
+*******************************************************************************/
uint8_t eeprom_read_byte (const uint8_t *Address)
{
const uint16_t p = (const uint32_t) Address;
- uint16_t temp;
- EEPROM_read(p, &temp);
- return (uint8_t) temp;
+ return EEPROM_ReadDataByte(p);
}
void eeprom_write_byte (uint8_t *Address, uint8_t Value)
{
uint16_t p = (uint32_t) Address;
- EEPROM_write(p, (uint16_t) Value);
+ EEPROM_WriteDataByte(p, Value);
}
void eeprom_update_byte (uint8_t *Address, uint8_t Value)
{
uint16_t p = (uint32_t) Address;
- EEPROM_update(p, (uint16_t) Value);
+ EEPROM_WriteDataByte(p, Value);
}
uint16_t eeprom_read_word (const uint16_t *Address)
{
const uint16_t p = (const uint32_t) Address;
- uint16_t temp;
- EEPROM_read(p, &temp);
- return temp;
+ return EEPROM_ReadDataByte(p) | (EEPROM_ReadDataByte(p+1) << 8);
}
void eeprom_write_word (uint16_t *Address, uint16_t Value)
{
uint16_t p = (uint32_t) Address;
- EEPROM_write(p, Value);
+ EEPROM_WriteDataByte(p, (uint8_t) Value);
+ EEPROM_WriteDataByte(p + 1, (uint8_t) (Value >> 8));
}
void eeprom_update_word (uint16_t *Address, uint16_t Value)
{
uint16_t p = (uint32_t) Address;
- EEPROM_update(p, Value);
+ EEPROM_WriteDataByte(p, (uint8_t) Value);
+ EEPROM_WriteDataByte(p + 1, (uint8_t) (Value >> 8));
}
uint32_t eeprom_read_dword (const uint32_t *Address)
{
const uint16_t p = (const uint32_t) Address;
- uint16_t temp1, temp2;
- EEPROM_read(p, &temp1);
- EEPROM_read(p + 1, &temp2);
- return temp1 | (temp2 << 16);
+ return EEPROM_ReadDataByte(p) | (EEPROM_ReadDataByte(p+1) << 8)
+ | (EEPROM_ReadDataByte(p+2) << 16) | (EEPROM_ReadDataByte(p+3) << 24);
}
void eeprom_write_dword (uint32_t *Address, uint32_t Value)
{
- uint16_t temp = (uint16_t) Value;
- uint16_t p = (uint32_t) Address;
- EEPROM_write(p, temp);
- temp = (uint16_t) (Value >> 16);
- EEPROM_write(p + 1, temp);
+ uint16_t p = (const uint32_t) Address;
+ EEPROM_WriteDataByte(p, (uint8_t) Value);
+ EEPROM_WriteDataByte(p+1, (uint8_t) (Value >> 8));
+ EEPROM_WriteDataByte(p+2, (uint8_t) (Value >> 16));
+ EEPROM_WriteDataByte(p+3, (uint8_t) (Value >> 24));
}
void eeprom_update_dword (uint32_t *Address, uint32_t Value)
{
- uint16_t temp = (uint16_t) Value;
- uint16_t p = (uint32_t) Address;
- EEPROM_update(p, temp);
- temp = (uint16_t) (Value >> 16);
- EEPROM_update(p + 1, temp);
+ uint16_t p = (const uint32_t) Address;
+ EEPROM_WriteDataByte(p, (uint8_t) Value);
+ EEPROM_WriteDataByte(p+1, (uint8_t) (Value >> 8));
+ EEPROM_WriteDataByte(p+2, (uint8_t) (Value >> 16));
+ EEPROM_WriteDataByte(p+3, (uint8_t) (Value >> 24));
+}
+
+void eeprom_read_block(void *buf, const void *addr, uint32_t len) {
+ const uint8_t *p = (const uint8_t *)addr;
+ uint8_t *dest = (uint8_t *)buf;
+ while (len--) {
+ *dest++ = eeprom_read_byte(p++);
+ }
+}
+
+void eeprom_write_block(const void *buf, void *addr, uint32_t len) {
+ uint8_t *p = (uint8_t *)addr;
+ const uint8_t *src = (const uint8_t *)buf;
+ while (len--) {
+ eeprom_write_byte(p++, *src++);
+ }
+}
+
+void eeprom_update_block(const void *buf, void *addr, uint32_t len) {
+ uint8_t *p = (uint8_t *)addr;
+ const uint8_t *src = (const uint8_t *)buf;
+ while (len--) {
+ eeprom_write_byte(p++, *src++);
+ }
}
diff --git a/tmk_core/common/chibios/eeprom_stm32.h b/tmk_core/common/chibios/eeprom_stm32.h
index 09229530ca..892e417b7e 100755
--- a/tmk_core/common/chibios/eeprom_stm32.h
+++ b/tmk_core/common/chibios/eeprom_stm32.h
@@ -10,15 +10,17 @@
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
- * This files are free to use from https://github.com/rogerclarkmelbourne/Arduino_STM32 and
- * https://github.com/leaflabs/libmaple
+ * This files are free to use from http://engsta.com/stm32-flash-memory-eeprom-emulator/ by
+ * Artur F.
*
* Modifications for QMK and STM32F303 by Yiancar
+ *
+ * This library assumes 8-bit data locations. To add a new MCU, please provide the flash
+ * page size and the total flash size in Kb. The number of available pages must be a multiple
+ * of 2. Only half of the pages account for the total EEPROM size.
+ * This library also assumes that the pages are not used by the firmware.
*/
-// This file must be modified if the MCU is not defined below.
-// This library also assumes that the pages are not used by the firmware.
-
#ifndef __EEPROM_H
#define __EEPROM_H
@@ -38,9 +40,11 @@
#ifndef EEPROM_PAGE_SIZE
#if defined (MCU_STM32F103RB)
- #define EEPROM_PAGE_SIZE (uint16_t)0x400 /* Page size = 1KByte */
+ #define FEE_PAGE_SIZE (uint16_t)0x400 // Page size = 1KByte
+ #define FEE_DENSITY_PAGES 2 // How many pages are used
#elif defined (MCU_STM32F103ZE) || defined (MCU_STM32F103RE) || defined (MCU_STM32F103RD) || defined (MCU_STM32F303CC)
- #define EEPROM_PAGE_SIZE (uint16_t)0x800 /* Page size = 2KByte */
+ #define FEE_PAGE_SIZE (uint16_t)0x800 // Page size = 2KByte
+ #define FEE_DENSITY_PAGES 4 // How many pages are used
#else
#error "No MCU type specified. Add something like -DMCU_STM32F103RB to your compiler arguments (probably in a Makefile)."
#endif
@@ -48,48 +52,30 @@
#ifndef EEPROM_START_ADDRESS
#if defined (MCU_STM32F103RB)
- #define EEPROM_START_ADDRESS ((uint32_t)(0x8000000 + 128 * 1024 - 2 * EEPROM_PAGE_SIZE))
+ #define FEE_MCU_FLASH_SIZE 128 // Size in Kb
#elif defined (MCU_STM32F103ZE) || defined (MCU_STM32F103RE)
- #define EEPROM_START_ADDRESS ((uint32_t)(0x8000000 + 512 * 1024 - 2 * EEPROM_PAGE_SIZE))
+ #define FEE_MCU_FLASH_SIZE 512 // Size in Kb
#elif defined (MCU_STM32F103RD)
- #define EEPROM_START_ADDRESS ((uint32_t)(0x8000000 + 384 * 1024 - 2 * EEPROM_PAGE_SIZE))
+ #define FEE_MCU_FLASH_SIZE 384 // Size in Kb
#elif defined (MCU_STM32F303CC)
- #define EEPROM_START_ADDRESS ((uint32_t)(0x8000000 + 256 * 1024 - 2 * EEPROM_PAGE_SIZE))
+ #define FEE_MCU_FLASH_SIZE 256 // Size in Kb
#else
#error "No MCU type specified. Add something like -DMCU_STM32F103RB to your compiler arguments (probably in a Makefile)."
#endif
#endif
-/* Pages 0 and 1 base and end addresses */
-#define EEPROM_PAGE0_BASE ((uint32_t)(EEPROM_START_ADDRESS + 0x000))
-#define EEPROM_PAGE1_BASE ((uint32_t)(EEPROM_START_ADDRESS + EEPROM_PAGE_SIZE))
-
-/* Page status definitions */
-#define EEPROM_ERASED ((uint16_t)0xFFFF) /* PAGE is empty */
-#define EEPROM_RECEIVE_DATA ((uint16_t)0xEEEE) /* PAGE is marked to receive data */
-#define EEPROM_VALID_PAGE ((uint16_t)0x0000) /* PAGE containing valid data */
-
-/* Page full define */
-enum uint16_t
- {
- EEPROM_OK = ((uint16_t)0x0000),
- EEPROM_OUT_SIZE = ((uint16_t)0x0081),
- EEPROM_BAD_ADDRESS = ((uint16_t)0x0082),
- EEPROM_BAD_FLASH = ((uint16_t)0x0083),
- EEPROM_NOT_INIT = ((uint16_t)0x0084),
- EEPROM_SAME_VALUE = ((uint16_t)0x0085),
- EEPROM_NO_VALID_PAGE = ((uint16_t)0x00AB)
- };
-
-#define EEPROM_DEFAULT_DATA 0xFFFF
+// DONT CHANGE
+// Choose location for the first EEPROM Page address on the top of flash
+#define FEE_PAGE_BASE_ADDRESS ((uint32_t)(0x8000000 + FEE_MCU_FLASH_SIZE * 1024 - FEE_DENSITY_PAGES * FEE_PAGE_SIZE))
+#define FEE_DENSITY_BYTES ((FEE_PAGE_SIZE / 2) * FEE_DENSITY_PAGES - 1)
+#define FEE_LAST_PAGE_ADDRESS (FEE_PAGE_BASE_ADDRESS + (FEE_PAGE_SIZE * FEE_DENSITY_PAGES))
+#define FEE_EMPTY_WORD ((uint16_t)0xFFFF)
+#define FEE_ADDR_OFFSET(Address)(Address * 2) // 1Byte per Word will be saved to preserve Flash
- uint16_t EEPROM_init(void);
- uint16_t EEPROM_format(void);
- uint16_t EEPROM_erases(uint16_t *);
- uint16_t EEPROM_read (uint16_t address, uint16_t *data);
- uint16_t EEPROM_write(uint16_t address, uint16_t data);
- uint16_t EEPROM_update(uint16_t address, uint16_t data);
- uint16_t EEPROM_count(uint16_t *);
- uint16_t EEPROM_maxcount(void);
+// Use this function to initialize the functionality
+uint16_t EEPROM_Init(void);
+void EEPROM_Erase (void);
+uint16_t EEPROM_WriteDataByte (uint16_t Address, uint8_t DataByte);
+uint8_t EEPROM_ReadDataByte (uint16_t Address);
#endif /* __EEPROM_H */
diff --git a/tmk_core/common/chibios/flash_stm32.c b/tmk_core/common/chibios/flash_stm32.c
index 2735934844..164654a15e 100755
--- a/tmk_core/common/chibios/flash_stm32.c
+++ b/tmk_core/common/chibios/flash_stm32.c
@@ -186,3 +186,18 @@ void FLASH_Lock(void)
/* Set the Lock Bit to lock the FPEC and the FCR */
FLASH->CR |= FLASH_CR_LOCK;
}
+
+/**
+ * @brief Clears the FLASH's pending flags.
+ * @param FLASH_FLAG: specifies the FLASH flags to clear.
+ * This parameter can be any combination of the following values:
+ * @arg FLASH_FLAG_PGERR: FLASH Programming error flag flag
+ * @arg FLASH_FLAG_WRPERR: FLASH Write protected error flag
+ * @arg FLASH_FLAG_EOP: FLASH End of Programming flag
+ * @retval None
+ */
+void FLASH_ClearFlag(uint32_t FLASH_FLAG)
+{
+ /* Clear the flags */
+ FLASH->SR = FLASH_FLAG;
+}
diff --git a/tmk_core/common/chibios/flash_stm32.h b/tmk_core/common/chibios/flash_stm32.h
index cc065cbca2..3c99cc566a 100755
--- a/tmk_core/common/chibios/flash_stm32.h
+++ b/tmk_core/common/chibios/flash_stm32.h
@@ -45,6 +45,7 @@ FLASH_Status FLASH_ProgramHalfWord(uint32_t Address, uint16_t Data);
void FLASH_Unlock(void);
void FLASH_Lock(void);
+void FLASH_ClearFlag(uint32_t FLASH_FLAG);
#ifdef __cplusplus
}
diff --git a/tmk_core/common/eeconfig.c b/tmk_core/common/eeconfig.c
index d8bab7d2e5..59b2bffbc7 100644
--- a/tmk_core/common/eeconfig.c
+++ b/tmk_core/common/eeconfig.c
@@ -33,7 +33,7 @@ void eeconfig_init_kb(void) {
*/
void eeconfig_init_quantum(void) {
#ifdef STM32_EEPROM_ENABLE
- EEPROM_format();
+ EEPROM_Erase();
#endif
eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER);
eeprom_update_byte(EECONFIG_DEBUG, 0);
@@ -74,7 +74,7 @@ void eeconfig_enable(void)
void eeconfig_disable(void)
{
#ifdef STM32_EEPROM_ENABLE
- EEPROM_format();
+ EEPROM_Erase();
#endif
eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER_OFF);
}
diff --git a/tmk_core/common/eeconfig.h b/tmk_core/common/eeconfig.h
index 8d4e1d4d00..eedd67602c 100644
--- a/tmk_core/common/eeconfig.h
+++ b/tmk_core/common/eeconfig.h
@@ -25,8 +25,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define EECONFIG_MAGIC_NUMBER (uint16_t)0xFEED
#define EECONFIG_MAGIC_NUMBER_OFF (uint16_t)0xFFFF
-/* eeprom parameteter address */
-#if !defined(STM32_EEPROM_ENABLE)
+/* EEPROM parameter address */
#define EECONFIG_MAGIC (uint16_t *)0
#define EECONFIG_DEBUG (uint8_t *)2
#define EECONFIG_DEFAULT_LAYER (uint8_t *)3
@@ -42,24 +41,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define EECONFIG_KEYBOARD (uint32_t *)15
#define EECONFIG_USER (uint32_t *)19
-#else
-/* STM32F3 uses 16byte block. Reconfigure memory map */
-#define EECONFIG_MAGIC (uint16_t *)0
-#define EECONFIG_DEBUG (uint8_t *)1
-#define EECONFIG_DEFAULT_LAYER (uint8_t *)2
-#define EECONFIG_KEYMAP (uint8_t *)3
-#define EECONFIG_MOUSEKEY_ACCEL (uint8_t *)4
-#define EECONFIG_BACKLIGHT (uint8_t *)5
-#define EECONFIG_AUDIO (uint8_t *)6
-#define EECONFIG_RGBLIGHT (uint32_t *)7
-#define EECONFIG_UNICODEMODE (uint8_t *)9
-#define EECONFIG_STENOMODE (uint8_t *)10
-// EEHANDS for two handed boards
-#define EECONFIG_HANDEDNESS (uint8_t *)11
-#define EECONFIG_KEYBOARD (uint32_t *)12
-#define EECONFIG_USER (uint32_t *)14
-#endif
-
/* debug bit */
#define EECONFIG_DEBUG_ENABLE (1<<0)
#define EECONFIG_DEBUG_MATRIX (1<<1)
diff --git a/tmk_core/common/eeprom.h b/tmk_core/common/eeprom.h
index 3696d0df3f..5ae0f6eebd 100644
--- a/tmk_core/common/eeprom.h
+++ b/tmk_core/common/eeprom.h
@@ -20,5 +20,4 @@ void eeprom_update_dword (uint32_t *__p, uint32_t __value);
void eeprom_update_block (const void *__src, void *__dst, uint32_t __n);
#endif
-
#endif /* TMK_CORE_COMMON_EEPROM_H_ */
diff --git a/tmk_core/common/host.h b/tmk_core/common/host.h
index aeabba7107..3d172eed66 100644
--- a/tmk_core/common/host.h
+++ b/tmk_core/common/host.h
@@ -15,14 +15,18 @@ 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 HOST_H
-#define HOST_H
+#pragma once
#include <stdint.h>
#include <stdbool.h>
#include "report.h"
#include "host_driver.h"
+#define IS_LED_ON(leds, led_name) ( (leds) & (1 << (led_name)))
+#define IS_LED_OFF(leds, led_name) (~(leds) & (1 << (led_name)))
+
+#define IS_HOST_LED_ON(led_name) IS_LED_ON(host_keyboard_leds(), led_name)
+#define IS_HOST_LED_OFF(led_name) IS_LED_OFF(host_keyboard_leds(), led_name)
#ifdef __cplusplus
extern "C" {
@@ -31,7 +35,6 @@ extern "C" {
extern uint8_t keyboard_idle;
extern uint8_t keyboard_protocol;
-
/* host driver */
void host_set_driver(host_driver_t *driver);
host_driver_t *host_get_driver(void);
@@ -49,5 +52,3 @@ uint16_t host_last_consumer_report(void);
#ifdef __cplusplus
}
#endif
-
-#endif
diff --git a/tmk_core/common/keyboard.h b/tmk_core/common/keyboard.h
index 71e594a890..ea2f336e9d 100644
--- a/tmk_core/common/keyboard.h
+++ b/tmk_core/common/keyboard.h
@@ -67,6 +67,8 @@ void keyboard_init(void);
void keyboard_task(void);
/* it runs when host LED status is updated */
void keyboard_set_leds(uint8_t leds);
+/* it runs whenever code has to behave differently on a slave */
+bool is_keyboard_master(void);
#ifdef __cplusplus
}
diff --git a/tmk_core/common/keycode.h b/tmk_core/common/keycode.h
index ac3edbd215..d5904276ee 100644
--- a/tmk_core/common/keycode.h
+++ b/tmk_core/common/keycode.h
@@ -46,6 +46,22 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define MOD_BIT(code) (1 << MOD_INDEX(code))
#define MOD_INDEX(code) ((code) & 0x07)
+#define MOD_MASK_CTRL (MOD_BIT(KC_LCTRL) | MOD_BIT(KC_RCTRL))
+#define MOD_MASK_SHIFT (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))
+#define MOD_MASK_ALT (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))
+#define MOD_MASK_GUI (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))
+#define MOD_MASK_CS (MOD_MASK_CTRL | MOD_MASK_SHIFT)
+#define MOD_MASK_CA (MOD_MASK_CTRL | MOD_MASK_ALT)
+#define MOD_MASK_CG (MOD_MASK_CTRL | MOD_MASK_GUI)
+#define MOD_MASK_SA (MOD_MASK_SHIFT | MOD_MASK_ALT)
+#define MOD_MASK_SG (MOD_MASK_SHIFT | MOD_MASK_GUI)
+#define MOD_MASK_AG (MOD_MASK_ALT | MOD_MASK_GUI)
+#define MOD_MASK_CSA (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_ALT)
+#define MOD_MASK_CSG (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_GUI)
+#define MOD_MASK_CAG (MOD_MASK_CTRL | MOD_MASK_ALT | MOD_MASK_GUI)
+#define MOD_MASK_SAG (MOD_MASK_SHIFT | MOD_MASK_ALT | MOD_MASK_GUI)
+#define MOD_MASK_CSAG (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_ALT | MOD_MASK_GUI)
+
#define FN_BIT(code) (1 << FN_INDEX(code))
#define FN_INDEX(code) ((code) - KC_FN0)
#define FN_MIN KC_FN0
@@ -174,6 +190,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define KC_BRIU KC_BRIGHTNESS_UP
#define KC_BRID KC_BRIGHTNESS_DOWN
+/* System Specific */
+#define KC_BRMU KC_PAUSE
+#define KC_BRMD KC_SCROLLLOCK
+
/* Mouse Keys */
#define KC_MS_U KC_MS_UP
#define KC_MS_D KC_MS_DOWN
diff --git a/tmk_core/common/progmem.h b/tmk_core/common/progmem.h
index dcc9efb3ce..de93138397 100644
--- a/tmk_core/common/progmem.h
+++ b/tmk_core/common/progmem.h
@@ -5,9 +5,9 @@
# include <avr/pgmspace.h>
#else
# define PROGMEM
-# define pgm_read_byte(p) *((unsigned char*)p)
-# define pgm_read_word(p) *((uint16_t*)p)
-# define pgm_read_dword(p) *((uint32_t*)p)
+# define pgm_read_byte(p) *((unsigned char*)(p))
+# define pgm_read_word(p) *((uint16_t*)(p))
+# define pgm_read_dword(p) *((uint32_t*)(p))
#endif
#endif
diff --git a/tmk_core/common/report.h b/tmk_core/common/report.h
index eb9afb727e..e7c31bd376 100644
--- a/tmk_core/common/report.h
+++ b/tmk_core/common/report.h
@@ -48,8 +48,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define TRANSPORT_STOP 0x00B7
#define TRANSPORT_STOP_EJECT 0x00CC
#define TRANSPORT_PLAY_PAUSE 0x00CD
-#define BRIGHTNESSUP 0x006F
-#define BRIGHTNESSDOWN 0x0070
+#define BRIGHTNESS_UP 0x006F
+#define BRIGHTNESS_DOWN 0x0070
/* application launch */
#define AL_CC_CONFIG 0x0183
#define AL_EMAIL 0x018A
@@ -192,8 +192,8 @@ typedef struct {
(key == KC_WWW_FORWARD ? AC_FORWARD : \
(key == KC_WWW_STOP ? AC_STOP : \
(key == KC_WWW_REFRESH ? AC_REFRESH : \
- (key == KC_BRIGHTNESS_UP ? BRIGHTNESSUP : \
- (key == KC_BRIGHTNESS_DOWN ? BRIGHTNESSDOWN : \
+ (key == KC_BRIGHTNESS_UP ? BRIGHTNESS_UP : \
+ (key == KC_BRIGHTNESS_DOWN ? BRIGHTNESS_DOWN : \
(key == KC_WWW_FAVORITES ? AC_BOOKMARKS : 0)))))))))))))))))))))))
uint8_t has_anykey(report_keyboard_t* keyboard_report);
diff --git a/tmk_core/common/wait.h b/tmk_core/common/wait.h
index a7cded9420..a77840bcef 100644
--- a/tmk_core/common/wait.h
+++ b/tmk_core/common/wait.h
@@ -15,6 +15,10 @@ extern "C" {
# include "ch.h"
# define wait_ms(ms) chThdSleepMilliseconds(ms)
# define wait_us(us) chThdSleepMicroseconds(us)
+#elif defined PROTOCOL_ARM_ATSAM
+# include "clks.h"
+# define wait_ms(ms) CLK_delay_ms(ms)
+# define wait_us(us) CLK_delay_us(us)
#elif defined(__arm__)
# include "wait_api.h"
#else // Unit tests