mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_ARM_BEETLE_SOC/TOOLCHAIN_ARM_STD/eflash_api.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /* mbed Microcontroller Library
AnnaBridge 171:3a7713b1edbc 2 * Copyright (c) 2015 ARM Limited
AnnaBridge 171:3a7713b1edbc 3 *
AnnaBridge 171:3a7713b1edbc 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 171:3a7713b1edbc 5 * you may not use this file except in compliance with the License.
AnnaBridge 171:3a7713b1edbc 6 * You may obtain a copy of the License at
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 171:3a7713b1edbc 9 *
AnnaBridge 171:3a7713b1edbc 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 171:3a7713b1edbc 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 171:3a7713b1edbc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 171:3a7713b1edbc 13 * See the License for the specific language governing permissions and
AnnaBridge 171:3a7713b1edbc 14 * limitations under the License.
AnnaBridge 171:3a7713b1edbc 15 */
AnnaBridge 171:3a7713b1edbc 16
AnnaBridge 171:3a7713b1edbc 17 #ifndef _EFLASH_DRV_H
AnnaBridge 171:3a7713b1edbc 18 #define _EFLASH_DRV_H
AnnaBridge 171:3a7713b1edbc 19
AnnaBridge 171:3a7713b1edbc 20 #include "fcache_api.h"
AnnaBridge 171:3a7713b1edbc 21
AnnaBridge 171:3a7713b1edbc 22 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 23
AnnaBridge 171:3a7713b1edbc 24 extern "C" {
AnnaBridge 171:3a7713b1edbc 25 #else
AnnaBridge 171:3a7713b1edbc 26 #include <stdio.h>
AnnaBridge 171:3a7713b1edbc 27 #endif
AnnaBridge 171:3a7713b1edbc 28
AnnaBridge 171:3a7713b1edbc 29 /* eFLASH Address Map */
AnnaBridge 171:3a7713b1edbc 30 #define SYS_EFLASH_BASE 0x40009000
AnnaBridge 171:3a7713b1edbc 31 #define SYS_EFLASH_IRQ_SET_STATUS (SYS_EFLASH_BASE + 0x008)
AnnaBridge 171:3a7713b1edbc 32 #define SYS_EFLASH_IRQ_CLR_STATUS (SYS_EFLASH_BASE + 0x008)
AnnaBridge 171:3a7713b1edbc 33 #define SYS_EFLASH_CTRL (SYS_EFLASH_BASE + 0x014)
AnnaBridge 171:3a7713b1edbc 34 #define SYS_EFLASH_STATUS (SYS_EFLASH_BASE + 0x018)
AnnaBridge 171:3a7713b1edbc 35 #define SYS_EFLASH_CONFIG0 (SYS_EFLASH_BASE + 0x01C)
AnnaBridge 171:3a7713b1edbc 36 #define SYS_EFLASH_WADDR (SYS_EFLASH_BASE + 0x028)
AnnaBridge 171:3a7713b1edbc 37 #define SYS_EFLASH_WDATA (SYS_EFLASH_BASE + 0x02C)
AnnaBridge 171:3a7713b1edbc 38 #define SYS_EFLASH_HWPARAMS0 (SYS_EFLASH_BASE + 0x034)
AnnaBridge 171:3a7713b1edbc 39 #define SYS_EFLASH_PIDR0 (SYS_EFLASH_BASE + 0xFE0)
AnnaBridge 171:3a7713b1edbc 40 #define SYS_EFLASH_PIDR1 (SYS_EFLASH_BASE + 0xFE4)
AnnaBridge 171:3a7713b1edbc 41 #define SYS_EFLASH_PIDR2 (SYS_EFLASH_BASE + 0xFE8)
AnnaBridge 171:3a7713b1edbc 42
AnnaBridge 171:3a7713b1edbc 43 /* SYS_EFLASH_CTRL (RW): Flash Control Register */
AnnaBridge 171:3a7713b1edbc 44 #define EFLASH_WRITE 1 /* Write one word on eFlash */
AnnaBridge 171:3a7713b1edbc 45 #define EFLASH_ROW_WRITE (1 << 1) /* Write a row of eFlash */
AnnaBridge 171:3a7713b1edbc 46 #define EFLASH_ERASE (1 << 2) /* Erase one page of eFlash */
AnnaBridge 171:3a7713b1edbc 47 #define EFLASH_MASS_ERASE (1 << 3) /* Erases all pages of the eFlash*/
AnnaBridge 171:3a7713b1edbc 48 #define EFLASH_STOP (1 << 4) /* Stop any write erase operation */
AnnaBridge 171:3a7713b1edbc 49
AnnaBridge 171:3a7713b1edbc 50 /* SYS_EFLASH_STATUS (RO): Status Register */
AnnaBridge 171:3a7713b1edbc 51 #define EFLASH_BUSY_MASK 1 /* EFlash Busy Mask */
AnnaBridge 171:3a7713b1edbc 52 #define EFLASH_BUSY 1 /* EFlash Busy */
AnnaBridge 171:3a7713b1edbc 53 #define EFLASH_LOCK_MASK (1 << 1) /* EFlash Lock Mask */
AnnaBridge 171:3a7713b1edbc 54 #define EFLASH_LOCK (1 << 1) /* EFlash Lock */
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 /* SYS_EFLASH_HWPARAMS0 (RO): HW parameters */
AnnaBridge 171:3a7713b1edbc 57 #define EFLASH_FLASHSIZE 0x1F /* Flash Size */
AnnaBridge 171:3a7713b1edbc 58
AnnaBridge 171:3a7713b1edbc 59 /* SYS_EFLASH_PIDR2 (RO): Flash Memory Information */
AnnaBridge 171:3a7713b1edbc 60 #define EFLASH_DES_1 0x7 /* JEP106 Id Mask */
AnnaBridge 171:3a7713b1edbc 61 #define EFLASH_JEDEC 0x8 /* JEDEC assigned val Mask */
AnnaBridge 171:3a7713b1edbc 62 #define EFLASH_REVISION 0xF0 /* Revision number */
AnnaBridge 171:3a7713b1edbc 63
AnnaBridge 171:3a7713b1edbc 64 /* Macros */
AnnaBridge 171:3a7713b1edbc 65 #define EFlash_Readl(reg) *(volatile unsigned int *)reg
AnnaBridge 171:3a7713b1edbc 66 #define EFlash_Writel(reg, val) *(volatile unsigned int *)reg = val;
AnnaBridge 171:3a7713b1edbc 67
AnnaBridge 171:3a7713b1edbc 68 /* peripheral and component ID values */
AnnaBridge 171:3a7713b1edbc 69 #define FLS_PID4 0x14
AnnaBridge 171:3a7713b1edbc 70 #define FLS_PID5 0x00
AnnaBridge 171:3a7713b1edbc 71 #define FLS_PID6 0x00
AnnaBridge 171:3a7713b1edbc 72 #define FLS_PID7 0x00
AnnaBridge 171:3a7713b1edbc 73 #define FLS_PID0 0x30
AnnaBridge 171:3a7713b1edbc 74 #define FLS_PID1 0xB8
AnnaBridge 171:3a7713b1edbc 75 #define FLS_PID2 0x0B
AnnaBridge 171:3a7713b1edbc 76 #define FLS_PID3 0x00
AnnaBridge 171:3a7713b1edbc 77 #define FLS_CID0 0x0D
AnnaBridge 171:3a7713b1edbc 78 #define FLS_CID1 0xF0
AnnaBridge 171:3a7713b1edbc 79 #define FLS_CID2 0x05
AnnaBridge 171:3a7713b1edbc 80 #define FLS_CID3 0xB1
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /* Functions */
AnnaBridge 171:3a7713b1edbc 83 /* EFlash_DriverInitialize: eFlash Driver Initialize function */
AnnaBridge 171:3a7713b1edbc 84 void EFlash_DriverInitialize(void);
AnnaBridge 171:3a7713b1edbc 85
AnnaBridge 171:3a7713b1edbc 86 /* EFlash_ClockConfig: eFlash Clock Configuration */
AnnaBridge 171:3a7713b1edbc 87 void EFlash_ClockConfig(void);
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 /*
AnnaBridge 171:3a7713b1edbc 90 * EFlash_Erase: Erases flash banks
AnnaBridge 171:3a7713b1edbc 91 * Mode:
AnnaBridge 171:3a7713b1edbc 92 * 0 - erases bank 0
AnnaBridge 171:3a7713b1edbc 93 * 1 - erases bank 1
AnnaBridge 171:3a7713b1edbc 94 * 2 - erases bank 0 + info pages
AnnaBridge 171:3a7713b1edbc 95 * 3 - erases bank 1 + info pages
AnnaBridge 171:3a7713b1edbc 96 * 4 - erases bank 0 + 1
AnnaBridge 171:3a7713b1edbc 97 * 5 - erases bank 0 + 1 with info pages
AnnaBridge 171:3a7713b1edbc 98 */
AnnaBridge 171:3a7713b1edbc 99 void EFlash_Erase(int mode);
AnnaBridge 171:3a7713b1edbc 100 /* EFlash_ErasePage: Erase a Page */
AnnaBridge 171:3a7713b1edbc 101 void EFlash_ErasePage(unsigned int waddr);
AnnaBridge 171:3a7713b1edbc 102 /*
AnnaBridge 171:3a7713b1edbc 103 * EFlash_Write: Write function
AnnaBridge 171:3a7713b1edbc 104 * Parameters:
AnnaBridge 171:3a7713b1edbc 105 * waddr - address in flash
AnnaBridge 171:3a7713b1edbc 106 * data - data to be written
AnnaBridge 171:3a7713b1edbc 107 */
AnnaBridge 171:3a7713b1edbc 108 void EFlash_Write(unsigned int waddr, unsigned int data);
AnnaBridge 171:3a7713b1edbc 109 /*
AnnaBridge 171:3a7713b1edbc 110 * EFlash_WritePage: Write Page function
AnnaBridge 171:3a7713b1edbc 111 * Parameters:
AnnaBridge 171:3a7713b1edbc 112 * waddr - address in flash
AnnaBridge 171:3a7713b1edbc 113 * page_size - data to be written
AnnaBridge 171:3a7713b1edbc 114 * buf - buffer containing the data
AnnaBridge 171:3a7713b1edbc 115 */
AnnaBridge 171:3a7713b1edbc 116 int EFlash_WritePage(unsigned int waddr,
AnnaBridge 171:3a7713b1edbc 117 unsigned int page_size, unsigned char *buf);
AnnaBridge 171:3a7713b1edbc 118 /*
AnnaBridge 171:3a7713b1edbc 119 * EFlash_Read: Read function
AnnaBridge 171:3a7713b1edbc 120 * Parameters:
AnnaBridge 171:3a7713b1edbc 121 * waddr - address in flash
AnnaBridge 171:3a7713b1edbc 122 * Returns:
AnnaBridge 171:3a7713b1edbc 123 * the vaule read at address waddr
AnnaBridge 171:3a7713b1edbc 124 */
AnnaBridge 171:3a7713b1edbc 125 unsigned int EFlash_Read(unsigned int waddr);
AnnaBridge 171:3a7713b1edbc 126 /*
AnnaBridge 171:3a7713b1edbc 127 * EFlash_Verify: Verifies if the eFlash has been written correctly.
AnnaBridge 171:3a7713b1edbc 128 * Parameters:
AnnaBridge 171:3a7713b1edbc 129 * waddr - address in flash
AnnaBridge 171:3a7713b1edbc 130 * page_size - data to be written
AnnaBridge 171:3a7713b1edbc 131 * buf - buffer containing the data
AnnaBridge 171:3a7713b1edbc 132 * Returns:
AnnaBridge 171:3a7713b1edbc 133 * (waddr+page_size) - OK or Failed Address
AnnaBridge 171:3a7713b1edbc 134 */
AnnaBridge 171:3a7713b1edbc 135 unsigned int EFlash_Verify(unsigned int waddr,
AnnaBridge 171:3a7713b1edbc 136 unsigned int page_size, unsigned char *buf);
AnnaBridge 171:3a7713b1edbc 137 /*
AnnaBridge 171:3a7713b1edbc 138 * EFlash_BlankCheck: Verifies if there is any Blank Block in eFlash
AnnaBridge 171:3a7713b1edbc 139 * Parameters:
AnnaBridge 171:3a7713b1edbc 140 * waddr - address in flash
AnnaBridge 171:3a7713b1edbc 141 * page_size - data to be written
AnnaBridge 171:3a7713b1edbc 142 * pat - pattern of a blank block
AnnaBridge 171:3a7713b1edbc 143 * Returns:
AnnaBridge 171:3a7713b1edbc 144 * 0 - OK or 1- Failed
AnnaBridge 171:3a7713b1edbc 145 */
AnnaBridge 171:3a7713b1edbc 146 int EFlash_BlankCheck(unsigned int waddr,
AnnaBridge 171:3a7713b1edbc 147 unsigned int page_size, unsigned char pat);
AnnaBridge 171:3a7713b1edbc 148
AnnaBridge 171:3a7713b1edbc 149 /* EFlash_Delay function */
AnnaBridge 171:3a7713b1edbc 150 void EFlash_Delay(unsigned int period);
AnnaBridge 171:3a7713b1edbc 151
AnnaBridge 171:3a7713b1edbc 152 /* EFlash_ReturnBank1BaseAddress: Returns start address of bank 1 */
AnnaBridge 171:3a7713b1edbc 153 int EFlash_ReturnBank1BaseAddress(void);
AnnaBridge 171:3a7713b1edbc 154
AnnaBridge 171:3a7713b1edbc 155 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 156 }
AnnaBridge 171:3a7713b1edbc 157 #endif
AnnaBridge 171:3a7713b1edbc 158 #endif /* _FCACHE_DRV_H */