diff options
| author | yiancar <yiangosyiangou@cytanet.com.cy> | 2019-01-07 01:22:19 +0000 | 
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-01-06 17:22:19 -0800 | 
| commit | 2bfac351edebc6e141d3291448512b0e228e5c47 (patch) | |
| tree | dd8f9ed31f1a3ddabe59f26a9fdfb85b1570d0ae /tmk_core/common | |
| parent | 2c0bc5ed6be737e98377fa2299102f6737bbea72 (diff) | |
Final HS60v2 changes. (#4790)
* initial commit, this now mostly works
- RGB controls work
- Dynamic keymap still broken due to eeprom
- Via works
* STM32 eeprom update
- Update EEPROM emulation library to handle 8bit data like AVR.
- This library also allows for multiple page pairs resulting in greater EEPROM size flexibility
* hs60 changes
* HS60 hhkb added
* Update keyboards/hs60/v2/config.h
Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy>
Diffstat (limited to 'tmk_core/common')
| -rwxr-xr-x | tmk_core/common/chibios/eeprom_stm32.c | 710 | ||||
| -rwxr-xr-x | tmk_core/common/chibios/eeprom_stm32.h | 68 | ||||
| -rwxr-xr-x | tmk_core/common/chibios/flash_stm32.c | 15 | ||||
| -rwxr-xr-x | tmk_core/common/chibios/flash_stm32.h | 1 | ||||
| -rw-r--r-- | tmk_core/common/eeconfig.c | 4 | ||||
| -rw-r--r-- | tmk_core/common/eeconfig.h | 21 | ||||
| -rw-r--r-- | tmk_core/common/eeprom.h | 1 | 
7 files changed, 172 insertions, 648 deletions
| 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_ */ | 
